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

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

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

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

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно			параметр (adom) в запрошенном URL
bypass_validation логическое значение		Варианты: нет ← да	устанавливается в True только в случае расхождения схемы модуля со структурой API FortiManager; модуль продолжает выполнение без проверки параметров
hotspot20_hsprofile словарь			параметры верхнего уровня
	3gpp-plmn строка		Имя PLMN 3GPP.
	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 строка		Имя возможности подключения.
	deauth-request-timeout целое число		Таймаут запроса отключения (в секундах).
	dgaf строка	Варианты: отключить включить	Включить/отключить переадресацию вниз по группе (DGAF).
	domain-name строка		Имя домена.
	gas-comeback-delay целое число		Задержка возврата GAS (0 или 100 - 4000 миллисекунд, по умолчанию = 500).
	gas-fragmentation-limit целое число		Предел фрагментации GAS (512 - 4096, по умолчанию = 1024).
	hessid строка		Однородный расширенный идентификатор набора услуг (HESSID).
	ip-addr-type строка		Имя типа адреса IP.
	l2tif строка	Варианты: отключить включить	Включить/отключить инспекцию и фильтрацию трафика второго уровня.
	nai-realm строка		Имя списка областей NAI.
	name строка		Имя профиля точки доступа.
	network-auth строка		Имя проверки подлинности сети.
	oper-friendly-name строка		Дружественное имя оператора.
	osu-provider строка		Ручной выбор списка поставщика(ов) OSU.
	osu-ssid строка		SSID онлайн-регистрации (OSU).
	pame-bi строка	Варианты: отключить включить	Включить/отключить независимый от BSSID обмен сообщениями до предварительной ассоциации (PAME-BI).
	proxy-arp строка	Варианты: отключить включить	Включить/отключить Прокси ARP.
	qos-map строка		Идентификатор набора QoS MAP.
	roaming-consortium строка		Имя списка консорциума роуминга.
	venue-group строка	Варианты: не указано собрание бизнес образование завод институциональное торговля жилой хранение утилиты транспортные средства открытый	Группа мест проведения.
	venue-name строка		Имя места проведения.
	venue-type строка	Варианты: не указано арена стадион пассажирский терминал амфитеатр парк развлечений место поклонения конференц-центр библиотека музей ресторан театр бар кофейня зоопарк или аквариум центр экстренной помощи врачебный кабинет банк пожарная часть полицейский участок почтовое отделение профессиональный офис исследовательский центр офис адвоката начальная школа средняя школа университет или колледж завод больница дом престарелых центр реабилитации групповой дом тюрьма или изолятор розничный магазин продовольственный рынок автосервисная станция торговый центр заправочная станция частный отель или мотель общежитие пансионат автомобиль самолет автобус паром судно или лодка поезд мотоцикл сет-сеть городской парк придорожная зона отдыха регулирование движения автобусная остановка киоск	Тип места проведения.
	wan-metrics строка		Имя метрики WAN.
	wnm-sleep-mode строка	Варианты: отключить включить	Включить/отключить режим сна беспроводного управления сетью (WNM).
rc_failed список / элементы=строка			список кодов rc, которые будут переопределять условия неудачи
rc_succeeded список / элементы=строка			список кодов rc, которые будут переопределять условия успеха
state строка / обязательно		Варианты: present absent	направление создания, обновления или удаления объекта
workspace_locking_adom строка			adom для блокировки FortiManager, работающего в режиме рабочей области; значение может быть глобальным и другими, включая root
workspace_locking_timeout целое число		По умолчанию: 300	максимальное время ожидания (в секундах) для других пользователей, чтобы разблокировать рабочую область

Примечания

Примечание

В этом модуле FortiManager поддерживается режим блокировки рабочего пространства, верхнеуровневые параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой при возвращении ненулевого значения rc. Вы также можете переопределить условия для завершения успехом или ошибкой с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure hotspot profile.
     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: <value in [present, absent]>
        hotspot20_hsprofile:
           3gpp-plmn: <value of 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: <value of integer>
           bss-transition: <value in [disable, enable]>
           conn-cap: <value of string>
           deauth-request-timeout: <value of integer>
           dgaf: <value in [disable, enable]>
           domain-name: <value of string>
           gas-comeback-delay: <value of integer>
           gas-fragmentation-limit: <value of integer>
           hessid: <value of string>
           ip-addr-type: <value of string>
           l2tif: <value in [disable, enable]>
           nai-realm: <value of string>
           name: <value of string>
           network-auth: <value of string>
           oper-friendly-name: <value of string>
           osu-provider: <value of string>
           osu-ssid: <value of string>
           pame-bi: <value in [disable, enable]>
           proxy-arp: <value in [disable, enable]>
           qos-map: <value of string>
           roaming-consortium: <value of string>
           venue-group: <value in [unspecified, assembly, business, ...]>
           venue-name: <value of string>
           venue-type: <value in [unspecified, arena, stadium, ...]>
           wan-metrics: <value of string>
           wnm-sleep-mode: <value in [disable, enable]>

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

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 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/fortimanager/fmgr_hotspot20_hsprofile_module.html