fortinet.fortimanager.fmgr_dvmdb_script_objectmember – Таблица сценариев.
Примечание
Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в playbook, укажите: fortinet.fortimanager.fmgr_dvmdb_script_objectmember.
Новое в версии 2.10: модуля fortinet.fortimanager
Описание
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для использования с источниками данных.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation булево |
| устанавливается в True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | |
| dvmdb_script_objectmember словарь | установленные параметры верхнего уровня | ||
| name строка | нет описания | ||
| vdom строка | нет описания | ||
| rc_failed список / элементы=строка | список кодов rc, при которых условие будет нарушено | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условие будет выполнено | ||
| script строка / обязательно | параметр (script) в запрошенном URL | ||
| state строка / обязательно |
| инструкция для создания, обновления или удаления объекта | |
| workspace_locking_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: Script table.
fmgr_dvmdb_script_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>
script: <your own value>
state: <value in [present, absent]>
dvmdb_script_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_script_objectmember_module.html