oracle.oci.oci_disaster_recovery_dr_plan_execution – Manage a DrPlanExecution resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.14.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_disaster_recovery_dr_plan_execution.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a DrPlanExecution resource in Oracle Cloud Infrastructure

  • For state=present, execute a DR Plan for a DR Protection Group.

  • This resource has the following action operations in the oracle.oci.oci_disaster_recovery_dr_plan_execution_actions module: cancel, ignore, pause, resume, retry.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
display_name
string
The display name of the DR Plan Execution.
Example: `Execution - EBS Switchover PHX to IAD`
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
dr_plan_execution_id
string
The OCID of the DR Plan Execution.
Example: `ocid1.drplanexecution.oc1.iad.exampleocid`
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
dr_protection_group_id
string
The OCID of the DR Protection Group. Mandatory query param.
Example: `ocid1.drprotectiongroup.oc1.phx.exampleocid`
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
execution_options
dictionary
Required for create using state=present.
are_prechecks_enabled
boolean
    Choices:
  • no
  • yes
A flag indicating whether a precheck should be executed before the plan.
Example: `false`
Applicable when plan_execution_type is one of ['SWITCHOVER', 'FAILOVER']
are_warnings_ignored
boolean
    Choices:
  • no
  • yes
A flag indicating whether warnigs should be ignored during the switchover.
Example: `true`
plan_execution_type
string / required
    Choices:
  • SWITCHOVER_PRECHECK
  • FAILOVER_PRECHECK
  • SWITCHOVER
  • FAILOVER
The type of the plan execution.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}`
This parameter is updatable.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
plan_id
string
The OCID of the DR Plan.
Example: `ocid1.drplan.oc1.iad.exampleocid2`
Required for create using state=present.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
state
string
    Choices:
  • present ←
  • absent
The state of the DrPlanExecution.
Use state=present to create or update a DrPlanExecution.
Use state=absent to delete a DrPlanExecution.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create dr_plan_execution
  oci_disaster_recovery_dr_plan_execution:
    # required
    plan_id: "ocid1.plan.oc1..xxxxxxEXAMPLExxxxxx"
    execution_options:
      # required
      plan_execution_type: SWITCHOVER_PRECHECK

      # optional
      are_warnings_ignored: true

    # optional
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update dr_plan_execution
  oci_disaster_recovery_dr_plan_execution:
    # required
    dr_plan_execution_id: "ocid1.drplanexecution.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update dr_plan_execution using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_disaster_recovery_dr_plan_execution:
    # required
    display_name: display_name_example
    dr_protection_group_id: "ocid1.drprotectiongroup.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete dr_plan_execution
  oci_disaster_recovery_dr_plan_execution:
    # required
    dr_plan_execution_id: "ocid1.drplanexecution.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete dr_plan_execution using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_disaster_recovery_dr_plan_execution:
    # required
    display_name: display_name_example
    dr_protection_group_id: "ocid1.drprotectiongroup.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
dr_plan_execution
complex
on success
Details of the DrPlanExecution resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'dr_protection_group_id': 'ocid1.drprotectiongroup.oc1..xxxxxxEXAMPLExxxxxx', 'execution_duration_in_sec': 56, 'execution_options': {'are_prechecks_enabled': True, 'are_warnings_ignored': True, 'plan_execution_type': 'SWITCHOVER'}, 'freeform_tags': {'Department': 'Finance'}, 'group_executions': [{'display_name': 'display_name_example', 'execution_duration_in_sec': 56, 'group_id': 'ocid1.group.oc1..xxxxxxEXAMPLExxxxxx', 'status': 'QUEUED', 'status_details': 'status_details_example', 'step_executions': [{'display_name': 'display_name_example', 'execution_duration_in_sec': 56, 'group_id': 'ocid1.group.oc1..xxxxxxEXAMPLExxxxxx', 'log_location': {'bucket': 'bucket_example', 'namespace': 'namespace_example', 'object': 'object_example'}, 'status': 'QUEUED', 'status_details': 'status_details_example', 'step_id': 'ocid1.step.oc1..xxxxxxEXAMPLExxxxxx', 'time_ended': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00', 'type': 'COMPUTE_INSTANCE_STOP_PRECHECK'}], 'time_ended': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00', 'type': 'USER_DEFINED'}], 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'life_cycle_details': 'life_cycle_details_example', 'lifecycle_state': 'ACCEPTED', 'log_location': {'bucket': 'bucket_example', 'namespace': 'namespace_example', 'object': 'object_example'}, 'peer_dr_protection_group_id': 'ocid1.peerdrprotectiongroup.oc1..xxxxxxEXAMPLExxxxxx', 'peer_region': 'us-phoenix-1', 'plan_execution_type': 'SWITCHOVER', 'plan_id': 'ocid1.plan.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_ended': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
compartment_id
string
on success
The OCID of the compartment containing this DR Plan Execution.
Example: `ocid1.compartment.oc1..exampleocid1`

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
The display name of this DR Plan Execution.
Example: `Execution - EBS Switchover PHX to IAD`

Sample:
display_name_example
 
dr_protection_group_id
string
on success
The OCID of the DR Protection Group to which this DR Plan Execution belongs.
Example: `ocid1.drprotectiongroup.oc1.iad.exampleocid2`

Sample:
ocid1.drprotectiongroup.oc1..xxxxxxEXAMPLExxxxxx
 
execution_duration_in_sec
integer
on success
The total duration in seconds taken to complete the DR Plan Execution.
Example: `750`

Sample:
56
 
execution_options
complex
on success

   
are_prechecks_enabled
boolean
on success
A flag indicating whether a precheck was executed before the plan.
Example: `true`

Sample:
True
   
are_warnings_ignored
boolean
on success
A flag indicating whether warnigs was ignored during the failover.
Example: `false`

Sample:
True
   
plan_execution_type
string
on success
The type of the plan execution.

Sample:
SWITCHOVER
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
group_executions
complex
on success
A list of groups executed in this DR Plan Execution.

   
display_name
string
on success
The display name of group that was executed.
Example: `DATABASE_SWITCHOVER`

Sample:
display_name_example
   
execution_duration_in_sec
integer
on success
The total duration in seconds taken to complete group execution.
Example: `120`

Sample:
56
   
group_id
string
on success
The unique id of the group. Must not be modified by user.
Example: `sgid1.group..examplegroupsgid`

Sample:
ocid1.group.oc1..xxxxxxEXAMPLExxxxxx
   
status
string
on success
The status of the group execution.

Sample:
QUEUED
   
status_details
string
on success
Additional details about the group execution status.
Example: `A total of three steps failed in the group`

Sample:
status_details_example
   
step_executions
complex
on success
A list of details of each step executed in this group.

     
display_name
string
on success
The display name of the step.
Example: `DATABASE_SWITCHOVER`

Sample:
display_name_example
     
execution_duration_in_sec
integer
on success
The total duration in seconds taken to complete step execution.
Example: `35`

Sample:
56
     
group_id
string
on success
The unique id of the group to which this step belongs. Must not be modified by user.
Example: `sgid1.group..examplegroupsgid`

Sample:
ocid1.group.oc1..xxxxxxEXAMPLExxxxxx
     
log_location
complex
on success

       
bucket
string
on success
The bucket name inside the Object Storage namespace.
Example: `operation_logs`

Sample:
bucket_example
       
namespace
string
on success
The namespace in Object Storage (Note - this is usually the tenancy name).
Example: `myocitenancy`

Sample:
namespace_example
       
object
string
on success
The object name inside the Object Storage bucket.
Example: `switchover_plan_executions`

Sample:
object_example
     
status
string
on success
The status of the step execution.

Sample:
QUEUED
     
status_details
string
on success
Additional details about the step execution status.
Example: `This step failed to complete due to a timeout`

Sample:
status_details_example
     
step_id
string
on success
The unique id of this step. Must not be modified by user.
Example: `sgid1.step..examplestepsgid`

Sample:
ocid1.step.oc1..xxxxxxEXAMPLExxxxxx
     
time_ended
string
on success
The time at which step execution ended. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`

