fortinet.fortimanager.fmgr_dynamic_interface – нет описания
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_dynamic_interface.
Новое в версии 2.10: из fortinet.fortimanager
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать, используя источники данных, перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||||
| bypass_validation логическое значение |
| устанавливается только в значение True, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |||
| dynamic_interface словарь | параметры верхнего уровня | ||||
| color целое число | нет описания | ||||
| default-mapping строка |
| нет описания | |||
| defmap-intf строка | нет описания | ||||
| defmap-intrazone-deny строка |
| нет описания | |||
| defmap-zonemember строка | нет описания | ||||
| description строка | нет описания | ||||
| dynamic_mapping список / элементы=строка | нет описания | ||||
| _scope список / элементы=строка | нет описания | ||||
| name строка | нет описания | ||||
| vdom строка | нет описания | ||||
| egress-shaping-profile строка | нет описания | ||||
| intrazone-deny строка |
| нет описания | |||
| local-intf строка | нет описания | ||||
| egress-shaping-profile строка | нет описания | ||||
| name строка | нет описания | ||||
| single-intf строка |
| нет описания | |||
| 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: no description
fmgr_dynamic_interface:
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]>
dynamic_interface:
color: <value of integer>
default-mapping: <value in [disable, enable]>
defmap-intf: <value of string>
defmap-intrazone-deny: <value in [disable, enable]>
defmap-zonemember: <value of string>
description: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
egress-shaping-profile: <value of string>
intrazone-deny: <value in [disable, enable]>
local-intf: <value of string>
egress-shaping-profile: <value of string>
name: <value of string>
single-intf: <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_dynamic_interface_module.html