Skip to content

Data Object - MachineData

Java Class

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

Property of

MachineDetailsView

See also

AccessGroupId, MachineAgentUpgradeInfo, MachineAlias, UserOrGroupId

Since

Horizon 7.7

Data Object Description

Fields common to all types of Machines.

Data Object Properties

Name Type Description
name xsd:string The name of the Machine. 2
dnsName xsd:string The DNS name for the Machine. 1 2
type xsd:string The type of Machine. 2
* This property will be one of:
ValueDescription
"MANAGED_VIRTUAL_MACHINE"The machine is a managed virtual machine.
"UNMANAGED_MACHINE"The machine is an unmanaged physical or virtual machine.
agentVersion xsd:string Horizon agent version installed on this Machine. 1 2
accessGroup AccessGroupId The access group of the Machine. 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
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
UNASSIGNED_USER_CONNECTEDA user other than the assigned user is logged in to a virtual machine in a dedicated desktop
CONNECTEDThe virtual machine is in an active session and has an active remote connection to a View client
UNASSIGNED_USER_DISCONNECTEDA user other than the assigned user is logged in and disconnected from a virtual machine in a dedicated desktop.
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.
assignedUser UserOrGroupId Deprecated._useassignedUsers instead. This field will not be populated for machine belonging to pool which support multiple assignment. _ Id of the user assigned to this Machine. This cannot be a group. 1
assignedUserName xsd:string Deprecated._useassignedUserNames instead. This field will not be populated for machine belonging to pool which support multiple assignment. _ Name of the user assigned to this Machine. This cannot be a group. 1
assignedUsers UserOrGroupId[] Ids of the users assigned to this Machine. This cannot be a group. Since Horizon 7.12 1
assignedUserNames xsd:string[] Names of the users assigned to this Machine. Names in this array maps to the ids in assignedUsers array. Since Horizon 7.12 1
aliases MachineAlias[] Machine aliases for all the assigned users. Since Horizon 7.13 1 2
agentBuildNumber xsd:string Horizon agent build number installed on this Machine. Since Horizon 7.8 1 2
held xsd:boolean Held status of the machine Since Horizon 8.8 2
agentUpgradeInfo MachineAgentUpgradeInfo Information about agent upgrade on the machine Since Horizon 8.8 1 2

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

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