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

Create Plan

Description

Create a new recovery plan in a given pairing.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
pairing_id Required

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


Request Body

Request Body

RecoveryPlanCreateSpec of mimetype application/json Required

A spec describing the new plan.

{
	"name": "string",
	"protected_vc_guid": "string"
}
string
name Required

Name of the recovery plan


string as uuid
protected_vc_guid Required

GUID of the protected site VC.


string
description Optional

Description of the recovery plan.


string
location Optional

Target location where the recovery plan will be placed. If not specified - the root folder will be used.


array of string
protection_groups Optional

A list of protection groups to be added to the recovery plan.


test_network_mappings Optional

A list of test network mappings to be added to the recovery plan.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted

Returns TaskDrResponseEntity of type application/json

Recovery plan creation task

{
	"_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

$TestNetworkMappingsSpec = Initialize-SrmTestNetworkMappingsSpec -TargetNetwork "MyTargetNetwork" -TestNetwork "MyTestNetwork"
$RecoveryPlanCreateSpec = Initialize-SrmRecoveryPlanCreateSpec -Location "MyLocation" -Name "MyName" -Description "MyDescription" -ProtectedVcGuid "MyProtectedVcGuid" -ProtectionGroups "MyProtectionGroups" -TestNetworkMappings $TestNetworkMappingsSpec
Invoke-SrmCreatePlan -pairingId "MypairingId" -recoveryPlanCreateSpec $recoveryPlanCreateSpec

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"description":"string","location":"string","name":"string","protected_vc_guid":"string","protection_groups":["string"],"test_network_mappings":[{"target_network":"string","test_network":"string"}]}' https://{api_host}/pairings/{pairing_id}/recovery-management/plans
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.Create
        - VcDr.ProtectionProfile.com.vmware.vcDr.AssignToRecoveryPlan
x-dr-remote-site-connectivity-contract:
    not-authenticated: DEPENDS_ON_PROVIDED_PARAMS
    server-down: DEPENDS_ON_PROVIDED_PARAMS


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

Was this page helpful?