fortinet.fortimanager.fmgr_dvmdb_metafields_adom – без описания

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: нет ← да	Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager. Модуль продолжает выполнение без проверки параметров.
dvmdb_metafields_adom словарь			Параметры верхнего уровня.
	importance строка	Варианты: optional required	без описания
	length целое число		без описания
	name строка		без описания
	status строка	Варианты: disable enable	без описания
rc_failed список / элементы=строка			Список кодов rc, при которых условия будут игнорироваться.
rc_succeeded список / элементы=строка			Список кодов rc, при которых условия будут выполняться.
state строка / обязательно		Варианты: present absent	Директива для создания, обновления или удаления объекта.
workspace_locking_adom строка			Область для блокировки FortiManager в режиме рабочего пространства. Может быть global, 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: no description
     fmgr_dvmdb_metafields_adom:
        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, ...]
        dvmdb_metafields_adom:
           importance: <value in [optional, required]>
           length: <value of integer>
           name: <value of string>
           status: <value in [disable, enable]>

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

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

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