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

Новая версия 2.7.

Краткое описание
Параметры
Примечания
Примеры
Значения возврата
Состояние

Краткое описание

Позволяет управлять 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 строка		Варианты: open psk open-with-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 Спонсорский гость	Установить для включения страницы приветствия и указать тип страницы приветствия.
state строка		Варианты: отсутствует запрос наличие ←	Указывает, следует ли запрашивать или изменять информацию SNMP.

timeout integer	Значение по умолчанию: 30	Время ожидания для HTTP-запросов.
use_https boolean	Варианты: no да ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy boolean	Варианты: нет да	Если `no`, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах.
use_vlan_tagging boolean	Варианты: нет да	Установить, использовать ли тегирование VLAN. Требуется `default_vlan_id`, чтобы быть установленным.
validate_certs boolean	Варианты: нет да ←	Проверять ли HTTP-сертификаты.
vlan_id integer		Идентификатор VLAN на SSID. Требуется `ip_assignment_mode`, чтобы быть `ayer 3 roaming with a concentrator`, или `VPN`.
walled_garden_enabled boolean	Варианты: нет да	Включить или выключить функциональность walled garden.
walled_garden_ranges list		Список диапазонов walled garden.
wpa_encryption_mode string	Варианты: WPA1 и WPA2 Только WPA2	Режим шифрования в рамках спецификации WPA2.

Примечания

Примечание

Удаление SSID не удаляет RADIUS-серверы.
Дополнительная информация об API Meraki доступна по адресу 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'ы.

Примеры

- 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 complex		успех	Список беспроводных SSID.
	auth_mode string	успех	Метод аутентификации. Пример: psk
	band_selection string	успех	Беспроводная частота RF, на которой будет транслироваться беспроводная сеть. Пример: только 5 ГГц диапазон
	enabled boolean	успех	Состояние включения беспроводной сети. Пример: True
	encryption_mode string	успех	Метод шифрования беспроводного трафика. Пример: wpa
	ip_assignment_mode string	успех	Метод назначения IP-адресов беспроводным клиентам. Пример: режим NAT
	min_bitrate integer	успех	Минимальная скорость передачи данных, с которой может подключиться беспроводной клиент. Пример: 11
	name string	успех	Название беспроводного SSID. Это то значение, которое транслируется. Пример: CorpWireless
	number integer	успех	Индекс SSID, начиная с нуля.
	per_client_bandwidth_limit_down integer	успех	Максимальная пропускная способность для загрузки, которую может использовать клиент.
	per_client_bandwidth_limit_up integer	успех	Максимальная пропускная способность для выгрузки, которую может использовать клиент. Пример: 1000
	psk string	успех	Секретный беспроводной пароль. Пример: SecretWiFiPass
	splash_page string	успех	Страница splash для отображения при аутентификации пользователя. Пример: Страница клик-сквозного splash
	ssid_admin_accessible boolean	успех	Доступно ли SSID для администратора. Пример: True
	wpa_encryption_mode string	успех	Включенные версии WPA. Пример: Только WPA2

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/meraki_ssid_module.html