Service -
GlobalEntitlement
- Class
- VMware.Hv.GlobalEntitlement
- See also
-
GlobalEntitlementBase, GlobalEntitlementId, GlobalEntitlementInfo, GlobalEntitlementSummaryView, MapEntry
- Since
- Horizon View 6.0
Service Description
The Global Entitlement service interface.
Methods
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
Return Value
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
GlobalEntitlement_Delete
Deletes a Global Entitlement.
Privileges
Privilege
|
Description
|
FEDERATED_LDAP_MANAGE |
Global LDAP management is required to
delete a global entitlement.
|
Parameters
Return Value
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
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
Return Value
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
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
Return Value
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
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
Return Value
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
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
Return Value
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
© 2018 VMware, Inc. All rights reserved.
Revision Sep-2018 Version 7.6.0