fortinet.fortimanager.fmgr_hotspot20_anqpnairealm модуль — Настройка идентификатора сетевого доступа

Примечание

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

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

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

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

Новая функция в fortinet.fortimanager 2.0.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
hotspot20_anqpnairealm словарь	Настройка параметров верхнего уровня.
nai-list список / элементы=словарь	Устаревшее, пожалуйста, переименуйте на nai_list. Список NAI.
eap-method список / элементы=словарь	Устаревшее, пожалуйста, переименуйте на eap_method. Метод EAP.
auth-param список / элементы=словарь	Устаревшее, пожалуйста, переименуйте на 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. Варианты: `"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.
name строка / обязательно	Имя списка областей NAI.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`

END_OF_DOCUMENT_MARKER

rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут игнорироваться.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут выполняться.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	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: Configure network access identifier
      fortinet.fortimanager.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: present # <value in [present, absent]>
        hotspot20_anqpnairealm:
          nai_list:
            -
              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>
          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 список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_module.html