Validate Migrate Connection Spec

Validate Migrate Connection Spec

Validates connection to the remote appliance. If successful the result task will finish successfully without any ''result''.

Request
URI
POST
https://{api_host}/appliance/migration-manager/actions/validate-connection
COPY
Request Body

The migration specification to be validated.

ApplianceConnectionSpec of type(s) application/json
Optional

Show optional properties

{
    "appliance_uri": "https://my-appliance.acme.com:443",
    "appliance_credentials": {
        "admin_user": "string",
        "admin_password": "string"
    }
}
{
    "appliance_uri": "https://my-appliance.acme.com:443",
    "appliance_credentials": {
        "admin_user": "string",
        "admin_password": "string"
    },
    "appliance_thumbprint": "string",
    "appliance_certificate": "string"
}
string
appliance_uri
Required

Appliance URI. Must specify the protocol (currently only https is supported) and optionally the port (default port is 443).

object
appliance_credentials
Required

Contains credentials information.

string
appliance_thumbprint
Optional

Appliance thumbprint.

string
appliance_certificate
Optional

Certificate in PEM format.

Authentication
This operation uses the following authentication methods.
Responses
202

Task to monitor the operation.

Returns Task of type(s) application/json 
"Task Object"
string
id
Optional

ID of the task.

string
description
Optional

Description of the task.

string
type
Optional

Operation type of the task.

string
status
Required

Status of the task.

Possible values are : QUEUED, RUNNING, SUCCESS, ERROR, CANCELLED,
object
error
Optional

Detailed information about the error if the task status is ERROR.

object
result
Optional

Information about the task result if the task status is SUCCESS.

integer As int32 As int32
progress
Optional
Constraints: minimum: 0 maximum: 100

The current progress of the task, in percentage number.

integer As int64 As int64
start_time
Optional

The start time of the task, in milliseconds.

integer As int64 As int64
complete_time
Optional

The complete time of the task, in milliseconds.


400

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

Returns ResponseError of type(s) application/json 
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


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 
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json 
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"appliance_credentials:"object","appliance_uri:"string"}' https://{api_host}/appliance/migration-manager/actions/validate-connection
On This Page
Migration Operations
POST
List Services To Migrate
POST
Migrate Services
POST
Validate Migrate Connection Spec