fortinet.fortimanager.fmgr_dynamic_vpntunnel_dynamicmapping – без описания
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_dynamic_vpntunnel_dynamicmapping
Добавлена в версии 2.10: модуля fortinet.fortimanager
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать, используя источники данных, перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | |||
| bypass_validation логическое значение |
| устанавливается в True только в случае, если схема модуля отличается от структуры API FortiManager; модуль продолжает выполняться без проверки параметров | ||
| dynamic_vpntunnel_dynamicmapping словарь | устанавливаемые параметры верхнего уровня | |||
| _scope список / элементы=строка | без описания | |||
| name строка | без описания | |||
| vdom строка | без описания | |||
| local-ipsec строка | без описания | |||
| rc_failed список / элементы=строка | список кодов rc, при которых условия выполнения завершаются ошибкой | |||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия выполнения завершаются успешно | |||
| state строка / обязательно |
| указание на создание, обновление или удаление объекта | ||
| vpntunnel строка / обязательно | параметр (vpntunnel) в запрошенном URL | |||
| workspace_locking_adom строка | домен, который будет заблокирован для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой | |||
| workspace_locking_timeout целое число | Значение по умолчанию: 300 | максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство | ||
Примечания
Примечание
- Поддержка работы в режиме блокировки рабочего пространства в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте directivе state present.
- Для удаления объекта используйте directivе 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_dynamic_vpntunnel_dynamicmapping:
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>
vpntunnel: <your own value>
state: <value in [present, absent]>
dynamic_vpntunnel_dynamicmapping:
_scope:
-
name: <value of string>
vdom: <value of string>
local-ipsec: <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_dynamic_vpntunnel_dynamicmapping_module.html