Модуль cisco.meraki.meraki_mr_ssid — управление беспроводными SSID в облаке Meraki

ap_availability_tags

list / elements=string

Укажите, следует ли точкам доступа (AP) транслировать SSID, если их теги совпадают с любым из тегов в этом списке.

Требуется, чтобы available_on_all_aps имел значение false.

ap_tags_vlan_ids

list / elements=dictionary

Список тегов VLAN.

Требуется, чтобы ip_assignment_mode имел значение Bridge mode или Layer 3 roaming.

Требуется, чтобы use_vlan_tagging имел значение True.

tags

list / elements=string

Список тегов точек доступа.

vlan_id

integer

Числовой идентификатор, назначенный VLAN.

auth_key

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

Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная окружения MERAKI_KEY не задана.

auth_mode

string

Задайте режим аутентификации сети.

Варианты:

• "open"
• "psk"
• "open-with-radius"
• "8021x-meraki"
• "8021x-radius"

available_on_all_aps

boolean

Укажите, должны ли все точки доступа транслировать SSID или его следует ограничить точками доступа, совпадающими с любыми тегами доступности.

Если задано значение False, необходимо определить ap_availability_tags.

Варианты:

• false
• true

band_selection

string

Задайте режим выбора диапазона.

Варианты:

• "Dual band operation"
• "5 GHz band only"
• "Dual band operation with Band Steering"

concentrator_network_id

string

Концентратор, используемый для «роуминга уровня 3 с концентратором» или «VPN».

default_vlan_id

integer

Идентификатор VLAN по умолчанию.

Требуется, чтобы ip_assignment_mode имел значение Bridge mode или Layer 3 roaming.

enabled

boolean

Включите или отключите сеть SSID.

Варианты:

• false
• true

encryption_mode

string

Задайте режим шифрования сети.

Варианты:

• "wpa"
• "eap"
• "wpa-eap"

enterprise_admin_access

string

Указывает, доступен ли SSID администраторам предприятия.

Варианты:

• "access disabled"
• "access enabled"

host

string

Имя узла панели управления Meraki.

Можно использовать для доступа к региональным средам Meraki, например в Китае.

По умолчанию: "api.meraki.com"

internal_error_retry_time

integer

Количество секунд до повторной попытки, если сервер возвращает внутреннюю ошибку.

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

ip_assignment_mode

string

Метод, используемый SSID для назначения IP-адресов.

Варианты:

• "NAT mode"
• "Bridge mode"
• "Layer 3 roaming"
• "Layer 3 roaming with a concentrator"
• "VPN"

lan_isolation_enabled

boolean

Включите или отключите изоляцию локальной сети уровня 2.

Требуется, чтобы ip_assignment_mode имел значение Bridge mode.

Варианты:

• false
• true

min_bitrate

float

Минимальная скорость передачи данных (Мбит/с), допустимая для SSID.

Варианты:

• 1.0
• 2.0
• 5.5
• 6.0
• 9.0
• 11.0
• 12.0
• 18.0
• 24.0
• 36.0
• 48.0
• 54.0

name

string

Имя SSID.

net_id

string

Идентификатор сети.

net_name

string

Имя сети.

number

псевдонимы: ssid_number

integer

Номер SSID в сети.

org_id

string

Идентификатор организации.

org_name

псевдонимы: organization

string

Название организации.

output_format

string

Указывает модулю, следует ли использовать для ключей ответа формат snake case (например, net_id) или camel case (например, netId).

Варианты:

• "snakecase" ← (по умолчанию)
• "camelcase"

output_level

string

Задайте уровень отладочного вывода во время выполнения модуля.

Варианты:

• "debug"
• "normal" ← (по умолчанию)

per_client_bandwidth_limit_down

integer

Максимальная пропускная способность загрузки для устройств в сети SSID, в Мбит/с.

per_client_bandwidth_limit_up

integer

Максимальная пропускная способность передачи данных для устройств в сети SSID, в Мбит/с.

psk

string

Пароль беспроводной сети.

Для этого параметра auth_mode должен иметь значение psk.

radius_accounting_enabled

boolean

Включите или отключите учет RADIUS.

Варианты:

• false
• true

radius_accounting_servers

list / elements=dictionary

Список серверов RADIUS для учета RADIUS.

host

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

IP-адрес или имя узла сервера RADIUS.

port

integer

Номер порта, на котором сервер RADIUS ожидает соединения.

secret

string

Пароль RADIUS.

Установка пароля не является идемпотентной.

radius_coa_enabled

boolean

Включите или отключите CoA RADIUS (изменение авторизации) для SSID.

Варианты:

• false
• true

radius_failover_policy

string

Задайте политику доступа клиентов на случай недоступности серверов RADIUS.

Варианты:

• "Deny access"
• "Allow access"

radius_load_balancing_policy

string

