3.2. deletegroup

deletegroup is the tool to delete a group in a given context. There is no need to remove the group members before.

3.2.1. Parameters

-h,--helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output
-i,--groupid <groupid>The id or the name of the group
-n,--name <name>The group name

3.2.2. Extra parameters when authentication is enabled

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

3.2.3. Return value

0 on success

>0 on failure

3.2.4. Mandatory parameters

contextid {adminuser adminpass} (groupid or name)

3.2.5. Command output

On success:

group <groupid> in context <contextid> deleted

On failure:

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

3.2.6. Example

root@oxhe~# /opt/open-xchange/sbin/deletegroup -c 123 -n sales

group 4 in context 123 deleted