Try SpotterFetches details about one or multiple AutonomousDatabaseDataguardAssociation resources in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about one or multiple AutonomousDatabaseDataguardAssociation resources in Oracle Cloud Infrastructure
Gets a list of the Autonomous Data Guard-enabled databases associated with the specified Autonomous Database.
If I(autonomous_database_dataguard_association_id) is specified, the details of a single AutonomousDatabaseDataguardAssociation will be returned.
- name: Get a specific autonomous_database_dataguard_association
oci_database_autonomous_database_dataguard_association_facts:
# required
autonomous_database_dataguard_association_id: "ocid1.autonomousdatabasedataguardassociation.oc1..xxxxxxEXAMPLExxxxxx"
autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx"
- name: List autonomous_database_dataguard_associations
oci_database_autonomous_database_dataguard_association_facts:
# required
autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx"
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
cert_bundle:
description:
- 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.
type: str
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
autonomous_database_id:
description:
- The database L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
required: true
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
realm_specific_endpoint_template_enabled:
description:
- Enable/Disable realm specific endpoint template for service client. By Default,
realm specific endpoint template is disabled. If not set, then the value of the
OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
type: bool
autonomous_database_dataguard_association_id:
aliases:
- id
description:
- The Autonomous Container Database-Autonomous Data Guard association L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
- Required to get a specific autonomous_database_dataguard_association.
type: str
autonomous_database_dataguard_associations:
contains:
apply_lag:
description:
- 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`'
returned: on success
sample: apply_lag_example
type: str
apply_rate:
description:
- The rate at which redo logs are synced between the associated databases.
- 'Example: `180 Mb per second`'
returned: on success
sample: apply_rate_example
type: str
autonomous_database_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Autonomous Database that has a relationship with the peer Autonomous
Database.
returned: on success
sample: ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx
type: str
id:
description:
- The OCID of the Autonomous Dataguard created for Autonomous Container Database
where given Autonomous Database resides in.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
is_automatic_failover_enabled:
description:
- Indicates whether Automatic Failover is enabled for Autonomous Container Database
Dataguard Association
returned: on success
sample: true
type: bool
lifecycle_details:
description:
- Additional information about the current lifecycleState, if available.
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- The current state of Autonomous Data Guard.
returned: on success
sample: PROVISIONING
type: str
peer_autonomous_database_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the peer Autonomous Database.
returned: on success
sample: ocid1.peerautonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx
type: str
peer_autonomous_database_life_cycle_state:
description:
- The current state of Autonomous Data Guard.
returned: on success
sample: PROVISIONING
type: str
peer_role:
description:
- The Data Guard role of the Autonomous Container Database or Autonomous Database,
if Autonomous Data Guard is enabled.
returned: on success
sample: PRIMARY
type: str
protection_mode:
description:
- The protection mode of this Autonomous Data Guard association. For more information,
see L(Oracle Data Guard Protection Modes,http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000)
in the Oracle Data Guard documentation.
returned: on success
sample: MAXIMUM_AVAILABILITY
type: str
role:
description:
- The Data Guard role of the Autonomous Container Database or Autonomous Database,
if Autonomous Data Guard is enabled.
returned: on success
sample: PRIMARY
type: str
time_created:
description:
- The date and time the Data Guard association was created.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_last_role_changed:
description:
- The date and time when the last role change action happened.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_last_synced:
description:
- The date and time of the last update to the apply lag, apply rate, and transport
lag values.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
transport_lag:
description:
- 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`'
returned: on success
sample: transport_lag_example
type: str
description:
- List of AutonomousDatabaseDataguardAssociation resources
returned: on success
sample:
- apply_lag: apply_lag_example
apply_rate: apply_rate_example
autonomous_database_id: ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
is_automatic_failover_enabled: true
lifecycle_details: lifecycle_details_example
lifecycle_state: PROVISIONING
peer_autonomous_database_id: ocid1.peerautonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx
peer_autonomous_database_life_cycle_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
type: complex