W3cubDocs

/Ansible 2.11

community.general.hipchat – post task events to hipchat

Note

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

To install it use: ansible-galaxy collection install community.general.

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

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 Choices/Defaults Configuration Comments
api_version
string
Default:
"v1"
ini entries:

[callback_hipchat]
api_version = v1

env:HIPCHAT_API_VERSION
HipChat API version, v1 or v2.
from
string
Default:
"ansible"
ini entries:

[callback_hipchat]
from = ansible

env:HIPCHAT_FROM
Name to post as
notify
boolean
    Choices:
  • no
  • yes ←
ini entries:

[callback_hipchat]
notify = yes

env:HIPCHAT_NOTIFY
Add notify flag to important messages
room
string
Default:
"ansible"
ini entries:

[callback_hipchat]
room = ansible

env:HIPCHAT_ROOM
HipChat room to post in.
token
string / required
ini entries:

[callback_hipchat]
token = None

env:HIPCHAT_TOKEN
HipChat API token for v1 or v2 API.

Authors

  • Unknown (!UNKNOWN)

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