cisco.meraki.meraki_ms_storm_control – Управление настройками контроля штормов на коммутаторе в облаке Meraki

Примечание

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

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

Чтобы использовать его в книге задач, укажите: cisco.meraki.meraki_ms_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 сложный		успех	Информация, запрошенная или обновленная конфигурация контроля штормов.
	broadcast_threshold целое число	успех	Процент (от 1 до 99) от общей пропускной способности порта для типа трафика широковещательной передачи. Значение по умолчанию 100 процентов означает удаление конфигурации. Пример: 42
	multicast_threshold целое число	успех	Процент (от 1 до 99) от общей пропускной способности порта для типа трафика многоадресной рассылки. Значение по умолчанию 100 процентов означает удаление конфигурации. Пример: 42
	unknown_unicast_threshold целое число	успех	Процент (от 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_ms_storm_control_module.html