DrPlanExecution¶

class oci.disaster_recovery.models.DrPlanExecution(**kwargs)¶

Bases: object

The details of a DR plan execution.

Attributes

`LIFECYCLE_STATE_ACCEPTED`	A constant which can be used with the lifecycle_state property of a DrPlanExecution.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a DrPlanExecution.
`LIFECYCLE_STATE_CANCELING`	A constant which can be used with the lifecycle_state property of a DrPlanExecution.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DrPlanExecution.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DrPlanExecution.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DrPlanExecution.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a DrPlanExecution.
`LIFECYCLE_STATE_PAUSED`	A constant which can be used with the lifecycle_state property of a DrPlanExecution.
`LIFECYCLE_STATE_PAUSING`	A constant which can be used with the lifecycle_state property of a DrPlanExecution.
`LIFECYCLE_STATE_RESUMING`	A constant which can be used with the lifecycle_state property of a DrPlanExecution.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a DrPlanExecution.
`LIFECYCLE_STATE_WAITING`	A constant which can be used with the lifecycle_state property of a DrPlanExecution.
`PLAN_EXECUTION_TYPE_FAILOVER`	A constant which can be used with the plan_execution_type property of a DrPlanExecution.
`PLAN_EXECUTION_TYPE_FAILOVER_PRECHECK`	A constant which can be used with the plan_execution_type property of a DrPlanExecution.
`PLAN_EXECUTION_TYPE_START_DRILL`	A constant which can be used with the plan_execution_type property of a DrPlanExecution.
`PLAN_EXECUTION_TYPE_START_DRILL_PRECHECK`	A constant which can be used with the plan_execution_type property of a DrPlanExecution.
`PLAN_EXECUTION_TYPE_STOP_DRILL`	A constant which can be used with the plan_execution_type property of a DrPlanExecution.
`PLAN_EXECUTION_TYPE_STOP_DRILL_PRECHECK`	A constant which can be used with the plan_execution_type property of a DrPlanExecution.
`PLAN_EXECUTION_TYPE_SWITCHOVER`	A constant which can be used with the plan_execution_type property of a DrPlanExecution.
`PLAN_EXECUTION_TYPE_SWITCHOVER_PRECHECK`	A constant which can be used with the plan_execution_type property of a DrPlanExecution.
`compartment_id`	[Required] Gets the compartment_id of this DrPlanExecution.
`defined_tags`	Gets the defined_tags of this DrPlanExecution.
`display_name`	[Required] Gets the display_name of this DrPlanExecution.
`dr_protection_group_id`	[Required] Gets the dr_protection_group_id of this DrPlanExecution.
`execution_duration_in_sec`	Gets the execution_duration_in_sec of this DrPlanExecution.
`execution_options`	[Required] Gets the execution_options of this DrPlanExecution.
`freeform_tags`	Gets the freeform_tags of this DrPlanExecution.
`group_executions`	[Required] Gets the group_executions of this DrPlanExecution.
`id`	[Required] Gets the id of this DrPlanExecution.
`life_cycle_details`	Gets the life_cycle_details of this DrPlanExecution.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DrPlanExecution.
`log_location`	[Required] Gets the log_location of this DrPlanExecution.
`peer_dr_protection_group_id`	[Required] Gets the peer_dr_protection_group_id of this DrPlanExecution.
`peer_region`	[Required] Gets the peer_region of this DrPlanExecution.
`plan_execution_type`	[Required] Gets the plan_execution_type of this DrPlanExecution.
`plan_id`	[Required] Gets the plan_id of this DrPlanExecution.
`system_tags`	Gets the system_tags of this DrPlanExecution.
`time_created`	[Required] Gets the time_created of this DrPlanExecution.
`time_ended`	Gets the time_ended of this DrPlanExecution.
`time_started`	Gets the time_started of this DrPlanExecution.
`time_updated`	[Required] Gets the time_updated of this DrPlanExecution.

Methods

__init__(**kwargs) Initializes a new DrPlanExecution object with values from keyword arguments.

LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the lifecycle_state property of a DrPlanExecution. This constant has a value of “ACCEPTED”

LIFECYCLE_STATE_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_state property of a DrPlanExecution. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'¶: A constant which can be used with the lifecycle_state property of a DrPlanExecution. This constant has a value of “CANCELING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a DrPlanExecution. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a DrPlanExecution. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a DrPlanExecution. This constant has a value of “FAILED”

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a DrPlanExecution. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_PAUSED = 'PAUSED'¶: A constant which can be used with the lifecycle_state property of a DrPlanExecution. This constant has a value of “PAUSED”

LIFECYCLE_STATE_PAUSING = 'PAUSING'¶: A constant which can be used with the lifecycle_state property of a DrPlanExecution. This constant has a value of “PAUSING”

