community.general.rocketchat 模块 – 发送通知到 Rocket Chat

注意

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

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

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

要在 playbook 中使用它，请指定：community.general.rocketchat。

概要

  • rocketchat 模块通过传入的 WebHook 集成将通知发送到 Rocket Chat

参数

参数

注释

attachments

list / elements=dictionary

定义附件列表。

channel

string

将消息发送到的频道。如果不存在，则消息将发送到为创建 webhook 时指定的 token 选择的频道。

color

string

允许文本使用默认颜色 - 使用 ‘normal’ 默认值，不在消息开头发送自定义颜色栏

选择

  • "normal" ← (默认)

  • "good"

  • "warning"

  • "danger"

domain

string / required

您的环境的域名，不带协议。(例如 example.com 或 chat.example.com.)

icon_emoji

string

消息发送者的表情符号。 可用表情符号的表示形式可以从 Rocket Chat 获取。

例如 :thumbsup:。

如果设置了 icon_emoji，则不会使用 icon_url。

icon_url

string

消息发送者图标的 URL。

默认: "https://docs.ansible.org.cn/favicon.ico"

integer

自动为 msg 中的频道和用户名创建链接。

选择

  • 1 ← (默认)

  • 0

msg

string

要发送的消息。

protocol

string

指定用于在 webhook URL 之前发送通知消息的协议（即 http 或 https）。

选择

  • "http"

  • "https" ← (默认)

token

string / required

Rocket Chat 传入 Webhook 集成令牌。这为 Rocket Chat 的传入 webhook 提供身份验证，以便发布消息。

username

string

这是消息的发送者。

默认: "Ansible"

validate_certs

boolean

如果为 false，则不会验证 SSL 证书。 这应该仅在个人控制的站点上使用自签名证书时使用。

选择

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持: 无

可以在 check_mode 中运行并返回更改状态预测，而无需修改目标。

diff_mode

支持: 无

当处于 diff 模式时，将返回有关已更改的内容（或可能需要在 check_mode 中更改的内容）的详细信息。

示例

- name: Send notification message via Rocket Chat
  community.general.rocketchat:
    token: thetoken/generatedby/rocketchat
    domain: chat.example.com
    msg: '{{ inventory_hostname }} completed'
  delegate_to: localhost

- name: Send notification message via Rocket Chat all options
  community.general.rocketchat:
    domain: chat.example.com
    token: thetoken/generatedby/rocketchat
    msg: '{{ inventory_hostname }} completed'
    channel: #ansible
    username: 'Ansible on {{ inventory_hostname }}'
    icon_url: http://www.example.com/some-image-file.png
    link_names: 0
  delegate_to: localhost

- name: Insert a color bar in front of the message for visibility purposes and use the default webhook icon and name configured in rocketchat
  community.general.rocketchat:
    token: thetoken/generatedby/rocketchat
    domain: chat.example.com
    msg: '{{ inventory_hostname }} is alive!'
    color: good
    username: ''
    icon_url: ''
  delegate_to: localhost

- name: Use the attachments API
  community.general.rocketchat:
    token: thetoken/generatedby/rocketchat
    domain: chat.example.com
    attachments:
      - text: Display my system load on host A and B
        color: #ff00dd
        title: System load
        fields:
          - title: System A
            value: 'load average: 0,74, 0,66, 0,63'
            short: true
          - title: System B
            value: 'load average: 5,16, 4,64, 2,43'
            short: true
  delegate_to: localhost

返回值

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

键

描述

changed

boolean

一个标志，指示是否进行了任何更改。

返回: 成功

示例: false

作者

  • Ramon de la Fuente (@ramondelafuente)