Data Object - FarmInfo

Class
VMware.Hv.FarmInfo
Returned by
Farm_Get, Farm_GetByNamingPattern
See also
FarmAutomatedFarmData, FarmData, FarmId
Since
Horizon View 6.0

Data Object Description

Farm info

Data Object Properties

Properties

Name Type Description
idFarmId

Farm entity ID
  • This property cannot be updated.
typexsd:string

Type of farm.

Since Horizon View 6.2
  • This property cannot be updated.
  • This property will be one of:
    Value Description
    "AUTOMATED"An automated farm creates RDS Servers cloned from a snapshot.
    "MANUAL"A manual farm allows selection and addition of existing RDS Servers to the farm.
sourcexsd:string

Source of farm machines.

Since Horizon 7.1
  • This property need not be set.
  • This property cannot be updated.
  • This property is required if type is set to "AUTOMATED".
  • This property will be one of:
    Value Description
    "VIEW_COMPOSER"View composer linked clones managed as view RDS Servers. They share the same base image and use less storage space than full RDS Servers.
    "INSTANT_CLONE_ENGINE"Instant clone engine created 'instant clones' managed as view RDS Servers. Instant clone engine uses vmfork technology to create the instant clones, these clones take much 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 Farm.
imageSourcexsd:string

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

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.
dataFarmData

Farm data
automatedFarmDataFarmAutomatedFarmData

Automated farm data.

Since Horizon View 6.2
  • This property need not be set.
  • This property is required if type is set to "AUTOMATED".
refIdxsd:string

Reference ID used for this farm.

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