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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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, перейдите в Меню -> Интеграции -> Входящий вебхук -> Добавить входящий вебхук. Это даст вам полную ссылку. `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 строка	Ссылка на значок отправителя сообщения. По умолчанию: `"https://docs.ansible.com/favicon.ico"`
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	Поддержка: отсутствует	Вернет подробности о том, что изменилось (или, возможно, требует изменения в `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

- 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 строка	Ссылка на вебхук Возвращается: успех

Авторы

Benjamin Jolivot (@bjolivot)

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/mattermost_module.html