community.general.ejabberd_user – Manages users for ejabberd servers
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.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 | Choices/Defaults | Comments |
|---|---|---|
| host
string / required
|
the ejabberd host associated with this username
|
|
| logging
boolean
|
|
enables or disables the local syslog facility for this module
|
| password
string
|
the password to assign to the username
|
|
| state
string
|
|
describe the desired state of the user to be managed
|
| username
string / required
|
the name of the user to manage
|
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–2021 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