fortinet.fortimanager.fmgr_user_securityexemptlist_rule – Настройка правил для освобождения пользователей от проверки подлинности на портале Captive Portal.
Примечание
Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_user_securityexemptlist_rule.
Новое в версии 2.10: плагина fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить по источникам данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательный | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое значение |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполняться без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, при которых будут игнорироваться условия сбоя | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых будут игнорироваться условия успеха | ||
| security-exempt-list строка / обязательный | параметр (security-exempt-list) в запрошенном URL | ||
| state строка / обязательный |
| указание на создание, обновление или удаление объекта | |
| user_securityexemptlist_rule словарь | настройка параметров верхнего уровня | ||
| devices строка | Устройства или группы устройств. | ||
| dstaddr строка | Адреса назначения или группы адресов. | ||
| id целое число | Идентификатор. | ||
| service строка | Услуги назначения. | ||
| srcaddr строка | Адреса источника или группы адресов. | ||
| 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: Configure rules for exempting users from captive portal authentication.
fmgr_user_securityexemptlist_rule:
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>
security-exempt-list: <your own value>
state: <value in [present, absent]>
user_securityexemptlist_rule:
devices: <value of string>
dstaddr: <value of string>
id: <value of integer>
service: <value of string>
srcaddr: <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_user_securityexemptlist_rule_module.html