fortinet.fortimanager.fmgr_hotspot20_anqpnairealm – Настройка домена доступа к сети (NAI).

Примечание

Этот плагин входит в состав коллекции fortinet.fortimanager (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_hotspot20_anqpnairealm.

Новое в версии 2.10: модуля fortinet.fortimanager

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить, используя источники данных, перед использованием.

Параметры

Параметр					Варианты/Значения по умолчанию	Комментарии
adom строка / обязательный						параметр (adom) в запрошенном URL
bypass_validation булево					Варианты: нет ← да	устанавливается в значение True только в том случае, когда схема модуля отличается от структуры API FortiManager. Модуль продолжает выполняться без проверки параметров
hotspot20_anqpnairealm словарь						параметры верхнего уровня
	nai-list список / элементы=строка					нет описания
		eap-method список / элементы=строка				нет описания
			auth-param список / элементы=строка			нет описания
				id строка	Варианты: non-eap-inner-auth inner-auth-eap credential tunneled-credential	Идентификатор параметра аутентификации.
				index целое число		Индекс параметра.
				val строка	Варианты: eap-identity eap-md5 eap-tls eap-ttls eap-peap eap-sim eap-aka eap-aka-prime non-eap-pap non-eap-chap non-eap-mschap non-eap-mschapv2 cred-sim cred-usim cred-nfc cred-hardware-token cred-softoken cred-certificate cred-user-pwd cred-none cred-vendor-specific tun-cred-sim tun-cred-usim tun-cred-nfc tun-cred-hardware-token tun-cred-softoken tun-cred-certificate tun-cred-user-pwd tun-cred-anonymous tun-cred-vendor-specific	Значение параметра аутентификации.
			index целое число			Индекс метода EAP.
			method строка		Варианты: eap-identity eap-md5 eap-tls eap-ttls eap-peap eap-sim eap-aka eap-aka-prime	Тип метода EAP.
		encoding строка			Варианты: отключено включено	Включить/выключить формат в соответствии с IETF RFC 4282.
		nai-realm строка				Настройка доменов NAI (разделенных символом точки с запятой).
		name строка				Имя домена NAI.
	name строка					Имя списка доменов NAI.
rc_failed список / элементы=строка						Список кодов rc, при которых условия будут считаться невыполненными
rc_succeeded список / элементы=строка						Список кодов rc, при которых условия будут считаться выполненными
state строка / обязательный					Варианты: present absent	Директива для создания, обновления или удаления объекта
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: Configure network access identifier (NAI) realm.
     fmgr_hotspot20_anqpnairealm:
        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]>
        hotspot20_anqpnairealm:
           nai-list:
             -
                 eap-method:
                   -
                       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, ...]>
                 encoding: <value in [disable, enable]>
                 nai-realm: <value of string>
                 name: <value of string>
           name: <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_hotspot20_anqpnairealm_module.html