Get Recovery Plan Details

Get Recovery Plan Details

Get details for the requested recovery plan.

Request
URI
GET
https://{api_host}/api/vcdr/v1/cloud-file-systems/{cloud_file_system_id}/recovery-plans/{id}
COPY
Path Parameters
string
cloud_file_system_id
Required

The cloud file system containing the recovery plan of interest.

string
id
Required

The recovery plan of interest.

Authentication
This operation uses the following authentication methods.
Responses
200

OK. The request succeeded.

Returns RecoveryPlanDetails of type(s) application/json 
{
    "id": "string",
    "name": "string",
    "status": "string",
    "state": "string",
    "vcenter_name": "string",
    "protection_groups": [
        {
            "id": "string",
            "name": "string"
        }
    ],
    "protected_site_id": "string",
    "recovery_site_id": "string",
    "compliance_results": [
        {
            "check_type": "string",
            "compliance_status": "string",
            "status_details": "string",
            "status_since": 0
        }
    ],
    "plan_enabled": false,
    "ransomware_recovery_enabled": false
}
string
id
Optional

The unique identifier of the recovery plan.

string
name
Optional

The name of the recovery plan.

string
status
Optional

The status of a recovery plan.

  • RP_STATUS_UNKNOWN: The recovery plan status could not be determined.
  • RP_STATUS_OK: There are no known problems.
  • RP_STATUS_WARNING: There are issues that may require attention. There are warnings in compliance checks.
  • RP_STATUS_CRITICAL: The recovery plan is failing to work as intended. There are errors in compliance checks.

Possible values are : RP_STATUS_UNKNOWN, RP_STATUS_OK, RP_STATUS_WARNING, RP_STATUS_CRITICAL,
string
state
Optional

The state of the recovery plan.

  • RP_STATE_UNKNOWN: The plan state could not be determined.
  • RP_STATE_READY: Plan cannot be used for test failover since test site is not specified but failover site is specified and plan is ready for failover.
  • RP_STATE_DISABLED: Plan is in disabled state. No scheduled compliance check or test/failover can be done at this stage.
  • RP_STATE_INCOMPLETE: Plan is in incomplete state which means destination may not be known.
  • RP_STATE_TESTABLE: Plan cannot be used for failover since failover site is not specified but test site is specified and plan is testable.
  • RP_STATE_PLANNED_FAILING_OVER: Planned failover is in progress.
  • RP_STATE_UNPLANNED_FAILING_OVER: Unplanned failover is in progress.
  • RP_STATE_TEST_FAILING_OVER: Test failover is in progress.
  • RP_STATE_TESTABLE_AND_READY: Plan is in ready state to start execution of any failover type.
  • RP_STATE_FAILOVER_COMMITTED: Plan is in failed over state after successful commit. In this state, the plan is disabled and cannot be run.
  • RP_STATE_RANSOMWARE_RECOVERY_STARTED: Plan is in ransomware recovery state. Individual VMs are ready to be worked on.
  • RP_STATE_RANSOMWARE_TEST_STARTED: Plan is in ransomware test state. Individual VMs are ready to be tested.

Possible values are : RP_STATE_UNKNOWN, RP_STATE_READY, RP_STATE_DISABLED, RP_STATE_INCOMPLETE, RP_STATE_TESTABLE, RP_STATE_PLANNED_FAILING_OVER, RP_STATE_UNPLANNED_FAILING_OVER, RP_STATE_TEST_FAILING_OVER, RP_STATE_TESTABLE_AND_READY, RP_STATE_FAILOVER_COMMITTED, RP_STATE_RANSOMWARE_RECOVERY_STARTED, RP_STATE_RANSOMWARE_TEST_STARTED,
string
vcenter_name
Optional

The source site vCenter server name.

array of object
protection_groups
Optional

The protection groups that are part of the recovery plan.

string
protected_site_id
Optional

The ID of the protected site associated with this recovery plan.

string
recovery_site_id
Optional

The ID of the recovery site associated with this recovery plan

array of object
compliance_results
Optional

Compliance results from the last run of this recovery plan.

boolean
plan_enabled
Optional

Indicates if the recovery plan is enabled. Plan needs to be enabled for failover, test failover or to run compliance checks.

boolean
ransomware_recovery_enabled
Optional

Indicates if ransomware recovery is enabled for this recovery plan.


400

Bad request. The server could not understand the request.

Operation doesn't return any data structure

401

Unauthorized. The client has not authenticated.

Operation doesn't return any data structure

403

Forbidden. The client is not authorized.

Operation doesn't return any data structure

404

Not found. The server cannot find the specified resource.

Operation doesn't return any data structure

500

VMware Live Cyber Recovery-specific error.
An error unique to VMware Live Cyber Recovery was encountered while attempting to satisfy the request. See the returned object for details on the error.

Returns Error of type(s) application/json 
"Error Object"
array of object
messages
Optional

A stack or error messages. The first element (top of the stack) is the broadest description of the failure.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcdr/v1/cloud-file-systems/{cloud_file_system_id}/recovery-plans/{id}
On This Page
Recovery Plan Operations
GET
Get Recovery Plans
GET
Get Recovery Plan Details
POST
Get Recovery Plan Batch Details