Spec-Zone.ru › Ansible

fortinet.fortios.fortios_wireless_controller_hotspot20_hs_profile модуль — Настройка профиля точки доступа в FortiOS и FortiGate Fortinet.

Примечание

Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).

Возможно, эта коллекция уже установлена, если вы используете пакет 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.15

Параметры

Параметр

Комментарии

access_token

строка

Аутентификация на основе токенов. Сгенерировано в графическом интерфейсе Fortigate.

enable_log

логический

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

Варианты:

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

member_path

строка

Путь к атрибуту члена для выполнения операции.

Разделяется слешем, если атрибутов несколько.

Параметр, помеченный member_path, подходит для выполнения операции с членом.

member_state

строка

Добавить или удалить члена по указанному пути к атрибуту.

При указании member_state параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

строка / обязательно

Указывает, нужно ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

строка

Виртуальная область (vdom) из ранее определенных. Vdom — виртуальная инстанция FortiGate, настраиваемая и используемая как отдельное устройство.

По умолчанию: "root"

wireless_controller_hotspot20_hs_profile

словарь

Настройка профиля точки доступа.

access_network_asra

строка

Включить/выключить дополнительный шаг, необходимый для доступа (ASRA).

Варианты:

  • "enable"
  • "disable"

access_network_esr

строка

Включить/выключить доступ к службам экстренной связи (ESR).

Варианты:

  • "enable"
  • "disable"

access_network_internet

строка

Включить/выключить подключение к Интернету.

Варианты:

  • "enable"
  • "disable"

access_network_type

строка

Тип сети доступа.

Варианты:

  • "private-network"
  • "private-network-with-guest-access"
  • "chargeable-public-network"
  • "free-public-network"
  • "personal-device-network"
  • "emergency-services-only-network"
  • "test-or-experimental"
  • "wildcard"

access_network_uesa

строка

Включить/выключить доступ к неопознанным службам экстренной связи (UESA).

Варианты:

  • "enable"
  • "disable"

advice_of_charge

строка

Уведомление об оплате. Источник wireless-controller.hotspot20.h2qp-advice-of-charge.name.

anqp_domain_id

целое число

Идентификатор домена ANQP (0-65535).

bss_transition

строка

Включить/выключить поддержку перехода базовой службы (BSS).

Варианты:

  • "enable"
  • "disable"

conn_cap

строка

Название возможности подключения. Источник wireless-controller.hotspot20.h2qp-conn-capability.name.

deauth_request_timeout

целое число

Таймаут запроса отключения (в секундах).

dgaf

строка

Включить/выключить переадресацию с групповым адресом в нисходящем направлении (DGAF).

Варианты:

  • "enable"
  • "disable"

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

Включить/отключить инспекцию и фильтрацию трафика 2-го уровня.

Варианты:

  • "enable"
  • "disable"

nai_realm

string

Имя списка областей NAI. Источник wireless-controller.hotspot20.anqp-nai-realm.name.

name

string / required

Имя профиля Hotspot.

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 / required

Имя поставщика 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

Включить/отключить Pre-Association Message Exchange BSSID Independent (PAME-BI).

Варианты:

  • "disable"
  • "enable"

plmn_3gpp

string

Имя 3GPP PLMN. Источник wireless-controller.hotspot20.anqp-3gpp-cellular.name.

proxy_arp

string

Включить/отключить Proxy ARP.

Варианты:

  • "enable"
  • "disable"

qos_map

string

ID набора 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

Группа мест.

Варианты:

  • "unspecified"
  • "assembly"
  • "business"
  • "educational"
  • "factory"
  • "institutional"
  • "mercantile"
  • "residential"
  • "storage"
  • "utility"
  • "vehicular"
  • "outdoor"

venue_name

string

Название места. Источник wireless-controller.hotspot20.anqp-venue-name.name.

venue_type

string

Тип места.

Варианты:

  • "unspecified"
  • "arena"
  • "stadium"
  • "passenger-terminal"
  • "amphitheater"
  • "amusement-park"
  • "place-of-worship"
  • "convention-center"
  • "library"
  • "museum"
  • "restaurant"
  • "theater"
  • "bar"
  • "coffee-shop"
  • "zoo-or-aquarium"
  • "emergency-center"
  • "doctor-office"
  • "bank"
  • "fire-station"
  • "police-station"
  • "post-office"
  • "professional-office"
  • "research-facility"
  • "attorney-office"
  • "primary-school"
  • "secondary-school"
  • "university-or-college"
  • "factory"
  • "hospital"
  • "long-term-care-facility"
  • "rehab-center"
  • "group-home"
  • "prison-or-jail"
  • "retail-store"
  • "grocery-market"
  • "auto-service-station"
  • "shopping-mall"
  • "gas-station"
  • "private"
  • "hotel-or-motel"
  • "dormitory"
  • "boarding-house"
  • "automobile"
  • "airplane"
  • "bus"
  • "ferry"
  • "ship-or-boat"
  • "train"
  • "motor-bike"
  • "muni-mesh-network"
  • "city-park"
  • "rest-area"
  • "traffic-control"
  • "bus-stop"
  • "kiosk"

venue_url

string

Название места. Источник wireless-controller.hotspot20.anqp-venue-url.name.

wan_metrics

string

Название метрики WAN. Источник wireless-controller.hotspot20.h2qp-wan-metric.name.

wnm_sleep_mode

string

Включить/выключить режим сна управления беспроводной сетью (WNM).

Варианты:

  • "enable"
  • "disable"

Примечания

Примечание

  • Модуль fortiosapi устарел, рекомендуется использовать httpapi для выполнения playbooks
  • Модуль поддерживает режим проверки (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)"
          wnm_sleep_mode: "enable"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

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

Пример: "1547"

http_method

string

Последний метод, использованный для предоставления контента в FortiGate

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

Пример: "PUT"

http_status

string

Последний результат, полученный от FortiGate при последней выполненной операции

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

Пример: "200"

mkey

string

Главный ключ (id), использованный в последнем вызове FortiGate

Возвращается: успешно

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

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

Пример: "urlfilter"

path

string

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

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

Пример: "webfilter"

revision

string

Внутренний номер ревизии

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

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

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

Пример: "FGVMEVYYQT3AB5352"

status

string

Указание результата операции

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

Пример: "success"

vdom

string

Использованный виртуальный домен

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

Пример: "root"

version

string

Версия 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_wireless_controller_hotspot20_hs_profile_module.html

Spec-Zone.ru

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