community.general.hipchat (8.5.0) — callback

post task events to hipchat

Authors: Unknown (!UNKNOWN)

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0


Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

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

Inputs

    
from:
    default: ansible
    description: Name to post as
    env:
    - name: HIPCHAT_FROM
    ini:
    - key: from
      section: callback_hipchat

room:
    default: ansible
    description: HipChat room to post in.
    env:
    - name: HIPCHAT_ROOM
    ini:
    - key: room
      section: callback_hipchat

token:
    description: HipChat API token for v1 or v2 API.
    env:
    - name: HIPCHAT_TOKEN
    ini:
    - key: token
      section: callback_hipchat
    required: true

notify:
    default: true
    description: Add notify flag to important messages
    env:
    - name: HIPCHAT_NOTIFY
    ini:
    - key: notify
      section: callback_hipchat
    type: bool

api_version:
    default: v1
    description: HipChat API version, v1 or v2.
    env:
    - name: HIPCHAT_API_VERSION
    ini:
    - key: api_version
      section: callback_hipchat
    required: false