RecoveryPlanJob#
- class RecoveryPlanJob(name=None, recovery_plan_ext_id=None, failover_directions=None, action_type=None, recovery_reference_time=None, is_live_migrate_v_ms=None, start_time=None, end_time=None, status=None, percentage_complete=None, validation_status=None, execution_phases=None, is_initiated_by_witness=None, owner_ext_id=None, is_instant_restore=None, ext_id=None, links=None, tenant_id=None, *args, **kwargs)#
Bases:
ExternalizableAbstractModelA recovery plan job specification describing the recovery plan to be executed, failover directions and type of failover.
- Parameters:
name (max=256 chars) – (
name) Name of the Recovery Plan Job.recovery_plan_ext_id – (
recovery_plan_ext_id) The external identifier of the recovery plan.failover_directions – (
failover_directions) List of failover directions from source disaster recovery location to target disaster recovery location.<br> For example, when failing over virtual machines (VMs) and volume groups from clusters C1, C2 registered to domain manager PC1 on source location to cluster C3 registered to domain manager PC1 on target location, there must be one direction between source location (PC1, C1) to target location (PC1, C3) and another mapping between source location (PC1, C2) and target location (PC1, C3).<br> Domain manager is a required parameter while describing disaster recovery location in failover directions.<br> When creating a Recovery Plan Job across two domain managers, the source clusters are not required.<br> Failover direction contains clusters only when failing over between primary and secondary clusters registered to the same domain manager.action_type – (
action_type)recovery_reference_time – (
recovery_reference_time) Point in time from which to restore the entities during an UNPLANNED_FAILOVER operation. Only ISO-8601 formatted timestamps are supported. For example, 2023-01-02T03:04:05Z.<br> When specified, virtual machines (VMs) and volume groups are restored from the latest recovery points created on or before the specified timestamp. If not specified, virtual machines (VMs) and volume groups are restored from the latest recovery points created on or before the start of the Recovery plan job.is_live_migrate_v_ms – (
is_live_migrate_v_ms) Indicates whether to perform a live migration of virtual machines (VMs) during a PLANNED_FAILOVER operation. When not specified or specified as false, the migration is performed for all virtual machines (VMs) in offline mode. When specified as true, the migration is performed for all virtual machines (VMs) in a running state.start_time – (
start_time) Recovery plan job start time in ISO-8601 format.end_time – (
end_time) Recovery plan job completion time in ISO-8601 format.status – (
status)percentage_complete (min=0, max=100) – (
percentage_complete) Percentage complete for the recovery plan job.validation_status – (
validation_status)execution_phases – (
execution_phases) Summary of all the phases involved in the recovery plan job execution:<br> - Pre-processing: Actions carried out prior to the recovery of entities, such as creating a network or synchronizing recovery points as part of a PLANNED_FAILOVER operation.<br> - Entity recovery: Steps performed for the recovery of the entities for the recovery plan job.<br> - Post-processing: Actions taken after the recovery of entities, such as creating a Consistency group or auditing the recovery plan job information.is_initiated_by_witness – (
is_initiated_by_witness) Indicates whether the recovery plan job was initiated by the witness or not.owner_ext_id – (
owner_ext_id) External identifier of the owner of the recovery plan job.is_instant_restore – (
is_instant_restore) Indicates whether to enable Instant Restore. This feature allows a workload, such as a virtual machine (VM), to be quickly restored and powered on directly from an external backup repository on a Nutanix AOS cluster, without waiting for a full data transfer.
- property action_type#
- Type:
- property end_time#
Recovery plan job completion time in ISO-8601 format.
- Type:
datetime
- property execution_phases#
Summary of all the phases involved in the recovery plan job execution:<br> - Pre-processing: Actions carried out prior to the recovery of entities, such as creating a network or synchronizing recovery points as part of a PLANNED_FAILOVER operation.<br> - Entity recovery: Steps performed for the recovery of the entities for the recovery plan job.<br> - Post-processing: Actions taken after the recovery of entities, such as creating a Consistency group or auditing the recovery plan job information.
- Type:
list[
PhaseSummary]
- property failover_directions#
List of failover directions from source disaster recovery location to target disaster recovery location.<br> For example, when failing over virtual machines (VMs) and volume groups from clusters C1, C2 registered to domain manager PC1 on source location to cluster C3 registered to domain manager PC1 on target location, there must be one direction between source location (PC1, C1) to target location (PC1, C3) and another mapping between source location (PC1, C2) and target location (PC1, C3).<br> Domain manager is a required parameter while describing disaster recovery location in failover directions.<br> When creating a Recovery Plan Job across two domain managers, the source clusters are not required.<br> Failover direction contains clusters only when failing over between primary and secondary clusters registered to the same domain manager.
- Type:
list[
FailoverDirection]
- property is_initiated_by_witness#
Indicates whether the recovery plan job was initiated by the witness or not.
- Type:
bool
- property is_instant_restore#
Indicates whether to enable Instant Restore. This feature allows a workload, such as a virtual machine (VM), to be quickly restored and powered on directly from an external backup repository on a Nutanix AOS cluster, without waiting for a full data transfer.
- Type:
bool
- property is_live_migrate_v_ms#
Indicates whether to perform a live migration of virtual machines (VMs) during a PLANNED_FAILOVER operation. When not specified or specified as false, the migration is performed for all virtual machines (VMs) in offline mode. When specified as true, the migration is performed for all virtual machines (VMs) in a running state.
- Type:
bool
- property name#
Name of the Recovery Plan Job.
- Type:
str
- property owner_ext_id#
External identifier of the owner of the recovery plan job.
- Type:
str
- property percentage_complete#
Percentage complete for the recovery plan job.
- Type:
int
- property recovery_plan_ext_id#
The external identifier of the recovery plan.
- Type:
str
- property recovery_reference_time#
Point in time from which to restore the entities during an UNPLANNED_FAILOVER operation. Only ISO-8601 formatted timestamps are supported. For example, 2023-01-02T03:04:05Z.<br> When specified, virtual machines (VMs) and volume groups are restored from the latest recovery points created on or before the specified timestamp. If not specified, virtual machines (VMs) and volume groups are restored from the latest recovery points created on or before the start of the Recovery plan job.
- Type:
datetime
- property start_time#
Recovery plan job start time in ISO-8601 format.
- Type:
datetime
- property status#
- to_dict()#
Returns the model properties as a dictionary
- to_str()#
Returns the string representation of the model