Service - GlobalAccessGroup

Class: VMware.Hv.GlobalAccessGroup
See also: GlobalAccessGroupBase, GlobalAccessGroupId, GlobalAccessGroupInfo
Since: Horizon 8.2

Service Description

Information about a global access group. This primarily represents a hierarchical storage concept for global entities like global entitlements, on which to base admin user permissions. For instance, an admin with root global access group permissions could interact with global entitlement assigned to any global access group under that root.

Methods

Methods defined in this Service
GlobalAccessGroup_Create, GlobalAccessGroup_Delete, GlobalAccessGroup_Get, GlobalAccessGroup_List

GlobalAccessGroup_Create

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

Privileges

Privilege	Description
FOLDER_MANAGEMENT	Global 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 GlobalAccessGroup used to make the method call.
base	GlobalAccessGroupBase	attributes needed to add a global access group

Return Value

Type	Description
GlobalAccessGroupId	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_GLOBAL_FOLDER_ADDED	Sent when successfully creating a global access group.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalAccessGroup_Create" type="vdi:GlobalAccessGroup_CreateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalAccessGroup_CreateResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GlobalAccessGroupId"/>
               </sequence>
            </complexType>
         </element>

GlobalAccessGroup_Delete

Delete a given global access group. Global access group can be deleted only if it is not in use (across PODs).

Privileges

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

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalAccessGroup used to make the method call.
entityId	GlobalAccessGroupId	Id of the global 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_GLOBAL_FOLDER_DELETED	Sent when successfully deleting a global access group

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalAccessGroup_Delete" type="vdi:GlobalAccessGroup_DeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalAccessGroup_DeleteResponse">
            <complexType/>
         </element>

GlobalAccessGroup_Get

Get a global access group by Id.

Privileges

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

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalAccessGroup used to make the method call.
id	GlobalAccessGroupId	Global Access group id.

Return Value

Type	Description
GlobalAccessGroupInfo	requested global 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="GlobalAccessGroup_Get" type="vdi:GlobalAccessGroup_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalAccessGroup_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GlobalAccessGroupInfo"/>
               </sequence>
            </complexType>
         </element>

GlobalAccessGroup_List

List all global access groups.

Privileges

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

Parameters

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

Return Value

Type	Description
GlobalAccessGroupInfo[]	The global access groups.

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="GlobalAccessGroup_List" type="vdi:GlobalAccessGroup_ListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalAccessGroup_ListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GlobalAccessGroupInfo" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>