[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
Run Test Recovery
DescriptionRun a test recovery for this recovery plan, leaving the primary site unaffected.
Request
URLURL
https://{api_host}//pairings/{pairing_id}/recovery-management/plans/{plan_id}/actions/test
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
{
"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.
Response
Response
Response BodyResponse 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"
}
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
PowerCLI Client SDK Example
$TestPlanSpec = Initialize-SrmTestPlanSpec -SyncData $false
Invoke-SrmRunTestRecovery -pairingId "MypairingId" -planId "MyplanId" -testPlanSpec $testPlanSpec
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"sync_data":false}' https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/actions/test
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
permissions:
- System.Read
- VcDr.RecoveryProfile.com.vmware.vcDr.Run
x-dr-remote-site-connectivity-contract:
not-authenticated: ERROR
server-down: DEPENDS_ON_PROVIDED_PARAMS
[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
On This Page
Recovery Operations
post
post
post
Create Recovery Plan Folder
Introduced
post
Create Recovery Steps Callout
Introduced
delete
delete
Delete Recovery Plan Folder
Introduced
delete
Delete Recovery Step
Introduced
post
Dismiss Recovery Steps Recovery Plan Prompt
Introduced
post
Edit Recovery Steps Callout
Introduced
get
Get Recovery Plan Folder
Introduced
get
Get Recovery Plan Folder Children
Introduced
get
Get Recovery Plan Folders
Introduced
get
Get Recovery Step
Introduced
get
Get Recovery Steps
Introduced
get
Get Recovery Steps Callout Details
Introduced
get
Get Recovery Steps User Prompt
Introduced
get
Get Recovery Steps User Prompts
Introduced
post
Move Recovery Plan Folder
Introduced
post
Rename Recovery Plan Folder
Introduced
post
post
post
