community.general.mattermost 模块 – 发送 Mattermost 通知

注意

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

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

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

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

概要 

通过传入 WebHook 集成将通知发送到 http://your.mattermost.url。

参数 

参数	注释
api_key 字符串 / 必需	Mattermost webhook api 密钥。登录您的 Mattermost 站点，转到菜单 -> 集成 -> 传入 Webhook -> 添加传入 Webhook。这将为您提供完整的 URL。 `api_key` 是最后一部分。 http://mattermost.example.com/hooks/`API_KEY`
attachments 列表 / 元素=字典在 community.general 4.3.0 中添加	定义附件列表。有关更多信息，请参阅 https://developers.mattermost.com/integrate/admin-guide/admin-message-attachments/。当未设置 `text` 时，此项为必需项。
channel 字符串	要将消息发送到的频道。如果不存在，则消息会发送到为 `api_key` 选择的频道。
icon_url 字符串	消息发送者图标的 URL。默认值： `"https://docs.ansible.org.cn/favicon.ico"`
priority 字符串在 community.general 10.0.0 中添加	设置消息的优先级。选择 `"important"` `"urgent"`
text 字符串	要发送的文本。请注意，该模块不处理转义字符。当未设置 `attachments` 时，此项为必需项。
url 字符串 / 必需	Mattermost URL（例如 http://mattermost.yourcompany.com）。
username 字符串	这是消息的发送者（需要由 mattermost 管理员启用用户名覆盖，请参阅 mattermost 文档）。默认值： `"Ansible"`
validate_certs 布尔值	如果 `false`，则不会验证 SSL 证书。这仅应用于使用自签名证书的个人控制站点。选择 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持：完全	可以在 `check_mode` 中运行，并返回更改状态预测，而无需修改目标。
diff_mode	支持：无	当处于 diff 模式时，将返回有关更改内容（或在 `check_mode` 中可能需要更改的内容）的详细信息。

示例 

- name: Send notification message via Mattermost
  community.general.mattermost:
    url: http://mattermost.example.com
    api_key: my_api_key
    text: '{{ inventory_hostname }} completed'

- name: Send notification message via Mattermost all options
  community.general.mattermost:
    url: http://mattermost.example.com
    api_key: my_api_key
    text: '{{ inventory_hostname }} completed'
    channel: notifications
    username: 'Ansible on {{ inventory_hostname }}'
    icon_url: http://www.example.com/some-image-file.png
    priority: important

- name: Send attachments message via Mattermost
  community.general.mattermost:
    url: http://mattermost.example.com
    api_key: my_api_key
    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

返回值 

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

键	描述
payload 字符串	Mattermost 有效负载返回：成功
webhook_url 字符串	将 webhook 发送到的 URL 返回：成功

作者

Benjamin Jolivot (@bjolivot)