fortinet.fortimanager.fmgr_securityconsole_install_device – нет описания

Примечание

Этот плагин входит в состав коллекции fortinet.fortimanager (версия 1.0.5).

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

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

Новое в версии 2.10: модуля fortinet.fortimanager

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

Описание

Этот модуль позволяет настроить устройство FortiManager, позволив пользователю [exec] следующие API.
/securityconsole/install/device
Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием из источников данных.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Проверка параметров выполняется нестрого.
method string / обязательный	Варианты: exec	Метод запроса.
params list / элементы=строка		Параметры для каждого метода. Полный список параметров см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
url_params словарь		Параметры для каждого URL запроса API. Полный список параметров URL см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
workspace_locking_adom строка		Имя ADOM для блокировки в случае работы FortiManager в режиме рабочего пространства. Может быть глобальным или любым другим именем настраиваемого ADOM.
workspace_locking_timeout целое число	Значение по умолчанию: 300	Максимальное время ожидания в секундах, пока другой пользователь не разблокирует рабочее пространство.

Примечания

Примечание

Существует только три параметра верхнего уровня, где «method» всегда обязателен, а остальные два «params» и «url_params» могут быть необязательными.
Из-за сложности схемы API fortimanager проверка выполняется вне стандартного процесса проверки параметров Ansible.
Синтаксис OPTIONS не соответствует стандартному спецификации аргументов Ansible, но в структуре схемы API fortimanager требуется тривиальное преобразование при заполнении книги задач Ansible.

Примеры

- 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: REQUESTING /SECURITYCONSOLE/INSTALL/DEVICE
     fmgr_securityconsole_install_device:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [exec]>
        params:
           -
              data:
                 adom: <value of string>
                 dev_rev_comments: <value of string>
                 flags:
                   - <value in [none, preview, auto_lock_ws]>
                 scope:
                   -
                       name: <value of string>
                       vdom: <value of string>

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
data словарь	всегда	Полезная нагрузка, возвращаемая в запросе.
status словарь	всегда	Статус запроса API.
url строка	всегда	Полный запрошенный URL. Пример: /sys/login/user

Авторы

Frank Shen (@fshen01)
Link Zheng (@zhengl)

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