Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции cisco.meraki (версия 2.18.2).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki.

Чтобы использовать её в книге задач, укажите: cisco.meraki.meraki_mr_ssid.

  • УСТАРЕЛО
  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

УСТАРЕЛО

Удалено в:

версии 3.0.0

Почему:

Выпущены обновлённые модули с расширенными возможностями

Альтернатива:

cisco.meraki.networks_wireless_ssids

Описание

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

Параметры

Параметр

Комментарии

ap_availability_tags

список / элементы=строка

Указывает, будет ли SSID транслироваться AP с метками, совпадающими с любыми метками в этом списке.

Требуется available_on_all_aps, чтобы быть false.

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"

available_on_all_aps

логическое значение

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

Требуется ap_availability_tags, когда установлено False.

Варианты:

  • false
  • true

band_selection

строка

Установка режима выбора диапазона.

Варианты:

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

concentrator_network_id

строка

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

default_vlan_id

целое число

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

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

enabled

логическое значение

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

Варианты:

  • false
  • true

encryption_mode

строка

Установка режима шифрования сети.

Варианты:

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

enterprise_admin_access

строка

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

Варианты:

  • "access disabled"
  • "access enabled"

host

строка

Имя хоста для панели управления Meraki.

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

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

internal_error_retry_time

целое число

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

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

ip_assignment_mode

строка

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

Варианты:

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

lan_isolation_enabled

логическое значение

Включить или отключить изоляцию L2 LAN.

Требуется ip_assignment_mode, чтобы быть Bridge mode.

Варианты:

  • false
  • true

min_bitrate

вещественное число

Минимальная битрейт (Мбит/с) разрешенная на 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

строка

Имя SSID.

net_id

строка

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

net_name

string

Имя сети.

number

aliases: ssid_number

integer

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

org_id

string

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

org_name

aliases: 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

Включить или выключить RADIUS CoA (изменение авторизации) для 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 Proxy для SSID.

Варианты:

  • false
  • true

radius_servers

list / elements=dictionary

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

host

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

IP-адрес или имя хоста сервера RADIUS.

port

integer

Порт сервера RADIUS.

secret

string

Пароль RADIUS.

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

rate_limit_retry_time

целое число

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

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

splash_guest_sponsor_domains

список / элементы=строка

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

splash_page

строка

Установите для включения страницы splash и укажите тип splash.

Варианты:

  • "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

строка

Определяет, нужно ли запрашивать или изменять информацию SNMP.

Варианты:

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

timeout

целое число

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

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

use_https

логический тип

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

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

Варианты:

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

use_proxy

логический тип

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

Варианты:

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

use_vlan_tagging

логический тип

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

Требуется default_vlan_id, чтобы быть установленным.

Варианты:

  • false
  • true

validate_certs

логический тип

Подтверждать ли HTTP-сертификаты.

Варианты:

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

visible

логический тип

Включить или отключить, должны ли точки доступа транслировать эту SSID.

Варианты:

  • false
  • true

vlan_id

целое число

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

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

walled_garden_enabled

логический тип

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

Варианты:

  • false
  • true

walled_garden_ranges

список / элементы=строка

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

wpa_encryption_mode

строка

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

Варианты:

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

Примечания

Примечание

  • Удаление 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
    visible: 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.

Возвращается: success

auth_mode

string

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

Возвращается: success

Пример: "psk"

band_selection

string

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

Возвращается: success

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

enabled

boolean

Включенное состояние беспроводной сети.

Возвращается: success

Пример: true

encryption_mode

string

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

Возвращается: success

Пример: "wpa"

ip_assignment_mode

string

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

Возвращается: success

Пример: "NAT mode"

min_bitrate

integer

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

Возвращается: success

Пример: 11

name

string

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

Это значение транслируется.

Возвращается: success

Пример: "CorpWireless"

number

integer

Нумерованный индекс для SSID.

Возвращается: success

Пример: 0

per_client_bandwidth_limit_down

integer

Максимальная пропускная способность загрузки, которую может использовать клиент.

Возвращается: success

Пример: 0

per_client_bandwidth_limit_up

integer

Максимальная пропускная способность загрузки, которую может использовать клиент.

Возвращается: success

Пример: 1000

psk

string

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

Возвращается: success

Пример: "SecretWiFiPass"

splash_page

string

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

Возвращается: success

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

ssid_admin_accessible

boolean

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

Возвращается: success

Пример: true

wpa_encryption_mode

string

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

Возвращается: success

Пример: "WPA2 only"

Статус

  • Этот модуль будет удален в версии 3.0.0. [устарело]
  • Для получения дополнительной информации см. УСТАРЕВШИЙ.

Авторы

  • Kevin Breit (@kbreit)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (исходники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/meraki_mr_ssid_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API