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

Примечание

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

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

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

Добавлен в версии 2.1.0: модуля cisco.meraki

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

Обзор

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
alerts список / элементы=словарь				Конфигурация для каждого типа оповещения.
	alert_destinations словарь			Словарь назначений для данного оповещения.
		all_admins логическое	Варианты: нет да	Если true, все администраторы сети получат письма.
		emails список / элементы=строка		Список адресов электронной почты, которые получат оповещения.
		http_server_ids список / элементы=строка		Список идентификаторов HTTP-серверов для отправки веб-хуков.
		snmp логическое	Варианты: нет да	Если true, будет отправлен SNMP-трап, если для этой сети настроен сервер SNMP-трапов.
	alert_type строка			Тип оповещения.
	enabled логическое		Варианты: нет да	Логическое значение, показывающее, включено или выключено оповещение.
	filters сырые данные			Словарь данных конфигурации для оповещения. Будут обновляться только фильтры, специфичные для оповещения. Проверка `filters` не производится.
auth_key строка / обязательный				Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не установлена.
default_destinations словарь				Свойства для назначений, когда не указаны назначения, специфичные для оповещения.
	all_admins логическое		Варианты: нет да	Если true, все администраторы сети получат письма.
	emails список / элементы=строка			Список адресов электронной почты, которые получат оповещения.
	http_server_ids список / элементы=строка			Список идентификаторов HTTP-серверов для отправки веб-хуков.
	snmp логическое		Варианты: нет да	Если 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 строка			Варианты: snake_case ← camelCase	Указывает модулю, должны ли ключи ответа быть в формате snake_case (например, `net_id`) или camelCase (например, `netId`).
output_level строка			Варианты: debug normal ←	Устанавливает уровень детализации вывода во время выполнения модуля.
rate_limit_retry_time целое число			Значение по умолчанию: 165	Количество секунд для повторной попытки, если срабатывает ограничение скорости.
state строка			Варианты: present ← query	Создание или изменение оповещения.
timeout целое число			Значение по умолчанию: 30	Время ожидания для HTTP-запросов.
use_https логическое			Варианты: нет да ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy логическое			Варианты: нет ← да	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
validate_certs логическое			Варианты: нет да ←	Нужно ли проверять сертификаты HTTP.

Примечания

Примечание

Более подробную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые из опций, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake_case. Чтобы использовать camelCase, установите переменную среды ANSIBLE_MERAKI_FORMAT в значение camelcase.
Модули Meraki в Ansible перестанут поддерживать вывод camelCase в 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`.
		тип строка		успех	Тип предупреждения.
	пункты_назначения_по_умолчанию сложный			успех	Свойства пунктов назначения, когда не указаны пункты назначения, специфичные для предупреждения.
		все_админы логическое		успех	Если истинно, все администраторы сети получат электронные письма. Пример: True
		электронные_письма список / элементы=строка		успех	Список электронных писем, которые получат предупреждение(я).
		id_http_серверов список / элементы=строка		успех	Список идентификаторов HTTP-серверов, которым нужно отправить веб-хук.
		snmp логическое		успех	Если истинно, то будет отправлена SNMP-ловушка, если для этой сети настроен SNMP-сервер ловушек. Пример: True

Авторы

Кевин Брейт (@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_alert_module.html