fortinet.fortimanager.fmgr_dvm_cmd_update_device – Обновить соединение FGFM и системную информацию устройства.

Примечание

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

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

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

Введено в версии 2.10: коллекции fortinet.fortimanager

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Проверка параметров в свободном режиме
method строка / обязательный	Варианты: 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, нам нужно тривиальное преобразование при заполнении книги задач 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/UPDATE/DEVICE
     fmgr_dvm_cmd_update_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>
                 device: <value of string>
                 flags:
                   - <value in [none, create_task, nonblocking, ...]>

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

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

Ключ	Возвращаемое значение	Описание
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_update_device_module.html