community.grafana.grafana_contact_point 模块 – 管理 Grafana 联系人

注意

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

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

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

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

community.grafana 2.0.0 中的新增功能

概要

• 通过 API 创建/更新/删除 Grafana 联系人。

参数

参数	注释
alertmanager_password 字符串	访问 Alertmanager 的密码。
alertmanager_url 字符串	访问 Alertmanager 的 URL。 当 type 为 alertmanager 时必需。
alertmanager_username 字符串	访问 Alertmanager 的用户名。
client_cert 路径	用于 SSL 客户端身份验证的 PEM 格式证书链文件。 此文件也可以包含密钥，如果包含密钥，则不需要 *client_key*
client_key 路径	包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。 如果 *client_cert* 包含证书和密钥，则不需要此选项。
dingding_message 字符串	通过钉钉发送的消息。
dingding_message_type 字符串	通过钉钉发送的消息类型。
dingding_title 字符串	钉钉消息的标题。
dingding_url 字符串	钉钉 Webhook 的 URL。 当 type 为 dingding 时必需。
disable_resolve_message 布尔值	禁用解决消息。 选项 false ← (默认) true
discord_avatar_url 字符串	Discord 消息的头像 URL。
discord_message 字符串	通过 Discord 发送的消息。
discord_title 字符串	Discord 消息的标题。
discord_url 字符串	Discord Webhook 的 URL。 当 type 为 discord 时必需。
discord_use_username 布尔值	是否在 Discord 中使用自定义用户名。 选项 false ← (默认) true
email_addresses 列表 / 元素=字符串	要将消息发送到的电子邮件地址列表。 当 type 为 email 时必需。
email_message 字符串	电子邮件内容。
email_single 布尔值	是否发送单个电子邮件或单独的电子邮件。 选项 false ← (默认) true
email_subject 字符串	电子邮件主题。
googlechat_message 字符串	通过 Google Chat 发送的消息。
googlechat_title 字符串	Google Chat 消息的标题。
googlechat_url 字符串	Google Chat Webhook 的 URL。 当 type 为 webhook 时必需。
grafana_api_key 字符串	Grafana API 密钥。 如果设置，则忽略 url_username 和 url_password。
include_image 布尔值	是否在通知中包含图像。 选项 false ← (默认) true
kafka_api_version 字符串	Kafka 的 API 版本。 默认： "v2"
kafka_cluster_id 字符串	Kafka 的集群 ID。
kafka_description 字符串	Kafka 配置的描述。
kafka_details 字符串	Kafka 的其他详细信息。
kafka_password 字符串	访问 Kafka 的密码。
kafka_rest_proxy_url 字符串	Kafka REST 代理的 URL。 当 type 为 kafka 时必需。
kafka_topic 字符串	要发布到的 Kafka 主题。 当 type 为 kafka 时必需。
kafka_username 字符串	访问 Kafka 的用户名。
line_description 字符串	Line 消息的描述。
line_title 字符串	Line 消息的标题。
line_token 字符串	Line 的访问令牌。 当 type 为 line 时必需。
name 字符串	联系人的名称。 当 state 为 present 时必需。
opsgenie_api_key 字符串	OpsGenie 的 API 密钥。 当 type 为 opsgenie 时必需。
opsgenie_auto_close 布尔值	是否启用 OpsGenie 中的自动关闭警报。 选项 false true
opsgenie_description 字符串	OpsGenie 警报的描述。
opsgenie_message 字符串	通过 OpsGenie 发送的消息。
opsgenie_override_priority 布尔值	是否覆盖 OpsGenie 中的优先级。 选项 false true
opsgenie_responders 列表 / 元素=字典	OpsGenie 警报的响应者列表。
opsgenie_send_tags_as 字符串	在 OpsGenie 中发送标签的格式。
opsgenie_url 字符串	OpsGenie Webhook 的 URL。 当 type 为 pagerduty 时必需。
org_id 整数	组织 ID。 默认值： 1
org_name 字符串	组织名称。
pagerduty_class 字符串	PagerDuty 警报的类别。
pagerduty_client 字符串	PagerDuty 的客户端标识符。
pagerduty_client_url 字符串	PagerDuty 的客户端 URL。
pagerduty_component 字符串	PagerDuty 警报中涉及的组件。
pagerduty_details 列表 / 元素=字典	PagerDuty 的附加详细信息列表。
pagerduty_group 字符串	与 PagerDuty 警报关联的组。
pagerduty_integration_key 字符串	PagerDuty 的集成密钥。 当 type 为 pagerduty 时必需。
pagerduty_severity 字符串	PagerDuty 警报的严重性级别。 选项 "critical" "error" "warning" "info"
pagerduty_source 字符串	PagerDuty 警报的来源。
pagerduty_summary 字符串	PagerDuty 警报的摘要。
provisioning 布尔值	指示是否启用预配。 选项 false true ← (默认)
pushover_api_token 字符串	Pushover 的 API 令牌。 当 type 为 pushover 时必需。
pushover_devices 列表 / 元素=字符串	Pushover 通知设备列表。
pushover_expire 整数	Pushover 通知过期时间。
pushover_message 字符串	通过 Pushover 发送的消息。
pushover_ok_priority 整数	Pushover 中 OK 消息的优先级。
pushover_ok_sound 字符串	Pushover 中 OK 消息的声音。
pushover_priority 整数	Pushover 消息的优先级。
pushover_retry 整数	Pushover 消息的重试间隔。
pushover_sound 字符串	Pushover 通知的声音。
pushover_title 字符串	Pushover 消息的标题。
pushover_upload_image 布尔值	是否上传 Pushover 通知中的图像。 选项 false true ← (默认)
pushover_user_key 字符串	Pushover 的用户密钥。 当 type 为 pushover 时必需。
sensugo_api_key 字符串	Sensu Go 的 API 密钥。 当 type 为 pushover 时必需。
sensugo_check 字符串	Sensu Go 的检查名称。
sensugo_entity 字符串	Sensu Go 的实体名称。
sensugo_handler 字符串	Sensu Go 的处理程序。
sensugo_message 字符串	通过 Sensu Go 发送的消息。
sensugo_namespace 字符串	Sensu Go 的命名空间。
sensugo_url 字符串	Sensu Go 的 URL。 当 type 为 sensugo 时必需。
slack_endpoint_url 字符串	Slack webhook 的端点 URL。
slack_icon_emoji 字符串	Slack 消息的表情符号图标。
slack_icon_url 字符串	Slack 消息的图标 URL。
slack_mention_channel 字符串	Slack 消息的频道提及。 选项 "here" "channel"
slack_mention_groups 列表 / 元素=字符串	要在 Slack 消息中提及的组列表。
slack_mention_users 列表 / 元素=字符串	要在 Slack 消息中提及的用户列表。
slack_recipient 字符串	Slack 消息的接收者。 当 type 为 slack 时必需。
slack_text 字符串	Slack 消息的文本内容。
slack_title 字符串	Slack 消息的标题。
slack_token 字符串	Slack 身份验证的令牌。 当 type 为 slack 时必需。
slack_url 字符串	Slack webhook 的 URL。 当 type 为 slack 时必需。
slack_username 字符串	要在 Slack 消息中使用的用户名。
state 字符串	接触点的状态。 选项 "present" ← (默认) "absent"
teams_message 字符串	通过 Microsoft Teams 发送的消息。
teams_section_title 字符串	Microsoft Teams 消息的章节标题。
teams_title 字符串	Microsoft Teams 消息的标题。
teams_url 字符串	Microsoft Teams webhook 的 URL。 当 type 为 teams 时必需。
telegram_chat_id 字符串	Telegram 的聊天 ID。 当 type 为 telegram 时必需。
telegram_disable_notifications 布尔值	是否禁用 Telegram 消息的通知。 选项 false true
telegram_message 字符串	通过 Telegram 发送的消息。
telegram_parse_mode 字符串	Telegram 消息的解析模式。
telegram_protect_content 布尔值	是否保护 Telegram 消息中的内容。 选项 false true
telegram_token 字符串	Telegram 身份验证的令牌。 当 type 为 telegram 时必需。
telegram_web_page_view 布尔值	是否在 Telegram 消息中启用网页预览。 选项 false true
threema_api_secret 字符串	Threema 的 API 密钥。 当 type 为 threema 时必需。
threema_description 字符串	Threema 消息的描述。
threema_gateway_id 字符串	Threema 的网关 ID。 当 type 为 threema 时必需。
threema_recipient_id 字符串	Threema 消息的接收者 ID。 当 type 为 threema 时必需。
threema_title 字符串	Threema 消息的标题。
type 字符串	接触点的类型。 当 state 为 present 时必需。 选项 "alertmanager" "dingding" "discord" "email" "googlechat" "kafka" "line" "opsgenie" "pagerduty" "pushover" "sensugo" "slack" "teams" "telegram" "threema" "victorops" "webex" "webhook" "wecom"
uid 字符串 / 必需	接触点的唯一 ID。 通常 uid 是随机生成的，但对于通过 API 处理接触点是必需的。
url 别名：grafana_url 字符串 / 必需	Grafana 的 URL。
url_password 别名：grafana_password 字符串	Grafana API 身份验证的密码。 默认值： "admin"
url_username 别名：grafana_user 字符串	Grafana API 身份验证的用户。 默认值： "admin"
use_proxy 布尔值	如果 false，即使在目标主机上的环境变量中定义了代理，也不会使用代理。 选项 false true ← (默认)
validate_certs 布尔值	如果 false，则不会验证 SSL 证书。 这只应在使用自签名证书的个人控制站点上设置为 false。 选项 false true ← (默认)
victorops_description 字符串	VictorOps 消息的描述。
victorops_message_type 字符串	VictorOps 的消息类型。 选项 "CRITICAL" "RECOVERY"
victorops_title 字符串	VictorOps 消息的标题。
victorops_url 字符串	VictorOps webhook 的 URL。 当 type 为 victorops 时必需。
webex_api_url 字符串	Webex 的 API URL。
webex_message 字符串	通过 Webex 发送的消息。
webex_room_id 字符串	Webex 消息的房间 ID。 当 type 为 webex 时必需。
webex_token 字符串	Webex 身份验证的令牌。 当 type 为 webex 时必需。
webhook_authorization_credentials 字符串	Webhook 的授权凭据。
webhook_authorization_scheme 字符串	Webhook 的授权方案。
webhook_http_method 字符串	Webhook 的 HTTP 方法。 选项 "POST" "PUT"
webhook_max_alerts 整数	Webhook 的最大警报数量。
webhook_message 字符串	通过 webhook 发送的消息。
webhook_password 字符串	Webhook 身份验证的密码。
webhook_title 字符串	Webhook 消息的标题。
webhook_url 字符串	Webhook 的 URL。 当 type 为 webhook 时必需。
webhook_username 字符串	Webhook 身份验证的用户名。
wecom_agent_id 字符串	WeCom 的代理 ID。 当 type 为 wecom 时必需。
wecom_corp_id 字符串	WeCom 的企业 ID。 当 type 为 wecom 时必需。
wecom_message 字符串	通过 WeCom 发送的消息。
wecom_msg_type 字符串	WeCom 的消息类型。
wecom_secret 字符串	WeCom 身份验证的密钥。 当 type 为 wecom 时必需。
wecom_title 字符串	WeCom 消息的标题。
wecom_to_user 列表 / 元素=字符串	要向其发送 WeCom 消息的用户列表。
wecom_url 字符串	WeCom webhook 的 URL。 当 type 为 wecom 时必需。

