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

Примечание

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

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

Чтобы использовать его в playbook, укажите: cisco.meraki.meraki_ssid.

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ap_tags_vlan_ids список / элементы=словарь			Список тегов VLAN. Требуется `ip_assignment_mode` быть `Bridge mode` или `Layer 3 roaming`. Требуется `use_vlan_tagging` быть `True`.
	теги список / элементы=строка		Список тегов AP.
	vlan_id целое число		Числовой идентификатор, назначенный VLAN.
ключ_аутентификации строка / обязательно			Ключ аутентификации, предоставленный панелью управления. Обязательно, если переменная среды `MERAKI_KEY` не задана.
режим_аутентификации строка		Варианты: открытый psk открытый-с-radius 8021x-meraki 8021x-radius	Устанавливает режим аутентификации сети.
выбор_диапазона строка		Варианты: Двухдиапазонная работа Только диапазон 5 ГГц Двухдиапазонная работа с направлением полосы	Устанавливает режим выбора диапазона.
идентификатор_концентратора_сети строка			Концентратор, используемый для «роуминга по 3-му слою с концентратором» или «VPN».
id_vlan_по_умолчанию целое число			ID VLAN по умолчанию. Требуется `ip_assignment_mode` быть `Bridge mode` или `Layer 3 roaming`.
включено булево		Варианты: нет да	Включить или выключить сеть SSID.
режим_шифрования строка		Варианты: wpa eap wpa-eap	Устанавливает режим шифрования сети.
хост строка		Значение по умолчанию: "api.meraki.com"	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
время_повторной_попытки_внутренней_ошибки целое число		Значение по умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает ошибку внутреннего сервера.
режим_назначения_ip строка		Варианты: Режим NAT Режим моста Роуминг по 3-му слою Роуминг по 3-му слою с концентратором VPN	Метод, используемый SSID для назначения IP-адресов.
минимальная_скорость_битов вещественное число		Варианты: 1 2 5.5 6 9 11 12 18 24 36 48 54	Минимальная скорость передачи данных (Мбит/с) на SSID.
имя строка			Имя SSID.
id_сети строка			Идентификатор сети.
название_сети строка			Название сети.
номер целое число			Номер SSID в сети. псевдонимы: номер_ssid
id_организации строка			Идентификатор организации.
название_организации строка			Название организации. псевдонимы: организация
формат_вывода строка		Варианты: snakecase ← camelcase	Указывает модулю, следует ли использовать ключи ответа в формате snake case (например, `net_id`) или camel case (например, `netId`).
уровень_вывода строка		Варианты: отладка обычный ←	Устанавливает количество отладочных выводов во время выполнения модуля.
предел_пропускной_способности_на_клиента_вниз целое число			Максимальная пропускная способность в Мбит/с, которую устройства на SSID могут загружать.
предел_пропускной_способности_на_клиента_вверх целое число			Максимальная пропускная способность в Мбит/с, которую устройства на SSID могут загружать.
psk строка			Пароль для беспроводной сети. Требуется, чтобы режим auth_mode был установлен на psk.
включена_учетная_запись_radius булево		Варианты: нет да	Включить или выключить учет RADIUS.
серверы_учета_radius список / элементы=словарь			Список серверов RADIUS для учета RADIUS.
	хост строка / обязательно		IP-адрес или имя хоста сервера RADIUS.
	порт целое число		Номер порта, на котором сервер RADIUS прослушивает.
	секрет строка		Пароль RADIUS. Установка пароля не идемпотентна.
включена_функция_radius_coa булево		Варианты: нет да	Включить или выключить RADIUS CoA (изменение авторизации) на SSID.
политика_переключения_radius строка		Варианты: Запретить доступ Разрешить доступ	Установить политику доступа к клиенту на случай, если серверы RADIUS недоступны.
политика_балансировки_нагрузки_radius строка		Варианты: Строгий порядок приоритетов Круговая очередь	Установить политику балансировки нагрузки при указании нескольких серверов RADIUS.
серверы_radius список / элементы=словарь			Список серверов RADIUS.
	хост строка / обязательно		IP-адрес или имя хоста сервера RADIUS.
	порт целое число		Номер порта, на котором сервер RADIUS прослушивает.
	секрет строка		Пароль RADIUS. Установка пароля не идемпотентна.
время_повторной_попытки_ограничения_скорости целое число		Значение по умолчанию: 165	Количество секунд для повторной попытки, если ограничитель скорости срабатывает.
splash_страница строка		Варианты: Нет Пропускающая страница Платежи Защищенная паролем с Meraki RADIUS Защищенная паролем с настраиваемым RADIUS Защищенная паролем с Active Directory Защищенная паролем с LDAP Аутентификация по SMS Systems Manager Sentry Facebook Wi-Fi Google OAuth Спонсируемый гость	Устанавливает включение страницы Splash и указывает тип Splash.
состояние строка		Варианты: отсутствует запрос наличие ←	Указывает, должна ли запрашиваться или изменяться информация SNMP.
тайм-аут целое число		Значение по умолчанию: 30	Время тайм-аута для запросов HTTP.
использовать_https булево		Варианты: нет да ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезна только для внутренних разработчиков Meraki.
использовать_прокси булево		Варианты: нет ← да	Если `no`, прокси не будет использоваться, даже если она определена в переменной среды на целевых хостах.
использовать_метки_vlan булево		Варианты: нет да	Устанавливает использование меток VLAN. Требуется `default_vlan_id`.
валидировать_сертификаты булево		Варианты: нет да ←	Включает или отключает проверку сертификатов HTTP.
vlan_id целое число			Номер ID VLAN на SSID. Требуется `ip_assignment_mode` быть `ayer 3 roaming with a concentrator` или `VPN`.
функция_закрытого_сада_включена булево		Варианты: нет да	Включить или выключить функциональность закрытого сада.
диапазоны_закрытого_сада список / элементы=строка			Список диапазонов закрытого сада.
режим_шифрования_wpa строка		Варианты: WPA1 и WPA2 Только WPA2 WPA3 Режим перехода Только WPA3	Режим шифрования в спецификации WPA.

Примечания

Примечание

Удаление SSID не приводит к удалению серверов RADIUS.
Дополнительную информацию о Meraki API можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые из опций, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake case. Чтобы использовать camel case, установите переменную среды ANSIBLE_MERAKI_FORMAT в значение camelcase.
Модули Ansible для Meraki прекратят поддержку вывода в формате 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 строка	успех	Беспроводная частота RF, на которой будет транслироваться беспроводная сеть. Пример: Только диапазон 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/meraki/meraki_ssid_module.html