ansible.builtin.hall (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

The C(hall) module connects to the U(https://hall.com) messaging API and allows you to deliver notication messages to rooms.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Send Hall notifiation
  hall:
    room_token: <hall room integration token>
    title: Nginx
    msg: 'Created virtual host file on {{ inventory_hostname }}'
  delegate_to: loclahost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Send Hall notification if EC2 servers were created.
  hall:
    room_token: <hall room integration token>
    title: Server Creation
    msg: 'Created instance {{ item.id }} of type {{ item.instance_type }}.\nInstance can be reached at {{ item.public_ip }} in the {{ item.region }} region.'
  delegate_to: loclahost
  when: ec2.instances|length > 0
  with_items: '{{ ec2.instances }}'

Inputs

    
msg:
    description:
    - The message you wish to deliver as a notification
    required: true

title:
    description:
    - The title of the message
    required: true

picture:
    description:
    - 'The full URL to the image you wish to use for the Icon of the message. Defaults
      to U(http://cdn2.hubspot.net/hub/330046/file-769078210-png/Official_Logos/ansible_logo_black_square_small.png?t=1421076128627)

      '
    required: false

room_token:
    description:
    - Room token provided to you by setting up the Ansible room integation on U(https://hall.com)
    required: true