Chapter 3. Group management
Prev   Next

Chapter 3. Group management

Table of Contents

3.1 creategroup
3.1.1 Parameters
3.1.2 Extra parameters when authentication is enabled
3.1.3 Return value
3.1.4 Mandatory parameters
3.1.5 Command output
3.1.6 Example
3.2 deletegroup
3.2.1 Parameters
3.2.2 Extra parameters when authentication is enabled
3.2.3 Return value
3.2.4 Mandatory parameters
3.2.5 Command output
3.2.6 Example
3.3 listgroup
3.3.1 Parameters
3.3.2 Extra parameters when authentication is enabled
3.3.3 Return value
3.3.4 Mandatory parameters
3.3.5 Command output
3.3.6 Example
3.4 changegroup
3.4.1 Parameters
3.4.2 Extra parameters when authentication is enabled
3.4.3 Return value
3.4.4 Mandatory parameters
3.4.5 Command output
3.4.6 Example

3.1. 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.

3.1.1. 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 ","

3.1.2. Extra parameters when authentication is enabled

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

3.1.3. Return value

0 on success

>0 on failure

3.1.4. Mandatory parameters

contextid {adminuser adminpass} name displayname

3.1.5. Command output

On success:

group <groupid> in context <contextid> created

On failure:

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

3.1.6. Example

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

group 4 in context 123 created

Prev   Next
2.7. usercopy Home 3.2. deletegroup