Create Pairing

Create Pairing

Pair to remote Site Recovery Manager server.

Request
URI
POST
https://{api_host}/pairings
COPY
Request Body

Remote Site Recovery Manager server spec to pair to.

PairingSpec of type(s) application/json
Required
{
    "pair_psc_info": {
        "url": "string",
        "port": 0,
        "thumbprint": "string",
        "username": "string",
        "password": "string"
    },
    "pair_vc_guid": "string",
    "pair_srm_thumbprint": "string",
    "pair_srm_url": "string"
}
pair_psc_info
Required

pair_psc_info

string
pair_vc_guid
Required

Server guid of the remote vCenter Server.

string
pair_srm_thumbprint
Optional

Thumbprint of the remote Site Recovery Manager.

string
pair_srm_url
Optional

URL of the remote Site Recovery Manager.

Authentication
This operation uses the following authentication methods.
Responses
202

Pairing task.

Returns Task of type(s) application/json
{
    "id": "string",
    "description": "string",
    "description_id": "string",
    "entity": "string",
    "entity_name": "string",
    "status": "string",
    "error": {
        "message": "string",
        "details": "string"
    },
    "progress": 0,
    "queued_time": 0,
    "start_time": 0,
    "complete_time": 0
}
string
id
Required

ID of the task.

string
description
Optional

Description of the task.

string
description_id
Optional

ID of the description of the task.

string
entity
Optional

Entity the task is executed upon.

string
entity_name
Optional

Name of the entity the task is executed upon.

string
status
Required

Status of the task.

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

error

object
result
Optional

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

integer As int32 As int32
progress
Optional

The current progress of the task, in percentage number.

integer As int64 As int64
queued_time
Optional

The queued time of the task, in milliseconds.

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 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

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
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
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
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
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.