You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

jabber - Send a message to jabber user or chat room¶

Synopsis
Requirements (on host that executes module)
Options
Examples
- Status

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: mybot@example.net
    password: secret
    to: friend@example.net
    msg: Ansible task finished

# send a message to a room
- jabber:
    user: mybot@example.net
    password: secret
    to: mychaps@conference.example.net/ansiblebot
    msg: Ansible task finished

# send a message, specifying the host and port
- jabber:
    user: mybot@example.net
    host: talk.example.net
    port: 5223
    password: secret
    to: mychaps@example.net
    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.