View API


Data Object - FarmData

Class
VMware.Hv.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

Properties

Name Type Description
namexsd:string

Farm name
  • This property cannot be updated.
  • This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.
displayNamexsd:string

Farm display name. If the display name is left blank, it defaults to name
  • This property need not be set.
  • This property has a maximum length of 256 characters.
accessGroupAccessGroupId

View access groups can organize the farms in your organization. They can also be used for delegated administration.
descriptionxsd:string

Farm description
  • This property need not be set.
  • This property has a maximum length of 1024 characters.
enabledxsd:boolean

Indicates if Farm is enabled
  • This property has a default value of true.
  • This property need not be set.
deletingxsd: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
  • This property has a default value of false.
  • This property cannot be updated.
settingsFarmSessionSettings

Farm settings
  • This property need not be set.
lbSettingsRDSHLoadBalancingSettings

Settings for load balancing the session requests across the RDS hosts in the farm

Since Horizon 7.8
  • This property need not be set.
desktopDesktopId

Entity ID of RDS Desktop in the Farm
  • This property need not be set.
  • This property cannot be updated.
displayProtocolSettingsFarmDisplayProtocolSettings

Farm Display Protocol settings
  • This property need not be set.
serverErrorThresholdxsd:int

The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state
  • This property has a default value of 0.
  • This property need not be set.
  • This property has a minimum value of 0.
mirageConfigurationOverridesFarmMirageConfigurationOverrides

The Mirage configuration overrides for this Farm.
  • This property need not be set.