RDSServerMonitorDetails

RDSServerMonitorDetails
RDSServerMonitorDetails

Details of RDS Server.

JSON Example 
{
    "agent_build": 4445678,
    "agent_version": "7.9.0",
    "max_sessions_count_configured": 123,
    "operating_system": "WINDOWS_SERVER_2016",
    "state": "AVAILABLE"
}
string
agent_build
Optional

Agent build number.

string
agent_version
Optional

Agent version.

integer As int32 As int32
max_sessions_count_configured
Optional

Maximum number of sessions for RDS server as configured by administrator. Will be unset if the value is not configured.

string
operating_system
Optional

Operating System version.

  • UNKNOWN: Unknown
  • 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_SERVER_OTHER: Linux Server (other)
Possible values are : UNKNOWN, WINDOWS_SERVER_2003, WINDOWS_SERVER_2008, WINDOWS_SERVER_2008_R2, WINDOWS_SERVER_2012, WINDOWS_SERVER_2012_R2, WINDOWS_SERVER_2016_OR_ABOVE, LINUX_SERVER_OTHER,
string
state
Optional

State of RDS Server.

  • WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.
  • AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.
  • AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.
  • AVAILABLE: The RDS Server is powered on and ready for an active connection.
  • DISABLED: The RDS Server is disabled.
  • DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.
  • PROVISIONING: The RDS Server is being provisioned.
  • PROVISIONING_ERROR: An error occurred during provisioning.
  • CUSTOMIZING: The RDS Server is being customized.
  • DELETING: The RDS Server is marked for deletion. It will be deleted soon.
  • MAINTENANCE: The RDS Server is in maintenance mode.
  • ERROR: An unknown error occurred in the RDS Server.
  • PROVISIONED: The RDS Server has been provisioned.
  • CONNECTED: The RDS Server is in an active session.
  • DISCONNECTED: The RDS Server is in an active session but is disconnected.
  • AGENT_ERR_STARTUP_IN_PROGRESS: The Horizon Agent has started on the virtual machine, but other required services such as the display protocol are still starting.
  • AGENT_ERR_DISABLED: The Horizon Agent is disabled.
  • AGENT_ERR_INVALID_IP: The Horizon Agent has an invalid IP.
  • AGENT_ERR_NEED_REBOOT: The Horizon Agent needs reboot.
  • AGENT_ERR_PROTOCOL_FAILURE: Protocol such as RDP or PCoIP is not enabled.
  • AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.
  • AGENT_DRAIN_MODE: The RDS Server is configured for drain mode.
  • AGENT_DRAIN_UNTIL_RESTART: The RDS Server is configured a mode to drain until restart.
  • ALREADY_USED: The RDS Server cannot accept new sessions.
  • IN_PROGRESS: There is a RDS Server operation in progress.
  • VALIDATING: The connection server is synchronizing state information with the agent.
  • UNKNOWN: Could not determine the state of the RDS Server.
Possible values are : WAIT_FOR_AGENT, AGENT_UNREACHABLE, AGENT_CONFIG_ERROR, AVAILABLE, DISABLED, DISABLE_IN_PROGRESS, PROVISIONING, PROVISIONING_ERROR, CUSTOMIZING, DELETING, MAINTENANCE, ERROR, PROVISIONED, CONNECTED, DISCONNECTED, AGENT_ERR_STARTUP_IN_PROGRESS, AGENT_ERR_DISABLED, AGENT_ERR_INVALID_IP, AGENT_ERR_NEED_REBOOT, AGENT_ERR_PROTOCOL_FAILURE, AGENT_ERR_DOMAIN_FAILURE, AGENT_DRAIN_MODE, AGENT_DRAIN_UNTIL_RESTART, ALREADY_USED, IN_PROGRESS, VALIDATING, UNKNOWN,
Property Of