Run Cleanup Test Recovery
DescriptionRun a cleanup test recovery for this recovery plan.
Request
URLURL
Path Parameters
Path Parameters
The ID of a pairing between this Site Recovery Manager server and remote one
The ID of a recovery plan defined within current pairing
Request Body
A spec describing the cleanup test recovery settings.
{
"forced": false
}
Whether to force the cleanup operation. If true, it 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
Response
Response BodyResponse Body
202 Accepted
A task to monitor the operation progress.
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
]
},
"complete_time": "string",
"description": "string",
"description_id": "string",
"entity": "string",
"entity_name": "string",
"error": {
"details": "string",
"message": "string"
},
"id": "string",
"progress": 0,
"queued_time": "string",
"result": {},
"start_time": "string",
"status": "QUEUED"
}
Errors
Bad request - the server could not understand the request due to invalid syntax or invalid request body content
Unauthorized - the client must authenticate itself to get the requested response
Forbidden - not sufficient access rights to fulfill the request
Not Found - server cannot find the requested in URL resource
Internal server error - unexpected condition prevents fulfilling the request
Code Samples
PowerCLI Client SDK Example
cURL Command
Vendor Extensions
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
