community.general.ejabberd_user module – Manages users for ejabberd servers
This module is part of the community.general collection (version 6.6.2).
You might already have this collection installed if you are using the
It is not included in
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:
This module provides user management for ejabberd servers
The below requirements are needed on the host that executes this module.
ejabberd with mod_admin_extra
the ejabberd host associated with this username
enables or disables the local syslog facility for this module
the password to assign to the username
describe the desired state of the user to be managed
the name of the user to manage
Can run in
Will return details on what has changed (or possibly needs changing in
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.
# Example playbook entries using the ejabberd_user module to manage users state.
- name: Create a user if it does not exist
- name: Delete a user if it exists