cisco.meraki.meraki_mr_settings – Управление общими параметрами беспроводных сетей Meraki

Примечание

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

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

Для использования в playbook, укажите: cisco.meraki.meraki_mr_settings.

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

Обзор

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

Параметры

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

Примечания

Примечание

Более подробную информацию об 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: 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

Авторы

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_settings_module.html