[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Test

Description

Tests a connection, including SSL handshake and hostname verification.

Request

Request

URL

URL


post
https://{api_host}/cloudapi/1.0.0/testConnection
Copy

Request Body

Request Body

Connection of type(s) application/json Required
{
	"host": "string",
	"port": 0
}
string
host Required

The host (or IP address) to connect to.


integer
port Required

The port to use when connecting.


array of string
additionalCAIssuers Optional

A list of URLs being authorized by the user to retrieve additional CA certificates from, if necessary, to complete the certificate chain to its trust anchor.

Upon retrieving the certificate chain presented during the handshake, if signing CA certificates were not included, but a location is specified for the 'caIssuers' access method of the 'Authority Info Access' extension (as described in RFC 5280 Section 4.2.2.1) of those certificates and that location is one of these supplied URLs, then additional certificates will be retrieved from those URLs in accordance with the protocol laid out in the RFC.

Any failure to retrieve this certificate will NOT fail the test connection request, nor will the error associated with this failure be returned.

In the unlikely event that the CA Issuers URL specifies `https` instead of `http`, the original certificate, that included that URL, will be temporarily used to trust the server during ssl handshake


string
hostnameVerificationAlgorithm Optional

Endpoint/Hostname verification algorithm to be used during SSL/TLS/DTLS handshake. Their values are as follows:

  • HTTPS: use https hostname verification algorithm as described in RFC 2818
  • LDAPS: use ldaps hostname verification algorithm as described in RFC 2830
When this field is not set, the default value null indicates no hostname verification will be performed.


string
preConfiguredProxy Introduced Changed Optional

The URN of a ProxyConfiguration to use for the test. Only one of proxyConnection or preConfiguredProxy can be specified. If neither is specified then no proxy is used to test the connection.


proxyConnection Optional

Proxy connection to use for test. Only one of proxyConnection and preConfiguredProxy can be specified. If neither is specified, then no proxy is used to test the connection.


boolean
secure Optional

If the connection should use https.


integer as int32
timeout Optional

Maximum time (in seconds) any step in the test should wait for a response.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns TestResult of type(s) application/json;version=36.3
{
	"proxyProbe": {
		"additionalCAIssuers": [
			"string"
		],
		"canConnect": false,
		"certificateChain": "string",
		"connectionResult": "string",
		"resolvedIp": "string",
		"result": "string",
		"sslHandshake": false,
		"sslResult": "string"
	},
	"targetProbe": {
		"additionalCAIssuers": [
			"string"
		],
		"canConnect": false,
		"certificateChain": "string",
		"connectionResult": "string",
		"resolvedIp": "string",
		"result": "string",
		"sslHandshake": false,
		"sslResult": "string"
	}
}
proxyProbe Optional

Results of a connection test to a specific endpoint.


targetProbe Optional

Results of a connection test to a specific endpoint.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"additionalCAIssuers":["string"],"host":"string","hostnameVerificationAlgorithm":"string","port":0,"preConfiguredProxy":"string","proxyConnection":{"proxyHost":"string","proxyPassword":"string","proxyPort":0,"proxySecure":false,"proxyUsername":"string"},"secure":false,"timeout":0}' https://{api_host}/cloudapi/1.0.0/testConnection


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 34.0
Test Connection Operations
Feedback

Was this page helpful?