Run Test Recovery

Run Test Recovery

Run a test recovery for this recovery plan, leaving the primary site unaffected.

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

Spec describing test recovery settings

TestPlanSpec of type(s) application/json
Required
{
    "sync_data": false
}
boolean
sync_data
Optional

Whether to call the replication providers to synchronize the outstanding data before the operation

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/test
                
Recovery Operations
GET
Get All Plan History Records
GET
Get Recovery Plan Folders
POST
Create Recovery Plan Folder
GET
Get Recovery Plan Folder
DELETE
Delete Recovery Plan Folder
POST
Move Recovery Plan Folder
POST
Rename Recovery Plan Folder
GET
Get Recovery Plan Folder Children
GET
Get All Recovery Plans
POST
Create Plan
GET
Get Recovery Plan
DELETE
Delete Recovery Plan
POST
Cancel Recovery Plan
POST
Run Cleanup Test Recovery
POST
Reconfigure Recovery Plan
POST
Run Recovery
POST
Run Reprotect
POST
Run Test Recovery
GET
Get Plan History Records
GET
Get Plan History Record
GET
Get Recovery Plan Issues
GET
Get Plan Related Protection Groups
GET
Get Recovery Steps User Prompts
GET
Get Recovery Steps User Prompt
POST
Dismiss Recovery Steps Recovery Plan Prompt
GET
Get Recovery Steps
POST
Create Recovery Steps Callout
GET
Get Recovery Step
DELETE
Delete Recovery Step
GET
Get Recovery Steps Callout Details
POST
Edit Recovery Steps Callout
GET
Get Plan Related Test Networks
GET
Get Plan Virtual Machines
GET
Get Plan Virtual Machine
GET
Get Plan Virtual Machine Recovery Settings
POST
Update Plan Virtual Machine Recovery Settings
GET
Get Plan Virtual Machine Dependent Vms
POST
Update Plan Virtual Machine Dependent Vms
POST
Plan Virtual Machine Check Dependent Vms
GET
Get Plan Virtual Machine Ip Customization
POST
Update Plan Virtual Machine Ip Customization
GET
Get Plan Virtual Machine Recovery Priority
PUT
Update Plan Virtual Machine Recovery Priority
GET
Get Plan Virtual Machine Summarized Recovery Settings