Модуль fortinet.fortimanager.fmgr_hotspot20_hsprofile — Настройка профиля точки доступа.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).

Эта коллекция возможно уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Для проверки установки запустите ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_hotspot20_hsprofile.

Добавлен в fortinet.fortimanager 2.0.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать согласно источникам данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (default) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (default) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
hotspot20_hsprofile dictionary	Набор параметров верхнего уровня.
3gpp-plmn string	Устарело, переименуйте в 3gpp_plmn. Имя PLMN 3GPP.
access-network-asra string	Устарело, переименуйте в access_network_asra. Включить/отключить дополнительный шаг, необходимый для доступа Варианты: `"disable"` `"enable"`
access-network-esr string	Устарело, переименуйте в access_network_esr. Включить/отключить доступ к службам экстренной помощи Варианты: `"disable"` `"enable"`
access-network-internet string	Устарело, переименуйте в access_network_internet. Включить/отключить подключение к Интернету. Варианты: `"disable"` `"enable"`
access-network-type string	Устарело, переименуйте в 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 string	Устарело, переименуйте в access_network_uesa. Включить/отключить доступ к неаутентифицированной службе экстренной помощи Варианты: `"disable"` `"enable"`
advice-of-charge string	Устарело, переименуйте в advice_of_charge. Уведомление о плате.
anqp-domain-id integer	Устарело, переименуйте в anqp_domain_id. ID домена ANQP
bss-transition string	Устарело, переименуйте в bss_transition. Включить/отключить базовый набор служб Варианты: `"disable"` `"enable"`
conn-cap string	Устарело, переименуйте в conn_cap. Имя возможности соединения.
deauth-request-timeout integer	Устарело, переименуйте в deauth_request_timeout. Время ожидания запроса на отключение от сети.
dgaf string	Включить/отключить переадресацию групповых адресов по нисходящей линии. Варианты: `"disable"` `"enable"`
domain-name string	Устарело, переименуйте в domain_name. Доменное имя.
gas-comeback-delay integer	Устарело, переименуйте в gas_comeback_delay. Задержка возврата GAS.

gas-fragmentation-limit integer	Устарело, переименуйте в gas_fragmentation_limit. Предел фрагментации GAS
hessid string	Идентификатор расширенного сервисного набора (ESSID)
ip-addr-type string	Устарело, переименуйте в ip_addr_type. Имя типа IP-адреса.
l2tif string	Включить/выключить инспекцию и фильтрацию трафика 2-го уровня. Варианты: `"disable"` `"enable"`
nai-realm string	Устарело, переименуйте в nai_realm. Имя списка областей NAI.
name string / required	Имя профиля Hotspot.
network-auth string	Устарело, переименуйте в network_auth. Имя сетевой аутентификации.
oper-friendly-name string	Устарело, переименуйте в oper_friendly_name. Отображаемое имя оператора.
oper-icon string	Устарело, переименуйте в oper_icon. Иконка оператора.
osu-provider any	(список или строка) Устарело, переименуйте в osu_provider. Вручную выбранный список провайдера OSU
osu-provider-nai string	Устарело, переименуйте в osu_provider_nai. Провайдер OSU NAI.
osu-ssid string	Устарело, переименуйте в osu_ssid. Онлайн регистрация
pame-bi string	Устарело, переименуйте в pame_bi. Включить/выключить Pre-Association Message Exchange BSSID Independent Варианты: `"disable"` `"enable"`
proxy-arp string	Устарело, переименуйте в proxy_arp. Включить/выключить Proxy ARP. Варианты: `"disable"` `"enable"`
qos-map string	Устарело, переименуйте в qos_map. ИД набора QoS MAP.
release integer	Hotspot 2.
roaming-consortium string	Устарело, переименуйте в roaming_consortium. Имя списка роумингового консорциума.
terms-and-conditions string	Устарело, переименуйте в terms_and_conditions. Условия и положения.
venue-group string	Устарело, переименуйте в venue_group. Группа мест проведения. Варианты: `"unspecified"` `"assembly"` `"business"` `"educational"` `"factory"` `"institutional"` `"mercantile"` `"residential"` `"storage"` `"utility"` `"vehicular"` `"outdoor"`
venue-name string	Устарело, переименуйте в venue_name. Название места проведения.

