Reconfigure Recovery Plan

Reconfigure Recovery Plan

Reconfigure settings for this recovery plan.

Request
URI
POST
https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/actions/reconfigure
COPY
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

A spec describing the new recovery plan settings.

RecoveryPlanEditSpec of type(s) application/json
Required
{
    "name": "string",
    "description": "string",
    "protected_vc_guid": "string",
    "protection_groups": [
        "string"
    ],
    "test_network_mappings": [
        {
            "target_network": "string",
            "test_network": "string"
        }
    ],
    "vms_to_suspend": [
        "string"
    ]
}
string
name
Optional

Name of the recovery plan. If null - the name will not be changed.

string
description
Optional

Description of the recovery plan. If null - the description will not be updated.

string
protected_vc_guid
Optional

GUID of the protected site vCenter Server. Use in order to change recovery plan direction. Plan direction change is possible when there are no protection groups in the plan. If null - will not try to change the direction of the recovery plan.

array of string
protection_groups
Optional

A list of protection groups to be added to the recovery plan.Protection groups currently in the recovery plan and not in this list will be removed from the recovery plan.If null - no change in the protection groups will be done.

array of object
test_network_mappings
Optional

A list of test network mappings to be used for the recovery plan.If existing test network mapping is not part of the list - it will be removed from the recovery plan and site-level mapping will be used.If at site level there is no test network mapping defined, an isolated test network will be created during test operation.If null - no changes in the test network mappings will be done.

array of string
vms_to_suspend
Optional

A list of VMs to be suspended during recovery. Must contain references for VMs from the recovery site.If a currently suspended VM is not part of this spec when modifying the recovery plan, it will not be suspended anymore.If null - VMs to be suspended will not be changed.

Authentication
This operation uses the following authentication methods.
Responses
202

A task to monitor the operation progress.

Returns TaskDrResponseEntity of type(s) application/json
This response body class contains all of the following: InlineTaskDrResponseEntity0 , InlineTaskDrResponseEntity1
"TaskDrResponseEntity Object"

400

Bad request - the server cannot understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json
"ResponseError Object"
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
"ResponseError Object"
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.


404

Not Found - server cannot find the requested in URL resource

Operation doesn't return any data structure

500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json
"ResponseError Object"
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.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/actions/reconfigure