Using dbaasapi

You can use the dbaasapi command line utility to create and delete databases on an Exadata DB system. The utility operates like a REST API. It reads a JSON request body and produces a JSON response body in an output file.

The utility is located in the /var/opt/oracle/dbaasapi/ directory on the compute nodes and must be run as the root user.

To learn how to add or remove Exadata databases by using the Oracle Cloud InfrastructureConsole or API instead, see Managing Exadata Databases.

Note

You must update the cloud-specific tooling on all the compute nodes in your Exadata DB system before performing the following procedures. For more information, see Updating an Exadata DB System.

Only one dbaasapi operation can execute at a given time. Oracle recommends that you check the status of an operation to ensure it completed before you run another operation.

Prerequisites

If you plan to create a database and store its backups in the Oracle Cloud Infrastructure Object Storage, refer to the prerequisites in Backing Up an Exadata Database, and ensure that the system meets the networking requirements for backing up to Object Storage. Review the Create Database Parameters and gather the information you'll need to supply in the input file you create for the dbaasapi operation.

Warning

Oracle recommends that you avoid specifying parameter values that include confidential
information when you use the dbaasapi commands.

Creating a Database

The following procedure creates directory called dbinput, a sample input file called myinput.json, and a sample output file called createdb.out.

Create the input file in the directory. The following sample file will create a database configured to store backups in an existing bucket in Object Storage. For parameter descriptions, see Create Database Parameters.

The database version as 18.0.0.0, 12.2.0.1, 12.1.0.2, or 11.2.0.4, in quotes.

adminPassword

The administrator (SYS and SYSTEM) password to use for the new database, in quotes. The password must be nine to thirty characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.

The database national character set. The value AL16UTF16 or UTF8, in quotes.

backupDestination

The database backup destination, in quotes. You can configure the following backup destinations.

NONE No backup destination is configured.

DISK Configure database backups to the local disk Fast Recovery Area.

OSS Configure database backups to an existing bucket in the Oracle Cloud Infrastructure Object Storage service. You must specify all the cloudStorage parameters.

BOTH Configure database backups to both local disk and an existing bucket in Object Storage. You must specify all the cloudStorage parameters.

For example:

"backupDestination":"BOTH"

cloudStorageContainer=<swift_url>

Required if you specify a backup destination of OSS or BOTH. The Object Storage URL, your Oracle Cloud Infrastructure tenant, and an existing bucket in the object store to use as the backup destination, in the following format: