fortinet.fortimanager.fmgr_dvmdb_device_vdom – Таблица устройств VDOM.
Примечание
Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_dvmdb_device_vdom.
Добавлен в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое значение |
| устанавливается в True только в случае расхождений между схемой модуля и структурой API FortiManager. Модуль продолжает выполнение без проверки параметров. | |
| device строка / обязательно | параметр (device) в запрошенном URL | ||
| dvmdb_device_vdom словарь | установленные параметры верхнего уровня | ||
| comments строка | нет описания | ||
| name строка | нет описания | ||
| opmode строка |
| нет описания | |
| rtm_prof_id целое число | нет описания | ||
| status строка | нет описания | ||
| 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: Device VDOM table.
fmgr_dvmdb_device_vdom:
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>
device: <your own value>
state: <value in [present, absent]>
dvmdb_device_vdom:
comments: <value of string>
name: <value of string>
opmode: <value in [nat, transparent]>
rtm_prof_id: <value of integer>
status: <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_device_vdom_module.html
