Pause User

Usage

pause user $user@$domain

- or -

pause user $user domain $domain

Description

The command pause user is used to pause a Virtual User record for REVLY. Paused users will continue to receive emails. Paused users are not able to login to services.

Symbol

pause user

Cardinal

action-identifier

Language

User Admin

Module

Admin

Parameters

ChangeDate

usage: changedate $timestamp

description: A Unix timestamp representing the last time the user 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 user.

- Execute ldapmodify to pause the user in OpenLDAP.

Template

# Pause virtualUser
dn: user=:#USER#:,domain=:#DOMAIN#:,o=domains,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 user '$user@$domain'.
1	The user '$user@$domain' does not exist.

Example

Input

pause user sally@example.com

Generated LDIF file

# Pause virtualUser
dn: user=sally,domain=example.com,o=domains,dc=revly
changetype: modify
replace: active
active: FALSE
-
replace: delete
delete: FALSE
-
replace: changeDate
changeDate: 1419358202

Output

Paused the user 'sally@example.com'.