fortinet.fortimanager.fmgr_dvm_cmd_reload_devlist – Получение списка устройств.

Примечание

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_dvm_cmd_reload_devlist.

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

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

Описание

Этот модуль может настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить, используя источники данных, перед использованием.

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean			Варианты: нет ← да	устанавливается в True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
dvm_cmd_reload_devlist словарь				параметры верхнего уровня
	adom строка			Имя или ID ADOM, на котором должен быть выполнен команд.
	flags список / элементы=строка		Варианты: нет create_task nonblocking log_dev	нет описания
	from строка		Варианты: um fgfm apache dvm fwm xml json ←	нет описания
	reload-dev-member-list список / элементы=строка			нет описания
		name строка		нет описания
		vdom строка		нет описания
	tag строка			Имя ревизии для извлечённой конфигурации.
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: Retrieve a list of devices.
     fmgr_dvm_cmd_reload_devlist:
        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_reload_devlist:
           adom: <value of string>
           flags:
             - none
             - create_task
             - nonblocking
             - log_dev
           from: <value in [um, fgfm, apache, ...]>
           reload-dev-member-list:
             -
                 name: <value of string>
                 vdom: <value of string>
           tag: <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_reload_devlist_module.html