oracle.oci.oci_disaster_recovery_dr_plan_facts – Fetches details about one or multiple DrPlan resources 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_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple DrPlan resources in Oracle Cloud Infrastructure

  • Gets a summary list of all DR Plans for a DR Protection Group.

  • If dr_plan_id is specified, the details of a single DrPlan will be returned.

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.
display_name
string
A filter to return only resources that match the entire display name given.
Example: `MY UNIQUE DISPLAY NAME`

aliases: name
dr_plan_id
string
The OCID of the DR Plan.
Example: `ocid1.drplan.oc1.iad.exampleocid`
Required to get a specific dr_plan.

aliases: id
dr_plan_type
string
    Choices:
  • SWITCHOVER
  • FAILOVER
The DR Plan type.
dr_protection_group_id
string
The OCID of the DR Protection Group. Mandatory query param.
Example: `ocid1.drprotectiongroup.oc1.phx.exampleocid`
Required to list multiple dr_plans.
lifecycle_state
string
    Choices:
  • CREATING
  • UPDATING
  • ACTIVE
  • INACTIVE
  • DELETING
  • DELETED
  • FAILED
  • NEEDS_ATTENTION
A filter to return only DR Plans that match the given lifecycleState.
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.
sort_by
string
    Choices:
  • timeCreated
  • displayName
The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
Example: `displayName`
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
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

Examples

- name: Get a specific dr_plan
  oci_disaster_recovery_dr_plan_facts:
    # required
    dr_plan_id: "ocid1.drplan.oc1..xxxxxxEXAMPLExxxxxx"

- name: List dr_plans
  oci_disaster_recovery_dr_plan_facts:
    # required
    dr_protection_group_id: "ocid1.drprotectiongroup.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    lifecycle_state: CREATING
    dr_plan_id: "ocid1.drplan.oc1..xxxxxxEXAMPLExxxxxx"
    dr_plan_type: SWITCHOVER
    display_name: display_name_example
    sort_order: ASC
    sort_by: timeCreated

Return Values

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

Key Returned Description
dr_plans
complex
on success
List of DrPlan resources

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', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'life_cycle_details': 'life_cycle_details_example', 'lifecycle_state': 'CREATING', 'peer_dr_protection_group_id': 'ocid1.peerdrprotectiongroup.oc1..xxxxxxEXAMPLExxxxxx', 'peer_region': 'us-phoenix-1', 'plan_groups': [{'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'steps': [{'display_name': 'display_name_example', 'error_mode': 'STOP_ON_ERROR', 'group_id': 'ocid1.group.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_enabled': True, 'member_id': 'ocid1.member.oc1..xxxxxxEXAMPLExxxxxx', 'timeout': 56, 'type': 'COMPUTE_INSTANCE_STOP_PRECHECK', 'user_defined_step': {'function_id': 'ocid1.function.oc1..xxxxxxEXAMPLExxxxxx', 'function_region': 'us-phoenix-1', 'object_storage_script_location': {'bucket': 'bucket_example', 'namespace': 'namespace_example', 'object': 'object_example'}, 'request_body': 'request_body_example', 'run_as_user': 'run_as_user_example', 'run_on_instance_id': 'ocid1.runoninstance.oc1..xxxxxxEXAMPLExxxxxx', 'run_on_instance_region': 'us-phoenix-1', 'script_command': 'script_command_example', 'step_type': 'RUN_OBJECTSTORE_SCRIPT_PRECHECK'}}], 'type': 'USER_DEFINED'}], 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'SWITCHOVER'}]
 
compartment_id
string
on success
The OCID of the compartment containing the DR Plan.
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.
Example: `EBS Switchover PHX to IAD`

Sample:
display_name_example
 
dr_protection_group_id
string
on success
The OCID of the DR Protection Group with which this DR Plan is associated.
Example: `ocid1.drplan.oc1.iad.exampleocid2`

Sample:
ocid1.drprotectiongroup.oc1..xxxxxxEXAMPLExxxxxx
 
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'}
 
id
string
on success
The OCID of this DR Plan.
Example: `ocid1.drplan.oc1.iad.exampleocid2`

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
life_cycle_details
string
on success
A message describing the DR Plan's current state in more detail.

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

Sample:
CREATING
 
peer_dr_protection_group_id
string
on success
The OCID of the 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 associated with this plan's DR Protection Group.
Example: `us-phoenix-1`

Sample:
us-phoenix-1
 
plan_groups
complex
on success
The list of groups in this DR Plan.
Returned for get operation

   
display_name
string
on success
The display name of this DR Plan Group.
Example: `DATABASE_SWITCHOVER`

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

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
steps
complex
on success
The list of steps in this plan group.

     
display_name
string
on success
The display name of this DR Plan Group.
Example: `DATABASE_SWITCHOVER`

Sample:
display_name_example
     
error_mode
string
on success
The error mode for this step.

Sample:
STOP_ON_ERROR
     
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
     
id
string
on success
The unique id of this step. Must not be modified by the user.
Example: `sgid1.step..examplestepsgid`

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
     
is_enabled
boolean
on success
A flag indicating whether this step should be enabled for execution.
Example: `true`

Sample:
True
     
member_id
string
on success
The OCID of the member associated with this step.
Example: `ocid1.database.oc1.phx.exampleocid1`

Sample:
ocid1.member.oc1..xxxxxxEXAMPLExxxxxx
     
timeout
integer
on success
The timeout in seconds for executing this step.
Example: `600`

Sample:
56
     
type
string
on success
The plan step type.

Sample:
COMPUTE_INSTANCE_STOP_PRECHECK
     
user_defined_step
complex
on success

       
function_id
string
on success
The OCID of function to be invoked.
Example: `ocid1.fnfunc.oc1.iad.exampleocid2`

Sample:
ocid1.function.oc1..xxxxxxEXAMPLExxxxxx
       
function_region
string
on success
The region in which the function is deployed.
Example: `us-ashburn-1`

Sample:
us-phoenix-1
       
object_storage_script_location
complex
on success

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

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: `validate_app_start.sh`

Sample:
object_example
       
request_body
string
on success
The request body for the function.
Example: `{ "FnParam1", "FnParam2" }`

Sample:
request_body_example
       
run_as_user
string
on success
The userid on the instance to be used for executing the script or command.
Example: `opc`

Sample:
run_as_user_example
       
run_on_instance_id
string
on success
The OCID of the instance where this script or command should be executed.
Example: `ocid1.instance.oc1.phx.exampleocid1`

Sample:
ocid1.runoninstance.oc1..xxxxxxEXAMPLExxxxxx
       
run_on_instance_region
string
on success
The region in which the instance is present.
Example: `us-phoenix-1`

Sample:
us-phoenix-1
       
script_command
string
on success
The script name and arguments.
Example: `/usr/bin/python3 /home/opc/scripts/my_app_script.py arg1 arg2 arg3`

Sample:
script_command_example
       
step_type
string
on success
The type of the step.
RUN_OBJECTSTORE_SCRIPT_PRECHECK - A step which performs a precheck on a script stored in Oracle Object Storage Service
RUN_LOCAL_SCRIPT_PRECHECK - A step which performs a precheck on a script which resides locally on a compute instance
INVOKE_FUNCTION_PRECHECK - A step which performs a precheck on an Oracle Function. See https://docs.oracle.com/en-us/iaas/Content/Functions/home.htm.
RUN_OBJECTSTORE_SCRIPT - A step which runs a script stored in Oracle Object Storage Service
RUN_LOCAL_SCRIPT - A step which runs a script that resides locally on a compute instance
INVOKE_FUNCTION - A step which invokes an Oracle Function. See https://docs.oracle.com/en-us/iaas/Content/Functions/home.htm.

Sample:
RUN_OBJECTSTORE_SCRIPT_PRECHECK
   
type
string
on success
The plan group type.

Sample:
USER_DEFINED
 
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 the DR Plan was created. 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 date and time the DR Plan was updated. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`

Sample:
2013-10-20T19:20:30+01:00
 
type
string
on success
The type of this DR Plan.

Sample:
SWITCHOVER


Authors

  • Oracle (@oracle)