Spec-Zone.ru › Ansible

Модуль community.grafana.grafana_notification_channel — управление каналами уведомлений Grafana

Примечание

Этот модуль входит в коллекцию community.grafana (версия 2.3.0).

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

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

Чтобы использовать её в плейбуке, укажите: community.grafana.grafana_notification_channel.

Добавлено в community.grafana 1.1.0

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

УСТАРЕЛО

Удалено в:

версии 3.0.0

Причина:

Устаревшая система оповещений удалена в Grafana версии 11.

Альтернатива:

Вместо этого используйте community.grafana.grafana_contact_point.

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

  • Создание, обновление и удаление каналов уведомлений Grafana через API.

Параметры

Параметр

Комментарии

client_cert

path

Файл цепочки сертификатов в формате PEM для аутентификации клиента SSL.

Этот файл также может содержать ключ. Если ключ включён в файл, указывать client_key не требуется.

client_key

path

Файл в формате PEM, содержащий закрытый ключ для аутентификации клиента SSL.

Если client_cert содержит и сертификат, и ключ, этот параметр не требуется.

dingding_message_type

list / elements=string

Тип сообщения DingDing.

Варианты:

  • "link"
  • "action_card"

dingding_url

string

URL веб-перехватчика DingDing.

disable_resolve_message

boolean

Отключить сообщение о разрешении инцидента.

Варианты:

  • false ← (по умолчанию)
  • true

discord_message_content

string

Переопределяет содержимое сообщения.

discord_url

string

URL веб-перехватчика Discord.

email_addresses

list / elements=string

Список получателей.

email_single

boolean

Отправлять одно письмо всем получателям.

Варианты:

  • false
  • true

googlechat_url

string

URL веб-перехватчика Google Hangouts.

grafana_api_key

string

Ключ API Grafana.

Если задан, url_username и url_password игнорируются.

hipchat_api_key

string

Ключ API HipChat.

hipchat_room_id

string

Идентификатор комнаты HipChat.

hipchat_url

string

URL веб-перехватчика HipChat.

include_image

boolean

Создавать снимок визуализации и прикреплять его к уведомлениям.

Варианты:

  • false ← (по умолчанию)
  • true

is_default

boolean

Использовать этот канал для всех оповещений.

Варианты:

  • false ← (по умолчанию)
  • true

kafka_topic

string

Имя топика Kafka.

kafka_url

string

URL REST-прокси Kafka.

line_token

string

Токен LINE.

name

string

Имя канала уведомлений.

Обязательно, если state имеет значение present.

opsgenie_api_key

string

Ключ API OpsGenie.

opsgenie_auto_close

boolean

Автоматически закрывать оповещения в OpsGenie, когда их состояние снова становится нормальным.

Варианты:

  • false
  • true

opsgenie_override_priority

boolean

Разрешить задавать приоритет оповещения с помощью тега og_priority.

Варианты:

  • false
  • true

opsgenie_url

string

URL веб-перехватчика OpsGenie.

org_id

integer

Идентификатор организации Grafana, в которую будет импортирована или из которой будет экспортирована панель мониторинга.

Не используется, если задан grafana_api_key, поскольку ключ grafana_api_key относится только к одной организации.

По умолчанию: 1

pagerduty_auto_resolve

boolean

Разрешать инциденты в PagerDuty, когда состояние оповещения снова становится нормальным.

Варианты:

  • false
  • true

pagerduty_integration_key

string

Ключ интеграции PagerDuty.

pagerduty_message_in_details

boolean

Перенести сообщение об оповещении из сводки PD в пользовательские сведения.

Это изменяет объект пользовательских сведений и может нарушить настроенные правила обработки событий.

Варианты:

  • false
  • true

pagerduty_severity

list / elements=string

Критичность оповещения в PagerDuty.

Варианты:

  • "critical"
  • "error"
  • "warning"
  • "info"

prometheus_password

string

Пароль Prometheus.

prometheus_url

string

URL API Prometheus.

prometheus_username

string

Имя пользователя Prometheus.

pushover_alert_sound

string

Звук оповещения в Pushover

pushover_api_token

string

Токен API Pushover.

pushover_devices

list / elements=string

Список устройств в Pushover.

pushover_expire

integer

Срок действия оповещения истекает через n минут.

Только при приоритете emergency.

pushover_ok_sound

string

Звук OK в Pushover

pushover_priority

list / elements=string

Приоритет оповещения в Pushover.

Варианты:

  • "emergency"
  • "high"
  • "normal"
  • "low"
  • "lowest"

pushover_retry

integer

Повторять попытку через n минут.

Только при приоритете emergency.

pushover_user_key

string

Ключ пользователя Pushover.

reminder_frequency

string

Интервал дополнительных уведомлений для активированных оповещений.

Например, 15m.

sensu_handler

string

Имя обработчика Sensu.

sensu_password

string

Пароль Sensu.

sensu_source

string

