List Farms V3

List Farms 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 farms, for which the caller has permission to this privilege, on the associated access group of the farm.

Request

URI

GET

https://{api_host}/rest/inventory/v3/farms

COPY

Query Parameters

integer

page

Optional

page, if passed should be > 0.

page example

integer

size

Optional

size, if passed should be > 0.

size example

string

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

ASC

Possible values are : ASC, DESC,

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

OK

[
    {
        "access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
        "automated_farm_settings": {
            "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",
                "instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
                "reuse_pre_existing_accounts": false,
                "sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
            },
            "enable_provisioning": true,
            "image_source": "VIRTUAL_CENTER",
            "max_session_type": "LIMITED",
            "max_sessions": 50,
            "min_ready_vms": 0,
            "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"
                        }
                    ]
                }
            ],
            "operating_system": "WINDOWS_SERVER_2016",
            "operating_system_architecture": "BIT_64",
            "pattern_naming_settings": {
                "max_number_of_rds_servers": 5,
                "naming_pattern": "vm-{n}-sales"
            },
            "provisioning_settings": {
                "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": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
                "parent_vm_id": "vm-2",
                "resource_pool_id": "resgroup-1",
                "vm_folder_id": "group-v1"
            },
            "provisioning_status_data": {
                "instant_clone_current_image_state": "READY",
                "instant_clone_operation": "INITIAL_PUBLISH",
                "instant_clone_operation_time": 1587081283000,
                "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_scheduled_maintenance_data": {
                    "immediate_maintenance_scheduled": true,
                    "logoff_policy": "WAIT_FOR_LOGOFF",
                    "next_scheduled_time": 1237081283000,
                    "recurring_maintenance_settings": {
                        "maintenance_period": "WEEKLY",
                        "maintenance_period_frequency": 10,
                        "start_index": 1,
                        "start_time": "10:00"
                    },
                    "stop_on_first_error": true
                },
                "last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
                "last_provisioning_error_time": 1587081283000
            },
            "stop_provisioning_on_error": true,
            "storage_settings": {
                "datastores": [
                    {
                        "datastore_id": "datastore-1",
                        "storage_overcommit": "CONSERVATIVE"
                    }
                ],
                "replica_disk_datastore_id": "datastore-1",
                "use_separate_datastores_replica_and_os_disks": false,
                "use_view_storage_accelerator": false,
                "use_vsan": false
            },
            "transparent_page_sharing_scope": "VM",
            "vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
        },
        "delete_in_progress": false,
        "description": "Farm Description",
        "desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
        "display_name": "ManualFarm",
        "display_protocol_settings": {
            "allow_users_to_choose_protocol": true,
            "default_display_protocol": "PCOIP",
            "grid_vgpus_enabled": false,
            "session_collaboration_enabled": false,
            "vgpu_grid_profile": "instant-profile"
        },
        "enabled": true,
        "id": "50d77b95-fcc0-448a-a478-ec4f3b657ca4",
        "load_balancer_settings": {
            "cpu_threshold": 10,
            "disk_queue_length_threshold": 15,
            "disk_read_latency_threshold": 10,
            "disk_write_latency_threshold": 15,
            "include_session_count": true,
            "memory_threshold": 10
        },
        "name": "ManualFarm",
        "server_error_threshold": 0,
        "session_settings": {
            "disconnected_session_timeout_minutes": 5,
            "disconnected_session_timeout_policy": "NEVER",
            "empty_session_timeout_minutes": 5,
            "empty_session_timeout_policy": "AFTER",
            "logoff_after_timeout": false,
            "pre_launch_session_timeout_minutes": 10,
            "pre_launch_session_timeout_policy": "AFTER"
        },
        "type": "MANUAL",
        "use_custom_script_for_load_balancing": false
    }
]

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

Request

Query Parameters

200 Response Body

Errors

Inventory Operations

Add Custom Icon

Add Local Application Pools To GAE

Add Local Desktop Pools To GDE

Add Machines By Name

Add Rds Servers

Application Icon Bulk Associate

Application Icon Bulk Remove Association

Archive Machines

Assign Machine Aliases

Attach Persistent Disk

Cancel Agent Upgrades

Cancel Desktop Pool Task

Cancel Rds Server Agent Upgrades

Cancel Scheduled Maintenance

Cancel Scheduled Push Image

Check Application Pool Name Availability

Check Desktop Pool Name Availability

Check Farm Name Availability

Check Machine Prefix Availability

Check RDS Server Prefix Availability

Create Application Icon

Create Application Pool

Create Application Pool V2

Create Application Pool V3

Create Application Pool V5

Create Desktop Pool

Create Desktop Pool V2

Create Desktop Pool V7

Create Global Application Entitlement

