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_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

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalEntitlement used to make the method call.
idGlobalEntitlementId

unique identifier for Global Entitlement
desktopsDesktopId[]

Desktops to be added to the Global Entitlement

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
PartialFailureFaultThrown 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).
UnexpectedFaultThrown 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



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

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalEntitlement used to make the method call.
baseGlobalEntitlementBase

attributes required to create a Global Entitlement

Return Value

Type Description
GlobalEntitlementIdunique identifier for Global Entitlement

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidStateThrown if this pod is not part of a Pod Federation
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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



GlobalEntitlement_Delete

Deletes a Global Entitlement.

Privileges

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalEntitlement used to make the method call.
idGlobalEntitlementId

unique identifier for Global Entitlement to be deleted

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if Global Entitlement is active and has resources associated with it in any pod.
InvalidStateThrown if the Pod Federation has not been initialized.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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



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

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalEntitlement used to make the method call.
idGlobalEntitlementId

unique identifier for Global Entitlement

Return Value

Type Description
GlobalEntitlementInfoGlobal entitlement info

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidStateThrown if this pod is not part of a Pod Federation
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalEntitlement used to make the method call.
idGlobalEntitlementId

unique identifier for Global Entitlement

Return Value

Type Description
GlobalEntitlementSummaryViewGlobal entitlement summary view

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidStateThrown if this pod is not part of a Pod Federation
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalEntitlement used to make the method call.
idsGlobalEntitlementId[]

unique identifiers for Global Entitlements

Return Value

Type Description
GlobalEntitlementSummaryView[]Global entitlement summary views

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidStateThrown if this pod is not part of a Pod Federation
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalEntitlement used to make the method call.
idGlobalEntitlementId

unique identifier for Global Entitlement
desktopsDesktopId[]

Desktops to be removed from the Global Entitlement

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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



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

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalEntitlement used to make the method call.
idGlobalEntitlementId

unique identifier for Global Entitlement to be updated
updatesMapEntry[]

key value pairs describing attributes to be updated

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the update map contains invalid or non-permitted fields
InvalidStateThrown if the Pod Federation has not been initialized.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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