[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vrms-appliance-config-api
Validate Connection
DescriptionIf 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
URLURL
https://{api_host}//appliance/configuration-manager/actions/validate-connection
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.
Authentication
This operation uses the following authentication methods.
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
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"}]
vrms-appliance-config-api
