Spec-Zone.ru › Ansible 2.9

fortios_wireless_controller_hotspot20_hs_profile – Настройка профиля доступа в Fortinet’s FortiOS и FortiGate

Новая версия 2.9.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

  • Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функциональность wireless_controller_hotspot20 и категорию hs_profile. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.4

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • fortiosapi>=0.9.8

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
host
строка
IP-адрес FortiOS или FortiGate.
https
логическое
    Варианты:
  • нет
  • да ←
Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
password
строка
По умолчанию:
""
Пароль FortiOS или FortiGate.
ssl_verify
логическое
    Варианты:
  • нет
  • да ←
Обеспечивает, что сертификат FortiGate должен быть проверен надлежащим центром сертификации.
state
строка / обязательно
    Варианты:
  • present
  • absent
Указывает, нужно ли создать или удалить объект.
username
строка
Имя пользователя FortiOS или FortiGate.
vdom
строка
По умолчанию:
"root"
Виртуальная область, среди тех, которые определены ранее. VDOM — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельный блок.
wireless_controller_hotspot20_hs_profile
словарь
По умолчанию:
null
Настройка профиля точки доступа.
access_network_asra
строка
    Варианты:
  • включить
  • отключить
Включить/отключить дополнительный шаг, необходимый для доступа (ASRA).
access_network_esr
строка
    Варианты:
  • включить
  • отключить
Включить/отключить доступ к службам экстренной помощи (ESR).
access_network_internet
строка
    Варианты:
  • включить
  • отключить
Включить/отключить подключение к Интернету.
access_network_type
строка
    Варианты:
  • частная сеть
  • частная сеть с доступом для гостей
  • платная общественная сеть
  • бесплатная общественная сеть
  • сеть личного устройства
  • только сеть экстренных служб
  • тестовая или экспериментальная
  • символьная подстановка
Тип сети доступа.
access_network_uesa
строка
    Варианты:
  • включить
  • отключить
Включить/отключить доступ к услугам экстренной помощи без аутентификации (UESA).
anqp_domain_id
целое число
Идентификатор домена ANQP (0-65535).
bss_transition
строка
    Варианты:
  • включить
  • отключить
Включить/отключить поддержку перехода базовой службы (BSS).
conn_cap
строка
Название возможности подключения. Источник wireless-controller.hotspot20.h2qp-conn-capability.name.
deauth_request_timeout
целое число
Время ожидания запроса на отключение (в секундах).
dgaf
строка
    Варианты:
  • включить
  • отключить
Включить/отключить переадресацию с групповым адресом вниз по потоку (DGAF).
domain_name
строка
Имя домена.
gas_comeback_delay
целое число
Задержка возврата GAS (0 или 100 - 4000 миллисекунд).
gas_fragmentation_limit
целое число
Предел фрагментации GAS (512 - 4096).
hessid
строка
Идентификатор однородного расширенного набора служб (HESSID).
ip_addr_type
строка
Название типа IP-адреса. Источник wireless-controller.hotspot20.anqp-ip-address-type.name.
l2tif
строка
    Варианты:
  • включить
  • отключить
Включить/отключить проверку и фильтрацию трафика второго уровня.
nai_realm
строка
Название списка областей NAI. Источник wireless-controller.hotspot20.anqp-nai-realm.name.
name
строка / обязательно
Имя профиля точки доступа.
network_auth
строка
Имя проверки подлинности сети. Источник wireless-controller.hotspot20.anqp-network-auth-type.name.
oper_friendly_name
строка
Дружественное имя оператора. Источник wireless-controller.hotspot20.h2qp-operator-name.name.
osu_provider
список
Вручную выбранный список поставщиков OSU.
name
строка / обязательно
Имя поставщика OSU. Источник wireless-controller.hotspot20.h2qp-osu-provider.name.
osu_ssid
строка
SSID онлайн-регистрации (OSU).
pame_bi
строка
    Варианты:
  • отключить
  • включить
Включить/отключить независимый от BSSID обмен сообщениями предварительной ассоциации (PAME-BI).
proxy_arp
строка
    Варианты:
  • включить
  • отключить
Включить/отключить прокси-ARP.
qos_map
строка
Идентификатор набора QoS MAP. Источник wireless-controller.hotspot20.qos-map.name.
roaming_consortium
строка
Название списка консорциума роуминга. Источник wireless-controller.hotspot20.anqp-roaming-consortium.name.
venue_group
строка
    Варианты:
  • не указано
  • собрание
  • бизнес
  • образование
  • завод
  • учреждение
  • торговля
  • жилой
  • хранение
  • утилиты
  • транспортное средство
  • открытый
