View API


Data Object - FarmHealthRDSServerHealthInfo

Class
VMware.Hv.RDSServerHealthInfo
Property of
FarmHealthInfo
See also
FarmHealthMissingApplicationInfo, RDSServerId
Since
Horizon View 6.0

Data Object Description

RDS server health data

Data Object Properties

Properties

Name Type Description
idRDSServerId

RDS server entity ID
  • This property cannot be updated.
namexsd:string

RDS Server name
  • This property need not be set.
  • This property cannot be updated.
statusxsd:string

RDS server status
  • This property cannot be updated.
  • This property will be one of:
    Value Description
    "WAIT_FOR_AGENT"View Connection Server is waiting to establish communication with View Agent for one of these cases - a virtual machine in a manual desktop, unmanaged machine or terminal server.
    "AGENT_UNREACHABLE"View Connection Server cannot establish communication with View Agent on a virtual machine
    "AGENT_CONFIG_ERROR"The Remote Desktop Services role is not enabled.
    "AVAILABLE"The virtual machine is powered on and ready for an active connection.
    "DISABLED"The machine is disabled
    "DISABLE_IN_PROGRESS"Disabled server still has some view brokered sessions. It can still accept re-connections
    "UNKNOWN"Could not determine the state of the virtual machine.
healthxsd:string

RDS server health
  • This property cannot be updated.
  • This property will be one of:
    Value Description
    "OK"RDSServer is reachable. All applications (defined on its farm) are verified installed on the server.
    "WARNING"RDSServer is reachable. Some applications are detected as not installed on the server.
    "ERROR"Server is unreachable, or, none of the applications are installed.
    "DISABLED"Server is disabled.
availablexsd:boolean

Indicates if RDS server is available
  • This property cannot be updated.
missingApplicationsFarmHealthMissingApplicationInfo[]

Missing Application info for those Applications that are missing on this RDSServer. An Application must be enabled in order for its health status to be collected.
  • This property need not be set.
  • This property cannot be updated.
loadPreferencexsd:string

Based on the current load of this RDSServer, gives a measure of how preferential this server is to be chosen for new application sessions.

Since Horizon View 6.2
  • This property cannot be updated.
  • This property will be one of:
    Value Description
    "BLOCK"This RDSServer will not be chosen for new sessions.
    "HEAVY"This RDSServer is experiencing heavy load and should likely not be chosen for new sessions.
    "NORMAL"This RDSServer is experiencing normal load and is okay to be chosen for new sessions.
    "LIGHT"This RDSServer is experiencing light load and is okay to be chosen for new sessions.
    "UNKNOWN"This RDSServer did not report a load preference. This is potentially a configuration issue if other RDSServers in the same Farm do report load preferences.