Create Group

Usage

create group $group

Description

The command create group is used to create a Virtual Group record for REVLY. Groups may contain domains and other groups. The new group will have access and rights to services defined by the command's parameters.

Symbol

create 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

CreateDate

usage: createdate $timestamp

description: A Unix timestamp representing the time the group record was created.

default: Current timestamp

Parent

usage: parent $group

description: The name of a group that this group is a part of.

LDAP Suffix

usage: ldap suffix $ldapsuffix

description: The base search path of the LDAP tree.

default: revly

Password

usage: password $password

description: Sets a password for the group. This allows a group administrator to login with the group name as a username.

Service

usage: service $service [$service etc..]

description: A list of services that the group will have access to.

Actions

- Encrypt a new group administrator password if provided.

- Generate a LDIF file containing the new group information.

- Execute ldapmodify to add the group to OpenLDAP.

Template

# Create virtualGroup
dn: group=:#GROUP#:,o=groups,dc=:#LDAP_SUFFIX#:
changetype: add
objectClass: top
objectClass: virtualGroup
active: TRUE
delete: FALSE
[:#PARENT#:]
[:#PASSWORD#:]
[:#SERVICE#:]
:#CREATE_DATE#:
:#CHANGE_DATE#:
group: :#GROUP#:

Sub-Templates

CreateDate

createDate: :#CREATE_DATE#:

ChangeDate

changeDate: :#CHANGE_DATE#:

Parent

parent: :#PARENT#:

Password

password: :#PASSWORD#:

Serivce

service: :#SERVICE#:

Return Codes

Code	Human Readable Output
0	Created the group '$group'.
1	Could not create the group '$group' because it already exists.

Example

Input

create group example parent "root" password "secret" service email groupware im

Generated LDIF file

# Create virtualGroup
dn: group=example,o=groups,dc=revly
changetype: add
objectClass: top
objectClass: virtualGroup
active: TRUE
delete: FALSE
parent: root
userPassword: {SSHA}GojpJiwrtz6zYKLyNa6nIoMy0GUS/LaYsgFSbA==
service: email
service: groupware
service: im
createDate: 1419358202
changeDate: 1419358202
group: example

Output

Created the group 'example'.