View API


Data Object - FarmSummaryData

Class
VMware.Hv.FarmSummaryData
Property of
FarmSummaryView
See also
AccessGroupId, DesktopId
Since
Horizon View 6.0

Data Object Description

Farm summary Data

Data Object Properties

Properties

Name Type Description
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.
namexsd:string

Farm name
  • This property cannot be updated.
displayNamexsd:string

Farm display name.
  • This property cannot be updated.
descriptionxsd:string

Farm description

Since Horizon View 6.2
  • This property need not be set.
  • This property cannot be updated.
accessGroupAccessGroupId

View access groups can organize the farms in your organization. They can also be used for delegated administration.
  • This property cannot be updated.
accessGroupNamexsd:string

View access group name
  • This property cannot be updated.
enabledxsd:boolean

Indicates if Farm is enabled
  • This property cannot be updated.
provisioningEnabledxsd:boolean

Indicates if provisioning is enabled for the Farm

Since Horizon 7.2
  • This property cannot be updated.
deletingxsd:boolean

Indicates if the farm is in the process of being deleted. Only applicable for automated farms.

Since Horizon View 6.2
  • This property cannot be updated.
desktopDesktopId

RDS Desktop EntityId
  • This property need not be set.
  • This property cannot be updated.
desktopNamexsd:string

RDS Desktop display name
  • This property need not be set.
  • This property cannot be updated.
rdsServerCountxsd:int

Count of RDS servers that belong to the Farm
  • This property cannot be updated.
applicationCountxsd:int

Count of Applications that belong to the Farm
  • This property cannot be updated.
maxSessionsTypexsd:string

Farm max sessions type
  • This property has a default value of "LIMITED".
  • This property cannot be updated.
  • This property will be one of:
    Value Description
    "UNLIMITED"Farm has unlimited number of sessions
    "LIMITED"Farm has a limited number of sessions
maximumNumberOfSessionsxsd:long

Sum of maximum number of sessions of all RDS servers that belong to the Farm.
  • This property need not be set.
  • This property cannot be updated.
  • This property has a minimum value of 1.
  • This property is required if maxSessionsType is set to "LIMITED".
appVolumesManagerGuidxsd:string

Guid of app volumes manager associated with the farm.

Since Horizon 8.8
  • This property cannot be updated.