Pair Vr

Pair Vr

Pair to the remote vSphere Replication Management Server.

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

Pair the remote server spec

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

pair_psc_info

string
pair_vc_id
Required

The ID of the remote vCenter server.

Authentication
This operation uses the following authentication methods.
Responses
202

Pairing task

Returns TaskDrResponseEntity of type(s) application/json
This response body class contains all of the following: Task 
{
    "id": "string",
    "description": "string",
    "description_id": "string",
    "entity": "string",
    "entity_name": "string",
    "status": "string",
    "error": {
        "message": "string",
        "details": "string"
    },
    "progress": 0,
    "queued_time": "string",
    "start_time": "string",
    "complete_time": "string",
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ]
    }
}
Metadata
_meta
Optional

_meta


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


On This Page
Pairing Operations
POST
Create Remote Session
DELETE
Delete Vr Pairing
GET
Get All Vr Details In Pairing
GET
Get All Vr Servers In Pairing
GET
Get Remote Session
GET
Get Vr Info In Pairing
GET
Get Vr Pairing
GET
Get Vr Pairing Issues
GET
Get Vr Pairings
GET
Get Vr Server In Pairing
POST
Pair Vr
POST
Reconnect Vr Pairing
POST
Reconnect Vr Server In Pairing
POST
Register Vr Server In Pairing
DELETE
Unregister Vr Server In Pairing