ConnectionServerMonitorInfoV3

ConnectionServerMonitorInfoV3
ConnectionServerMonitorInfoV3

Monitoring information related to Connection Server.

JSON Example 
{
    "certificate": {
        "valid": true,
        "valid_from": 1561939200000,
        "valid_to": 1561939200000
    },
    "connection_count": 1234,
    "cs_replications": [
        {
            "server_name": "cs1.example.com",
            "status": "OK"
        }
    ],
    "default_certificate": false,
    "details": {
        "build": "12345678.0.1",
        "version": "7.9.0"
    },
    "id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
    "last_updated_timestamp": 1582029025748,
    "name": "cs1.example.com",
    "services": [
        {
            "service_name": "BLAST_SECURE_GATEWAY",
            "status": "UP"
        }
    ],
    "session_protocol_data": [
        {
            "session_count": 341,
            "session_protocol": "BLAST"
        }
    ],
    "session_threshold": 2000,
    "status": "OK",
    "tunnel_connection_count": 1234,
    "unrecognized_pcoip_requests_count": 3,
    "unrecognized_tunnel_requests_count": 4,
    "unrecognized_xmlapi_requests_count": 5
}
CertificateMonitorInfo
certificate
Optional

certificate

integer As int32 As int32
connection_count
Optional

Number of connections to this Connection Server.

array of ConnectionServerMonitorCSReplication
cs_replications
Optional

Connection Server replication status with respect to the Peer Connection Servers in the same cluster.

boolean
default_certificate
Optional

Indicates whether server has the default certificate.

ConnectionServerMonitorDetails
details
Optional

details

string
id
Required

Unique ID of the Connection Server.

integer As int64 As int64
last_updated_timestamp
Optional

The timestamp in milliseconds when the last update was obtained. Measured as epoch time.

string
name
Optional

Connection Server host name or IP address.

array of ConnectionServerMonitorServiceStatus
services
Optional

Connection Server related Windows services information.

array of ConnectionServerSessionProtocolData
session_protocol_data
Optional

PCoIP, RDP or BLAST protocol sessions details when clients connect directly to the connection server.

integer As int32 As int32
session_threshold
Optional

The maximum number of connections allowed for the connection server through the Horizon client. If all of the secure gateways (HTTP(S)/PCOIP/BLAST) are enabled, this field denotes the maximum number of connections allowed for the connection server.If none of the secure gateways(HTTP(S)/PCOIP/BLAST) are enabled, sessionThreshold value will not be set.

string
status
Optional

Status of the Connection Server.

  • OK: The Connection Server is working properly.
  • ERROR: Error occurred when connecting to Connection Server.
  • NOT_RESPONDING: The Connection Server is not responding.
  • UNKNOWN: Status of Connection Server is unknown.
  • RESTART_REQUIRED: Connection Server needs a Restart.
Possible values are : OK, ERROR, NOT_RESPONDING, UNKNOWN, RESTART_REQUIRED,
integer As int32 As int32
tunnel_connection_count
Optional

Number of connections tunneled through this Connection Server.

integer As int32 As int32
unrecognized_pcoip_requests_count
Optional

Number of unrecognized PCoIP secure gateway requests.

integer As int32 As int32
unrecognized_tunnel_requests_count
Optional

Number of unrecognized tunnel requests.

integer As int32 As int32
unrecognized_xmlapi_requests_count
Optional

Number of unrecognized XML API requests.

Returned By