oci_backup - Create and Delete a Database Backup in OCI Database Cloud Service.

New in version 2.5.

Synopsis

  • Create and Delete a Database Backup in OCI Database Cloud Service.
  • Since all the operations of this module takes a long time, it is recommended to set the wait parameter to False. Use oci_backup_facts to check the status of the operation as a separate task.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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
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
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
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_type
    Choices:
  • api_key ←
  • instance_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.
backup_id
Identifier of the Database Backup. Mandatory for delete.
config_file_location
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
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
Identifier of the Database whose backup has to be created. Mandatory for create.

aliases: id
display_name
The user-friendly name for the Database Backup. It does not have to be unique. Mandatory for create.
force_create
bool
    Choices:
  • no ←
  • yes
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
The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
region
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
required
    Choices:
  • present ←
  • absent
Decides whether to create or delete Database Backup. For state=present, if the backup does not exists, it gets created.For state=absent, backup gets deleted.
tenancy
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
bool
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout Default:
1200
Time, in seconds, to wait when wait=yes.
wait_until
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Examples

# Note: These examples do not set authentication details.
# Create Database Backup
- name: Create Database Backup
  oci_backup:
      database_id: 'ocid1.database.aaaa'
      display_name: 'ansible-backup'
      wait: False
      state: 'present'
# Delete Database Backup
- name: Delete Database Backup
  oci_backup:
      backup_id: 'ocid1.backup.aaaa'
      state: 'absent'

Return Values

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

Key Returned Description
backup
complex
success
Attributes of the Database Backup.

Sample:
{'lifecycle_state': 'AVAILABLE', 'availability_domain': 'IwGV:US-ABC-AD-1', 'display_name': 'ansible-backup', 'time_started': '2018-02-23T06:37:58.669000+00:00', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'time_ended': '2018-02-23T13:50:57.211000+00:00', 'database_id': 'ocid1.database.oc1.iad.xxxxxEXAMPLExxxxx', 'lifecycle_details': 'The backup operation run successfully.', 'type': 'FULL', 'id': 'ocid1.dbbackup.oc1.iad.xxxxxEXAMPLExxxxx'}
  lifecycle_state
string
always
The current state of the Database Backup.

Sample:
ACTIVE
  availability_domain
string
always
The name of the Availability Domain that the Database Backup is located in.

Sample:
IwGV:US-ABC-AD-1
  display_name
string
always
The user-friendly name for the Database Backup.

Sample:
ansible-backup
  time_started
string
always
The date and time the Database Backup starts.

Sample:
2018-02-23 06:37:58.669000
  compartment_id
string
always
The identifier of the compartment containing the DB System where the Database resides, whose backup has to be created.

Sample:
ocid1.compartment.oc1.xzvf..oifds
  time_ended
string
always
The date and time the Database Backup was completed.

Sample:
2018-02-23 13:50:57.211000
  database_id
string
always
The identifier of the Database whose backup has to be created.

Sample:
ocid1.database.oc1.iad.xxxxxEXAMPLExxxxx
  lifecycle_details
string
always
Additional information about the current lifecycle_state of the Database Backup.

Sample:
The backup operation cannot run successfully because the node is STOPPING or STOPPED
  type
string
always
The type of Database Backup.

Sample:
FULL
  id
string
always
Identifier of the Database Backup.

Sample:
ocid1.backup.oc1.iad.xxxxxEXAMPLExxxxx


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Debayan Gupta(@debayan_gupta)

Hint

If you notice any issues in this documentation you can edit this document to improve it.