Documentation : Command Line Documentation : Alias Management : Erase Alias

Erase Alias

Usage

erase alias $alias@$domain

- or -

erase alias $alias domain $domain 

Description

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

Symbol

erase alias

Cardinal

action-identifier

Language

Alias 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 alias information.

- Execute ldapmodify to remove the alias from OpenLDAP.

Template

# Erase virtualAlias
dn: alias=:#USER#:,domain=:#DOMAIN#:,o=domains,dc=:#LDAP_SUFFIX#:
changetype: delete

Return Codes

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

Example

Input

erase alias info@example.com

Generated LDIF file

# Erase virtualAlias
dn: alias=info,domain=example.com,o=domains,dc=revly
changetype: delete

Output

Erased the alias 'info@example.com'.

Returncode

0