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.

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

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

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.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

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

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