Stop Domain
Usage
stop domain $domain
Description
The command stop domain is used to stop a REVLY Virtual Domain record. Emails sent to stopped domains will bounce. Stopped domains are not able to login to services.
Symbol
stop domain
Cardinal
action-identifier
Language
Domain Admin
Module
Admin
Parameters
ChangeDate
usage: changedate $timestamp
description: A Unix timestamp representing the last time the domain 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 stop the domain.
- Execute ldapmodify to stop the domain in OpenLDAP.
Template
# Stop virtualDomain
dn: domain=:#DOMAIN#:,o=domains,dc=:#LDAP_SUFFIX#:
changetype: modify
replace: active
active: FALSE
-
replace: delete
delete: TRUE
-
replace: changeDate
:#CHANGE_DATE#:
Return Codes
Code | Human Readable Output |
---|---|
0 | Stopped the domain '$domain@$domain'. |
1 | The domain '$domain@$domain' does not exist. |
Example
Input
stop domain example.com
Generated LDIF file
# Stop virtualDomain
dn: domain=example.com,o=domains,dc=revly
changetype: modify
replace: active
active: FALSE=
-
replace: delete
delete: TRUE
-
replace: changeDate
changeDate: 1419358202
Output
Stopped the domain 'example.com'.
Returncode
0