Service - GlobalEntitlement

Class: VMware.Hv.GlobalEntitlement
See also: DesktopId, GlobalEntitlementBase, GlobalEntitlementId, GlobalEntitlementInfo, GlobalEntitlementSummaryView, MapEntry
Since: Horizon View 6.0

Service Description

The Global Entitlement service interface.

Methods

Methods defined in this Service
GlobalEntitlement_AddDesktopsToGE, GlobalEntitlement_Create, GlobalEntitlement_Delete, GlobalEntitlement_Get, GlobalEntitlement_GetSummaryView, GlobalEntitlement_GetSummaryViews, GlobalEntitlement_ListCompatibleBackupGEs, GlobalEntitlement_RemoveDesktopsFromGE, GlobalEntitlement_Update

GlobalEntitlement_AddDesktopsToGE

Add list of desktops to the Global Entitlement.

Privileges

Privilege	Description
POOL_MANAGEMENT	Desktop management with the corresponding access group permission is required to update a desktop.
FEDERATED_LDAP_MANAGE	Global LDAP management is required to update the globalEntitlementData members of a desktop.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalEntitlement used to make the method call.
id	GlobalEntitlementId	unique identifier for Global Entitlement
desktops	DesktopId[]	Desktops to be added to the Global Entitlement

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.
PartialFailureFault	Thrown if all operations were not successful, a PartialFailureFault will be thrown indicating which desktops were successfully added and which ones failed. The index of results in the PartialFailureFault corresponds to the desktop's index in request. The result entry will contain either the original return type (on success) or an exception (on failure).
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
VLSI_DESKTOP_UPDATE_ATTEMPT	For every Desktop, if an attempt to update the desktop was made successfully
VLSI_DESKTOP_UPDATED	For every Desktop, if a desktop is successfully updated.
VLSI_DESKTOP_UPDATE_FAILED	For every Desktop that could not be updated.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalEntitlement_AddDesktopsToGE" type="vdi:GlobalEntitlement_AddDesktopsToGERequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalEntitlement_AddDesktopsToGEResponse">
            <complexType/>
         </element>

GlobalEntitlement_Create

Creates a Global Entitlement. Global entitlements are used to route users to their resources across multiple pods. These are persisted in a global ldap instance that is replicated across all pods in a linked mode view set.

Privileges

Privilege	Description
FEDERATED_LDAP_MANAGE	Global LDAP management is required to create a global entitlement.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalEntitlement used to make the method call.
base	GlobalEntitlementBase	attributes required to create a Global Entitlement

Return Value

Type	Description
GlobalEntitlementId	unique identifier for Global Entitlement

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.
InvalidState	Thrown if this pod is not part of a Pod Federation
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
VLSI_GE_ADDED	If the global entitlement was successfully created.
VLSI_GE_ADD_FAILED	If the global entitlement could not be created.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalEntitlement_Create" type="vdi:GlobalEntitlement_CreateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalEntitlement_CreateResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GlobalEntitlementId"/>
               </sequence>
            </complexType>
         </element>

GlobalEntitlement_Delete

Deletes a Global Entitlement.

Privileges

Privilege	Description
FEDERATED_LDAP_MANAGE	Global LDAP management is required to delete a global entitlement.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalEntitlement used to make the method call.
id	GlobalEntitlementId	unique identifier for Global Entitlement to be deleted

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.
InvalidRequest	Thrown if Global Entitlement is active and has resources associated with it in any pod.
InvalidState	Thrown if the Pod Federation has not been initialized.
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
VLSI_GE_DELETED	If the global entitlement was successfully deleted.
VLSI_GE_DELETE_FAILED	If the global entitlement could not be deleted.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalEntitlement_Delete" type="vdi:GlobalEntitlement_DeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalEntitlement_DeleteResponse">
            <complexType/>
         </element>

GlobalEntitlement_Get

Returns Global Entitlement corresponding to a specific Global Entitlement id.

Privileges

Privilege	Description
FEDERATED_LDAP_VIEW	Global LDAP read is required to read a global entitlement.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalEntitlement used to make the method call.
id	GlobalEntitlementId	unique identifier for Global Entitlement

Return Value

