Get Farm V2 | VMware Horizon Server API

Get Farm V2

All the listed privileges are required -

Privileges	Description
POOL_VIEW	Caller should have permission to this privilege, on the associated access group of the farm.

Request

URI

GET

https://{api_host}//localhost/rest/inventory/v2/farms/{id}

COPY

Path Parameters

string

Required

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns FarmInfoV2 of type(s) */*

{
    "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"
            },
            "instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
            "reuse_pre_existing_accounts": false
        },
        "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
}

string

access_group_id

Optional

Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Supported Filters: 'Equals'.