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

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: cisco.meraki.meraki_ms_storm_control.

Новая функция в cisco.meraki 0.0.1

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

УСТЕРЕЛО

Удалено в:: версия 3.0.0
Почему:: Выпущены обновленные модули с расширенными функциями
Альтернатива:: cisco.meraki.networks_switch_storm_control

Описание

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

Параметры

Параметр	Комментарии
auth_key строка / обязательно	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
broadcast_threshold целое число	Процент (от 1 до 99) от общей пропускной способности порта для типа трафика широковещательной рассылки. Значение по умолчанию 100 процентов - это очистка конфигурации.
host строка	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай. По умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной части. По умолчанию: `60`
multicast_threshold целое число	Процент (от 1 до 99) от общей пропускной способности порта для типа трафика многоадресной рассылки. Значение по умолчанию 100 процентов - это очистка конфигурации.
net_id строка	Идентификатор сети.
net_name строка	Имя сети.
org_id строка	Идентификатор организации.
org_name псевдонимы: organization строка	Название организации.
output_format строка	Указывает модулю, следует ли использовать ключи ответа в формате snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level строка	Установите объем отладочного вывода во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time целое число	Количество секунд для повторной попытки, если срабатывает ограничитель скорости. По умолчанию: `165`
state строка	Указывает, следует ли запросить или изменить конфигурацию контроля шторма. Варианты: `"query"` ← (по умолчанию) `"present"`
timeout целое число	Время ожидания для HTTP-запросов. По умолчанию: `30`
unknown_unicast_threshold целое число	Процент (от 1 до 99) от общей пропускной способности порта для типа трафика неизвестной одноадресной рассылки. Значение по умолчанию 100 процентов - это очистка конфигурации.
use_https логическое значение	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy логическое значение	Если `no`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Варианты: `false` ← (по умолчанию) `true`
validate_certs логическое значение	Подтверждать ли 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. Пожалуйста, обновите свои плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если существуют различия в конфигурациях, но не отправляет изменения в 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`

Статус

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