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.1).
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 | Choices/Defaults | 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
|
Default:
5222
|
port to connect to, overrides default
|
| 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: mybot@example.net
password: secret
to: friend@example.net
msg: Ansible task finished
- name: Send a message to a room
community.general.jabber:
user: mybot@example.net
password: secret
to: mychaps@conference.example.net/ansiblebot
msg: Ansible task finished
- name: Send a message, specifying the host and port
community.general.jabber:
user: mybot@example.net
host: talk.example.net
port: 5223
password: secret
to: mychaps@example.net
msg: Ansible task finished
Authors
- Brian Coca (@bcoca)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/jabber_module.html