W3cubDocs

/Ansible

jabber - Send a message to jabber user or chat room

Synopsis

Send a message to jabber

Requirements (on host that executes module)

  • python xmpp (xmpppy)

Options

parameter required default choices comments
encoding
 no
message encoding
host
 no
host to connect, overrides user info
msg
 yes
The message body.
password
 yes
password for user to connect
port
 no 5222
port to connect to, overrides default
to
 yes
user ID or name of the room, when using room use a slash to indicate your nick.
user
 yes
User as which to connect

Examples

# send a message to a user
- jabber: [email protected]
          password=secret
          [email protected]
          msg="Ansible task finished"

# send a message to a room
- jabber: [email protected]
          password=secret
          [email protected]/ansiblebot
          msg="Ansible task finished"

# send a message, specifying the host and port
- jabber [email protected]
         host=talk.example.net
         port=5223
         password=secret
         [email protected]
         msg="Ansible task finished"

This is an Extras Module

For more information on what this means please read Extras Modules

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

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/jabber_module.html