示例

- name: Create email contact point
  community.grafana.grafana_contact_point:
    grafana_url: "{{ grafana_url }}"
    grafana_user: "{{ grafana_username }}"
    grafana_password: "{{ grafana_password }}"
    uid: email
    name: E-Mail
    type: email
    email_addresses:
      - [email protected]

- name: Delete email contact point
  community.grafana.grafana_contact_point:
    grafana_url: "{{ grafana_url }}"
    grafana_user: "{{ grafana_username }}"
    grafana_password: "{{ grafana_password }}"
    uid: email
    state: absent

返回值

常见的返回值已在此处 记录，以下是此模块独有的字段

键	描述
contact_point 复杂类型	模块创建或更新的接触点。 返回：成功
disableResolveMessage 布尔值	接触点的解决消息是否被禁用。 返回：成功 示例： [false]
name 字符串	联系人的名称。 返回：成功 示例： "['supportmail']"
secureFields 字典	接触点的安全字段配置。 返回：成功
settings 字典	接触点的特定类型设置。 返回：成功 示例： [{"addresses": "support@example.com", "singleEmail": false}]
type 字符串	接触点的类型。 返回：成功 示例： "['email']"
uid 字符串	接触点的 uid。 返回：成功 示例： "['ddmyrs0f74t8hc']"
diff 复杂类型	更新后的联系人与之前的联系人差异。 返回：已更改
之后 字典	当前联系人。 返回：已更改 示例： [{"disableResolveMessage": true, "name": "supportmail", "secureFields": {}, "settings": {"addresses": "support123@example.com", "singleEmail": false}, "type": "email", "uid": "ddmyrs0f74t8hc"}]
之前 字典	之前的联系人。 返回：已更改 示例： [{"disableResolveMessage": false, "name": "supportmail", "secureFields": {}, "settings": {"addresses": "support@example.com", "singleEmail": false}, "type": "email", "uid": "ddmyrs0f74t8hc"}]

作者

• Moritz Pötschk (@nemental)

资源链接

• 问题追踪
• 主页
• 代码仓库