Chapter 3. Group management

Table of Contents

creategroup
Parameters
Extra parameters when authentication is enabled
Return value
Mandatory parameters
Command output
Example
deletegroup
Parameters
Extra parameters when authentication is enabled
Return value
Mandatory parameters
Command output
Example
listgroup
Parameters
Extra parameters when authentication is enabled
Return value
Mandatory parameters
Command output
Example
changegroup
Parameters
Extra parameters when authentication is enabled
Return value
Mandatory parameters
Command output
Example

creategroup

creategroup is the tool to create a new group in a given context. Groups are created with no group members when no userid(s) are supplied with the parameter -a.

Parameters

-h,--helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output
-c,--contextid <integer>The id of the contex
-n,--name <string>The group name
-d,--displayname <stringe>The displayname for the group
-a,--addmembers <userid(s)>List of members to add to the group separated by ","

Extra parameters when authentication is enabled

-A,--adminuser <string>Context Admin user name
-P,--adminpass <string>Context Admin password

Return value

0 on success

>0 on failure

Mandatory parameters

contextid {adminuser adminpass} name displayname

Command output

On success:

group <groupid> in context <contextid> created

On failure:

group in context <contextid> could not be created: <reason from server>

Example

root@oxhe~# /opt/open-xchange/sbin/creategroup -c 123 -n "sales" -d "Sales Department"

group 4 in context 123 created