Edit Group

Usage

edit group $group

Description

The command edit group is used to modify a Virtual Group record for REVLY. This command may be used to alter the parameters Parent, Password, and Service.

Symbol

edit 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

Change Parent

usage: change parent $group

description: Change the name of a group that this group is a part of.

Change Password

usage: change password $password

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

Add Service

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

description: Add a service to the list of services that the group will have access to.

Remove Service

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

description: Remove a service from the list of services that the group will have access to.

Replace Service

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

description: Replace all services that the group will have access to with the supplied service or services.

Actions

- Encrypt a new group administrator password if provided.

- Generate a LDIF file containing the alterations to the group record.

- Execute ldapmodify to edit the group record in OpenLDAP.

Template

# Edit virtualGroup
dn: group=:#GROUP#:,o=groups,dc=:#LDAP_SUFFIX#:
changetype: modify
[:#CHANGE_PARENT#:]
[:#CHANGE_PASSWORD#:]
[:#ADD_SERVICE#:]
[:#REMOVE_SERVICE#:]
[:#REPLACE_SERVICE#:]
replace: changeDate
:#CHANGE_DATE#:

Sub-Templates

ChangeDate

changeDate: :#CHANGE_DATE#:

ChangeParent

replace: parent
:#PARENT#:
-

Parent

parent: :#PARENT#:

Change Password

replace: userPassword
:#PASSWORD#:
-

Password

password: :#PASSWORD#:

Add Service

add: service
:#SERVICE#:
-

Delete Service

delete: service
:#SERVICE#:
-

Replace Service

replace: service
:#SERVICE#:
-

Service

service: :#SERVICE#:

Return Codes

Code	Human Readable Output
0	Edited the group '$group'.
1	Could not edit the group '$group' because it does not exist.
2	Failed to add attributes to the group '$group' because one or more attributes already exists.
3	Failed to remove attributes from the group '$group' because one or more attributes does not exist.

Example

Input

edit group example change parent "root" change password "secret" replace service email groupware im

Generated LDIF file

# Edit virtualGroup
dn: group=example,o=groups,dc=revly
changetype: modify
replace: parent
parent: root
-
replace: userPassword
userPassword: {SSHA}GojpJiwrtz6zYKLyNa6nIoMy0GUS/LaYsgFSbA==
-
replace: service
service: email
service: groupware
service: im
-
replace: changeDate
changeDate: 1419358202

Output

Edited the group 'example'.