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:
    user: [email protected]
    password: secret
    to: [email protected]
    msg: Ansible task finished

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

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

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

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

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