Run Recovery

Run Recovery

Run the recovery for this recovery plan.

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

RecoverPlanSpec of type(s) application/json
Required
{
    "skip_protection_site_operations": false,
    "migrate_eligible_vms": false,
    "sync_data": false,
    "planned_failover": false
}
boolean
skip_protection_site_operations
Optional

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. To set to true, you must first enable the recovery.forceRecovery advanced setting.

boolean
migrate_eligible_vms
Optional

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.

boolean
sync_data
Optional

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

boolean
planned_failover
Optional

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.

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: Task
{
    "id": "string",
    "description": "string",
    "description_id": "string",
    "entity": "string",
    "entity_name": "string",
    "status": "string",
    "error": {
        "message": "string",
        "details": "string"
    },
    "progress": 0,
    "queued_time": "string",
    "start_time": "string",
    "complete_time": "string",
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ]
    }
}
_meta
Optional

_meta


400

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

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id


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
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id


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
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id