Skip to content

Data Object - DesktopSettings

Java Class

com.omnissa.vdi.vlsi.binding.vdi.resources.Desktop.DesktopSettings

Property of

DesktopInfo, DesktopSpec

See also

DesktopAdobeFlashSettings, DesktopDisplayProtocolSettings, DesktopLogoffSettings, DesktopMirageConfigurationOverrides

Since

Horizon View 6.0

Data Object Description

Settings related to desktop configuration.

Data Object Properties

Name Type Description
enabled xsd:boolean True if the desktop is enabled. 4
deleting xsd:boolean True if the desktop is in the process of being deleted. This cannot be set or updated. 3 2
connectionServerRestrictions xsd:string[] Connection server restrictions. This is a list of tags that access to the desktop is restricted to. No list means that the desktop can be accessed from any connection server. 1
logoffSettings DesktopLogoffSettings Remote machine settings applicable when a user logs off or when a desktop is no longer keeping a machine as a spare. For RDS Desktops, this will be unset when retrieved, must be unset when created, and cannot be updated. The RDS Desktop's Farm's FarmSessionSettings will be used instead. Otherwise, this must be set. 1
displayProtocolSettings DesktopDisplayProtocolSettings Remote display protocol settings. These relate to RDP/PCoIP/BLAST. For RDS Desktops, this will be unset when retrieved, must be unset when created, and cannot be updated. The RDS Desktop's Farm's FarmDisplayProtocolSettings will be used instead. Otherwise, this must be set. 1
flashSettings DesktopAdobeFlashSettings Deprecated._This property is no longer in use for Horizon Components and will be ignored duringDesktop_Create and Desktop_Update operations _ Adobe flash settings for remote sessions. 1
mirageConfigurationOverrides DesktopMirageConfigurationOverrides Override of the mirage configuration for this Desktop. For RDS Desktops, this will be unset when retrieved, must be unset when created, and cannot be updated. The RDS Desktop's Farm's FarmMirageConfigurationOverrides will be used instead. Otherwise, this must be set. 1
categoryFolderName xsd:string Name of the category folder in the user's OS containing a shortcut to the desktop. Unset if the desktop does not belong to a category. Since Horizon 7.3 1
* This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels. The subdirectories can be specified using a backslash, e.g. (dir1\dir2\dir3\dir4). Folder names can't start or end with a backslash nor can there be 2 or more backslashes together. Combinations such as (\dir1, dir1\dir2\, dir1\\dir2, dir1\\\dir2) are invalid. The windows reserved keywords (CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.
clientRestrictions xsd:boolean Client restrictions to be applied to Desktop. Since Horizon 7.3 3 1
shortcutLocations xsd:string[] Locations of the category folder in the user's OS containing a shortcut to the desktop. The value must be set if categoryFolderName is provided. Since Horizon 7.5 1
allowMultipleSessionsPerUser xsd:boolean Whether multiple sessions are allowed per user for this pool. This is valid for RDS Desktops. For other Desktops use allowMultipleSessionsPerUser Since Horizon 7.7 3 1
supportedSessionType xsd:string Supported session types for this desktop. If application sessions are selected to be supported then this desktop can be used for application pool creation. This will be useful when the machines in the pool support application remoting. Since Horizon 7.9 5 1
* This property will be one of:
ValueDescription
DESKTOPOnly desktop sessions are supported for this desktop.
APPLICATIONOnly application sessions are supported for this desktop.
DESKTOP_AND_APPLICATIONBoth desktop and application sessions are supported for this desktop.
cloudManaged xsd:boolean Indicates whether this desktop is managed by Horizon Cloud Services. This can be set to false only when cloudAssigned is false. This cannot be set to true, if any of the conditions are satisfied: 6 7 8 9 10 11 12 13
Since Horizon 7.11 3 1
cloudAssigned xsd:boolean Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services. This can be set to true from cloud session only and only when cloudManaged is true. This can be changed to false only if there are no entitlements. Since Horizon 7.11 3 1
displayAssignedMachineName xsd:boolean Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using View Client. This is applicable for dedicated pools only. If no machine is assigned to the user then "displayName (No machine assigned)" will be displayed in the client. Since Horizon 7.12 3 1

  1. This property need not be set. ↩↩↩↩↩↩↩↩↩↩↩↩↩

  2. This property cannot be updated. ↩

  3. This property has a default value of false. ↩↩↩↩↩↩

  4. This property has a default value of true. ↩

  5. This property has a default value of 'DESKTOP'. ↩

  6. user is provided. ↩

  7. enabled is false. ↩

  8. supportedSessionType is not "DESKTOP". ↩

  9. globalEntitlement is set. ↩

  10. userAssignment is "DEDICATED" and automaticAssignment is false. ↩

  11. Local entitlements are configured. ↩

  12. Any of the machines in the pool have users assigned. ↩

  13. connectionServerRestrictions is not set. ↩