Модуль community.general.hipchat – Отправка сообщения в Hipchat

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать его в книге задач, укажите: community.general.hipchat.

УСТЕРЕГШИЙСЯ
Краткое описание
Параметры
Атрибуты
Примеры
Статус

УСТЕРЕГШИЙСЯ

Удалено в:: версии 11.0.0
Почему:: Сервис Hipchat был прекращен, а самохостинговый вариант достиг конца жизненного цикла с 2020 года.
Альтернатива:: Нет.

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

Отправить сообщение в чат Hipchat с возможностью управления форматированием.

Параметры

Параметр	Комментарии
api строка	URL API, если используется самохостинговый сервер Hipchat. Для версии API Hipchat 2 используйте стандартный URI с `/v2` вместо `/v1`. По умолчанию: `"https://api.hipchat.com/v1"`
цвет строка	Цвет фона сообщения. Варианты: `"yellow"` ← (по умолчанию) `"red"` `"green"` `"purple"` `"gray"` `"random"`
сообщение строка / обязательно	Тело сообщения.
формат_сообщения строка	Формат сообщения. Варианты: `"text"` ← (по умолчанию) `"html"`
msg_from псевдонимы: от строка	Имя отправителя сообщения. Максимальная длина 15 символов — превышение приведет к обрезанию. По умолчанию: `"Ansible"`
уведомление логическое	Если True, для пользователей в комнате будет выполнено уведомление. Варианты: `false` `true` ← (по умолчанию)
комната строка / обязательно	ID или имя комнаты.
токен строка / обязательно	Токен API.
проверить_сертификаты логическое	Если `false`, сертификаты SSL не будут проверены. Это следует использовать только на управляемых лично сайтах с самозаверяющимися сертификатами. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
режим_проверки	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз состояния изменения без изменения целевого объекта.
режим_сравнения	Поддержка: нет	Возвратит детали изменений (или, возможно, изменений, требуемых в `check_mode`), при использовании режима сравнения.

Примеры

- name: Send a message to a Hipchat room
  community.general.hipchat:
    room: notif
    msg: Ansible task finished

- name: Send a message to a Hipchat room using Hipchat API version 2
  community.general.hipchat:
    api: https://api.hipchat.com/v2/
    token: OAUTH2_TOKEN
    room: notify
    msg: Ansible task finished

Статус

Этот модуль будет удален в версии 11.0.0. [устарел]
Дополнительная информация см. в разделе УСТЕРЕГШИЙСЯ.

Авторы

Shirou Wakayama (@shirou)
Paul Bourdel (@pb8226)

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

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