salt.returners.hipchat_return¶

Return salt data via hipchat.

The following fields can be set in the minion conf file:

hipchat.room_id (required)
hipchat.api_key (required)
hipchat.api_version (required)
hipchat.from_name (required)
hipchat.color (optional)
hipchat.notify (optional)
hipchat.profile (optional)
hipchat.url (optional)

Alternative configuration values can be used by prefacing the configuration. Any values not found in the alternative configuration will be pulled from the default location:

hipchat.room_id
hipchat.api_key
hipchat.api_version
hipchat.from_name

Hipchat settings may also be configured as:

hipchat:
  room_id: RoomName
  api_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  api_version: v1
  from_name: user@email.com

alternative.hipchat:
  room_id: RoomName
  api_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  api_version: v1
  from_name: user@email.com

hipchat_profile:
  hipchat.api_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  hipchat.api_version: v1
  hipchat.from_name: user@email.com

hipchat:
  profile: hipchat_profile
  room_id: RoomName

alternative.hipchat:
  profile: hipchat_profile
  room_id: RoomName

hipchat:
  room_id: RoomName
  api_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  api_version: v1
  api_url: api.hipchat.com
  from_name: user@email.com

To use the HipChat returner, append '--return hipchat' to the salt command.

salt '*' test.ping --return hipchat

To use the alternative configuration, append '--return_config alternative' to the salt command.

salt '*' test.ping --return hipchat --return_config alternative

To override individual configuration items, append --return_kwargs '{"key:": "value"}' to the salt command.

salt '*' test.ping --return hipchat --return_kwargs '{"room_id": "another-room"}'

salt.returners.hipchat_return.event_return(events)¶

Return event data to hipchat

salt.returners.hipchat_return.returner(ret)¶

Send an hipchat message with the return data from a job