cisco.meraki.meraki_alert – Управление оповещениями в облаке Meraki

Примечание

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

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

Для использования в плейбуке укажите: cisco.meraki.meraki_alert.

Новое в версии 2.1.0: модуля cisco.meraki

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

Обзор

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
alerts список / элементы=словарь				Настройка для каждого типа оповещения.
	alert_destinations словарь			Хэш назначений для данного оповещения.
		all_admins логическое значение	Варианты: no yes	Если true, все администраторы сети получат электронные письма.
		emails список / элементы=строка		Список адресов электронной почты, которые получат оповещения.
		http_server_ids список / элементы=строка		Список идентификаторов HTTP-серверов, которым будет отправлен Webhook.
		snmp логическое значение	Варианты: no yes	Если true, будет отправлен SNMP-трап, если для этой сети настроен SNMP-сервер трапов.
	alert_type строка			Тип оповещения.
	enabled логическое значение		Варианты: no yes	Логическое значение, определяющее, включено или выключено оповещение.
	filters необработанные данные			Хэш конфигурации оповещения. Обновляются только фильтры, специфичные для оповещения. Проверка `filters` не выполняется.
auth_key строка / обязательно				Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
default_destinations словарь				Свойства по умолчанию для назначений, когда не указаны специфичные для оповещения назначения.
	all_admins логическое значение		Варианты: no yes	Если true, все администраторы сети получат электронные письма.
	emails список / элементы=строка			Список адресов электронной почты, которые получат оповещения.
	http_server_ids список / элементы=строка			Список идентификаторов HTTP-серверов, которым будет отправлен Webhook.
	snmp логическое значение		Варианты: no yes	Если true, будет отправлен SNMP-трап, если для этой сети настроен SNMP-сервер трапов.
host строка			По умолчанию: "api.meraki.com"	Имя хоста панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time целое число			По умолчанию: 60	Количество секунд, в течение которых будет выполняться повторная попытка, если сервер вернёт ошибку внутренней серверной ошибки.
net_id строка				Идентификатор сети.
net_name строка				Название сети. псевдонимы: name, network
org_id строка				Идентификатор организации.
org_name строка				Название организации. псевдонимы: organization
output_format строка			Варианты: snakecase ← camelcase	Указывает модулю, должны ли ключи ответа быть в формате snake case (например, `net_id`) или camel case (например, `netId`).
output_level строка			Варианты: debug normal ←	Устанавливает объём отладочной информации во время выполнения модуля.
rate_limit_retry_time целое число			По умолчанию: 165	Количество секунд, в течение которых будет выполняться повторная попытка, если срабатывает ограничитель скорости.
state строка			Варианты: present ← query	Создание или изменение оповещения.
timeout целое число			По умолчанию: 30	Время ожидания для HTTP-запросов.
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: Update settings
  meraki_alert:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    default_destinations:
      emails:
      - 'youremail@yourcorp'
      - 'youremail2@yourcorp'
      all_admins: yes
      snmp: no
    alerts:
      - type: "gatewayDown"
        enabled: yes
        filters:
          timeout: 60
        alert_destinations:
          emails:
          - 'youremail@yourcorp'
          - 'youremail2@yourcorp'
          all_admins: yes
          snmp: no
      - type: "usageAlert"
        enabled: yes
        filters:
          period: 1200
          threshold: 104857600
        alert_destinations:
          emails:
          - 'youremail@yourcorp'
          - 'youremail2@yourcorp'
          all_admins: yes
          snmp: no

- name: Query all settings
  meraki_alert:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

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

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

Ключ				Возвращаемое значение	Описание
данные сложный				информация	Информация об созданном или измененном объекте.
	предупреждения сложный			успех	Настройка предупреждений для каждого типа.
		адреса_предупреждений сложный		успех	Хеш-таблица адресов назначения для данного предупреждения.
			все_админы булево	успех	Если значение истина, все администраторы сети получат электронные письма.
			электронные_письма список / элементы=строка	успех	Список электронных писем, которые получат предупреждение(я).
			id_http_серверов список / элементы=строка	успех	Список идентификаторов HTTP-серверов, которым будет отправлен веб-хук.
			snmp булево	успех	Если значение истина, будет отправлен SNMP-ловушки, если для данной сети настроен сервер SNMP-ловушек.
		включено булево		успех	Булево значение, указывающее, включено ли предупреждение или выключено.
		фильтры сложный		успех	Хеш-таблица конфигурационных данных для предупреждения. Обновляются только фильтры, специфичные для данного предупреждения. Проверка `filters` не выполняется.
		тип строка		успех	Тип предупреждения.
	стандартные_назначения сложный			успех	Свойства пунктов назначения, когда не указаны адреса, специфичные для предупреждения.
		все_админы булево		успех	Если значение истина, все администраторы сети получат электронные письма. Пример: Истина
		электронные_письма список / элементы=строка		успех	Список электронных писем, которые получат предупреждение(я).
		id_http_серверов список / элементы=строка		успех	Список идентификаторов HTTP-серверов, которым будет отправлен веб-хук.
		snmp булево		успех	Если значение истина, будет отправлен SNMP-ловушки, если для данной сети настроен сервер SNMP-ловушек. Пример: Истина

Авторы

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