Pause Group

Usage

pause group $group

Description

The command pause group is used to pause a REVLY Virtual Group record. Paused groups will continue to receive emails. Paused groups are not able to login to services.

Symbol

pause 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 pause the group.

- Execute ldapmodify to pause the group in OpenLDAP.

Template

# Pause virtualGroup
dn: group=:#GROUP#:,o=groups,dc=:#LDAP_SUFFIX#:
changetype: modify
replace: active
active: FALSE
-
replace: delete
delete: FALSE
-
replace: changeDate
:#CHANGE_DATE#:

Return Codes

Code	Human Readable Output
0	Paused the group '$group'.
1	The group '$group' does not exist.

Example

Input

pause group example

Generated LDIF file

# Pause virtualGroup
dn: group=example,o=groups,dc=revly
changetype: modify
replace: active
active: FALSE
-
replace: delete
delete: FALSE
-
replace: changeDate
changeDate: 1419358202

Output

Paused the group 'example'.