3.4. changegroup

changegroup is the tool to change a group in a given context.

3.4.1. Parameters

-h,--helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output
-c,--contextid <contextid>The id of the context
-i,--groupid <groupid>The id or the name of the group
-n,--name <string>The group name
-d,--displayname <string>The displayname for the Group
-a,--addmembers <userid(s)>List of members to add to group, separated by ","
-r,--removemembers <userid(s)>List of members to be removed from group, separated by ","

3.4.2. Extra parameters when authentication is enabled

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

3.4.3. Return value

0 on success

>0 on failure

3.4.4. Mandatory parameters

contextid {adminuser adminpass} (groupid or name) and at minimum one parameter for an attribute to change

3.4.5. Command output

On success:

group <groupid> in context <contextid> changed

On failure:

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

3.4.6. Example

root@oxhe~# /opt/open-xchange/sbin/changegroup -c 123 -i 5 -d "new groupname"

group 5 in context 123 changed