Documentation

hall - Send notification to Hall

New in version 2.0.

Synopsis

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

Options

parameter required default choices comments
msg
yes
The message you wish to deliver as a notifcation
picture
no
The full URL to the image you wish to use for the Icon of the message. Defaults to http://cdn2.hubspot.net/hub/330046/file-769078210-png/Official_Logos/ansible_logo_black_square_small.png?t=1421076128627
room_token
yes
Room token provided to you by setting up the Ansible room integation on https://hall.com
title
yes
The title of the message

Examples

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

- name: Send Hall notification if EC2 servers were created.
  hall:
    room_token: <hall room integration token>
    title: Server Creation
    msg: 'Created EC2 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 }}'

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.