fortinet.fortimanager.fmgr_wtpprofile – Настройка профилей WTP или профилей FortiAP, определяющих настройки радио для управляемых платформ FortiAP.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_wtpprofile.
Введено в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | |||
| bypass_validation булево |
| устанавливается только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | ||
| rc_failed список / элементы=строка | список кодов rc, при которых условия отказа будут переопределены | |||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия успеха будут переопределены | |||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | ||
| workspace_locking_adom строка | adom для блокировки FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая корневой | |||
| workspace_locking_timeout целое число | Значение по умолчанию: 300 | максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство | ||
| wtpprofile словарь | параметры верхнего уровня | |||
| allowaccess список / элементы=строка |
| нет описания | ||
| ap-country строка |
| Страна, в которой будет работать данная точка доступа WTP, FortiAP или AP (по умолчанию = NA, автоматически используется страна, настроенная для текущего…) | ||
| ble-profile строка | Имя профиля Bluetooth Low Energy. | |||
| comment строка | Комментарий. | |||
| control-message-offload список / элементы=строка |
| нет описания | ||
| deny-mac-list список / элементы=строка | нет описания | |||
| id целое число | ID. | |||
| mac строка | Устройство Wi-Fi с этим MAC-адресом получает отказ в доступе к этой точке доступа WTP, FortiAP или AP. | |||
| dtls-in-kernel строка |
| Включить/выключить DTLS канала данных в ядре. | ||
| dtls-policy список / элементы=строка |
| нет описания | ||
| energy-efficient-ethernet строка |
| Включить/выключить использование энергоэффективного Ethernet на точке доступа WTP. | ||
| ext-info-enable строка |
| Включить/выключить информацию расширения станции/VAP/радио. | ||
| handoff-roaming строка |
| Включить/выключить балансировку нагрузки клиентов во время роуминга для избежания задержки роуминга (по умолчанию = выключить). | ||
| handoff-rssi целое число | Минимальное значение индикатора силы принимаемого сигнала (RSSI) для роуминга (20 - 30, по умолчанию = 25). | |||
| handoff-sta-thresh целое число | Пороговое значение для переключения точек доступа AP. | |||
| ip-fragment-preventing список / элементы=строка |
| нет описания | ||
| led-schedules строка | Ежедневные графики брандмауэра для включения светодиодов на FortiAP. Если led-state включен, светодиоды будут видны, когда... | |||
| led-state строка |
| Включить/выключить использование светодиодов на WTP (по умолчанию = выключить). | ||
| lldp строка |
| Включить/выключить протокол обнаружения уровня канала (LLDP) для WTP, FortiAP или AP (по умолчанию = выключить). | ||
| login-passwd строка | нет описания | |||
| login-passwd-change строка |
| Изменить или сбросить пароль администратора управляемой точки доступа WTP, FortiAP или AP (да, по умолчанию или нет, по умолчанию = нет). | ||
| max-clients целое число | Максимальное количество станций (STAs), поддерживаемых WTP (по умолчанию = 0, что означает отсутствие ограничения на клиентов). | |||
| name строка | Имя профиля WTP (или FortiAP или AP). | |||
| poe-mode строка |
| Установить режим PoE для WTP, FortiAP или AP. | ||
| split-tunneling-acl список / элементы=строка | нет описания | |||
| dest-ip строка | IP-адрес назначения и маска для подсети с разделенным туннелированием. | |||
| id целое число | ID. | |||
| split-tunneling-acl-local-ap-subnet строка |
| Включить/выключить автоматическое добавление локальной подсети FortiAP в ACL разделенного туннелирования (по умолчанию = выключить). | ||
| split-tunneling-acl-path строка |
| Путь ACL разделенного туннелирования — локальный/туннель. | ||
| tun-mtu-downlink целое число | MTU туннеля CAPWAP нисходящего канала (0, 576 или 1500 байт, по умолчанию = 0). | |||
| tun-mtu-uplink целое число | MTU туннеля CAPWAP восходящего канала (0, 576 или 1500 байт, по умолчанию = 0). | |||
| wan-port-mode строка |
| Включить/выключить использование порта WAN как порта LAN. | ||
Примечания
Примечание
- В этом модуле 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 WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
fmgr_wtpprofile:
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]>
wtpprofile:
allowaccess:
- https
- ssh
- snmp
- http
- telnet
ap-country: <value in [AL, DZ, AR, ...]>
ble-profile: <value of string>
comment: <value of string>
control-message-offload:
- ebp-frame
- aeroscout-tag
- ap-list
- sta-list
- sta-cap-list
- stats
- aeroscout-mu
- sta-health
deny-mac-list:
-
id: <value of integer>
mac: <value of string>
dtls-in-kernel: <value in [disable, enable]>
dtls-policy:
- clear-text
- dtls-enabled
- ipsec-vpn
energy-efficient-ethernet: <value in [disable, enable]>
ext-info-enable: <value in [disable, enable]>
handoff-roaming: <value in [disable, enable]>
handoff-rssi: <value of integer>
handoff-sta-thresh: <value of integer>
ip-fragment-preventing:
- tcp-mss-adjust
- icmp-unreachable
led-schedules: <value of string>
led-state: <value in [disable, enable]>
lldp: <value in [disable, enable]>
login-passwd: <value of string>
login-passwd-change: <value in [no, yes, default]>
max-clients: <value of integer>
name: <value of string>
poe-mode: <value in [auto, 8023af, 8023at, ...]>
split-tunneling-acl:
-
dest-ip: <value of string>
id: <value of integer>
split-tunneling-acl-local-ap-subnet: <value in [disable, enable]>
split-tunneling-acl-path: <value in [tunnel, local]>
tun-mtu-downlink: <value of integer>
tun-mtu-uplink: <value of integer>
wan-port-mode: <value in [wan-lan, wan-only]>
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_wtpprofile_module.html