oracle.oci.oci_database_autonomous_database_backup_facts – Fetches details about one or multiple AutonomousDatabaseBackup resources 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_autonomous_database_backup_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple AutonomousDatabaseBackup resources in Oracle Cloud Infrastructure

  • Gets a list of Autonomous Database backups based on either the autonomousDatabaseId or compartmentId specified as a query parameter.

  • If autonomous_database_backup_id is specified, the details of a single AutonomousDatabaseBackup will be returned.

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_database_backup_id
string
The OCID of the Autonomous Database backup.
Required to get a specific autonomous_database_backup.

aliases: id
autonomous_database_id
string
The 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.
compartment_id
string
The compartment OCID.
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.
display_name
string
A filter to return only resources that match the entire display name given. The match is not case sensitive.

aliases: name
lifecycle_state
string
    Choices:
  • CREATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
A filter to return only resources that match the given lifecycle state exactly.
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.
sort_by
string
    Choices:
  • TIMECREATED
  • DISPLAYNAME
The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
**Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`DESC`).
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

Examples

- name: Get a specific autonomous_database_backup
  oci_database_autonomous_database_backup_facts:
    # required
    autonomous_database_backup_id: "ocid1.autonomousdatabasebackup.oc1..xxxxxxEXAMPLExxxxxx"

- name: List autonomous_database_backups
  oci_database_autonomous_database_backup_facts:

    # optional
    autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    sort_by: TIMECREATED
    sort_order: ASC
    lifecycle_state: CREATING
    display_name: display_name_example

Return Values

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

Key Returned Description
autonomous_database_backups
complex
on success
List of AutonomousDatabaseBackup resources

Sample:
[{'autonomous_database_id': 'ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'database_size_in_tbs': 10, 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_automatic': True, 'is_restorable': True, 'key_store_id': 'ocid1.keystore.oc1..xxxxxxEXAMPLExxxxxx', 'key_store_wallet_name': 'key_store_wallet_name_example', 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx', 'kms_key_version_id': 'ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'time_ended': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00', 'type': 'INCREMENTAL', 'vault_id': 'ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx'}]
 
autonomous_database_id
string
on success
The OCID of the Autonomous Database.

Sample:
ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
database_size_in_tbs
float
on success
The size of the database in terabytes at the time the backup was taken.

Sample:
10
 
display_name
string
on success
The user-friendly name for the backup. The name does not have to be unique.

Sample:
display_name_example
 
id
string
on success
The OCID of the Autonomous Database backup.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_automatic
boolean
on success
Indicates whether the backup is user-initiated or automatic.

Sample:
True
 
is_restorable
boolean
on success
Indicates whether the backup can be used to restore the associated Autonomous Database.

Sample:
True
 
key_store_id
string
on success
The OCID of the key store.

Sample:
ocid1.keystore.oc1..xxxxxxEXAMPLExxxxxx
 
key_store_wallet_name
string
on success
The wallet name for Oracle Key Vault.

Sample:
key_store_wallet_name_example
 
kms_key_id
string
on success
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
 
kms_key_version_id
string
on success
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

Sample:
ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
Additional information about the current lifecycle state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the backup.

Sample:
CREATING
 
time_ended
string
on success
The date and time the backup completed.

Sample:
2013-10-20T19:20:30+01:00
 
time_started
string
on success
The date and time the backup started.

Sample:
2013-10-20T19:20:30+01:00
 
type
string
on success
The type of backup.

Sample:
INCREMENTAL
 
vault_id
string
on success
The OCID of the Oracle Cloud Infrastructure vault.

Sample:
ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)