community.general.jabber (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Send a message to jabber

Requirements

• python xmpp (xmpppy)

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Send a message to a user
  community.general.jabber:
    user: mybot@example.net
    password: secret
    to: friend@example.net
    msg: Ansible task finished

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
to:
    description:
    - user ID or name of the room, when using room use a slash to indicate your nick.
    required: true
    type: str

msg:
    description:
    - The message body.
    required: true
    type: str

host:
    description:
    - host to connect, overrides user info
    type: str

port:
    default: 5222
    description:
    - port to connect to, overrides default
    type: int

user:
    description:
    - User as which to connect
    required: true
    type: str

encoding:
    description:
    - message encoding
    type: str

password:
    description:
    - password for user to connect
    required: true
    type: str