ansible.builtin.ejabberd_user (v2.9.27) — module

Manages users for ejabberd servers

| "added in version" 1.5 of ansible.builtin"

Authors: Peter Sprygada (@privateip)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

This module provides user management for ejabberd servers


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Example playbook entries using the ejabberd_user module to manage users state.

- name: create a user if it does not exist
  ejabberd_user:
    username: test
    host: server
    password: password
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: delete a user if it exists
  ejabberd_user:
    username: test
    host: server
    state: absent

Inputs

    
host:
    description:
    - the ejabberd host associated with this username
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - describe the desired state of the user to be managed
    required: false

logging:
    default: false
    description:
    - enables or disables the local syslog facility for this module
    required: false
    type: bool

password:
    description:
    - the password to assign to the username
    required: false

username:
    description:
    - the name of the user to manage
    required: true