Группа мест проведения.
venue_name
строка
Название места проведения. Источник wireless-controller.hotspot20.anqp-venue-name.name.
тип_места
строка
    Варианты:
  • не указано
  • арена
  • стадион
  • пассажирский_терминал
  • амфитеатр
  • парк_развлечений
  • место_культового_назначения
  • конференц-центр
  • библиотека
  • музей
  • ресторан
  • театр
  • бар
  • кофейня
  • зоопарк_или_аквариум
  • центр_экстренной_помощи
  • кабинет_врача
  • банк
  • пожарная_станция
  • полицейский_участок
  • почтовое_отделение
  • офис_профессионалов
  • исследовательский_центр
  • адвокатский_кабинет
  • начальная_школа
  • средняя_школа
  • университет_или_колледж
  • завод
  • больница
  • дом_длительного_пребывания
  • центр_реабилитации
  • групповой_дом
  • тюрьма_или_исправительное_учреждение
  • розничный_магазин
  • рынок_продуктов
  • станция_технического_обслуживания_авто
  • торговый_центр
  • заправочная_станция
  • частное
  • отель_или_мотель
  • общежитие
  • гостиница
  • автомобиль
  • самолет
  • автобус
  • паром
  • судно_или_лодка
  • поезд
  • мотоцикл
  • сеть_муниципального_меша
  • городской_парк
  • остановка_для_отдыха
  • управление_движением
  • автобусная_остановка
  • киоск
Тип места.
метрики_wan
строка
Имя метрики WAN. Источник wireless-controller.hotspot20.h2qp-wan-metric.name.
режим_сна_wnm
строка
    Варианты:
  • включить
  • выключить
Включение/выключение режима сна управления беспроводной сетью (WNM).

Примечания

Примечание

  • Требуется библиотека fortiosapi, разработанная Fortinet
  • Запускается как local_action в вашем playbook

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure hotspot profile.
    fortios_wireless_controller_hotspot20_hs_profile:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      wireless_controller_hotspot20_hs_profile:
        access_network_asra: "enable"
        access_network_esr: "enable"
        access_network_internet: "enable"
        access_network_type: "private-network"
        access_network_uesa: "enable"
        anqp_domain_id: "9"
        bss_transition: "enable"
        conn_cap: "<your_own_value> (source wireless-controller.hotspot20.h2qp-conn-capability.name)"
        deauth_request_timeout: "12"
        dgaf: "enable"
        domain_name: "<your_own_value>"
        gas_comeback_delay: "15"
        gas_fragmentation_limit: "16"
        hessid: "<your_own_value>"
        ip_addr_type: "<your_own_value> (source wireless-controller.hotspot20.anqp-ip-address-type.name)"
        l2tif: "enable"
        nai_realm: "<your_own_value> (source wireless-controller.hotspot20.anqp-nai-realm.name)"
        name: "default_name_21"
        network_auth: "<your_own_value> (source wireless-controller.hotspot20.anqp-network-auth-type.name)"
        oper_friendly_name: "<your_own_value> (source wireless-controller.hotspot20.h2qp-operator-name.name)"
        osu_provider:
         -
            name: "default_name_25 (source wireless-controller.hotspot20.h2qp-osu-provider.name)"
        osu_ssid: "<your_own_value>"
        pame_bi: "disable"
        proxy_arp: "enable"
        qos_map: "<your_own_value> (source wireless-controller.hotspot20.qos-map.name)"
        roaming_consortium: "<your_own_value> (source wireless-controller.hotspot20.anqp-roaming-consortium.name)"
        venue_group: "unspecified"
        venue_name: "<your_own_value> (source wireless-controller.hotspot20.anqp-venue-name.name)"
        venue_type: "unspecified"
        wan_metrics: "<your_own_value> (source wireless-controller.hotspot20.h2qp-wan-metric.name)"
        wnm_sleep_mode: "enable"

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

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

Ключ Возвращаемое Описание
версия_сборки
строка
всегда
Номер сборки образа fortigate

Пример:
1547
метод_http
строка
всегда
Последний метод, используемый для предоставления содержимого в FortiGate

Пример:
PUT
статус_http
строка
всегда
Последний результат, предоставленный FortiGate при последнем применённом действии

Пример:
200
mkey
строка
успех
Главный ключ (id), используемый в последнем вызове FortiGate

Пример:
id
имя
строка
всегда
Имя таблицы, используемой для выполнения запроса

Пример:
urlfilter
путь
строка
всегда
Путь таблицы, используемой для выполнения запроса

Пример:
webfilter
ревизия
строка
всегда
Внутренний номер ревизии

Пример:
17.0.2.10658
серийный_номер
строка
всегда
Серийный номер устройства

Пример:
FGVMEVYYQT3AB5352
статус
строка
всегда
Указание результата операции

Пример:
успех
vdom
строка
всегда
Используемый виртуальный домен

Пример:
root
версия
строка
всегда
Версия FortiGate

Пример:
v5.6.3


Статус

  • Гарантия обратной совместимости данного модуля не предоставляется. [превью]
  • Данный модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Подсказка

Если вы заметили какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_wireless_controller_hotspot20_hs_profile_module.html

Spec-Zone.ru

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