fortinet.fortimanager.fmgr_hotspot20_anqpnairealm_nailist_eapmethod – Методы EAP.
Примечание
Этот плагин входит в состав коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_hotspot20_anqpnairealm_nailist_eapmethod.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| adom строка / обязательный | параметр (adom) в запрошенном URL | |||
| anqp-nai-realm строка / обязательный | параметр (anqp-nai-realm) в запрошенном URL | |||
| bypass_validation булево |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров | ||
| hotspot20_anqpnairealm_nailist_eapmethod словарь | параметры верхнего уровня | |||
| auth-param список / элементы=строка | нет описания | |||
| id строка |
| Идентификатор параметра аутентификации. | ||
| index целое число | Индекс параметра. | |||
| val строка |
| Значение параметра аутентификации. | ||
| index целое число | Индекс метода EAP. | |||
| method строка |
| Тип метода EAP. | ||
| nai-list строка / обязательный | параметр (nai-list) в запрошенном URL | |||
| rc_failed список / элементы=строка | список кодов rc, с помощью которых будут переопределены условия для завершения работы с ошибкой | |||
| rc_succeeded список / элементы=строка | список кодов rc, с помощью которых будут переопределены условия успешного завершения работы | |||
| state строка / обязательный |
| направление для создания, обновления или удаления объекта | ||
| 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: EAP Methods.
fmgr_hotspot20_anqpnairealm_nailist_eapmethod:
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>
anqp-nai-realm: <your own value>
nai-list: <your own value>
state: <value in [present, absent]>
hotspot20_anqpnairealm_nailist_eapmethod:
auth-param:
-
id: <value in [non-eap-inner-auth, inner-auth-eap, credential, ...]>
index: <value of integer>
val: <value in [eap-identity, eap-md5, eap-tls, ...]>
index: <value of integer>
method: <value in [eap-identity, eap-md5, eap-tls, ...]>
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_hotspot20_anqpnairealm_nailist_eapmethod_module.html