Модуль community.general.mattermost — отправка уведомлений Mattermost

Примечание

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

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

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

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

Краткое описание
Параметры
Атрибуты
Примеры
Возвращаемые значения

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

Отправляет уведомления на http://your.mattermost.url с помощью интеграции Incoming WebHook.

Параметры

Параметр	Комментарии
api_key строка / обязательный	Ключ API веб-перехватчика Mattermost. Войдите на свой сайт Mattermost, перейдите в меню -> Интеграция -> Incoming Webhook -> Добавить Incoming 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.com/favicon/favicon.ico"`
priority строка добавлено в community.general 10.0.0	Задаёт приоритет сообщения. Варианты: `"important"` `"urgent"`
text строка	Текст для отправки. Обратите внимание, что модуль не выполняет экранирование символов. Обязательно, если не задано `attachments`.
url строка / обязательный	URL Mattermost (например, `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. Возвращается: success
webhook_url строка	URL, на который отправляется веб-перехватчик. Возвращается: success

Авторы

Benjamin Jolivot (@bjolivot)

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

© 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/general/mattermost_module.html