fortinet.fortimanager.fmgr_dvm_cmd_add_devlist модуль — Добавление нескольких устройств в базу данных Диспетчера устройств.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_dvm_cmd_add_devlist.

Новый в fortinet.fortimanager 2.0.0

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Устанавливайте в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (default) `true`
dvm_cmd_add_devlist dictionary	Набор параметров верхнего уровня.
add-dev-list list / elements=dictionary	Устарело, переименуйте в add_dev_list. Список объектов устройств, которые необходимо добавить.
adm_pass any	(list) Добавить реальное и повысить устройство.
adm_usr string	Добавить реальное и повысить устройство.
authorization template string	Устарело, переименуйте в authorization_template. Добавить только модель устройства.
desc string	Доступно для всех операций.
device action string	Устарело, переименуйте в device_action. Укажите операции добавления устройства или оставьте пустым, чтобы добавить реальное устройство add_model - добавить модель устройства. promote_unreg - повысить не зарегистрированное устройство до управляемого FortiManager с использованием информации из базы данных.
device blueprint string	Устарело, переименуйте в device_blueprint. Добавить только модель устройства.
faz.quota integer	Устарело, переименуйте в faz_quota. Доступно для всех операций.
ip string	Только для добавления реального устройства.
meta fields any	(dict or str) Устарело, переименуйте в meta_fields. Добавить реальное и модель устройства.
mgmt_mode string	Добавить реальное и модель устройства. Варианты: `"unreg"` `"fmg"` `"faz"` `"fmgfaz"`
mr integer	Добавить только модель устройства.
name string	Обязательно для всех операций.
os_type string	Добавить только модель устройства. Варианты: `"unknown"` `"fos"` `"fsw"` `"foc"` `"fml"` `"faz"` `"fwb"` `"fch"` `"fct"` `"log"` `"fmg"` `"fsa"` `"fdd"` `"fac"` `"fpx"` `"fna"`
os_ver string	Добавить только модель устройства. Варианты: `"unknown"` `"0.0"` `"1.0"` `"2.0"` `"3.0"` `"4.0"` `"5.0"` `"6.0"` `"7.0"` `"8.0"`
patch integer	Добавить только модель устройства.
platform_str string	Добавить только модель устройства.
sn string	Добавить только модель устройства.

adom строка	Имя или идентификатор ADOM, на котором нужно выполнить команду.
flags список / элементы=строка	create_task - Создать новую задачу в базе данных менеджера задач. nonblocking - API вернёт результат немедленно для неблокирующего вызова. Варианты: `"none"` `"create_task"` `"nonblocking"` `"log_dev"`
enable_log логический	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
rc_failed список / элементы=целое число	Список кодов rc, при которых выполнение будет остановлено.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых выполнение будет завершено успешно.
workspace_locking_adom строка	ADOM для блокировки в режиме работы с рабочим пространством. Значение может быть глобальным или другим, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют обозначение с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов все еще доступны, но вы получите предупреждения о устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Поддержка работы в режиме блокировки рабочего пространства в этом модуле FortiManager. Параметры workspace_locking_adom и workspace_locking_timeout помогают выполнить эту задачу.
Обычно, модуль может завершиться ошибкой, если возвращается код rc, отличный от нуля. Вы также можете переопределить условия для завершения ошибкой или успешно с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Add multiple devices to the Device Manager database.
      fortinet.fortimanager.fmgr_dvm_cmd_add_devlist:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        dvm_cmd_add_devlist:
          add_dev_list:
            -
              adm_pass: <list or string>
              adm_usr: <string>
              desc: <string>
              device_action: <string>
              faz_quota: <integer>
              ip: <string>
              meta_fields: <dict or string>
              mgmt_mode: <value in [unreg, fmg, faz, ...]>
              mr: <integer>
              name: <string>
              os_type: <value in [unknown, fos, fsw, ...]>
              os_ver: <value in [unknown, 0.0, 1.0, ...]>
              patch: <integer>
              platform_str: <string>
              sn: <string>
              device_blueprint: <string>
              authorization_template: <string>
          adom: <string>
          flags:
            - none
            - create_task
            - nonblocking
            - log_dev

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API-запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложный

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_dvm_cmd_add_devlist_module.html