[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-appliance-config-api

Validate Connection

Description

If there is no explicit and valid vcInstanceId in the connection spec, no vCenter Server validation will be done. Only the infra node will be validated.

Request

Request

URL

URL


post
https://{api_host}//appliance/configuration-manager/actions/validate-connection
Copy

Request Body

Request Body

VcConnectionSpec of mimetype application/json Optional

The connection specification to be validated.

{
	"connection_spec": {
		"psc_thumbprint": "string",
		"psc_uri": "string",
		"vc_instance_id": "string",
		"vc_thumbprint": "string"
	},
	"credentials": {
		"admin_password": "string",
		"admin_user": "string"
	}
}
connection_spec Required

Contains connection information for a service. If not set the connection parameters will be read from the current DR solution configuration if it exists.


credentials Required

Contains credentials information.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

204 No Content

The connection is validated successfully.

Errors

Errors

ResponseError
400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content


401

Unauthorized - the client must authenticate itself to get the requested response


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"connection_spec":{"psc_thumbprint":"string","psc_uri":"string","vc_instance_id":"string","vc_thumbprint":"string"},"credentials":{"admin_password":"string","admin_user":"string"}}' https://{api_host}/appliance/configuration-manager/actions/validate-connection


[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-appliance-config-api
Feedback

Was this page helpful?