fortinet.fortimanager.fmgr_hotspot20_anqpnairealm_nailist – Список NAI.

Примечание

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

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_hotspot20_anqpnairealm_nailist.

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

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

Обзор

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

Параметры

Параметр				Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно					параметр (adom) в запрошенном URL
anqp-nai-realm строка / обязательно					параметр (anqp-nai-realm) в запрошенном URL
bypass_validation булево				Варианты: нет ← да	устанавливать только в значение True, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров
hotspot20_anqpnairealm_nailist словарь					установленные параметры верхнего уровня
	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 строка			Варианты: отключить включить	Включить/отключить формат в соответствии с RFC 4282 IETF.
	nai-realm строка				Настройка областей 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: NAI list.
     fmgr_hotspot20_anqpnairealm_nailist:
        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>
        state: <value in [present, absent]>
        hotspot20_anqpnairealm_nailist:
           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>

Возвращаемые значения

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
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_module.html