DBaaS CLI Command Reference
dbaascli is a command-line utility for database lifecycle and administration tasks on Oracle Base Database Cloud@Customer. It uses DBCA functionality to create databases from templates and OCI APIs to integrate them with cloud automation. For scripted database creation, call dbaascli instead of DBCA. If a required DBCA feature is unavailable in dbaascli, open a My Oracle Support service request.
You can also use dbaascli to apply database updates and manage pluggable databases (PDBs). Use the DBaaS console or command-line interface (CLI) to scale resources. When connectivity between the Control Plane Server and the OCI region is disrupted, you can use dbaascli system scaleCPU to change the CPU core count for a VM cluster.
To run dbaascli, connect to an Oracle Base Database Cloud@Customer virtual machine. See Connecting to a Virtual Machine with SSH. Unless a command states otherwise, run administration commands as root.
Use dbaascli --help to list available commands. For command-specific help, run the command with --help, for example, dbaascli database create --help.
Browse the command groups below or use the alphabetical index to find syntax, parameters, and examples.
- Administration and Configuration
- Cloud Software Library (CSWLIB) Management
- Database Management
- Data Guard Management
- Database Home Management
- Grid Infrastructure Management
- Pluggable Database (PDB) Management
- Transparent Data Encryption (TDE) Management
Alphabetical Command Index
Select a command to open its reference entry.
dbaascli admin updateStackdbaascli cswlib deleteLocaldbaascli cswlib downloaddbaascli cswlib listLocaldbaascli cswlib showImagesdbaascli database addInstancedbaascli database backupdbaascli database bouncedbaascli database changepassworddbaascli database convertToPDBdbaascli database createdbaascli database createTemplatedbaascli database deletedbaascli database deleteInstancedbaascli database duplicatedbaascli database getDetailsdbaascli database getPDBsdbaascli database modifyParametersdbaascli database movedbaascli database recoverdbaascli database runDatapatchdbaascli database startdbaascli database stopdbaascli database upgradedbaascli dataguard configureAWRdbaascli dataguard configureStandbydbaascli dataguard deregisterStandbydbaascli dataguard failoverdbaascli dataguard prepareForStandbydbaascli dataguard prepareStandbyBlobdbaascli dataguard registerStandbydbaascli dataguard reinstatedbaascli dataguard switchoverdbaascli dataguard updateConfigurationdbaascli dataguard updateDGConfigAttributesdbaascli dbhome createdbaascli dbHome deletedbaascli dbhome getDatabasesdbaascli dbHome getDetailsdbaascli dbHome patchdbaascli diag collectdbaascli diag healthCheckdbaascli grid configureTCPSdbaascli grid patchdbaascli grid removeTCPSCertdbaascli grid rotateTCPSCertdbaascli grid upgradedbaascli gridHome createdbaascli job getStatusdbaascli pdb backupdbaascli pdb bouncedbaascli pdb closedbaascli pdb createdbaascli pdb deletedbaascli pdb getConnectStringdbaascli pdb getDetailsdbaascli pdb listdbaascli pdb localClonedbaascli pdb opendbaascli pdb recoverdbaascli pdb refreshdbaascli pdb relocatedbaascli pdb remoteClonedbaascli system getDBHomesdbaascli system getGridHomesdbaascli system scalecpudbaascli tde addSecondaryHsmKeydbaascli tde changePassworddbaascli tde enableWalletRootdbaascli tde encryptTablespacesInPDBdbaascli tde fileToHsmdbaascli tde getHsmKeysdbaascli tde getMkidForKeyVersionOCIDdbaascli tde getPrimaryHsmKeydbaascli tde hsmToFiledbaascli tde listKeysdbaascli tde removeSecondaryHsmKeydbaascli tde rotateMasterKeydbaascli tde setKeyVersiondbaascli tde setPrimaryHsmKeydbaascli tde status