Skip to content

Data Object - FarmSummaryData

Java Class

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

Property of

FarmSummaryView

See also

AccessGroupId, DesktopId

Since

Horizon View 6.0

Data Object Description

Farm summary Data

Data Object Properties

Name Type Description
type xsd:string Type of farm. Since Horizon View 6.2 2
* This property will be one of:
ValueDescription
AUTOMATEDAn automated farm creates RDS Servers cloned from a snapshot.
MANUALA manual farm allows selection and addition of existing RDS Servers to the farm.
source xsd:string Source of farm machines. Since Horizon 7.1 1 2 5
* This property will be one of:
ValueDescription
"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 :- 6 7. This option is only valid for Automated Farm.
imageSource xsd:string Source of image used in the farm. Applicable for automated farm. Since Horizon 7.10 1 2
* This property will be one of:
ValueDescription
"VIRTUAL_CENTER"Image was created in virtual center.
"IMAGE_CATALOG"Image was created in image catalog.
name xsd:string Farm name 2
displayName xsd:string Farm display name. 2
description xsd:string Farm description Since Horizon View 6.2 1 2
accessGroup AccessGroupId View access groups can organize the farms in your organization. They can also be used for delegated administration. 2
accessGroupName xsd:string View access group name 2
enabled xsd:boolean Indicates if Farm is enabled 2
provisioningEnabled xsd:boolean Indicates if provisioning is enabled for the Farm Since Horizon 7.2 2
deleting xsd:boolean Indicates if the farm is in the process of being deleted. Only applicable for automated farms. Since Horizon View 6.2 2
desktop DesktopId RDS Desktop EntityId 1 2
desktopName xsd:string RDS Desktop display name 1 2
rdsServerCount xsd:int Count of RDS servers that belong to the Farm 2
applicationCount xsd:int Count of Applications that belong to the Farm 2
maxSessionsType xsd:string Farm max sessions type 8 2
* This property will be one of:
ValueDescription
"UNLIMITED"Farm has unlimited number of sessions
"LIMITED"Farm has a limited number of sessions
maximumNumberOfSessions xsd:long Sum of maximum number of sessions of all RDS servers that belong to the Farm. 1 2 3 4
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 minimum value of 1. 

  4. This property is required if maxSessionsType is set to 'LIMITED'. 

  5. This property is required if type is set to 'AUTOMATED'. 

  6. Both instant and linked clones share the same base image and use less storage space than full virtual machines. 

  7. The user profile for both types clones can be redirected to persistent disks that will be unaffected by OS updates and refreshes. 

  8. This property has a default value of 'LIMITED'.