Service - GlobalApplicationEntitlement

Class
VMware.Hv.GlobalApplicationEntitlement
See also
ApplicationId, GlobalApplicationEntitlementBase, GlobalApplicationEntitlementId, GlobalApplicationEntitlementInfo, MapEntry
Since
Horizon View 6.2


Service Description

The Global Application Entitlement service interface.

Methods

Methods defined in this Service
GlobalApplicationEntitlement_AddApplicationsToGAE, GlobalApplicationEntitlement_Create, GlobalApplicationEntitlement_Delete, GlobalApplicationEntitlement_Get, GlobalApplicationEntitlement_Update

GlobalApplicationEntitlement_AddApplicationsToGAE

Add list of applications to the Global Application Entitlement.

Privileges

Privilege Description
POOL_MANAGEMENT privilege is required to update an Application.
FEDERATED_LDAP_MANAGE Global LDAP management is required to update the ApplicationInfo#data.globalApplicationEntitlement members of an application.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalApplicationEntitlement used to make the method call.
idGlobalApplicationEntitlementId

unique identifier for Global Application Entitlement
applicationsApplicationId[]

Applications to be added to the Global Application 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 applications were successfully added and which ones failed. The index of results in the PartialFailureFault corresponds to the application'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_APPLICATION_UPDATED for each Application attribute that was updated
VLSI_APPLICATION_UPDATE_FAILED if the Application update failed.

Show WSDL type definition



GlobalApplicationEntitlement_Create

Creates a Global Application Entitlement. Global application 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 application entitlement.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalApplicationEntitlement used to make the method call.
baseGlobalApplicationEntitlementBase

attributes required to create a Global Application Entitlement

Return Value

Type Description
GlobalApplicationEntitlementIdunique identifier for Global Application 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_GAE_ADDED If the global application entitlement was successfully created.
VLSI_GAE_ADD_FAILED If the global application entitlement could not be created.

Show WSDL type definition



GlobalApplicationEntitlement_Delete

Deletes a Global Application Entitlement.

Privileges

Privilege Description
FEDERATED_LDAP_MANAGE Global LDAP management is required to delete a Global Application Entitlement.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalApplicationEntitlement used to make the method call.
idGlobalApplicationEntitlementId

unique identifier for Global Application 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 Application 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_GAE_DELETED If the Global Application Entitlement was successfully deleted.
VLSI_GAE_DELETE_FAILED If the Global Application Entitlement could not be deleted.

Show WSDL type definition



GlobalApplicationEntitlement_Get

Returns Global Application Entitlement information corresponding to a specific Global Application Entitlement id.

Privileges

Privilege Description
FEDERATED_LDAP_VIEW Global LDAP read is required to read a Global Application Entitlement.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalApplicationEntitlement used to make the method call.
idGlobalApplicationEntitlementId

unique identifier for Global Application Entitlement

Return Value

Type Description
GlobalApplicationEntitlementInfoGlobal Application Entitlement information

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



GlobalApplicationEntitlement_Update

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

Privileges

Privilege Description
FEDERATED_LDAP_MANAGE Global LDAP management is required to update a Global Application Entitlement.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalApplicationEntitlement used to make the method call.
idGlobalApplicationEntitlementId

unique identifier for Global Application 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_GAE_CHANGED If the Global Application Entitlement was successfully updated.
VLSI_GAE_CHANGE_FAILED If the Global Application Entitlement could not be updated.

Show WSDL type definition