Data Object - RDSServerStateView

Class: VMware.Hv.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

Properties

Name

Type

Description

RDSServerId

The id of the RDSServer.

This property cannot be updated.

farm

FarmId

The farm id of the RDSServer.

This property need not be set.
This property cannot be updated.

desktop

DesktopId

The desktop id of the RDSServer.

This property need not be set.
This property cannot be updated.

status

xsd:string

The status of the RDSServer.

This property need not be set.
This property cannot be updated.

This property will be one of:

Value	Description
"PROVISIONING"	The virtual machine is being provisioned
"PROVISIONING_ERROR"	An error occurred during provisioning.
"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.
"CUSTOMIZING"	The virtual machine in automated/provisioned desktop is being customized
"DELETING"	The virtual machine is marked for deletion. View Manager will delete the virtual machine soon.
"MAINTENANCE"	The virtual machine is in maintenance mode. Users cannot log in or use the virtual machine
"ERROR"	An unknown error occurred in the virtual machine.
"PROVISIONED"	The virtual machine is powered off or suspended.
"AGENT_UNREACHABLE"	View Connection Server cannot establish communication with View Agent on a virtual machine
"CONNECTED"	The virtual machine is in an active session and has an active remote connection to a View client
"DISCONNECTED"	The virtual machine is in an active session, but it is disconnected from the View client
"AGENT_ERR_STARTUP_IN_PROGRESS"	View Agent has started on the virtual machine, but other required services such as the display protocol are still starting
"AGENT_ERR_DISABLED"	View Agent is disabled
"AGENT_ERR_INVALID_IP"	View Agent has invalid IP
"AGENT_ERR_NEED_REBOOT"	View Agent needs reboot.
"AGENT_ERR_PROTOCOL_FAILURE"	Protocol such as RDP or PCoIP is not enabled.
"AGENT_ERR_DOMAIN_FAILURE"	View Agent has invalid domain.
"AGENT_CONFIG_ERROR"	The Remote Desktop Services role is not enabled.
"AGENT_DRAIN_MODE"	RDS host is configured for drain mode
"AGENT_DRAIN_UNTIL_RESTART"	RDS host is configured for drain until restart mode
"ALREADY_USED"	The virtual machine is configured to have only one session which is currently in progress and cannot accept new sessions
"AVAILABLE"	The virtual machine is powered on and ready for an active connection.
"IN_PROGRESS"	There is a virtual machine operation in-progress.
"DISABLED"	The machine is disabled
"DISABLE_IN_PROGRESS"	Disabled server still has some view brokered sessions. It can still accept re-connections
"VALIDATING"	The connection server is synchronizing state information with the agent.
"UNKNOWN"	Could not determine the state of the virtual machine.