Type	Description
GlobalEntitlementInfo	Global entitlement info

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.
InvalidState	Thrown if this pod is not part of a Pod Federation
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="GlobalEntitlement_Get" type="vdi:GlobalEntitlement_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalEntitlement_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GlobalEntitlementInfo"/>
               </sequence>
            </complexType>
         </element>

GlobalEntitlement_GetSummaryView

Returns Global Entitlement summary corresponding to a specific Global Entitlement id.

Privileges

Privilege	Description
FEDERATED_LDAP_VIEW	Global LDAP read is required to read a global entitlement.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalEntitlement used to make the method call.
id	GlobalEntitlementId	unique identifier for Global Entitlement

Return Value

Type	Description
GlobalEntitlementSummaryView	Global entitlement summary view

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.
InvalidState	Thrown if this pod is not part of a Pod Federation
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="GlobalEntitlement_GetSummaryView" type="vdi:GlobalEntitlement_GetSummaryViewRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalEntitlement_GetSummaryViewResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GlobalEntitlementSummaryView"/>
               </sequence>
            </complexType>
         </element>

GlobalEntitlement_GetSummaryViews

Returns Global Entitlement summaries corresponding to the specific Global Entitlement ids.

Privileges

Privilege	Description
FEDERATED_LDAP_VIEW	Global LDAP read is required to read a global entitlements.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalEntitlement used to make the method call.
ids	GlobalEntitlementId[]	unique identifiers for Global Entitlements

Return Value

Type	Description
GlobalEntitlementSummaryView[]	Global entitlement summary views

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.
InvalidState	Thrown if this pod is not part of a Pod Federation
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="GlobalEntitlement_GetSummaryViews" type="vdi:GlobalEntitlement_GetSummaryViewsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalEntitlement_GetSummaryViewsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GlobalEntitlementSummaryView" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

GlobalEntitlement_ListCompatibleBackupGEs

Lists the Global Entitlements that can be associated as backup Global Entitlement.

Privileges

Privilege	Description
FEDERATED_LDAP_VIEW	Global LDAP read is required to read a global entitlement.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalEntitlement used to make the method call.
id	GlobalEntitlementId	unique identifier for Global Entitlement

Return Value

Type	Description
GlobalEntitlementInfo[]

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="GlobalEntitlement_ListCompatibleBackupGEs" type="vdi:GlobalEntitlement_ListCompatibleBackupGEsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalEntitlement_ListCompatibleBackupGEsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GlobalEntitlementInfo" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

GlobalEntitlement_RemoveDesktopsFromGE

Remove the specified desktops from the Global Entitlement.

Privileges

Privilege	Description
POOL_MANAGEMENT	Desktop management with the corresponding access group permission is required to update a desktop.
FEDERATED_LDAP_MANAGE	Global LDAP management is required to update the globalEntitlementData members of a desktop.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalEntitlement used to make the method call.
id	GlobalEntitlementId	unique identifier for Global Entitlement
desktops	DesktopId[]	Desktops to be removed from the Global Entitlement

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
VLSI_DESKTOP_UPDATE_ATTEMPT	For every Desktop, if an attempt to update the desktop was made successfully.
VLSI_DESKTOP_UPDATED	For every Desktop, if a desktop is successfully updated.
VLSI_DESKTOP_UPDATE_FAILED	For every Desktop that could not be updated.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalEntitlement_RemoveDesktopsFromGE" type="vdi:GlobalEntitlement_RemoveDesktopsFromGERequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalEntitlement_RemoveDesktopsFromGEResponse">
            <complexType/>
         </element>

GlobalEntitlement_Update

Updates Global Entitlement with the set of attributes in the map.

Privileges

Privilege	Description
FEDERATED_LDAP_MANAGE	Global LDAP management is required to update a global entitlement.

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the GlobalEntitlement used to make the method call.

GlobalEntitlementId

unique identifier for Global Entitlement to be updated

updates

MapEntry[]

key value pairs describing attributes to be updated

This parameter is an update map based on GlobalEntitlementInfo.

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.
InvalidRequest	Thrown if the update map contains invalid or non-permitted fields
InvalidState	Thrown if the Pod Federation has not been initialized.
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
VLSI_GE_CHANGED	If the global entitlement was successfully updated.
VLSI_GE_CHANGE_FAILED	If the global entitlement could not be updated.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalEntitlement_Update" type="vdi:GlobalEntitlement_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalEntitlement_UpdateResponse">
            <complexType/>
         </element>