jabber - Send a message to jabber user or chat room

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • python xmpp (xmpppy)

Parameters

Parameter Choices/Defaults Comments
encoding
message encoding
host
host to connect, overrides user info
msg
required
The message body.
password
required
password for user to connect
port Default:
5222
port to connect to, overrides default
to
required
user ID or name of the room, when using room use a slash to indicate your nick.
user
required
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.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Brian Coca (@bcoca)

Hint

If you notice any issues in this documentation you can edit this document to improve it.