Модуль cisco.meraki.meraki_mr_settings — управление общими настройками беспроводных сетей Meraki

Примечание

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

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

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

Чтобы использовать её в плейбуке, укажите: cisco.meraki.meraki_mr_settings.

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

УСТАРЕЛО

Удаляется в:: версии 3.0.0
Причина:: Выпущены обновлённые модули с расширенными возможностями
Альтернатива:: cisco.meraki.networks_wireless_settings

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

Позволяет настраивать общие параметры беспроводных сетей Meraki MR.

Параметры

Параметр	Комментарии
auth_key строка / обязательный	Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная среды `MERAKI_KEY` не задана.
host строка	Имя хоста панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, например в Китае. По умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд до повторной попытки, если сервер возвращает внутреннюю ошибку. По умолчанию: `60`
ipv6_bridge_enabled логический	Переключатель для включения или отключения мостового режима IPv6 в сети. Если параметр включён, для SSID также необходимо настроить мостовой режим. Варианты: `false` `true`
led_lights_on логический	Переключатель для включения или отключения светодиодных индикаторов на всех точках доступа в сети. Варианты: `false` `true`
location_analytics_enabled логический	Переключатель для включения или отключения аналитики местоположения в сети. Варианты: `false` `true`
meshing_enabled логический	Переключатель для включения или отключения ячеистой сети. Варианты: `false` `true`
net_id строка	Идентификатор сети.
net_name строка	Имя сети.
org_id строка	Идентификатор организации.
org_name псевдонимы: organization строка	Имя организации.
output_format строка	Указывает модулю, следует ли возвращать ключи в формате snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level строка	Задаёт объём отладочных данных, выводимых во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time целое число	Количество секунд до повторной попытки, если срабатывает ограничение частоты запросов. По умолчанию: `165`
state строка	Запрос или изменение настроек беспроводной сети. Варианты: `"present"` ← (по умолчанию) `"query"`
timeout целое число	Время ожидания для HTTP-запросов. По умолчанию: `30`
upgrade_strategy строка	Стратегия обновления, применяемая к сети. Требуется версия прошивки MR 26.8 или выше. Варианты: `"minimize_upgrade_time"` `"minimize_client_downtime"`
use_https логический	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy логический	Если `no`, прокси использоваться не будет, даже если он задан в переменной среды на целевых хостах. Варианты: `false` ← (по умолчанию) `true`
validate_certs логический	Проверять ли сертификаты HTTP. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Query all settings
  meraki_mr_settings:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost
- name: Configure settings
  meraki_mr_settings:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    upgrade_strategy: minimize_upgrade_time
    ipv6_bridge_enabled: false
    led_lights_on: true
    location_analytics_enabled: true
    meshing_enabled: true
  delegate_to: localhost

Возвращаемые значения

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

Ключ	Описание
data сложный тип	Список настроек беспроводной сети. Возвращается: при успехе
ipv6_bridge_enabled логический	Переключатель для включения или отключения мостового режима IPv6 в сети. Если параметр включён, для SSID также необходимо настроить мостовой режим. Возвращается: при успехе Пример: `true`
led_lights_on логический	Переключатель для включения или отключения светодиодных индикаторов на всех точках доступа в сети. Возвращается: при успехе Пример: `true`
location_analytics_enabled логический	Переключатель для включения или отключения аналитики местоположения в сети. Возвращается: при успехе Пример: `true`
meshing_enabled логический	Переключатель для включения или отключения ячеистой сети. Возвращается: при успехе Пример: `true`
upgrade_strategy строка	Стратегия обновления, применяемая к сети. Требуется версия прошивки MR 26.8 или выше. Возвращается: при успехе Пример: `"minimize_upgrade_time"`

Статус

Этот модуль будет удалён в версии 3.0.0. [устарел]
Дополнительную информацию см. в разделе УСТАРЕЛО.

Авторы

Kevin Breit (@kbreit)

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

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