W3cubDocs

/Ansible

community.general.ejabberd_user module – Manages users for ejabberd servers

Note

This module is part of the community.general collection (version 10.7.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. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.general.ejabberd_user.

Synopsis

  • This module provides user management for ejabberd servers.

Requirements

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

  • ejabberd with mod_admin_extra

Parameters

Parameter

Comments

host

string / required

The ejabberd host associated with this username.

password

string

The password to assign to the username.

state

string

Describe the desired state of the user to be managed.

Choices:

  • "present" ← (default)
  • "absent"

username

string / required

The name of the user to manage.

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

  • Password parameter is required for state=present only.
  • Passwords must be stored in clear text for this release.
  • The ejabberd configuration file must include mod_admin_extra as a module.

Examples

# Example playbook entries using the ejabberd_user module to manage users state.

- name: Create a user if it does not exist
  community.general.ejabberd_user:
    username: test
    host: server
    password: password

- name: Delete a user if it exists
  community.general.ejabberd_user:
    username: test
    host: server
    state: absent

Authors

  • Peter Sprygada (@privateip)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/ejabberd_user_module.html