Источник в Sensu.

sensu_url

string

URL веб-перехватчика Sensu.

sensu_username

string

Пользователь Sensu.

skip_version_check

boolean

Пропустить проверку версии Grafana и в любом случае попытаться обратиться к конечной точке API.

Варианты:

  • false ← (по умолчанию)
  • true

slack_icon_emoji

string

Эмодзи для сообщения бота.

slack_icon_url

string

URL изображения, которое будет использоваться в качестве значка сообщения бота.

slack_mention_channel

list / elements=string

Упомянуть весь канал или только активных участников.

Варианты:

  • "here"
  • "channel"

slack_mention_groups

list / elements=string

Список упоминаемых групп.

slack_mention_users

list / elements=string

Список упоминаемых пользователей.

slack_recipient

string

Переопределить канал или пользователя Slack по умолчанию.

slack_token

string

Токен Slack.

slack_url

string

URL веб-перехватчика Slack.

slack_username

string

Задать имя пользователя для сообщения бота.

state

string

Состояние канала уведомлений.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

teams_url

string

URL веб-перехватчика Microsoft Teams.

telegram_bot_token

string

Токен бота Telegram;

telegram_chat_id

string

Идентификатор чата Telegram.

threema_api_secret

string

Секретный ключ API шлюза Threema.

threema_gateway_id

string

8-символьный идентификатор шлюза Threema (начинается с *).

threema_recipient_id

string

8-символьный идентификатор Threema, на который следует отправлять оповещения.

type

string

Тип канала уведомлений.

Обязателен, если state имеет значение present.

Варианты:

  • "dingding"
  • "discord"
  • "email"
  • "googlechat"
  • "hipchat"
  • "kafka"
  • "line"
  • "teams"
  • "opsgenie"
  • "pagerduty"
  • "prometheus"
  • "pushover"
  • "sensu"
  • "slack"
  • "telegram"
  • "threema"
  • "victorops"
  • "webhook"

uid

string

Уникальный идентификатор канала.

url

псевдонимы: grafana_url

string / обязательный

URL Grafana.

url_password

псевдонимы: grafana_password

string

Пароль Grafana для аутентификации API.

По умолчанию: "admin"

url_username

псевдонимы: grafana_user

string

Имя пользователя Grafana для аутентификации API.

По умолчанию: "admin"

use_proxy

boolean

Если false, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах.

Варианты:

  • false
  • true ← (по умолчанию)

validate_certs

boolean

Если false, сертификаты SSL проверяться не будут.

Это следует устанавливать только в значение false при использовании самоподписанных сертификатов на сайтах, находящихся под личным контролем.

Варианты:

  • false
  • true ← (по умолчанию)

victorops_auto_resolve

boolean

Закрывать инциденты в VictorOps, когда состояние оповещения возвращается к норме.

Варианты:

  • false
  • true

victorops_url

string

URL веб-перехватчика VictorOps.

webhook_http_method

list / элементы=string

HTTP-метод веб-перехватчика.

Варианты:

  • "POST"
  • "PUT"

webhook_password

string

Пароль веб-перехватчика.

webhook_url

string

URL веб-перехватчика

webhook_username

string

Имя пользователя веб-перехватчика.

Примечания

Примечание

  • Начиная с Grafana 8.3 каналы уведомлений заменены точками контакта; в настоящее время этот модуль не позволяет управлять точками контакта.
  • Модуль сообщит об успешном выполнении, поскольку Grafana сохраняет обратную совместимость с предыдущей системой управления оповещениями, но
  • если включен новый механизм оповещений, точки контакта не будут отображаться.

Примеры

- name: Create slack notification channel
  register: result
  grafana_notification_channel:
    uid: slack
    name: slack
    type: slack
    slack_url: https://hooks.slack.com/services/xxx/yyy/zzz
    grafana_url: "{{ grafana_url }}"
    grafana_user: "{{ grafana_username }}"
    grafana_password: "{{ grafana_password}}"

- name: Delete slack notification channel
  register: result
  grafana_notification_channel:
    state: absent
    uid: slack
    grafana_url: "{{ grafana_url }}"
    grafana_user: "{{ grafana_username }}"
    grafana_password: "{{ grafana_password}}"

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

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

Ключ

Описание

notification_channel

dictionary

Канал уведомлений, созданный или обновленный модулем.

Возвращается: changed

Пример: {"created": "2020-11-10T21:10:19.675308051+03:00", "disableResolveMessage": false, "frequency": "", "id": 37, "isDefault": false, "name": "Oops", "secureFields": {}, "sendReminder": false, "settings": {"uploadImage": false, "url": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"}, "type": "slack", "uid": "slack-oops", "updated": "2020-11-10T21:10:19.675308112+03:00"}

Статус

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

Авторы

  • Aliaksandr Mianzhynski (@amenzhinsky)
  • Rémi REY (@rrey)

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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/community/grafana/grafana_notification_channel_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API