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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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` ← (по умолчанию) `true`
dvm_cmd_add_devlist dictionary	Набор параметров верхнего уровня.
add_dev_list псевдонимы: add-dev-list list / элементы=dictionary	Список объектов устройств для добавления.
adm_pass any	(list) Добавление реального устройства и повышение его статуса.
adm_usr string	Добавление реального устройства и повышение его статуса.
authorization_template псевдонимы: authorization template string	Используется только при добавлении модельного устройства.
desc string	Доступно для всех операций.
device_action псевдонимы: device action string	Укажите операцию добавления устройства или оставьте поле пустым, чтобы добавить реальное устройство. add_model — добавить модельное устройство. promote_unreg — повысить статус незарегистрированного устройства, чтобы им управлял FortiManager, используя данные из базы данных.
device_blueprint псевдонимы: device blueprint string	Используется только при добавлении модельного устройства.
faz_quota псевдонимы: faz.quota integer	Доступно для всех операций.
ip string	Используется только при добавлении реального устройства.
meta_fields псевдонимы: meta fields any	(dict или str) Добавление реального или модельного устройства.
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 string	Имя или идентификатор ADOM, в котором должна выполняться команда.
flags list / элементы=string	create_task — создать задачу в базе данных диспетчера задач. nonblocking — API немедленно вернет результат при неблокирующем вызове. Варианты: `"none"` `"create_task"` `"nonblocking"` `"log_dev"`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия возникновения ошибки.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
workspace_locking_adom string	ADOM для блокировки в FortiManager, работающем в режиме рабочего пространства. Значением может быть global или другой ADOM, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания снятия блокировки рабочего пространства другим пользователем. По умолчанию: `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
  gather_facts: false
  tasks:
    - name: Add multiple devices to the Device Manager database.
      fortinet.fortimanager.fmgr_dvm_cmd_add_devlist:
        # workspace_locking_adom: <global or your adom name>
        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 dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Сведения о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: complex

Авторы

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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_dvm_cmd_add_devlist_module.html