Changed1
[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api

Create Pairing

Description

Pair to remote Site Recovery Manager server.

Request

Request

URL

URL


post
https://{api_host}//pairings
Copy

Request Body

Request Body

PairingSpec of mimetype application/json Required

Remote Site Recovery Manager server spec to pair to.

{
	"pair_psc_info": {
		"password": "string",
		"port": 0,
		"thumbprint": "string",
		"url": "string",
		"username": "string"
	},
	"pair_vc_guid": "string"
}
pair_psc_info Required

Details of a pair Platform Services Controller.


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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted

Returns Task of type application/json

Pairing task.

{
	"complete_time": 0,
	"description": "string",
	"description_id": "string",
	"entity": "string",
	"entity_name": "string",
	"error": {
		"details": "string",
		"message": "string"
	},
	"id": "string",
	"progress": 0,
	"queued_time": 0,
	"result": {},
	"start_time": 0,
	"status": "QUEUED"
}
string
id Required

ID of the task.


string
status Required

Status of the task.

Possible values are: QUEUEDRUNNINGSUCCESSERRORCANCELLED


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.


integer as int64
complete_time Changed Optional

The complete time of the task, in milliseconds.


integer as int32
progress Optional

The current progress of the task, in percentage number.


integer as int64
queued_time Changed Optional

The queued time of the task, in milliseconds.


object
result Optional

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


integer as int64
start_time Changed Optional

The start time of the task, in milliseconds.


error Optional

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

Errors

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

Code Samples

PowerCLI Client SDK Example

$PairingSpecPairPscInfo = Initialize-SrmPairingSpecPairPscInfo -Url "MyUrl" -Port 0 -Thumbprint "MyThumbprint" -Username "MyUsername" -Password "MyPassword"
$PairingSpec = Initialize-SrmPairingSpec -PairPscInfo $PairingSpecPairPscInfo -PairVcGuid "MyPairVcGuid" -PairSrmThumbprint "MyPairSrmThumbprint" -PairSrmUrl "MyPairSrmUrl"
Invoke-SrmCreatePairing -pairingSpec $pairingSpec

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"pair_psc_info":{"password":"string","port":0,"thumbprint":"string","url":"string","username":"string"},"pair_srm_thumbprint":"string","pair_srm_url":"string","pair_vc_guid":"string"}' https://{api_host}/pairings


[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
What's changed in latest?
INTRODUCED
Feedback

Was this page helpful?