oci_autonomous_database - Create,update and terminate an Autonomous Database in OCI Database Cloud Service.

New in version 2.5.

Synopsis

  • Create an OCI Autonomous Database
  • Update an OCI Autonomous Database, if present, with a new display name
  • Terminate an OCI Autonomous Database, if present.
  • Restore a specific state of an OCI Autonomous Database
  • Start and Stop an OCI Autonomous Database
  • Since all operations of this module takes a long time, it is recommended to set the wait to False. Use oci_autonomous_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.

Parameters

Parameter Choices/Defaults Comments
admin_password
A strong password for Admin. The password must be between 12 and 60 characters long, and must contain at least 1 uppercase, 1 lowercase and 2 numeric characters. It cannot contain the double quote symbol ("). It must be different than the last 4 passwords.
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.
autonomous_database_id
Identifier of the existing Autonomous Database which required to be updated, terminated, restored, started or stopped. Mandatory for terminate, update, restore, start and stop.

aliases: id
compartment_id
Identifier of the compartment under which this Autonomous Database would be created. Mandatory for create operation.
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.
cpu_core_count
The number of CPU cores to be made available to the Autonomous Database.
data_storage_size_in_tbs
The size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed.
db_name
The database name. The name must begin with an alphabetic character and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy.
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.
display_name
The user-friendly name for the Autonomous Database. It does not have to be unique.
force
bool
    Choices:
  • no
  • yes ←
Force overwriting existing wallet file when downloading wallet.

aliases: overwrite
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.
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.
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.
license_model
    Choices:
  • LICENSE_INCLUDED
  • BRING_YOUR_OWN_LICENSE
The Oracle license model that applies to all the databases on the Autonomous Database. The default is LICENSE_INCLUDED.
password
The password to encrypt the keys inside the wallet. The password must be at least 8 characters long and must include at least 1 letter and either 1 numeric character or 1 special character. password is required if state='generate_wallet'.
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
    Choices:
  • present ←
  • absent
  • restore
  • start
  • stop
  • generate_wallet
Create, update, terminate, restore, start, stop and generate wallet for Autonomous Database. For state=present, if it does not exist, it gets created. If it exists, it gets updated.
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 time to restore the database to.
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.
wallet_file
The destination file path with file name when downloading wallet. The file must have 'zip' extension. wallet_file is required if state='generate_wallet'.

Examples

# Note: These examples do not set authentication details.
# Create Autonomous Database
- name: Create Autonomous Database
  oci_autonomous_database:
    compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx..qndq'
    admin_password: 'BEstr0ng_#1'
    data_storage_size_in_tbs: 1
    cpu_core_count: 2
    db_name: 'autonomousdb'
    display_name: 'autonomousdb'
    initial_data_storage_size_in_tbs: 2
    license_model: 'LICENSE_INCLUDED'
    node_count: 1
    freeform_tags:
        deployment: 'production'
    defined_tags:
        target_users:
            division: 'documentation'
    wait: False
    state: 'present'

# Update Autonomous Database's CPU core count
- name: Update Autonomous Database
  oci_autonomous_database:
    autonomous_database_id: 'ocid1.autonomousdatabase.oc1..xxxxxEXAMPLExxxxx..qndq'
    cpu_core_count: 4
    state: 'present'

# Restore Autonomous Database
- name: Restore Autonomous Database with the time to restore the database to.
  oci_autonomous_database:
    autonomous_database_id: 'ocid1.autonomousdatabase.oc1..xxxxxEXAMPLExxxxx..qndq'
    timestamp: '2018-03-23T00:59:07.032Z'
    state: 'restore'

# Start Autonomous Database
- name: Start Autonomous Database
  autonomous_database:
    autonomous_database_id: 'ocid1.autonomousdatabase.oc1..xxxxxEXAMPLExxxxx..qndq'
    state: 'start'

# Stop Autonomous Database
- name: Stop Autonomous Database
  oci_autonomous_database:
    autonomous_database_id: 'ocid1.autonomousdatabase.oc1..xxxxxEXAMPLExxxxx..qndq'
    state: 'stop'

# Download wallet for Autonomous Database
- name: Download wallet for Autonomous Database
  oci_autonomous_database:
    autonomous_database_id: 'ocid1.autonomousdatabase.oc1..xxxxxEXAMPLExxxxx'
    password: 'BEstr0ng_#1'
    wallet_file: '/tmp/atp_wallet.zip'
    state: 'generate_wallet'

# Delete Autonomous Database
- name: Delete Autonomous Database
  oci_autonomous_database:
    autonomous_database_id: 'ocid1.autonomousdatabase.oc1..xxxxxEXAMPLExxxxx..qndq'
    state: 'absent'

Return Values

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

Key Returned Description
autonomous_database
complex
success
Attributes of the launched/updated Autonomous Database. For delete, deleted Autonomous Database description will be returned.

Sample:
{'lifecycle_state': 'AVAILABLE', 'display_name': 'ansible-autonomous-database-955', 'cpu_core_count': 1, 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'defined_tags': {'ansible_tag_namespace_integration_test_1': {'ansible_tag_1': 'initial'}}, 'freeform_tags': {'system_license': 'trial'}, 'time_created': '2018-09-22T15:06:55.426000+00:00', 'db_name': 'autodbbackup', 'license_model': 'LICENSE_INCLUDED', 'connection_strings': {'high': 'adwc.EXAMPLE1.oraclecloud.com:1522/EXAMPLE1_autodb_high.atp.oraclecloud.com', 'medium': 'adwc.EXAMPLE3.oraclecloud.com:1522/EXAMPLE3_autodb_medium.atp.oraclecloud.com', 'low': 'adwc.EXAMPLE2.oraclecloud.com:1522/EXAMPLE2_autodb_low.atp.oraclecloud.com'}, 'lifecycle_details': None, 'data_storage_size_in_tbs': 1, 'id': 'ocid1.autonomousdatabase.oc1.iad.xxxxxEXAMPLExxxxx', 'service_console_url': 'https://example1.oraclecloud.com/console/index.html? tenant_name=OCID1.TENANCY.OC1..xxxxxEXAMPLExxxxx &database_name=ANSIBLEAUTODB&service_type=ATP'}
  lifecycle_state
string
always
The current state of the Autonomous Database.

Sample:
AVAILABLE
  display_name
string
always
The user-friendly name for the Autonomous Database.

Sample:
ansibleautodb
  cpu_core_count
string
always
The number of CPU cores to enable.

Sample:
2
  compartment_id
string
always
The identifier of the compartment containing the Autonomous Database

Sample:
ocid1.compartment.oc1.xzvf.xxxxxEXAMPLExxxxx
  time_created
datetime
always
Date and time when the Autonomous Database was created, in the format defined by RFC3339

Sample:
2016-08-25 21:10:29.600000
  db_name
string
always
The database name.

Sample:
ansibleautodb
  license_model
string
always
The Oracle license model that applies to all the databases on the Autonomous Database

Sample:
LICENSE_INCLUDED
  connection_strings
dict
always
The connection string used to connect to the Autonomous Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Database for the password value.

Sample:
{'high': 'adwc.EXAMPLE1.oraclecloud.com:1522/EXAMPLE1_autodb_high.atp.oraclecloud.com', 'medium': 'adwc.EXAMPLE3.oraclecloud.com:1522/EXAMPLE3_autodb_medium.atp.oraclecloud.com', 'low': 'adwc.EXAMPLE2.oraclecloud.com:1522/EXAMPLE2_autodb_low.atp.oraclecloud.com'}
  lifecycle_details
string
always
Additional information about the current lifecycle state.

Sample:
details
  data_storage_size_in_tbs
string
always
Data storage size, in terrabytes, that is currently available to the Autonomous Database.

Sample:
2048
  id
string
always
The identifier of the Autonomous Database

Sample:
ocid1.autonomousdatabase.oc1.xzvf.xxxxxEXAMPLExxxxx
  service_console_url
string
always
The URL of the Service Console for the Autonomous Database.

Sample:
https://example1.oraclecloud.com/console/index.html? tenant_name=OCID1.TENANCY.OC1..xxxxxEXAMPLExxxxx &database_name=ANSIBLEAUTODB&service_type=ATP


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.