Skip to content

Data Object - RDSServerStateView

Java Class

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

See also

DesktopId, FarmId, RDSServerId

Since

Horizon 7.7

Data Object Description

This View includes status, powerState, dnsName and IP address of this RDS Server.

Queryable Data Object

This data object is queryable using QueryService.

Can filter on all RDSServerStateView attributes.

Query Privileges

Privilege Description
GLOBAL_CONFIG_VIEW is required to query RDSServers that are not in-use. It is sufficient to get all RDSServers that may or may not be associated with a Farm.
POOL_VIEW is required to query RDSServers that are associated with a Farm. All in-use RDSServers can be queried with POOL_VIEW on the Root access group. With POOL_VIEW privilege on a non-Root Farm access group, only the RDSServers associated with the Farm can be queried.

Data Object Properties

Name Type Description
id RDSServerId The id of the RDSServer. 2
farm FarmId The farm id of the RDSServer. 1 2
desktop DesktopId The desktop id of the RDSServer. 1 2
status xsd:string The status of the RDSServer. 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_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.
machinePowerState xsd:string PowerState of the RDSServer. 1 2
* This property will be one of:
ValueDescription
POWERED_OFF
POWERED_ONThe virtual machine is powered on.
SUSPENDEDThe virtual machine is suspended.
ipV4 xsd:string IPV4 address of the RDSServer. 1 2
ipV6 xsd:string IPV6 address of the RDSServer. 1 2
dnsName xsd:string DNS name of the RDSServer. 1 2
agentId xsd:string ViewAgent Identity of the RDSServer. 1 2

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

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