oracle.oci.oci_database_autonomous_container_database_dataguard_association – Manage an AutonomousContainerDatabaseDataguardAssociation 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_database_autonomous_container_database_dataguard_association.

New in version 2.9.0: of oracle.oci

Synopsis

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.
autonomous_container_database_dataguard_association_id
string / required
The Autonomous Container Database-Autonomous Data Guard association OCID.

aliases: id
autonomous_container_database_id
string / required
The Autonomous Container Database OCID.
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.
fast_start_fail_over_lag_limit_in_seconds
integer
The lag time for my preference based on data loss tolerance in seconds.
This parameter is updatable.
is_automatic_failover_enabled
boolean
    Choices:
  • no
  • yes
Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association
This parameter is updatable.
protection_mode
string
    Choices:
  • MAXIMUM_AVAILABILITY
  • MAXIMUM_PERFORMANCE
The protection mode of this Autonomous Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
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
    Choices:
  • present ←
The state of the AutonomousContainerDatabaseDataguardAssociation.
Use state=present to update an existing an AutonomousContainerDatabaseDataguardAssociation.
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: Update autonomous_container_database_dataguard_association
  oci_database_autonomous_container_database_dataguard_association:
    # required
    autonomous_container_database_id: "ocid1.autonomouscontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx"
    autonomous_container_database_dataguard_association_id: "ocid1.autonomouscontainerdatabasedataguardassociation.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    is_automatic_failover_enabled: true
    protection_mode: MAXIMUM_AVAILABILITY
    fast_start_fail_over_lag_limit_in_seconds: 56

Return Values

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

Key Returned Description
autonomous_container_database_dataguard_association
complex
on success
Details of the AutonomousContainerDatabaseDataguardAssociation resource acted upon by the current operation

Sample:
{'apply_lag': 'apply_lag_example', 'apply_rate': 'apply_rate_example', 'autonomous_container_database_id': 'ocid1.autonomouscontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx', 'fast_start_fail_over_lag_limit_in_seconds': 56, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_automatic_failover_enabled': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'PROVISIONING', 'peer_autonomous_container_database_dataguard_association_id': 'ocid1.peerautonomouscontainerdatabasedataguardassociation.oc1..xxxxxxEXAMPLExxxxxx', 'peer_autonomous_container_database_id': 'ocid1.peerautonomouscontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx', 'peer_lifecycle_state': 'PROVISIONING', 'peer_role': 'PRIMARY', 'protection_mode': 'MAXIMUM_AVAILABILITY', 'role': 'PRIMARY', 'time_created': '2013-10-20T19:20:30+01:00', 'time_last_role_changed': '2013-10-20T19:20:30+01:00', 'time_last_synced': '2013-10-20T19:20:30+01:00', 'transport_lag': 'transport_lag_example'}
 
apply_lag
string
on success
The lag time between updates to the primary Autonomous Container Database and application of the redo data on the standby Autonomous Container Database, as computed by the reporting database.
Example: `9 seconds`

Sample:
apply_lag_example
 
apply_rate
string
on success
The rate at which redo logs are synchronized between the associated Autonomous Container Databases.
Example: `180 Mb per second`

Sample:
apply_rate_example
 
autonomous_container_database_id
string
on success
The OCID of the Autonomous Container Database that has a relationship with the peer Autonomous Container Database.

Sample:
ocid1.autonomouscontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx
 
fast_start_fail_over_lag_limit_in_seconds
integer
on success
The lag time for my preference based on data loss tolerance in seconds.

Sample:
56
 
id
string
on success
The OCID of the Autonomous Data Guard created for a given Autonomous Container Database.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_automatic_failover_enabled
boolean
on success
Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association

Sample:
True
 
lifecycle_details
string
on success
Additional information about the current lifecycleState, if available.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of Autonomous Data Guard.

Sample:
PROVISIONING
 
peer_autonomous_container_database_dataguard_association_id
string
on success
The OCID of the peer Autonomous Container Database-Autonomous Data Guard association.

Sample:
ocid1.peerautonomouscontainerdatabasedataguardassociation.oc1..xxxxxxEXAMPLExxxxxx
 
peer_autonomous_container_database_id
string
on success
The OCID of the peer Autonomous Container Database.

Sample:
ocid1.peerautonomouscontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx
 
peer_lifecycle_state
string
on success
The current state of Autonomous Data Guard.

Sample:
PROVISIONING
 
peer_role
string
on success
The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Sample:
PRIMARY
 
protection_mode
string
on success
The protection mode of this Autonomous Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

Sample:
MAXIMUM_AVAILABILITY
 
role
string
on success
The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Sample:
PRIMARY
 
time_created
string
on success
The date and time the Autonomous DataGuard association was created.

Sample:
2013-10-20T19:20:30+01:00
 
time_last_role_changed
string
on success
The date and time when the last role change action happened.

Sample:
2013-10-20T19:20:30+01:00
 
time_last_synced
string
on success
The date and time of the last update to the apply lag, apply rate, and transport lag values.

Sample:
2013-10-20T19:20:30+01:00
 
transport_lag
string
on success
The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database.
Example: `7 seconds`

Sample:
transport_lag_example


Authors

  • Oracle (@oracle)