Updates Policies On Desktop Pool

Updates Policies On Desktop Pool

All the listed privileges are required -

Privileges Description
POOL_MANAGEMENT Caller should have permission to this privilege, on the associated access group of the desktop pool.
Request
URI
PUT
https://{api_host}/rest/inventory/v1/desktop-pools/{id}/policies
COPY
Path Parameters
string
id
Required

id

Request Body
PoliciesSettingsUpdateSpec of type(s) application/json
Required 
{
    "allow_multimedia_redirection": "ALLOW",
    "allow_pcoip_hardware_acceleration": "ALLOW",
    "allow_remote_mode": "ALLOW",
    "allow_usb_access": "ALLOW",
    "pcoip_hardware_acceleration_priority": "MEDIUM"
}
string
allow_multimedia_redirection
Required

Determines whether MMR (Multimedia Redirection, a Microsoft DirectShow filter) is enabled for client systems.

  • ALLOW: This policy option is set to allow.
  • DENY: This policy option is set to deny.
  • INHERIT: This policy option will be inherited from the parent.
Possible values are : ALLOW, DENY, INHERIT,
string
allow_pcoip_hardware_acceleration
Required

Determines whether to enable hardware acceleration of the PCoIP display protocol. Default value is ALLOW. If the property is set, pcoip_hardware_acceleration_priority must be set. This setting has an effect only if a PCoIP hardware acceleration device is present on the physical computer that hosts the machine.

  • ALLOW: This policy option is set to allow.
  • DENY: This policy option is set to deny.
  • INHERIT: This policy option will be inherited from the parent.
Possible values are : ALLOW, DENY, INHERIT,
string
allow_remote_mode
Required

Determines whether users can connect to and use machines running on vCenter Server instances. If set to deny, machines must be used in local mode.

  • ALLOW: This policy option is set to allow.
  • DENY: This policy option is set to deny.
  • INHERIT: This policy option will be inherited from the parent.
Possible values are : ALLOW, DENY, INHERIT,
string
allow_usb_access
Required

Determines whether machines can use USB devices connected to the client system.

  • ALLOW: This policy option is set to allow.
  • DENY: This policy option is set to deny.
  • INHERIT: This policy option will be inherited from the parent.
Possible values are : ALLOW, DENY, INHERIT,
string
pcoip_hardware_acceleration_priority
Optional

Determines priority for hardware acceleration. This property is ignored, if allow_pcoip_hardware_acceleration is not set to ALLOW. Default value is MEDIUM priority.

  • LOWEST: PCOIP Hardware acceleration priority is lowest possible.
  • LOWER: PCOIP Hardware acceleration priority is lower.
  • MEDIUM: PCOIP Hardware acceleration priority is medium. Default.
  • HIGHER: PCOIP Hardware acceleration priority is higher.
  • HIGHEST: PCOIP Hardware acceleration priority is highest.
