Get Desktop Monitor Info

All the listed privileges are required -

Privileges	Description
POOL_VIEW	Caller should have permission to this privilege, to perform this operation.

Request

URI

GET

https://{api_host}/rest/monitor/v1/desktops/{id}

COPY

Path Parameters

string

Required

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns DesktopMonitorInfo of type(s) */*

{
    "access_group_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
    "enable_app_remoting": false,
    "id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
    "name": "Desktop1",
    "source": "INSTANT_CLONE",
    "status": "OK",
    "type": "AUTOMATED"
}

string

access_group_id

Optional

ID of access group associated with the desktop.

boolean

enable_app_remoting

Optional

Is set as true if desktop can be used for application pool creation. Default value is false.

string

Optional

Unique ID of the Desktop.

string

name

Optional

Desktop name.

string

source

Optional

Source of the machines in the desktop pool. This property is required if type is set to "AUTOMATED".

INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.
UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.
VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.

Possible values are : INSTANT_CLONE, LINKED_CLONE, RDS, UNMANAGED, VIRTUAL_CENTER,

string

status

Optional

Status of Desktop.

OK: Desktop is enabled and no machines are in WARNING or ERROR state. One or more machine(s) may be DISABLED (including the case where all of them are DISABLED).
WARNING: Desktop is enabled. One or more machine(s) is either in WARNING or ERROR (not exceeding the predefined threshold) state.
ERROR: Desktop is enabled. One or more machine(s) (exceeding the predefined threshold) is in ERROR state, or, for Automated Desktops, there could be a provisioning error.
DISABLED: Desktop is disabled.

Possible values are : OK, WARNING, ERROR, DISABLED,

string

type

Optional

Type of the desktop.