Start Alias
Usage
start alias $alias@$domain
- or -
start alias $alias domain $domain
Description
The command start alias is used to start a Virtual Alias record for REVLY.
Symbol
start alias
Cardinal
action-identifier
Language
Alias Admin
Module
Admin
Parameters
ChangeDate
usage: changedate $timestamp
description: A Unix timestamp representing the last time the alias record was modified.
default: Current timestamp
LDAP Suffix
usage: ldap suffix $ldapsuffix
description: The base search path of the LDAP tree.
default: revly
Actions
- Generate a LDIF file to start the alias.
- Execute ldapmodify to start the alias in OpenLDAP.
Template
# Start virtualAlias
dn: alias=:#ALIAS#:,domain=:#DOMAIN#:,o=domains,dc=:#LDAP_SUFFIX#:
changetype: modify
replace: active
active: TRUE
-
replace: delete
delete: FALSE
-
replace: changeDate
:#CHANGE_DATE#:
Return Codes
Code | Human Readable Output |
---|---|
0 | Started the alias '$alias@$domain'. |
1 | The alias '$alias@$domain' does not exist. |
Example
Input
start alias info@example.com
Generated LDIF file
# Start virtualAlias
dn: alias=info,domain=example.com,o=domains,dc=revly
changetype: modify
replace: active
active: TRUE
-
replace: delete
delete: FALSE
-
replace: changeDate
changeDate: 1419358202
Output
started alias info@example.com
Returncode
0