Start Group
Usage
start group $group
Description
The command start group is used to change the state of a REVLY Virtual Group. Emails sent to groups in the start state will be delivered to their users mail directories. Started groups are able to login to services.
Symbol
start group
Cardinal
action-identifier
Language
Group Admin
Module
Admin
Parameters
ChangeDate
usage: changedate $timestamp
description: A Unix timestamp representing the last time the group 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 group.
- Execute ldapmodify to start the group in OpenLDAP.
Template
# Start virtualGroup
dn: group=:#GROUP#:,o=groups,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 group '$group'. |
1 | The group '$group' does not exist. |
Example
Input
start group example.com
Generated LDIF file
# Start virtualGroup
dn: group=example,o=groups,dc=revly
changetype: modify
replace: active
active: TRUE
-
replace: delete
delete: FALSE
-
replace: changeDate
changeDate: 1419358202
Output
Started the group 'example.com'.
Returncode
0