community.grafana.grafana_notification_channel 模块 – 管理 Grafana 通知渠道

注意

此模块是 community.grafana 集合 (版本 2.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.grafana。

要在 playbook 中使用它，请指定：community.grafana.grafana_notification_channel。

community.grafana 1.1.0 中的新增功能

已弃用

在以下版本中移除：

版本 3.0.0

原因：

Grafana 11 版中移除了旧版警报功能。

替代方案：

改用 community.grafana.grafana_contact_point。

摘要

• 通过 API 创建/更新/删除 Grafana 通知渠道。

参数

参数	注释
client_cert path	用于 SSL 客户端身份验证的 PEM 格式证书链文件。 此文件也可以包含密钥，如果包含密钥，则不需要 *client_key*
client_key path	包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。 如果 *client_cert* 包含证书和密钥，则不需要此选项。
dingding_message_type 列表 / 元素=字符串	钉钉消息类型。 选项 "link" "action_card"
dingding_url 字符串	钉钉 Webhook URL。
disable_resolve_message 布尔值	禁用解决消息。 选项 false ← (默认) true
discord_message_content 字符串	覆盖消息内容。
discord_url 字符串	Discord Webhook URL。
email_addresses 列表 / 元素=字符串	收件人列表。
email_single 布尔值	向所有收件人发送单个电子邮件。 选项 false true
googlechat_url 字符串	Google Hangouts Webhook URL。
grafana_api_key 字符串	Grafana API 密钥。 如果设置了此项，则将忽略 url_username 和 url_password。
hipchat_api_key 字符串	HipChat API 密钥。
hipchat_room_id 字符串	HipChat 房间 ID。
hipchat_url 字符串	HipChat Webhook URL。
include_image 布尔值	捕获可视化图像并将其附加到通知。 选项 false ← (默认) true
is_default 布尔值	将此渠道用于所有警报。 选项 false ← (默认) true
kafka_topic 字符串	Kafka 主题名称。
kafka_url 字符串	Kafka REST 代理 URL。
line_token 字符串	LINE 令牌。
name 字符串	通知渠道的名称。 当 *state* 为 present 时，这是必需的。
opsgenie_api_key 字符串	OpsGenie API 密钥。
opsgenie_auto_close 布尔值	警报恢复正常后，自动在 OpsGenie 中关闭警报。 选项 false true
opsgenie_override_priority 布尔值	允许使用 og_priority 标签设置警报优先级。 选项 false true
opsgenie_url 字符串	OpsGenie Webhook URL。
org_id 整数	将导入/导出仪表板的 Grafana 组织 ID。 设置了 *grafana_api_key* 时不使用，因为 grafana_api_key 只属于一个组织。 默认值： 1
pagerduty_auto_resolve 布尔值	警报恢复正常后，在 PagerDuty 中解决事件。 选项 false true
pagerduty_integration_key 字符串	PagerDuty 集成密钥。
pagerduty_message_in_details 布尔值	将警报消息从 PD 摘要移动到自定义详细信息。 这会更改自定义详细信息对象，并可能破坏您已配置的事件规则。 选项 false true
pagerduty_severity 列表 / 元素=字符串	PagerDuty 中的警报严重性。 选项 "critical" "error" "warning" "info"
prometheus_password 字符串	Prometheus 密码。
prometheus_url 字符串	Prometheus API URL。
prometheus_username 字符串	Prometheus 用户名。
pushover_alert_sound 字符串	Pushover 中的警报声音
pushover_api_token 字符串	Pushover API 令牌。
pushover_devices 列表 / 元素=字符串	Pushover 中的设备列表。
pushover_expire 整数	在 n 分钟后使警报过期。 仅当优先级为 emergency 时。
pushover_ok_sound 字符串	Pushover 中的 OK 声音
pushover_priority 列表 / 元素=字符串	Pushover 中的警报优先级。 选项 "emergency" "high" "normal" "low" "lowest"
pushover_retry 整数	在 n 分钟后重试。 仅当优先级为 emergency 时。
pushover_user_key 字符串	Pushover 用户密钥。
reminder_frequency 字符串	触发警报的附加通知间隔。 例如 15m。
sensu_handler 字符串	Sensu 处理程序名称。
sensu_password 字符串	Sensu 密码。
sensu_source 字符串	Sensu 中的来源。
sensu_url 字符串	Sensu Webhook URL。
sensu_username 字符串	Sensu 用户。
skip_version_check 布尔值	跳过 Grafana 版本检查，并尝试连接 API 终结点。 选项 false ← (默认) true
slack_icon_emoji 字符串	机器人消息使用的表情符号。
slack_icon_url 字符串	用作机器人消息图标的图像 URL。
slack_mention_channel 列表 / 元素=字符串	提及整个频道还是仅提及活跃成员。 选项 "here" "channel"
slack_mention_groups 列表 / 元素=字符串	提及的群组列表。
slack_mention_users 列表 / 元素=字符串	提及的用户列表。
slack_recipient 字符串	覆盖默认 Slack 频道或用户。
slack_token 字符串	Slack 令牌。
slack_url 字符串	Slack Webhook URL。
slack_username 字符串	设置机器人消息的用户名。
state 字符串	通知渠道的状态。 选项 "present" ← (默认) "absent"
teams_url 字符串	Microsoft Teams Webhook URL。
telegram_bot_token 字符串	Telegram 机器人令牌；
telegram_chat_id 字符串	Telegram 聊天 ID。
threema_api_secret 字符串	Threema Gateway API 密钥。
threema_gateway_id 字符串	8 位 Threema Gateway ID（以 * 开头）。
threema_recipient_id 字符串	应接收警报的 8 位 Threema ID。
type 字符串	渠道通知类型。 当 *state* 为 present 时，这是必需的。 选项 "dingding" "discord" "email" "googlechat" "hipchat" "kafka" "line" "teams" "opsgenie" "pagerduty" "prometheus" "pushover" "sensu" "slack" "telegram" "threema" "victorops" "webhook"
uid 字符串	渠道唯一标识符。
url 别名：grafana_url 字符串 / 必需	Grafana URL。
url_password 别名：grafana_password 字符串	用于 API 身份验证的 Grafana 密码。 默认值： "admin"
url_username 别名：grafana_user 字符串	用于 API 身份验证的 Grafana 用户。 默认值： "admin"
use_proxy 布尔值	如果 false，即使目标主机上的环境变量中定义了代理，也不会使用代理。 选项 false true ← (默认)
validate_certs 布尔值	如果 false，则不会验证 SSL 证书。 仅当在使用自签名证书的个人控制站点上使用时，才应将其设置为 false。 选项 false true ← (默认)
victorops_auto_resolve 布尔值	警报恢复正常后，在 VictorOps 中解决事件。 选项 false true
victorops_url 字符串	VictorOps Webhook URL。
webhook_http_method 列表 / 元素=字符串	要使用的 Webhook HTTP 方法。 选项 "POST" "PUT"
webhook_password 字符串	Webhook 密码。
webhook_url 字符串	Webhook URL
webhook_username 字符串	Webhook 用户名。

注释

注意

• 从 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 字典	模块创建或更新的通知渠道。 返回：已更改 示例： {"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)

集合链接

• 问题追踪器
• 主页
• 代码库（源代码）