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

Примечание

Этот модуль является частью коллекции cisco.meraki (версия 2.18.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 список / элементы=словарь	Настройка, специфичная для каждого типа оповещения.
alert_destinations словарь	Хеш-таблица назначений для этого конкретного оповещения.
all_admins булево	Если true, все администраторы сети получат электронные письма. Варианты: `false` `true`
emails список / элементы=строка	Список адресов электронной почты, которые получат оповещение(я).
http_server_ids список / элементы=строка	Список идентификаторов HTTP-серверов, которым необходимо отправить веб-хук.
snmp булево	Если true, при наличии SNMP-сервера оповещения для этой сети будет отправлен SNMP-трав. Варианты: `false` `true`
alert_type строка	Тип оповещения.
enabled булево	Булево значение, определяющее включено или выключено оповещение. Варианты: `false` `true`
filters любой	Хеш-таблица с конкретными данными конфигурации для оповещения. Обновляются только фильтры, специфичные для оповещения. Проверка на соответствие `filters` не выполняется. Значение по умолчанию: `{}`
auth_key строка / обязательно	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
default_destinations словарь	Свойства назначений по умолчанию, если не указаны назначения, специфичные для оповещения.
all_admins булево	Если true, все администраторы сети получат электронные письма. Варианты: `false` `true`
emails список / элементы=строка	Список адресов электронной почты, которые получат оповещение(я).
http_server_ids список / элементы=строка	Список идентификаторов HTTP-серверов, которым необходимо отправить веб-хук.
snmp булево	Если true, при наличии SNMP-сервера оповещения для этой сети будет отправлен SNMP-трав. Варианты: `false` `true`
host строка	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай. Значение по умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной части. Значение по умолчанию: `60`
net_id строка	Идентификатор сети.
net_name псевдонимы: name, network строка	Имя сети.
org_id строка	Идентификатор организации.
org_name псевдонимы: organization строка	Название организации.

END_OF_DOCUMENT_MARKER

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.
Модули Meraki от Ansible перестанут поддерживать вывод camel case в Ansible 2.13. Пожалуйста, обновите свои playbook'ы.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит о изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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:
      - alert_type: "gatewayDown"
        enabled: yes
        filters:
          timeout: 60
        alert_destinations:
          emails:
          - 'youremail@yourcorp'
          - 'youremail2@yourcorp'
          all_admins: yes
          snmp: no
      - alert_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

Значения возврата

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

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

Статус

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