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

Run Reprotect

Description

Run reprotect for this recovery plan. Complete a recovery, and start protecting the groups so they can be recovered on the peer site. Reprotect involves unregistering the VMs on the peer site, configuring storage, and registering placeholders. The callers must ensure that they have all the required privileges for VM creation, deletion, and reconfiguration.

Request

Request

URL

URL


post
https://{api_host}//pairings/{pairing_id}/recovery-management/plans/{plan_id}/actions/reprotect
Copy

Path Parameters

Path Parameters

string
pairing_id Required

The ID of a pairing between this Site Recovery Manager server and remote one.


string
plan_id Required

The ID of a recovery plan defined within current pairing.


Request Body

Request Body

ReprotectPlanSpec of mimetype application/json Required

A spec describing the reprotect recovery settings.

{
	"forced": false
}
boolean
forced Optional

Whether to force the cleanup operation. If true, makes best effort to complete, and could leak resources in the process (e.g. silently failing to delete a test-network, test-VM, etc).

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted

Returns TaskDrResponseEntity of type application/json

A task to monitor the operation progress.

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	},
	"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"
}
_meta Optional

Response meta data. Contains data about the response payload data.

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


404

Not Found - server cannot find the requested in URL resource


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

PowerCLI Client SDK Example

$ReprotectPlanSpec = Initialize-SrmReprotectPlanSpec -Forced $false
Invoke-SrmRunReprotect -pairingId "MypairingId" -planId "MyplanId" -reprotectPlanSpec $reprotectPlanSpec

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"forced":false}' https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/actions/reprotect
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
    permissions:
        - System.Read
        - VcDr.RecoveryProfile.com.vmware.vcDr.Reprotect
x-dr-remote-site-connectivity-contract:
    not-authenticated: ERROR
    server-down: ERROR


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

Was this page helpful?