community.general.campfire module – Send a message to Campfire

Note

This module is part of the community.general collection (version 10.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

Synopsis

  • Send a message to Campfire.

  • Messages with newlines will result in a “Paste” message being sent.

Parameters

Parameter

Comments

msg

string / required

The message body.

notify

string

Send a notification sound before the message.

Choices:

  • "56k"

  • "bell"

  • "bezos"

  • "bueller"

  • "clowntown"

  • "cottoneyejoe"

  • "crickets"

  • "dadgummit"

  • "dangerzone"

  • "danielsan"

  • "deeper"

  • "drama"

  • "greatjob"

  • "greyjoy"

  • "guarantee"

  • "heygirl"

  • "horn"

  • "horror"

  • "inconceivable"

  • "live"

  • "loggins"

  • "makeitso"

  • "noooo"

  • "nyan"

  • "ohmy"

  • "ohyeah"

  • "pushit"

  • "rimshot"

  • "rollout"

  • "rumble"

  • "sax"

  • "secret"

  • "sexyback"

  • "story"

  • "tada"

  • "tmyk"

  • "trololo"

  • "trombone"

  • "unix"

  • "vuvuzela"

  • "what"

  • "whoomp"

  • "yeah"

  • "yodel"

room

string / required

Room number to which the message should be sent.

subscription

string / required

The subscription name to use.

token

string / required

API token.

Attributes

Attribute

Support

Description

check_mode

Support: none

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- name: Send a message to Campfire
  community.general.campfire:
    subscription: foo
    token: 12345
    room: 123
    msg: Task completed.

- name: Send a message to Campfire
  community.general.campfire:
    subscription: foo
    token: 12345
    room: 123
    notify: loggins
    msg: Task completed ... with feeling.

Authors

  • Adam Garside (@fabulops)