oracle.oci.oci_disaster_recovery_dr_protection_group – Manage a DrProtectionGroup 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_protection_group.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, create a new DR Protection Group.

  • This resource has the following action operations in the oracle.oci.oci_disaster_recovery_dr_protection_group_actions module: associate, change_compartment, disassociate, update_dr_protection_group_role.

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).
association
dictionary
peer_id
string
The OCID of the peer (remote) DR Protection Group.
Example: `ocid1.drprotectiongroup.oc1.iad.exampleocid2`
peer_region
string
The region of the peer (remote) DR Protection Group.
Example: `us-ashburn-1`
role
string / required
    Choices:
  • PRIMARY
  • STANDBY
  • UNCONFIGURED
The role of this DR Protection Group.
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.
compartment_id
string
The OCID of the compartment in which to create the DR Protection Group.
Example: `ocid1.compartment.oc1..exampleocid1`
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.
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 Protection Group.
Example: `EBS PHX DRPG`
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_protection_group_id
string
The OCID of the DR Protection Group.
Example: `ocid1.drprotectiongroup.oc1.phx.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
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.
log_location
dictionary
Required for create using state=present.
This parameter is updatable.
bucket
string / required
The bucket name inside the Object Storage namespace.
Example: `operation_logs`
This parameter is updatable.
namespace
string / required
The namespace in Object Storage (Note - this is usually the tenancy name).
Example: `myocitenancy`
This parameter is updatable.
members
list / elements=dictionary
A list of DR Protection Group members.
This parameter is updatable.
destination_compartment_id
string
The OCID of the compartment for this compute instance in the destination region.
Example: `ocid1.compartment.oc1..exampleocid1`
This parameter is updatable.
Applicable when member_type is 'COMPUTE_INSTANCE'
destination_dedicated_vm_host_id
string
The OCID of the dedicated VM Host in the destination region where this compute instance should be launched
Example: `ocid1.dedicatedvmhost.oc1.iad.exampleocid2`
This parameter is updatable.
Applicable when member_type is 'COMPUTE_INSTANCE'
is_movable
boolean
    Choices:
  • no
  • yes
A flag indicating if this compute instance should be moved during DR operations.
Example: `false`
This parameter is updatable.
Applicable when member_type is 'COMPUTE_INSTANCE'
member_id
string / required
The OCID of the member.
Example: `ocid1.instance.oc1.phx.exampleocid1`
This parameter is updatable.
member_type
string / required
    Choices:
  • COMPUTE_INSTANCE
  • DATABASE
  • AUTONOMOUS_DATABASE
  • VOLUME_GROUP
The type of the member.
This parameter is updatable.
password_vault_secret_id
string
The OCID of the vault secret where the database password is stored.
Example: `ocid1.vaultsecret.oc1.phx.exampleocid1`
This parameter is updatable.
Applicable when member_type is 'DATABASE'
vnic_mapping
list / elements=dictionary
A list of Compute Instance VNIC mappings.
Applicable when member_type is 'COMPUTE_INSTANCE'
destination_nsg_id_list
list / elements=string
A list of destination region's network security group (NSG) Ids which this VNIC should use.
Example: `[ ocid1.networksecuritygroup.oc1.iad.abcd1, ocid1.networksecuritygroup.oc1.iad.wxyz2 ]`
Applicable when member_type is 'COMPUTE_INSTANCE'
destination_subnet_id
string / required
The OCID of the destination (remote) subnet to which this VNIC should connect.
Example: `ocid1.subnet.oc1.iad.exampleocid2`
Required when member_type is 'COMPUTE_INSTANCE'
source_vnic_id
string / required
The OCID of the VNIC.
Example: `ocid1.vnic.oc1.phx.exampleocid1`
Required when member_type is 'COMPUTE_INSTANCE'
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 DrProtectionGroup.
Use state=present to create or update a DrProtectionGroup.
Use state=absent to delete a DrProtectionGroup.
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_protection_group
  oci_disaster_recovery_dr_protection_group:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    log_location:
      # required
      namespace: namespace_example
      bucket: bucket_example

    # optional
    association:
      # required
      role: PRIMARY

      # optional
      peer_id: "ocid1.peer.oc1..xxxxxxEXAMPLExxxxxx"
      peer_region: us-phoenix-1
    members:
    - # required
      member_id: "ocid1.member.oc1..xxxxxxEXAMPLExxxxxx"
      member_type: COMPUTE_INSTANCE

      # optional
      is_movable: true
      vnic_mapping:
      - # required
        source_vnic_id: "ocid1.sourcevnic.oc1..xxxxxxEXAMPLExxxxxx"
        destination_subnet_id: "ocid1.destinationsubnet.oc1..xxxxxxEXAMPLExxxxxx"

        # optional
        destination_nsg_id_list: [ "destination_nsg_id_list_example" ]
      destination_compartment_id: "ocid1.destinationcompartment.oc1..xxxxxxEXAMPLExxxxxx"
      destination_dedicated_vm_host_id: "ocid1.destinationdedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update dr_protection_group
  oci_disaster_recovery_dr_protection_group:
    # required
    dr_protection_group_id: "ocid1.drprotectiongroup.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    log_location:
      # required
      namespace: namespace_example
      bucket: bucket_example
    members:
    - # required
      member_id: "ocid1.member.oc1..xxxxxxEXAMPLExxxxxx"
      member_type: COMPUTE_INSTANCE

      # optional
      is_movable: true
      vnic_mapping:
      - # required
        source_vnic_id: "ocid1.sourcevnic.oc1..xxxxxxEXAMPLExxxxxx"
        destination_subnet_id: "ocid1.destinationsubnet.oc1..xxxxxxEXAMPLExxxxxx"

        # optional
        destination_nsg_id_list: [ "destination_nsg_id_list_example" ]
      destination_compartment_id: "ocid1.destinationcompartment.oc1..xxxxxxEXAMPLExxxxxx"
      destination_dedicated_vm_host_id: "ocid1.destinationdedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update dr_protection_group using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_disaster_recovery_dr_protection_group:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    log_location:
      # required
      namespace: namespace_example
      bucket: bucket_example
    members:
    - # required
      member_id: "ocid1.member.oc1..xxxxxxEXAMPLExxxxxx"
      member_type: COMPUTE_INSTANCE

      # optional
      is_movable: true
      vnic_mapping:
      - # required
        source_vnic_id: "ocid1.sourcevnic.oc1..xxxxxxEXAMPLExxxxxx"
        destination_subnet_id: "ocid1.destinationsubnet.oc1..xxxxxxEXAMPLExxxxxx"

        # optional
        destination_nsg_id_list: [ "destination_nsg_id_list_example" ]
      destination_compartment_id: "ocid1.destinationcompartment.oc1..xxxxxxEXAMPLExxxxxx"
      destination_dedicated_vm_host_id: "ocid1.destinationdedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete dr_protection_group
  oci_disaster_recovery_dr_protection_group:
    # required
    dr_protection_group_id: "ocid1.drprotectiongroup.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete dr_protection_group using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_disaster_recovery_dr_protection_group:
    # required
    compartment_id: "ocid1.compartment.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:

Key Returned Description
dr_protection_group
complex
on success
Details of the DrProtectionGroup resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'life_cycle_details': 'life_cycle_details_example', 'lifecycle_state': 'CREATING', 'log_location': {'bucket': 'bucket_example', 'namespace': 'namespace_example', 'object': 'object_example'}, 'members': [{'destination_compartment_id': 'ocid1.destinationcompartment.oc1..xxxxxxEXAMPLExxxxxx', 'destination_dedicated_vm_host_id': 'ocid1.destinationdedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx', 'is_movable': True, 'member_id': 'ocid1.member.oc1..xxxxxxEXAMPLExxxxxx', 'member_type': 'COMPUTE_INSTANCE', 'password_vault_secret_id': 'ocid1.passwordvaultsecret.oc1..xxxxxxEXAMPLExxxxxx', 'vnic_mapping': [{'destination_nsg_id_list': [], 'destination_subnet_id': 'ocid1.destinationsubnet.oc1..xxxxxxEXAMPLExxxxxx', 'source_vnic_id': 'ocid1.sourcevnic.oc1..xxxxxxEXAMPLExxxxxx'}]}], 'peer_id': 'ocid1.peer.oc1..xxxxxxEXAMPLExxxxxx', 'peer_region': 'us-phoenix-1', 'role': 'PRIMARY', 'system_tags': {}, 'time_created': '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 the DR Protection Group.
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 the DR Protection Group.
Example: `EBS PHX DRPG`

Sample:
display_name_example
 
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 the DR Protection Group.
Example: `ocid1.drprotectiongroup.oc1.phx.exampleocid1`

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

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

Sample:
CREATING
 
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
 
members
complex
on success
A list of DR Protection Group members.

   
destination_compartment_id
string
on success
The OCID of the compartment for this compute instance in the destination region.
Example: `ocid1.compartment.oc1..exampleocid`

Sample:
ocid1.destinationcompartment.oc1..xxxxxxEXAMPLExxxxxx
   
destination_dedicated_vm_host_id
string
on success
The OCID of the dedicated VM Host for this compute instance in the destination region.
Example: `ocid1.dedicatedvmhost.oc1.iad.exampleocid`

Sample:
ocid1.destinationdedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx
   
is_movable
boolean
on success
A flag indicating if this compute instance should be moved during DR operations.
Example: `false`

Sample:
True
   
member_id
string
on success
The OCID of the member.
Example: `ocid1.instance.oc1.phx.exampleocid1`

Sample:
ocid1.member.oc1..xxxxxxEXAMPLExxxxxx
   
member_type
string
on success
The type of the member.

Sample:
COMPUTE_INSTANCE
   
password_vault_secret_id
string
on success
The ID of the vault secret where the database password is stored.
Example: `ocid1.vaultsecret.oc1.phx.exampleocid1`

Sample:
ocid1.passwordvaultsecret.oc1..xxxxxxEXAMPLExxxxxx
   
vnic_mapping
complex
on success
A list of compute instance VNIC mappings.

     
destination_nsg_id_list
list / elements=string
on success
A list of destination region's network security group (NSG) OCIDs which this VNIC should use.
Example: `[ ocid1.networksecuritygroup.oc1.iad.exampleocid1, ocid1.networksecuritygroup.oc1.iad.exampleocid2 ]`

     
destination_subnet_id
string
on success
The OCID of the destination (remote) subnet to which this VNIC should connect.
Example: `ocid1.subnet.oc1.iad.exampleocid`

Sample:
ocid1.destinationsubnet.oc1..xxxxxxEXAMPLExxxxxx
     
source_vnic_id
string
on success
The OCID of the VNIC.
Example: `ocid1.vnic.oc1.phx.exampleocid`

Sample:
ocid1.sourcevnic.oc1..xxxxxxEXAMPLExxxxxx
 
peer_id
string
on success
The OCID of the peer (remote) DR Protection Group.
Example: `ocid1.drprotectiongroup.oc1.iad.exampleocid2`

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

Sample:
us-phoenix-1
 
role
string
on success
The role of the DR Protection Group.

Sample:
PRIMARY
 
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 Protection Group 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 Protection Group was updated. An RFC3339 formatted datetime string.
Example: `2019-03-29T09:36:42Z`

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


Authors

  • Oracle (@oracle)