PhysicalMachineInfoV2

PhysicalMachineInfoV2
PhysicalMachineInfoV2

Information related to a Physical Machine.
List API returning this summary information can use search filter query to filter on specific fields supported by filters.
Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports.

JSON Example 
{
    "description": "This is a physical machine.",
    "dns_name": "machine1.example.com",
    "id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
    "message_security_enhanced_mode_supported": true,
    "message_security_mode": "MIXED",
    "name": "machine1",
    "operating_system": "WINDOWS_SERVER_2016",
    "rds_server": true,
    "state": "AVAILABLE"
}
string
description
Optional

Description of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'.

string
dns_name
Optional

DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.

string
id
Optional

Unique ID representing machine.
Supported Filters : 'Equals'.

boolean
message_security_enhanced_mode_supported
Optional

Indicates whether ENHANCED message security mode is currently supported by this machine.

string
message_security_mode
Optional

The current JMS message security mode used by this machine.
Supported Filters : 'Equals'.

  • DISABLED: Message security mode is disabled.
  • MIXED: Message security mode is enabled but not enforced.
  • ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
  • ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
Possible values are : DISABLED, MIXED, ENABLED, ENHANCED,
string
name
Optional

Name of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'.

string
operating_system
Optional

The machine operating system.

  • UNKNOWN: Unknown
  • WINDOWS_XP: Windows XP
  • WINDOWS_VISTA: Windows Vista
  • WINDOWS_7: Windows 7
  • WINDOWS_8: Windows 8
  • WINDOWS_10: Windows 10
  • WINDOWS_SERVER_2003: Windows Server 2003
  • WINDOWS_SERVER_2008: Windows Server 2008
  • WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
  • WINDOWS_SERVER_2012: Windows Server 2012
  • WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
  • 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_RHEL: Linux (Red Hat Enterprise)
  • LINUX_SUSE: Linux (Suse)
  • LINUX_CENTOS: Linux (CentOS)
Possible values are : UNKNOWN, WINDOWS_XP, WINDOWS_VISTA, WINDOWS_7, WINDOWS_8, WINDOWS_10, WINDOWS_SERVER_2003, WINDOWS_SERVER_2008, WINDOWS_SERVER_2008_R2, WINDOWS_SERVER_2012, WINDOWS_SERVER_2012_R2, WINDOWS_SERVER_2016_OR_ABOVE, LINUX_OTHER, LINUX_SERVER_OTHER, LINUX_UBUNTU, LINUX_RHEL, LINUX_SUSE, LINUX_CENTOS,
boolean
rds_server
Optional

Indicates if the physical machine is RDS Server.
Supported Filters : 'Equals'.

string
state
Optional

The state of the machine.
Supported Filters : 'Equals'.

  • AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.
  • UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.
  • CONNECTED: The machine is in an active session and has an active connection to a Horizon client.
  • UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.
  • DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.
  • 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_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_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.
  • AVAILABLE: The machine is powered on and ready for active connections.
  • VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.
  • DISABLED: The machine is disabled.
  • UNKNOWN: Could not determine the state of the machine.
Possible values are : AGENT_UNREACHABLE, UNASSIGNED_USER_CONNECTED, CONNECTED, UNASSIGNED_USER_DISCONNECTED, DISCONNECTED, AGENT_ERROR_STARTUP_IN_PROGRESS, AGENT_ERROR_DISABLED, AGENT_ERROR_INVALID_IP, AGENT_ERROR_NEEDS_REBOOT, AGENT_ERROR_PROTOCOL_FAILURE, AGENT_CONFIG_ERROR, AVAILABLE, VALIDATING, DISABLED, UNKNOWN,
Returned By