oracle.oci.oci_database_backup – Manage a Backup resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.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_backup
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create and delete a Backup resource in Oracle Cloud Infrastructure
For state=present, creates a new backup in the specified database based on the request parameters you provide. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
This resource has the following action operations in the oracle.oci.oci_database_backup_actions module: cancel.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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. |
backup_id
string
|
The backup OCID.
Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
|
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 . |
|
database_id
string
|
The OCID of the database.
Required for create using state=present.
|
|
display_name
string
|
The user-friendly name for the backup. The name does not have to be unique.
Required for create using state=present.
Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.aliases: name |
|
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
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.
|
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. |
|
state
string
|
|
The state of the Backup.
Use state=present to create a Backup.
Use state=absent to delete a Backup.
|
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 |
|
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create backup
oci_database_backup:
# required
database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
- name: Delete backup
oci_database_backup:
# required
backup_id: "ocid1.backup.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
- name: Delete backup using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_database_backup:
# required
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
backup
complex
|
on success |
Details of the Backup resource acted upon by the current operation
Sample:
{'availability_domain': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'database_edition': 'STANDARD_EDITION', 'database_id': 'ocid1.database.oc1..xxxxxxEXAMPLExxxxxx', 'database_size_in_gbs': 1.2, 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', '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', 'shape': 'shape_example', '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', 'version': 'version_example'}
|
|
availability_domain
string
|
on success |
The name of the availability domain where the database backup is stored.
Sample:
Uocm:PHX-AD-1
|
|
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|
database_edition
string
|
on success |
The Oracle Database edition of the DB system from which the database backup was taken.
Sample:
STANDARD_EDITION
|
|
database_id
string
|
on success |
The OCID of the database.
Sample:
ocid1.database.oc1..xxxxxxEXAMPLExxxxxx
|
|
database_size_in_gbs
float
|
on success |
The size of the database in gigabytes at the time the backup was taken.
Sample:
1.2
|
|
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 backup.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
key_store_id
string
|
on success |
The OCID of the key store of Oracle Vault.
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. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
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
|
|
shape
string
|
on success |
Shape of the backup's source database.
Sample:
shape_example
|
|
time_ended
string
|
on success |
The date and time the backup was 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. This parameter and `secretId` are required for Customer Managed Keys.
Sample:
ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx
|
|
version
string
|
on success |
Version of the backup's source database
Sample:
version_example
|
Authors¶
Oracle (@oracle)