oracle / oracle.oci / 4.32.0 / module / oci_database_data_guard_association_actions Perform actions on a DataGuardAssociation resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_data_guard_association_actions (4.32.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.32.0
collections: - name: oracle.oci version: 4.32.0
Perform actions on a DataGuardAssociation resource in Oracle Cloud Infrastructure
For I(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 I(action=reinstate), reinstates the database identified by the `databaseId` parameter into the standby role in a Data Guard association.
For I(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.
- 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
wait: default: true description: Whether to wait for create or delete operation to complete. type: bool action: choices: - failover - reinstate - switchover description: - The action to perform on the DataGuardAssociation. required: true type: str 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 database_id: description: - The database L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). required: true 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 wait_timeout: description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most of the services but some services might have a longer wait timeout. type: int 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 database_admin_password: description: - The DB system administrator password. 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 data_guard_association_id: aliases: - id description: - The Data Guard association's L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). required: true 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
data_guard_association: 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 database_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the reporting database. returned: on success sample: ocid1.database.oc1..xxxxxxEXAMPLExxxxxx type: str id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Data Guard association. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str is_active_data_guard_enabled: description: - True if active Data Guard is enabled. 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 the Data Guard association. returned: on success sample: PROVISIONING type: str peer_data_guard_association_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the peer database's Data Guard association. returned: on success sample: ocid1.peerdataguardassociation.oc1..xxxxxxEXAMPLExxxxxx type: str peer_database_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the associated peer database. returned: on success sample: ocid1.peerdatabase.oc1..xxxxxxEXAMPLExxxxxx type: str peer_db_home_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Database Home containing the associated peer database. returned: on success sample: ocid1.peerdbhome.oc1..xxxxxxEXAMPLExxxxxx type: str peer_db_system_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the DB system containing the associated peer database. returned: on success sample: ocid1.peerdbsystem.oc1..xxxxxxEXAMPLExxxxxx type: str peer_role: description: - The role of the peer database in this Data Guard association. returned: on success sample: PRIMARY type: str protection_mode: description: - The protection mode of this 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 role of the reporting database in this Data Guard association. 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 transport_type: description: - The redo transport type used by this Data Guard association. For more information, see L(Redo Transport Services,http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) in the Oracle Data Guard documentation. returned: on success sample: SYNC type: str description: - Details of the DataGuardAssociation resource acted upon by the current operation returned: on success 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 type: complex