Skip to content

Data Object - RDSServerRuntimeData

Java Class

com.omnissa.vdi.vlsi.binding.vdi.resources.RDSServer.RDSServerRuntimeData

Property of

RDSServerInfo, RDSServerSummaryView

Since

Horizon View 6.0

Data Object Description

RDSServer runtime information

Data Object Properties

Name Type Description
status xsd:string RDS server status 1 2
* This property will be one of:
ValueDescription
PROVISIONINGThe virtual machine is being provisioned
PROVISIONING_ERRORAn error occurred during provisioning.
WAIT_FOR_AGENTView 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.
CUSTOMIZINGThe virtual machine in automated/provisioned desktop is being customized
DELETINGThe virtual machine is marked for deletion. View Manager will delete the virtual machine soon.
MAINTENANCEThe virtual machine is in maintenance mode. Users cannot log in or use the virtual machine
ERRORAn unknown error occurred in the virtual machine.
PROVISIONEDThe virtual machine is powered off or suspended.
AGENT_UNREACHABLEView Connection Server cannot establish communication with View Agent on a virtual machine
CONNECTEDThe virtual machine is in an active session and has an active remote connection to a View client
DISCONNECTEDThe virtual machine is in an active session, but it is disconnected from the View client
AGENT_ERR_STARTUP_IN_PROGRESSView Agent has started on the virtual machine, but other required services such as the display protocol are still starting
AGENT_ERR_WAIT_FOR_HYBRID_JOINView Agent is waiting for hybrid domain join
AGENT_ERR_DISABLEDView Agent is disabled
AGENT_ERR_INVALID_IPView Agent has invalid IP
AGENT_ERR_NEED_REBOOTView Agent needs reboot.
AGENT_ERR_PROTOCOL_FAILUREProtocol such as RDP or PCoIP is not enabled.
AGENT_ERR_DOMAIN_FAILUREView Agent has invalid domain.
AGENT_CONFIG_ERRORThe Remote Desktop Services role is not enabled.
AGENT_DRAIN_MODERDS host is configured for drain mode
AGENT_DRAIN_UNTIL_RESTARTRDS host is configured for drain until restart mode
ALREADY_USEDThe virtual machine is configured to have only one session which is currently in progress and cannot accept new sessions
AVAILABLEThe virtual machine is powered on and ready for an active connection.
IN_PROGRESSThere is a virtual machine operation in-progress.
DISABLEDThe machine is disabled
DISABLE_IN_PROGRESSDisabled server still has some view brokered sessions. It can still accept re-connections
VALIDATINGThe connection server is synchronizing state information with the agent.
BLOCKED_AGENT_VERSIONThe agent version is blocked from establishing sessions.
UNKNOWNCould not determine the state of the virtual machine.
sessionCount xsd:long RDS server session count 1 2
loadPreference xsd: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 1 2
* This property will be one of:
ValueDescription
"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.
loadIndex xsd:int Represents the load on the RDSServer in the range of 0-100 Since Horizon 7.8 1 2

  1. This property need not be set. ↩↩↩↩

  2. This property cannot be updated. ↩↩↩↩