Start User

Usage

start user $user@$domain

- or -

start user $user domain $domain 

Description

The command start user is used to change the state of a REVLY Virtual User. Emails sent to users in the start state will be delivered to their mail directory. Started users are able to login to services.

Symbol

start 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 start the user.

- Execute ldapmodify to start the user in OpenLDAP.

Template

# Start virtualUser
dn: user=:#USER#:,domain=:#DOMAIN#:,o=domains,dc=:#LDAP_SUFFIX#:
changetype: modify
replace: active
active: TRUE
-
replace: delete
delete: FALSE
-
replace: changeDate
:#CHANGE_DATE#:

Return Codes

CodeHuman Readable Output
0Started the user '$user@$domain'.
1The user '$user@$domain' does not exist.

Example

Input

start user sally@example.com

Generated LDIF file

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

Output

Started the user 'sally@example.com'.

Returncode

0