Модуль fortinet.fortimanager.fmgr_hotspot20_anqpnairealm_nailist – Список NAI.

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).

Вы, возможно, уже установили эту коллекцию, если используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать в playbook, укажите: fortinet.fortimanager.fmgr_hotspot20_anqpnairealm_nailist.

Добавлен в fortinet.fortimanager 2.0.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
anqp-nai-realm строка	Устаревшее значение, используйте «anqp_nai_realm»
anqp_nai_realm строка	Параметр (anqp-nai-realm) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
hotspot20_anqpnairealm_nailist словарь	Настройка параметров верхнего уровня.
eap_method список / элементы=словарь	Устаревшее значение, используйте eap_method. Тип метода EAP.
auth_param список / элементы=словарь	Устаревшее значение, используйте auth_param. Параметр аутентификации.
id строка	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. Варианты: `"eap-identity"` `"eap-md5"` `"eap-tls"` `"eap-ttls"` `"eap-peap"` `"eap-sim"` `"eap-aka"` `"eap-aka-prime"`
encoding строка	Включить/выключить формат в соответствии с RFC 4282 IETF. Варианты: `"disable"` `"enable"`
nai_realm строка	Устаревшее значение, используйте nai_realm. Настройка областей NAI.
name строка / обязательно	Имя области NAI.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`

rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут игнорироваться.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут игнорироваться.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	Область, которую нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют название с использованием подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов все еще доступны, но вы получите предупреждения о устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Поддержка работы в режиме блокировки рабочей области реализована в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают выполнить эту задачу.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой при возвращении ненулевого кода rc. Вы также можете переопределить условия завершения с ошибкой или успехом с параметрами rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: NAI list.
      fortinet.fortimanager.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: present # <value in [present, absent]>
        hotspot20_anqpnairealm_nailist:
          eap_method:
            -
              auth_param:
                -
                  id: <value in [non-eap-inner-auth, inner-auth-eap, credential, ...]>
                  index: <integer>
                  val: <value in [eap-identity, eap-md5, eap-tls, ...]>
              index: <integer>
              method: <value in [eap-identity, eap-md5, eap-tls, ...]>
          encoding: <value in [disable, enable]>
          nai_realm: <string>
          name: <string>

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложный

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_hotspot20_anqpnairealm_nailist_module.html