fortinet.fortimanager.fmgr_switchcontroller_securitypolicy_captiveportal – Названия VLAN, использующих аутентификацию через портал для доступа в Интернет.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_switchcontroller_securitypolicy_captiveportal
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое |
| устанавливается в значение True только в случае расхождения схемы модуля со структурой API FortiManager. Модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут считаться выполненными с ошибкой | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут считаться выполненными успешно | ||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | |
| switchcontroller_securitypolicy_captiveportal словарь | устанавливаемые параметры верхнего уровня | ||
| name строка | Имя политики. | ||
| policy-type строка |
| Тип политики. | |
| vlan строка | Названия VLAN, использующих аутентификацию через портал для доступа в Интернет. | ||
| workspace_locking_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: Names of VLANs that use captive portal authentication.
fmgr_switchcontroller_securitypolicy_captiveportal:
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]>
switchcontroller_securitypolicy_captiveportal:
name: <value of string>
policy-type: <value in [captive-portal]>
vlan: <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_switchcontroller_securitypolicy_captiveportal_module.html
