W3cubDocs

/Ansible

ejabberd_user - Manages users for ejabberd servers

New in version 1.5.

Synopsis

This module provides user management for ejabberd servers

Requirements (on host that executes module)

  • ejabberd with mod_admin_extra

Options

parameter required default choices comments
host
 yes
the ejabberd host associated with this username
logging
 no
  • true
  • false
  • yes
  • no
enables or disables the local syslog facility for this module
password
 no
the password to assign to the username
state
 no present
  • present
  • absent
describe the desired state of the user to be managed
username
 yes
the name of the user to manage

Examples

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

    tasks:

    - name: create a user if it does not exists
      action: ejabberd_user username=test host=server password=password

    - name: delete a user if it exists
      action: ejabberd_user username=test host=server state=absent

Notes

Note

Password parameter is required for state == present only

Note

Passwords must be stored in clear text for this release

Note

The ejabberd configuration file must include mod_admin_extra as a module.

This is an Extras Module

For more information on what this means please read Extras Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/ejabberd_user_module.html