LIFECYCLE_STATE_RESUMING = 'RESUMING'¶: A constant which can be used with the lifecycle_state property of a DrPlanExecution. This constant has a value of “RESUMING”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the lifecycle_state property of a DrPlanExecution. This constant has a value of “SUCCEEDED”

LIFECYCLE_STATE_WAITING = 'WAITING'¶: A constant which can be used with the lifecycle_state property of a DrPlanExecution. This constant has a value of “WAITING”

PLAN_EXECUTION_TYPE_FAILOVER = 'FAILOVER'¶: A constant which can be used with the plan_execution_type property of a DrPlanExecution. This constant has a value of “FAILOVER”

PLAN_EXECUTION_TYPE_FAILOVER_PRECHECK = 'FAILOVER_PRECHECK'¶: A constant which can be used with the plan_execution_type property of a DrPlanExecution. This constant has a value of “FAILOVER_PRECHECK”

PLAN_EXECUTION_TYPE_START_DRILL = 'START_DRILL'¶: A constant which can be used with the plan_execution_type property of a DrPlanExecution. This constant has a value of “START_DRILL”

PLAN_EXECUTION_TYPE_START_DRILL_PRECHECK = 'START_DRILL_PRECHECK'¶: A constant which can be used with the plan_execution_type property of a DrPlanExecution. This constant has a value of “START_DRILL_PRECHECK”

PLAN_EXECUTION_TYPE_STOP_DRILL = 'STOP_DRILL'¶: A constant which can be used with the plan_execution_type property of a DrPlanExecution. This constant has a value of “STOP_DRILL”

PLAN_EXECUTION_TYPE_STOP_DRILL_PRECHECK = 'STOP_DRILL_PRECHECK'¶: A constant which can be used with the plan_execution_type property of a DrPlanExecution. This constant has a value of “STOP_DRILL_PRECHECK”

PLAN_EXECUTION_TYPE_SWITCHOVER = 'SWITCHOVER'¶: A constant which can be used with the plan_execution_type property of a DrPlanExecution. This constant has a value of “SWITCHOVER”

PLAN_EXECUTION_TYPE_SWITCHOVER_PRECHECK = 'SWITCHOVER_PRECHECK'¶: A constant which can be used with the plan_execution_type property of a DrPlanExecution. This constant has a value of “SWITCHOVER_PRECHECK”

__init__(**kwargs)¶

Initializes a new DrPlanExecution object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this DrPlanExecution.
compartment_id (str) – The value to assign to the compartment_id property of this DrPlanExecution.
display_name (str) – The value to assign to the display_name property of this DrPlanExecution.
plan_id (str) – The value to assign to the plan_id property of this DrPlanExecution.
plan_execution_type (str) – The value to assign to the plan_execution_type property of this DrPlanExecution. Allowed values for this property are: “SWITCHOVER”, “SWITCHOVER_PRECHECK”, “FAILOVER”, “FAILOVER_PRECHECK”, “START_DRILL”, “START_DRILL_PRECHECK”, “STOP_DRILL”, “STOP_DRILL_PRECHECK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
execution_options (oci.disaster_recovery.models.DrPlanExecutionOptions) – The value to assign to the execution_options property of this DrPlanExecution.
dr_protection_group_id (str) – The value to assign to the dr_protection_group_id property of this DrPlanExecution.
peer_dr_protection_group_id (str) – The value to assign to the peer_dr_protection_group_id property of this DrPlanExecution.
peer_region (str) – The value to assign to the peer_region property of this DrPlanExecution.
log_location (oci.disaster_recovery.models.ObjectStorageLogLocation) – The value to assign to the log_location property of this DrPlanExecution.
time_created (datetime) – The value to assign to the time_created property of this DrPlanExecution.
time_started (datetime) – The value to assign to the time_started property of this DrPlanExecution.
time_updated (datetime) – The value to assign to the time_updated property of this DrPlanExecution.
time_ended (datetime) – The value to assign to the time_ended property of this DrPlanExecution.
execution_duration_in_sec (int) – The value to assign to the execution_duration_in_sec property of this DrPlanExecution.
group_executions (list[oci.disaster_recovery.models.DrPlanGroupExecution]) – The value to assign to the group_executions property of this DrPlanExecution.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DrPlanExecution. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “CANCELING”, “CANCELED”, “SUCCEEDED”, “FAILED”, “DELETING”, “DELETED”, “PAUSING”, “PAUSED”, “RESUMING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
life_cycle_details (str) – The value to assign to the life_cycle_details property of this DrPlanExecution.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DrPlanExecution.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DrPlanExecution.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DrPlanExecution.

compartment_id¶

[Required] Gets the compartment_id of this DrPlanExecution. The OCID of the compartment containing this DR plan execution.

Example: ocid1.compartment.oc1..uniqueID

Returns:	The compartment_id of this DrPlanExecution.
Return type:	str

