fortinet.fortimanager.fmgr_vpnmgr_node_ipv4excluderange – без описания
Примечание
Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_vpnmgr_node_ipv4excluderange.
Добавлена в версии 2.10: of fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить перед использованием, исходя из данных источников.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое |
| устанавливать в значение True только при несовпадении схемы модуля со структурой API FortiManager, модуль продолжает выполняться без проверки параметров | |
| node строка / обязательно | параметр (node) в запрошенном URL | ||
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут считаться выполненными с ошибкой | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут считаться выполненными успешно | ||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | |
| vpnmgr_node_ipv4excluderange словарь | параметры верхнего уровня | ||
| end-ip строка | без описания | ||
| id целое число | без описания | ||
| start-ip строка | без описания | ||
| 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_vpnmgr_node_ipv4excluderange:
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>
node: <your own value>
state: <value in [present, absent]>
vpnmgr_node_ipv4excluderange:
end-ip: <value of string>
id: <value of integer>
start-ip: <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_vpnmgr_node_ipv4excluderange_module.html