Possible values are : LOWEST, LOWER, MEDIUM, HIGHER, HIGHEST,
Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page
Inventory Operations
POST
Add Custom Icon
POST
Add Local Application Pools To GAE
POST
Add Local Desktop Pools To GDE
POST
Add Machines
POST
Add Machines By Name
POST
Add Rds Servers
POST
Application Icon Bulk Associate
POST
Application Icon Bulk Remove Association
POST
Archive Machines
POST
Assign Machine Aliases
POST
Assign Users
POST
Attach Persistent Disk
POST
Cancel Agent Upgrades
POST
Cancel Desktop Pool Task
POST
Cancel Rds Server Agent Upgrades
POST
Cancel Scheduled Maintenance
POST
Cancel Scheduled Push Image
POST
Check Application Pool Name Availability
POST
Check Desktop Pool Name Availability
POST
Check Farm Name Availability
POST
Check Machine Prefix Availability
POST
Check RDS Server Prefix Availability
POST
Create Application Icon
POST
Create Application Pool
POST
Create Application Pool V2
POST
Create Application Pool V3
POST
Create Application Pool V5
POST
Create Desktop Pool
POST
Create Desktop Pool V2
POST
Create Desktop Pool V7
POST
Create Farm
POST
Create Farm V2
POST
Create Farm V3
POST
Create Farm V6
POST
Create Global Application Entitlement
POST
Create Global Application Entitlement V3
POST
Create Global Desktop Entitlement
POST
Create Global Desktop Entitlement V2
POST
Create Global Desktop Entitlement V3
POST
Create Persistent Disk
POST
Create Policy Overrides For Users
DELETE
Delete Application Icon
DELETE
Delete Application Pool
DELETE
Delete Application Pools
DELETE
Delete Application Pools V5
DELETE
Delete Desktop Pool
DELETE
Delete Desktop Pool V7
DELETE
Delete Farm
DELETE
Delete Farm V6
DELETE
Delete Global Application Entitlement
DELETE
Delete Global Application Entitlement V3
DELETE
Delete Global Desktop Entitlement
DELETE
Delete Global Desktop Entitlement V3
DELETE
Delete Machine
DELETE
Delete Machines
DELETE
Delete Persistent Disk
DELETE
Delete Physical Machine
DELETE
Delete Policy Overrides For Users
DELETE
Delete RDS Server
DELETE
Delete RDS Server V2
POST
Desktop Pool Apply Image
POST
Desktop Pool Promote Pending Image
POST
Detach Persistent Disk
POST
Disable Application Pools
POST
Disable Desktop Pools
POST
Disable Provisioning For Desktop Pools
POST
Disconnect Global Sessions
POST
Disconnect Sessions
POST
Enable Application Pools
POST
Enable Desktop Pools
POST
Enable Provisioning For Desktop Pools
POST
Enter Maintenance
POST
Exit Maintenance
POST
Farm Apply Image
POST
Farm Promote Pending Image
GET
Get Agent Installer Package
GET
Get Agent Upgrade Task
GET
Get Agent Upgrade Task V2
GET
Get Application Icon
GET
Get Application Pool
GET
Get Application Pool V2
GET
Get Application Pool V3
GET
Get Application Pool V4
GET
Get Application Pool V5
GET
Get Desktop Pool
GET
Get Desktop Pool Task
GET
Get Desktop Pool V2
GET
Get Desktop Pool V3
GET
Get Desktop Pool V4
GET
Get Desktop Pool V5
GET
Get Desktop Pool V6
GET
Get Desktop Pool V7
GET
Get Farm
GET
Get Farm V2
GET
Get Farm V3
GET
Get Farm V4
GET
Get Farm V5
GET
Get Farm V6
GET
Get Global Application Entitlement
GET
Get Global Application Entitlement V2
GET
Get Global Application Entitlement V3
GET
Get Global Desktop Entitlement
GET
Get Global Desktop Entitlement V2
GET
Get Global Desktop Entitlement V3
GET
Get Machine
GET
Get Machine V2
GET
Get Machine V3
GET
Get Machine V4
GET
Get Machine V5
GET
Get Persistent Disk
GET
Get Physical Machine
GET
Get Physical Machine V2
GET
Get RDS Server
GET
Get Rds Server Agent Upgrade Task
GET
Get RDS Server V2
GET
Get Session Info
GET
List Agent Installer Packages
GET
List Agent Upgrade Tasks
GET
List Agent Upgrade Tasks V2
GET
List Application Icons
GET
List Application Pools
GET
List Application Pools V2
GET
List Application Pools V3
GET
List Application Pools V4
GET
List Application Pools V5
GET
List App Volumes Applications On Farm
GET
List Attachable Machines
GET
List Category Folders
GET
List Compatible Backup GA Es
GET
List Compatible Backup GD Es
GET
List Compatible Local Application Pools
GET
List Compatible Local Desktop Pools
GET
List Custom Application Icons
GET
List Desktop Pools
GET
List Desktop Pools V2
GET
List Desktop Pools V3
GET
List Desktop Pools V4
GET
List Desktop Pools V5
GET
List Desktop Pools V6
GET
List Desktop Pools V7
GET
List Desktop Pool Tasks
GET
List Farms
GET
List Farms V2
GET
List Farms V3
GET
List Farms V4
GET
List Farms V5
GET
List Farms V6
GET
List Global Application Entitlements
GET
List Global Application Entitlements V2
GET
List Global Application Entitlements V3
GET
List Global Desktop Entitlements
GET
List Global Desktop Entitlements V2
GET
List Global Desktop Entitlements V3
GET
List Installed Applications On Desktop Pool
GET
List Installed Applications On Farm
GET
List Local Application Pools
GET
List Local Desktop Pools
GET
List Machines
GET
List Machines V2
GET
List Machines V3
GET
List Machines V4
GET
List Machines V5
GET
List Persistent Disks
GET
List Physical Machines
GET
List Physical Machines V2
GET
List Policies On Desktop Pool
GET
List Rds Server Agent Upgrade Tasks
GET
List RDS Servers
GET
List RDS Servers V2
GET
List Session Info
GET
List Unentitled Machines
GET
List User Policies Overrides
POST
Log Off Global Sessions
POST
Log Off Sessions
POST
Pause Desktop Pool Task
GET
Query Global Sessions
POST
Rebuild Machines
POST
Recover Machines
POST
Recover RDS Servers
POST
Recreate From Persistent Disk
POST
Register Agent Installer Package
POST
Register Physical Machine
POST
Register RDS Server
POST
Remove Custom Icon
DELETE
Remove Local Application Pools From GAE
DELETE
Remove Local Desktop Pools From GDE
POST
Remove Machines
POST
Remove Rds Servers
POST
Reset Global Sessions
POST
Reset Machines
POST
Reset Sessions
POST
Restart Global Sessions
POST
Restart Machines
POST
Restart Sessions
POST
Resume Desktop Pool Task
POST
Schedule Agent For Upgrade
POST
Schedule Agent For Upgrade Rds Server
POST
Schedule Agent For Upgrade V2
POST
Schedule Maintenance
POST
Schedule Maintenance V2
POST
Schedule Push Image
POST
Schedule Push Image V2
POST
Send Message To Global Sessions
POST
Send Message To Sessions
POST
Unassign Machine Aliases
POST
Unassign Users
POST
Unregister Agent Installer Package
PUT
Update Application Pool
PUT
Update Application Pool V2
PUT
Update Application Pool V3
PUT
Update Application Pool V5
PUT
Update Desktop Pool
PUT
Update Desktop Poolv7
PUT
Update Farm
PUT
Update Farm V2
PUT
Update Farm V3
PUT
Update Farm V6
PUT
Update Global Application Entitlement
PUT
Update Global Application Entitlement V3
PUT
Update Global Desktop Entitlement
PUT
Update Global Desktop Entitlement V3
PUT
Update Persistent Disk
PUT
Update Policy Overrides For Users
PUT
Update RDS Server
PUT
Update RDS Server V2
PUT
Updates Policies On Desktop Pool
POST
Validate Installed Applications On Desktop Pool
POST
Validate Installed Applications On Farm
POST
Validate Specified Names