community.general.hipchat callback – post task events to hipchat

Note

This callback plugin is part of the community.general collection (version 9.4.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general. You need further requirements to be able to use this callback plugin, see Requirements for details.

To use it in a playbook, specify: community.general.hipchat.

DEPRECATED

Removed in:

version 10.0.0

Why:

The hipchat service has been discontinued and the self-hosted variant has been End of Life since 2020.

Alternative:

There is none.

Callback plugin

This plugin is a notification callback. It sends information for a playbook run to other applications, services, or systems. See Callback plugins for more information on callback plugins.

Synopsis

  • This callback plugin sends status updates to a HipChat channel during playbook execution.

  • Before 2.4 only environment variables were available for configuring this plugin.

Requirements

The below requirements are needed on the local controller node that executes this callback.

  • whitelist in configuration.

  • prettytable (python lib)

Parameters

Parameter

Comments

api_version

string

HipChat API version, v1 or v2.

Choices:

  • "v1" ← (default)

  • "v2"

Configuration:

from

string

Name to post as

Default: "ansible"

Configuration:

  • INI entry:

    [callback_hipchat]
from = ansible

  • Environment variable: HIPCHAT_FROM

notify

boolean

Add notify flag to important messages

Choices:

  • false

  • true ← (default)

Configuration:

  • INI entry:

    [callback_hipchat]
notify = true

  • Environment variable: HIPCHAT_NOTIFY

room

string

HipChat room to post in.

Default: "ansible"

Configuration:

  • INI entry:

    [callback_hipchat]
room = ansible

  • Environment variable: HIPCHAT_ROOM

token

string / required

HipChat API token for v1 or v2 API.

Configuration:

  • INI entry:

    [callback_hipchat]
token = VALUE

  • Environment variable: HIPCHAT_TOKEN

Status

  • This callback will be removed in version 10.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Unknown

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.