ProbeResult

ProbeResult
ProbeResult

Results of a connection test to a specific endpoint.

JSON Example
{
    "result": "string",
    "resolvedIp": "string",
    "canConnect": false,
    "sslHandshake": false,
    "connectionResult": "string",
    "sslResult": "string",
    "certificateChain": "string",
    "additionalCAIssuers": [
        "string"
    ]
}
string
result
Optional

Localized message describing the connection result stating success or an error message with a brief summary.

string
resolvedIp
Optional

The IP address the host was resolved to, if not going through a proxy.

boolean
canConnect
Optional

If vCD can establish a connection on the specified port.

boolean
sslHandshake
Optional

If an SSL Handshake succeeded (secure requests only).

string
connectionResult
Optional

A code describing the result of establishing a connection. Will be one of the following:

  • SUCCESS: The connection was successful.
  • ERROR_CANNOT_RESOLVE_IP: The hostname could not be resolved to an IP address.
  • ERROR_CANNOT_CONNECT: Unable to establish connection.
string
sslResult
Optional

A code describing the result of the SSL handshake. Will be one of the following:

  • SUCCESS: The SSL handshake was successful.
  • ERROR_SSL_ERROR: Unable to establish SSL connection.
  • ERROR_UNTRUSTED_CERTIFICATE: Certificate not trusted.
  • ERROR_CANNOT_VERIFY_HOSTNAME: Hostname verification failed.
  • null: No SSL handshake was attempted.
string
certificateChain
Optional

The SSL certificate chain presented by the server if a secure connection was made.

array of string
additionalCAIssuers
Optional

URLs supplied by Certificate Authorities to retrieve signing certificates, when those certificates are not included in the chain. These URLs are the locations for the 'caIssuers' access method in the 'Authority Info Access' extension (as described in RFC 5280 Section 4.2.2.1) of the certificates and gives the caller an indication where additional CA certificates may be retrieved from, to complete the chain to the trust anchor.

Availability
Added in 34.0
Property Of