oci_database - Restore or Update a Database in OCI Database Cloud Service.¶

New in version 2.5.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis ¶

Restore a Database. Note that this operation is not idempotent and any existing data in the database would be overwritten by this operation.
Update a Database.
Since all operations of this module takes a long time, it is recommended to set the wait to False. Use oci_database_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.

python >= 2.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

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.
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		Default: DEFAULT	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 required			Identifier of the Database that is required to be restored or updated. aliases: id
database_scn			System Change Number of the backup which should be used to restore the Database.
db_backup_config			Determines whether to configure automatic backups for the Database.
	auto_backup_enabled		Configures automatic backup if auto_backup_enabled=True
defined_tags			Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
freeform_tags			Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
latest			If latest=True, the Database is restored to the last known good state with the least possible data loss.
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: restore update ←	Desired action to be performed on Database
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
timestamp			The timestamp to which Database gets restored.
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.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

# Note: These examples do not set authentication details.
# Update Database Backup Configuration
- name: Enable automatic Database Backups for a Database
  oci_database:
      database_id: 'ocid1.database.aaaa'
      db_backup_config:
          auto_backup_enabled: True
      state: 'update'
#Restore Database from latest backup
- name: Restore Database from latest backup
  oci_database:
      database_id: 'ocid1.database.aaaa'
      latest: True
      wait: False
      state: 'restore'

Return Values ¶

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

Key		Returned	Description
database complex		success	Attributes of the Database. Sample: {'lifecycle_state': 'BACKUP_IN_PROGRESS', 'ncharacter_set': 'AL16UTF16', 'compartment_id': 'ocid1.compartment.aaaa', 'defined_tags': {'target_users': {'division': 'design'}}, 'pdb_name': None, 'freeform_tags': {'deployment': 'test'}, 'time_created': '2018-02-22T08:42:26.060000+00:00', 'db_workload': 'OLTP', 'db_backup_config': {'auto_backup_enabled': False}, 'db_name': 'ansibledb', 'db_home_id': 'ocid1.dbhome.oc1.iad.xxxxxEXAMPLExxxxx', 'db_unique_name': 'ansibledb_iad2cj', 'lifecycle_details': None, 'character_set': 'AL32UTF8', 'id': 'ocid1.database.oc1.iad.xxxxxEXAMPLExxxxx'}
	lifecycle_state string	always	The current state of the Database. Sample: AVAILABLE
	ncharacter_set string	always	The national character set for the database. Sample: AL16UTF16
	compartment_id string	always	The identifier of the compartment containing the DB System where the Database resides. Sample: ocid1.compartment.oc1.xzvf..oifds
	pdb_name string	always	Pluggable database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. Sample: ocid1.vnic.oc1.iad.xxxxxEXAMPLExxxxx
	db_workload string	always	Database workload type. Sample: OLTP
	time_created datetime	always	Date and time when the DB Node was created, in the format defined by RFC3339 Sample: 2016-08-25 21:10:29.600000
	character_set string	always	The character set for the database. Sample: AL32UTF8
	db_backup_config string	always	Determines whether to configure automatic backup of the Database. Sample: db_backup_config:{ auto_backup_enabled:false }
	db_name string	always	The database name. Sample: ansibledb
	db_home_id string	always	The identifier of the DB Home containing the Database. Sample: ocid1.dbhome.oc1.iad.xxxxxEXAMPLExxxxx
	db_unique_name string	always	A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed. Sample: ansibledb_iad7b
	lifecycle_details string	always	Additional information about the current lifecycle_state of the Database. Sample: AVAILABLE
	id string	always	Identifier of the Database. Sample: ocid1.database.oc1.iad.xxxxxEXAMPLExxxxx
	software_storage_size_in_gb string	always	Storage size, in GBs, of the software volume that is allocated to the DB system. This is applicable only for VM-based DBs. Sample: 1024

Status ¶

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.