fortinet.fortimanager.fmgr_dvmdb_adom_objectmember – Таблица ADOM, большинство атрибутов — только для чтения и могут быть изменены только внутренне.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_dvmdb_adom_objectmember.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль способен настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое значение |
| устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager. Модуль продолжает выполнение без проверки параметров. | |
| dvmdb_adom_objectmember словарь | установленные параметры верхнего уровня | ||
| name строка | нет описания | ||
| vdom строка | нет описания | ||
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут считаться неудачными | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут считаться успешными | ||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | |
| workspace_locking_adom строка | adom для блокировки в режиме работы FortiManager в рабочем пространстве. Значение может быть глобальным и другими, включая корень. | ||
| 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: ADOM table, most attributes are read-only and can only be changed internally.
fmgr_dvmdb_adom_objectmember:
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, ...]
adom: <your own value>
state: <value in [present, absent]>
dvmdb_adom_objectmember:
name: <value of string>
vdom: <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_dvmdb_adom_objectmember_module.html