cisco.meraki.meraki_mr_ssid – Управление беспроводными SSID в облаке Meraki

Примечание

Этот плагин входит в коллекцию cisco.meraki (версия 2.2.0).

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

Для использования в плейбуке укажите: cisco.meraki.meraki_mr_ssid.

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

Обзор

Позволяет управлять SSID в беспроводной среде Meraki.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ap_tags_vlan_ids список / элементы=словарь			Список тегов VLAN. Требуется `ip_assignment_mode` для `Bridge mode` или `Layer 3 roaming`. Требуется `use_vlan_tagging` для `True`.
	tags список / элементы=строка		Список тегов AP.
	vlan_id целое число		Числовой идентификатор, назначенный VLAN.
auth_key строка / обязательно			Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
auth_mode строка		Варианты: открытый psk открытый с RADIUS 8021x-meraki 8021x-radius	Установить режим аутентификации сети.
band_selection строка		Варианты: Двухполосная работа Только 5 ГГц Двухполосная работа с функцией выбора полосы	Установить режим выбора полосы.
concentrator_network_id строка			Концентратор для использования в режимах «роуминг по слою 3 с концентратором» или «VPN».
default_vlan_id целое число			Идентификатор VLAN по умолчанию. Требуется `ip_assignment_mode` для `Bridge mode` или `Layer 3 roaming`.
enabled булево		Варианты: нет да	Включить или выключить сеть SSID.
encryption_mode строка		Варианты: wpa eap wpa-eap	Установить режим шифрования сети.
host строка		Значение по умолчанию: "api.meraki.com"	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time целое число		Значение по умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней службы.
ip_assignment_mode строка		Варианты: Режим NAT Режим моста Роуминг по слою 3 Роуминг по слою 3 с концентратором VPN	Метод, используемый SSID для назначения IP-адресов.
min_bitrate число с плавающей точкой		Варианты: 1 2 5.5 6 9 11 12 18 24 36 48 54	Минимальная скорость передачи данных (Мбит/с) для SSID.
name строка			Имя SSID.
net_id строка			Идентификатор сети.
net_name строка			Имя сети.
number целое число			Номер SSID в сети. псевдонимы: ssid_number
org_id строка			Идентификатор организации.
org_name строка			Название организации. псевдонимы: organization
output_format строка		Варианты: snakecase ← camelcase	Указывает модулю, следует ли использовать ключи ответа в формате snake case (например, `net_id`) или camel case (например, `netId`).
output_level строка		Варианты: отладка обычный ←	Установить объем отладочных сообщений во время выполнения модуля.
per_client_bandwidth_limit_down целое число			Максимальная пропускная способность (Мбит/с) для загрузки устройств на SSID.
per_client_bandwidth_limit_up целое число			Максимальная пропускная способность (Мбит/с) для загрузки устройств на SSID.
psk строка			Пароль для беспроводной сети. Требуется, если auth_mode установлен на psk.
radius_accounting_enabled булево		Варианты: нет да	Включить или выключить учёт RADIUS.
radius_accounting_servers список / элементы=словарь			Список RADIUS-серверов для учёта RADIUS.
	host строка / обязательно		IP-адрес или имя хоста RADIUS-сервера.
	port целое число		Порт, на котором RADIUS-сервер слушает запросы.
	secret строка		Пароль RADIUS. Установка пароля не идемпотентна.
radius_coa_enabled булево		Варианты: нет да	Включить или выключить RADIUS CoA (Изменение авторизации) на SSID.
radius_failover_policy строка		Варианты: Отказ в доступе Разрешить доступ	Установить политику переключения доступа в случае недоступности RADIUS-серверов.
radius_load_balancing_policy строка		Варианты: Строгий порядок приоритетов По кругу	Установить политику балансировки нагрузки при указании нескольких RADIUS-серверов.
radius_servers список / элементы=словарь			Список RADIUS-серверов.
	host строка / обязательно		IP-адрес или имя хоста RADIUS-сервера.
	port целое число		Порт, на котором RADIUS-сервер слушает запросы.
	secret строка		Пароль RADIUS. Установка пароля не идемпотентна.
