oracle.oci.oci_database_data_guard_association_actions – Perform actions on a DataGuardAssociation resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.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_data_guard_association_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a DataGuardAssociation resource in Oracle Cloud Infrastructure

  • For action=failover, performs a failover to transition the standby database identified by the databaseId parameter into the specified Data Guard association’s primary role after the existing primary database fails or becomes unreachable. A failover might result in data loss depending on the protection mode in effect at the time of the primary database failure.

  • For action=reinstate, reinstates the database identified by the databaseId parameter into the standby role in a Data Guard association.

  • For action=switchover, performs a switchover to transition the primary database of a Data Guard association into a standby role. The standby database associated with the dataGuardAssociationId assumes the primary database role. A switchover guarantees no data loss.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • failover
  • reinstate
  • switchover
The action to perform on the DataGuardAssociation.
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.
data_guard_association_id
string / required
The Data Guard association's OCID.

aliases: id
database_admin_password
string / required
The DB system administrator password.
database_id
string / required
The database OCID.
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.
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: Perform action failover on data_guard_association
  oci_database_data_guard_association_actions:
    # required
    database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
    data_guard_association_id: "ocid1.dataguardassociation.oc1..xxxxxxEXAMPLExxxxxx"
    database_admin_password: example-password
    action: failover

- name: Perform action reinstate on data_guard_association
  oci_database_data_guard_association_actions:
    # required
    database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
    data_guard_association_id: "ocid1.dataguardassociation.oc1..xxxxxxEXAMPLExxxxxx"
    database_admin_password: example-password
    action: reinstate

- name: Perform action switchover on data_guard_association
  oci_database_data_guard_association_actions:
    # required
    database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
    data_guard_association_id: "ocid1.dataguardassociation.oc1..xxxxxxEXAMPLExxxxxx"
    database_admin_password: example-password
    action: switchover

Return Values

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

Key Returned Description
data_guard_association
complex
on success
Details of the DataGuardAssociation resource acted upon by the current operation

Sample:
{'apply_lag': 'apply_lag_example', 'apply_rate': 'apply_rate_example', 'database_id': 'ocid1.database.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_active_data_guard_enabled': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'PROVISIONING', 'peer_data_guard_association_id': 'ocid1.peerdataguardassociation.oc1..xxxxxxEXAMPLExxxxxx', 'peer_database_id': 'ocid1.peerdatabase.oc1..xxxxxxEXAMPLExxxxxx', 'peer_db_home_id': 'ocid1.peerdbhome.oc1..xxxxxxEXAMPLExxxxxx', 'peer_db_system_id': 'ocid1.peerdbsystem.oc1..xxxxxxEXAMPLExxxxxx', 'peer_role': 'PRIMARY', 'protection_mode': 'MAXIMUM_AVAILABILITY', 'role': 'PRIMARY', 'time_created': '2013-10-20T19:20:30+01:00', 'transport_type': 'SYNC'}
 
apply_lag
string
on success
The lag time between updates to the primary database and application of the redo data on the standby 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 synced between the associated databases.
Example: `180 Mb per second`

Sample:
apply_rate_example
 
database_id
string
on success
The OCID of the reporting database.

Sample:
ocid1.database.oc1..xxxxxxEXAMPLExxxxxx
 
id
string
on success
The OCID of the Data Guard association.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_active_data_guard_enabled
boolean
on success
True if active Data Guard is enabled.

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 the Data Guard association.

Sample:
PROVISIONING
 
peer_data_guard_association_id
string
on success
The OCID of the peer database's Data Guard association.

Sample:
ocid1.peerdataguardassociation.oc1..xxxxxxEXAMPLExxxxxx
 
peer_database_id
string
on success
The OCID of the associated peer database.

Sample:
ocid1.peerdatabase.oc1..xxxxxxEXAMPLExxxxxx
 
peer_db_home_id
string
on success
The OCID of the Database Home containing the associated peer database.

Sample:
ocid1.peerdbhome.oc1..xxxxxxEXAMPLExxxxxx
 
peer_db_system_id
string
on success
The OCID of the DB system containing the associated peer database.

Sample:
ocid1.peerdbsystem.oc1..xxxxxxEXAMPLExxxxxx
 
peer_role
string
on success
The role of the peer database in this Data Guard association.

Sample:
PRIMARY
 
protection_mode
string
on success
The protection mode of this 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 role of the reporting database in this Data Guard association.

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

Sample:
2013-10-20T19:20:30+01:00
 
transport_type
string
on success
The redo transport type used by this Data Guard association. For more information, see Redo Transport Services in the Oracle Data Guard documentation.

Sample:
SYNC


Authors

  • Oracle (@oracle)