cisco.meraki.meraki_switch_storm_control – Управление конфигурацией контроля всплеска на коммутаторе Meraki в облаке Meraki

Примечание

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

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

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

Введено в версии 0.0.1: модуля cisco.meraki

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Позволяет управлять настройками контроля всплеска для коммутаторов Meraki MS.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_key строка / обязательно		Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не установлена.
broadcast_threshold целое число		Процент (от 1 до 99) от общей доступной пропускной способности порта для типа трафика широковещательной передачи. Значение по умолчанию 100 процентов означает сброс конфигурации.
host строка	По умолчанию: "api.meraki.com"	Имя хоста панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time целое число	По умолчанию: 60	Количество секунд, которые необходимо ждать для повторной попытки, если сервер возвращает ошибку внутренней системы.
multicast_threshold целое число		Процент (от 1 до 99) от общей доступной пропускной способности порта для типа трафика многоадресной рассылки. Значение по умолчанию 100 процентов означает сброс конфигурации.
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 строка	Варианты: query ← present	Указывает, нужно ли запросить конфигурацию контроля всплеска или изменить её.
timeout целое число	По умолчанию: 30	Время ожидания для HTTP-запросов.
unknown_unicast_threshold целое число		Процент (от 1 до 99) от общей доступной пропускной способности порта для типа трафика неизвестной одноадресной рассылки. Значение по умолчанию 100 процентов означает сброс конфигурации.
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: Set broadcast settings
  meraki_switch_storm_control:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    broadcast_threshold: 75
    multicast_threshold: 70
    unknown_unicast_threshold: 65
  delegate_to: localhost

- name: Query storm control settings
  meraki_switch_storm_control:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
  delegate_to: localhost

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

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

Ключ		Возвращаемое значение	Описание
data сложный		success	Запрашиваемая или обновленная информация о конфигурации контроля всплеска.
	broadcast_threshold целое число	success	Процент (от 1 до 99) от общей доступной пропускной способности порта для типа трафика широковещательной передачи. Значение по умолчанию 100 процентов означает сброс конфигурации. Пример: 42
	multicast_threshold целое число	success	Процент (от 1 до 99) от общей доступной пропускной способности порта для типа трафика многоадресной рассылки. Значение по умолчанию 100 процентов означает сброс конфигурации. Пример: 42
	unknown_unicast_threshold целое число	success	Процент (от 1 до 99) от общей доступной пропускной способности порта для типа трафика неизвестной одноадресной рассылки. Значение по умолчанию 100 процентов означает сброс конфигурации. Пример: 42

Авторы

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