View API


Data Object - DesktopDetailData

Class
VMware.Hv.DesktopDetailData
Property of
DesktopDetailView
Since
Horizon 7.4

Data Object Description

Core attributes of a desktop detail instance.

Data Object Properties

Properties

Name Type Description
namexsd:string

Unique name for the desktop.
displayNamexsd:string

Desktop display name.
typexsd:string

Type of desktop.
  • This property will be one of:
    Value Description
    "AUTOMATED"An automated desktop creates virtual machines cloned from a base template or snapshot.
    "MANUAL"A manual machine desktop allows selection of existing virtual machines and addition to the desktop of available machines to connect to.
    "RDS"An RDS Desktop Desktop.
enabledxsd:boolean

Determines if the desktop is enabled.
renderer3Dxsd:string

3D rendering is supported on Windows 7 or later guests running on VMs with virtual hardware version 8 or later. The default protocol must be PCoIP and users must not be allowed to choose their own protocol to enable 3D rendering.
  • This property has a default value of "DISABLED".
  • This property will be one of:
    Value Description
    "MANAGE_BY_VSPHERE_CLIENT"3D rendering managed by vSphere Client.
    "AUTOMATIC"3D rendering is automatic.
    "SOFTWARE"3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.
    "HARDWARE"3D rendering is hardware dependent. The hardware-based renderer is supported (at minimum) on virtual hardware version 9 in a vSphere 5.1 environment.
    "DISABLED"3D rendering is disabled.
operatingSystemxsd:string

The guest operating system. Applicable only for automated desktops.
  • This property need not be set.
  • This property will be one of:
    Value Description
    "Unknown"
    "Windows XP"Windows XP
    "Windows Vista"Windows Vista
    "Windows 7"Windows 7
    "Windows 8"Windows 8
    "Windows 10"Windows 10
    "Windows Server 2003"Windows Server 2003
    "Windows Server 2008"Windows Server 2008
    "Windows Server 2008R2"Windows Server 2008R2
    "Windows Server 2012"Windows Server 2012
    "Windows Server 2012R2"Windows Server 2012R2
    "Windows Server 10"null
    "Windows Server 2016"Windows Server 2016
    "Linux (other)"Linux (other)
    "Linux (Ubuntu)"Linux (Ubuntu)
    "Linux (Red Hat Enterprise Linux)"Linux (Red Hat Enterprise)
    "Linux (SUSE Linux Enterprise Server)"Linux (Suse)
    "Linux (CentOS)"Linux (CentOS)
operatingSystemArchitecturexsd:string

The guest operating system architecture. Applicable only for automated desktops.
  • This property need not be set.
  • This property will be one of:
    Value Description
    "Unknown"Operating System cannot be determined.
    "32_bit"32 bit Operating System Architecture.
    "64_bit"64 bit Operating System Architecture.
avmEndpointsxsd:string[]

App Volumes manager endpoints. Applicable only for automated desktops.
  • This property need not be set.
  • This property is an unordered array of unique values.
supportedDomainsxsd:string[]

Supported domains for the desktop. Applicable only for automated desktops.
  • This property need not be set.
  • This property is an unordered array of unique values.
uemAgentVersionxsd:string

UEM agent version. Applicable only for automated desktops.
  • This property need not be set.
vcenterUrlxsd:string

URL of associated Vcenter for this desktop.
  • This property need not be set.
creationTimexsd:dateTime

Desktop creation time.
  • This property need not be set.
lastModifiedTimexsd:dateTime

Desktop last modified time.
  • This property need not be set.
numOfEntitledUsersxsd:int

Number of entitled users for the desktop.
  • This property need not be set.
numMachinesxsd:int

Number of machines in the desktop. The machines may be queried using the query service for Machine. This field does not apply to RDS desktops. The RDS servers associated with an RDS desktop may be queried using the query service for RDSServer.