Data Object - DesktopInfo

Class
VMware.Hv.DesktopInfo
Returned by
Desktop_Get, Desktop_GetByNamingPattern
See also
DesktopAutomatedDesktopData, DesktopBase, DesktopGlobalEntitlementData, DesktopId, DesktopManualDesktopData, DesktopRDSDesktopData, DesktopSettings
Since
Horizon View 6.0

Data Object Description

A detailed description of a desktop instance.

Data Object Properties

Properties

Name Type Description
idDesktopId

Client reference to a specific desktop instance.
baseDesktopBase

Desktop identification information.
desktopSettingsDesktopSettings

Configuration settings for the desktop.
typexsd:string

Type of desktop.
  • This property cannot be updated.
  • 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.
sourcexsd:string

Source of machines.
  • This property cannot be updated.
  • This property will be one of:
    Value Description
    "VIRTUAL_CENTER"Virtual center virtual machines managed as view machines. This option is valid for Automated and Manual Desktop. In case of Automated Desktop, these refer to Full Virtual Machines that are created from a vCenter Server template.
    "VIEW_COMPOSER"View composer linked clones managed as view machines. They share the same base image and use less storage space than full virtual machines. The user profile for linked clones can be redirected to persistent disks that will be unaffected by OS updates and refreshes. This option is only valid for Automated Desktop.
    "INSTANT_CLONE_ENGINE"Instant clone engine created 'instant clones' managed as view machines. Instant clone engine uses vmfork technology to create the instant clones, these clones take very less time for provisioning. Instant clones have many similarities to linked clones like :-
    • Both instant and linked clones share the same base image and use less storage space than full virtual machines.
    • The user profile for both types clones can be redirected to persistent disks that will be unaffected by OS updates and refreshes.
    This option is only valid for Automated Desktop.
    "UNMANAGED"Non-vCenter Server virtual machines managed as view machines. These can include physical computers, non-vCenter Server virtual machines, and blade PCs. This option is only valid for Manual Desktops.
    "RDS"This option is only valid for RDS Desktops.
imageSourcexsd:string

Source of image used in the desktop. Applicable for automated desktop.

Since Horizon 7.10
  • This property need not be set.
  • This property cannot be updated.
  • This property will be one of:
    Value Description
    "VIRTUAL_CENTER"Image was created in virtual center.
    "IMAGE_CATALOG"Image was created in image catalog.
automatedDesktopDataDesktopAutomatedDesktopData

Automated desktop data.
  • This property need not be set.
  • This property is required if type is set to "AUTOMATED".
manualDesktopDataDesktopManualDesktopData

Manual desktop data.
  • This property need not be set.
  • This property is required if type is set to "MANUAL".
rdsDesktopDataDesktopRDSDesktopData

RDS Desktop data.
  • This property need not be set.
  • This property is required if type is set to "RDS".
globalEntitlementDataDesktopGlobalEntitlementData

Global entitlement data.
refIdxsd:string

Reference ID used for this desktop pool.

Since Horizon 8.1
  • This property need not be set.
  • This property cannot be updated.