Skip to content

Data Object - FarmData

Java Class

com.omnissa.vdi.vlsi.binding.vdi.resources.Farm.FarmData

Property of

FarmInfo, FarmSpec

See also

AccessGroupId, DesktopId, FarmDisplayProtocolSettings, FarmMirageConfigurationOverrides, FarmSessionSettings, RDSHLoadBalancingSettings

Since

Horizon View 6.0

Data Object Description

Farm data

Data Object Properties

Name Type Description
name xsd:string Farm name 2 5
displayName xsd:string Farm display name. If the display name is left blank, it defaults to name 1 6
accessGroup AccessGroupId View access groups can organize the farms in your organization. They can also be used for delegated administration.
description xsd:string Farm description 1 7
enabled xsd:boolean Indicates if Farm is enabled 4 1
deleting xsd:boolean True if the farm is in the process of being deleted. This cannot be set or updated. Only applicable for automated farms. Since Horizon View 6.2 3 2
settings FarmSessionSettings Farm settings 1
lbSettings RDSHLoadBalancingSettings Settings for load balancing the session requests across the RDS hosts in the farm Since Horizon 7.8 1
desktop DesktopId Entity ID of RDS Desktop in the Farm 1 2
displayProtocolSettings FarmDisplayProtocolSettings Farm Display Protocol settings 1
serverErrorThreshold xsd:int The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state 8 1 9
mirageConfigurationOverrides FarmMirageConfigurationOverrides The Mirage configuration overrides for this Farm. 1
appVolumesManagerGuid xsd:string Guid of app volumes manager associated with the farm. Since Horizon 8.8 2

  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 must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters. 

  6. This property has a maximum length of 256 characters. 

  7. This property has a maximum length of 1024 characters. 

  8. This property has a default value of 0. 

  9. This property has a minimum value of 0.