Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

УСТАРЕВШИЙ

Удалён в:

версии 3.0.0

Почему:

Обновлённые модули выпущены с повышенной функциональностью

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

cisco.meraki.networks_wireless_settings

Описание

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

Параметры

Параметр

Комментарии

auth_key

string / required

Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды MERAKI_KEY не установлена.

host

string

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

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

Default: "api.meraki.com"

internal_error_retry_time

integer

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

Default: 60

ipv6_bridge_enabled

boolean

Переключатель для включения или отключения моста IPv6 в сети.

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

Choices:

  • false
  • true

led_lights_on

boolean

Переключатель для включения или отключения светодиодов на всех AP в сети.

Choices:

  • false
  • true

location_analytics_enabled

boolean

Переключатель для включения или отключения аналитики местоположения для вашей сети.

Choices:

  • false
  • true

meshing_enabled

boolean

Переключатель для включения или отключения мешинга в сети.

Choices:

  • false
  • true

net_id

string

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

net_name

string

Имя сети.

org_id

string

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

org_name

aliases: organization

string

Имя организации.

output_format

string

Указывает модулю, должны ли ключи ответа быть в формате snake case (например, net_id) или camel case (например, netId).

Choices:

  • "snakecase" ← (default)
  • "camelcase"

output_level

string

Устанавливает объем отладочного вывода во время выполнения модуля.

Choices:

  • "debug"
  • "normal" ← (default)

rate_limit_retry_time

integer

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

Default: 165

state

string

Запрос или редактирование настроек беспроводной сети.

Choices:

  • "present" ← (default)
  • "query"

timeout

integer

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

Default: 30

upgrade_strategy

string

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

Требуется версия прошивки MR 26.8 или выше.

Choices:

  • "minimize_upgrade_time"
  • "minimize_client_downtime"

use_https

boolean

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

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

Choices:

  • false
  • true ← (default)

use_proxy

boolean

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

Choices:

  • false ← (default)
  • true

validate_certs

boolean

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

Варианты:

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

Примечания

Примечание

  • Дополнительную информацию об 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

сложный

Список настроек беспроводной связи.

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

ipv6_bridge_enabled

boolean

Переключатель для включения или отключения IPv6-моста в сети.

При включении SSID также должны быть настроены для использования режима моста.

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

Пример: true

led_lights_on

boolean

Переключатель для включения или отключения светодиодов на всех точках доступа в сети.

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

Пример: true

location_analytics_enabled

boolean

Переключатель для включения или отключения аналитики местоположений для вашей сети.

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

Пример: true

meshing_enabled

boolean

Переключатель для включения или отключения объединения в сети.

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

Пример: true

upgrade_strategy

строка

Стратегия обновления, применяемая к сети.

Требуется версия микропрограммы MR 26.8 или выше.

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

Пример: "minimize_upgrade_time"

Статус

  • Этот модуль будет удален в версии 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_settings_module.html

Spec-Zone.ru

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