Run Recovery
DescriptionRun the 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 planned recovery settings.
{
"migrate_eligible_vms": false,
"planned_failover": false,
"skip_protection_site_operations": false,
"sync_data": false
}
Whether we should perform xVC-vMotion for eligible VMs during the planned failover workflow. If this option is set, failover will attempt to use xVC-vMotion for all protected powered on VMs residing on stretched storage at the protected site. If this option is not set, failover will be performed using the regular recovery workflow for replicated LUNs (including stretched devices). This option will be available only for planned failover. If xVC-vMotion fails for any reason, the recovery plan will stop with appropriate error. Must be true if vMotion is supported.
Whether this recover operation is a planned failover. Planned failovers will attempt to restore the protection site to the original state if an error (or user cancellation) occurs before the storage steps.
Skips all recovery plan operation that involve communication with the protection site. These include: shutting down of protected VMs, syncing, and deactivating. If set to true, sync_data setting is ignored and assumed to be false. This flag is ignored if planned_failover is set to true. In order to set to true, first activate recovery.forceRecovery advanced setting.
Whether to call the replication providers to synchronize the outstanding data before the operation.
Authentication
Response
Response BodyResponse Body
202 Accepted
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
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.Failover
x-dr-remote-site-connectivity-contract:
not-authenticated: ERROR
server-down: DEPENDS_ON_PROVIDED_PARAMS
