Service - Policies

Class: VMware.Hv.Policies
See also: EntityId, MapEntry, PoliciesInfo, PoliciesSettings, UserOrGroupId
Since: Horizon View 6.0

Service Description

Service for reading and specifying policy settings for resources, and users or groups. Covers policies for multimedia redirection, USB access, remote mode, and PCoIP hardware acceleration.

Methods

Methods defined in this Service
Policies_Clear, Policies_Get, Policies_List, Policies_ListUnentitledPolicies, Policies_Set, Policies_Update

Policies_Clear

Clear overrides for the given resource, or user or group on a given resource. Clearing overrides for a resource will not delete any overrides for specific users or groups on that resource. Cannot clear global policies.

Privileges

Privilege	Description
POOL_MANAGEMENT	Requires pool management to clear pool or user policies

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the Policies used to make the method call.

resource

EntityId

Entity Id of resource to clear policy overrides for.

userOrGroup

UserOrGroupId

User or Group Id of user or group to clear policy overrides for.

Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type	Description
None

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="Policies_Clear" type="vdi:Policies_ClearRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Policies_ClearResponse">
            <complexType/>
         </element>

Policies_Get

Get the overrides for the given (optional, as long as userId is not present) resource and (optional) user or group. Global policies and effective policies will always exist. If there is a resource or user or group policies object, these are the overrides specific to the resource or user or group, respectively. The resourceId and userId of the returned object should always match the passed-in resourceId and userId. However, if no overrides exist specifically for that resource, or for that user or group on that resource, the associated policies object will be null.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Requires global configuration view or pool view to get global policies
POOL_VIEW	Requires pool view or global configuration view to get global policies. Requires pool view to get pool or user overrides

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the Policies used to make the method call.

resource

EntityId

Entity Id of resource to get policies for.

Optional parameter. If not specifing any value, this should be set to null.

userOrGroup

UserOrGroupId

User or Group Id of user or group to get policies for.

Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type	Description
PoliciesInfo	PoliciesInfo object describing policy overrides and effective policies for given resourceId and userId.

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="Policies_Get" type="vdi:Policies_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Policies_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:PoliciesInfo"/>
               </sequence>
            </complexType>
         </element>

Policies_List

Get all overrides for users or groups on a given resource. May be null if there are no overrides for this users or groups on this resource.

Privileges

Privilege	Description
POOL_VIEW	Requires pool view to list user policy overrides on a specific pool.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Policies used to make the method call.
resource	EntityId	Entity Id of resource to get policies for.

Return Value

Type	Description
PoliciesInfo[]	List of complete policies for all users that have specific overrides for this resource.

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="Policies_List" type="vdi:Policies_ListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Policies_ListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:PoliciesInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

Policies_ListUnentitledPolicies

Get all unentitled policies. May be null if there are no unentitled policies present. Unentitled policies are the policy overrides for the users, who are no longer entitled to their resources.

Privileges

Privilege	Description
POOL_VIEW	Requires pool view to list unentitled policy overrides for various users.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Policies used to make the method call.

Return Value

Type	Description
PoliciesInfo[]	List of complete unentitled policies for all users that have specific overrides for this resource.

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="Policies_ListUnentitledPolicies" type="vdi:Policies_ListUnentitledPoliciesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Policies_ListUnentitledPoliciesResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:PoliciesInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

Policies_Set

Create an override for the associated policies settings for the specified (optional, as long as userId is not present) resource and (optional) user or group. Global policies may be set as long as none of the values are set to INHERIT.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Requires global configuration management to set global policies
POOL_MANAGEMENT	Requires pool management to set pool or user policies

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Policies used to make the method call.
resource	EntityId	Entity Id of resource to set policies for. Optional parameter. If not specifing any value, this should be set to null.
userOrGroup	UserOrGroupId	User or Group Id of user or group to set policies for. Optional parameter. If not specifing any value, this should be set to null.
settings	PoliciesSettings	Policies object to use as overrides.

Return Value

Type	Description
None

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="Policies_Set" type="vdi:Policies_SetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Policies_SetResponse">
            <complexType/>
         </element>

Policies_Update

Update the associated policies settings for the specified (optional, as long as userId is not present) resource and (optional) user or group. Global policies may be updated as long as none of the values are set to INHERIT. If there are no overrides for the specified resource and user or group, a new set of overrides will be created, and the default value of INHERIT will be assumed for any policies which are not specifically included in the update. If there are existing overrides for the specified resource and user or group, no policies which are not specified in the update map will be changed.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Requires global configuration management to update global policies
POOL_MANAGEMENT	Requires pool management to update pool or user policies

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Policies used to make the method call.
resource	EntityId	Entity Id of resource to apply this update to. Optional parameter. If not specifing any value, this should be set to null.
userOrGroup	UserOrGroupId	User or Group Id of user or group to apply this update to. Optional parameter. If not specifing any value, this should be set to null.
updates	MapEntry[]	Update map. This parameter is an update map based on PoliciesSettings.

Return Value

Type	Description
None

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="Policies_Update" type="vdi:Policies_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Policies_UpdateResponse">
            <complexType/>
         </element>