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

Примечание

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

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

Для использования в книге задач укажите: cisco.meraki.meraki_ms_storm_control.

Новое в версии 0.0.1: of 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/meraki/meraki_ms_storm_control_module.html