rate_limit_retry_time целое число		Значение по умолчанию: 165	Количество секунд для повторной попытки, если срабатывает ограничитель скорости.
splash_page строка		Варианты: Нет Простая страница Платежная Защищенная паролем с Meraki RADIUS Защищенная паролем с пользовательским RADIUS Защищенная паролем с Active Directory Защищенная паролем с LDAP Аутентификация по SMS Systems Manager Sentry Facebook Wi-Fi Google OAuth Спонсируемый гость Cisco ISE	Установить для включения страницы входа и указать её тип.
state строка		Варианты: отсутствует запрос наличие ←	Указывает, следует ли запрашивать или изменять информацию SNMP.
timeout целое число		Значение по умолчанию: 30	Время ожидания HTTP-запросов.
use_https булево		Варианты: нет да ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только внутренним разработчикам Meraki.
use_proxy булево		Варианты: нет ← да	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах.
use_vlan_tagging булево		Варианты: нет да	Указать использовать ли теги VLAN. Требуется установить `default_vlan_id`.
validate_certs булево		Варианты: нет да ←	Требовать проверку HTTP-сертификатов.
vlan_id целое число			Идентификатор VLAN на SSID. Требуется `ip_assignment_mode` для `ayer 3 roaming with a concentrator` или `VPN`.
walled_garden_enabled булево		Варианты: нет да	Включить или выключить функциональность «огражденного сада».
walled_garden_ranges список / элементы=строка			Список диапазонов «огражденного сада».
wpa_encryption_mode строка		Варианты: WPA1 и WPA2 Только WPA2 Режим перехода WPA3 Только WPA3	Режим шифрования в рамках спецификации WPA.

Примечания

Примечание

Удаление SSID не удаляет серверы RADIUS.
Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками внутри Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake case. Чтобы использовать формат camel case, установите переменную среды ANSIBLE_MERAKI_FORMAT в значение camelcase.
Модули Meraki от Ansible перестанут поддерживать вывод camel case в Ansible 2.13. Обновите свои playbook.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит о внесённых изменениях, если в конфигурациях есть отличия, но не отправит изменения в API для проверки изменений.

Примеры

- name: Enable and name SSID
  meraki_ssid:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: WiFi
    name: GuestSSID
    enabled: true
  delegate_to: localhost

- name: Set PSK with invalid encryption mode
  meraki_ssid:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: WiFi
    name: GuestSSID
    auth_mode: psk
    psk: abc1234
    encryption_mode: eap
  ignore_errors: yes
  delegate_to: localhost

- name: Configure RADIUS servers
  meraki_ssid:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: WiFi
    name: GuestSSID
    auth_mode: open-with-radius
    radius_servers:
      - host: 192.0.1.200
        port: 1234
        secret: abc98765
  delegate_to: localhost

- name: Enable click-through splash page
  meraki_ssid:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: WiFi
    name: GuestSSID
    splash_page: Click-through splash page
  delegate_to: localhost

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

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

Ключ		Возвращаемое значение	Описание
data сложное		успех	Список беспроводных SSID.
	auth_mode строка	успех	Метод аутентификации. Пример: psk
	band_selection строка	успех	Беспроводная частота радиосети, на которой будет транслироваться беспроводная сеть. Пример: только 5 ГГц диапазон
	enabled логическое значение	успех	Состояние включения беспроводной сети. Пример: True
	encryption_mode строка	успех	Метод шифрования беспроводного трафика. Пример: wpa
	ip_assignment_mode строка	успех	Метод назначения IP-адреса беспроводному клиенту. Пример: режим NAT
	min_bitrate целое число	успех	Минимальная скорость передачи данных, на которой может подключиться беспроводной клиент. Пример: 11
	name строка	успех	Имя беспроводного SSID. Это значение, которое транслируется. Пример: CorpWireless
	number целое число	успех	Номер индекса SSID с нуля.
	per_client_bandwidth_limit_down целое число	успех	Максимальная пропускная способность для загрузки, которую может использовать клиент.
	per_client_bandwidth_limit_up целое число	успех	Максимальная пропускная способность для загрузки, которую может использовать клиент. Пример: 1000
	psk строка	успех	Секретный беспроводной пароль. Пример: SecretWiFiPass
	splash_page строка	успех	Всплывающая страница, которая отображается при аутентификации пользователя. Пример: Всплывающая страница перехода по клику
	ssid_admin_accessible логическое значение	успех	Доступно ли SSID для администратора. Пример: True
	wpa_encryption_mode строка	успех	Включенные версии WPA. Пример: только WPA2

Авторы

Kevin Breit (@kbreit)

© 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/cisco/meraki/meraki_mr_ssid_module.html