fortinet.fortimanager.fmgr_dvm_cmd_add_device – Добавить устройство в базу данных менеджера устройств.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_dvm_cmd_add_device
Новое в версии 2.10: модуля fortinet.fortimanager
Описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| bypass_validation boolean |
| устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | ||
| dvm_cmd_add_device словарь | параметры верхнего уровня | |||
| adom строка | Имя или идентификатор ADOM, на котором необходимо выполнить команду. | |||
| device словарь | без описания | |||
| adm_pass строка | без описания | |||
| adm_usr строка | <i>добавление реального и продвижение устройства</i>. | |||
| desc строка | <i>доступно для всех операций</i>. | |||
| device action строка | Укажите операции добавления устройства, или оставьте пустым для добавления реального устройства: "add_model" - добавить модель устройства. "promote_unreg" - продвинуть нерегистирированное устройство для управления FortiManager, используя информацию из базы данных. | |||
| faz.quota целое число | <i>доступно для всех операций</i>. | |||
| ip строка | <i>только для добавления реального устройства</i>. Добавление устройства будет зондировать с этим IP-адресом, используя данные для входа, указанные в параметрах. | |||
| meta fields словарь | без описания | |||
| mgmt_mode строка |
| <i>добавление реального и модели устройства</i>. | ||
| mr целое число | <i>только для добавления модели устройства</i>. | |||
| name строка | <i>требуется для всех операций</i>. Уникальное имя для устройства. | |||
| os_type строка |
| <i>только для добавления модели устройства</i>. | ||
| os_ver строка |
| версия ОС | ||
| patch целое число | <i>только для добавления модели устройства</i>. | |||
| platform_str строка | <i>только для добавления модели устройства</i>. Требуется для определения платформы для виртуальных платформ. | |||
| sn строка | <i>только для добавления модели устройства</i>. Этот атрибут будет использован для определения платформы устройства, за исключением виртуальных платформ, w... | |||
| flags список / элементы=строка |
| без описания | ||
| groups список / элементы=строка | без описания | |||
| name строка | без описания | |||
| vdom строка | без описания | |||
| rc_failed список / элементы=строка | список кодов rc, при которых выполнение будет прервано | |||
| rc_succeeded список / элементы=строка | список кодов rc, при которых выполнение будет успешно завершено | |||
| workspace_locking_adom строка | adom, который необходимо заблокировать для FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая root | |||
| workspace_locking_timeout целое число | По умолчанию: 300 | максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство | ||
Примечания
Примечание
- Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно, выполнение одного модуля может завершиться ошибкой при возвращении ненулевого rc. Вы также можете переопределить условия для ошибки или успеха с помощью параметров rc_failed и rc_succeeded
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Add a device to the Device Manager database.
fmgr_dvm_cmd_add_device:
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_device:
adom: <value of string>
device:
adm_pass: <value of string>
adm_usr: <value of string>
desc: <value of string>
device action: <value of string>
faz.quota: <value of integer>
ip: <value of string>
meta fields: <value of dict>
mgmt_mode: <value in [unreg, fmg, faz, ...]>
mr: <value of integer>
name: <value of string>
os_type: <value in [unknown, fos, fsw, ...]>
os_ver: <value in [unknown, 0.0, 1.0, ...]>
patch: <value of integer>
platform_str: <value of string>
sn: <value of string>
flags:
- none
- create_task
- nonblocking
- log_dev
groups:
-
name: <value of string>
vdom: <value of string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | полный URL запроса Пример: /sys/login/user |
| response_code целое число | всегда | статус запроса API |
| response_message строка | всегда | описательное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_dvm_cmd_add_device_module.html
