Try SpotterFetches details about one or multiple AutonomousDatabaseBackup 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 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 I(autonomous_database_backup_id) is specified, the details of a single AutonomousDatabaseBackup will be returned.
- 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
type: type_example
type:
description:
- A filter to return only backups that matches with the given type of Backup.
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
sort_by:
choices:
- TIMECREATED
- DISPLAYNAME
description:
- 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.'
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
sort_order:
choices:
- ASC
- DESC
description:
- The sort order to use, either ascending (`ASC`) or descending (`DESC`).
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
display_name:
aliases:
- name
description:
- A filter to return only resources that match the entire display name given. The
match is not case sensitive.
type: str
compartment_id:
description:
- The compartment L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
type: str
lifecycle_state:
choices:
- CREATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- UPDATING
description:
- A filter to return only resources that match the given lifecycle state exactly.
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).
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
autonomous_database_backup_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Autonomous Database backup.
- Required to get a specific autonomous_database_backup.
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_backups:
contains:
autonomous_database_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Autonomous Database.
returned: on success
sample: ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx
type: str
backup_destination_details:
contains:
dbrs_policy_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the DBRS policy used for backup.
returned: on success
sample: ocid1.dbrspolicy.oc1..xxxxxxEXAMPLExxxxxx
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the backup destination.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
internet_proxy:
description:
- Proxy URL to connect to object store.
returned: on success
sample: internet_proxy_example
type: str
type:
description:
- Type of the database backup destination.
returned: on success
sample: NFS
type: str
vpc_password:
description:
- For a RECOVERY_APPLIANCE backup destination, the password for the VPC
user that is used to access the Recovery Appliance.
returned: on success
sample: example-password
type: str
vpc_user:
description:
- For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog
(VPC) user that is used to access the Recovery Appliance.
returned: on success
sample: vpc_user_example
type: str
description:
- ''
returned: on success
type: complex
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
database_size_in_tbs:
description:
- The size of the database in terabytes at the time the backup was taken.
returned: on success
sample: 10
type: float
db_version:
description:
- A valid Oracle Database version for Autonomous Database.
returned: on success
sample: db_version_example
type: str
display_name:
description:
- The user-friendly name for the backup. The name does not have to be unique.
returned: on success
sample: display_name_example
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Autonomous Database backup.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
is_automatic:
description:
- Indicates whether the backup is user-initiated or automatic.
returned: on success
sample: true
type: bool
is_restorable:
description:
- Indicates whether the backup can be used to restore the associated Autonomous
Database.
returned: on success
sample: true
type: bool
key_store_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the key store of Oracle Vault.
returned: on success
sample: ocid1.keystore.oc1..xxxxxxEXAMPLExxxxxx
type: str
key_store_wallet_name:
description:
- The wallet name for Oracle Key Vault.
returned: on success
sample: key_store_wallet_name_example
type: str
kms_key_id:
description:
- The OCID of the key container that is used as the master encryption key in
database transparent data encryption (TDE) operations.
returned: on success
sample: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
type: str
kms_key_version_id:
description:
- 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. Autonomous Database Serverless does not use key versions,
hence is not applicable for Autonomous Database Serverless instances.
returned: on success
sample: ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx
type: str
lifecycle_details:
description:
- Additional information about the current lifecycle state.
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- The current state of the backup.
returned: on success
sample: CREATING
type: str
retention_period_in_days:
description:
- Retention period, in days, for long-term backups
returned: on success
sample: 56
type: int
size_in_tbs:
description:
- The backup size in terrabytes (TB).
returned: on success
sample: 1.2
type: float
time_available_till:
description:
- Timestamp until when the backup will be available
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_ended:
description:
- The date and time the backup completed.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_started:
description:
- The date and time the backup started.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
type:
description:
- The type of backup.
returned: on success
sample: INCREMENTAL
type: str
vault_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Oracle Cloud Infrastructure L(vault,https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm#concepts).
This parameter and `secretId` are required for Customer Managed Keys.
returned: on success
sample: ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- List of AutonomousDatabaseBackup resources
returned: on success
sample:
- autonomous_database_id: ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx
backup_destination_details:
dbrs_policy_id: ocid1.dbrspolicy.oc1..xxxxxxEXAMPLExxxxxx
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
internet_proxy: internet_proxy_example
type: NFS
vpc_password: example-password
vpc_user: vpc_user_example
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
database_size_in_tbs: 10
db_version: db_version_example
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
retention_period_in_days: 56
size_in_tbs: 1.2
time_available_till: '2013-10-20T19:20:30+01:00'
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
type: complex