Service - AccessGroup

Class: VMware.Hv.AccessGroup
See also: AccessGroupBase, AccessGroupId, AccessGroupInfo
Since: Horizon View 6.0

Service Description

Information about an access group. This primarily represents a hierarchical storage concept for desktops, applications, farms, machines, and persistent disks on which to base admin user permissions. For instance, an admin with root access group permissions could interact with desktops assigned to any access group under that root.

Methods

Methods defined in this Service
AccessGroup_Create, AccessGroup_Delete, AccessGroup_Get, AccessGroup_List

AccessGroup_Create

Add a new access group. delete/create should be used instead of update. Only access groups with root as a parent are supported.

Privileges

Privilege	Description
FOLDER_MANAGEMENT	Access group management privilege on the new access group's parent or its ancestors is required to create an access group.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the AccessGroup used to make the method call.
base	AccessGroupBase	attributes needed to add an access group

Return Value

Type	Description
AccessGroupId	unique identifier

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
ADMIN_FOLDER_ADDED	Sent when successfully creating an access group.
ADMIN_FOLDER_ADD_FAILED	Sent when an access group failed to be created.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AccessGroup_Create" type="vdi:AccessGroup_CreateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AccessGroup_CreateResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:AccessGroupId"/>
               </sequence>
            </complexType>
         </element>

AccessGroup_Delete

Delete a given access group and all permissions associated with it. This also deletes all children of the access group. delete/create should be used instead of update. The access group must not be associated with any Desktops, Farms, Applications, or Persistent Disks.

Privileges

Privilege	Description
FOLDER_MANAGEMENT	Access group management privilege on the specified access group or its ancestors is required to delete an access group.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the AccessGroup used to make the method call.
entityId	AccessGroupId	Id of the access group to delete.

Return Value

Type	Description
None

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
ADMIN_FOLDER_DELETED	Sent when successfully deleting an access group.
ADMIN_FOLDER_DELETE_FAILED	Sent when an access group failed to be deleted.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AccessGroup_Delete" type="vdi:AccessGroup_DeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AccessGroup_DeleteResponse">
            <complexType/>
         </element>

AccessGroup_Get

Get an access group by Id.

Privileges

Privilege	Description
GLOBAL_PERMISSION_VIEW	Read access to permissions is sufficient to read any access group. This is also necessary to read permissions that belong to the specified access group.
FOLDER_VIEW	Read access to a specific access group or its ancestors is necessary to read an access group without the above privilege.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the AccessGroup used to make the method call.
id	AccessGroupId	Access group id of entity to get.

Return Value

Type	Description
AccessGroupInfo	requested access group entity.

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AccessGroup_Get" type="vdi:AccessGroup_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AccessGroup_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:AccessGroupInfo"/>
               </sequence>
            </complexType>
         </element>

AccessGroup_List

List all permitted access groups via their allowed ancestor closest to the root access group. If the client has permission to read the root access group, this will return just the root access group, which can be traversed to list all access groups.

Privileges

Privilege	Description
GLOBAL_PERMISSION_VIEW	Read access to permissions is sufficient to read all access groups. This is also necessary to read permissions that belong to an access group.
FOLDER_VIEW	Read access to a specific access group or its ancestors is necessary to read an access group without the above privilege.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the AccessGroup used to make the method call.

Return Value

Type	Description
AccessGroupInfo[]	The permitted access groups, listed by their ancestors closest to the root.

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AccessGroup_List" type="vdi:AccessGroup_ListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="AccessGroup_ListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:AccessGroupInfo" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>