fortinet.fortimanager.fmgr_adom_options – нет описания
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_adom_options.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно |
параметр (adom) в запрошенном URL |
||
| adom_options словарь |
параметры верхнего уровня |
||
| assign_excluded строка |
|
нет описания |
|
| specify_assign_pkg_list строка |
|
нет описания |
|
| bypass_validation логическое значение |
|
устанавливать только в значение True, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров |
|
| rc_failed список / элементы=строка |
список кодов rc, с которыми будут переопределены условия для завершения работы с ошибкой |
||
| rc_succeeded список / элементы=строка |
список кодов rc, с которыми будут переопределены условия для успешного завершения |
||
| 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: no description
fmgr_adom_options:
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>
adom_options:
assign_excluded: <value in [disable, enable]>
specify_assign_pkg_list: <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_adom_options_module.html
