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.

community.general.jabber – Send a message to jabber user or chat room

Note

This plugin is part of the community.general collection (version 3.8.3).

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.jabber.

Synopsis

• Send a message to jabber

Requirements

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

• python xmpp (xmpppy)

Parameters

Parameter	Comments
encoding string	message encoding
host string	host to connect, overrides user info
msg string / required	The message body.
password string / required	password for user to connect
port integer	port to connect to, overrides default Default: 5222
to string / required	user ID or name of the room, when using room use a slash to indicate your nick.
user string / required	User as which to connect

Examples

- name: Send a message to a user
  community.general.jabber:
    user: [email protected]
    password: secret
    to: [email protected]
    msg: Ansible task finished

- name: Send a message to a room
  community.general.jabber:
    user: [email protected]
    password: secret
    to: [email protected]/ansiblebot
    msg: Ansible task finished

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

Authors

• Brian Coca (@bcoca)