RecoveryPlanDetails

RecoveryPlanDetails
RecoveryPlanDetails

Detailed information for recovery plans.

JSON Example
{
    "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.

RecoveryPlanStatus
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,
RecoveryPlanState
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 ProtectionGroupSummary
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 RecoveryPlanComplianceResult
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.

Property Of
Returned By