Модуль fortinet.fortios.fortios_wireless_controller_hotspot20_hs_profile — настройка профиля точки доступа в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для работы с этим модулем необходимы дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_wireless_controller_hotspot20_hs_profile.
Добавлено в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию wireless_controller_hotspot20 и категорию hs_profile. В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено с FOS v6.0.0
Требования
На узле, на котором выполняется этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate. |
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту участника, над которым выполняется операция. Если атрибутов несколько, они разделяются косой чертой. Параметр с указанием member_path можно использовать для выполнения операции над участником. |
member_state string | Добавить или удалить участника по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, следует ли создать или удалить объект. Варианты:
|
vdom string | Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
wireless_controller_hotspot20_hs_profile dictionary | Настройка профиля хот-спота. |
|
access_network_asra string |
Включить/отключить дополнительный шаг, необходимый для доступа (ASRA). Варианты:
|
|
access_network_esr string |
Включить/отключить доступность служб экстренной помощи (ESR). Варианты:
|
|
access_network_internet string |
Включить/отключить подключение к Интернету. Варианты:
|
|
access_network_type string |
Тип сети доступа. Варианты:
|
|
access_network_uesa string |
Включить/отключить доступность служб экстренной помощи без аутентификации (UESA). Варианты:
|
|
advice_of_charge string |
Информация о стоимости. Источник: wireless-controller.hotspot20.h2qp-advice-of-charge.name. |
|
anqp_domain_id integer |
Идентификатор домена ANQP (0–65535). |
bss_transition string | Включить/отключить поддержку перехода между базовыми наборами служб (BSS). Варианты:
|
|
conn_cap string |
Имя параметра возможностей подключения. Источник: wireless-controller.hotspot20.h2qp-conn-capability.name. |
|
deauth_request_timeout integer |
Время ожидания запроса на отмену аутентификации (в секундах). |
|
dgaf string | Включить/отключить пересылку широковещательных кадров для групповых адресов (DGAF). Варианты:
|
|
domain_name string |
Доменное имя. |
|
gas_comeback_delay integer |
Задержка возврата GAS (0 или 100–10000 миллисекунд). |
|
gas_fragmentation_limit integer |
Предел фрагментации GAS (512–4096). |
|
hessid string |
Идентификатор однородного расширенного набора служб (HESSID). |
|
ip_addr_type string |
Имя типа IP-адреса. Источник: wireless-controller.hotspot20.anqp-ip-address-type.name. |
|
l2tif string |
Включить/отключить проверку и фильтрацию трафика второго уровня. Варианты:
|
|
nai_realm string |
Имя списка доменов NAI. Источник: wireless-controller.hotspot20.anqp-nai-realm.name. |
|
name string / обязательный |
Имя профиля хот-спота. |
|
network_auth string |
Имя типа сетевой аутентификации. Источник: wireless-controller.hotspot20.anqp-network-auth-type.name. |
|
oper_friendly_name string |
Удобочитаемое имя оператора. Источник: wireless-controller.hotspot20.h2qp-operator-name.name. |
|
oper_icon string |
Значок оператора. Источник: wireless-controller.hotspot20.icon.name. |
|
osu_provider list / elements=dictionary |
Список поставщиков OSU, выбранных вручную. |
|
name string / обязательный |
Имя поставщика OSU. Источник: wireless-controller.hotspot20.h2qp-osu-provider.name. |
|
osu_provider_nai string |
NAI поставщика OSU. Источник: wireless-controller.hotspot20.h2qp-osu-provider-nai.name. |
|
osu_ssid string |
SSID для онлайн-регистрации (OSU). |
|
pame_bi string |
Включить/отключить обмен сообщениями до ассоциации, независимый от BSSID (PAME-BI). Варианты:
|
|
plmn_3gpp string |
Имя PLMN 3GPP. Источник: wireless-controller.hotspot20.anqp-3gpp-cellular.name. |
|
proxy_arp string |
Включить/отключить Proxy ARP. Варианты:
|
|
qos_map string |
Идентификатор набора QoS MAP. Источник: wireless-controller.hotspot20.qos-map.name. |
|
release integer |
Номер версии Hotspot 2.0 (1, 2, 3). |
|
roaming_consortium string |
Имя списка роуминговых консорциумов. Источник: wireless-controller.hotspot20.anqp-roaming-consortium.name. |
|
terms_and_conditions string |
Условия использования. Источник: wireless-controller.hotspot20.h2qp-terms-and-conditions.name. |
|
venue_group string |
Группа места проведения. Варианты:
|
|
venue_name string |
Название места проведения. Источник: wireless-controller.hotspot20.anqp-venue-name.name. |
|
venue_type string |
Тип места проведения. Варианты:
|
|
venue_url string |
Название места проведения. Источник: wireless-controller.hotspot20.anqp-venue-url.name. |
|
wan_metrics string |
Имя метрики WAN. Источник: wireless-controller.hotspot20.h2qp-wan-metric.name. |
|
wba_charging_currency string |
Трехбуквенный код валюты. |
|
wba_charging_rate integer |
Количество денежных единиц за килобайт. |
|
wba_data_clearing_provider string |
Идентификатор WBA поставщика клиринга данных. |
|
wba_financial_clearing_provider string |
Идентификатор WBA поставщика финансового клиринга. |
|
wba_open_roaming string |
Включить/отключить поддержку открытого роуминга WBA. Варианты:
|
|
wnm_sleep_mode string |
Включить/отключить режим сна управления беспроводной сетью (WNM). Варианты:
|
Примечания
Примечание
- Устаревшая библиотека fortiosapi больше не поддерживается; для запуска плейбуков рекомендуется использовать httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Configure hotspot profile.
fortinet.fortios.fortios_wireless_controller_hotspot20_hs_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_hotspot20_hs_profile:
plmn_3gpp: "<your_own_value> (source wireless-controller.hotspot20.anqp-3gpp-cellular.name)"
access_network_asra: "enable"
access_network_esr: "enable"
access_network_internet: "enable"
access_network_type: "private-network"
access_network_uesa: "enable"
advice_of_charge: "<your_own_value> (source wireless-controller.hotspot20.h2qp-advice-of-charge.name)"
anqp_domain_id: "0"
bss_transition: "enable"
conn_cap: "<your_own_value> (source wireless-controller.hotspot20.h2qp-conn-capability.name)"
deauth_request_timeout: "60"
dgaf: "enable"
domain_name: "<your_own_value>"
gas_comeback_delay: "500"
gas_fragmentation_limit: "1024"
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_22"
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)"
oper_icon: "<your_own_value> (source wireless-controller.hotspot20.icon.name)"
osu_provider:
-
name: "default_name_27 (source wireless-controller.hotspot20.h2qp-osu-provider.name)"
osu_provider_nai: "<your_own_value> (source wireless-controller.hotspot20.h2qp-osu-provider-nai.name)"
osu_ssid: "<your_own_value>"
pame_bi: "disable"
proxy_arp: "enable"
qos_map: "<your_own_value> (source wireless-controller.hotspot20.qos-map.name)"
release: "2"
roaming_consortium: "<your_own_value> (source wireless-controller.hotspot20.anqp-roaming-consortium.name)"
terms_and_conditions: "<your_own_value> (source wireless-controller.hotspot20.h2qp-terms-and-conditions.name)"
venue_group: "unspecified"
venue_name: "<your_own_value> (source wireless-controller.hotspot20.anqp-venue-name.name)"
venue_type: "unspecified"
venue_url: "<your_own_value> (source wireless-controller.hotspot20.anqp-venue-url.name)"
wan_metrics: "<your_own_value> (source wireless-controller.hotspot20.h2qp-wan-metric.name)"
wba_charging_currency: "<your_own_value>"
wba_charging_rate: "0"
wba_data_clearing_provider: "<your_own_value>"
wba_financial_clearing_provider: "<your_own_value>"
wba_open_roaming: "disable"
wnm_sleep_mode: "enable"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Мастер-ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успешном выполнении Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат выполнения операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/fortios/fortios_wireless_controller_hotspot20_hs_profile_module.html