fortinet.fortios.fortios_wireless_controller_hotspot20_hs_profile – Настройка профиля точки доступа в FortiOS и FortiGate Fortinet.
Примечание
Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).
Для его установки используйте: ansible-galaxy collection install fortinet.fortios.
Для использования в playbook, укажите: fortinet.fortios.fortios_wireless_controller_hotspot20_hs_profile.
В версии 2.9: модуля fortinet.fortios
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию wireless_controller_hotspot20 и категорию hs_profile. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| access_token строка | Аутентификация на основе токена. Сгенерировано в интерфейсе Fortigate. | |||
| state строка / обязательно |
| Указывает, нужно ли создать или удалить объект. | ||
| vdom строка | Значение по умолчанию: "root" | Виртуальная область, среди ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный блок. | ||
| wireless_controller_hotspot20_hs_profile словарь | Настройка профиля хот-спота. | |||
| 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). | ||
| plmn_3gpp строка | Имя 3GPP PLMN. Источник wireless-controller.hotspot20.anqp-3gpp-cellular.name. | |||
| proxy_arp строка |
| Включить/выключить Proxy 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. | |||
| venue_type строка |
| Тип места проведения. | ||
| wan_metrics строка | Имя метрики WAN. Источник wireless-controller.hotspot20.h2qp-wan-metric.name. | |||
| wnm_sleep_mode строка |
| Включить/выключить режим сна управления беспроводной сетью (WNM). | ||
Примечания
Примечание
- Модуль fortiosapi устарел, httpapi — предпочтительный способ запуска плейбуков
Примеры
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure hotspot profile.
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"
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"
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| build строка | всегда | Номер сборки изображения FortiGate Пример: 1547 |
| http_method строка | всегда | Последний метод, использованный для предоставления содержимого в FortiGate Пример: PUT |
| http_status строка | всегда | Последний результат, полученный от FortiGate при последней операции Пример: 200 |
| mkey строка | успех | Главный ключ (id), используемый в последнем вызове FortiGate Пример: id |
| name строка | всегда | Имя таблицы, используемой для выполнения запроса Пример: urlfilter |
| path строка | всегда | Путь таблицы, используемой для выполнения запроса Пример: webfilter |
| revision строка | всегда | Внутренний номер ревизии Пример: 17.0.2.10658 |
| serial строка | всегда | Серийный номер устройства Пример: FGVMEVYYQT3AB5352 |
| status строка | всегда | Указание результата операции Пример: успех |
| vdom строка | всегда | Используемый виртуальный домен Пример: root |
| version строка | всегда | Версия FortiGate Пример: v5.6.3 |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortios/fortios_wireless_controller_hotspot20_hs_profile_module.html