Задайте политику балансировки нагрузки, если указано несколько серверов RADIUS.

Варианты:

• "Strict priority order"
• "Round robin"

radius_proxy_enabled

boolean

Включите или отключите прокси-сервер RADIUS для SSID.

Варианты:

• false
• true

radius_servers

list / elements=dictionary

Список серверов RADIUS.

host

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

IP-адрес или имя узла сервера RADIUS.

port

integer

Номер порта, на котором сервер RADIUS ожидает соединения.

secret

string

Пароль RADIUS.

Установка пароля не является идемпотентной.

rate_limit_retry_time

integer

Количество секунд до повторной попытки при срабатывании ограничения частоты запросов.

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

splash_guest_sponsor_domains

list / elements=string

Список допустимых доменов электронной почты спонсоров для гостевого портала со спонсорским доступом.

splash_page

string

Включите заставку и укажите ее тип.

Варианты:

• "None"
• "Click-through splash page"
• "Billing"
• "Password-protected with Meraki RADIUS"
• "Password-protected with custom RADIUS"
• "Password-protected with Active Directory"
• "Password-protected with LDAP"
• "SMS authentication"
• "Systems Manager Sentry"
• "Facebook Wi-Fi"
• "Google OAuth"
• "Sponsored guest"
• "Cisco ISE"

state

string

Указывает, следует ли получать или изменять сведения SNMP.

Варианты:

• "absent"
• "query"
• "present" ← (по умолчанию)

timeout

integer

Время ожидания для HTTP-запросов.

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

use_https

boolean

Если no, будет использоваться HTTP. В противном случае будет использоваться HTTPS.

Полезно только для внутренних разработчиков Meraki.

Варианты:

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

use_proxy

boolean

Если no, прокси-сервер использоваться не будет, даже если он указан в переменной среды на целевых узлах.

Варианты:

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

use_vlan_tagging

boolean

Укажите, следует ли использовать тегирование VLAN.

Требуется задать default_vlan_id.

Варианты:

• false
• true

validate_certs

boolean

Указывает, следует ли проверять сертификаты HTTP.

Варианты:

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

visible

boolean

Включите или отключите трансляцию этого SSID точками доступа.

Варианты:

• false
• true

vlan_id

integer

Идентификатор VLAN для SSID.

Требуется, чтобы ip_assignment_mode имел значение ayer 3 roaming with a concentrator или VPN.

walled_garden_enabled

boolean

Включите или отключите функциональность «огороженного сада».

Варианты:

• false
• true

walled_garden_ranges

list / elements=string

Список диапазонов «огороженного сада».

wpa_encryption_mode

string

Режим шифрования в спецификации WPA.

Варианты:

• "WPA1 and WPA2"
• "WPA2 only"
• "WPA3 Transition Mode"
• "WPA3 only"

data

complex

Список беспроводных SSID.

Возвращается: при успешном выполнении

auth_mode

string

Метод аутентификации.

Возвращается: при успешном выполнении

Пример: "psk"

band_selection

string

Радиочастота беспроводной сети, в диапазоне которой она будет транслироваться.

Возвращается: при успешном выполнении

Пример: "5 GHz band only"

enabled

boolean

Состояние беспроводной сети (включена или выключена).

Возвращается: при успешном выполнении

Пример: true

encryption_mode

string

Метод шифрования беспроводного трафика.

Возвращается: при успешном выполнении

Пример: "wpa"

ip_assignment_mode

string

Метод назначения IP-адресов клиентам беспроводной сети.

Возвращается: при успешном выполнении

Пример: "NAT mode"

min_bitrate

integer

Минимальная скорость передачи данных, при которой клиент может подключиться к беспроводной сети.

Возвращается: при успешном выполнении

Пример: 11

name

string

Имя беспроводного SSID.

Это имя транслируется в эфир.

Возвращается: при успешном выполнении

Пример: "CorpWireless"

number

integer

Индекс SSID, начиная с нуля.

Возвращается: при успешном выполнении

Пример: 0

per_client_bandwidth_limit_down

integer

Максимальная пропускная способность для загрузки данных, доступная клиенту.

Возвращается: при успешном выполнении

Пример: 0

per_client_bandwidth_limit_up

integer

Максимальная пропускная способность для отправки данных, доступная клиенту.

Возвращается: при успешном выполнении

Пример: 1000

psk

string

Секретный пароль беспроводной сети.

Возвращается: при успешном выполнении

Пример: "SecretWiFiPass"

splash_page

string

Страница-заставка, отображаемая при аутентификации пользователя.

Возвращается: при успешном выполнении

Пример: "Click-through splash page"

ssid_admin_accessible

boolean

Доступен ли SSID для администрирования.

Возвращается: при успешном выполнении

Пример: true

wpa_encryption_mode

string

Включенные версии WPA.

Возвращается: при успешном выполнении

Пример: "WPA2 only"