Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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 / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров.

Варианты:

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

enable_log

boolean

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

Варианты:

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

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.

hotspot20_hsprofile

dictionary

Набор параметров верхнего уровня.

3gpp_plmn

псевдонимы: 3gpp-plmn

string

Название PLMN 3GPP.

access_network_asra

псевдонимы: access-network-asra

string

Включить/отключить необходимость дополнительного шага для доступа

Варианты:

  • "disable"
  • "enable"

access_network_esr

псевдонимы: access-network-esr

string

Включить/отключить доступность служб экстренной помощи

Варианты:

  • "disable"
  • "enable"

access_network_internet

псевдонимы: access-network-internet

string

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

Варианты:

  • "disable"
  • "enable"

access_network_type

псевдонимы: access-network-type

string

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

Варианты:

  • "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

псевдонимы: access-network-uesa

string

Включить/отключить доступность служб экстренной помощи без аутентификации

Варианты:

  • "disable"
  • "enable"

advice_of_charge

псевдонимы: advice-of-charge

string

Информация о стоимости.

anqp_domain_id

псевдонимы: anqp-domain-id

integer

Идентификатор домена ANQP

bss_transition

псевдонимы: bss-transition

string

Включить/отключить набор базовых служб

Варианты:

  • "disable"
  • "enable"

conn_cap

псевдонимы: conn-cap

string

Название возможностей подключения.

deauth_request_timeout

псевдонимы: deauth-request-timeout

integer

Время ожидания запроса на деаутентификацию

dgaf

string

Включить/отключить пересылку пакетов, адресованных группам, в направлении вниз по сети

Варианты:

  • "disable"
  • "enable"

domain_name

псевдонимы: domain-name

string

Доменное имя.

gas_comeback_delay

псевдонимы: gas-comeback-delay

integer

Задержка повторного обращения GAS

gas_fragmentation_limit

псевдонимы: gas-fragmentation-limit

integer

Предел фрагментации GAS

hessid

string

Идентификатор однородного расширенного набора служб

ip_addr_type

псевдонимы: ip-addr-type

string

Название типа IP-адреса.

l2tif

string

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

Варианты:

  • "disable"
  • "enable"

nai_realm

псевдонимы: nai-realm

string

Название списка областей NAI.

name

string / обязательный

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

network_auth

псевдонимы: network-auth

string

Название метода сетевой аутентификации.

oper_friendly_name

псевдонимы: oper-friendly-name

string

Удобное имя оператора.

oper_icon

псевдонимы: oper-icon

string

Значок оператора.

osu_provider

псевдонимы: osu-provider

any

(список или строка) Список поставщиков OSU, выбранный вручную

osu_provider_nai

псевдонимы: osu-provider-nai

string

NAI поставщика OSU.

osu_ssid

псевдонимы: osu-ssid

string

Онлайн-регистрация

pame_bi

псевдонимы: pame-bi

string

Включить/отключить обмен сообщениями до ассоциации, независимый от BSSID (PAME-BI)

Варианты:

  • "disable"
  • "enable"

proxy_arp

псевдонимы: proxy-arp

string

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

Варианты:

  • "disable"
  • "enable"

qos_map

псевдонимы: qos-map

string

Идентификатор набора карты QoS.

release

integer

Hotspot 2.

roaming_consortium

псевдонимы: roaming-consortium

string

Название списка консорциумов роуминга.

terms_and_conditions

псевдонимы: terms-and-conditions

string

Условия использования.

venue_group

псевдонимы: venue-group

string

Группа мест проведения.

Варианты:

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

venue_name

псевдонимы: venue-name

string

Название места проведения.

venue_type

псевдонимы: 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

псевдонимы: venue-url

string

Название места проведения.

wan_metrics

псевдонимы: wan-metrics

string

Название метрик WAN.

wba_charging_currency

псевдонимы: wba-charging-currency

string

Трёхбуквенный код валюты.

wba_charging_rate

псевдонимы: wba-charging-rate

integer

Количество денежных единиц за килобайт.

wba_data_clearing_provider

псевдонимы: wba-data-clearing-provider

string

Идентификатор WBA поставщика услуг взаиморасчётов за данные.

wba_financial_clearing_provider

псевдонимы: wba-financial-clearing-provider

string

Идентификатор WBA поставщика услуг финансовых взаиморасчётов.

wba_open_roaming

псевдонимы: wba-open-roaming

string

Включить/отключить поддержку открытого роуминга WBA.

Варианты:

  • "disable"
  • "enable"

wnm_sleep_mode

псевдонимы: wnm-sleep-mode

string

Включить/отключить управление беспроводной сетью

Варианты:

  • "disable"
  • "enable"

proposed_method

string

Метод, переопределяющий базовый запрос Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, переопределяющий условия возникновения ошибки.

rc_succeeded

list / elements=integer

Список кодов rc, переопределяющий условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательный

Директива для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

string

ADOM для блокировки в FortiManager, работающем в режиме рабочей области. В качестве значения можно указать global и другие ADOM, включая root.

workspace_locking_timeout

integer

Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем.

По умолчанию: 300

Примечания

Примечание

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

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure hotspot profile.
      fortinet.fortimanager.fmgr_hotspot20_hsprofile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        hotspot20_hsprofile:
          name: "your value" # Required variable, string
          # 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>
          # 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

dictionary

Результат запроса.

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

request_url

string

Полный URL запроса.

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

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

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

Пример: 0

response_data

list / elements=string

Ответ API.

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

response_message

string

Описание ответа API.

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

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

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

rc

integer

Статус запроса.

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

Пример: 0

version_check_warning

list / elements=string

Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_hotspot20_hsprofile_module.html

Spec-Zone.ru

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