venue-type string	Устарело, переименуйте в venue_type. Тип места. Choices: `"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	Устарело, переименуйте в venue_url. Название места.
wan-metrics string	Устарело, переименуйте в wan_metrics. Название метрики WAN.
wba-charging-currency string	Устарело, переименуйте в wba_charging_currency. Трехбуквенный код валюты.
wba-charging-rate integer	Устарело, переименуйте в wba_charging_rate. Количество денежных единиц за килобайт.
wba-data-clearing-provider string	Устарело, переименуйте в wba_data_clearing_provider. WBA ID поставщика очистки данных.
wba-financial-clearing-provider string	Устарело, переименуйте в wba_financial_clearing_provider. WBA ID финансового клирингового провайдера.
wba-open-roaming string	Устарело, переименуйте в wba_open_roaming. Включить/выключить поддержку открытого роуминга WBA. Choices: `"disable"` `"enable"`
wnm-sleep-mode string	Устарело, переименуйте в wnm_sleep_mode. Включить/выключить управление беспроводной сетью Choices: `"disable"` `"enable"`
proposed_method string	Переопределённый метод для базового запроса Json RPC. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, с которыми будут переопределены условия неудачи.
rc_succeeded list / elements=integer	Список кодов rc, с которыми будут переопределены условия успеха.
state string / required	Директива для создания, обновления или удаления объекта. Choices: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки FortiManager, работающего в режиме рабочей области; значение может быть global и другими, включая root.
workspace_locking_timeout integer	Максимальное время ожидания (в секундах) освобождения блокировки рабочей области другим пользователем. Default: `300`

Примечания

Примечание

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

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure hotspot profile.
      fortinet.fortimanager.fmgr_hotspot20_hsprofile:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        hotspot20_hsprofile:
          3gpp_plmn: <string>
          access_network_asra: <value in [disable, enable]>
          access_network_esr: <value in [disable, enable]>
          access_network_internet: <value in [disable, enable]>
          access_network_type: <value in [private-network, private-network-with-guest-access, chargeable-public-network, ...]>
          access_network_uesa: <value in [disable, enable]>
          anqp_domain_id: <integer>
          bss_transition: <value in [disable, enable]>
          conn_cap: <string>
          deauth_request_timeout: <integer>
          dgaf: <value in [disable, enable]>
          domain_name: <string>
          gas_comeback_delay: <integer>
          gas_fragmentation_limit: <integer>
          hessid: <string>
          ip_addr_type: <string>
          l2tif: <value in [disable, enable]>
          nai_realm: <string>
          name: <string>
          network_auth: <string>
          oper_friendly_name: <string>
          osu_provider: <list or string>
          osu_ssid: <string>
          pame_bi: <value in [disable, enable]>
          proxy_arp: <value in [disable, enable]>
          qos_map: <string>
          roaming_consortium: <string>
          venue_group: <value in [unspecified, assembly, business, ...]>
          venue_name: <string>
          venue_type: <value in [unspecified, arena, stadium, ...]>
          wan_metrics: <string>
          wnm_sleep_mode: <value in [disable, enable]>
          advice_of_charge: <string>
          oper_icon: <string>
          osu_provider_nai: <string>
          release: <integer>
          terms_and_conditions: <string>
          venue_url: <string>
          wba_charging_currency: <string>
          wba_charging_rate: <integer>
          wba_data_clearing_provider: <string>
          wba_financial_clearing_provider: <string>
          wba_open_roaming: <value in [disable, enable]>

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API-запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_hotspot20_hsprofile_module.html