group Object

Use this object to manage user groups.

Method	Description
create	Add a group to the grid controller's local directory service database. The new group is created without any members.
destroy	Destroy a group.
list	List groups in the grid controller's local directory service database and groups in the global directory service database (if the grid is configured to use such a service).
get	Show group information. The information displayed includes: group name, ID, scope, description, and principal group members.
info	Show group information. The information displayed includes: group name, ID, scope, description, and principal group members.
put	Replace a local group's description and entire membership.
modify	Replace a local group's description or membership.
get_newobj_acl	Retrieve the new object ACL definition associated to a group
put_newobj_acl	Replace the entire new object ACL definition associated to a group
modify_newobj_acl	Replace portion of a new object ACL definition associated to a group

Description

Add a group to the grid controller's local directory service database. The new group is created without any members.

Syntax

/api/v1/group/create?group=group&vdc=controller-name

Arguments

Transaction Type

synchronous

Request Type

GET

Examples

Create a local group named mygroup

GET
http://192.168.123.200/api/v1/group/create?group=mygroup&vdc=mygrid

Sample Output

JSON:


{
   "message" : "Creating group mygroup...\n"
}

XML:


<message>Creating group mygroup...
</message>

HTTP Error Codes

400: Entity vdc mygrid not found
- A VDC name was specified that is not configured in the WS_API application.
400.4: Missing required arguments (app).
- Argument group=group missing.

Note: This API is available with WS_API_r6-1.0.6-1 and above.