Documentation : Command Line Documentation : User Management : Erase User

Erase User

Usage

erase user $user@$domain

- or -

erase user $user domain $domain

Description

The command erase user is used to remove a Virtual User record for REVLY. This action cannot be undone.

Symbol

erase user

Cardinal

action-identifier

Language

User Admin

Module

Admin

Parameters

LDAP Suffix

usage: ldap suffix $ldapsuffix

description: The base search path of the LDAP tree.

default: revly

Actions

- Generate a LDIF file to remove the user information.

- Execute ldapmodify to remove the user from OpenLDAP.

Template

# Erase virtualUser
dn: user=:#USER#:,domain=:#DOMAIN#:,o=domains,dc=:#LDAP_SUFFIX#:
changetype: delete

Return Codes

CodeHuman Readable Output
0Erased the user '$user@$domain'
1The user '$user@$domain' does not exist.

Example

Input

erase user sally@example.com

Generated LDIF file

# Erase virtualUser
dn: user=sally,domain=example.com,o=domains,dc=revly
changetype: delete

Output

Erased the user 'user@example.com'.

Returncode

0