Модуль cisco.meraki.meraki_alert — управление оповещениями в облаке Meraki

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki.

Чтобы использовать её в плейбуке, укажите: cisco.meraki.meraki_alert.

Добавлено в cisco.meraki 2.1.0

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

УСТАРЕЛО

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

Краткое описание

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

Параметры

Параметр	Комментарии
alerts list / элементы=dictionary	Настройки для каждого типа оповещения.
alert_destinations dictionary	Словарь адресатов для этого оповещения.
all_admins boolean	Если значение равно true, все администраторы сети будут получать электронные письма. Варианты: `false` `true`
emails list / элементы=string	Список адресов электронной почты, на которые будут отправляться оповещения.
http_server_ids list / элементы=string	Список идентификаторов HTTP-серверов для отправки Webhook.
snmp boolean	Если значение равно true, будет отправлена SNMP-ловушка, если для этой сети настроен сервер SNMP-ловушек. Варианты: `false` `true`
alert_type string	Тип оповещения.
enabled boolean	Логическое значение, указывающее, включено или выключено оповещение. Варианты: `false` `true`
filters any	Словарь данных конфигурации, относящихся к оповещению. Будут обновлены только фильтры, относящиеся к этому оповещению. Проверка значений `filters` не выполняется. По умолчанию: `{}`
auth_key string / обязательный	Ключ аутентификации, предоставленный панелью управления. Обязателен, если не задана переменная окружения `MERAKI_KEY`.
default_destinations dictionary	Параметры адресатов, используемые, если для оповещения не указаны отдельные адресаты.
all_admins boolean	Если значение равно true, все администраторы сети будут получать электронные письма. Варианты: `false` `true`
emails list / элементы=string	Список адресов электронной почты, на которые будут отправляться оповещения.
http_server_ids list / элементы=string	Список идентификаторов HTTP-серверов для отправки Webhook.
snmp boolean	Если значение равно true, будет отправлена SNMP-ловушка, если для этой сети настроен сервер SNMP-ловушек. Варианты: `false` `true`
host string	Имя узла панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, например в Китае. По умолчанию: `"api.meraki.com"`
internal_error_retry_time integer	Количество секунд до повторной попытки, если сервер возвращает внутреннюю ошибку. По умолчанию: `60`
net_id string	Идентификатор сети.
net_name псевдонимы: name, network string	Название сети.
org_id string	Идентификатор организации.
org_name псевдонимы: organization string	Название организации.
output_format string	Указывает модулю, следует ли возвращать ключи в формате snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level string	Задаёт объём отладочной информации во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time integer	Количество секунд до повторной попытки при срабатывании ограничителя частоты запросов. По умолчанию: `165`
state string	Создать или изменить оповещение. Варианты: `"present"` ← (по умолчанию) `"query"`
timeout integer	Время ожидания для HTTP-запросов. По умолчанию: `30`
use_https boolean	Если значение равно `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy boolean	Если значение равно `no`, прокси-сервер использоваться не будет, даже если он задан переменной окружения на целевых узлах. Варианты: `false` ← (по умолчанию) `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.
В Ansible 2.13 модули Meraki перестанут поддерживать вывод в формате camel case. Обновите свои плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает с ней изменения. В режиме проверки будет сообщено об изменениях, если конфигурации различаются, но изменения не отправляются в API для проверки.

Примеры

- name: Update settings
  meraki_alert:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    default_destinations:
      emails:
        - youremail@yourcorp
        - youremail2@yourcorp
      all_admins: true
      snmp: false
    alerts:
      - alert_type: gatewayDown
        enabled: true
        filters:
          timeout: 60
        alert_destinations:
          emails:
            - youremail@yourcorp
            - youremail2@yourcorp
          all_admins: true
          snmp: false
      - alert_type: usageAlert
        enabled: true
        filters:
          period: 1200
          threshold: 104857600
        alert_destinations:
          emails:
            - youremail@yourcorp
            - youremail2@yourcorp
          all_admins: true
          snmp: false
- name: Query all settings
  meraki_alert:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

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

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

Ключ	Описание
data complex	Информация о созданном или изменённом объекте. Возвращается: информация
alerts complex	Настройки для каждого типа оповещения. Возвращается: при успешном выполнении
alert_destinations complex	Словарь адресатов для этого оповещения. Возвращается: при успешном выполнении
all_admins boolean	Если значение равно true, все администраторы сети будут получать электронные письма. Возвращается: при успешном выполнении
emails list / элементы=string	Список адресов электронной почты, на которые будут отправляться оповещения. Возвращается: при успешном выполнении
http_server_ids list / элементы=string	Список идентификаторов HTTP-серверов для отправки Webhook. Возвращается: при успешном выполнении
snmp boolean	Если значение равно true, будет отправлена SNMP-ловушка, если для этой сети настроен сервер SNMP-ловушек. Возвращается: при успешном выполнении
alert_type string	Тип оповещения. Возвращается: при успешном выполнении
enabled boolean	Логическое значение, указывающее, включено или выключено оповещение. Возвращается: при успешном выполнении
filters complex	Словарь данных конфигурации, относящихся к оповещению. Будут обновлены только фильтры, относящиеся к этому оповещению. Проверка значений `filters` не выполняется. Возвращается: при успешном выполнении
default_destinations complex	Параметры адресатов, используемые, если для оповещения не указаны отдельные адресаты. Возвращается: при успешном выполнении
all_admins boolean	Если значение равно true, все администраторы сети будут получать электронные письма. Возвращается: при успешном выполнении Пример: `true`
emails list / элементы=string	Список адресов электронной почты, на которые будут отправляться оповещения. Возвращается: при успешном выполнении
http_server_ids list / элементы=string	Список идентификаторов HTTP-серверов для отправки Webhook. Возвращается: при успешном выполнении
snmp boolean	Если значение равно true, будет отправлена SNMP-ловушка, если для этой сети настроен сервер SNMP-ловушек. Возвращается: при успешном выполнении Пример: `true`

Статус

Этот модуль будет удалён в версии 3.0.0. [устарело]
Дополнительную информацию см. в разделе УСТАРЕЛО.

Авторы

Kevin Breit (@kbreit)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/meraki/meraki_alert_module.html