Skip to content

Data Object - MachineBase

Java Class

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

Property of

MachineInfo, MachineNamesView, MachineSummaryView

See also

AccessGroupId, DesktopId, MachineAgentUpgradeInfo, MachineAlias, SessionId, UserOrGroupId

Since

Horizon View 6.0

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 DNS name for the Machine. 1 2
user UserOrGroupId Deprecated._useusers instead. This field will not be populated for machine belonging to pool which support multiple assignment. _ The user assigned to the Machine. This cannot be a group. 1
users UserOrGroupId[] The users assigned to the Machine. This cannot be a group. Since Horizon 7.12 1 2
aliases MachineAlias[] Machine aliases for all the assigned users. Since Horizon 7.13 1 2
accessGroup AccessGroupId The access group of this Machine. 2
desktop DesktopId The id of the desktop that the machine belongs to. 2
desktopName xsd:string The name of the desktop that the machine belongs to. Since Horizon 7.6 1 2
session SessionId The ID of the session on the machine (if one exists). 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
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.
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.
operatingSystem xsd:string The guest operating system. 1 2
* This property will be one of:
ValueDescription
"Unknown"
"Windows XP"Windows XP
"Windows Vista"Windows Vista
"Windows 7"Windows 7
"Windows 8"Windows 8
"Windows 10"Windows 10
"Windows 11"Windows 11
"Windows Server 2003"Windows Server 2003
"Windows Server 2008"Windows Server 2008
"Windows Server 2008R2"Windows Server 2008R2
"Windows Server 2012"Windows Server 2012
"Windows Server 2012R2"Windows Server 2012R2
"Windows Server 10"null
"Windows Server 2016"null
"Windows Server 2016 or above"Windows Server 2016 or above
"Linux (other)"Linux (other)
"Linux Server (other)"Linux server (other)
"Linux (Ubuntu)"Linux (Ubuntu)
"Linux (Red Hat Enterprise Linux)"Linux (Red Hat Enterprise)
"Linux (SUSE Linux Enterprise Server)"Linux (Suse)
"Linux (CentOS)"Linux (CentOS)
operatingSystemArchitecture xsd:string The guest operating system architecture. Since Horizon 7.5 1 2
* This property will be one of:
ValueDescription
"Unknown"Operating System cannot be determined.
"32_bit"32 bit Operating System Architecture.
"64_bit"64 bit Operating System Architecture.
agentVersion xsd:string The agent version. 1 2
agentBuildNumber xsd:string The agent build number 1 2
remoteExperienceAgentVersion xsd:string The remote experience agent version 1 2
remoteExperienceAgentBuildNumber xsd:string The remote experience agent build number 1 2
refId xsd:string Reference ID used for this machine. Since Horizon 7.12 1
held xsd:boolean Held status of the machine Since Horizon 8.8 1 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. ↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