Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager: модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.

hotspot20_anqpnairealm

dictionary

Набор параметров верхнего уровня.

nai_list

псевдонимы: nai-list

list / элементы=dictionary

Список NAI.

eap_method

псевдонимы: eap-method

list / элементы=dictionary

Метод EAP.

auth_param

псевдонимы: auth-param

list / элементы=dictionary

Параметр аутентификации.

id

string

Идентификатор параметра аутентификации.

Варианты:

  • "non-eap-inner-auth"
  • "inner-auth-eap"
  • "credential"
  • "tunneled-credential"

index

integer

Индекс параметра.

val

string

Значение параметра аутентификации.

Варианты:

  • "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

integer

Индекс метода EAP.

method

string

Тип метода EAP.

Варианты:

  • "eap-identity"
  • "eap-md5"
  • "eap-tls"
  • "eap-ttls"
  • "eap-peap"
  • "eap-sim"
  • "eap-aka"
  • "eap-aka-prime"

encoding

string

Включить или отключить форматирование в соответствии с IETF RFC 4282.

Варианты:

  • "disable"
  • "enable"

nai_realm

псевдонимы: nai-realm

string

Настройка областей NAI

name

string

Имя области NAI.

name

string / обязательный

Имя списка областей NAI.

proposed_method

string

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / элементы=integer

Список кодов rc, переопределяющий условия сбоя.

rc_succeeded

list / элементы=integer

Список кодов rc, переопределяющий условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательный

Директива для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

string

ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие ADOM, включая root.

workspace_locking_timeout

integer

Максимальное время ожидания освобождения блокировки рабочей области другим пользователем, в секундах.

По умолчанию: 300

Примечания

Примечание

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

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure network access identifier
      fortinet.fortimanager.fmgr_hotspot20_anqpnairealm:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        hotspot20_anqpnairealm:
          name: "your value" # Required variable, string
          # 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>

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

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

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / элементы=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / элементы=string

Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_hotspot20_anqpnairealm_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API