Sample:
2013-10-20T19:20:30+01:00
     
time_started
string
on success
The time at which step execution began. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`

Sample:
2013-10-20T19:20:30+01:00
     
type
string
on success
The plan step type.

Sample:
COMPUTE_INSTANCE_STOP_PRECHECK
   
time_ended
string
on success
The time at which group execution ended. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`

Sample:
2013-10-20T19:20:30+01:00
   
time_started
string
on success
The time at which group execution began. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`

Sample:
2013-10-20T19:20:30+01:00
   
type
string
on success
The plan group type.

Sample:
USER_DEFINED
 
id
string
on success
The OCID of the DR Plan Execution.
Example: `ocid1.drplanexecution.oc1.iad.exampleocid2`

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
life_cycle_details
string
on success
A message describing the DR Plan Execution's current state in more detail.
Example: `The DR Plan Execution [Execution - EBS Switchover PHX to IAD] is currently in progress`

Sample:
life_cycle_details_example
 
lifecycle_state
string
on success
The current state of the DR Plan Execution.

Sample:
ACCEPTED
 
log_location
complex
on success

   
bucket
string
on success
The bucket name inside the Object Storage namespace.
Example: `operation_logs`

Sample:
bucket_example
   
namespace
string
on success
The namespace in Object Storage (Note - this is usually the tenancy name).
Example: `myocitenancy`

Sample:
namespace_example
   
object
string
on success
The object name inside the Object Storage bucket.
Example: `switchover_plan_executions`

Sample:
object_example
 
peer_dr_protection_group_id
string
on success
The OCID of peer (remote) DR Protection Group associated with this plan's DR Protection Group.
Example: `ocid1.drprotectiongroup.oc1.phx.exampleocid1`

Sample:
ocid1.peerdrprotectiongroup.oc1..xxxxxxEXAMPLExxxxxx
 
peer_region
string
on success
The region of the peer (remote) DR Protection Group.
Example: `us-ashburn-1`

Sample:
us-phoenix-1
 
plan_execution_type
string
on success
The type of the DR Plan executed.

Sample:
SWITCHOVER
 
plan_id
string
on success
The OCID of the DR Plan.
Example: `ocid1.drplan.oc1.iad.exampleocid2`

Sample:
ocid1.plan.oc1..xxxxxxEXAMPLExxxxxx
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

 
time_created
string
on success
The date and time at which DR Plan Execution was created. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_ended
string
on success
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`

Sample:
2013-10-20T19:20:30+01:00
 
time_started
string
on success
The date and time at which DR Plan Execution began. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time at which DR Plan Execution was last updated. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)