List Desktop Pools V3
This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.com All the listed privileges are required -
| Privileges | Description |
|---|---|
| POOL_VIEW | Returns results only for those desktop pools, for which the caller has permission to this privilege, on the associated access group of the desktop pool. |
| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset. |
Request
URI
GET
https://{api_host}/rest/inventory/v3/desktop-pools
COPY
Query Parameters
integer
page
Optional
page, if passed should be > 0.
page example
1integer
size
Optional
size, if passed should be > 0.
size example
10string
filter
Optional
filter expression built using fields with 'supported filters' as described in output model schema of this API.
filter example
[object Object]string
sort_by
Optional
Field that would be used to sort the results.
sort_by example
<property-name>string
order_by
Optional
Determines the ordering of results.
order_by example
ASCPossible values are : ASC, DESC,
Responses
200
OK
[
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"allow_multiple_user_assignments": true,
"allow_rds_pool_multi_session_per_user": false,
"automatic_user_assignment": false,
"category_folder_name": "dir1",
"cloud_assigned": false,
"cloud_managed": false,
"cs_restriction_tags": [
"CS1_TAG1"
],
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": false,
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"quickprep_customization_settings": {
"post_synchronization_script_parameters": "p1 p2 p3",
"post_synchronization_script_path": "quickprep_postsync_script",
"power_off_script_parameters": "p1 p2 p3",
"power_off_script_path": "quickprep_poweroff_script"
},
"reuse_pre_existing_accounts": false,
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"view_composer_domain_account_id": "0ebb464a-8780-4860-924f-8b2d1d1b33ef"
},
"delete_in_progress": false,
"description": "Desktop pool description",
"display_assigned_machine_name": false,
"display_machine_alias": true,
"display_name": "pool",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"display_protocols": [
"PCOIP",
"BLAST",
"RDP"
],
"grid_vgpus_enabled": false,
"html_access_enabled": true,
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "true",
"session_collaboration_enabled": false,
"vgpu_grid_profile": "instant-profile",
"vram_size_mb": 64
},
"enable_client_restrictions": false,
"enable_provisioning": true,
"enabled": true,
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"global_desktop_entitlement_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"image_source": "VIRTUAL_CENTER",
"name": "sales-pool1",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_machines": 100,
"min_number_of_machines": 10,
"naming_pattern": "vm-{n}-sales",
"number_of_spare_machines": 10,
"provisioning_time": "ON_DEMAND"
},
"provisioning_settings": {
"add_virtual_tpm": false,
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"min_ready_vms_on_vcomposer_maintenance": 10,
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1",
"vm_template_id": "vm-1"
},
"provisioning_status_data": {
"instant_clone_current_image_state": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_operation": "NONE",
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_push_image_settings": {
"add_virtual_tpm": false,
"logoff_policy": "WAIT_FOR_LOGOFF",
"start_time": 1587081283000,
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000
},
"session_settings": {
"allow_multiple_sessions_per_user": false,
"allow_users_to_reset_machines": false,
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": false,
"power_policy": "ALWAYS_POWERED_ON",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30
},
"session_type": "DESKTOP",
"shortcut_locations": [
"Desktop"
],
"source": "INSTANT_CLONE",
"specific_naming_settings": {
"num_machines": 10,
"num_unassigned_machines_kept_powered_on": 1,
"start_machines_in_maintenance_mode": false
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": false,
"storage_overcommit": "CONSERVATIVE"
}
],
"non_persistent_disk_drive_letter": "Auto",
"non_persistent_disk_size_mb": 4096,
"non_persistent_redirect_disposable_files": true,
"persistent_disk_datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": false,
"storage_overcommit": "CONSERVATIVE"
}
],
"persistent_disk_drive_letter": "D",
"persistent_disk_size_mb": 2048,
"reclaim_vm_disk_space": false,
"reclamation_threshold_mb": 1024,
"redirect_windows_profile": false,
"replica_disk_datastore_id": "datastore-1",
"use_native_snapshots": false,
"use_separate_datastores_persistent_and_os_disks": false,
"use_separate_datastores_replica_and_os_disks": false,
"use_vsan": false
},
"transparent_page_sharing_scope": "VM",
"type": "AUTOMATED",
"user_assignment": "DEDICATED",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360",
"view_storage_accelerator_settings": {
"blackout_times": [
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
],
"regenerate_view_storage_accelerator_days": 7,
"use_view_storage_accelerator": false,
"view_storage_accelerator_disk_types": "OS_DISKS"
}
}
]
400
Bad Request
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
409
Conflict | CPA not initialized for the pod
Operation doesn't return any data structure
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