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

Примечание

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

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

Для использования в книге задач укажите: 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 булево	Варианты: no yes	Переключатель для включения или отключения IPv6-моста в сети. Если включено, SSID также должны быть настроены для использования режима моста.
led_lights_on булево	Варианты: no yes	Переключатель для включения или отключения светодиодов на всех точках доступа в сети.
location_analytics_enabled булево	Варианты: no yes	Переключатель для включения или отключения аналитики местоположения для вашей сети.
meshing_enabled булево	Варианты: no yes	Переключатель для включения или отключения мешинга в сети.
net_id строка		ID сети.
net_name строка		Имя сети.
org_id строка		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 yes ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy булево	Варианты: no ← yes	Если `no`, прокси не будет использоваться, даже если она определена в переменной среды на целевых хостах.
validate_certs булево	Варианты: no yes ←	Требовать валидацию сертификатов 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. Обновите свои книги задач.
Режим проверки загружает текущую конфигурацию с панели управления, затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/meraki/meraki_mr_settings_module.html