fortinet.fortios.fortios_wireless_controller_vap – Настройка виртуальных точек доступа (VAP) в FortiOS и FortiGate Fortinet.
Примечание
Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).
Для его установки используйте: ansible-galaxy collection install fortinet.fortios.
Для использования в плейбуке укажите: fortinet.fortios.fortios_wireless_controller_vap.
Новое в версии 2.8: of fortinet.fortios
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию wireless_controller и категорию vap. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось на FOS v6.0.0
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ansible>=2.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| access_token строка | Аутентификация на основе токенов. Сгенерировано в интерфейсе Fortigate. | |||
| state строка добавлен в 2.9 fortinet.fortios |
| Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущих версиях на более глубоком уровне. Он был вынесен на внешний уровень. | ||
| vdom строка | Значение по умолчанию: "root" | Виртуальная область, среди тех, которые были определены ранее. VDOM — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельный узел. | ||
| wireless_controller_vap словарь | Настройка виртуальных точек доступа (VAP). | |||
| acct_interim_interval целое число | Промежуток времени учёта WiFi RADIUS (60 - 86400 сек). | |||
| alias строка | Псевдоним. | |||
| auth строка |
| Протокол аутентификации. | ||
| broadcast_ssid строка |
| Включить/выключить передачу SSID. | ||
| broadcast_suppression строка |
| Необязательное подавление широковещательных сообщений. Например, вы можете отключить сообщения DHCP, ARP-широковещания и так далее на беспроводной сети. | ||
| captive_portal_ac_name строка | Имя captive portal ac для локального моста. | |||
| captive_portal_macauth_radius_secret строка | Секретный ключ доступа к серверу RADIUS macauth. | |||
| captive_portal_macauth_radius_server строка | Имя домена или IP-адрес внешнего сервера RADIUS для captive portal. | |||
| captive_portal_radius_secret строка | Секретный ключ доступа к серверу RADIUS. | |||
| captive_portal_radius_server строка | Имя домена или IP-адрес сервера RADIUS для captive portal. | |||
| captive_portal_session_timeout_interval целое число | Промежуток времени ожидания сессии (0 - 864000 сек). | |||
| dhcp_lease_time целое число | Время аренды DHCP в секундах для IP-адреса NAT. | |||
| dhcp_option82_circuit_id_insertion строка |
| Включить/выключить вставку DHCP-опции 82 circuit-id. | ||
| dhcp_option82_insertion строка |
| Включить/выключить вставку DHCP-опции 82. | ||
| dhcp_option82_remote_id_insertion строка |
| Включить/выключить вставку DHCP-опции 82 remote-id. | ||
| dynamic_vlan строка |
| Включить/выключить динамическое назначение VLAN. | ||
| eap_reauth строка |
| Включить/выключить повторную аутентификацию EAP для безопасности WPA-Enterprise. | ||
| eap_reauth_intv целое число | Интервал повторной аутентификации EAP (1800 - 864000 сек). | |||
| eapol_key_retries строка |
| Включить/выключить повторную передачу кадров EAPOL-Key (сообщение 3/4 и групповое сообщение 1/2). | ||
| encrypt строка |
| Протокол шифрования (доступен только при настройке безопасности в типе WPA). | ||
| external_fast_roaming строка |
| Включить/выключить быстрый роуминг или предварительную аутентификацию с внешними точками доступа, не управляемыми FortiGate. | ||
| external_logout строка | URL внешнего сервера аутентификации для выхода. | |||
| external_web строка | URL внешнего веб-сервера аутентификации. | |||
| fast_bss_transition строка |
| Включить/выключить быстрый переход BSS (FT) 802.11r. | ||
| fast_roaming строка |
| Включить/выключить быстрый роуминг или предварительную аутентификацию, где это поддерживается клиентами. | ||
| ft_mobility_domain целое число | Идентификатор области подвижности в FT (1 - 65535). | |||
| ft_over_ds строка |
| Включить/выключить FT через систему распределения (DS). | ||
| ft_r0_key_lifetime целое число | Срок действия ключа PMK-R0 в FT, в минутах (1-65535). | |||
| gtk_rekey строка |
| Включить/выключить GTK-перевывод ключа для безопасности WPA. | ||
| gtk_rekey_intv целое число | Интервал перевывода ключа GTK (1800 - 864000 сек). | |||
| hotspot20_profile строка | Имя профиля Hotspot 2.0. | |||
| intra_vap_privacy строка |
| Включить/выключить блокирование связи между клиентами на одном SSID (также называется меж-SSID конфиденциальность). | ||
| ip строка | IP-адрес и маска подсети для локальной автономной подсети NAT. | |||
| key строка | Ключ WEP. | |||
| keyindex целое число | Индекс ключа WEP (1 - 4). | |||
| ldpc строка |
| Настройка кодирования VAP с низкой плотностью парности (LDPC). | ||
| local_authentication строка |
| Включить/выключить локальную аутентификацию AP. | ||
| local_bridging строка |
| Включить/выключить мост между беспроводными и Ethernet интерфейсами на FortiAP. | ||
| local_lan строка |
| Разрешить/запретить трафик, предназначенный для частного IP-адреса класса A, B или C. | ||
| local_standalone строка |
| Включить/выключить локальный автономный AP. | ||
| local_standalone_nat строка |
| Включить/выключить локальный автономный режим NAT AP. | ||
| mac_auth_bypass строка |
| Включить/выключить обход MAC-аутентификации. | ||
| mac_filter string |
| Включить/выключить фильтрацию MAC-адресов для блокировки беспроводных клиентов по MAC-адресу. | ||
| mac_filter_list list / elements=string | Создайте список MAC-адресов для фильтрации по MAC-адресам. | |||
| id integer / required | Идентификатор. | |||
| mac string | MAC-адрес. | |||
| mac_filter_policy string |
| Запретить или разрешить клиенту с этим MAC-адресом. | ||
| mac_filter_policy_other string |
| Разрешить или заблокировать клиентов с MAC-адресами, которые не находятся в списке фильтра. | ||
| max_clients integer | Максимальное количество клиентов, которые могут одновременно подключиться к VAP. | |||
| max_clients_ap integer | Максимальное количество клиентов, которые могут одновременно подключиться к каждому радиоканалу. | |||
| me_disable_thresh integer | Отключить расширение многоадресной рассылки, когда столько клиентов получают многоадресную рассылку. | |||
| mesh_backhaul string |
| Включить/выключить использование этого VAP в качестве беспроводного шлюза меша . Эта запись доступна только при настройке безопасности на тип WPA или открытом. | ||
| mpsk string |
| Включить/выключить несколько предварительно общих ключей (PSK). | ||
| mpsk_concurrent_clients integer | Количество предварительно общих ключей (PSK), разрешенных, если включены несколько предварительно общих ключей. | |||
| mpsk_key list / elements=string | Предварительно общие ключи, которые можно использовать для подключения к этой виртуальной точке доступа. | |||
| comment string | Комментарий. | |||
| concurrent_clients string | Количество клиентов, которые могут подключиться с помощью этого предварительно общего ключа. | |||
| key_name string | Название предварительно общего ключа. | |||
| passphrase string | Предварительно общий ключ WPA. | |||
| multicast_enhance string |
| Включить/выключить преобразование многоадресной рассылки в одноадресную для повышения производительности. | ||
| multicast_rate string |
| Скорость многоадресной рассылки (0, 6000, 12000 или 24000 кбит/с). | ||
| name string / required | Имя виртуальной точки доступа. | |||
| okc string |
| Включить/выключить кеширование ключей по принципу «возможности» (OKC). | ||
| passphrase string | Предварительно общий ключ (PSK) WPA, который используется для аутентификации пользователей Wi-Fi. | |||
| pmf string |
| Поддержка защищённых управляющих кадров (PMF). | ||
| pmf_assoc_comeback_timeout integer | Максимальное время ожидания возвращения защищённых управляющих кадров (PMF) (1-20 с). | |||
| pmf_sa_query_retry_timeout integer | Интервал повторных запросов SA защищённых управляющих кадров (PMF) (1-500 мс). | |||
| portal_message_override_group string | Группа замещающих сообщений для этого VAP (доступна только при настройке безопасности на тип портала captive). | |||
| portal_message_overrides dictionary | Отдельные замещающие сообщения. | |||
| auth_disclaimer_page string | Заменить сообщение auth-disclaimer-page сообщением из группы portal-message-overrides. | |||
| auth_login_failed_page string | Заменить сообщение auth-login-failed-page сообщением из группы portal-message-overrides. | |||
| auth_login_page string | Заменить сообщение auth-login-page сообщением из группы portal-message-overrides. | |||
| auth_reject_page string | Заменить сообщение auth-reject-page сообщением из группы portal-message-overrides. | |||
| portal_type string |
| Функциональность портала captive. Настройка того, как портал captive аутентифицирует пользователей и включает ли он отказ от ответственности. | ||
| probe_resp_suppression string |
| Включить/выключить подавление ответа зонда (для игнорирования слабых сигналов). | ||
| probe_resp_threshold string | Минимальный уровень сигнала/порог в дБм, необходимый для ответа AP на запросы зонда (-95 до -20). | |||
| ptk_rekey string |
| Включить/выключить переподключение PTK для безопасности WPA-Enterprise. | ||
| ptk_rekey_intv integer | Интервал переподключения PTK (1800-864000 с). | |||
| qos_profile string | Имя профиля качества обслуживания. | |||
| quarantine string |
| Включить/выключить изоляцию станции. | ||
| radius_mac_auth string |
| Включить/выключить аутентификацию MAC-адресов клиентов на основе RADIUS. | ||
| radius_mac_auth_server string | Сервер аутентификации MAC-адресов на основе RADIUS. | |||
| radius_server string | Сервер RADIUS, который будет использоваться для аутентификации пользователей Wi-Fi. | |||
| rates_11a string |
| Разрешённые скорости передачи данных для 802.11a. | ||
| rates_11ac_ss12 string |
| Разрешённые скорости передачи данных для 802.11ac с 1 или 2 пространственными потоками. | ||
| rates_11ac_ss34 string |
| Допустимые скорости передачи данных для 802.11ac с 3 или 4 пространственными потоками. | ||
| rates_11bg string |
| Допустимые скорости передачи данных для 802.11b/g. | ||
| rates_11n_ss12 string |
| Допустимые скорости передачи данных для 802.11n с 1 или 2 пространственными потоками. | ||
| rates_11n_ss34 string |
| Допустимые скорости передачи данных для 802.11n с 3 или 4 пространственными потоками. | ||
| schedule string | Имя расписания VAP. | |||
| security string |
| Режим безопасности для беспроводного интерфейса. | ||
| security_exempt_list string | Дополнительный список исключений из требований к безопасности для проверки подлинности captive portal. | |||
| security_obsolete_option string |
| Включить/выключить устаревшие параметры безопасности. | ||
| security_redirect_url string | Необязательный URL для перенаправления пользователей после успешной проверки подлинности captive portal. | |||
| selected_usergroups list / elements=string | Выбранные группы пользователей, которым разрешена проверка подлинности. | |||
| name string / required | Имя группы пользователей. | |||
| split_tunneling string |
| Включить/выключить разделенный туннелирование. | ||
| ssid string | Идентификатор набора служб IEEE 802.11 (SSID) для беспроводного интерфейса. Пользователи, желающие использовать беспроводную сеть, должны настроить свои компьютеры для доступа к этому имени SSID. | |||
| state string |
| Устарело Начиная с Ansible 2.9, рекомендуется использовать параметр «state» на верхнем уровне. Указывает, нужно ли создать или удалить объект. | ||
| tkip_counter_measure string |
| Включить/выключить контрмеры TKIP. | ||
| usergroup list / elements=string | Группа пользователей брандмауэра, используемая для аутентификации пользователей Wi-Fi. | |||
| name string / required | Имя группы пользователей. | |||
| utm_profile string | Имя профиля UTM. | |||
| vdom string | Имя VDOM, к которому добавлен виртуальный AP. Источник system.vdom.name. | |||
| vlan_auto string |
| Включить/выключить автоматическое управление интерфейсом VLAN SSID. | ||
| vlan_pool list / elements=string | Пул VLAN. | |||
| id integer / required | ID. | |||
| wtp_group string | Имя группы WTP. | |||
| vlan_pooling string |
| Включить/выключить пул VLAN, чтобы разрешить объединение нескольких VLAN беспроводных контроллеров в пулы VLAN. При установке в значение «wtp-group» объединение VLAN происходит с назначением VLAN по группе WTP. | ||
| vlanid integer | Необязательный идентификатор VLAN. | |||
| voice_enterprise string |
| Включить/выключить поддержку голосового роуминга предприятия с использованием 802.11k и 802.11v. | ||
Примечания
Примечание
- Модуль fortiosapi устарел, httpapi — предпочтительный способ запуска playbooks
Примеры
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure Virtual Access Points (VAPs).
fortios_wireless_controller_vap:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_vap:
acct_interim_interval: "3"
alias: "<your_own_value>"
auth: "psk"
broadcast_ssid: "enable"
broadcast_suppression: "dhcp-up"
captive_portal_ac_name: "<your_own_value>"
captive_portal_macauth_radius_secret: "<your_own_value>"
captive_portal_macauth_radius_server: "<your_own_value>"
captive_portal_radius_secret: "<your_own_value>"
captive_portal_radius_server: "<your_own_value>"
captive_portal_session_timeout_interval: "13"
dhcp_lease_time: "14"
dhcp_option82_circuit_id_insertion: "style-1"
dhcp_option82_insertion: "enable"
dhcp_option82_remote_id_insertion: "style-1"
dynamic_vlan: "enable"
eap_reauth: "enable"
eap_reauth_intv: "20"
eapol_key_retries: "disable"
encrypt: "TKIP"
external_fast_roaming: "enable"
external_logout: "<your_own_value>"
external_web: "<your_own_value>"
fast_bss_transition: "disable"
fast_roaming: "enable"
ft_mobility_domain: "28"
ft_over_ds: "disable"
ft_r0_key_lifetime: "30"
gtk_rekey: "enable"
gtk_rekey_intv: "32"
hotspot20_profile: "<your_own_value>"
intra_vap_privacy: "enable"
ip: "<your_own_value>"
key: "<your_own_value>"
keyindex: "37"
ldpc: "disable"
local_authentication: "enable"
local_bridging: "enable"
local_lan: "allow"
local_standalone: "enable"
local_standalone_nat: "enable"
mac_auth_bypass: "enable"
mac_filter: "enable"
mac_filter_list:
-
id: "47"
mac: "<your_own_value>"
mac_filter_policy: "allow"
mac_filter_policy_other: "allow"
max_clients: "51"
max_clients_ap: "52"
me_disable_thresh: "53"
mesh_backhaul: "enable"
mpsk: "enable"
mpsk_concurrent_clients: "56"
mpsk_key:
-
comment: "Comment."
concurrent_clients: "<your_own_value>"
key_name: "<your_own_value>"
passphrase: "<your_own_value>"
multicast_enhance: "enable"
multicast_rate: "0"
name: "default_name_64"
okc: "disable"
passphrase: "<your_own_value>"
pmf: "disable"
pmf_assoc_comeback_timeout: "68"
pmf_sa_query_retry_timeout: "69"
portal_message_override_group: "<your_own_value>"
portal_message_overrides:
auth_disclaimer_page: "<your_own_value>"
auth_login_failed_page: "<your_own_value>"
auth_login_page: "<your_own_value>"
auth_reject_page: "<your_own_value>"
portal_type: "auth"
probe_resp_suppression: "enable"
probe_resp_threshold: "<your_own_value>"
ptk_rekey: "enable"
ptk_rekey_intv: "80"
qos_profile: "<your_own_value>"
quarantine: "enable"
radius_mac_auth: "enable"
radius_mac_auth_server: "<your_own_value>"
radius_server: "<your_own_value>"
rates_11a: "1"
rates_11ac_ss12: "mcs0/1"
rates_11ac_ss34: "mcs0/3"
rates_11bg: "1"
rates_11n_ss12: "mcs0/1"
rates_11n_ss34: "mcs16/3"
schedule: "<your_own_value>"
security: "open"
security_exempt_list: "<your_own_value>"
security_obsolete_option: "enable"
security_redirect_url: "<your_own_value>"
selected_usergroups:
-
name: "default_name_98"
split_tunneling: "enable"
ssid: "<your_own_value>"
tkip_counter_measure: "enable"
usergroup:
-
name: "default_name_103"
utm_profile: "<your_own_value>"
vdom: "<your_own_value> (source system.vdom.name)"
vlan_auto: "enable"
vlan_pool:
-
id: "108"
wtp_group: "<your_own_value>"
vlan_pooling: "wtp-group"
vlanid: "111"
voice_enterprise: "disable"
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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 | всегда | Указание результата операции Пример: успех |
| 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortios/fortios_wireless_controller_vap_module.html