List Desktop Pools V2

List Desktop Pools V2

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

Required Privileges : (This server version allows only Administrators on Root access group to login. These privileges are NOT relevant currently but will be applicable in later server versions.)

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.

Request

URI

GET

https://{api_host}//localhost/rest/inventory/v2/desktop-pools

COPY

Query Parameters

string

filter

Optional

filter expression built using fields with 'supported filters' as described in output model schema of this API.

filter example

{"type":"And", "filters":[{"type":"Equals", "name":"<>", "value":"<>"}] }

integer

page

Optional

page, if passed should be > 0.

page example

integer

size

Optional

size, if passed should be > 0

size example

Authentication

This operation uses the following authentication methods.

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": [
            "string"
        ],
        "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_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",
        "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": 0,
            "refresh_threshold_percentage_for_replica_os_disk": 0
        },
        "session_type": "DESKTOP",
        "shortcut_locations": [
            "string"
        ],
        "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": [
                        "string"
                    ],
                    "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

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

Inventory Operations

Add Local Application Pools To GAE

Add Local Desktop Pools To GDE

Add Machines By Name

Assign Machine Aliases

Cancel Desktop Pool Task

Cancel Scheduled Push Image

Create Application Pool

Create Global Desktop Entitlement

Delete Application Pool

Delete Machines

Delete Physical Machine

Delete RDS Server

Disconnect Sessions

Enter Maintenance

Exit Maintenance

Get Application Icon

Get Application Pool

Get Application Pool V2

Get Desktop Pool

Get Desktop Pool Task

Get Desktop Pool V2

Get Desktop Pool V3

Get Global Application Entitlement

Get Global Desktop Entitlement

Get Physical Machine

Get Session Info

List Application Icons

List Application Pools

List Application Pools V2

List Compatible Local Application Pools

List Compatible Local Desktop Pools

List Desktop Pools

List Desktop Pools V2

List Desktop Pools V3

List Desktop Pool Tasks

List Global Application Entitlements

List Global Desktop Entitlements

List Installed Applications On Desktop Pool

List Installed Applications On Farm

List Local Application Pools

List Local Desktop Pools

List Machines V2

List Physical Machines

List RDS Servers

List Session Info

Log Off Sessions

Rebuild Machines

Recover Machines

Recover RDS Servers

Register Physical Machine

Register RDS Server

Remove Local Application Pools From GAE

Remove Local Desktop Pools From GDE

Remove Machines

Restart Machines

Restart Sessions

Schedule Push Image

Send Message To Sessions

Unassign Machine Aliases

Update Application Pool

Update RDS Server