Create Global Application Entitlement V3

Create Global Desktop Entitlement

Create Global Desktop Entitlement V2

Create Global Desktop Entitlement V3

Create Persistent Disk

Create Policy Overrides For Users

Delete Application Icon

Delete Application Pool

Delete Application Pools

Delete Application Pools V5

Delete Desktop Pool

Delete Desktop Pool V7

Delete Global Application Entitlement

Delete Global Application Entitlement V3

Delete Global Desktop Entitlement

Delete Global Desktop Entitlement V3

Delete Machines

Delete Persistent Disk

Delete Physical Machine

Delete Policy Overrides For Users

Delete RDS Server

Delete RDS Server V2

Desktop Pool Apply Image

Desktop Pool Promote Pending Image

Detach Persistent Disk

Disable Application Pools

Disable Desktop Pools

Disable Provisioning For Desktop Pools

Disconnect Global Sessions

Disconnect Sessions

Enable Application Pools

Enable Desktop Pools

Enable Provisioning For Desktop Pools

Enter Maintenance

Exit Maintenance

Farm Apply Image

Farm Promote Pending Image

Get Agent Installer Package

Get Agent Upgrade Task

Get Agent Upgrade Task V2

Get Application Icon

Get Application Pool

Get Application Pool V2

Get Application Pool V3

Get Application Pool V4

Get Application Pool V5

Get Desktop Pool

Get Desktop Pool Task

Get Desktop Pool V2

Get Desktop Pool V3

Get Desktop Pool V4

Get Desktop Pool V5

Get Desktop Pool V6

Get Desktop Pool V7

Get Global Application Entitlement

Get Global Application Entitlement V2

Get Global Application Entitlement V3

Get Global Desktop Entitlement

Get Global Desktop Entitlement V2

Get Global Desktop Entitlement V3

Get Persistent Disk

Get Physical Machine

Get Physical Machine V2

Get Rds Server Agent Upgrade Task

Get RDS Server V2

Get Session Info

List Agent Installer Packages

List Agent Upgrade Tasks

List Agent Upgrade Tasks V2

List Application Icons

List Application Pools

List Application Pools V2

List Application Pools V3

List Application Pools V4

List Application Pools V5

List App Volumes Applications On Farm

List Attachable Machines

List Category Folders

List Compatible Backup GA Es

List Compatible Backup GD Es

List Compatible Local Application Pools

List Compatible Local Desktop Pools

List Custom Application Icons

List Desktop Pools

List Desktop Pools V2

List Desktop Pools V3

List Desktop Pools V4

List Desktop Pools V5

List Desktop Pools V6

List Desktop Pools V7

List Desktop Pool Tasks

List Global Application Entitlements

List Global Application Entitlements V2

List Global Application Entitlements V3

List Global Desktop Entitlements

List Global Desktop Entitlements V2

List Global Desktop Entitlements V3

List Installed Applications On Desktop Pool

List Installed Applications On Farm

List Local Application Pools

List Local Desktop Pools

List Machines V2

List Machines V3

List Machines V4

List Machines V5

List Persistent Disks

List Physical Machines

List Physical Machines V2

List Policies On Desktop Pool

List Rds Server Agent Upgrade Tasks

List RDS Servers

List RDS Servers V2

List Session Info

List Unentitled Machines

List User Policies Overrides

Log Off Global Sessions

Log Off Sessions

Pause Desktop Pool Task

Query Global Sessions

Rebuild Machines

Recover Machines

Recover RDS Servers

Recreate From Persistent Disk

Register Agent Installer Package

Register Physical Machine

Register RDS Server

Remove Custom Icon

Remove Local Application Pools From GAE

Remove Local Desktop Pools From GDE

Remove Machines

Remove Rds Servers

Reset Global Sessions

Restart Global Sessions

Restart Machines

Restart Sessions

Resume Desktop Pool Task

Schedule Agent For Upgrade

Schedule Agent For Upgrade Rds Server

Schedule Agent For Upgrade V2

Schedule Maintenance

Schedule Maintenance V2

Schedule Push Image

Schedule Push Image V2

Send Message To Global Sessions

Send Message To Sessions

Unassign Machine Aliases

Unregister Agent Installer Package

Update Application Pool

Update Application Pool V2

Update Application Pool V3

Update Application Pool V5

Update Desktop Pool

Update Desktop Poolv7

Update Global Application Entitlement

Update Global Application Entitlement V3

Update Global Desktop Entitlement

Update Global Desktop Entitlement V3

Update Persistent Disk

Update Policy Overrides For Users

Update RDS Server

Update RDS Server V2

Updates Policies On Desktop Pool

Validate Installed Applications On Desktop Pool

Validate Installed Applications On Farm

Validate Specified Names