Validate Connection

Validate Connection

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
URI
POST
https://{api_host}/appliance/configuration-manager/actions/validate-connection
COPY
Request Body

The connection specification to be validated.

VcConnectionSpec of type(s) application/json
Optional
{
    "credentials": {
        "admin_user": "string",
        "admin_password": "string"
    },
    "connection_spec": {
        "psc_uri": "string",
        "psc_thumbprint": "string",
        "vc_instance_id": "string",
        "vc_thumbprint": "string"
    }
}
credentials
Required

credentials

connection_spec
Required

connection_spec

Authentication
This operation uses the following authentication methods.
Responses
204

The connection is validated successfully.

Operation doesn't return any data structure

400

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

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id


401

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

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id


500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id