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

Name	Type	Description
_this	ManagedObjectReference	A reference to the EntitledUserOrGroup used to make the method call.
id	UserOrGroupId	UserOrGroupId of entity to get.

Return Value

Type	Description
EntitledUserOrGroupInfo	requested user or group 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.
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="EntitledUserOrGroup_Get" type="vdi:EntitledUserOrGroup_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="EntitledUserOrGroup_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:EntitledUserOrGroupInfo"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the EntitledUserOrGroup used to make the method call.
id	UserOrGroupId	UserOrGroupId of entity to get.

Return Value

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="EntitledUserOrGroup_GetGlobalSummaryView" type="vdi:EntitledUserOrGroup_GetGlobalSummaryViewRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="EntitledUserOrGroup_GetGlobalSummaryViewResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:EntitledUserOrGroupGlobalSummaryView"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the EntitledUserOrGroup used to make the method call.
ids	UserOrGroupId[]	UserOrGroupIds of entities to get.

Return Value

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="EntitledUserOrGroup_GetGlobalSummaryViews" type="vdi:EntitledUserOrGroup_GetGlobalSummaryViewsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="EntitledUserOrGroup_GetGlobalSummaryViewsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:EntitledUserOrGroupGlobalSummaryView" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the EntitledUserOrGroup used to make the method call.
ids	UserOrGroupId[]	UserOrGroupIds of entities to get.

Return Value

Type	Description
EntitledUserOrGroupInfo[]	requested user or group infos.

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="EntitledUserOrGroup_GetInfos" type="vdi:EntitledUserOrGroup_GetInfosRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="EntitledUserOrGroup_GetInfosResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:EntitledUserOrGroupInfo" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the EntitledUserOrGroup used to make the method call.
id	UserOrGroupId	UserOrGroupId of entity to get.

Return Value

Type	Description
EntitledUserOrGroupLocalSummaryView	requested user or group local 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.
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="EntitledUserOrGroup_GetLocalSummaryView" type="vdi:EntitledUserOrGroup_GetLocalSummaryViewRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="EntitledUserOrGroup_GetLocalSummaryViewResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:EntitledUserOrGroupLocalSummaryView"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the EntitledUserOrGroup used to make the method call.
ids	UserOrGroupId[]	UserOrGroupIds of entities to get.

Return Value

Type	Description
EntitledUserOrGroupLocalSummaryView[]	requested user or group local 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.
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="EntitledUserOrGroup_GetLocalSummaryViews" type="vdi:EntitledUserOrGroup_GetLocalSummaryViewsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="EntitledUserOrGroup_GetLocalSummaryViewsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:EntitledUserOrGroupLocalSummaryView" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>