Skip to content

Data Object - MachineStateView

Java Class

com.omnissa.vdi.vlsi.binding.vdi.resources.Machine.MachineStateView

See also

DesktopId, MachineId

Since

Horizon 7.7

Data Object Description

This View includes baseState, powerState, dnsName and IP address of this Machine.

Queryable Data Object

This data object is queryable using QueryService.

Can filter on the all MachineStateView attributes.

Query Privileges

Privilege Description
MACHINE_VIEW is required to query MachineStateView.

Data Object Properties

Name Type Description
id MachineId The id of the Machine. 2
desktop DesktopId The desktop id of the Machine. 1 2
basicState xsd:string The basic state of the Machine. For a Virtual Machine based Machine, the complete state is determined by basicState, isMissingInVCenter, operationState and isInHoldCustomization. In the Admin UI, the last three states are shown in brackets in the Machine State. 2
* This property will be one of:
ValueDescription
"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
"UNASSIGNED_USER_CONNECTED"A user other than the assigned user is logged in to a virtual machine in a dedicated desktop
"CONNECTED"The virtual machine is in an active session and has an active remote connection to a View client
"UNASSIGNED_USER_DISCONNECTED"A user other than the assigned user is logged in and disconnected from a virtual machine in a dedicated desktop.
"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.
machinePowerState xsd:string PowerState of the machine. 1 2
* This property will be one of:
ValueDescription
"POWERED_OFF"
"POWERED_ON"The virtual machine is powered on.
"SUSPENDED"The virtual machine is suspended.
ipV4 xsd:string IPV4 address of the machine. 1 2
ipV6 xsd:string IPV6 address of the machine. 1 2
dnsName xsd:string DNS name of the machine. 1 2
agentId xsd:string agent Identity of the machine. 1 2

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

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