fortinet.fortimanager.fmgr_dvm_cmd_discover_device – Опрос удалённого устройства и получение информации об устройстве и состоянии системы.

Примечание

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

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

Чтобы использовать его в playbook, укажите: fortinet.fortimanager.fmgr_dvm_cmd_discover_device.

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

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Проверка параметров в свободном режиме
method string / обязательный	Варианты: exec	Метод запроса
params список / элементы=строка		Параметры для каждого метода Полный список параметров см. в 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 строка		Имя домена администрирования для блокировки, если FortiManager работает в режиме рабочего пространства может быть глобальным или любым другим пользовательским именем домена администрирования
workspace_locking_timeout целое число	По умолчанию: 300	Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем

Примечания

Примечание

Существует только три параметра верхнего уровня, где «method» всегда требуется, а «params» и «url_params» могут быть необязательными.
Из-за сложности схемы API fortimanager, проверка выполняется вне процедуры проверки параметров Ansible.
Синтаксис OPTIONS не соответствует стандартной спецификации аргументов Ansible, но в соответствии со структурой схемы API fortimanager нам необходимо тривиальное преобразование при заполнении playbook 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 /DVM/CMD/DISCOVER/DEVICE
     fmgr_dvm_cmd_discover_device:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [exec]>
        params:
           -
              data:
                 device:
                    adm_pass: <value of string>
                    adm_usr: <value of string>
                    ip: <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_dvm_cmd_discover_device_module.html