defined_tags¶

Gets the defined_tags of this DrPlanExecution. Defined tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this DrPlanExecution.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this DrPlanExecution. The display name of the DR plan execution.

Example: Execution - EBS Switchover PHX to IAD

Returns:	The display_name of this DrPlanExecution.
Return type:	str

dr_protection_group_id¶

[Required] Gets the dr_protection_group_id of this DrPlanExecution. The OCID of the DR protection group to which this DR plan execution belongs.

Example: ocid1.drprotectiongroup.oc1..uniqueID

Returns:	The dr_protection_group_id of this DrPlanExecution.
Return type:	str

execution_duration_in_sec¶

Gets the execution_duration_in_sec of this DrPlanExecution. The total duration in seconds taken to complete the DR plan execution.

Example: 750

Returns:	The execution_duration_in_sec of this DrPlanExecution.
Return type:	int

execution_options¶

[Required] Gets the execution_options of this DrPlanExecution.

Returns:	The execution_options of this DrPlanExecution.
Return type:	oci.disaster_recovery.models.DrPlanExecutionOptions

freeform_tags¶

Gets the freeform_tags of this DrPlanExecution. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this DrPlanExecution.
Return type:	dict(str, str)

group_executions¶

[Required] Gets the group_executions of this DrPlanExecution. A list of groups executed in this DR plan execution.

Returns:	The group_executions of this DrPlanExecution.
Return type:	list[oci.disaster_recovery.models.DrPlanGroupExecution]

id¶

[Required] Gets the id of this DrPlanExecution. The OCID of the DR plan execution.

Example: ocid1.drplanexecution.oc1..uniqueID

Returns:	The id of this DrPlanExecution.
Return type:	str

life_cycle_details¶

Gets the life_cycle_details of this DrPlanExecution. A message describing the DR plan execution’s current state in more detail.

Returns:	The life_cycle_details of this DrPlanExecution.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this DrPlanExecution. The current state of the DR plan execution.

Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “CANCELING”, “CANCELED”, “SUCCEEDED”, “FAILED”, “DELETING”, “DELETED”, “PAUSING”, “PAUSED”, “RESUMING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this DrPlanExecution.
Return type:	str

log_location¶

[Required] Gets the log_location of this DrPlanExecution.

Returns:	The log_location of this DrPlanExecution.
Return type:	oci.disaster_recovery.models.ObjectStorageLogLocation

peer_dr_protection_group_id¶

[Required] Gets the peer_dr_protection_group_id of this DrPlanExecution. The OCID of peer DR protection group associated with this plan’s DR protection group.

Example: ocid1.drprotectiongroup.oc1..uniqueID

Returns:	The peer_dr_protection_group_id of this DrPlanExecution.
Return type:	str

peer_region¶

[Required] Gets the peer_region of this DrPlanExecution. The region of the peer DR protection group associated with this plan’s DR protection group.

Example: us-ashburn-1

Returns:	The peer_region of this DrPlanExecution.
Return type:	str

plan_execution_type¶

[Required] Gets the plan_execution_type of this DrPlanExecution. The type of the DR plan executed.

Allowed values for this property are: “SWITCHOVER”, “SWITCHOVER_PRECHECK”, “FAILOVER”, “FAILOVER_PRECHECK”, “START_DRILL”, “START_DRILL_PRECHECK”, “STOP_DRILL”, “STOP_DRILL_PRECHECK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The plan_execution_type of this DrPlanExecution.
Return type:	str

plan_id¶

[Required] Gets the plan_id of this DrPlanExecution. The OCID of the DR plan.

Example: ocid1.drplan.oc1..uniqueID

Returns:	The plan_id of this DrPlanExecution.
Return type:	str

system_tags¶

Gets the system_tags of this DrPlanExecution. Usage of system tag keys. These predefined keys are scoped to namespaces.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this DrPlanExecution.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this DrPlanExecution. The date and time at which DR plan execution was created. An RFC3339 formatted datetime string.

Example: 2019-03-29T09:36:42Z

Returns:	The time_created of this DrPlanExecution.
Return type:	datetime

time_ended¶

Gets the time_ended of this DrPlanExecution. The date and time at which DR plan execution succeeded, failed, was paused, or was canceled. An RFC3339 formatted datetime string.

Example: 2019-03-29T09:36:42Z

Returns:	The time_ended of this DrPlanExecution.
Return type:	datetime

time_started¶

Gets the time_started of this DrPlanExecution. The date and time at which DR plan execution began. An RFC3339 formatted datetime string.

Example: 2019-03-29T09:36:42Z

Returns:	The time_started of this DrPlanExecution.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this DrPlanExecution. The time when DR plan execution was last updated. An RFC3339 formatted datetime string.

Example: 2019-03-29T09:36:42Z

Returns:	The time_updated of this DrPlanExecution.
Return type:	datetime