Service - EntitledUserOrGroup

Class
VMware.Hv.EntitledUserOrGroup
See also
EntitledUserOrGroupGlobalSummaryView, EntitledUserOrGroupInfo, EntitledUserOrGroupLocalSummaryView, UserOrGroupId
Since
Horizon View 6.0


Service Description

Information about a User or a Group with resource entitlements.

Methods

Methods defined in this Service
EntitledUserOrGroup_Get, EntitledUserOrGroup_GetGlobalSummaryView, EntitledUserOrGroup_GetGlobalSummaryViews, EntitledUserOrGroup_GetInfos, EntitledUserOrGroup_GetLocalSummaryView, EntitledUserOrGroup_GetLocalSummaryViews

EntitledUserOrGroup_Get

Get an entitled user or group info by ID.

Privileges

Privilege Description
POOL_VIEW Desktop or application read privileges in the corresponding access group are required to include results for those desktops or applications.
MACHINE_VIEW Machine read privileges in the corresponding access group are required to include results for those machines.
UDD_VIEW Persistent disk read privileges in the corresponding access group are required to include results for those persistent disks.
FEDERATED_SESSIONS_VIEW Federated session read privilege or one of the above on the corresponding folder is required to include session information for a machine.
FEDERATED_LDAP_VIEW Global LDAP read is required to access the globalData members.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the EntitledUserOrGroup used to make the method call.
idUserOrGroupId

UserOrGroupId of entity to get.

Return Value

Type Description
EntitledUserOrGroupInforequested user or group 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.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



EntitledUserOrGroup_GetGlobalSummaryView

Get an entitled user or group global summary view by ID.

Privileges

Privilege Description
FEDERATED_LDAP_VIEW Global LDAP read is required to read a EntitledUserOrGroupGlobalSummaryView.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the EntitledUserOrGroup used to make the method call.
idUserOrGroupId

UserOrGroupId of entity to get.

Return Value

Type Description
EntitledUserOrGroupGlobalSummaryViewrequested user or group global 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 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.

Show WSDL type definition



EntitledUserOrGroup_GetGlobalSummaryViews

Get entitled user or group summary global views by ids.

Privileges

Privilege Description
FEDERATED_LDAP_VIEW Global LDAP read is required to read multiple EntitledUserOrGroupGlobalSummaryView.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the EntitledUserOrGroup used to make the method call.
idsUserOrGroupId[]

UserOrGroupIds of entities to get.

Return Value

Type Description
EntitledUserOrGroupGlobalSummaryView[]requested user or group global 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 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.

Show WSDL type definition



EntitledUserOrGroup_GetInfos

Get entitled user or group infos by ids.

Privileges

Privilege Description
POOL_VIEW Desktop or application read privileges in the corresponding access group are required to include results for those desktops or applications.
MACHINE_VIEW Machine read privileges in the corresponding access group are required to include results for those machines.
UDD_VIEW Persistent disk read privileges in the corresponding access group are required to include results for those persistent disks.
FEDERATED_SESSIONS_VIEW Federated session read privilege or one of the above on the corresponding folder is required to include session information for a machine.
FEDERATED_LDAP_VIEW Global LDAP read is required to access the globalData members.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the EntitledUserOrGroup used to make the method call.
idsUserOrGroupId[]

UserOrGroupIds of entities to get.

Return Value

Type Description
EntitledUserOrGroupInfo[]requested user or group infos.

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.

Show WSDL type definition



EntitledUserOrGroup_GetLocalSummaryView

Get an entitled user or group local summary view by ID.

Privileges

Privilege Description
POOL_VIEW Desktop or application read privileges in the corresponding access group are required to include results for those desktops or applications.
MACHINE_VIEW Machine read privileges in the corresponding access group are required to include results for those machines.
UDD_VIEW Persistent disk read privileges in the corresponding access group are required to include results for those persistent disks.
FEDERATED_SESSIONS_VIEW Federated session read privilege or one of the above on the corresponding folder is required to include session information for a machine.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the EntitledUserOrGroup used to make the method call.
idUserOrGroupId

UserOrGroupId of entity to get.

Return Value

Type Description
EntitledUserOrGroupLocalSummaryViewrequested user or group local 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.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



EntitledUserOrGroup_GetLocalSummaryViews

Get entitled user or group local summary views by ids.

Privileges

Privilege Description
POOL_VIEW Desktop or application read privileges in the corresponding access group are required to include results for those desktops or applications.
MACHINE_VIEW Machine read privileges in the corresponding access group are required to include results for those machines.
UDD_VIEW Persistent disk read privileges in the corresponding access group are required to include results for those persistent disks.
FEDERATED_SESSIONS_VIEW Federated session read privilege or one of the above on the corresponding folder is required to include session information for a machine.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the EntitledUserOrGroup used to make the method call.
idsUserOrGroupId[]

UserOrGroupIds of entities to get.

Return Value

Type Description
EntitledUserOrGroupLocalSummaryView[]requested user or group local 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.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition