oracle.oci.oci_disaster_recovery_dr_plan – Manage a DrPlan 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
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a DrPlan resource in Oracle Cloud Infrastructure
For state=present, creates a new DR Plan of the specified DR Plan type.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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 being created.
Example: `EBS Switchover PHX to IAD`
Required for create using state=present.
Required for 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_id
string
|
The OCID of the DR Plan.
Example: `ocid1.drplan.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 to which this DR Plan belongs.
Example: `ocid1.drprotectiongroup.oc1.iad.exampleocid2`
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. |
|||||
force_create
boolean
|
|
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_groups
list
/ elements=dictionary
|
An ordered list of plan groups in a DR Plan.
This parameter is updatable.
|
|||||
display_name
string
|
The display name of this group.
Example: `My_GROUP_3 - EBS Start`
This parameter is updatable.
aliases: name |
|||||
id
string
|
The unique id of this group. Must not be modified by user.
Example: `sgid1.group..examplegroupsgid`
This parameter is updatable.
|
|||||
steps
list
/ elements=dictionary
|
The list of steps in this group.
|
|||||
display_name
string
|
The display name of this step in a group.
Example: `My_STEP_3A - EBS Start - STAGE A`
This parameter is updatable.
aliases: name |
|||||
error_mode
string
|
|
The error mode for this step.
This parameter is updatable.
|
||||
id
string
|
The unique id of this step.
Example: `sgid1.step..examplestepsgid`
This parameter is updatable.
|
|||||
is_enabled
boolean
|
|
A flag indicating whether this step should be enabled for execution.
Example: `true`
This parameter is updatable.
|
||||
timeout
integer
|
The timeout in seconds for executing this step.
Example: `600`
This parameter is updatable.
|
|||||
user_defined_step
dictionary
|
||||||
function_id
string
|
The OCID of function to be invoked.
Example: `ocid1.fnfunc.oc1.iad.exampleocid2`
This parameter is updatable.
Applicable when step_type is 'INVOKE_FUNCTION'
|
|||||
object_storage_script_location
dictionary
|
Applicable when step_type is 'RUN_OBJECTSTORE_SCRIPT'
|
|||||
bucket
string
/ required
|
The bucket name inside the Object Storage namespace.
Example: `custom_dr_scripts`
This parameter is updatable.
Required when step_type is 'RUN_OBJECTSTORE_SCRIPT'
|
|||||
namespace
string
/ required
|
The namespace in Object Storage (Note - this is usually the tenancy name).
Example: `myocitenancy`
This parameter is updatable.
Required when step_type is 'RUN_OBJECTSTORE_SCRIPT'
|
|||||
object
string
/ required
|
The object name inside the Object Storage bucket.
Example: `validate_app_start.sh`
This parameter is updatable.
Required when step_type is 'RUN_OBJECTSTORE_SCRIPT'
|
|||||
request_body
string
|
The request body for the function.
Example: `{ "FnParam1", "FnParam2" }`
This parameter is updatable.
Applicable when step_type is 'INVOKE_FUNCTION'
|
|||||
run_as_user
string
|
The userid on the instance to be used for executing the script or command.
Example: `opc`
This parameter is updatable.
Applicable when step_type is 'RUN_LOCAL_SCRIPT'
|
|||||
run_on_instance_id
string
|
The OCID of the instance where this script or command should be executed.
This parameter is updatable.
Applicable when step_type is one of ['RUN_LOCAL_SCRIPT', 'RUN_OBJECTSTORE_SCRIPT']
|
|||||
script_command
string
|
The script name and arguments.
Example: `/usr/bin/python3 /home/opc/scripts/my_app_script.py arg1 arg2 arg3`
This parameter is updatable.
Applicable when step_type is 'RUN_LOCAL_SCRIPT'
|
|||||
step_type
string
/ required
|
|
The type of the user-defined step.
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.
This parameter is updatable.
|
||||
type
string
|
|
The group type.
This parameter is updatable.
|
||||
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
|
|
The state of the DrPlan.
Use state=present to create or update a DrPlan.
Use state=absent to delete a DrPlan.
|
||||
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 |
|||||
type
string
|
|
The type of DR Plan to be created.
Required for create using state=present.
|
||||
wait
boolean
|
|
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.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create dr_plan
oci_disaster_recovery_dr_plan:
# required
type: SWITCHOVER
dr_protection_group_id: "ocid1.drprotectiongroup.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update dr_plan
oci_disaster_recovery_dr_plan:
# required
dr_plan_id: "ocid1.drplan.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
plan_groups:
- # optional
id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
type: USER_DEFINED
steps:
- # optional
id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
error_mode: STOP_ON_ERROR
timeout: 56
is_enabled: true
user_defined_step:
# required
step_type: RUN_LOCAL_SCRIPT_PRECHECK
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update dr_plan using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_disaster_recovery_dr_plan:
# required
dr_protection_group_id: "ocid1.drprotectiongroup.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
plan_groups:
- # optional
id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
type: USER_DEFINED
steps:
- # optional
id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
error_mode: STOP_ON_ERROR
timeout: 56
is_enabled: true
user_defined_step:
# required
step_type: RUN_LOCAL_SCRIPT_PRECHECK
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete dr_plan
oci_disaster_recovery_dr_plan:
# required
dr_plan_id: "ocid1.drplan.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete dr_plan using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_disaster_recovery_dr_plan:
# required
dr_protection_group_id: "ocid1.drprotectiongroup.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)