HeldVMInfo

HeldVMInfo
HeldVMInfo

Information related to a held Virtual Machine.

JSON Example 
{
    "machine_id": "vm-416",
    "machine_state": "Connected",
    "name": "Win10"
}
string
machine_id
Optional

Unique virtual center moid representing the virtual machine.

string
machine_state
Optional

Machine state

  • AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.
  • AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.
  • AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.
  • AGENT_ERROR_DISABLED: Horizon Agent is disabled.
  • AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.
  • AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.
  • AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.
  • AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.
  • AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.
  • AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.
  • ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.
  • AVAILABLE: The machine is powered on and ready for active connections.
  • BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.
  • CONNECTED: The machine is in an active session and has an active connection to a Horizon client.
  • CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.
  • DELETING: The machine is marked for deletion.
  • DISABLED: The machine is disabled.
  • DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.
  • DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.
  • ERROR: An unknown error occurred in the machine.
  • IN_PROGRESS: There is a machine operation in progress.
  • MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.
  • PROVISIONED: The machine is powered off or suspended.
  • PROVISIONING: The machine is being provisioned.
  • PROVISIONING_ERROR: An error occurred during provisioning.
  • UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.
  • UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.
  • UNKNOWN: Could not determine the state of the machine.
  • VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.
  • WAITING_FOR_AGENT: Horizon Connection Server is waiting to establish communication with Horizon Agent for one of these cases - a virtual machine in a manual desktop pool, unmanaged machine or RDS server.
Possible values are : AGENT_CONFIG_ERROR, AGENT_DRAIN_MODE, AGENT_DRAIN_UNTIL_RESTART, AGENT_ERROR_DISABLED, AGENT_ERROR_INVALID_IP, AGENT_ERROR_NEEDS_REBOOT, AGENT_ERROR_PROTOCOL_FAILURE, AGENT_ERROR_STARTUP_IN_PROGRESS, AGENT_ERROR_DOMAIN_FAILURE, AGENT_UNREACHABLE, ALREADY_USED, AVAILABLE, BLOCKED_AGENT_VERSION, CONNECTED, CUSTOMIZING, DELETING, DISABLED, DISABLE_IN_PROGRESS, DISCONNECTED, ERROR, IN_PROGRESS, MAINTENANCE, PROVISIONED, PROVISIONING, PROVISIONING_ERROR, UNASSIGNED_USER_CONNECTED, UNASSIGNED_USER_DISCONNECTED, UNKNOWN, VALIDATING, WAITING_FOR_AGENT,
string
name
Optional

VM name.

Property Of