oci_data_guard_association_facts - Fetches details of an OCI Data Guard Association

New in version 2.5.

Synopsis

  • Fetches details of an OCI Data Guard Association

Requirements

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

Parameters

Parameter Choices/Defaults Comments
api_user
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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
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
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
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_type
    Choices:
  • api_key ←
  • instance_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.
config_file_location
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
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
Identifier of the Data Guard Association whose details needs to be fetched.

aliases: id
database_id
Identifier of the database whose Data Guard Association details needs to be fetched
region
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
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

# Note: These examples do not set authentication details.
# List all Data Guard Association related to a database
- name: List all Data Guard Association of a Database
  oci_data_guard_association_facts:
      database_id: 'ocid1.database..abuw'

# List a specific Data Guard Association related to a database
- name: List all Data Guard Association of a Database
  oci_data_guard_association_facts:
      database_id: 'ocid1.database..abuw'
      data_guard_association_id: 'ocid1.dgassociation.abuw'

Return Values

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

Key Returned Description
data_guard_association
complex
success
Attributes of the Data Guard Association.

Sample:
[{'peer_db_home_id': 'ocid1.dbhome.oc1.iad.xxxxxEXAMPLExxxxx', 'lifecycle_state': 'PROVISIONING', 'peer_data_guard_association_id': 'ocid1.dgassociation.oc1.iad.xxxxxEXAMPLExxxxx', 'peer_role': 'STANDBY', 'time_created': '2018-03-03T06:55:49.463000+00:00', 'id': 'ocid1.dgassociation.oc1.iad.xxxxxEXAMPLExxxxx', 'database_id': 'ocid1.database.oc1.iad.xxxxxEXAMPLExxxxx', 'role': 'PRIMARY', 'peer_database_id': 'ocid1.database.oc1.iad.xxxxxEXAMPLExxxxx', 'transport_type': 'ASYNC', 'lifecycle_details': None, 'apply_rate': '15 KByte/s', 'apply_lag': '7 seconds', 'peer_db_system_id': 'ocid1.dbsystem.oc1.iad.xxxxxEXAMPLExxxxx', 'protection_mode': 'MAXIMUM_PERFORMANCE'}, {'peer_db_home_id': 'ocid1.dbhome.oc1.iad.xxxxxEXAMPLExxxxx', 'lifecycle_state': 'PROVISIONING', 'peer_data_guard_association_id': 'ocid1.dgassociation.oc1.iad.xxxxxEXAMPLExxxxx', 'peer_role': 'STANDBY', 'time_created': '2018-03-03T06:55:49.463000+00:00', 'id': 'ocid1.dgassociation.oc1.iad.xxxxxEXAMPLExxxxx', 'database_id': 'ocid1.database.oc1.iad.xxxxxEXAMPLExxxxx', 'role': 'PRIMARY', 'peer_database_id': 'ocid1.database.oc1.iad.xxxxxEXAMPLExxxxx', 'transport_type': 'ASYNC', 'lifecycle_details': None, 'apply_rate': '15 KByte/s', 'apply_lag': '7 seconds', 'peer_db_system_id': 'ocid1.dbsystem.oc1.iad.xxxxxEXAMPLExxxxx', 'protection_mode': 'MAXIMUM_PERFORMANCE'}]
  lifecycle_state
string
always
The current state of the Data Guard Association.

Sample:
AVAILABLE
  peer_data_guard_association_id
string
always
Identifier of the peer database's Data Guard association.

Sample:
ocid1.dgassociation.oc1.iad.xxxxxEXAMPLExxxxx
  peer_role
string
always
The role of the peer database in this Data Guard association.

Sample:
STANDBY
  time_created
datetime
always
Date and time when the Data Guard Association was created, in the format defined by RFC3339

Sample:
2016-08-25 21:10:29.600000
  id
string
always
Identifier of the Data Guard Association.

Sample:
ocid1.dgassociation.oc1.iad.xxxxxEXAMPLExxxxx
  database_id
string
always
Identifier of the reporting Database.

Sample:
ocid1.database.oc1.iad.xxxxxEXAMPLExxxxx
  role
string
always
The role of the reporting database in this Data Guard Association.

Sample:
PRIMARY
  peer_database_id
string
always
Identifier of the associated peer database.

Sample:
ocid1.database.oc1.iad.xxxxxEXAMPLExxxxx
  transport_type
string
always
The redo transport type used by this Data Guard Association.

Sample:
ASYNC
  lifecycle_details
string
always
Additional information about the current lifecycle_state, if available.

Sample:
Details of lifecycle state
  apply_rate
string
always
The rate at which redo logs are synced between the associated databases.

Sample:
17.00 KByte/s
  apply_lag
string
always
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.

Sample:
9 seconds
  peer_db_system_id
string
always
Identifier of the DB System containing the associated peer database.

Sample:
ocid1.dgassociation.oc1.iad.xxxxxEXAMPLExxxxx
  protection_mode
string
always
The protection mode of this Data Guard association.

Sample:
MAXIMUM_PERFORMANCE


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Debayan Gupta(@debayan_gupta)

Hint

If you notice any issues in this documentation you can edit this document to improve it.