16 Oracle Database Appliance Command-Line Interface

The command-line interface has different classes of tools to manage Oracle Database Appliance.

• About Oracle Database Appliance Command-Line Interface
  Three classes of tools are available to perform deployment, lifecycle management, and system administration on Oracle Database Appliance.
• Managing ODACLI Privileges and Security with SUDO
  Oracle Appliance Manager command-line utility requires root system privileges for most administration actions. You may want to use SUDO as part of your system auditing and security policy.
• ODACLI Command Changes with Multi-User Access on Oracle Database Appliance
  Understand the ODACLI command changes when you enable multi-user access.
• odacli Network Commands
  Use the odacli network commands to list and describe network interfaces.
• odacli Multi-User Access Commands
  Use odacli commands to enable multi-user access for the appliance.
• odacli Apply Patch and Update Commands
  Use the commands odacli update and apply patch to apply patches and update the appliance.
• odacli Appliance Commands
  Use the odacli appliance commands to perform lifecycle activities for the appliance.
• odacli Backup and Recovery Commands
  Use the odacli backup and recover commands to backup to and restore from Oracle Cloud Infrastructure Object Storage or disk or NFS.
• odacli Oracle Data Guard Commands
  Use ODACLI commands to configure and manage Oracle Data Guard in your Oracle Database Appliance deployment.
• odacli CPU Core Commands
  Use the CPU Core commands to enable CPU cores and display current and historical CPU core configurations.
• odacli CPU Pool Commands for Bare Metal and KVM
  Use odacli commands to manage resource allocations on Oracle Database Appliance for bare metal and KVM deployments.
• odacli Database Commands
  Use the odacli database commands to perform database lifecycle operations.
• odacli DBHome Commands
  Use the odacli DBHome commands to manage database Home operations.
• odacli Database Storage Commands
  Use the Database Storage commands to list, describe, create, and delete Oracle database storage.
• odacli Job Commands
  Use the odacli list-jobs and odacli describe-job commands to display job details.
• Log Commands
  Use the odacli log commands to specify the options to collect and delete logs.
• odacli Oracle Auto Service Request Commands
  Use the Oracle Auto Service Request (Oracle ASR) commands to configure, update, test, and delete Oracle ASR on the system.
• odacli OS Commands
  Use the odacli OS commands to list and update operating system (OS) parameters.
• odaadmcli Hardware Monitoring Commands
  Use the hardware monitoring commands to display hardware configurations.
• Storage Commands
  Understand the commands to perform storage operations and diagnostics.

About Oracle Database Appliance Command-Line Interface

Three classes of tools are available to perform deployment, lifecycle management, and system administration on Oracle Database Appliance.

The command-line interface (CLI) is an alternative to Oracle Database Appliance Browser User Interface for some appliance configuration and patching tasks, database management, and job activity.

Oracle Database Appliance uses a role-based command-line interface. Use the odacli commands to perform lifecycle management tasks and the odaadmcli commands to perform storage and hardware monitoring maintenance. Many tasks related to managing Oracle Databases are also required with databases on Oracle Database Appliance. Tasks common to Oracle Database generally are described in the Oracle Database documentation library. However, to simplify tasks, use the Oracle Database Appliance command-line interface. The odacli and odaadmcliutilities combine the capabilities of the SYS database administrator role and the operating system Superuser (root user). Always perform administrative tasks using the Oracle Database Appliance Browser User Interface or CLI utilities.

The following classes of commands are available:

• Deployment and Configuration: Use the deployment and configuration commands as part of the initial deployment of the appliance and to configure CPU cores.

• Lifecycle management: Use odacli commands to perform database and system administration tasks for the appliance. The odacli commands are the primary interface to perform life cycle activities for the appliance.

• Administration: Use odaadmcli commands to perform hardware administration tasks for the appliance. The odaadmcli commands are the interface for infrequent administration activities needed to manage appliance hardware components, storage, and VLAN.

You can perform the following deployment and configuration tasks:

• Configure the first network in the appliance

• Unzip and copy the Oracle Database Appliance software to the correct locations

• Set the number of CPU Cores for the system

You can perform the following appliance lifecycle tasks with odacli commands:

• Create and describe the appliance

• Create, list, describe, and delete databases

• Create, list, describe, and delete Oracle Database Homes

• Create, list, and describe the networks

• List and describe the jobs

You can perform the following appliance administration tasks with odaadmcli commands:

• Show storage, disks, diskgroups, and controllers

• Display storage diagnostics for disks and NVM Express (NVMes)

• Show server, memory, processor, power, cooling, and network details

Depending on your version of Oracle Appliance Manager and your hardware, some of the odacli commands may not be available to you. To see which commands are supported on your version of Oracle Appliance Manager and your hardware, run the odacli help command: odacli -h.

Command-Line Interface Syntax

The command-line interface commands and parameters are case-sensitive.

An odacli or odaadmclicommand uses the following command syntax:

odacli command [options]

• command is an action you want to perform on the appliance. For example: odacli list-networks or odacli describe-jobs.

• options are optional parts of the odacli command. Options can consist of one or more options that extend the use of the odacli command carried out on an object. Options include additional information about the action that you want to perform on the object. Option names are preceded with a dash. Some options require the name of an object for the command to perform the action that you want to carry out. If an option is preceded with an * (asterisk), this information is required to submit the command. When appending -j to the odacli command, the output is returned in JSON format. The help option (-h) is an option that is available with almost all commands. When you include the -h option, you can obtain additional information about the command that you want to perform.

Example 16-1 Command-Line Interface Syntax

# odacli create-database -h 

Usage: create-database [options]   
Options:   
 * --adminpassword, -m
       Password for SYS,SYSTEM and PDB Admin
  --backupconfigid, -bi
       Backup Config ID     
  --cdb, -c
       Create Container Database (Inverse option: --no-cdb/-no-c)    
  --characterset, -cs
       Character Set (default:AL32UTF8)        Default: AL32UTF8     
  --databaseUniqueName, -u
       database unique name     
  --dbclass, -cl
       Database Class EE: OLTP/DSS/IMDB, SE: OLTP     Default: OLTP
  --dbconsole, -co
       Enable Database Console (Inverse option: --no-dbconsole/-no-co)     
  --dbhomeid, -dh
       Database Home ID (Use Existing DB Home)     
  --dblanguage, -l
       Datbase Language (default:AMERICAN)        Default: AMERICAN   
* --dbname, -n
       Database Name     
  --dbshape, -s
       Database Shape{odb1s,odb1,odb2,etc.}        Default: odb1
  --dbstorage, -r
       Database Storage {ACFS|ASM}        Default: ACFS  
  --dbterritory, -dt
       Database Territory (default:AMERICA)        Default: AMERICA     
  --dbtype, -y
       Database Type: SI        Default: SI     
  --help, -h
       get help
  --instanceonly, -io
       Create Instance Only (For Standby)    
  --json, -j
       json output 
  --nlscharacterset, -ns
       NLS Character Set (default:AL16UTF16)        Default: AL16UTF16
   --no-cdb, -no-c        
    Won't create Container Database (Inverse option: --cdb/-c)
    --no-dbconsole, -no-co
    Disable Database Console (Inverse option: --dbconsole/-co)
  --pdbadmin, -d
       Pluggable Database Admin User     
  --pdbname, -p
       Pluggable Database Name     
  --version, -v
       Database Version

Oracle Database Appliance Manager Command-Line Interface Help

Run the -h command to see the usage information for all commands available for your Oracle Database Appliance. For example:

odacli -h

Run odacli command -h or odacliadm command -h to see detailed help about a specific command. For example, to see detailed help for the odacli describe-dbhome command, use the following:

odacli describe-dbhome -h

Managing ODACLI Privileges and Security with SUDO

Oracle Appliance Manager command-line utility requires root system privileges for most administration actions. You may want to use SUDO as part of your system auditing and security policy.

For most tasks, Oracle recommends that you log in as root to use the Oracle Appliance Manager command-line interface on Oracle Database Appliance. If you are not logged in as root, then you cannot carry out most actions on the appliance. For example, if you are not logged in as root, then you can view storage information, but you cannot modify the storage.

Allowing Root User Access Using SUDO

In environments where system administration is handled by a different group than database administration, or where security is a significant concern, you may want to limit access to the root user account and password. SUDO enables system administrators to grant certain users (or groups of users) the ability to run commands as root, while logging all commands and arguments as part of your security and compliance protocol.

A SUDO security policy is configured by using the file /etc/sudoers. Within the sudoers file, you can configure groups of users and sets of commands to simplify and audit server administration with SUDO commands.

Caution:

Configuring SUDO to allow a user to perform any operation is equivalent to giving that user root privileges. Consider carefully if this is appropriate for your security needs.

Example 16-2 SUDO Example 1: Allow a User to Perform Any ODACLI Operation

This example shows how to configure SUDO to enable a user to perform any ODACLI operation. You do this by adding lines to the commands section in the /etc/sudoers file:

## The commands section may have other options added to it.
##
Cmnd_Alias ODACLI_CMDS=/opt/oracle/dcs/bin/odacli *
jdoe ALL = ODACLI_CMDS

In this example, the user name is jdoe. The file parameter setting ALL= ODACLI_CMDS grants the user jdoe permission to run all odacli commands that are defined by the command alias ODACLI_CMDS. After configuration, you can copy one sudoers file to multiple hosts. You can also create different rules on each host.

Note:

Before database creation, you must set up user equivalency with SSH for the root user on each server. If you do not set up user equivalency and configure SSH on each server, then you are prompted to provide the root password for each server during database creation.

After you configure the sudoer file with the user, the user jdoe can run the set of odacli commands configured with the command alias ODACLI_CMDS. For example:

odacli create-database --dbname newdb -m
Enter new 'SYS, SYSTEM and PDB Admin user' password: 
Confirm 'SYS, SYSTEM and PDB Admin user' password:

Job details 
----------------------------------------------------------------
                     ID: 1bc31577-f910-4d3f-b6ff-8e3fccd30141
            Description: Database service creation with db name: newdb
                 Status: Created
                Created: November 30, 2018 9:23:57 AM PST
                Message: 

Task Name Start Time End Time Status 
----------------------------------------------------------- 

Example 16-3 SUDO Example 2: Allow a User to Perform Only Selected ODACLI Operations

To configure SUDO to allow a user to perform only selected ODACLI operations, add lines to the commands section in the /etc/sudoers file as follows:

## DCS commands for oracle user 
Cmnd_Alias DCSCMDS = /opt/oracle/dcs/bin/odacli describe-appliance
oracle  ALL=       DCSCMDS

$ sudo /opt/oracle/dcs/bin/odacli describe-appliance

Appliance Information
----------------------------------------------------------------
                     ID: a977bb04-6cf0-4c07-8e0c-91a8c7e7ebb8
               Platform: OdaliteL
        Data Disk Count: 6
         CPU Core Count: 20
                Created: October 24, 2017 6:51:52 AM HDT

System Information
----------------------------------------------------------------
                   Name: systeml001
            Domain Name: example.com
              Time Zone: America/Adak
             DB Edition: EE
            DNS Servers: 10.200.76.198 10.200.76.199 192.0.2.254
            NTP Servers: 10.200.0.1 10.200.0.2

Disk Group Information
----------------------------------------------------------------
DG Name                   Redundancy                Percentage
------------------------- ------------------------- ------------
Data                      Normal                    90
Reco                      Normal                    10

In this example, the user jdoe2 tries to run the sudo odacli list-databases command, which is not part of the set of commands that is configured for that user. SUDO prevents jdoe2 from running the command.

[jdoe2@servernode1 ~]$ sudo /opt/oracle/dcs/bin/odacli list-databases

Sorry, user jdoe2 is not allowed to execute '/opt/oracle/dcs/bin/odacli list-databases' as root on servernode1.

ODACLI Command Changes with Multi-User Access on Oracle Database Appliance

Understand the ODACLI command changes when you enable multi-user access.

ODACLI Command Usage and Entitlement Requirements When Multi-User Access is Enabled

Note:

If you have enabled multi-user access, then you can run all supported ODACLI commands on KVM and DB systems, after logging in as odaadmin.

Note:

The authentication token support for ODACLI session management is linked to a multi-user access user account. Since root is an operating system administrative user and not a multi-user access user, auth token based session management system is not supported when a user logs in as root. Therefore, you must provide an Oracle Database Appliance account user name and password to run any ODACLI command.

The following table describes the ODACLI commands that have changes for multi-user access and the entitlements required to run the commands.

ODACLI Command	Roles Required	Changes in command option
odacli configure-firstnet	ODA-ADMINISTRATOR	No change
odacli create-network	ODA-ADMINISTRATOR	No change
odacli delete-network	ODA-ADMINISTRATOR	No change
odacli delete-networkinterface	ODA-ADMINISTRATOR	No change
odacli describe-network	ODA-ADMINISTRATOR, ODA-DB	No change
odacli describe-networkinterface	ODA-ADMINISTRATOR, ODA-DB	No change
odacli list-networks	ODA-ADMINISTRATOR, ODA-DB	No change
odacli list-networkinterfaces	ODA-ADMINISTRATOR, ODA-DB	No change
odacli update-network	ODA-ADMINISTRATOR	No change
odacli cleanup-patchrepo	ODA-ADMINISTRATOR, ODA-DB	No change
odacli create-prepatchreport	ODA-ADMINISTRATOR, ODA-DB	No change
odacli describe-prepatchreport	ODA-ADMINISTRATOR, ODA-DB	No change
odacli list-prepatchreports	ODA-ADMINISTRATOR, ODA-DB	No change
odacli delete-prepatchreport	ODA-ADMINISTRATOR, ODA-DB	No change
odacli list-availablepatches	ODA-ADMINISTRATOR, ODA-DB	No change
odacli describe-component	ODA-ADMINISTRATOR, ODA-DB	No change
odacli describe-latestpatch	ODA-ADMINISTRATOR, ODA-DB	No change
odacli list-agentconfig-parameters	ODA-ADMINISTRATOR	No change
odacli update-agentconfig-parameters	ODA-ADMINISTRATOR	No change
odacli delete-agentconfig-parameters	ODA-ADMINISTRATOR	No change
odacli update-dbhome	ODA-ADMINISTRATOR, ODA-DB	User odaadmin with the role of ODA-ADMINISTRATOR can update any database home. A custom user with the role of ODA-DB can only update a database home that they have primary access (as the creator) or shared access (as a user who is granted access by odaadmin).
odacli update-dcsadmin	ODA-ADMINISTRATOR	No change
odacli update-dcsagent	ODA-ADMINISTRATOR	No change
odacli update-dcscomponents	ODA-ADMINISTRATOR	No change
odacli update-registry	User with any role	No change
odacli update-repository	ODA-ADMINISTRATOR, ODA-DB	No change
odacli update-server	ODA-ADMINISTRATOR	No change
odacli update-storage	ODA-ADMINISTRATOR	No change
odaadmcli orachk	ODA-ADMINISTRATOR	No change
odacli set-credential	ODA-ADMINISTRATOR, ODA-DB	Not supported when multi-user access is enabled. When multi-user access is enabled, log in as a custom user and use odacli change-password instead.
odacli create-appliance	ODA-ADMINISTRATOR	Add an attribute called "isMultiUserAccessEnabled":true in the provision.json file. When you run the command, you are prompted to enter and confirm passwords for odaadmin, oracle and grid users and the provisioning job is submitted.
odacli describe-system	User with any role	No change
odacli list-featuretracking	ODA-ADMINISTRATOR	No change
odacli create-backup	ODA-ADMINISTRATOR, ODA-DB	Must have primary or shared access
odacli create-backupconfig	ODA-ADMINISTRATOR, ODA-DB	If creating backupconfig based on ObjectStoreSwift, user must be the creator of the ObjectStoreSwift.
odacli create-objectstoreswift	ODA-ADMINISTRATOR, ODA-DB	No change
odacli delete-backup	ODA-ADMINISTRATOR, ODA-DB	User must have primary (creator of that database) or shared access (granted by odaadmin) on the database whose backup is being deleted.
odacli delete-backupconfig	ODA-ADMINISTRATOR, ODA-DB	Must have primary or shared access
odacli describe-backupreport	ODA-ADMINISTRATOR, ODA-DB	Must have primary or shared access
odacli delete-objectstoreswift	ODA-ADMINISTRATOR, ODA-DB	Must have primary or shared access
odacli describe-schedule	ODA-ADMINISTRATOR, ODA-DB	Must have primary or shared access
odacli irestore-database	ODA-ADMINISTRATOR, ODA-DB	Must have primary or shared access
odacli list-backupconfigs	ODA-ADMINISTRATOR, ODA-DB	Must have primary or shared access
odacli list-backupreports	ODA-ADMINISTRATOR, ODA-DB	Must have primary or shared access
odacli list-objectstoreswifts	ODA-ADMINISTRATOR, ODA-DB	Must have primary or shared access
odacli list-schedules	ODA-ADMINISTRATOR, ODA-DB	No changes
odacli list-tdebackupreports	ODA-ADMINISTRATOR, ODA-DB	Must have primary or shared access
odacli recover-database	ODA-ADMINISTRATOR, ODA-DB	Must have primary or shared access
odacli restore-archivelog	ODA-ADMINISTRATOR, ODA-DB	Must have primary or shared access
odacli restore-tdewallet	ODA-ADMINISTRATOR, ODA-DB	Must have primary or shared access
odacli update-backupconfig	ODA-ADMINISTRATOR, ODA-DB	Must have primary or shared access
odacli update-schedule	ODA-ADMINISTRATOR, ODA-DB	No change
odacli configure-dataguard	ODA-ADMINISTRATOR, ODA-DB	The creator of the primary database and the standby database could be the same or different users. The default is oda-admin.
odacli deconfigure-dataguard	ODA-ADMINISTRATOR, ODA-DB	The creator of the primary database and the standby database could be the same or different users. The default is oda-admin.
odacli describe-dataguardstatus	ODA-ADMINISTRATOR, ODA-DB	No change
odacli failover-dataguard	ODA-ADMINISTRATOR, ODA-DB	No change
odacli list-dataguardstatus	ODA-ADMINISTRATOR, ODA-DB	No change
odacli reinstate-dataguard	ODA-ADMINISTRATOR, ODA-DB	No change
odacli switchover-dataguard	ODA-ADMINISTRATOR, ODA-DB	No change
odacli list-cpucores	ODA-ADMINISTRATOR	No change
odacli describe-cpucore	ODA-ADMINISTRATOR	No change
odacli update-cpucore	ODA-ADMINISTRATOR	No change
odacli create-cpupool	ODA-ADMINISTRATOR	Only odaadmin can create it but a non-admin user with role of ODA-DB can use them.
odacli remap-cpupools	ODA-ADMINISTRATOR	No change
odacli list-cpupools	ODA-ADMINISTRATOR, ODA-DB	A non-admin user with the role of ODA-DB can run the odacli list-cpupools command to view all available CPU pools.
odacli describe-cpupool	ODA-ADMINISTRATOR, ODA-DB	A non-admin user with the role of ODA-DB can run the odacli describe-cpupool command to view details of the CPU pool.
odacli modify-cpupool	ODA-ADMINISTRATOR	No change
odacli delete-cpupool	ODA-ADMINISTRATOR	No change
odacli list-auditrecords	ODA-ADMINISTRATOR	No change
odacli describe-auditrecord	ODA-ADMINISTRATOR	No change
odacli clone-database	ODA-ADMINISTRATOR, ODA-DB	User must have primary or shared access to the database home and the source database being cloned. A user with shared access to source database gets only shared access to the cloned database. Hence, the primary owner of the source database remains the primary owner of the cloned database in this case.
odacli create-database	ODA-ADMINISTRATOR, ODA-DB	For database creation in an existing database home, the user must have primary or shared access to the database home. A user with shared access to the database home gets only shared access to the new database, whose primary owner remains the primary owner of the database home. When using existing database storage for the new database, the user must have primary or shared access to that database storage.
odacli delete-database	ODA-ADMINISTRATOR, ODA-DB	Can access only those databases where the user has primary or shared access
odacli describe-database	ODA-ADMINISTRATOR, ODA-DB	Can access only those databases where the user has primary or shared access
odacli list-databases	ODA-ADMINISTRATOR, ODA-DB	User can only view listing of the databases for which they have primary or shared access. Use the -all option to view all databases and request access.
odacli modify-database	ODA-ADMINISTRATOR, ODA-DB	User should have primary or shared access to the database and the backupconfig being attached. Additionally, the primary owner (creator) of the database and backupconfig should be the same.
odacli move-database	ODA-ADMINISTRATOR, ODA-DB	User must have primary or shared access to the source database that is being moved and the target database home. Additionally, the primary owner of the source and target database home must be the same.
odacli register-database	ODA-ADMINISTRATOR, ODA-DB	User must be the primary owner (creator) of the database home on which this database is to be registered.
odacli upgrade-database	ODA-ADMINISTRATOR, ODA-DB	User must have primary or shared access to the source database (the database being upgraded) and the target database home. Additionally, the owner of the source and target database home must be the same.
odacli configure-dbhome-storage	ODA-ADMINISTRATOR	No change
odacli list-dbhome-storages	ODA-ADMINISTRATOR	No change
odacli describe-dbhome-storage	ODA-ADMINISTRATOR	No change
odacli modify-dbhome-storage	ODA-ADMINISTRATOR	No change
odacli create-dbhome	ODA-ADMINISTRATOR, ODA-DB	Can access only those database homes where the user has primary or shared access.
odacli delete-dbhome	ODA-ADMINISTRATOR, ODA-DB	Can access only those database homes where the user has primary or shared access.
odacli describe-dbhome	ODA-ADMINISTRATOR, ODA-DB	Can access only those database homes where the user has primary or shared access.
odacli list-dbhomes	ODA-ADMINISTRATOR, ODA-DB	Can access only those database homes where the user has primary or shared access. Use the -all option to view all database homes and request access.
odacli create-dbstorage	ODA-ADMINISTRATOR	Can access only those dbstorages where the user has primary or shared access.
odacli delete-dbstorage	ODA-ADMINISTRATOR	Can access only those dbstorages where the user has primary or shared access.
odacli describe-dbstorage	ODA-ADMINISTRATOR	Can access only those dbstorages where the user has primary or shared access.
odacli list-dbstorages	ODA-ADMINISTRATOR	Can access only those dbstorages where the user has primary or shared access.
odacli modify-dbstorage	ODA-ADMINISTRATOR	Can access only those dbstorages where the user has primary or shared access.
odacli update-dgstorage	ODA-ADMINISTRATOR	No change
odacli create-jobdata-retention-policy	ODA-ADMINISTRATOR	No change
odacli create-purge-jobdata-job	ODA-ADMINISTRATOR	No change
odacli delete-jobdata-retention-policy	ODA-ADMINISTRATOR	No change
odacli describe-job	User with any role	No change
odacli list-jobs	User with any role	No change
odacli list-jobdata-retention-policy	ODA-ADMINISTRATOR	No change
odacli list-purge-jobdata-job	ODA-ADMINISTRATOR	No change
odacli list-scheduled-executions	ODA-ADMINISTRATOR	No change
odaadmcli manage diagcollect	ODA-ADMINISTRATOR	No change
odacli create-auto-logclean-policy	ODA-ADMINISTRATOR	No change
odacli create-logcleanjob	ODA-ADMINISTRATOR	No change
odacli describe-logcleanjob	ODA-ADMINISTRATOR	No change
odacli list-auto-logclean-policy	ODA-ADMINISTRATOR	No change
odacli list-logcleanjobs	ODA-ADMINISTRATOR	No change
odacli list-logspaceusage	ODA-ADMINISTRATOR	No change
odacli configure-asr	ODA-ADMINISTRATOR	No change
odacli delete-asr	ODA-ADMINISTRATOR	No change
odacli describe-asr	ODA-ADMINISTRATOR	No change
odacli test-asr	ODA-ADMINISTRATOR	No change
odacli update-asr	ODA-ADMINISTRATOR	No change
odacli list-osconfigurations	ODA-ADMINISTRATOR	No change
odacli update-osconfigurations	ODA-ADMINISTRATOR	No change
odaadmcli show cooling	root	No change
odaadmcli show env_hw	root	No change
odaadmcli show fs	root	No change
odaadmcli show memory	root	No change
odaadmcli show network	root	No change
odaadmcli show power	root	No change
odaadmcli show processor	root	No change
odaadmcli show server	root	No change
odaadmcli asmops diskgroup	root	No change
odaadmcli expand storage	root	No change
odacli list-dgdisks	ODA-ADMINISTRATOR, ODA-DB	No change
odacli validate-storagetopology	ODA-ADMINISTRATOR	No change
odaadmcli power disk	root	No change
odaadmcli show controller	root	No change
odaadmcli show disk	root	No change
odaadmcli show diskgroup	root	No change
odaadmcli show raidsyncstatus	root	No change
odaadmcli show storage	root	No change
odaadmcli stordiag	root	No change

odacli Network Commands

Use the odacli network commands to list and describe network interfaces.

• odacli configure-firstnet
  Use the command configure-firstnet to configure the first network in the appliance after racking and connecting the power and network cables.
• odacli configure-pmem
  Use the odacli configure-pmem command to configure PMEM in the system.
• odacli create-network
  Use the odacli create-network command to create a network.
• odacli delete-network
  Use the command odacli delete-network to delete a network.
• odacli delete-networkinterface
  Use the command odacli delete-networkinterface to delete a network interface on Oracle Database Appliance X8-2 hardware models.
• odacli describe-network
  Use the odacli describe-network command to display the details of a specific network.
• odacli describe-networkinterface
  Use the odacli describe-networkinterface command to display the details of any network interface.
• odacli list-networks
  Use the odacli list-networks command to display networks.
• odacli list-networkinterfaces
  Use the odacli list-networkinterfaces command to display network interfaces.
• odacli update-network
  Use the odacli update-network command to update an existing network configuration.

odacli configure-firstnet

Use the command configure-firstnet to configure the first network in the appliance after racking and connecting the power and network cables.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  # /opt/oracle/dcs/bin/odacli configure-firstnet  

Usage Notes

This command ensures that the system is available in the network, enabling you to manage the deployment through the Oracle Appliance Manager Browser User Interface.

• Bonded network configuration: Bonded dual-ported interface. With the bonded configuration, you can only enable one of the interfaces. The bonded configuration supports VLANs. The bonded network configuration uses btbond1 on Oracle Database Appliance hardware models other than X8-2. On Oracle Database Appliance X8-2, the bonded network configuration uses btbond1 to btbond6. This is the default setting.

• Non-bonded network configuration (on Oracle Database Appliance hardware models other than X8-2): Two separate physical network interfaces, this configuration does not support VLANs. The non-bonded network configuration uses em2 and em3 as public interfaces. Note that Oracle Database Appliance X8-2 does not support non-bonded network configuration.

• To change a non-bonded network configuration to a bonded configuration, run the Oracle Database Appliance Cleanup Script and redeploy the appliance.

Example 16-4 Configuring the First Network as a Bonded Network

Configure the first network to use a btbond1 interface without configuring DHCP. Complete the IP address, netmask address, and gateway address.

Values that you need to provide are shown in italic font, with the exception of the net1 gateway address; the program obtains the gateway IP address. The program derives this gateway address using the network information you provided for the other IP addresses. Accept this value, unless your network administrator provides an alternative gateway address that is different from the default that the appliance command-line interface detects.

The following is an example of the command on a single node platform:

# /opt/oracle/dcs/bin/odacli configure-firstnet

Select the Interface to configure the network on (btbond1): btbond1
Configure DHCP on btbond1 (yes/no): no
INFO: You have chosen Static configuration
Enter the IP address to configure: 10.1.10.2
Enter the Netmask address to configure: 255.255.255.0
Enter the Gateway address to configure: 10.1.10.1
INFO: Plumbing the IPs now
INFO: Restarting the network
Shutting down interface btbond1: bonding: btbond1: Removing slave em2. 
bonding: btbond1: releasing active interface em2 
bonding: btbond1: making interface em3 the new active one. 
bonding: btbond1: Removing slave em3. 
bonding: btbond1: releasing active interface em3 
:::::::::: 

Example 16-5 Configuring the First Network as a Non-Bonded Network

The following is an example of a non-bonded configuration. For a non-bonded configuration, answer no to using a bonding public interface. Note that Oracle Database Appliance X8-2 does not support non-bonded network configuration.

# /opt/oracle/dcs/bin/odacli configure-firstnet
Using bonding public interface (yes/no) [yes]: no
INFO: Breaking the bonding on btbond1
INFO: remove bonding module: rmmod bonding
INFO: remove slave setup in /etc/sysconfig/network-scripts/ifcfg-em2
INFO: remove slave setup in /etc/sysconfig/network-scripts/ifcfg-em3
INFO: Restarting the network
Shutting down interface em1: [ OK ]
Shutting down loopback interface: [ OK ]
Bringing up loopback interface: [ OK ]
Bringing up interface em1: [ OK ]
Bringing up interface em2: [ OK ]
Bringing up interface em3: [ OK ]
INFO: Restarting the DCS agent
initdcsagent stop/waiting
initdcsagent start/running, process 57629
Select the Interface to configure the network on (em2 em3) [em2]:
Configure DHCP on em2 (yes/no) [no]:
INFO: You have chosen Static configuration
Enter the IP address to configure : 10.31.102.101
Enter the Netmask address to configure : 255.255.240.0
Enter the Gateway address to configure[10.31.96.1] :
INFO: Plumbing the IPs now
INFO: Restarting the network
Shutting down interface em1: [ OK ]
Shutting down interface em2: [ OK ]
Shutting down interface em3: [ OK ]
Shutting down loopback interface: [ OK ]
Bringing up loopback interface: [ OK ]
Bringing up interface em1: [ OK ]
Bringing up interface em2: Determining if ip address 10.31.102.101 is already in use for device em2...
[ OK ]
Bringing up interface em3: [ OK ]

odacli configure-pmem

Use the odacli configure-pmem command to configure PMEM in the system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli configure-pmem [-h]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.

Usage Notes

• By default, PMEM is configured in MemoryMode.
• When PMEM is running in MemoryMode, the sysctl.conf hugepage parameter can be set up based on different types of databases:
  • OLTP: 50% of total memory
  • In-memory: 50% of total memory
  • DSS: 25% of total memory
  • TimesTen: 80% of total memory

Example 16-6 Configure PMEM

# odacli configure-pmem
Configure PMEM in the system.
INFO: PMEM is configured in 'MemoryMode' mode.
Please select the database type - 1) OLTP 2) In-memory 3) DSS 4) TimesTen [4] 3
Setup the system to use PMEM in 'MemoryMode' mode for 'DSS' type database
The system will be reboot after finish the setup
Do you want to continue [Y/N] y

odacli create-network

Use the odacli create-network command to create a network.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli create-network [-d|-no-d] -n interface -p ipaddress  -w {Public|Dataguard|Database|Management|Backup|Other} -s subnetmask -g 
gateway[-h] [-sip] [-sn] [-vs] [-j]

Parameters

Parameter	Description
--defaultnetwork, -d	Identifies the default network.
--gateway, -g	Defines the network gateway. The gateway is required for the default network.
--help, -h	(Optional) Displays help for using the command.
--interface, -n	Defines the name of the network interface.
--interfacetype, -t	Defines the network interface type {BOND|PHYSICAL|VLAN|INTERNAL} (non case-sensitive).
--ipaddress, -p	Defines the network IP address. This can be specified in the format IPAddress or nodeNumber0:IPAddress0,nodeNumber1:IPAddress1,...
--json, -j	(Optional) Displays JSON output.
--networktype, -w	Defines the type of network. Options are: {Public|Dataguard|Database|Management|Backup|Other}. The default is Other.
--name, -m	Name of the network.
--no-defaultnetwork, no–d	Identifies a network as not the default network. Use --defaultnetwork -d to identify a default network.
--subnetmask, -s	Defines the Network Subnet Mask.
--scanips, -sip	Defines the SCAN IP addresses (in the format scanip0,scanip1,...)
--scanname, -sn	Defines the SCAN name.
--nodeNumber, -u	Defines the node number for High-Availability deployments. Note: This option is deprecated and will be desupported in a future release.
--vips, -vs	List of virtual IP addresses. They can be specified in the format vipname0:nodeNumber0:vip0,vipname1:nodenumber1:vip1,...
--vlanid, -v	Add VLAN as a new network. This option is available for for High-Availability deployments.

Usage Notes

• Network of public type can only be defined when deploying the appliance or when running odacli configure-firstnet during initial provisioning.
• Use this command to create an additional network not done in create-appliance.
• You are only allowed to create a network on the bond interface.
• On Oracle Database Appliance non-High Availability systems, you cannot specify Virtual IP addresses. The Virtual IP address is set to the same value as the IP address.
• Single Client Access Name (SCAN) cannot be set up on Oracle Database Appliance non-High Availability systems.

Example 16-7 Creating a Network

The following example creates a new network, sfpbond1, with IP address 192.0.2.15. The network is an additional network that uses subnet mask 255.255.255.0 and is not a default network.

# odacli create-network -n sfpbond1 -p 192.0.2.15 -w Backup -s 255.255.255.0 -no-d

Example 16-8 Creating a VLAN Network

odacli create-network -g 10.31.131.129 -n btbond1 -t VLAN -p 0:10.31.131.132,1:10.31.131.133 -m vlan150 -w Database -no-d -sip 10.31.131.134,10.31.131.135 -sn scaoda702c1-vlan150-scan -s 255.255.255.128 -vs scaoda702c1n1-vlan150-vip:0:10.31.131.136,scaoda702c1n2-vlan150-vip:1:10.31.131.137 -v 150

odacli delete-network

Use the command odacli delete-network to delete a network.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To delete a network:

odacli  delete-network -i id [-m] [-h] [-j]

Parameters

Parameter	Description
--id, -i	Defines the network identity.
--name, -m	Specifies the network name.
--json, -j	(Optional) Displays JSON output.
--help, -h	(Optional) Displays help for using the command.

Usage Notes

You cannot delete the Public-network or Private-network after the system is deployed.

On High-Availability systems, if the node number is not specified in the odacli delete-network command, then the network on both nodes is deleted.

Example 16-9 Deleting a Network

The following example deletes a backup network with a network ID of 55db39db-d95c-42c5-abbd-b88eb99b83ec.

# odacli delete-network -i 55db39db-d95c-42c5-abbd-b88eb99b83ec 

"jobId" : "c26d217e-419b-4a91-8680-7b06bcfe9828",   
"status" : "Running",   
"message" : null,   
"reports" : [ {
     "taskId" : "TaskSequential_137",
     "taskName" : "deleting network",
     "taskResult" : "Running",
     "startTime" : "December 8, 2021 23:14:32 PM EDT",
     "endTime" : "December 8, 2021 23:14:32 PM EDT",
     "status" : "Running",
     "taskDescription" : null,
     "parentTaskId" : "TaskSequential_135",
     "jobId" : "c26d217e-419b-4a91-8680-7b06bcfe9828",
     "tags" : [ ],
     "reportLevel" : "Info",
     "updatedTime" : "December 8, 2021 23:14:32 PM EDT"
   },{     
   "taskId" : "TaskZJsonRpcExt_142",
     "taskName" : "Setting up Network",
     "taskResult" : "Network setup success",
     "startTime" : "December 8, 2021 23:14:32 PM EDT",
     "endTime" : "December 8, 2021 23:14:32 PM EDT",
     "status" : "Success",
     "taskDescription" : null,
     "parentTaskId" : "TaskParallel_141",
     "jobId" : "c26d217e-419b-4a91-8680-7b06bcfe9828",
     "tags" : [ ],
     "reportLevel" : "Info",
     "updatedTime" : "December 8, 2021 23:14:32 PM EDT"   } ],
   "createTimestamp" : "December 8, 2021 23:14:32 PM EDT",
   "description" : "Network service delete",
   "updatedTime" : "December 8, 2021 23:14:32 PM EDT"
 }

odacli delete-networkinterface

Use the command odacli delete-networkinterface to delete a network interface on Oracle Database Appliance X8-2 hardware models.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To delete a network interface:

odacli  delete-networkinterface id [-h]

Parameters

Parameter	Description
-id	Defines the network interface name.
--help, -h	(Optional) Displays help for using the command.

Usage Notes

You cannot delete the network interface card in slot 7.

Example 16-10 Deleting a Network Interface

[root@oak ~]/opt/oracle/dcs/bin/odacli delete-networkinterface -m btbond4
{
"jobId" : "a81066e2-417e-4df6-b810-08df24c646c1",
"status" : "Running",
"message" : null,
"reports" : ,
"createTimestamp" : "December 8, 2021 00:01:09 AM UTC",
"resourceList" : ,
"description" : "Network Interface Deletion with name btbond4",
"updatedTime" : "December 8, 2021 00:01:09 AM UTC"
}

Example 16-11 Deleting btbond1 Network Interface is Not Allowed

[root@oak ~]# /opt/oracle/dcs/bin/odacli delete-networkinterface -m btbond1
DCS-10001:Internal error encountered: Delete operation is not allowed on network interface : btbond1. 

Example 16-12 Deleting Network Interface When Network Exists is Not Allowed

[root@oak ~]# opt/oracle/dcs/bin/odacli delete-networkinterface -m btbond3
DCS-10001:Internal error encountered: Delete operation is not allowed – networks {[Public-network]} found on interface btbond3. Pleae delete the network first.  

odacli describe-network

Use the odacli describe-network command to display the details of a specific network.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To display the details of a specific network:

 odacli  describe-network -i id [-j][-u][-h] 

Parameters

Parameter	Description
--id, -i	Identifies the network ID. Use the odacli list-networks command to obtain the id.
--json, -j	(Optional) Displays JSON output.
--help, -h	(Optional) Displays help for using the command.
--name, -m	Specifies the network name.
--nodeNumber, -u	(Optional) Displays the network interface information for the specified node. Note: This option is deprecated and will be desupported in a future release.

Example 16-13 Displaying Network Details

Enter the following command to display the details of the public network:

# odacli describe-network -m Public-network

Network details                      
----------------------------------------------------------------
                     ID:  a11573f1-cad4-41fc-9dd0-3ba958b605f8
                   Name:  Public-network
                    NIC:  btbond1
         Interface Type:  BOND
            Subnet Mask:  255.255.255.0
                Gateway:  10.31.116.1
                VLAN ID:  
                   Type:  Public 
                Default:  true
                Created:  March 30, 2020 8:37:00 AM PDT
                Updated:  March 30, 2020 10:25:27 AM PDT
                 Status:  Configured
          Node Networks:  [IP Address on node0: 10.31.117.60, IP Address on node1: 10.31.117.62]
              Scan Name:  scaoda1-scan
               Scan Ips:  10.31.117.64 10.31.117.65
                   Vips:  [scaoda1-vip on node0: 10.31.116.61, scaoda2-vip on node1: 10.31.116.63]
   Associated Databases: odacn db122a db122b db122c db122d       

Example 16-14 Displaying Network Details

Enter the following command to display the details of network ID 93c07043-3002-494a-8fa0-f3ae932fb4c5:

# odacli describe-network -i 93c07043-3002-494a-8fa0-f3ae932fb4c5 -u 1

Network details                                                  
----------------------------------------------------------------
                     ID:  93c07043-3002-494a-8fa0-f3ae932fb4c5
                   Name:  Private-network
                    NIC:  ibbond0
          InterfaceType:  BOND
             IP Address:  192.168.16.25
            Subnet Mask:  255.255.255.0
                Gateway:  
                 VlanId:  
                   Type:  Private 
                Default:  false
                Created:  November 18, 2018 10:54:16 PM PST

odacli describe-networkinterface

Use the odacli describe-networkinterface command to display the details of any network interface.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To display the details of a specific network interface:

 odacli describe-networkinterface -i id [-j][-h][-u]

Parameters

Parameter	Description
--id, -i	Identifies the network interface ID. Use the odacli list-networks command to obtain the id.
--json, -j	(Optional) Displays JSON output.
--help, -h	(Optional) Displays help for using the command.
--nodeNumber, -u	(Optional) Displays the network interface information for the specified node. Note: This option is deprecated and will be desupported in a future release.

Usage Notes

By default, this command always displays the network interface description of the local node. To display the description of another node, specify the node number option (-u).

Example 16-15 Displaying Network Details

Enter the following command to display the details of network interface with ID fe1bf0a7-f56e-44cd-9a84-f374c0aa4b61:

# /opt/oracle/dcs/bin/odacli describe-networkinterface  
-i fe1bf0a7-f56e-44cd-9a84-f374c0aa4b61 -u 1 

Network Interface details 
---------------------------------------------------------------- 
                     ID:  fe1bf0a7-f56e-44cd-9a84-f374c0aa4b61 
                   Name:  eth2 
                    NIC:  eth2 
                   Type:  PHYSICAL 
                Members:  eth2 
        Slave Interface:  true 
                Created:  October 16, 2018 1:16:59 PM PDT 

odacli list-networks

Use the odacli list-networks command to display networks.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

 odacli list-networks  [-j] [-h] 

Parameters

Parameter	Description
--json, -j	(Optional) Displays JSON output.
--help, -h	(Optional) Displays help for using the command.
--nodeNumber, -u	(Optional) Displays the network interface information for the specified node. Note: This option is deprecated and will be desupported in a future release.

Example 16-16 Displaying a List of Networks

Use the odacli list-networks command to display a list of networks:

# odacli list-networks
ID Name NIC Interface Type Subnet Mask Gateway VLAN ID Node Networks 
-------------------------------------- -------------------- ------------ --------------- ------------------ ------------------ -------- -----------------------
30012eeb-1205-4cb6-9fc0-488972b2e420 Private-network priv0 INTERNAL 255.255.255.240 [IP Address on node0: 192.168.16.24]
75d01d4f-e940-4d0f-a4fe-ee04f5a90c73 Public-network btbond1.370 VLAN 255.255.255.0 10.209.10.241 370 [IP Address on node0: 10.209.10.244]

odacli list-networkinterfaces

Use the odacli list-networkinterfaces command to display network interfaces.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-networkinterfaces  [-j] [-h] [-u]

Parameters

Parameter	Description
--json, -j	(Optional) Displays JSON output.
--help, -h	(Optional) Displays help for using the command.
--nodeNumber, -u	(Optional) Displays the network interface information for the specified node. Note: This option is deprecated and will be desupported in a future release.

Example 16-17 Displaying a List of Network Interfaces

Use the odacli list-networkinterfaces command to display a list of network interfaces:

# odacli list-networkinterfaces -u 1
ID                                       Name                 NIC           Type      
---------------------------------------- --------------------  
d5907a23-1c5d-48c7-8d47-2c188ed43ddd     bond0                bond0         BOND       
4f7ea558-9a43-42a9-8e08-6bfdf3a33229     bond1                bond1         BOND       
743ced8d-bbe5-4987-b316-5fdf95d5e60b     eth0                 eth0          PHYSICAL   
a4121f9e-e694-4852-a521-44efc6ef3fde     eth1                 eth1          PHYSICAL   
c62c5f04-aa93-4783-a3a7-275bf9fab2d9     eth2                 eth2          PHYSICAL   
bda21dad-5c1c-4073-89e5-798b8fce8533     eth3                 eth3          PHYSICAL   
0141f1ac-5c34-4393-8b99-76094b6f795c     ib0                  ib0           PHYSICAL   
e8cb138a-087f-4739-bb8d-90b1d903aeb6     ib1                  ib1           PHYSICAL   
a31cfd63-fb90-4cbb-a2fb-382c5e33983b     ibbond0              ibbond0       BOND

odacli update-network

Use the odacli update-network command to update an existing network configuration.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To update a network:

odacli  update-network -i id [-p IP address] [-w {Public|Dataguard|Database|Management|Backup|Other} ] [-s  network subnet mask] [-g network gateway] [-sip] [-sn] [-vs]
[-j] [-h]

Parameters

Parameter	Description
--id, -i	Defines the network identity.
--gateway, -g	(Optional) Defines the network gateway.
--ipaddress, -p	(Optional) Defines the network IP address. This can be specified in the format IPAddress or nodeNumber0:IPAddress0,nodeNumber1:IPAddress1,...
--json, -j	(Optional) Displays JSON output.
--networktype, -w	(Optional) Defines the type of network. {Public|Dataguard|Database|Management|Backup|Other}
--scanips, -sip	Defines the SCAN IP addresses (in the format scanip0,scanip1,...)
--scanname, -sn	Defines the SCAN name.
--subnetmask, -s	(Optional) Defines the Network Subnet Mask.
--vips, -vs	List of virtual IP addresses. They can be specified in the format vipname0:nodeNumber0:vip0,vipname1:nodenumber1:vip1,...
--help,-h	(Optional) Displays help for using the command.

Usage Notes

• You cannot modify the Public and Private-interfaces after the system is deployed.
• On Oracle Database Appliance non-High Availability systems, you cannot update Virtual IP addresses. The Virtual IP address is set to the same value as the IP address.
• Single Client Access Name (SCAN) cannot be set up on Oracle Database Appliance non-High Availability systems.
• On Oracle Database Appliance High Availability systems, you cannot update network of type Database to other types of network (such as backup, management and so on). You can, however, update IP address, Virtual IP address, Gateway, and Subnet mask for all network types.
• The system has both SFP+ and 10GBaseT bonded pairs, which means that one of them is used for the public, and you can configure the other after deployment if you want additional connectivity. For example, if you want a backup network.

Example 16-18 Updating a Network

The following example updates network ID 192.0.0.2 and designates the network as a backup network:

# odacli update-network -i 192.0.0.2 -w Backup

odacli Multi-User Access Commands

Use odacli commands to enable multi-user access for the appliance.

Note:

For Oracle Database Appliance release 19.13, the multi-user access feature is available for standalone Oracle Database Appliance systems. During provisioning, a single domain and tenancy is created by default and all users are created within the default domain and tenancy.

• odacli list-domains
  Use the odacli list-domains command to list all multi-user access domains.
• odacli describe-domain
  Use the odacli describe-domain command to describes a multi-user access domain.
• odacli list-tenants
  Use the odacli list-tenants command to list all tenants in a multi-user access domain.
• odacli describe-tenant
  Use the odacli describe-tenant command to describe a tenant in a multi-user access domain.
• odacli create-user
  Use the odacli create-user command to create a user in a multi-user access system.
• odacli activate-user
  Use the odacli activate-user command to activate a user in a multi-user access system.
• odacli list-users
  Use the odacli list-users command to list all users in a multi-user access system.
• odacli describe-user
  Use the odacli describe-user command to describe a user in a multi-user access system.
• odacli authorize-user
  Use the odacli authorize-user command in a multi-user access system to unlock a user account that is locked due to multiple failed login attempts or where the password has expired, and authorize the user to reset their password to reactivate their account.
• odacli delete-user
  Use the odacli delete-user command in a multi-user access system to delete a user account.
• odacli list-user-roles
  Use the odacli list-user-roles command to list user roles in a multi-user access system.
• odacli describe-user-role
  Use the odacli describe-user-role command to describe a user role in a multi-user access system.
• odacli list-user-entitlements
  Use the odacli list-user-entitlements command to list all entitlements in a multi-user access system.
• odacli describe-user-entitlement
  Use the odacli describe-user-entitlement command to describe an entitlement in a multi-user access system.
• odacli list-user-operations
  Use the odacli list-user-operations command to list all operations in a multi-user access system.
• odacli describe-user-operation
  Use the odacli describe-user-operation command to describe an operation in a multi-user access system.
• odacli list-resources-access
  Use the odacli list-resources-access command to list access to DCS resources in a multi-user access system.
• odacli describe-resource-access
  Use the odacli describe-resource-access command to describe access to a DCS resource in a multi-user access system.
• odacli grant-resource-access
  Use the odacli grant-resource-access command to grant shared access to a DCS resource in a multi-user access system.
• odacli revoke-resource-access
  Use the odacli revoke-resource-access command to revoke access to a DCS resource in a multi-user access system.
• odacli reset-password
  Use the odacli reset-password command to reset the password for a user, after it is unlocked, in a multi-user access system.
• odacli change-password
  Use the odacli change-password command to change the password for a user in a multi-user access system.

odacli list-domains

Use the odacli list-domains command to list all multi-user access domains.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-domains [-j] [-h]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• The odaadmin user can run this command to view all the multi-user access domains.

Example 16-19

[odaadmin@oda1 bin]$ odacli list-domains
ID                                   Name         Description    Is Active
---------------------------------------------------------------------------
811f176a-26c9-4480-afb3-2c735d565d91 odalocal.com Default domain true

odacli describe-domain

Use the odacli describe-domain command to describes a multi-user access domain.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli describe-domain -dn domain_name [-j] [-h]

Parameters

Parameter	Description
--domain-name, -dn	(Required) Specifies the multi-user access domain.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• The odaadmin user can run this command to view details of the multi-user access domain.

Example 16-20

# odacli describe-domain -dn odalocal.com
Domain details
----------------------------------------------------------------
                     ID: 811f176a-26c9-4480-afb3-2c735d565d91
                   Name: odalocal.com
            Description: Default domain
              Is Active: true
                Created: November 22, 2021 7:39:50 PM UTC
           Last Updated: November 22, 2021 7:39:50 PM UTC

odacli list-tenants

Use the odacli list-tenants command to list all tenants in a multi-user access domain.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-tenants -dn domain_name [-j] [-h]

Parameters

Parameter	Description
--domain-name, -dn	(Optional) Specifies the multi-user access domain name.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• The odaadmin user can run this command to view the tenants in a multi-user access domain.

Example 16-21

[odaadmin@oda1 bin]$ odacli list-tenants
ID Domain Name                       Tenant Name  Tenant   Description    Is Active
---------------------------------------------------------------------------------------------------- ---------------------------------------- ----------
1656723b-f614-4539-9634-d9013e611015 odalocal.com odalocal Default tenant true

odacli describe-tenant

Use the odacli describe-tenant command to describe a tenant in a multi-user access domain.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli describe-tenant -tn tenant_name -dn domain_name [-j] [-h]

Parameters

Parameter	Description
--tenant-name, -tn	(Required) Specifies the multi-user access tenant name.
--domain-name, -dn	(Optional) Specifies the multi-user access domain name.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• The odaadmin user can run this command to view the tenant details in a multi-user access domain.

Example 16-22

[odaadmin@oda1 bin]$ odacli describe-tenant -tn odalocal
Tenant details
----------------------------------------------------------------
                     ID: 1656723b-f614-4539-9634-d9013e611015
            Domain Name: odalocal.com
            Tenant Name: odalocal
     Tenant Description: Default tenant
              Is Active: true
                Created: November 22, 2021 7:39:50 PM UTC
           Last Updated: November 22, 2021 7:39:50 PM UTC

odacli create-user

Use the odacli create-user command to create a user in a multi-user access system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli create-user -u user_id -r roles [-gc] [-j] [-h]

Parameters

Parameter	Description
--user-id, -u	(Required) Specifies the user whose details are being created.
--user-roles, -r	(Required) Specifies the role to be assigned to the user. Use commas to specify multiple roles.
--generate-cert, -gc	(Optional) This option generates and registers a pair of certificates, one for the client and the other for the server (DCS agent). After these certificates are mutually exchanged and authenticated, the client and server can communicate with each other using mTLS (mutual Transport Layer Security). This attribute is optional and must be enabled only when you need to connect to the DCS agent with mTLS in addition to Basic Authentication.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to create a user in a multi-user access system. After odaadmin creates a user and generates temporary login credentials, the new user must activate their account by connecting to the appliance with the temporary password. Run the odacli activate-user command and provide the temporary password and then specify the new password. You can also activate the user from the Browser User Interface.

Example 16-23

[odaadmin@oda1 bin]$ odacli create-user -u dcsdb2 -r ODA-DB
Enter ODA account password for user 'dcsdb2':
Retype ODA account password for user 'dcsdb2':

Job details
----------------------------------------------------------------
                     ID: 856b3d79-8ae1-427c-a77a-8893254a451f
            Description: User creation(dcsdb2)
                 Status: Running
                Created: November 29, 2021 7:01:54 AM UTC
                Message:

Task Name Start Time End Time Status
---------------------------------------- ----------------------------------- ----------------------------------- ----------

[odaadmin@oda1 bin]$ odacli describe-job -i 856b3d79-8ae1-427c-a77a-8893254a451f
Job details
----------------------------------------------------------------
                     ID: 856b3d79-8ae1-427c-a77a-8893254a451f
            Description: User creation(dcsdb2)
                 Status: Success
                Created: November 29, 2021 7:01:54 AM UTC
                Message:

Task Name Start Time End Time Status
---------------------------------------- ----------------------------------- ----------------------------------- ----------

odacli activate-user

Use the odacli activate-user command to activate a user in a multi-user access system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli activate-user [-j] [-h]

Parameters

Parameter	Description
--domain-name, -d	(Optional) Specifies the name of the domain in which the user exists.
--tenant-name, -t	(Optional) Specifies the tenancy in which the user exists.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to activate a user in a multi-user access system. To activate a user, the user to be activated must connect to the Oracle Database Appliance system through SSH and then run the command.

Example 16-24

[dcsdb2@oda1 bin]$ odacli activate-user
Enter your ODA account password:
Enter new password for your ODA account:
Retype new password for your ODA account:
User 'dcsdb2' activated successfully.

odacli list-users

Use the odacli list-users command to list all users in a multi-user access system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-users [-d domain_name] [-t tenant_name] [-u user_id] [-j] [-h]

Parameters

Parameter	Description
--domain-name, -d	(Optional) Specifies the name of the domain in which the user exists.
--tenant-name, -t	(Optional) Specifies the tenancy in which the user exists.
--user-id, -u	(Optional) Specifies the user for whom the list is being generated.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• The odaadmin user can run this command to view all the users in a multi-user access system.

Example 16-25

[odaadmin@oda1 bin]$ odacli list-users

ID                                   DCS User Name  OS User Name Role(s)           Account Status  User Type
---------------------------------------------------------------------------------------------------------------------------------- ------------------------- ---------------
13b64a36-23f8-4ba2-9af3-e0a17a16b376 dcsdb2         dcsdb2       ODA-DB            Active          Custom
5006da5b-0fc0-4d6f-9115-17d89ad235e4 oakdroot       oakdroot     ODA-OAKDROOT      Active          System
7af066af-55bd-48a9-8db5-c0d3049a1541 ugrid          ugrid        ODA-GRID          Active          System
8361ca4b-8747-4687-9459-799c6a17d1b1 uoracle        uoracle      ODA-DB            Active          System
a205ce98-2675-49a2-81e2-4e1c7540f023 odaadmin       odaadmin     ODA-ADMINISTRATOR Active          System

odacli describe-user

Use the odacli describe-user command to describe a user in a multi-user access system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli describe-user [-u user_id] [-d domain_name] [-rd] [-t tenant_name] [-j] [-h]

Parameters

Parameter	Description
--user-id, -u	(Required) Specifies the user whose details are being viewed.
--domain-name, -d	(Optional) Specifies the name of the domain in which the user exists.
--role-details, -rd	(Optional) Specifies the entitlements and operations associated with the user role.
--tenant-name, -t	(Optional) Specifies the tenancy in which the user exists.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to view details about a user in a multi-user access system.

Example 16-26

[odaadmin@oda1 bin]$ odacli describe-user -u dcsdb1

User details
----------------------------------------------------------------
                     ID: be3182b4-9933-44a8-89b8-02b883db9d30
            DCS User ID: dcsdb1
             OS User ID: dcsdb1
       Primary OS Group: uoinstall
    Secondary OS Groups: uasmdba,dcsdb1_dba,dcsdb1_dbaoper,dcsdb1,dcsagent
                Role(s): ODA-DB
         Account Status: Active
         Account Status: Custom
                Created: November 25, 2021 12:21:16 PM UTC
           Last Updated: November 25, 2021 12:27:31 PM UTC

odacli authorize-user

Use the odacli authorize-user command in a multi-user access system to unlock a user account that is locked due to multiple failed login attempts or where the password has expired, and authorize the user to reset their password to reactivate their account.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli authorize-user -u user_id [-d domain_name] [-t tenant_name] [-j] [-h]

Parameters

Parameter	Description
--user-id, -u	(Required) Specifies the user whose account is locked.
--domain-name, -d	(Optional) Specifies the name of the domain in which the user exists.
--tenant-name, -t	(Optional) Specifies the tenancy in which the user exists.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to authorize a user in a multi-user access system. Only the system administrator odaadmin has the necessary privileges to run this command.

Example 16-27

[odaadmin@oda1 bin]$ odacli authorize-user -u dcsdb2
Enter your ODA account password:
Enter new password for user 'dcsdb2':
Retype new password for user 'dcsdb2':
User 'dcsdb2' authorized successfully. 
User can now login with the temporary password assigned to them by the system administrator 
and reset their password by executing 'odacli reset-password' command or via BUI.

odacli delete-user

Use the odacli delete-user command in a multi-user access system to delete a user account.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli delete-user -u user_id [-d domain_name] [-t tenant_name] [-j] [-h]

Parameters

Parameter	Description
--user-id, -u	(Required) Specifies the user account to be deleted.
--domain-name, -d	(Optional) Specifies the name of the domain in which the user exists.
--tenant-name, -t	(Optional) Specifies the tenancy in which the user exists.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to delete a user in a multi-user access system. Only the system administrator odaadmin has the necessary privileges to run this command.
• The user can be deleted only if there are no resources currently being held in their name.

Example 16-28

[odaadmin@oda1 bin]$ odacli delete-user -u dcsdb2

Job details
----------------------------------------------------------------
                     ID: a8724a04-3225-43b3-9484-a949bce1c5c0
            Description: User deletion(dcsdb2)
                 Status: Success
                Created: November 19, 2021 11:44:35 AM UTC
                Message:

Task Name Start Time End Time Status dcs
---------------------------------------- ----------------------------------- ----------------------------------- ----------

[odaadmin@oda1 bin]$ odacli describe-job -i a8724a04-3225-43b3-9484-a949bce1c5c0

Job details
----------------------------------------------------------------
                     ID: a8724a04-3225-43b3-9484-a949bce1c5c0
            Description: User deletion(dcsdb2)
                 Status: Success
                Created: November 19, 2021 11:44:35 AM UTC
                Message:

Task Name Start Time End Time Status
---------------------------------------- ----------------------------------- ----------------------------------- ----------

odacli list-user-roles

Use the odacli list-user-roles command to list user roles in a multi-user access system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-user-roles [-n role_name] [-j] [-h]

Parameters

Parameter	Description
--role-name, -n	(Optional) Displays the list for the specified role.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to view all the roles in a multi-user access system. Only the system administrator odaadmin has the necessary privileges to run this command.

Example 16-29

[odaadmin@oda1 bin]$ odacli list-user-roles

Role Name         Role Description                                 Is Admin Role Is Internal Is Active
------------------------- ------------------------------------------------------------------------------------------ --------------- --------------- ----------
ODA-DB            Role with DB provisioning related entitlements   false         false       true
ODA-GRID          Role with GRID provisioning related entitlements false         true        true
ODA-DBVMINFRA     Role with DBVM user related entitlements false   true          true
ODA-ADMINISTRATOR System Administrator role with all entitlements  true          true        true
ODA-OAKDROOT      Role with OAKD related entitlements              false         true        true

odacli describe-user-role

Use the odacli describe-user-role command to describe a user role in a multi-user access system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli describe-user-role [-n role_name] [-j] [-h]

Parameters

Parameter	Description
--role-name, -n	(Required) Specifies the user role for which you want to list the details.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to describe a user role in a multi-user access system. Only the system administrator odaadmin has the necessary privileges to run this command.

Example 16-30

[odaadmin@oda1 bin]$ odacli describe-user-role -n ODA-DB
Role details
----------------------------------------------------------------
                   Name: ODA-DB
            Description: Role with DB provisioning related entitlements
          Is Admin Role: false
            Is Internal: false
              Is Active: true
  Mapped Entitlement(s): PROVISIONDB-MGMT,BACKUPDB-MGMT,PATCHDB-MGMT,DATAGUARD-MGMT,DBSTORAGE-MGMT,OBJSTORESWIFT-MGMT,RMANREPORT-MGMT,SCHEDULE-MGMT,ORACHK-MGMT,ASM-RDBMS-INSTANCE-MGMT,CPUPOOLVIEW-MGMT,COMMON-ALL

odacli list-user-entitlements

Use the odacli list-user-entitlements command to list all entitlements in a multi-user access system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-user-entitlements [-ao] [-n entitlement_name] [-j] [-h]

Parameters

Parameter	Description
--active-only, -ao	(Optional) Lists the active entitlements.
--entitlement-name, -n	(Optional) Displays the list for the specified entitlement.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to view all entitlements in a multi-user access system. Only the system administrator odaadmin has the necessary privileges to run this command.

Example 16-31

[odaadmin@oda1 bin]$ odacli list-user-entitlements

Entitlement Name        Entitlement Description                                                Is Active
----------------------------------- ---------------------------------------------------------------------
TOKEN-MGMT              Entitlement for performing user token management operations            true
OSCONFIGS-MGMT          Entitlement for performing os configurations related operations        true
FEATURETOGGLE-MGMT      Entitlement for performing feature enable/diable management operations true
SERVER-MGMT             Entitlement for performing server related operations                   true
HAT-MGMT                Entitlement for performing HAT Administrative operations               true
ASM-RDBMS-INSTANCE-MGMT Entitlement for performing ASM/RDBMS instance related operations       true
RMANREPORT-MGMT         Entitlement for performing RMAN report(s) related operations           true
DBHOME-MGMT             Entitlement for performing DBHomes (on ACFS) related operations        true
DCSCOMPS-MGMT           Entitlement for performing DCS component related operations            true
KVM-MGMT-INTERNAL       Entitlement for performing blackbox KVM related internal operations    true
...

odacli describe-user-entitlement

Use the odacli describe-user-entitlement command to describe an entitlement in a multi-user access system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli describe-user-entitlement -n entitlement_name [-j] [-h]

Parameters

Parameter	Description
--entitlement-name, -n	(Required) Displays the details for the specified entitlement.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to view an entitlement in a multi-user access system. Only the system administrator odaadmin has the necessary privileges to run this command.

Example 16-32

[odaadmin@oda1 bin]$ odacli describe-user-entitlement -n PROVISIONDB-MGMT

Entitlement details
----------------------------------------------------------------
                   Name: PROVISIONDB-MGMT
            Description: Entitlement for performing DB provision related operations
              Is Active: true
    Mapped Operation(s): clone-database,create-database,delete-database,describe-database,list-databases,modify-database,move-database,register-database,update-database,upgrade-database,create-dbhome,delete-dbhome,describe-dbhome,list-dbhomes,describe-netsecurity,update-netsecurity,list-supported-dbversions,get-db-shapes,restore-archivelog,restore-tdewallet,modify-dbfileattributes

odacli list-user-operations

Use the odacli list-user-operations command to list all operations in a multi-user access system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-user-operations [-ao] [-n operations_name] [-j] [-h]

Parameters

Parameter	Description
--active-only, -ao	(Optional) Lists the active multi-user access operations.
--operation-name, -n	(Optional) Displays the list for the specified operation.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to view operations in a multi-user access system. Only the system administrator odaadmin has the necessary privileges to run this command.

Example 16-33

[odaadmin@oda1 bin]$ odacli list-user-operations

Operation Name           Operation Description      Is Active
----------------------------------- ----------------------------------------------------------------------------------------------- ----------
migrate-ovm2kvm          Migrate OVM to KVM         true
list-orachkreports       List orachkreports         true
list-osconfigurations    List os configurations     true
describe-database        Describe database          true
retrieveall-resources    Retrieve all resources     true
modify-dbsystem-vm       Modify DB System VMs       true
list-backupconfigs       List backup configurations true

odacli describe-user-operation

Use the odacli describe-user-operation command to describe an operation in a multi-user access system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli describe-user-operation [-n operation_name] [-j] [-h]

Parameters

Parameter	Description
--operation-name, -n	(Optional) Displays the details for the specified operation.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to view an operation in a multi-user access system. Only the system administrator odaadmin has the necessary privileges to run this command.

Example 16-34

[odaadmin@oda1 bin]$ odacli describe-user-operation -n create-database
Operation details
----------------------------------------------------------------
                   Name: create-database
            Description: Create database
              Is Active: true

odacli list-resources-access

Use the odacli list-resources-access command to list access to DCS resources in a multi-user access system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-resources-access [-ao] [-rn resource_name] [-rt resource_type] [-j] [-h]

Parameters

Parameter	Description
--active-only, -ao	(Optional) Lists the active resources.
--resource-name, -rn	(Optional) Displays the list by resource name.
--resource-type, -rt	(Optional) Displays the list for the specified resource type, for example, oda_dbhome, oda_db, oda_dbstorage, oda_objstoreswift, and oda_backupconfig.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to view access to resources in a multi-user access system. Only the system administrator odaadmin has the necessary privileges to run this command.

Example 16-35

[odaadmin@oda1 bin]$ odacli list-resources-access

Resource ID                          Resource Name    Resource Location                                          Resource Type    Primary Owner Shared Access Is Active
---------------------------------------- ----------------------------------------------------------------------------------------------- ---------------------------------------- ----------
cfc65e00-5d9e-4c00-a7a0-f7ea37884e06 asmtde1          53f434fe-598e-46a0-bbdc-a456404da0c9                       ODA_DB            odadb1       odaadmin      true
1dd795e1-b582-49f1-b1fb-eb3d77eb158b bkpcfg_o1        ObjectStore                                                ODA_BACKUPCONFIG  odadb1       odaadmin      true
06682f78-8f5f-4dd2-a918-7935e00bf0c4 o1               https://swiftobjectstorage.us-phoenix-1.oraclecloud.com/v1 ODA_OBJSTORESWIFT odadb1       odaadmin      true
53f434fe-598e-46a0-bbdc-a456404da0c9 OraDB19000_home1 /u01/app/odaorahome/odadb1/product/19.0.0.0/dbhome_1       ODA_DBHOME        odadb1       odaadmin      true
abc9a670-493e-4226-b186-6bc91ea48b9a default          Disk                                                       ODA_BACKUPCONFIG  uoracle      odaadmin      true
2360eebc-8899-471c-828f-c008e56fefea asmtde1          DATA,RECO,RECO                                             ODA_DBSTORAGE     odadb1       odaadmin      true

odacli describe-resource-access

Use the odacli describe-resource-access command to describe access to a DCS resource in a multi-user access system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli describe-resource-access [-ri resource_ID] [-j] [-h]

Parameters

Parameter	Description
--resource-ID, -ri	(Required) Specifies the resource ID.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to view access to a resource in a multi-user access system. Only the system administrator odaadmin has the necessary privileges to run this command.

Example 16-36

[odaadmin@oda1 bin]$ odacli describe-resource-access -ri cfc65e00-5d9e-4c00-a7a0-f7ea37884e06

Resource Access details
----------------------------------------------------------------
            Resource ID: cfc65e00-5d9e-4c00-a7a0-f7ea37884e06
          Resource Name: asmtde1
      Resource Location: 53f434fe-598e-46a0-bbdc-a456404da0c9
          Resource Type: ODA_DB
          Primary Owner: odadb1
          Shared Access: odaadmin
              Is Active: true
                Created: November 17, 2021 1:31:55 PM UTC
           Last Updated: November 17, 2021 1:31:55 PM UTC

odacli grant-resource-access

Use the odacli grant-resource-access command to grant shared access to a DCS resource in a multi-user access system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli grant-resource-access [-ri resource_ID] [-u user_ID] [-j] [-h]

Parameters

Parameter	Description
--resource-ID, -ri	(Required) Specifies the resource ID.
--user-ID, -u	(Required) Specifies the user name to be granted shared access.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to grant access to a resource in a multi-user access system. Only the system administrator odaadmin has the necessary privileges to run this command.

Example 16-37

[odaadmin@oda1 bin]$ odacli grant-resource-access -ri cfc65e00-5d9e-4c00-a7a0-f7ea37884e06 -u odadb2
Shared access of resource granted to user successfully...
[odaadmin@oda1 bin]$ odacli describe-resource-access -ri cfc65e00-5d9e-4c00-a7a0-f7ea37884e06
Resource Access details
----------------------------------------------------------------
            Resource ID: cfc65e00-5d9e-4c00-a7a0-f7ea37884e06
          Resource Name: asmtde1
      Resource Location: 53f434fe-598e-46a0-bbdc-a456404da0c9
          Resource Type: ODA_DB
          Primary Owner: odadb1
          Shared Access: odaadmin,odadb2
              Is Active: true
                Created: November 17, 2021 1:31:55 PM UTC
           Last Updated: November 19, 2021 12:46:55 PM UTC

odacli revoke-resource-access

Use the odacli revoke-resource-access command to revoke access to a DCS resource in a multi-user access system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli revoke-resource-access [-ri resource_ID] [-u user_ID] [-j] [-h]

Parameters

Parameter	Description
--resource-ID, -ri	(Required) Specifies the resource ID.
--user-ID, -u	(Required) Specifies the user name whose shared access is to be revoked.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to revoke access to a resource in a multi-user access system. Only the system administrator odaadmin has the necessary privileges to run this command.

Example 16-38

[odaadmin@oda1 bin]$ odacli revoke-resource-access -ri cfc65e00-5d9e-4c00-a7a0-f7ea37884e06 -u dcsdb2
Shared access of resource to the user revoked successfully...
[odaadmin@oda1 bin]$ odacli describe-resource-access -ri cfc65e00-5d9e-4c00-a7a0-f7ea37884e06
Resource Access details
----------------------------------------------------------------
            Resource ID: cfc65e00-5d9e-4c00-a7a0-f7ea37884e06
          Resource Name: asmtde1
      Resource Location: 53f434fe-598e-46a0-bbdc-a456404da0c9
          Resource Type: ODA_DB
          Primary Owner: odadb1
          Shared Access: odaadmin
              Is Active: true
                Created: November 17, 2021 1:31:55 PM UTC
           Last Updated: November 19, 2021 12:53:43 PM UTC

odacli reset-password

Use the odacli reset-password command to reset the password for a user, after it is unlocked, in a multi-user access system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli reset-password [-d domain_name] [-t tenant_name] [-j] [-h]

Parameters

Parameter	Description
--domain-name, -d	(Optional) Specifies the name of the domain in which the user exists.
--tenant-name, -t	(Optional) Specifies the tenancy in which the user exists.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to reset the password for a user in a multi-user access system. The password of a user must be reset either when the user account is locked due to multiple failed login attempts or if the password has expired. The odaadmin must first unlock the user account by running the odacli authorize-user command. The user can then log in with the temporary password assigned by odaadmin, run the odacli reset-password command, provide the temporary password, and then specify the new password. You can also reset the password from the Browser User Interface.

Example 16-39

[dcsdb2@oda1 bin]$ odacli reset-password
Enter your ODA account password:
Enter new password for your ODA account:
Retype new password for your ODA account:
Password reset for user 'dcsdb2' successful...

odacli change-password

Use the odacli change-password command to change the password for a user in a multi-user access system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli change-password [-d domain_name] [-t tenant_name] [-j] [-h]

Parameters

Parameter	Description
--domain-name, -d	(Optional) Specifies the name of the domain in which the user exists.
--tenant-name, -t	(Optional) Specifies the tenancy in which the user exists.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• This command must be run by the active user who wants to change the password. To reset the password of a locked or expired account, use the odacli reset-password command.

Example 16-40

[dcsdb2@oda1 bin]$ odacli reset-password
Enter your ODA account password:
Enter new password for your ODA account:
Retype new password for your ODA account:
Password reset for user 'dcsdb2' successful...

odacli Apply Patch and Update Commands

Use the commands odacli update and apply patch to apply patches and update the appliance.

• odacli cleanup-patchrepo
  Use the odacli cleanup-patchrepo command to delete obsolete or old patches from the repository.
• odacli create-prepatchreport
  Use the odacli create-prepatchreport command to run pre-checks for patching.
• odacli describe-prepatchreport
  Use the odacli describe-prepatchreport command to display the pre-check report, with a list of pre-checks run with status and comments.
• odacli list-prepatchreports
  Use the odacli list-prepatchreports command to display all pre-check reports, with a list of pre-checks run with status and comments.
• odacli delete-prepatchreport
  Use the odacli delete-prepatchreport command to delete any pre-check report.
• odacli list-availablepatches
  Use the odacli list-availablepatches command to display all available patches for Oracle Database Appliance.
• odacli describe-component
  Use the odacli describe-component command to display the installed version and the latest available version for each component.
• odacli describe-latestpatch
  Use the odacli describe-latestpatch command to display a list of the latest supported patch versions for each component.
• odacli list-agentconfig-parameters
  Use the odacli list-agentconfig-parameters command to list configuration variables used by the appliance.
• odacli update-agentconfig-parameters
  Use the odacli update-agentconfig-parameters command to modify configuration variables used by the appliance.
• odacli delete-agentconfig-parameters
  Use the odacli delete-agentconfig-parameters command to delete configuration variables used by the appliance.
• odacli update-dbhome
  Use the odacli update-dbhome command to update a specific database home to the latest patch bundle version.
• odacli update-dcsadmin
  Use the odacli update-dcsadmin command to update the DCS admin components for Zookeeper upgrade.
• odacli update-dcsagent
  Use the odacli update-dcsagent command to update the agent.
• odacli update-dcscomponents
  Use the odacli update-dcscomponents command to update the DCS components such as the DCS agent and Zookeeper.
• odacli update-registry
  Use the odacli update-registry command to update the registry of components when you apply patches manually.
• odacli update-repository
  Use the odacli update-repository command to update the repository with the new Oracle Database Appliance software.
• odacli update-server
  Use the odacli update-server command to update the operating system, firmware, Oracle Appliance Kit, Oracle Clusterware, and all other infrastructure components.
• odacli update-storage
  Use the odacli update-storage command to update the storage.
• odaadmcli orachk
  Use the odaadmcli orachk command to check configuration settings for Oracle Database Appliance components.

odacli cleanup-patchrepo

Use the odacli cleanup-patchrepo command to delete obsolete or old patches from the repository.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli cleanup-patchrepo [-cl clones] | [-v version [-comp component]]| [-l local|-n NodeID] 

Parameters

Parameter	Description
--clones, -cl	Specifies the option to clean up clone files (DB and GI) from the repository /opt/oracle/oak/pkgrepos/orapkgs/clones/.
--version, -v	Defines the Oracle Database Appliance release you want to delete. You cannot delete the initial or current release files. For example, 12.2.1.4.0.
--component, -comp	A comma-separated list of components as {DB,GI} to cleanup for a specific Oracle Database Appliance patch version. The default is both {DB,GI}.
--local, -l	(Optional) Cleans up the repository on the local node.
--node, -n	(Optional) Cleans up the repository on the specified nodes.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

• Use the command to free up space in the patch repository.
• This command does not delete the current patches or latest installed patch repository.

Example 16-41 Deleting RDBMS and GI components for a specific release

# odacli cleanup-patchrepo -cl -comp db,gi -v 12.2.1.4.0
{
"jobId" : "d915ffc0-c7f6-49cf-8ddd-ab5d2ad9072f",
"status" : "Created",
"message" : null,
"reports" : ,
"createTimestamp" : "April 17, 2019 06:44:28 AM UTC",
"resourceList" : ,
"description" : "Cleanup patchrepos",
"updatedTime" : "April 17, 2019 06:44:28 AM UTC"

Example 16-42 Deleting Clone Files

# odacli cleanup-patchrepo -cl
{
"jobId" : "5d8549a2-1a5e-4b4f-9867-c1f671c659c4",
"status" : "Created",
"message" : null,
"reports" : ,
"createTimestamp" : "April 17, 2019 06:43:45 AM UTC",
"resourceList" : ,
"description" : "Cleanup patchrepos",
"updatedTime" : "April 17, 2019 06:43:45 AM UTC"
}

odacli create-prepatchreport

Use the odacli create-prepatchreport command to run pre-checks for patching.

Patching pre-checks help identify and remedy any problems before patching is attempted, and ensure all components are ready for updates.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli create-prepatchreport [-d] [-i] [-f] [-l] [-n] [-v] [-h] [-s] [-r] [-st] [-c os [-local]]

Parameters

Parameter	Description
--dbhome, –d	(Optional) Specifies the database home component for running the pre-checks.
--dbhomeid, –i	(Optional) Specifies the IDs of the database homes for running the pre-checks.
--files, -f	(Optional) Specifies files required to update repository, comma-separated if multiple files are required.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--operating-system, -os	(Optional) Specifies the operating system components. Use this option to run operating system upgrade. If you specify -c, then the only option is os. If you specify -c os, then you can also specify -local (optional).
--node, –n	(Optional) Runs patch pre-checks on specified nodes.
--repo, –r	(Optional) Specify this option to run the patch pre-checks for the repository components.
--server, –s	(Optional) Specify this option to run the patch pre-checks for the server components.
--storage, –st	(Optional) Specify this option to run the patch pre-checks for the storage components.
--version, –v	(Optional) Specifies the version for running the pre-checks.

Usage Notes

Use the odacli create-prepatchreport command to generate a pre-check report.

Example 16-43 Creating Pre-Check Report

# odacli create-prepatchreport -v 19.14.0.0.0 -s

Job details 
----------------------------------------------------------------
                     ID: e07993d5-0a06-44e7-819a-36d708c52bb6
            Description: Patch pre-checks for [OS, ILOM, GI, ORACHKSERVER]
                 Status: Created
                Created: April 20, 2020 1:01:59 AM PDT
                Message: Use 'odacli describe-prepatchreport -i e07993d5-0a06-44e7-819a-36d708c52bb6' to check details of results

Task Name Start Time End Time Status   
---------------------------------------- ----------------------------------- -----------------------------

odacli describe-prepatchreport

Use the odacli describe-prepatchreport command to display the pre-check report, with a list of pre-checks run with status and comments.

Patching pre-checks help identify and remedy any problems before attempting to patch, and ensure all components are ready for updates.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

odacli describe-prepatchreport -i

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--jobid, -i	Specifies the Job ID for the pre-check report.

Usage Notes

Use the odacli describe-prepatchreport command to display the pre-check report.

The pre-checks report indicates whether the server patching can be rolling or not.

Example 16-44 Patch pre-checks report with rolling mode patching supported when Expander or Controller upgrade is not required

[root@node1 bin]# odacli describe-prepatchreport -i 83e41cc6-bd0e-4c53-a9fe-c3f6b7ecd47b
 
Patch pre-check report                                           
------------------------------------------------------------------------
                 Job ID:  83e41cc6-bd0e-4c53-a9fe-c3f6b7ecd47b
            Description:  Patch pre-checks for [STORAGE]
                 Status:  SUCCESS
                Created:  September 3, 2021 2:51:29 PM UTC
                 Result:  All pre-checks succeeded
 
Node Name       
---------------
node1
 
Pre-Check                      Status   Comments                              
------------------------------ -------- -------------------------------------- 
__STORAGE__ 
Validate patching tag           Success   Validated patching tag: 19.12.0.0.0.  
Patch location validation       Success   Verified patch location               
Patch tag validation            Success   Verified patch tag                    
Storage patch tag validation    Success   Verified storage patch location       
Verify ASM disks status         Success   ASM disks are online                  
Validate rolling patch          Success   Rolling mode patching allowed as      
                                          there is no expander and controller   
                                          upgrade.                              
Validate command execution      Success   Validated command execution           
 
Node Name       
---------------
node2
 
Pre-Check                      Status   Comments                              
------------------------------ -------- -------------------------------------- 
__STORAGE__ 
Validate patching tag           Success   Validated patching tag: 19.12.0.0.0.  
Patch location validation       Success   Verified patch location               
Patch tag validation            Success   Verified patch tag                    
Storage patch tag validation    Success   Verified storage patch location       
Verify ASM disks status         Success   ASM disks are online                  
Validate rolling patch          Success   Rolling mode patching allowed as      
                                          there is no expander and controller   
                                          upgrade.                              
Validate command execution      Success   Validated command execution       

Example 16-45 Patch pre-checks report with rolling mode patching not supported when Expander or Controller upgrade is required

[root@node1 bin]# odacli describe-prepatchreport -i 4a3bef2b-687e-41f2-b3d7-cbda79e63877
 
Patch pre-check report                                           
------------------------------------------------------------------------
                 Job ID:  4a3bef2b-687e-41f2-b3d7-cbda79e63877
            Description:  Patch pre-checks for [STORAGE]
                 Status:  SUCCESS
                Created:  September 7, 2021 12:30:57 PM UTC
                 Result:  All pre-checks succeeded
 
Node Name       
---------------
node1
 
Pre-Check                      Status   Comments                              
------------------------------ -------- -------------------------------------- 
__STORAGE__ 
Validate patching tag           Success   Validated patching tag: 19.12.0.0.0.  
Patch location validation       Success   Verified patch location               
Patch tag validation            Success   Verified patch tag                    
Storage patch tag validation    Success   Verified storage patch location       
Verify ASM disks status         Success   ASM disks are online                  
Validate rolling patch          Alert     Rolling mode patching not allowed as  
                                          there is expander and controller   
                                          upgrade.                              
Validate command execution      Success   Validated command execution           
 
Node Name       
---------------
node2
 
Pre-Check                      Status   Comments                              
------------------------------ -------- -------------------------------------- 
__STORAGE__ 
Validate patching tag           Success   Validated patching tag: 19.12.0.0.0.  
Patch location validation       Success   Verified patch location               
Patch tag validation            Success   Verified patch tag                    
Storage patch tag validation    Success   Verified storage patch location       
Verify ASM disks status         Success   ASM disks are online                  
Validate rolling patch          Alert     Rolling mode patching not allowed as  
                                          there is expander and controller   
                                          upgrade.                              
Validate command execution      Success   Validated command execution               

Example 16-46 Displaying the Patch Pre-Checks Report for Operating System, Oracle Grid Infrastructure, and ORAchk

# odacli describe-prepatchreport -i e07993d5-0a06-44e7-819a-36d708c52bb6

Patch pre-check report                                          
------------------------------------------------------------------------
                 Job ID:  e07993d5-0a06-44e7-819a-36d708c52bb6
            Description:  Patch pre-checks for [OS, ILOM, GI, ORACHKSERVER]
                 Status:  FAILED
                Created:  April 20, 2020 1:01:59 AM PDT
                 Result:  One or more pre-checks failed for [OS, ORACHK]

Node Name      
---------------
node1

Pre-Check                      Status   Comments                             
------------------------------ -------- --------------------------------------
__OS__
Validate supported versions     Success   Validated minimum supported versions.
Validate patching tag           Success   Validated patching tag: 19.6.0.0.0.  
Is patch location available     Success   Patch location is available.         
Validate if ODABR is installed  Failed    ODABR utility is not installed on 
                                          node: scaoda8m004.                   
Space checks for OS upgrade     Success   Validated space checks.              
Install OS upgrade software     Success   Extracted OS upgrade patches into    
                                          /root/oda-upgrade. Do not remove this
                                          directory untill OS upgrade completes.
Verify OS upgrade by running    Success   Results stored in:                   
preupgrade checks                         '/root/preupgrade-results/           
                                          preupg_results-200420010731.tar.gz' .
                                          Read complete report file            
                                          '/root/preupgrade/result.html' before
                                          attempting OS upgrade.               
Validate custom rpms installed  Success   No additional RPMs found installed on
                                          node:scaoda8m004.                    
Scheduled jobs check            Failed    Scheduled jobs found. Disable        
                                          scheduled jobs before attempting OS  
                                          upgrade.
__ILOM__
Validate supported versions     Success   Validated minimum supported versions.
Validate patching tag           Success   Validated patching tag: 19.6.0.0.0.  
Is patch location available     Success   Patch location is available.         
Checking Ilom patch Version     Success   Successfully verified the versions   
Patch location validation       Success   Successfully validated location      

__GI__
Validate supported GI versions  Success   Validated minimum supported versions.
Validate available space        Success   Validated free space under /u01      
Verify DB Home versions         Success   Verified DB Home versions            
Validate patching locks         Success   Validated patching locks             
Validate clones location exist  Success   Validated clones location            
Validate ODABR snapshots exist  Success   No ODABR snaps found on the node.    

__ORACHK__
Running orachk                  Failed    Orachk validation failed: .          
Verify diagsnap configuration   Failed    diagsnap or pstack are configured to 
                                          collect first failure diagnostic     
Software home                   Failed    Software home check failed                                       

Example 16-47 Example of a successful patch pre-checks report

# odacli describe-prepatchreport -i aec9373c-96aa-43ce-9aae-8091ec9cd4eb
Patch pre-check report                                           
----------------------------------------------------------------
                 Job ID:  aec9373c-96aa-43ce-9aae-8091ec9cd4eb
            Description:  Pre-Check report for patching [DB]
                 Status:  COMPLETED
                 Result:  All pre-checks succeeded
Node Name       
---------------
node1
Pre-Check                      Status     Comments                           
------------------------------ ---------- ----------------------------------- 
__DB__ 
Validate patching tag           Success     Validated patching tag: 12.2.1.2.0
Validate available space        Success     Validated free space required      
                                            under /u01                         
Is system provisioned           Success     Verified system is provisioned     
Is patch location available     Success     Patch location is available        
Validate minimum agent version  Success     Validated minimum agent version    
Verify DBHome patch tag         Success     Verified DB Home patch tag         
Is GI upgraded                  Success     Validated GI is upgraded           
Patch location validation       Success     Successfully validated location    
Patch verification              Success     Patch 26710464 not applied on DB   
                                            home                               
Is patch rollback required      Success     No DB patch is required to rollback
Opatch updation                 Success     Successfully updated the opatch in 
                                            DbHome                             
Patch conflict check            Success     No patch conflicts found on DBHome

odacli list-prepatchreports

Use the odacli list-prepatchreports command to display all pre-check reports, with a list of pre-checks run with status and comments.

Patching pre-checks help identify and remedy any problems before attempting to patch, and ensure all components are ready for updates.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-prepatchreports [-h] [-j]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.

Usage Notes

Use the odacli list-prepatchreports command to display all pre-check reports.

Example 16-48 Displaying All Patch Pre-Checks Reports

# odacli list-prepatchreports 
ID   Description  Created                             Status    

------------- ----------------------------------- ----------

8a8a14b5-1b5e-4eeb-8ba9-c8136fb4eea1     Patch pre-checks for [DB]: DbHome is OraDB12102_home1  
May 16, 2018 7:00:56 PM PDT         Running   

2c9a747d-a452-4e48-bcab-9c7cd9f5f35b     Patch pre-checks for [STORAGE]      
May 16, 2018 6:53:23 PM PDT         Success   

f3b9c7c1-3061-4577-848d-645669d71f72     Patch pre-checks for [OS, ILOM, GI]
May 16, 2018 7:00:56 PM PDT         Running   

odacli delete-prepatchreport

Use the odacli delete-prepatchreport command to delete any pre-check report.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli delete-prepatchreport -i Report ID

Parameters

Parameter	Description
Report ID	Describes the ID of the report to be deleted.
--help, -h	(Optional) Displays help for using the command.

Usage Notes

Use the odacli delete-prepatchreport command to delete pre-check reports.

Example 16-49 Deleting A Patch Pre-Checks Report

# odacli delete-prepatchreport -i 741f635b-7c75-4832-8813-782367f1e6fd

odacli list-availablepatches

Use the odacli list-availablepatches command to display all available patches for Oracle Database Appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-availablepatches [-h] [-j]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.

Usage Notes

Use the odacli list-availablepatches command to display all available patches for Oracle Database Appliance.

Example 16-50 Displaying All Available Patches on Bare Metal System

# odacli list-availablepatches
-------------------- ------------------------- ------------------------- ------------------------------
ODA Release Version  Supported DB Versions     Available DB Versions     Supported Platforms           
-------------------- ------------------------- ------------------------- ------------------------------
19.14.0.0.0          21.5.0.0.220118           21.5.0.0.220118           DB System                      
                     19.14.0.0.220118          19.14.0.0.220118          Bare Metal, DB System          
                     12.2.0.1.220118           12.2.0.1.220118           Bare Metal                    
                     12.1.0.2.220118           12.1.0.2.220118           Bare Metal                    
                        
19.11.0.0.0          19.11.0.0.210420          19.11.0.0.210420          Bare Metal, DB System          
                     18.14.0.0.210420          18.14.0.0.210420          Bare Metal                    
                     12.2.0.1.210420           12.2.0.1.210420           Bare Metal                    
                     12.1.0.2.210420           12.1.0.2.210420           Bare Metal   

Example 16-51 Displaying All Available Patches on DB System

# odacli list-availablepatches
-------------------- ------------------------- ------------------------- ------------------------------
ODA Release Version  Supported DB Versions     Available DB Versions     Supported Platforms           
-------------------- ------------------------- ------------------------- ------------------------------
19.14.0.0.0          21.5.0.0.220118           21.5.0.0.220118           DB System                      
                     19.14.0.0.220118          19.14.0.0.220118          Bare Metal, DB System          
                     12.2.0.1.220118           12.2.0.1.220118           Bare Metal                    
                     12.1.0.2.220118           12.1.0.2.220118           Bare Metal                    
                        
19.11.0.0.0          19.11.0.0.210420          19.11.0.0.210420          Bare Metal, DB System          
                     18.14.0.0.210420          18.14.0.0.210420          Bare Metal                    
                     12.2.0.1.210420           12.2.0.1.210420           Bare Metal                    
                     12.1.0.2.210420           12.1.0.2.210420           Bare Metal       

odacli describe-component

Use the odacli describe-component command to display the installed version and the latest available version for each component.

If there are multiple DB Homes installed in Oracle Database Appliance, then the output displays the version details for each of the installed homes. You can use this command to check the component version after applying a patch.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli describe-component [-d][-j][-h][-s][-v][-l][-n]

Parameters

Parameter	Description
--dbhomes, –d	(Optional) Lists the database home versions and available versions.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--local, -l	(Optional) Describes the components for the local node. Use to display details on the local node of multi-node high availability (HA) systems. This option is not needed to display component details on single-node systems.
--node, –n	(Optional) Describes the components for a specific node on high availability (HA) systems. This option is not needed to display component details on single node systems. {0|1}
--server, –s	(Optional) Lists the server components and versions and the available versions to which you can patch them.
--systemversion, –v	(Optional) Displays only the system version. This option is available only on high-availability systems.

Usage Notes

Use the odacli describe-component command to get component details. On a multi-node environment, the command provides details across all nodes. Use the --node or --local option to get component details for a specific node.

The odacli describe-component command displays the local and shared storage components and the updates required for them separately.

Example 16-52 Displaying local and shared storage components and the required updates

[root@node1 ~]# odacli describe-component
System Version  
---------------
19.13.0.0.0

System node Name 
---------------
node1

Local System Version 
---------------
19.13.0.0.0 

Component                                Installed Version    Available Version   
---------------------------------------- -------------------- --------------------
OAK                                       19.13.0.0.0           up-to-date          

GI                                        19.13.0.0.211019      up-to-date          

DB {
[ OraDB19000_home1,OraDB19000_home2,      19.13.0.0.211019      up-to-date          
OraDB19000_home3 ]                                                                  
[ OraDB12201_home1 ]                      12.2.0.1.211019       up-to-date          
[ OraDB12102_home1 ]                      12.1.0.2.211019       up-to-date          
} 

DCSCONTROLLER                             19.13.0.0.0           up-to-date          

DCSCLI                                    19.13.0.0.0           up-to-date          

DCSAGENT                                  19.13.0.0.0           up-to-date          

DCSADMIN                                  19.13.0.0.0           up-to-date          

OS                                        7.9                   up-to-date          

ILOM                                      5.0.2.24.r141466      up-to-date     

BIOS                                      52050300              up-to-date            

SHARED CONTROLLER FIRMWARE                16.00.08.00           up-to-date          

FIRMWAREEXPANDER                          0310                  up-to-date          

LOCAL DISK FIRMWARE                       1132                  up-to-date          

SHARED DISK FIRMWARE {
[ c0d0,c0d1,c0d2,c0d3,c0d4,c0d5,c1d0,     RXA0                  up-to-date          
c1d1,c1d2,c1d3,c1d4,c1d5 ]                                                          
[ c0d6,c0d7,c0d8,c0d9,c0d10,c0d11,c0d12,  A144                  up-to-date          
c0d13,c0d14,c0d15,c0d16,c0d17,c0d18,                                                
c0d19,c0d20,c0d21,c0d22,c0d23,c1d6,c1d7,                                            
c1d8,c1d9,c1d10,c1d11,c1d12,c1d13,c1d14,                                            
c1d15,c1d16,c1d17,c1d18,c1d19,c1d20,                                                
c1d21,c1d22,c1d23 ]                                                                 
[ c2d0,c2d1 ]                             1132                  up-to-date          
} 
HMP                                       2.4.8.0.600           up-to-date          

Example 16-53 Displaying patch details for components for High-Availability Oracle Database Appliance Systems for a release

# /opt/oracle/dcs/bin/odacli describe-component -v
System Version
---------------
18.8.0.0.0

System node Name
---------------
node1

Local System Version
---------------
18.8.0.0.0

Component                                Installed Version    Available Version
---------------------------------------- -------------------- --------------------
OAK                                       18.8.0.0.0            up-to-date

GI                                        18.8.0.0.191015       up-to-date

DB                                        18.8.0.0.191015       up-to-date

DCSAGENT                                  18.8.0.0.0            up-to-date

ILOM                                      4.0.4.41.r130359      up-to-date

BIOS                                      25080100              up-to-date

OS                                        6.10                  up-to-date

FIRMWARECONTROLLER                        11.05.03.00           up-to-date

FIRMWAREEXPANDER                          0018                  001e

FIRMWAREDISK {
[ c0d0,c0d1 ]                             A7E0                  up-to-date
[ c1d0,c1d1,c1d2,c1d3,c1d4,c1d5,c1d6,     A72A                  a7e0
c1d7,c1d8,c1d9,c1d10,c1d11,c1d12,c1d13,
c1d14,c1d15,c1d16,c1d17,c1d18,c1d19,
c2d0,c2d1,c2d2,c2d3,c2d4,c2d5,c2d6,c2d7,
c2d8,c2d9,c2d10,c2d11,c2d12,c2d13,c2d14,
c2d15,c2d16,c2d17,c2d18,c2d19 ]
[ c1d20,c1d21,c1d22,c2d20,c2d21,c2d22 ]   944A                  up-to-date
}

System node Name
---------------
node2

Local System Version
---------------
18.8.0.0.0

Component                                Installed Version    Available Version
---------------------------------------- -------------------- --------------------
OAK                                       18.8.0.0.0            up-to-date

GI                                        18.8.0.0.191015       up-to-date

DB                                        18.8.0.0.191015       up-to-date

DCSAGENT                                  18.8.0.0.0            up-to-date

ILOM                                      4.0.2.27.b.r125869    4.0.4.41.r130359

BIOS                                      25060400              25080100

OS                                        6.10                  up-to-date

FIRMWARECONTROLLER                        11.05.03.00           up-to-date

FIRMWAREEXPANDER                          0018                  001e

FIRMWAREDISK {
[ c0d0,c0d1 ]                             A7E0                  up-to-date
[ c1d0,c1d1,c1d2,c1d3,c1d4,c1d5,c1d6,     A72A                  a7e0
c1d7,c1d8,c1d9,c1d10,c1d11,c1d12,c1d13,
c1d14,c1d15,c1d16,c1d17,c1d18,c1d19,
c2d0,c2d1,c2d2,c2d3,c2d4,c2d5,c2d6,c2d7,
c2d8,c2d9,c2d10,c2d11,c2d12,c2d13,c2d14,
c2d15,c2d16,c2d17,c2d18,c2d19 ]
[ c1d20,c1d21,c1d22,c2d20,c2d21,c2d22 ]   944A                  up-to-date
}

Example 16-54 List DB Home Details

# odacli describe-component -d

System Version
---------------
18.7.0.0.0

System node Name
---------------
node1

Local System Version
---------------
18.7.0.0.0

Component                                Installed Version    Available Version
---------------------------------------- -------------------- --------------------
DB                                        12.2.0.1.190716       up-to-date

System node Name
---------------
node2

Local System Version
---------------
18.7.0.0.0

Component                                Installed Version    Available Version
---------------------------------------- -------------------- --------------------
DB                                        12.2.0.1.190716       up-to-date

Example 16-55 List the Server Components and Versions

# odacli describe-component -s
System Version
---------------
18.7.0.0.0

System node Name
---------------
node1

Local System Version
---------------
18.7.0.0.0

Component                                Installed Version    Available Version
---------------------------------------- -------------------- --------------------
OAK                                       18.7.0.0.0            up-to-date

GI                                        18.7.0.0.190716       up-to-date

ILOM                                      4.0.4.38.r130206      up-to-date

BIOS                                      52010400              up-to-date

OS                                        6.10                  up-to-date

System node Name
---------------
node2

Local System Version
---------------
18.7.0.0.0

Component                                Installed Version    Available Version
---------------------------------------- -------------------- --------------------
OAK                                       18.7.0.0.0            up-to-date

GI                                        18.7.0.0.190716       up-to-date

ILOM                                      4.0.4.38.r130206      up-to-date

BIOS                                      52010400              up-to-date

OS                                        6.10                  up-to-date

odacli describe-latestpatch

Use the odacli describe-latestpatch command to display a list of the latest supported patch versions for each component.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

odacli describe-latestpatch [-h]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.

Example 16-56 Listing the Latest Supported Versions

#  odacli describe-latestpatch
 
ComponentType   availableVersion
--------------- --------------------
gi              18.7.0.0.190716
db              18.7.0.0.190716
db              12.2.0.1.190716
db              12.1.0.2.190716
oak             18.7.0.0.0
asr             18.3.1
ilom            3.0.16.22.f.r100119
ilom            4.0.2.31.r126282
ilom            4.0.4.41.r130359
ilom            4.0.4.37.r130617
ilom            4.0.0.24.r121140
ilom            4.0.4.40.r130348
ilom            4.0.4.38.r130206
os              6.10
bios            17140300
bios            30150300
bios            25080100
bios            41060300
bios            38130200
bios            39090000
bios            52010400
firmwareexpander 0342
firmwareexpander 001e
firmwareexpander 0306
firmwaredisk    a901
firmwaredisk    0r3q
firmwaredisk    a29a
firmwarecontroller 11.05.03.00
firmwarecontroller qdv1rf30
firmwarecontroller vdv1ry03
firmwarecontroller 20.08.01.14
firmwarecontroller 2.11.1280
firmwarecontroller 13.00.00.00
firmwarecontroller 4.650.00-7176
firmwarecontroller kpyair3q
dcsagent        18.7.0.0.0
firmwaredisk    a7e0
firmwaredisk    a4c0
firmwaredisk    a72a
firmwaredisk    a880
firmwaredisk    a122
firmwaredisk    a38k
firmwaredisk    c122
firmwaredisk    944a
firmwaredisk    9440
firmwaredisk    e12b
firmwaredisk    5g08
firmwaredisk    a902
firmwaredisk    a140
firmwaredisk    sa03
firmwaredisk    0b25
firmwaredisk    sf04
firmwaredisk    c38k
firmwaredisk    a3a0
firmwaredisk    pd51
firmwaredisk    m554
firmwaredisk    0121
firmwaredisk    xc311102

odacli list-agentconfig-parameters

Use the odacli list-agentconfig-parameters command to list configuration variables used by the appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-agentconfig-parameters [-h] [-j] [-n] [-t]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--name, -n	Specifies the name of the parameter.
--type, -t	(Optional) Specifies the configuration value for the given type. The default value is PUBLIC.

Usage Notes

Use the odacli list-agentconfig-parameters command to list configuration variables used by the appliance.

Example 16-57 Displaying the HttpProxyPort

./odacli list-agentconfig-parameters -n HttpProxyPort

Name      Value      Description      Updated                            
------------------------------------------------------
HttpProxyPort  Http proxy server port    December 8, 2021 4:14:10 AM UTC       

Example 16-58 Displaying the agent configuration

# odacli list-agentconfig-parameters

Name          Value     Description   Updated                            
------------------------------ ----------------------------------------------------------------- 
HttpProxyHost   Http proxy server host  December 8, 2021 4:14:10 AM UTC       
HttpProxyPort   Http proxy server port   December 8, 2021 4:14:10 AM UTC       
HttpsProxyHost   Https proxy server host  December 8, 2021 4:14:10 AM UTC       
HttpsProxyPort  Https proxy server port  December 8, 2021 4:14:10 AM UTC         

Example 16-59 Displaying Oracle ASM configuration

# odacli list-agentconfig-parameters -t ASM
Name                Value  Description  Updated   
------------------------------ ----------------------------------------------------------------- ---------------------------------------------------------------------- -----------------------------------
asm_power_limit        4  June 22, 2021 12:13:10 AM UTC    

odacli update-agentconfig-parameters

Use the odacli update-agentconfig-parameters command to modify configuration variables used by the appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli update-agentconfig-parameters

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--append, -a	(Optional) Appends the parameter values. For example, -n p1 -v v1 -n p2 -v v2 -a.
--all-dbsystems, -adbs	(Optional) Dynamic parameter update for all DB systems.
--bm-only, -bm	(Optional) Dynamic parameter update for bare metal systems only.
--comment, -c	(Optional) Specifies the comment for the parameter.
--dbsystem, -dbs	(Optional) DB system name for dynamic parameter update.
--description, -d	(Optional) Specifies the description of the parameter.
--json, -j	(Optional) Displays JSON output. The default is false.
--name, -n	Specifies the name of the parameter. Provide multiple parameter values in the format -n p1 -v v1 -n p2 -v v2.
--reset, -r	Resets the parameter to the default value. For example: -n p1 -n p2 -r.
--update, -u	Replaces the parameter with the specified value. For example: -n p1 -v v1 -n p2 -v v2 -u.
--value, -v	Specifies the value of the parameter. Provide multiple parameter values in the format -n p1 -v v1 -n p2 -v v2.
--type, -t	(Optional) Specifies the type of the parameter.

Usage Notes

Use the odacli update-agentconfig-parameters command to modify configuration variables used by the appliance. The supported configuration parameters are HttpsProxyHost and HttpsProxyPort.

Multiple values can be specified. For High-Availability models, the command sets the parameter values on both nodes in the cluster.

For a DB system, dynamic parameter value specified using the -dbs flag has more priority than the parameter value specified using the -adbs flag, which in turn has a higher priority than the case where the parameter was updated without using any flag from the bare metal system.

Example 16-60 Setting Multiple Parameters

# odacli update-agentconfig-parameters -n HttpsProxyPort -v 80 -d "Http proxy port" 
-n HttpsProxyPort -v 80 -d "Https proxy port" -u

update-agentconfig-parameters -n HttpsProxyPort -n HttpProxyPort -r

update-agentconfig-parameters -n HttpsProxyHost -v 90 -a

update-agentconfig-parameters -n OSPatchRepos -v

Example 16-61 Setting Oracle RDBMS Parameters

# odacli update-agentconfig-parameters -t RDBMS -n processes -v 300 -u
The value of processes will be set to 300 in BM and all the DBVMs.

#  odacli list-agentconfig-parameters -t RDBMS -n processes

Name               Value     Description     Updated                            
----------------------------------------------------------------------------------------------
processes          300                       November 22, 2021 5:24:45 PM UTC

Example 16-62 Updating the RDBMS Parameter for all DB systems in the Bare Metal System

# odacli update-agentconfig-parameters -t RDBMS -n processes -v 400 -u -adbs

In the bare metal system, the value of the processes parameter is not changed:

# odacli list-agentconfig-parameters -t RDBMS -n processes

Name               Value        Description       Updated                            
------------------------------ ----------------------------------------------------------------- ------------
processes           300                           November 10, 2021 12:08:15 AM UTC

In all DB systems, the value of processes is changed:

# odacli list-agentconfig-parameters -t RDBMS -n processes

Name               Value        Description       Updated                            
------------------------------ ----------------------------------------------------------------- ------------
processes          400                           November 10, 2021 12:08:15 AM UTC

You can set the value for a specific DB system:

# odacli update-agentconfig-parameters -t RDBMS -n processes -v 700 -u -dbs DBSYSTEM1

Value is changed on DBSYSTEM1:

# odacli list-agentconfig-parameters -t RDBMS -n processes   

Name               Value        Description       Updated                            
------------------------------ ----------------------------------------------------------------- ------------
processes           700                          November 10, 2021 12:08:15 AM UTC

odacli delete-agentconfig-parameters

Use the odacli delete-agentconfig-parameters command to delete configuration variables used by the appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli delete-agentconfig-parameters -n name_param [-adbs] [-bm] [-dbs dbs_param] [-t type_param] [-j] [-h]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--name, -n	(Mandatory) Specifies the name of the parameter.
--type, -t	(Optional) Deletes the configuration value for the given type.
--all-dbsystems, -adbs	(Optional) Deletes the dynamic parameter updated for DB systems, using the -ad option in the odacli update-agentconfig-parameters command.
--bm-only, -bm	(Optional) Deletes the dynamic parameter only from the bare metal systems.
--dbsystem, -dbs	(Optional) Deletes the dynamic parameter for a specific DB system.

Usage Notes

Use the odacli delete-agentconfig-parameters command to delete configuration values. For High-Availability models, the command deletes the parameter values on both nodes in the cluster.

Example 16-63 Deleting configuration parameters

# odacli delete-agentconfig-parameters -n HttpProxyHost

Job details                                                
----------------------------------------------------------------
                     ID:  c6e123c6-1b76-48f8-973d-63c8dab65545
            Description:  delete configuration parameter HttpProxyHost
                 Status:  Running
                Created:  December 8, 2021 9:45:39 AM PDT
                Message:  
Task Name                                Start Time                          End Time                            Status    
---------------------------------------- ----------------------------------- ----------------------------------- ----------

Example 16-64 Deleting processes configuration parameter

# odacli delete-agentconfig-parameters -t rdbms -n processes
odacli list-agentconfig-parameters -t RDBMS -n processes
No result found

Note: Parameters updated using -adbs, -dbs flags should be deleted using the same corresponding flags.

# odacli delete-agentconfig-parameters -t rdbms -n processes -dbs DBSYSTEM1

# odacli delete-agentconfig-parameters -t rdbms -n processes -adbs

odacli update-dbhome

Use the odacli update-dbhome command to update a specific database home to the latest patch bundle version.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli update-dbhome -i dbhomeid -v version [-f] [-imp] [-p] [-j] [-h]

Parameters

Parameter	Description
--dbhomeid, -i	Defines the Oracle Database Home to update.
--help-h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--precheck, –p	(Optional) Analyzes the patch.
--force, –f	(Optional) Ignores precheck error and forces the operation.
--version, -v	Defines the Oracle Database Appliance version to update. For example, 19.11.0.0.0.
----ignore-missing-patch, -imp	(Optional) Ignores missing patch error and forces the operation.

Usage Notes

• You must run the patching pre-checks at least once before running the odacli update-dbhome command. Analyze any failed pre-checks, fix them, and rerun pre-checks. If any of the pre-checks fail, then run the odacli update-dbhome command with the -f option.

• The update-dbhome command applies the latest release update (RU) for Oracle Database home.

• To be updated with the latest patches, the database must be running.

• Only databases in the Configured status are updated. Use the odacli list-database command to see a list of configured databases. Databases in any other status are skipped during the update.

Example 16-65 Updating an Oracle Database Home

To apply the latest patch bundle to update an Oracle Database:

# odacli update-dbhome -i ad6c7326-e460-411e-94df-230dedbef743 -v 19.14.0.0.0

odacli update-dcsadmin

Use the odacli update-dcsadmin command to update the DCS admin components for Zookeeper upgrade.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

  odacli update-dcsadmin  -v version  [-j] [-h]

Parameters

Parameter	Description
--version, -v	Defines the Oracle Database Appliance version after update.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

The update-dcsadmin command sets up the dcsadmin and other components. Run the update-dcsadmin command only after you update the DCS agent.

Example 16-66 Updating DCS Admin

# odacli update-dcsadmin -v 18.7.0.0.0
{
  "jobId" : "4c238b93-e641-4f9d-9f86-93d0574dd234",
  "status" : "Created",
  "message" : null,
  "reports" : [ ],
  "createTimestamp" : "July 12, 2019 03:11:53 AM UTC",
  "resourceList" : [ ],
  "description" : "DcsAdmin patching",
  "updatedTime" : "July 12, 2019 03:11:53 AM UTC"
}

odacli update-dcsagent

Use the odacli update-dcsagent command to update the agent.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

  odacli update-dcsagent  -v version  [-j] [-h]

Parameters

Parameter	Description
--version, -v	Defines the Oracle Database Appliance version after update.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

The update dcsagent command updates the dcs-agent to the RPM package that is located in the location and restarts the dcs-agent. After the update is applied, the agent automatically restarts. It will take a few minutes to reconnect to the dcs-agent. Wait until the agent shuts down and completes restarting before performing any tasks.

Note:

Before updating the agent, ensure that you do not have any jobs running or pending during the update window.

Example 16-67 Updating the Agent

To update the dcs-agent to version 19.14:

# odacli update-dcsagent -v 19.14
{
  "jobId" : "77e454d3-eb68-4130-a247-7633f8d6192b",
  "status" : "Created",
  "message" : null,
  "reports" : [ ],
  "createTimestamp" : "December 8, 2021 14:09:24 PM CST",
  "description" : "DcsAgent patching",
  "updatedTime" : "December 8, 2021 14:09:24 PM CST"
}

odacli update-dcscomponents

Use the odacli update-dcscomponents command to update the DCS components such as the DCS agent and Zookeeper.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

  odacli update-dcscomponents  -v version  [-j] [-h]

Parameters

Parameter	Description
--version, -v	Defines the Oracle Database Appliance version after update.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

The update-dcscomponents command sets up the dcscomponents such as Zookeeper.

Example 16-68 Updating DCS Components

# odacli update-dcscomponents -v 18.7.0.0.0
{
  "jobId" : "4c238b93-e641-4f9d-9f86-93d0574dd234",
  "status" : "Created",
  "message" : null,
  "reports" : [ ],
  "createTimestamp" : "July 12, 2019 03:11:53 AM UTC",
  "resourceList" : [ ],
  "description" : "DcsComponents patching",
  "updatedTime" : "July 12, 2019 03:11:53 AM UTC"
}

odacli update-registry

Use the odacli update-registry command to update the registry of components when you apply patches manually.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

  odacli update-registry  -n component  [-f] [-j] [-h]

Parameters

Parameter	Description
--component, -n	Defines the Oracle Database Appliance component for the registry update. The values can be system {gihome, dbnode, sysinstance} or all {dbhome, db, dbstorage, asr}. You can also specify the individual component to be refreshed. Note: Refresh system components before you refresh all components.
-f	(Optional) Forces the refresh of the specified component even if it already exists in the appliance registry metadata.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage Notes

The update-registry command updates the registry of components when you apply patches manually.

The components must be updated in the order: system, dbhome, db,dbstorage, otherwise the update-registry command displays an error. To update all components, you can specify the component as all in the update-registry command.

The update-registry command rediscovers only the following DCS components resources:

• System resources : Oracle Grid Infrastructure (gihome), Oracle Database node (dbnode), System instance (sysinstance)
• Database Home (dbhome)
• Database (db)
• Database storage (dbstorage)
• Oracle ASR

The update-registry command does not rediscover any other components not mentioned in the list.

If a TDE database is created without using Oracle Database Appliance tooling and the registry is updated for database components, then this database is added to the DCS metadata. If the TDE Wallet Management of the database is ODA, then the TDE password of the database must be updated in the DCS metadata by modifying the database with the same option you use to change the TDE password. You can specify the same password for both the current and new TDE password to ensure that the TDE password is updated in the DCS metadata.

Example 16-69 Updating the Registry with the -force option

# odacli update-registry -n system
DCS-10112:Specified components are already discovered.

Using force flag option to rediscover and update the sytem components though it already exists in appliance registry 
# odacli update-registry -n system -f

Job details 
----------------------------------------------------------------
                     ID: 752b56d8-2bcd-4a29-ab96-196925fc5c13
            Description: Discover System Components : system
                 Status: Created
                Created: July 31, 2019 1:02:51 PM UTC
                Message: 

Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ----------

# odacli describe-job -i 752b56d8-2bcd-4a29-ab96-196925fc5c13

Job details 
----------------------------------------------------------------
                     ID: 752b56d8-2bcd-4a29-ab96-196925fc5c13
            Description: Discover System Components : system
                 Status: Success
                Created: July 31, 2019 1:02:51 PM UTC
                Message: 

Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ----------
Rediscover SysInstance July 31, 2019 1:02:51 PM UTC July 31, 2019 1:03:24 PM UTC Success 
Rediscover DBNode July 31, 2019 1:03:24 PM UTC July 31, 2019 1:03:24 PM UTC Success 
Rediscover GiHome July 31, 2019 1:03:24 PM UTC July 31, 2019 1:03:26 PM UTC Success

odacli update-repository

Use the odacli update-repository command to update the repository with the new Oracle Database Appliance software.

Prerequisites

Before updating the repository, you must upload the Oracle Database Appliance software to the appliance. If the patch contains more than one zip file, then extract and concatenate the zip files before updating the repository.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To unpack and copy the patch bundle to the correct locations in the file system:

odacli update-repository  -f filename [-j] [-h]

Parameters

Parameter	Description
--filename, –f	Defines the zip filename of patch bundle or RDBMS clones downloaded from My Oracle Support. Provide a comma-separated list of absolute file paths of the end user and patch bundles.
--json, -j	(Optional) Displays JSON output. The default is false.
--help,-h	(Optional) Displays help for using the command.

Usage Notes

• Before updating the repository, ensure that you do not have any jobs running or pending during the update window.

• Upload the patches to dom0 on Node0. On multi-node systems, the DCS-Agent copies the patch to Node1 and updates the patch repository on both nodes.

• Starting with Oracle Database Appliance release 19.12, a new Oracle ACFS file system is created to store the Oracle Database and Oracle Grid Infrastructure clone files. The DATA disk group provides a space of 150 GB for the file system. When provisioning a system with Oracle Database Appliance release 19.12, the file system is created after Oracle Grid Infrastructure software is configured. When patching a system with Oracle Database Appliance release 19.12, the file system is created when you run the odacli update-server command. If you run the command odacli update-repository after this file system is configured during provisioning or patching, then the odacli update-repository command fails if Oracle Clusterware is not running. The following error is displayed:

  DCS-10626:Cannot update the repository as the Clusterware is down. Some files need to be stored on an ACFS file system.

Example 16-70 Updating the Repository

The server patch zip file is located in the /u01/tmpdir directory. The following example updates the repository with the latest server patch and then lists the job to verify that the update is successful:

# /opt/oracle/dcs/bin/odacli update-repository -f /tmp/oda-sm-19.14.0.0.0-date-server.zip,/tmp/oda-sm-19.14.0.0.0-date-server.zip
{
  "jobId" : "d3510276-da05-447b-990e-6d30964f8f79",
  "status" : "Created",
  "message" : "/u01/tmpdir/oda-sm-12.2.1.1.0-171031-server.zip",
  "reports" : [ ],
  "createTimestamp" : "December 8, 2021 14:13:45 AM CST",
  "description" : "Repository Update",
  "updatedTime" : "December 8, 2021 14:13:45 AM CST"
}
[root@oak1 tmpdir]# ./odacli list-jobs
# odacli list-jobs
ID                                    Description       Created                             Status
----------------------------          ----------------  ----------------------------        -------
6f27a29a-959f-44e1-b984-7473e3c918ad  Server Patching   December 8, 2021 14:19:05 AM CST    Success 

odacli update-server

Use the odacli update-server command to update the operating system, firmware, Oracle Appliance Kit, Oracle Clusterware, and all other infrastructure components.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli update-server [-p] [-c] -v version [-f][-ng] [-j] [-h]

Parameters

Parameter	Description
--precheck, –p	(Optional) Analyzes the patch.
--version, –v	(Mandatory) Defines the version to update.
--component,–c	(Optional) Component that is to be upgraded. Supported value is OS.
--nogrid,–ng	(Optional) Skips upgrade of Oracle Grid Infrastructure.
--skip-orachk, –sko	(Optional) Skips ORAchk errors and continues patching operation.
--force, –f	(Optional) Ignores precheck error and forces the patching operation.
--json, -j	(Optional) Displays JSON output. The default is false.
--help, -h	(Optional) Displays help for using the command.

Usage Notes

• The update-server command applies the patches to various infrastructure components and Oracle Clusterware.

  After the update is applied, the agent automatically restarts. It will take a few minutes to reconnect to the server. Wait until the agent shuts down and completes restarting before performing any tasks. Allow at least two (2) minutes before running the next command.

• You must run the patching pre-checks at least once before running the odacli update-server command. Analyze any failed pre-checks, fix them, and rerun pre-checks. If any of the pre-checks fail, then run the odacli update-server command with the -f option.

Note:

Before updating the server, ensure that you do not have any jobs running or pending during the update window. You must run the odacli create-prepatchreport command before you patch your server; otherwise, the odacli update-server command fails with an error message prompting you to run the patching pre-checks. You can use the -f option to override precheck failures and complete the server patching.

Example 16-71 Updating the Server

Run the odacli update-server command to update the server to 19.14.0.0.0. On a high-availability system, run the command on one node. The patches are applied automatically to both nodes.

# odacli update-server -v 19.14.0.0.0
{
  "jobId" : "6f27a29a-959f-44e1-b984-7473e3c918ad",
  "status" : "Created",
  "message" : "Success of Server Update may trigger reboot of node after 4-5 minutes. 
Please wait till node restart",
  "reports" : [ ],
  "createTimestamp" : "December 8, 2021 14:13:45 PM CST",
  "resourceList" : [ ],
  "description" : "Server Patching",
  "updatedTime" : "December 8, 2021 14:13:45 PM CST"
} 

odacli update-storage

Use the odacli update-storage command to update the storage.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli update-storage -v version [-h] [-j] [-r]

Parameters

Parameter	Description
--version, –v	Defines the version to update.
--json, -j	(Optional) Displays JSON output. The default is false.
--help, -h	(Optional) Displays help for using the command.
--rolling, -r	(Optional) Enables to patch shared disks in rolling fashion without stopping Oracle Clusterware. The shared disks must be online.

Usage Notes

• If the FIRMWAREEXPANDER Installed Version is lower than or equal to the Available Version, then you cannot use rolling mode to update the storage.
• If the FIRMWARECONTROLLER Installed Version is lower than or equal to the Available Version, then you cannot use rolling mode to update the storage.

Example 16-72 Updating the Storage

# odacli update-storage -v 19.14.0.0.0

odaadmcli orachk

Use the odaadmcli orachk command to check configuration settings for Oracle Database Appliance components.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To perform diagnostic checks of components:

   odaadmcli orachk [-h]  

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
Components such as -a, -acchk, -applypatch, -autostop	(Optional) Specifies the comma-separated list of components for which you want to collect data. Specify the component to be checked in the command. For example: # odaadmcli orachk -a
--verbose	Displays detailed message.

Usage Notes

The odaadmcli orachk command invokes orachk from the directory opt/oracle.SupportTools/orachk.

Example 16-73 Running odaadmcli orachk

[root@oak bin] # ./odaadmcli orachk
INFO: 2019-09-04 16:41:26: Running orachk under /opt/oracle.SupportTools/orachk

Example 16-74 Running odaadmcli orachk for a component

[root@oak bin] # ./odaadmcli orachk -a
INFO: 2019-09-19 10:45:16: Running orachk under /usr/bin/orachk
Checking ssh user equivalency settings on all nodes in cluster for root

odacli Appliance Commands

Use the odacli appliance commands to perform lifecycle activities for the appliance.

• odacli set-credential
  Use the odacli set-credential command to change the oda-admin user credentials.
• odacli create-appliance
  Use the odacli create-appliance command in a JSON file format to provision Oracle Database Appliance.
• odacli describe-system
  Use the odacli describe-system command to display details about components installed on the system.
• odacli list-featuretracking
  Use the odacli list-featuretracking command to display the latest feature tracking report.

odacli set-credential

Use the odacli set-credential command to change the oda-admin user credentials.

Syntax

To reset the oda-admin user credentials in interactive mode:

  odacli set-credential --username username [-j] [-h]

Parameters

Parameter	Description
--username, -u	User name required to access the Oracle Appliance Manager Browser User Interface. The default user name is oda-admin.
--json, -j	(Optional) Displays JSON output.
--help, -h	(Optional) Displays help for using the command.

Usage Notes

Only root user can reset the oda-admin user credentials.

Example 16-75 Resetting the oda-admin Password in Interactive Mode

To reset the oda-admin user password to a new password in interactive mode:

# odacli set-credential --username oda-admin
Enter 'user' password: 
Retype 'user' password:

odacli create-appliance

Use the odacli create-appliance command in a JSON file format to provision Oracle Database Appliance.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

To view help for the odacli create-appliance command:

   odacli create-appliance  -r requestjson [-j] [-h]

Note:

The odacli create-appliance command only supports a JavaScript Object Notation (JSON) file format. An example JSON files and a readme are available in an appendix in this document and in the /opt/oracle/dcs/sample directory.

Parameters

Parameter	Description
--requestjson, -r	JSON input for appliance creation.
--json, -j	(Optional) Displays JSON output.
--help, -h	(Optional) Displays help for using the command.

odacli describe-system

Use the odacli describe-system command to display details about components installed on the system.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

To list jobs and view job details and status:

   odacli describe-system [-h] [-b] [-d] [-j] 

Parameters

Parameter	Description
--json, -j	(Optional) Displays JSON output.
--help, -h	(Optional) Displays help for using the command.
--bom, -b	(Optional) Displays the bill of materials for the installed components on the appliance.
--details, -d	(Optional) Display on the command-line, the details of all installed components on the appliance.

Usage Notes

Do not provide both options -b and -d at the same time, in the command.

Example 16-76 Example Command to View the Bill of Materials from the Command Line for Bare Metal Deployments

# odacli describe-system -b
ODA Components Information 
------------------------------
Component Name                Component Details                                             
---------------               ----------------------------------------------------------------------------------------------- 
NODE                          Name : oda1 
                              Domain Name :  
                              Time Stamp : April 29, 2020 7:00:12 PM UTC 

  
RPMS                          Installed RPMS : acl-2.2.49-7.el6_9.1.x86_64,
                                               aide-0.14-11.el6.x86_64,
                                               alsa-lib-1.1.0-4.el6.x86_64,
                                               at-3.1.10-49.el6.x86_64,
                                               atk-1.30.0-1.el6.x86_64,
                                               attr-2.4.44-7.el6.x86_64,
                                               audit-2.4.5-6.el6.x86_64,
                                               audit-libs-2.4.5-6.el6.x86_64,
                                               audit-libs-python-2.4.5-6.el6.x86_64,
                                               augeas-libs-1.0.0-10.el6.x86_64,
                                               authconfig-6.1.12-23.el6.x86_64,
                                               avahi-libs-0.6.25-17.el6.x86_64,
                                               b43-openfwwf-5.2-10.el6.noarch,
                                               basesystem-10.0-4.0.1.el6.noarch,
                                               bash-4.1.2-48.el6.x86_64,
                                               bc-1.06.95-1.el6.x86_64,
                                               bind-libs-9.8.2-0.62.rc1.el6_9.5.x86_64,
                                               bind-utils-9.8.2-0.62.rc1.el6_9.5.x86_64,
                                               binutils-2.20.51.0.2-5.47.el6_9.1.x86_64,
                                               biosdevname-0.7.2-1.el6.x86_64,
                                               bridge-utils-1.2-10.el6.x86_64,
                                               busybox-1.15.1-21.el6_6.x86_64,
                                               bzip2-1.0.5-7.el6_0.x86_64,
                                               bzip2-libs-1.0.5-7.el6_0.x86_64,
                                               ca-certificates-2017.2.14-65.0.1.el6_9.noarch,
                                               cairo-1.8.8-6.el6_6.x86_64,
                                               celt051-0.5.1.3-0.el6.x86_64,
                                               checkpolicy-2.0.22-1.el6.x86_64,
                                               chkconfig-1.3.49.5-1.el6.x86_64,
                                               cloog-ppl-0.15.7-1.2.el6.x86_64,
                                               compat-libcap1-1.10-1.x86_64,
                                               compat-libstdc++-33-3.2.3-69.el6.x86_64,
                                               compat-readline5-5.2-17.1.el6.x86_64,
                                               compat-sap-c++-4.8.2-16.el6.x86_64,
                                               ConsoleKit-0.4.1-6.el6.x86_64,
                                               ConsoleKit-libs-0.4.1-6.el6.x86_64,
                                               ConsoleKit-x11-0.4.1-6.el6.x86_64,
                                               coreutils-8.4-46.0.1.el6.x86_64,
                                               coreutils-libs-8.4-46.0.1.el6.x86_64,
                                               cpio-2.10-13.el6.x86_64,
                                               cpp-4.4.7-18.el6.x86_64,
                                               cpupowerutils-1.3-2.el6.x86_64,
                                               cpuspeed-1.5-22.0.1.el6.x86_64,
                                               cracklib-2.8.16-4.el6.x86_64,
                                               cracklib-dicts-2.8.16-4.el6.x86_64,
                                               crash-7.1.4-1.0.1.el6_7.x86_64,
                                               crda-3.13_2015.10.22-3.el6.x86_64,
                                               createrepo-0.9.9-27.el6_9.noarch,
                                               cronie-1.4.4-16.el6_8.2.x86_64,
                                               cronie-anacron-1.4.4-16.el6_8.2.x86_64,
                                               crontabs-1.10-33.el6.noarch,
                                               cryptsetup-luks-1.2.0-11.el6.x86_64,
                                               cryptsetup-luks-libs-1.2.0-11.el6.x86_64,
                                               cups-libs-1.4.2-78.el6_9.x86_64,

....
....
....

odacli list-featuretracking

Use the odacli list-featuretracking command to display the latest feature tracking report.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

Use the odacli list-featuretracking command to display the latest feature tracking report.

   odacli list-featuretracking [-h] [-j] 

Parameters

Parameter	Description
--json, -j	(Optional) Displays JSON output.
--help, -h	(Optional) Displays help for using the command.

Example 16-77 Example Command to View the Features Report from the Command Line

# odacli list-featuretracking
                                    DCS Feature Tracking Report

Last collection date:   10/26/18 15:35
Report version:         1.0

-------------------------------------------------------------------
DCS Feature Usage Summary

                                                          Currently Detected    Total     Last Usage
Feature Name                                              Used        Usages  Samples           Time
--------------------------------------------------------- --------- 
Object Store                                              TRUE            12       12 10/26/18 15:35
Automatic Service Request (ASR)                           FALSE            0       12               
Storage Expansion Shelf                                   FALSE            0       12               


-------------------------------------------------------------------
DCS High Water Mark Statistics

Measured Feature Name                                        High Water Mark       Category         
------------------------------------------------------------ 
Maximum usage of CPU                                         8.12 %                DCS Agent        
Maximum usage of Memory                                      437.12 MB             DCS Agent        
Maximum number of threads                                    150                   DCS Agent        
Maximum number of open file descriptors                      257                   DCS Agent        
Maximum number of Databases                                  1                     Database         
Maximum number of EE Databases                               1                     Database         
Maximum number of SE Databases                               0                     Database         
Maximum number of CDBs                                       1                     Database         
Maximum number of non-CDBs                                   0                     Database         
Maximum number of RAC Databases                              1                     Database         
Maximum number of RAC One Databases                          0                     Database         
Maximum number of Single Instance Databases                  0                     Database         
Maximum number of PDBs                                       0                     Database         
Maximum number of Datafiles                                  7                     Database         
Maximum number of Database Homes                             1                     Database         
Maximum number of Flashback Databases                        0                     Database         
Maximum size of a Database                                   6.40 GB               Database         
Minimum Database version                                     18.0.0.0.0            Database         
Maximum Database version                                     18.0.0.0.0            Database         
Maximum number of Backups                                    12                    Database         
Maximum number of NFS Backups                                0                     Database         
Maximum number of Object Store Backups                       12                    Database         
Maximum number of Disk Backups                               0                     Database         
Maximum number of Regular-L0 Backups                         0                     Database         
Maximum number of Regular-L1 Backups                         1                     Database         
Maximum number of ArchiveLog Backups                         9                     Database         
Maximum number of Longterm Backups                           2                     Database         
Maximum interval between Database Backups                    0 Day(s), 01:01:06    Database         
Maximum number of Object Store tenants                       1                     Object Store     
Maximum number of enabled CPU cores                          12                    Server           
Maximum number of disks                                      24                    Storage          
Maximum number of ASM Disks Groups                           3                     Storage          
Maximum size of ASM Disk Groups                              11.46 TB              Storage          
Maximum usage of ASM Disk Groups                             1.70 %                Storage          
Maximum number of ASM Disks Groups with redundancy 'NORMAL'  0                     Storage          
Maximum number of ASM Disks Groups with redundancy 'HIGH'    3                     Storage          
Maximum number of ASM Disks Groups with redundancy 'EXTERN'  0                     Storage          
Maximum number of ASM Disks Groups with redundancy 'FLEX'    0                     Storage          
Maximum ASM Disk Groups compatibility                        18.0.0.0.0            Storage          
Minimum ASM Disk Groups compatibility                        18.0.0.0.0            Storage          
Maximum number of non-ACFS file systems                      4                     Storage          
Maximum size of non-ACFS file systems                        98.31 GB              Storage          
Maximum usage of non-ACFS file systems                       82.71 %               Storage          
Maximum number of ACFS file systems                          1                     Storage          
Maximum size of ACFS file systems                            5.00 GB               Storage          
Maximum usage of ACFS file systems                           12.19 %               Storage 

odacli Backup and Recovery Commands

Use the odacli backup and recover commands to backup to and restore from Oracle Cloud Infrastructure Object Storage or disk or NFS.

• odacli create-backup
  Use the command odacli create-backup to create a Level 0, Level 1, archivelog, or Longterm backup.
• odacli create-backupconfig
  Use the command odacli create-backupconfig to create a backup configuration.
• odacli create-objectstoreswift
  Use the command odacli create-objectstoreswift to create and store the Oracle credential details required to backup to Oracle Object Store.
• odacli delete-backup
  Use the command odacli delete-backup to delete obsolete backups and backup reports.
• odacli delete-backupconfig
  Use the command odacli delete-backupconfig to delete a backup configuration.
• odacli describe-backupreport
  Use the command odacli describe-backupreport to display details of a specific backup report.
• odacli delete-objectstoreswift
  Use the command odacli delete-objectstoreswift to delete the credentials for the ObjectStore account.
•  odacli describe-schedule
  Use the command odacli describe-schedule to display details for a specific schedule.
• odacli irestore-database
  Use the command odacli irestore-database to restore a database from one system to other system from an external FRA (NFS) or Object Store location based on a BackupReport.
• odacli list-backupconfigs
  Use the command odacli list-backupconfigs to list all backup configurations.
• odacli list-backupreports
  Use the command odacli list-backupreports to display a list of all backup reports.
• odacli list-objectstoreswifts
  Use the command odacli list-objectstoreswifts to display a list of credentials for the ObjectStore account.
•  odacli list-schedules
  Use the command odacli list-schedules to display all of the schedules in the system, including database backup schedules and some internal maintenance schedules.
• odacli list-tdebackupreports
  Use the odacli list-tdebackupreports command to view TDE Wallet backup reports.
• odacli recover-database
  Use the odacli recover-database command to recover or restore a database from backup.
• odacli restore-archivelog
  Use the odacli restore-archivelog command to restore archivelog from one SCN to another SCN, or from one timestamp to another timestamp.
• odacli restore-tdewallet
  Use the odacli restore-tdewallet command to restore TDE wallet from the backup location.
• odacli update-backupconfig
  Use the command odacli update-backupconfig to update a backup configuration.
• odacli update-objectstoreswift
  Use the command odacli update-objectstoreswift to change the credentials for the ObjectStore account.
•  odacli update-schedule
  Use the command odacli update-schedule to update the schedule for a database, or to disable the database backup schedule.

odacli create-backup

Use the command odacli create-backup to create a Level 0, Level 1, archivelog, or Longterm backup.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli  create-backup [-i Database Resource ID | -in Database Resource Name] [-h] [-j]

Parameters

Parameter	Description
--backupType, -bt {Regular-L0|Regular-L1|Longterm|archivelog}	Defines the type of backup. The options are not case sensitive.
--component, -c {Database|TDEWallet}	(Optional) Defines the component. The supported options are Database and TDE Wallet. The options are not case-sensitive. The default value is Database. If you specify the value as Database, then a backup of both the database and TDE Wallet is taken.
--dbName, -in	Defines the Database name.
--dbid, -i	Defines the Database Resource ID.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--keep-archivelog, -ka	Keeps archive logs.
--keepDays, -k	Defines the Keep Days. For Longterm Backup Type only.
--tag, -t	Defines the name of the backup. A tag is alphanumeric, up to 30 characters. Required for Longterm Backup Type. The tag must be wrapped in single quotes when special characters are used.

Usage Notes

• Use the command odacli create-backup for a specified Database Resource ID and provide a tag for the backup name. Use up to 30 alphanumeric characters for the backup name tag. Three types of backups are available:

  • Level 0:  An RMAN incremental backup that backs up all data blocks in the data files being backed up. An incremental backup at level 0 is identical in content to a full backup, but unlike a full backup, the level 0 backup is part of an incremental backup strategy.

  • Level 1: An RMAN incremental backup that includes only those blocks that have been changed since the "parent" backup was taken. A parent backup can be either a level 0 or a level 1 backup.

  • Longterm: Longterm backups are available when backing up to NFS (External FRA) or Oracle Cloud Infrastructure Object Storage (Oracle Object Storage).

  • Archivelog: This option is used to perform backup of all archivelogs not yet backed up to the backup destination, such as Internal FRA, External FRA (NFS location), or Object Store.

• The Backup Type must be specified in most cases, when you run the odacli create-backup command. If the Backup Component is TDE Wallet, then you need not specify the Backup Type.

• This command creates a Backup Report with a Resource ID. To get the ID, use the command odacli describe-job -i job_id -j and look for the resourceId attribute in resourceList.

Example 16-78 Create a Manual Database Backup

Create a long term backup that is kept for 90 days and named q12018HR.

  # odacli  create-backup -i Database Resource ID -bt Longterm -c database -k 90 -t q12018HR

Example 16-79 Create a Level 0 Database Backup

Create a Level 0 backup named 2017Dec22ProductionLevel0 for resource ID 20576eb1-bc32-4e34-bf97-fda0b60ca15b

# odacli  create-backup -i 20576eb1-bc32-4e34-bf97-fda0b60ca15b -bt Regular-L0 -t 2017Dec22ProductionLevel0

Example 16-80 Create a Backup of only the TDE Wallet

# odacli create-backup -in testdb -c TDEWallet

Example 16-81 Create a Backup of the database and TDE Wallet

# odacli create-backup -in testdb -bt regular-l0

odacli create-backupconfig

Use the command odacli create-backupconfig to create a backup configuration.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli  create-backupconfig  -n backup configuration name -d backup destination{Disk|ObjectStore|NFS|None} [-c] [-cr] [-h] [-j] [-no-cr] [-o] [-w] [-f] [-ca] [-dc] [-ec] [-on]

Parameters

Parameter	Description
--backupdestination, –d {Disk|ObjectStore|NFS|None}	Defines the backup destination. The options are not case sensitive.
--container, -c	(Optional) Defines the object store container.
--crosscheck, -cr	(Optional) Enable crosscheck.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--name, -n	Defines the backup configuration name.
--no-crosscheck, -no-cr	(Optional) Disable crosscheck.
--objectstoreswiftId, -o	(Optional) Defines the swift object store credential ID.
--tde-container, -f	(Optional) Defines the container or backup location to backup the TDE Wallet. Must be the absolute path to the parent directory when the backup target is NFS, and must be the container name when the backup target is Objectstore.
--recoverywindow, -wDisk: {1-14} | ObjectStore: {1-31}	(Optional) Defines the Recovery Window in days. {1-14} days for Disk and {1-31} days for Object Storage in the cloud.
--compression-algo, -ca	(Optional) Defines the compression algorithm {basic|low|medium|high} that RMAN must use. (default: basic(disk/NFS), medium(ObjectStore))
--disable-compression, -dc	(Optional) Disables compression for the backups. Compression is enabled by default.
--enable-compression, -ec	(Optional) Enables compression for the backups. Compression is enabled by default.
--objectstoreswiftName, -on	(Optional) Defines the Objectstore Swift resource name. Specify the Objectstore Swift resource name or Objectstore Swift ID.

Usage Notes

• To backup a TDE-enabled database, backup configuration with separate TDE Wallet backup location and Database backup location is mandatory.
• To backup a non-TDE database, backup configuration with either single database backup location or backup configuration with both database backup location and TDE Wallet backup location can be used.
• For Disk backup configuration, TDE Wallet backup location is by default, Fast Recovery Area (FRA), but in a separate path from the Database backup path within FRA. Hence, TDE Wallet backup location need not be specified when creating the Disk backup configuration.

• The recovery window that is defined in the backup configuration determines when backups are considered obsolete. The following are guidelines:

  • Disk: 1-14 days

  • Object Storage: 1-31 days

Example 16-82 Create a Backup Configuration for disk

Create a backup configuration named production that backs up to disk with a 14 day recovery window.

# odacli create-backupconfig -d Disk -n production -w 14

Example 16-83 Create a Backup Configuration for NFS location

Create a backup configuration that backs up to NFS with a 2 day recovery window.

# odacli create-backupconfig -d NFS -n NfsPolicy1 -c /tmp/Nfsbackps -w 2

Example 16-84 Create a Backup Configuration with separate backup locations for database backup and TDE Wallet backup

# odacli create-backupconfig -n bcfg1 -d Objectstore -w 1 -c location1-on oss1 -f location2

Example 16-85 Create a Backup Configuration with single backup location for database backup

# odacli create-backupconfig -n bcfg2 -d Objectstore -w 1 -c testb2 -on oss2

odacli create-objectstoreswift

Use the command odacli create-objectstoreswift to create and store the Oracle credential details required to backup to Oracle Object Store.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli create-objectstoreswift -e swift end point URL [-h] [-j] -n Object Store Swift name -t Object Store tenant name -u Object Store user name

Parameters

Parameter	Description
--endpointurl, –e	Defines the swift end point URL.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--name, -n	Defines the Object Store Swift name.
--tenantname, -t	Defines the Object Store Swift tenant name.
--username, -u	Defines the Object Store Swift user name.

Usage Notes

The command creates and stores the Oracle Cloud Infrastructure Object Storage credential details in the system and stores the password in an encrypted Oracle wallet. You can attach the credentials to one or more backup configurations.

The credentials are validated during Object Store backup configuration creation against the endpoint URL and tenancy.

odacli delete-backup

Use the command odacli delete-backup to delete obsolete backups and backup reports.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

  odacli  delete-backup -i Database Resource ID -in [-br] [-h] [-j]

Parameters

Parameter	Description
--backupreport, -br	(Optional) Defines the backup report. To delete a Long Term backup, use a JSON input file for the backupreport.
--dbid, -i	Defines the Database Resource Identifier (ID). To delete obsolete level 0, level 1 and archivelog backups and backup reports, use the database resource ID.
--dbName, -in	Defines the Database resource name.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.

Usage Notes

• Delete older, obsolete level 0 and level 1, archive log backups and backup reports with the Database Resource ID. The recovery window that is defined in the backup configuration determines when backups are considered obsolete.

• Delete long term backups and backup report from Oracle Object Storage or NFS backup location using a JSON file with the --backupreport option.

• To locate the database ID, view the databases in the Browser User Interface or use the command odacli list-databases.

Example 16-86 Delete a Level 0 or Level 1 Backup

# odacli delete-backup -i 20576eb1-bc32-4e34-bf97-fda0b60ca15b

Example 16-87 Delete a Long Term Backup Report

Delete a Long Term backup using a JSON input file for the Backup Report. In this example, backupreport.json is the JSON input for the backupreport.

# odacli delete-backup -i 20576eb1-bc32-4e34-bf97-fda0b60ca15b -br backupreport.json

odacli delete-backupconfig

Use the command odacli delete-backupconfig to delete a backup configuration.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

  odacli  delete-backupconfig  -i backup configuration id [-h] [-j]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--id, -i	Defines the Backup Config identifier (ID).
--backupconfigname, -in	Defines the Backup Config name.
--json, -j	(Optional) Displays JSON output. The default is false.

Usage Notes

You cannot delete a backup configuration if it is attached to a database.

Example 16-88 Deleting a Backup Configuration

Delete a backup configuration named production

# odacli delete-backupconfig -in production

odacli describe-backupreport

Use the command odacli describe-backupreport to display details of a specific backup report.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

odacli  describe-backupreport  [-h] [-j] [-i]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--id, -i	Defines the backup report ID.

Example 16-89 Display Details of a Specific Backup Report

#  odacli  describe-backupreport -i 2d82460c-d648-4e75-8c7d-72cc90bc442a
{
  "id" : "2d82460c-d648-4e75-8c7d-72cc90bc442a",
  "dbResId" : "b5fc646e-01a6-4c8b-8286-7633346c4329",
  "tag" : null,
  "dbId" : "2717054291",
  "dbName" : "ExampleDB",
  "dbUniqueName" : "ExampleDBu",
  "backupType" : "REGULAR-L1",
  "keepDays" : null,
  "backupLocation" : "https://swiftobjectstorage.example.com/v1/dbaasimage/backupbucket",
  "cfBackupHandle" : "c-2717054291-20180108-04",
  "spfBackupHandle" : "c-2717054291-20180108-04",
  "pitrTimeStamp" : "January 08, 2018 12:43:14 PM UTC",
  "pitrSCN" : "1175058",
  "resetLogsTimeStamp" : "January 08, 2018 09:55:34 AM UTC",
  "resetLogsSCN" : "1112268",
  "oraHomeVersion" : "12.2.0.1.170814 (26723265, 26609817)",
  "sqlPatches" : "25811364,26609817",
  "backupLogLoc" : "https://swiftobjectstorage.example.com/v1/dbaasimage/backupbucket/scaoda702c1n1/rmanlog/ExampleDBu/2717054291/2018-01-08/rman_backup_2018-01-08_12-42-41.0545.log",
  "tdeWalletLoc" : null,
  "dbConfigLoc" : "https://swiftobjectstorage.example.com/v1/dbaasimage/backupbucket/scaoda702c1n1/dbconfig/ExampleDBu/2717054291/2018-01-08/DBCONFIG_TAG20180108T124407_2018-01-08_12-44-07.0533.tar.gz",
  "name" : "Backup_Report_ExampleDB",
  "createTime" : "January 08, 2018 12:42:08 PM UTC",
  "state" : {
    "status" : "CONFIGURED"
  },
  "updatedTime" : "January 08, 2018 12:44:12 PM UTC",
  "backupReportLogDetail" : "https://swiftobjectstorage.example.com/v1/dbaasimage/backupbucket/scaoda702c1n1/rmandetaillogreport/ExampleDBu/2717054291/2018-01-08/rman_list_backup_detail_2018-01-08_12-44-04.0362.log",
  "dbInfo" : {
    "dbClass" : "OLTP",
    "dbType" : "RAC",
    "dbShape" : "odb1",
    "dbEdition" : "EE",
    "dbStorage" : "ASM"
  },
  "dbDataSize" : "1542M",
  "dbRedoSize" : "16403M"
}

odacli delete-objectstoreswift

Use the command odacli delete-objectstoreswift to delete the credentials for the ObjectStore account.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

# odacli  delete-objectstoreswift -i Object Store Swift id -in Object Store Swift name  [-h] [-j]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--objectstoreswiftid, -i	Defines the Object Store Swift identifier (ID).
--objectstoreswiftName, -in	Defines the Object Store Swift name.

Usage Notes

You cannot delete the Object Store credentials if they are attached to a backup configuration.

Example 16-90 Deleting the Oracle Object Store Credentials

# odacli  delete-objectstoreswift -i Object Store Swift id 

 odacli describe-schedule

Use the command odacli describe-schedule to display details for a specific schedule.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

#  odacli  describe-schedule  [-h] [-j] [-i]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--scheduleid, -id	Defines the schedule with an identifier (ID).

Example 16-91 Display Schedule Details

#  odacli  describe-schedule -i scheduleid 

odacli irestore-database

Use the command odacli irestore-database to restore a database from one system to other system from an external FRA (NFS) or Object Store location based on a BackupReport.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

 odacli irestore-database -r [-n] [-bp] [-cl] [-nn] [-co] [-s] [-ro] [-dr] [-y] [-c] [-oid] [-tf] [-bl] [-t] [-tl] [-cp] [-dh] [-dn] [-de] [-f] [-rd] [-on] [-h] [-j]

Parameters

Parameter	Description
--backupPassword(s), -bp	(Optional) Defines the RMAN password for recovery. You can provide more than one password, but the passwords must be separated by a comma(,).
--backupReport, -r	JSON input for a backup report.
--dbClass, -cl {EE: OLTP/DSS/IMDB, SE: OLTP}	(Optional) Defines the Database class.
--dbConsoleEnable, -co	(Optional) Enables the Database Console.
--dbShape, -s {odb1,odb2, and so on}	(Optional) Defines the database shape.
--dbStorage, -dr {ACFS|ASM}	(Optional) Defines the database storage. Database Storage {ACFS|ASM} (non case-sensitive). The default is ASM.
--dbType, -y	(Optional) Defines the type of database. For high-availability deployments, the values can be RAC|RACOne|SI, with the default as RAC. For single-node deployments, the value is SI.
--dbEdition, -de	(Optional) Defines the Database Edition (SE or EE).
--databaseHome, -dh	(Optional) Defines the database home.
--dbName, -n	(Optional) Defines the database name.
--dbUniqueName, -u	(Optional) Defines the database unique name.
--dbDomainName, -dn	Defines the database domain name.
--dbrole, -ro	Defines the database role for Oracle Data Guard operations. The options are PRIMARY|STANDBY.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--enable-tde, -t	(Optional) Specifies whether you want to enable TDE on the target database.
--tde-backup-location, -tl	(Optional) Specifies the backup location for TDE wallet.
--noOfRmanChannels, -c	(Optional) Defines the number of RMAN channels (parallelism) Default: SE Edition: 1, Other Enterprise Editions: 5
--objectStoreId, -oid	Defines the Swift Object Store credential ID.
--objectStoreName, -on	Defines the Swift Object Store resource name.
--backuplocation, -bl	(Optional) Specifies the NFS or local directory path where backups are available.
--dbRedundancy, -rd	Specifies the database redundancy value, that is, {HIGH|MIRROR}. To specify the dbRedundancy option for an Oracle ASM or ACFS storage-based database, at least one disk group of FLEX redundancy must exist. To specify the dbRedundancy option for an Oracle ASM storage database, the dbVersion or dbHomeVersion must be 12.2 or later. The precedence logic for setting the dbRedundancy is: dbRedundancy that is specified in the irestore-database command. dbRedundancy in the backup report. If the disk group redundancy is FLEX, then the default dbRedundancy value is MIRROR.
--associated-networks, -nn	Specifies the associated network names (in the format networkName1,networkName2,...).
--dbOnFlashStorage, -f	(Optional) Specifies whether to enable data on Flash storage.
--no-dbOnFlashStorage, -no-f	(Optional) Specifies whether to disable data on Flash storage.
--cpupool, -cp	(Optional) Specifies the CPU pool name.

Usage Notes

Caution:

When you create a database with Transparent Data Encryption (TDE) enabled, you are prompted to set a password for the TDE wallet. Provide a strong password for security compliance. Set the password carefully, and ensure that this password is available to you at all times for database management operations. Failure to provide the TDE wallet password when prompted, will cause an error in accessing encrypted data.

• The command odacli irestore-database restores a database to a system using the Backup Report that is in the Oracle Object Store or External FRA (NFS) location. You can restore a database from one appliance to another appliance, or to the same appliance after the source database is deleted.

• An Oracle wallet (ObjectStoreSwift credentials) must be created to access the backups in Oracle Object Store. This command performs the environment checks, validation checks, and tasks needed to restore a database to an Oracle Database Appliance system.

• If -cp parameter is provided as part of the command, the database is associated with the particular CPU pool.
• If -cp parameter is not provided as part of the command, and if the backup report has information about the associated CPU pool, then the command validates the CPU pool specified in the backup report. If the validation fails, then an error message is displayed.
• If the backup report does not have information about any associated CPU pool, then the database is created without being associated with any CPU pool.
• To restore a TDE-enabled database, the TDE wallet password must be provided.
• If source database is TDE enabled, then the target database which was restored will also have TDE enabled.
• Specify the TDE wallet location if the backup report does not have TDE wallet location or if the backup report is inaccessible or unavailable.

Example 16-92 Restoring a Database to the Same System

Run the command odacli irestore-database with the backup report. Enter the SYS user password when prompted.

# odacli irestore-database -r backupreport.json -oid Object Store ID

Example 16-93 Restoring a Database to a Different System

To restore to a different system, copy the backup report to the other machine's \bin folder (or provide the complete path to the backup report), then run the command odacli irestore-database with the backup report. Enter the SYS user password when prompted.

# odacli irestore-database -r backupreport.json -oid Object Store ID

Example 16-94 Restoring a Database with TDE Wallet backup from a backup report

# odacli irestore-database -r backupreport.json -on oss1 -t
Enter SYS user password:
Retype SYS user password:
Enter TDE wallet password:

Example 16-95 Restoring a Database with TDE Wallet backup specified on the CLI

# odacli irestore-database -r backupreport.json -tl https://swiftobjectstorage.us-ashburn-1.oraclecloud.com/v1/paas_test/tde_Backups/test2-c/database/91276171/tdbacf2/tdewallet/ewallet_2020021714442745.p12 -on oss2 -p -m 
Enter SYS user password:
Retype SYS user password:
Enter TDE wallet password:

Example 16-96 Restoring to a standby database when Oracle Data Guard is configured

# odacli irestore-database -r backup_report.json -u dbUniqueName -ro STANDBY

Example 16-97 Recovering a Database that was associated with a CPU Pool

# odacli irestore-database -n irmendb3 -r dbcpupllong.json -on ostore -bp -dh 45156cc5-e768-4817-8b52-2a0a482be18f
Enter SYS user password: 
Retype SYS user password: 
Enter RMAN backup encryption password: 
Do you want to provide another RMAN backup encryption password? [y/n] (default 'n'): n
{
  "jobId" : "31af6cc8-5e04-459b-8017-271c55b8c99b",
  "status" : "Created",
  "message" : null,
  "reports" : [ ],
  "createTimestamp" : "August 10, 2020 11:20:08 AM UTC",
  "resourceList" : [ ],
  "description" : "Database service recovery with db name: irmendb3",
  "updatedTime" : "August 10, 2020 11:20:08 AM UTC"
}

odacli list-backupconfigs

Use the command odacli list-backupconfigs to list all backup configurations.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli  list-backupconfigs  [-h] [-j]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.

Example 16-98 Displaying a List of Backup Configuration

Display a list of backup configurations.

# odacli list-backupconfigs

odacli list-backupreports

Use the command odacli list-backupreports to display a list of all backup reports.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

#  odacli  list-backupreports  [-h] [-j]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.

Usage Notes

Displays a list of all database backup reports generated from the command odacli create-backup.

Example 16-99 Display a List of all Backup Reports

#  odacli  list-backupreports 

odacli list-objectstoreswifts

Use the command odacli list-objectstoreswifts to display a list of credentials for the ObjectStore account.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

# odacli list-objectstoreswifts [-h] [-j] 

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.

Example 16-100 Displaying a List of ObjectStore Swift Credentials

# odacli list-objectstoreswifts 

 odacli list-schedules

Use the command odacli list-schedules to display all of the schedules in the system, including database backup schedules and some internal maintenance schedules.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

#  odacli  list-schedules  [-h] [-j]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.

Usage Notes

The command lists all of the schedules in the system, including database backup schedules and some internal maintenance schedules.

Example 16-101 Display a List of Scheduled Database Backups

Display a list of all scheduled database backups and details.

#  odacli  list-schedules 
ID                                       Name                      Description                                        CronExpression                 Disabled
---------------------------------------- ------------------------- -------------------------------------------------- ------------------------------ --------
201672f6-c80c-4ff9-99be-2bc8be480e66     metastore maintenance     internal metastore maintenance                     0 0 0 1/1 * ? *                true   
e86ff1e9-8607-41f8-8d0a-cf59dc1e52a9     AgentState metastore cleanup internal agentstateentry metastore maintenance     0 0 0 1/1 * ? *                true   
17640773-aa8b-4b4f-b170-3a68d5329cbb     bom maintenance           bom reports generation                             0 0 1 ? * SUN *                true   
cae98cb1-e8ab-48c6-aaf9-22d9ab4097b1     Big File Upload Cleanup   clean up expired big file uploads.                 0 0 1 ? * SUN *                true   
745333ad-8845-4444-b591-7ca7d19a4d91     feature_tracking_job      Feature tracking job                               0 0 20 ? * WED *               true   
42b6894f-f680-4316-9958-f4ecf501d781     Log files Cleanup         Auto log file purge bases on policy                0 0 3 1/1 * ? *                true 

odacli list-tdebackupreports

Use the odacli list-tdebackupreports command to view TDE Wallet backup reports.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli list-tdebackupreports [-h] [-j] 

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.

Usage Notes

The TDE backup report saves the latest TDE Wallet backup location of a TDE-enabled database, when a database backup or a TDE Wallet backup is taken for that database.

Example 16-102 Viewing the TDE backup report

# odacli list-tdebackupreports
DbResID                                  OraDbId              BackupLocation                          
---------------------------------------- -------------------- ----------------------------------------
49772c1b-e4e4-401b-a5f0-16c7992d6766     1080131389           https://swiftobjectstorage.us-ashburn-1.oraclecloud.com/v1/paastest/TestLtBackupFailur/test2-c/database/1080131389/tddb3/tdewallet/ewallet_2020053120350968.p12
f1043fa4-b1ee-461b-84d6-8541e4f6f053     1052183392           /u01/NFS_TDE/orabackups/test2-c/database/1052183392/tddb4/tdewallet/ewallet_2020060102471941.p12
944a5613-2a1f-41fb-b7b1-91d35e3e8530     1002460890           /u03/app/oracle/fast_recovery_area/TDDB5/tdewallet/ewallet_2020060103125231.

odacli recover-database

Use the odacli recover-database command to recover or restore a database from backup.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli  recover-database [-i] [-br] [-i] [-h] [-j] [-r] [-t] [-p] [-s] [-in] [-tp] [-tl] [-tz] [-cp]

Parameters

Parameter	Description
--backupReport, -br{Regular-L0|Regular-L1|Longterm}	(Optional) JSON input for a backup report.
--dbName, -in	Defines the Database Name.
--dbid, -i	Defines the Database Resource ID.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--tde-backup-location, -tl	(Optional) Specifies the backup location for TDE wallet. If not specified, the latest known TDE backup location is used.
--recoveryTimeStamp, -r	(Optional) Defines the date and time of the backup. The Recovery Timestamp (in format mm/dd/yyyy hh:mm:ss) is required when the recovery is a point in time recovery (PITR).
--recoverytype, -t {Latest|PITR|SCN}	(Optional) Defines the recovery type. Do not provide the recovery type if you define the Backup Report.
--rmanrecoverypassword(s), -p	(Optional) Defines the password for recovery. You can provide more than one password, but the passwords must be within single quote separated by comma(,).
--scn, -s	(Optional) Defines the SCN recovery type. Required when the RecoveryType is SCN.
--cpupool, -cp	(Optional) Specifies the CPU pool name.
--timeZone, -tz	(Optional) Specifies the recovery time zone, in a format similar to {area}/{city} such as america/los_angeles. This option is required when the recovery type is a point in time recovery (PITR).

Usage Notes

Recovers a database to the latest, a point in time recovery (PITR), or System Change Number (SCN) as input. You can also recover a database from a Backup Report provided as JSON input file.

This command performs various environment and validation checks in order to attempt to ensure that recovery of database is successful. If non-TDE database backups are in ObjectStore, the RMAN recovery passwords are needed to recover the database. This includes RMAN restore and recovery.

This command always performs a full RMAN database restore and recovery. This command is most useful when there is a complete database loss or when the majority of the database files are lost. If you do not require a full RMAN restore, you can perform a manual recovery. For example, a single data file loss or control file loss.

• If -cp parameter is provided as part of the command, recovered database is associated with the particular CPU pool.
• If -cp parameter is not provided as part of the command, and if the backup report has information about the associated CPU pool, then the recovered database is also associated with the same CPU pool.
• If the original database does not have any associated CPU pool, then the recovered database is also not associated with any CPU pool.

Example 16-103 Recovering a Database to a Point-in-Time

# odacli recover-database -i b5fc646e-01a6-4c8b-8286-7633346c4 -t PITR -r 11/08/2017 12:57:33 –p

Example 16-104 Recovering a Database to the latest

# odacli recover-database -i b5fc646e-01a6-4c8b-8286-7633346c4 -t Latest -p

Example 16-105 Recovering a Database to an SCN

# odacli recover-database -i b5fc646e-01a6-4c8b-8286-7633346c4 -t SCN -s 392375947

Example 16-106 Restoring the TDE Wallet while performing database recovery, if TDE wallets are lost

# odacli recover-database -in db1 -t latest -tp -tl /u01/NFS_TDE/testbackups/test2-c/database/91276171/tdbacf2/tdewallet/ewallet_2020021714442745.p12
Enter TDE wallet password: 

Example 16-107 Recovering a Database that was associated with a CPU Pool

# odacli recover-database -t latest -in irmendb4  -cp testcpupool3
{
  "jobId" : "b09f2d3f-2b01-4dbb-9797-122ba786e0e4",
  "status" : "Created",
  "message" : null,
  "reports" : [ ],
  "createTimestamp" : "August 10, 2020 14:56:57 PM UTC",
  "resourceList" : [ ],
  "description" : "Create recovery-latest for db : irmendb4",
  "updatedTime" : "August 10, 2020 14:56:57 PM UTC"
}

odacli restore-archivelog

Use the odacli restore-archivelog command to restore archivelog from one SCN to another SCN, or from one timestamp to another timestamp.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli restore-archivelog -fs from_scn -ts to_scn -ft from_timestamp -tt to_timestamp [-h] [-j] 

Parameters

Parameter	Description
--dbname, -in	Specifies the Database Name.
--dbid, -i	(Optional) Specifies the Database resource ID.
--from-scn, -fs	(Optional) Specifies the start SCN of archivelog restore.
--from-timestamp, -ft	(Optional) Specifies the start time of archivelog restore (in the format mm/dd/yyyy hh:mi:ss).
--to-scn, -ts	(Optional) Specifies the end SCN of archivelog restore.
--to-timestamp, -tt	(Optional) Specifies the end time of archivelog restore (in the format mm/dd/yyyy hh:mi:ss).
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.

Usage Notes

You can restore archivelog for all supported database versions and database types for an Oracle Database Appliance release.

Example 16-108 Restoring archivelog

# odacli restore-archivelog -fs from_scn -ts to_scn
# odacli restore-archivelog -ft from_timestamp -tt to_timestamp

odacli restore-tdewallet

Use the odacli restore-tdewallet command to restore TDE wallet from the backup location.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli  restore-tdewallet [-in] [-tl] [-h] [-j] 

Parameters

Parameter	Description
--dbname, -in	Specifies the Database Name.
--tde-backup-location, -tl	(Optional) Specifies the backup location for TDE wallet.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.

Usage Notes

Caution:

When you create a database with Transparent Data Encryption (TDE) enabled, you are prompted to set a password for the TDE wallet. Provide a strong password for security compliance. Set the password carefully, and ensure that this password is available to you at all times for database management operations. Failure to provide the TDE wallet password when prompted, will cause an error in accessing encrypted data.

• This command prompts for TDE wallet password. When prompted, enter the password of the TDE wallet. This password is the one you created or last updated using the modify-database command.
• TDE Wallet backup location is optional. If no TDE Wallet backup location is provided, then the latest TDE Wallet backup of the database known to the system is used for restoring the TDE Wallet.

Example 16-109 Restoring TDE wallet for a database from a backup location

# odacli restore-tdewallet -in testdb -tl /u01/NFS_TDE/testbackups/test2-c/database/91276171/tdbacf2/tdewallet/ewallet_2020021714442745.p12
Enter TDE wallet password: 

odacli update-backupconfig

Use the command odacli update-backupconfig to update a backup configuration.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

  odacli  update-backupconfig [-i] [-in] [-ca] -d backup destination{Disk|ObjectStore|None} [-c] [-cr] [-h] [-j] [-no-cr] [-dc] [-ec] [-o][-w]

Parameters

Parameter	Description
--backupconfigid, -i	Defines the Backup Config ID.
--backupconfigname, -in	Defines the Backup Config name.
--backupdestination, –d{Disk|ObjectStore|None}	Defines the backup destination. The options are not case sensitive. Applicable to System type backup config.
--compression-algo, –ca{BASIC|LOW|MEDIUM|HIGH}	Defines the Compression Algorithm that RMAN must use. The default is BASIC for Disk and NFS backup and MEDIUM for ObjectStore backup.
--container, -c	(Optional) Defines the object store container or absolute path to the parent directory of NFS destination for backups.
--crosscheck, -cr	(Optional) Enable Crosscheck. Applicable to Database type backup config.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--name, -n	Defines the backup configuration name.
--no-crosscheck, -no-cr	(Optional) Disable crosscheck.
--objectstoreswiftId, -o	(Optional) Defines the swift object store credential ID.
--recoverywindow, -w Disk: {1-14} ObjectStore: {1-30}	(Optional) Defines the Recovery Window in days. {1-14} days for Disk and {1-30} days for Object store. Applicable to Database type backup config.
--disable-compression, -dc	(Optional) Disables compression for the backups.
--enable-compression, -ec	(Optional) Enables compression for the backups.
--objectstoreswiftname, -on	(Optional) Describes the Swift Object Store credential name.

Usage Notes

• The recovery window that is defined in the backup configuration determines when backups are considered obsolete. The following are guidelines:

  • Disk: 1-14 days

  • ObjectStore in Casper: 1-30 days

Example 16-110 Revise a Backup Configuration for Disk

Create a backup configuration named production that backs up to disk with a 14 day recovery window.

# odacli update-backupconfig -d Disk -in production -w 14

odacli update-objectstoreswift

Use the command odacli update-objectstoreswift to change the credentials for the ObjectStore account.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli  update-objectstoreswift [-h] [-j] [-in] [-i] [-p] [-u] Object Store user name

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--objectstoreswiftid, -i	Defines the Object Store Swift identifier (ID).
--objectstoreswiftName, -in	Defines the Object Store Swift name.
--swiftpassword, -p	(Optional) Defines the Object Store Swift password.
--username, -u	(Optional) Defines the Object Store Swift user name.

Usage Notes

Use this command to update the password when it is changed for an ObjectStore account. The command updates the Oracle ObjectStore credential details in the system and stores the password in an encrypted Oracle wallet.

The credentials are validated during the command odacli update-backupconfig with objectstore as the destination. The credentials are not validated against endpoint URL and tenancy.

Example 16-111 Changing the Oracle Casper ObjectStore Password

# odacli  update-objectstoreswift -i Object Store Swift id -p

Example 16-112 Changing the Oracle ObjectStore User Name

# odacli  update-objectstoreswift -i Object Store Swift id -u Object Store user name

 odacli update-schedule

Use the command odacli update-schedule to update the schedule for a database, or to disable the database backup schedule.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

#  odacli  update-schedule  [-x] [-t] [-d] [-e] [-h] [-j] [-id]

Parameters

Parameter	Description
--cronExpression, -x	(Optional) Defines the date and time for the update.
--description, -t	(Optional) Provides a description for the update schedule.
--disable, -d	(Optional) Disables the schedule.
--enable, -e	(Optional) Enables a disabled schedule.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--scheduleid, -id	Defines the schedule with an identifier (ID).

Usage Notes

Backups incur overhead on the system. When possible, do not schedule backups to run when users are trying to access data.

Use a utility, such as www.croncronmaker.com, to generate a valid cron expression.

Example 16-113 Change What Time the Backup Occurs

Edit the cron expression to change the time of scheduled backups for a given schedule ID.

#  odacli  update-schedule -i scheduleid  -x "0 0 13 1/1 * ? *" -e

Example 16-114 Disable Scheduled Database Backups

#  odacli  update-schedule -i scheduleid  -d

odacli Oracle Data Guard Commands

Use ODACLI commands to configure and manage Oracle Data Guard in your Oracle Database Appliance deployment.

•  odacli configure-dataguard
  Use the command odacli configure-dataguard to configure Oracle Data Guard on Oracle Database Appliance.
•  odacli deconfigure-dataguard
  Use the command odacli deconfigure-dataguard to deconfigure Oracle Data Guard on Oracle Database Appliance.
•  odacli describe-dataguardstatus
  Use the command odacli describe-dataguardstatus to view Oracle Data Guard status on Oracle Database Appliance.
•  odacli failover-dataguard
  Use the command odacli failover-dataguard on the standby system to failover the Oracle Data Guard primary database to the standby database.
•  odacli list-dataguardstatus
  Use the command odacli list-dataguardstatus to verify Oracle Data Guard status on both primary and standby databases.
•  odacli reinstate-dataguard
  Use the command odacli reinstate-dataguard on the new primary system to reinstate a failed primary database after a failover and convert it to a new standby database.
•  odacli switchover-dataguard
  Use the command odacli switchover-dataguard on the primary system to reverse the Oracle Data Guard primary and standby database roles on Oracle Database Appliance.

 odacli configure-dataguard

Use the command odacli configure-dataguard to configure Oracle Data Guard on Oracle Database Appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli configure-dataguard [-h] [-j] [-i] [-r] [-s]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--requestjson, -r	(Optional) Specifies the JSON file for creating the appliance.
--skip-password-copy, -s	(Optional) Specifies that step to copy the password from primary database to standby database can be skipped.

Usage Notes

If the database orapwd file is not in the typical location, then an error may occur in the configuration process. In such a case, manually copy the orapwd file from the primary database to the standby database in advance, and configure Oracle Data Guard with the --skip-password-copy option.

Example 16-115 Configuring Oracle Data Guard interactively on the commad line

# odacli configure-dataguard
Standby site address: test_domain
BUI username for Standby site (default: oda-admin): 
BUI password for Standby site: 
TrustStore path for Standby DCS server: /cacerts.a
TrustStore password for Standby DCS server: <TrustStore_Password>
Database name for Data Guard configuration: cpub
Primary database syspassword: 
***********************************************************************************
Data Guard default settings
Primary site network for Data Guard configuration: Public-network
Standby site network for Data Guard configuration: Public-network
Primary database listener port: 1521
Standby database listener port: 1521
Transport type: ASYNC
Protection mode: MAX_PERFORMANCE
Data Guard configuration name: pcpub_scpub
Active Data Guard: disabled
Do you want to edit this Data Guard configuration? (Y/N, default:N): 
The TrustStore of the Standby site should be removed unless it is necessary for some other purpose. Do you want to delete it? (Y/N, default:Y): n
As a requirement, Standby database's SYS password will be set to Primary database's after Data Guard configuration. Are you sure you want to proceed with Data Guard configuration? (Y/N): y
*******************************************************************************************
Configure Data Guard pcpub_scpub started
*******************************************************************************************
Step 1: Validate Data Guard configuration request (Primary site)
Description: Validate DG Config Creation
Job ID: bafb8ef4-d3c9-4421-84a1-4c75d73e71a0
Started August 25, 2020 05:51:20 UTC
Validate create Data Guard configuration request
Finished August 25, 2020 05:51:27 UTC
*******************************************************************************************
Step 2: Validate Data Guard configuration request (Standby site)
Description: Validate DG Config Creation
Job ID: a7b80880-40ab-4dbf-b8be-22717ae87711
Started August 25, 2020 05:51:27 UTC
Validate create Data Guard configuration request
Finished August 25, 2020 05:51:33 UTC
*******************************************************************************************
Step 3: Download password file from Primary database (Primary site)
Description: Download orapwd file from Primary database
Started August 25, 2020 05:51:33 UTC
Prepare orapwd file for Primary database cpub
Finished August 25, 2020 05:51:38 UTC
*******************************************************************************************
Step 4: Upload password file to Standby database (Standby site)
Description: Upload orapwd file to Standby database
Started August 25, 2020 05:51:38 UTC
Write orapwd file to Standby database cpub
Finished August 25, 2020 05:51:47 UTC
*******************************************************************************************
Step 5: Configure Primary database (Primary site)
Description: DG Config service creation - ConfigurePrimary
Job ID: b6726f76-0a3a-4bb1-8fec-a3eb311531cf
Started August 25, 2020 05:51:47 UTC
Configure host DNS on primary env
Configure Data Guard Tns on primary env
Enable Data Guard related Db parameters for primary env
Enable force logging and archivelog mode in primary env
Enable FlashBac
Configure network parameters for local listener on primary env
Restart listener on primary env
Create services for primary db
Finished August 25, 2020 05:52:10 UTC
*******************************************************************************************
Step 6: Configure Standby database (Standby site)
Description: DG Config service creation - ConfigureStandby
Job ID: e6b552be-fef0-4cd6-a61d-81292f957a6e
Started August 25, 2020 05:52:10 UTC
Configure Data Guard Tns on standby env
Configure host DNS on standby env
Clear Data Guard related Db parameters for standby env
Enable Data Guard related Db parameters for standby env
Enable force logging and archivelog mode in standby env
Populate standby database metadata
Configure network parameters for local listener on standby env
Reset Db sizing and hidden parameters for ODA best practice
Restart Listener on standby env
Create services for standby db
Finished August 25, 2020 05:53:40 UTC
*******************************************************************************************
Step 7: Configure and enable Data Guard (Primary site)
Description: DG Config service creation - ConfigureDg
Job ID: 0b79511f-794a-4bc2-936d-5c651110467f
Started August 25, 2020 05:53:40 UTC
Config and enable Data Guard
Post check Data Guard configuration
Finished August 25, 2020 05:55:06 UTC
*******************************************************************************************
Step 8: Enable Flashback (Standby site)
Description: DG Config service creation - EnableFlashback
Job ID: b526445e-67df-4c35-a7ca-8420298b8bd2
Started August 25, 2020 05:55:06 UTC
Enable FlashBack
Finished August 25, 2020 05:55:17 UTC
*******************************************************************************************
Step 9: Re-enable Data Guard (Primary site)
Description: DG Config service creation - ReenableDg
Job ID: 4833133f-da65-44a9-beb7-2c4d347c9120
Started August 25, 2020 05:55:23 UTC
Re-enable Data Guard if inconsistent properties found
Post check Data Guard configuration
Finished August 25, 2020 05:55:29 UTC
*******************************************************************************************
Step 10: Create Data Guard status (Primary site)
Description: DG Status service creation - NewDgconfig
Job ID: 430d0613-bcd3-4e34-9418-c5f4dfddc052
Started August 25, 2020 05:55:33 UTC
Create Data Guard status
Finished August 25, 2020 05:55:37 UTC
*******************************************************************************************
Step 11: Create Data Guard status (Standby site)
Description: DG Status service creation - NewDgconfig
Job ID: 93bcdd39-657f-4d7c-b893-c50dc5e708c4
Started August 25, 2020 05:55:40 UTC
Create Data Guard status
Finished August 25, 2020 05:55:43 UTC
*******************************************************************************************
Configure Data Guard pcpub_scpub completed
*******************************************************************************************

Example 16-116 Configuring Oracle Data Guard using JSON file

# odacli configure-dataguard -r configdg_ODA_HA.json 
Standby machine address: 192.214.108.19
BUI username for Standby machine (default: oda-admin): 
BUI password for Standby machine: 
TrustStore path for Standby DCS server (copy from /opt/oracle/dcs/dcscli/cacerts on Standby machine to this machine and set file permissions to 400): /cacerts.a
TrustStore password for Standby DCS server: (can be found in /opt/oracle/dcs/dcscli/dcscli.conf)
Primary database syspassword: 
Standby database syspassword (default: same as primary): 
The TrustStore of the Standby machine should be removed unless it is necessary for some other purpose. Do you want to delete it? (Y/N, default:Y): n
As a requirement, Standby database’s SYS password will be set to Primary database’s after Data Guard configuration. Are you sure you want to proceed? (Y/N): y
Data Guard configuration for database 'test' started
*******************************************************************************************
Step 1: Validate Data Guard configuration request (Primary machine)
.....

Example 16-117 Sample JSON for configuring Oracle Data Guard on Oracle Database Appliance High-Availability Deployments

{
  "name": "pink1_pink7",
  "protectionMode": "MAX_PERFORMANCE",
  "enableFlashback": true,
  "enableActiveDg": false,
  "replicationGroups": [
    {
      "sourceEndPoints": [
        {
          "endpointType": "PRIMARY",
          "hostName": "test_domain1",
          "listenerPort": 1521,
          "databaseUniqueName": "pink1",
          "ipAddress": "192.214.96.214"
        },
    {
      "endpointType": "PRIMARY",
      "hostName": "test_domain2",
      "listenerPort": 1521,
      "databaseUniqueName": "pink1",
      "ipAddress": "192.214.96.215"
    }
      ],
      "targetEndPoints": [
        {
          "endpointType": "STANDBY",
          "hostName": "test_domain1",
          "listenerPort": 1521,
          "databaseUniqueName": "pink7",
          "ipAddress": "192.214.108.19"
        },
        {
          "endpointType": "STANDBY",
          "hostName": "test_domain2",
          "listenerPort": 1521,
          "databaseUniqueName": "pink7",
          "ipAddress": "192.214.108.20"
        }
      ],
      "transportType": "ASYNC"
    }
  ]
}

 odacli deconfigure-dataguard

Use the command odacli deconfigure-dataguard to deconfigure Oracle Data Guard on Oracle Database Appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli deconfigure-dataguard [-h] [-j] [-i]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--dgconfigid, -i	Specifies the Oracle Data Guard Configuration ID.

Usage Notes

For deconfiguring Oracle Data Guard, you must specify the Oracle Data Guard Configuration ID. Run the odacli list-dataguardstatus command to find the Oracle Data Guard Configuration ID.

Example 16-118 Deconfiguring Oracle Data Guard on the Primary Machine

# odacli deconfigure-dataguard -i 8396aac4-f7e7-42e4-a2e8-0cbbc89ce31b
Standby site address: test_domain
BUI username for Standby site (default: oda-admin): 
BUI password for Standby site: 
TrustStore path for Standby DCS server : /cacerts.a
TrustStore password for Standby DCS server: TrustStore_Password
The TrustStore of the Standby site should be removed unless it is necessary for some other purpose. Do you want to delete it? (Y/N, default:Y): n
Standby database will be deleted after Data Guard configuration is removed. Are you sure you want to proceed? (Y/N): y
Deconfigure Dataguard Started
*******************************************************************************************
Step 1: Deconfigure Data Guard (Primary site)
Description: Deconfigure DG service
Job ID: 8deb3e4c-09cd-4593-8184-f7706dd2ec8a
Started
Deconfigure Data Guard service
Cleanup broker resources
Finished
*******************************************************************************************
Step 2: Delete Data Guard status (Primary site)
Description: DG Status service creation - UpdateDgconfig
Job ID: 59c61629-6c7d-474c-8c29-c0a9565d91a3
Started
Update Data Guard status
Finished
*******************************************************************************************
Step 3: Delete Data Guard status (Standby site)
Description: DG Status service creation - UpdateDgconfig
Job ID: 93dcf4cd-1019-4bcd-984a-d3efeb3fae6e
Started
Update Data Guard status
Finished
*******************************************************************************************
Step 4: Delete Standby database (Standby site)
Description: Database service deletion with db name: panda with id : 30dd49da-a54f-4a9a-abbf-d3a4e39abee5
Job ID: 0b1cb921-fd41-4e01-86df-beff3adb6de0
Started
Validate db 30dd49da-a54f-4a9a-abbf-d3a4e39abee5 for deletion
Database Deletion
Unregister Db From Cluster
Kill Pmon Process
Database Files Deletion
Deleting Volume
Delete File Groups of Database panda
Finished
*******************************************************************************************
Data Guard configuration is removed

 odacli describe-dataguardstatus

Use the command odacli describe-dataguardstatus to view Oracle Data Guard status on Oracle Database Appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli describe-dataguardstatus [-h] [-j] [-i]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--dgid, -i	Specifies the Oracle Data Guard Status ID.

Usage Notes

Example 16-119 Viewing Oracle Data Guard configuration status

# odacli describe-dataguardstatus -i 5f0ed48a-366d-454c-a389-fe367772dbb7

 odacli failover-dataguard

Use the command odacli failover-dataguard on the standby system to failover the Oracle Data Guard primary database to the standby database.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli failover-dataguard [-h] [-j] [-i] [-u]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--dgid, -i	Specifies the Oracle Data Guard Status ID.
--databaseUniqueName, -u	Specifies the unique name of the database to failover to.

Usage Notes

After performing the failover, view the status with the odacli list-dataguardstatus command.

Example 16-120 Performing Failover Oracle Data Guard

# odacli failover-dataguard -i 75f23ce0-006a-4aeb-ba6d-b4b60275c19 -u houdg02 

 odacli list-dataguardstatus

Use the command odacli list-dataguardstatus to verify Oracle Data Guard status on both primary and standby databases.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli list-dataguardstatus [-h] [-j]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.

Usage Notes

Example 16-121 Viewing Oracle Data Guard status on primary and standby databases

# odacli list-dataguardstatus

 odacli reinstate-dataguard

Use the command odacli reinstate-dataguard on the new primary system to reinstate a failed primary database after a failover and convert it to a new standby database.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli reinstate-dataguard [-h] [-j] [-i] [-u]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--dgid, -i	Specifies the Oracle Data Guard Status ID.
--databaseUniqueName, -u	(Optional) Specifies the unique name of the database to reinstate.

Usage Notes

After completing the reinstate operation, view the status with the odacli list-dataguardstatus command.

Example 16-122 Performing reinstate operation on Oracle Data Guard

# odacli reinstate-dataguard -i 75f23ce0-006a-4aeb-ba6d-b4b60275c19 -u houdg02  

 odacli switchover-dataguard

Use the command odacli switchover-dataguard on the primary system to reverse the Oracle Data Guard primary and standby database roles on Oracle Database Appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli switchover-dataguard [-h] [-j] [-i] [-u]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output. The default is false.
--dgid, -i	Specifies the Oracle Data Guard Status ID.
--databaseUniqueName, -u	(Optional) Specifies the unique name of the database to switchover to.

Usage Notes

After performing the switchover, view the status with the odacli list-dataguardstatus command.

Example 16-123 Switching over Oracle Data Guard

# odacli switchover-dataguard -i 75f23ce0-006a-4aeb-ba6d-b4b60275c19 -u houdg02 

odacli CPU Core Commands

Use the CPU Core commands to enable CPU cores and display current and historical CPU core configurations.

• odacli list-cpucores
  Use the odacli list-cpucores command lists the history of core configuration changes in the system.
• odacli describe-cpucore
  Use the odacli describe-cpucore command to display the current core configuration and the modification date and time.
• update-cpucore
  Use the odacli update-cpucore command to enable the number of CPU cores in the system.

odacli list-cpucores

Use the odacli list-cpucores command lists the history of core configuration changes in the system.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

odacli list-cpucores  [-h]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.

Example 16-124 Displaying a List of Cores

# odacli list-cpucores  

Node  Cores  Modified                       Job Status 
----- ------ ------------------------------ --------------- 
0     10     July 22, 2016 12:06:08 PM SGT  Configured 
0     8      July 25, 2016 9:39:59 AM SGT   Configured

odacli describe-cpucore

Use the odacli describe-cpucore command to display the current core configuration and the modification date and time.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

 odacli describe-cpucore  [-h]

Parameters

Parameter	Description
--help, -h	(Optional) Displays help for using the command.

Example 16-125 Displaying the Current Core Configuration

# odacli describe-cpucore  

Node  Cores  Modified                       Job Status
----- ------ ------------------------------ --------------- 
0      8     July 25, 2016 9:39:59 AM SGT   Configured

update-cpucore

Use the odacli update-cpucore command to enable the number of CPU cores in the system.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

 odacli update-cpucore  -c cores [-h]

Parameters

Parameter	Description
--cores, -c	Defines the number of cores to be enabled in the system.
--help, -h	(Optional) Displays help for using the command.

Usage Notes

• The number of cores you enable must be a multiple of 2.

• After the initial configuration, you cannot reduce the number of cores. You can only increase the number of cores.

• When you run the command, you are prompted to confirm the operation with the following message:

  Modifying the enabled number of CPU requires a reboot of all nodes in the ODA system. Are you sure you want to proceed with this operation? (Y/N):

• Nodes are restarted after modifying the cores in the BIOS. Note this results in database outage as all the nodes in the cluster are restarted at the same time. Once the system is restarted, the system is updated with the correct number of cores.

Example 16-126 Enabling CPU Cores

The following command enables 8 CPU cores.

# odacli update-cpucore -c 32
Modifying the enabled number of CPU requires a reboot of all nodes in the ODA system. Are you sure you want to proceed with this operation? (Y/N): y
{
  "jobId" : "1a59d182-79f0-4847-81e6-ab3ebf779096",
  "status" : "Created",
  "message" : null,
  "reports" : [ ],
  "createTimestamp" : "June 30, 2021 10:29:37 AM UTC",
  "resourceList" : [ ],
  "description" : "CPU cores service update",
  "updatedTime" : "June 30, 2021 10:29:37 AM UTC"
}
WARNING: Reducing the number of enabled cores may set offline any of the CPUs
used by a CPU Pool. Thus, please review the status of all the CPU Pools after
this operation using the 'describe-cpupool' command. In case of any CPU from
a CPU Pool was offline please run 'modify-cpupool' to update the list of CPUs
and use only online CPUs.
WARNING: All the nodes in this ODA system will reboot after this operation 

odacli CPU Pool Commands for Bare Metal and KVM

Use odacli commands to manage resource allocations on Oracle Database Appliance for bare metal and KVM deployments.

CPU pools enable management of CPU resources in both bare metal and KVM environments. There are two types of CPU pools, that is, BM and VM.

Use the BM CPU pool to ensure that the database on a bare metal host runs exclusively on the CPUs specified in the CPU pool.

Use the VM CPU pools to cage and manage CPU resource allocations to workloads for virtual machines. Workloads are isolated by creating CPU pools and assigning or pinning virtual machines to a specific CPU pool. When you pin a virtual machine to a CPU pool, you ensure that the virtual machine uses CPUs in only that CPU pool.

Resources in CPU pools cannot overlap, that is, CPU pools cannot share CPUs.

• odacli create-cpupool
  Use the odacli create-cpupool command to create a new CPU pool on Oracle Database Appliance Bare Metal or Kernel-based Virtual Machine (KVM) deployment.
• odacli remap-cpupools
  Use the odacli remap-cpupools command to remap CPU pools to NUMA allocation on Oracle Database Appliance Bare Metal or Kernel-based Virtual Machine (KVM) deployment.
• odacli list-cpupools
  Use the odacli list-cpupools command to list all CPU Pools on Oracle Database Appliance Bare Metal or Kernel-based Virtual Machine (KVM) deployment.
• odacli describe-cpupool
  Use the odacli describe-cpupool command to describe CPU Pools on Oracle Database Appliance Bare Metal or Kernel-based Virtual Machine (KVM) deployment.
• odacli modify-cpupool
  Use the odacli modify-cpupool command to modify a CPU Pool configuration on Oracle Database Appliance Bare Metal or Kernel-based Virtual Machine (KVM) deployment.
• odacli delete-cpupool
  Use the odacli delete-cpupool command to delete a CPU Pool configuration on Oracle Database Appliance Kernel-based Virtual Machine (KVM).
• odacli list-auditrecords
  Use the odacli list-auditrecords command to list the audit records for a CPU Pool on Oracle Database Appliance Bare Metal or Kernel-based Virtual Machine (KVM) deployment.
• odacli describe-auditrecord
  Use the odacli describe-auditrecord command to describe the audit record for a CPU Pool on Oracle Database Appliance Bare Metal or Kernel-based Virtual Machine (KVM) deployment.

odacli create-cpupool

Use the odacli create-cpupool command to create a new CPU pool on Oracle Database Appliance Bare Metal or Kernel-based Virtual Machine (KVM) deployment.

Syntax

 odacli create-cpupool -n name -c number_of_cores {-bm|-vm} -nn node_name -s socket -dbs [-j] [-h]

Parameters

Parameter	Description
--name, -n	Specifies the CPU Pool name.
--cores, -c	Specifies the CPU Pool cores.
--bm, -bm	Specifies the CPU Pool as Bare Metal.
--vm, -vm	Specifies the CPU Pool as Virtual Machine.
--dbsystem, -dbs	Specifies the CPU Pool type as DB System.
--socket, -s	Specifies the socket to use. If not specified, then use all available sockets.
--node-name, -nn	(Optional) Specifies the node where the CPU Pool will be created. On High-Availability deployment, if this option is not specified, then the CPU pool is created on both nodes.
--json, -j	(Optional) Displays output in JSON format.
--help, -h	(Optional) Displays help for using the command.

Usage Notes

• Attach the BM CPU pool to databases. Bare metal CPU pools can be assigned to multiple databases.
• Attach VM CPU pool VM guest machines. VM CPU pools can be assigned to multiple VMs.
• Attach dbsystem CPU pool to dbsystems. dbsystem CPU pool can be assigned to multiple dbsystems. After you create a dbsystem CPU pool, you can create a new dbsystem with this CPU pool by adding the new CPU pool parameter in the create-dbsystem json file, or modify-dbsystem to attach CPU pool to an existing dbsystem.
• Resources in CPU pools cannot overlap, that is, CPU pools cannot share CPUs.
• After you create a BM CPU pool, you can associate this CPU pool to a database using the create-database or modify-database command.
• After you create a VM CPU pool, you can associate this CPU pool to a VM using the create-vm or modify-vm command.
• Number of cores mustbe an even number between 2 and the total number of available cores on the system.
• By default, a CPU in the CPU pool is allocated across two sockets in release 19.12 and later. Optionally, you can choose to allocate the CPU based on the socket number (0 or 1). This is especially useful to support Standard Edition licensing. It is recommended that you use the default allocation and do not mix two types of allocation.

Example

Create a BM CPU pool named cpupool1 with 6 cores associated to it.

# odacli create-cpupool -n cpupool1 -c 6 -bm

Create a VM CPU pool named cpupool2 with 6 cores associated to it.

# odacli create-cpupool -n cpupool2 -c 6 -vm

Create a DB System CPU pool named cpupool3 with 6 cores associated to it.

# odacli create-cpupool -n cpupool3 -c 6 -dbs

Create a DB System CPU pool named cpupool4 with 4 cores of CPUs allocated from socket 0.

# odacli create-cpupool -n cpupool4 -dbs -s 0 -c 4

odacli remap-cpupools

Use the odacli remap-cpupools command to remap CPU pools to NUMA allocation on Oracle Database Appliance Bare Metal or Kernel-based Virtual Machine (KVM) deployment.

Syntax

 odacli remap-cpupools -f -urc [-j] [-h]

Parameters

Parameter	Description
--force, -f	(Optional) Specifies to force the operation.
--use-reserved-cores, -j	(Optional) Specifies to use reserved CPU cores.
--json, -j	(Optional) Displays output in JSON format.
--help, -h	(Optional) Displays help for using the command.

Usage Notes

If the odacli remap-cpupools command fails with the error DCS-10001:Internal error encountered: Not enough physical CPUs available for CPU Pool 'cpupool_name' on node 'node_name', run the odacli remap-cpupools command again with the --use_reserved-cores option.

Use the --force option to remap CPU pools even if the CPU pool is marked as NUMA-enabled. You must odacli remap-cpupools command, after updating the bare metal CPU cores with the command odacli update-cpucores for CPU core number changes.

By default, the first core of the socket is reserved and cannot be used by the VM and DB system CPU pools for optimal performance. Use the --use-reserved-cores option to enable use of the first core of socket for VM and DB system CPU pools.

Example

# odacli remap-cpupools

About Enabling NUMA on Oracle Database Appliance

odacli modify-vm

odacli remap-cpupools

odacli modify-dbsystem

odacli create-cpupool

odacli list-cpupools

Use the odacli list-cpupools command to list all CPU Pools on Oracle Database Appliance Bare Metal or Kernel-based Virtual Machine (KVM) deployment.

Syntax

 odacli list-cpupools [-j] [-h]

Parameters

Parameter	Description
--json, -j	(Optional) Displays output in JSON format.
--help, -h	(Optional) Displays help for using the command.

Example

# odacli list-cpupools

odacli describe-cpupool

Use the odacli describe-cpupool command to describe CPU Pools on Oracle Database Appliance Bare Metal or Kernel-based Virtual Machine (KVM) deployment.

Syntax

 odacli describe-cpupool -n name [-j] [-h]

Parameters

Parameter	Description
--name, -n	Specifies the name of the CPU Pool.
--json, -j	(Optional) Displays output in JSON format.
--help, -h	(Optional) Displays help for using the command.

Example: Describing a CPU pool named cpupool1

# odacli describe-cpupool -n cpupool1

odacli modify-cpupool

Use the odacli modify-cpupool command to modify a CPU Pool configuration on Oracle Database Appliance Bare Metal or Kernel-based Virtual Machine (KVM) deployment.

Syntax

 odacli modify-cpupool -n name -c cores -f -l [-j] [-h]

Parameters

Parameter	Description
--name, -n	Specifies the CPU Pool name
--cores, -c	Specifies the new number of CPU cores
--force, -f	(Optional) Forces the operation
--live, -l	(Optional) Applies the changes to running VMs
--json, -j	(Optional) Displays output in JSON format.
--help, -h	(Optional) Displays help for using the command.

Usage Notes

For VM CPU pool, if --live is not specified, then the changes are applied to the VM configuration file and will be activated next time the VM is started. If --live is specified, then the changes will be applied to both VM configuration file and to the running VM.

Example

Set the size of a CPU Pool cpupool1 to 10. If --live is not specified, the change is applied to the VM configuration file and will be activated next time the VM is started.

# odacli modify-cpupool -n cpupool1 -c 10

odacli delete-cpupool

Use the odacli delete-cpupool command to delete a CPU Pool configuration on Oracle Database Appliance Kernel-based Virtual Machine (KVM).

Syntax

 odacli delete-cpupool -n name -f [-j] [-h]

Parameters

Parameter	Description
--name, -n	Specifies the CPU Pool name to be deleted
--force, -f	(Optional) Forces deletion.
--json, -j	(Optional) Displays output in JSON format.
--help, -h	(Optional) Displays help for using the command.

Example

Delete a CPU pool named cpupool1.

# odacli delete-cpupool -n cpupool1

odacli list-auditrecords

Use the odacli list-auditrecords command to list the audit records for a CPU Pool on Oracle Database Appliance Bare Metal or Kernel-based Virtual Machine (KVM) deployment.

Syntax

 odacli list-auditrecords -du dcs-username -f from_date-range -l latest -n node_ID -ot operation_type -ou OS_username -rn resource_name -rt resource_type -t to_date-range [-j] [-h]

Parameters

Parameter	Description
--dcs-user, -du	(Optional) Specifies the DCS user name.
--from, -f	(Optional) Specfies the from date in the date range for the CPU pool audit records.
--latest, -l	(Optional) Specifies the latest number of CPU pool audit records.
--node-id, -n	(Optional) Specifies the node ID.
--op-type, -ot	(Optional) Specifies the type of operation.
--os-user, -ou	(Optional) Specifies the operating system user.
--rsc-name, -rn	(Optional) Specifies the resource name.
--rsc-type, -rt	(Optional) Specifies the resource type.
--to, -t	(Optional) Specfies the to date in the date range for the CPU pool audit records.
--json, -j	(Optional) Displays output in JSON format.
--help, -h	(Optional) Displays help for using the command.

Example

# odacli list-auditrecords
ID                                    Resource type         Resource name         Operation type   DCS username     OS username      Timestamp              
------------------------------------  --------------------  --------------------  ---------------  ---------------  ---------------  -----------------------
41295d99-f263-4284-b6d9-2aff1ae0f850  BM_CPU_POOL           testbmpool            CREATE           oda-admin        root             2020-10-08 13:27:05 UTC
0f07a013-5bb4-4cd8-bd49-04dc61fcd454  BM_CPU_POOL           pool_9f74a8e9-        DELETE           oda-admin        root             2020-10-08 12:26:30 UTC
d858269b-6c28-4bc2-af71-79004f3561e6  BM_CPU_POOL           pool_9f74a8e9-        CREATE           oda-admin        root             2020-10-08 12:24:36 UTC
9d7852c1-93fb-410e-9e0c-8c0a95ed3f0c  VM_CPU_POOL           pool_d48e81e4-        DELETE           oda-admin        root             2020-10-08 12:06:45 UTC
0235cc84-9345-40bc-ac4f-7de3f63202e2  VM_CPU_POOL           pool_4fe0b4f4-        DELETE           oda-admin        root             2020-10-08 12:06:45 UTC
762f7263-7bd9-4b12-b891-48305165bf36  VM_CPU_POOL           pool_4fe0b4f4-        MODIFY           oda-admin        root             2020-10-08 12:06:22 UTC
0bd2a25d-2327-4918-bd47-8c00f7406f92  VM_CPU_POOL           pool_4fe0b4f4-        MODIFY           

odacli describe-auditrecord

Use the odacli describe-auditrecord command to describe the audit record for a CPU Pool on Oracle Database Appliance Bare Metal or Kernel-based Virtual Machine (KVM) deployment.

Syntax

 odacli describe-auditrecord -i [-j] [-h]

Parameters

Parameter	Description
--id, -i	Describes the ID of the audit record.
--json, -j	(Optional) Displays output in JSON format.
--help, -h	(Optional) Displays help for using the command.

Example

# odacli describe-auditrecord -i 41295d99-f263-4284-b6d9-2aff1ae0f850
Audit Record details                                                            
--------------------------------------------------------------------------------
 Event details            
--------------------------
                Record ID:  41295d99-f263-4284-b6d9-2aff1ae0f850
         Record timestamp:  2020-10-08 13:27:05 UTC
             DCS username:  oda-admin
              OS username:  root
               Cluster ID:  test_cluster-c
                  Node ID:  test_cluster

 Resource/Operation       
--------------------------
            Resource type:  BM_CPU_POOL
              Resource ID:  b17cb623-bf79-491f-86d8-d8502987e26c
            Resource name:  testbmpool
           Operation type:  CREATE
    Operation description:  Created with '2' cores and allocation 'test_cluster:1-2,17-18'

odacli Database Commands

Use the odacli database commands to perform database lifecycle operations.

• odacli clone-database
  Use the odacli clone-database command to clone a new database from a source database.
• odacli create-database
  Use the odacli create-database command to create a new database.
• odacli delete-database
  Use the odacli delete-database command to delete a database.
• odacli describe-database
  Use the odacli describe-database command to display database details.
• odacli list-databases
  Use the odacli list-databases command to list all databases on the appliance.
• odacli modify-database
  Use the odacli modify-database command to modify the configuration of a database, such as backup configuration, database class, and database type, and to change TDE wallet management from EXTERNAL to ODA.
• odacli move-database
  Use the command odacli move-database to move a database from one Oracle home to another home of the same database version.
• odacli register-database
  Use the odacli register-database command to register a migrated database with the appliance.
• odacli upgrade-database
  You can use the odacli upgrade-database command to upgrade a database from a supported release.

odacli clone-database

Use the odacli clone-database command to clone a new database from a source database.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli clone-database [-u] [-n] [-s] [-t] [-j] [-f] [-nn] [-p] [-h] [-sh|-no-sh] [-cp]

Parameters

Parameter	Description
--databaseUniqueName, -u	Defines a unique name for the database.
--dbname, -n	Defines the name given to the new database (dbname.)
--dbshape, -s	(Optional) Identifies the database shape (template) and determines the total memory allocated to the database. For example, odb1 and odb2. The default is odb1.
--dbtype, -t [RAC|RACOne|SI]	(Optional) Defines the database type. The default database type is the source database type, if the option is not specified. For high-availability deployments, the values can be RAC|RACOne|SI, with the default as RAC. For single-node deployments, the value is SI.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.
--sourcedbname, -f	Specifies the name of the source database
--associated-networks, -nn	(Optional) Specifies the associated network names (in the format networkName1,networkName2,...).
--disable-seha, -no-sh	(Optional) Specifies whether you want to disable Standard Edition High-Availability for Oracle Database Standard Edition 19c and later single-instance databases.
--enable-seha, -sh	(Optional) Specifies whether you want to enable Standard Edition High-Availability for Oracle Database Standard Edition 19c and later single-instance databases.
--cpupool, -cp	(Optional) Specifies the CPU pool name.
--tdepassword, -p	(Optional) Specifies the TDE password of the source database.

Usage Notes

• The source database must be up and running.

• The source database must use Oracle ACFS storage.

• The source database must not be a multitenant container database (CDB)

• If -cp parameter is provided as part of the command, cloned database is associated with the particular CPU pool.
• If -cp parameter is not provided as part of the command, and if the parent database has an associated CPU pool, then the cloned database is also associated with the same CPU pool as that of parent database.
• If -cp parameter is not provided as part of the command, and if the parent database does not have any associated CPU pool, then the cloned database is also not associated with any CPU pool.

Example 16-127 Cloning a Database

The following example creates a clone database snap1 from source database acfsdb1.

# /opt/oracle/dcs/bin/odacli clone-database -n snap1 -u snap1u -f acfsdb1

Example 16-128 Cloning a Database and associating it with the same CPU Pool as the parent database

# odacli clone-database -f dbcpupin -n dbclone -u dbcloneUnique
Enter new 'SYS user' password: 
Confirm 'SYS user' password: 
{
  "jobId" : "74a80586-3523-4367-93a0-38401647c5a0",
  "status" : "Created",
  "message" : null,
  "reports" : [ ],
  "createTimestamp" : "August 09, 2020 10:25:40 AM UTC",
  "resourceList" : [ ],
  "description" : "Snap Database service creation with db name: dbclone",
  "updatedTime" : "August 09, 2020 10:25:40 AM UTC"
}

Example 16-129 Cloning a Database and associating it with a different CPU Pool

# odacli clone-database -f dbcpupin -n db1clone -u db1cloneUnique -cp testdbcpupool2
Enter new 'SYS user' password: 
Confirm 'SYS user' password: 
{
  "jobId" : "2fe285b5-2e3b-4e80-9121-e7c8380952b3",
  "status" : "Created",
  "message" : null,
  "reports" : [ ],
  "createTimestamp" : "August 09, 2020 10:36:55 AM UTC",
  "resourceList" : [ ],
  "description" : "Snap Database service creation with db name: db1clone",
  "updatedTime" : "August 09, 2020 10:36:55 AM UTC"
}

Example 16-130 Cloning a TDE-Enabled Database

# odacli clone-database --sourcedbname tdbacf2 --dbname tdbacf2c --databaseUniqueName tdacf2cu -p
Enter SYS user password:
Retype SYS user password:
Enter TDE wallet password of source database: 

odacli create-database

Use the odacli create-database command to create a new database.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli create-database -n database_name -cs characterset -cl {OLTP|DSS|IMDB}
-l dblanguage -s dbshape -r {ACFS|ASM} -dt dbterritory 
-y dbtype -ns nationalscharacterset -d pdbadmin -p pdbname -v version 
[-u databaseUniqueName] [-dh Database Home ID] [-c|-no-c] [-co|-no-co]
[-bi backupconfigid] [-io] [-dn] [-j] [-nn] [-h] [-rd] [-sh|-no-sh] [-t] [-cp]

Parameters

Parameter	Description
--backupconfigid, -bi	(Optional) Defines the backup configuration identifier for future use.
--cdb, -c	(Optional) Creates the database as a container database. Use the -c flag to create a container database and use the -no-c flag to create a non-CDB database. The default is -no-c.
--characterset, -cs	Defines the character set. The default is AL32UTF8.
--databaseUniqueName, -u	(Optional) Defines a unique name for the database.
--dbdomainname, -dn	Defines the database domain name.
--cpupool, -cp	Defines the CPU pool name. The CPU pool must be of type bare metal (BM).
--dbEdition, -de	Defines the Database Edition.
--dbclass, -cl {OLTP|DSS|IMDB}	Defines the database class. The default is OLTP. The options are as follows: Enterprise Edition: OLTP, DSS, or IMDB. Standard Edition: OLTP
--dbconsole, -co	(Optional) Enables the Database Console. Use the -no-co flag to disable the Database Console. If not selected, the default is no database console.
--dbhomeid, -dh	(Optional) Identifies the existing Database Home ID.
--dblanguage, -l	Defines the database language. The default language is AMERICAN.
--dbname, -n	Defines the name given to the new database (dbname.)
--dbshape, -s	Identifies the database shape (template) and determines the total memory allocated to the database. For example, odb1 and odb2. The default is odb1. You cannot specify the database shape when you create a instance-only database.
--dbstorage, -r{ACFS|ASM}	Defines the Database Storage, either Oracle ACFS or Oracle ASM. The default value is Oracle ASM.
--dbterritory, -dt	Defines the database territory. The default territory is AMERICA.
--dbtype, -y [RAC|RACOne|SI]	Defines the database type. For high-availability deployments, the values can be RAC|RACOne|SI, with the default as RAC. For single-node deployments, the value is SI.
--help, -h	(Optional) Displays help for using the command.
--instanceonly, -io	(Optional) Creates a database instance, password file and also the underlying Oracle ACFS mount point. You can use the instance as an auxiliary instance for RMAN duplicate.
--json, -j	(Optional) Displays JSON output.
--nationalscharacterset, -ns	Defines the NLS National Character Set. The default is AL16UTF16.
--no-cdb, -no-c	(Optional) Creates a database that is not a container database. Use this flag when you want to create a non-CDB database. Use the -c flag to create a container database.
--no-dbconsole, -no-co	(Optional) Disables Database Console. Use the -co flag to enable Database Console.
--pdbadmin, -d	Defines the Pluggable Database (PDB) Admin User.
--pdbname, -p	Defines the Pluggable Database (PDB) name. The default value is pdb1.
--version, -v	Defines the database bundle patch number. To install the latest bundle patch for a release, specify the release version. To specify a specific supported bundle, use the 5 digit format.
--dbRedundancy, -rd	Specifies the database redundancy value, that is, {HIGH|MIRROR}. To specify the dbRedundancy option for an Oracle ASM or ACFS storage-based database, all disk groups must have FLEX redundancy. To specify the dbRedundancy option for an Oracle ASM storage database, the dbVersion or dbHomeVersion must be 12.2 or later.
--associated-networks, -nn	Specifies the associated network names (in the format networkName1,networkName2,...).
--enable-tde, -t	Specifies whether to enable Transparent Data Encryption (TDE) which uses Software Keystore.
--disable-seha, -no-sh	Specifies whether you want to disable Standard Edition High-Availability for Oracle Database Standard Edition 19c and later single-instance databases.
--enable-seha, -sh	Specifies whether you want to enable Standard Edition High-Availability for Oracle Database Standard Edition 19c and later single-instance databases.
--targethost, -th	(Optional) Specifies the target host name (applicable only for Oracle RAC One Node Database and single-instance Oracle Database, where supported).
--targetnode, -g	(Optional) Specifies the target node number (applicable only for Oracle RAC One Node Database and single-instance Oracle Database, where supported). The values are 0 or 1.
--levelzerobackupday, -lb	(Optional) Specifies the level zero backup day. The values can be Monday|Tuesday|Wednesday...|Sunday. The default is Sunday.
--backupconfigname, -bn	(Optional) Specifies the name of the backup configuration.
--bkuppassword, -bp	(Optional) Specifies the RMAN backup encryption password.
--enableFlashCache, -fc	(Optional) Specifies whether to enable Flash Cache.
--no-enableFlashCache, -no-fc	(Optional) Specifies whether to disable Flash Cache.
--dbOnFlashStorage, -f	(Optional) Specifies whether to enable data on Flash storage.
--no-dbOnFlashStorage, -no-f	(Optional) Specifies whether to disable data on Flash storage.

Usage Notes

• If the disk group redundancy is FLEX, then the default dbRedundancy value is MIRROR.

• Flash cache is disabled by default.

• You cannot mix Oracle Database Standard Edition and Enterprise Edition databases on the same appliance.

• For Standard Edition Oracle Database 19c or later, you cannot create Oracle RAC Or Oracle RAC One Node Database. For Standard Edition, you can only deploy single-instance Oracle Database with or without high-availability enabled.
• Transparent Data Encryption (TDE) is an Advanced Security Option (ASO) available with Oracle Database Enterprise Edition.
• TDE is not configured by default during database creation.
• The dbname and databaseUniqueName can contain underscores (-), lowercase and uppercase alphabet (a-zA-Z, and numeric characters (0-9), must start with an alphabet, and must not exceed 8 characters in length. The dbname and databaseUniqueName must not also be an Oracle reserved key word.

• Use the --cdb or --no-cdb flag to indicate whether or not the database is a container database. When neither flag is specified, the default database created is a non-CDB database.

• When --dbhomeid is not provided, the create-database command creates a new Oracle Database Home.

• When --dbhomeid is provided, the create-database command creates the database using the existing Oracle Home. Use the odacli list-dbhomes command to obtain the dbhomeid.

• When you use the command to create an instance-only database, then you cannot specify the database shape (template).

• When you specify both the --version and the--dbhomeid, the version is ignored and the database is created against the existing database home.

• Oracle Database 12.1 or later is supported on both Oracle Automatic Storage Management (Oracle ASM) and Oracle ASM Cluster file system (ACFS). The default is Oracle ASM.

• When databases are created in Oracle ACFS, each database is configured with its own Oracle ACFS file system for the datafiles and uses the following naming convention: /u02/app/db user/oradata/db unique name. The default size of this mount point is 100 GB.

  Note:

  Oracle recommends not sharing the mount point across different databases.

• Online logs are stored in the /u03/app/db user/redo/ directory.

• Oracle Fast Recovery Area (FRA) is located in the /u03/app/db user/fast_recovery_area directory.

• For the version, you can specify the database version, for example, 19.11.0.0, 18.8.0.0, 12.2.0.1, or12.1.0.2, or you can use a 5 digit format to specify a specific patch bundle version. If you use the database version without specifying the bundle patch number, the latest bundle patch is used.

Caution:

When you create a database with Transparent Data Encryption (TDE) enabled, you are prompted to set a password for the TDE wallet. Provide a strong password for security compliance. Set the password carefully, and ensure that this password is available to you at all times for database management operations. Failure to provide the TDE wallet password when prompted, will cause an error in accessing encrypted data.

Example 16-131 Creating a TDE-enabled database

# odacli create-database -n test -t
Enter new 'SYS, SYSTEM and PDB Admin user' password: 
Confirm 'SYS, SYSTEM and PDB Admin user' password: 
Enter new 'TDE wallet' password: 
Confirm 'TDE wallet' password:

Example 16-132 Creating a Database in Interactive Mode

This example creates a 19.14.0.0.0 OLTP container database named hrdb with shape odb2 and enables you to provide the password interactively.

# odacli create-database -n hrdb -c -cl OLTP -s odb2 -p pdb1 

Enter new 'SYS, SYSTEM and PDB Admin user' password: 
Confirm 'SYS, SYSTEM and PDB Admin user' password: 
{
   "jobId" : "f12485f2-dcbe-4ddf-aee1-de24d37037b6",
   "status" : "Created",
   "message" : null,
   "reports" : [ ],
   "createTimestamp" : "December 8, 2021 03:54:03 AM EDT",
   "description" : "Database service creation with db name: hrdb",
   "updatedTime" : "December 8, 2021 03:54:03 AM EDT" 
}

Example 16-133 Creating a Database Against a Different Version

Either of the following statements creates a database against a home with Oracle Database Bundle applied:

# odacli create-database -n hrmsdb1 -v 19.14.0.0.0       
# odacli create-database -n hrmsdb2 -v 19.14.0.0.220118  

The following statement creates a new database against a home with a specific Oracle Database Bundle:

# odacli create-database -n hrmsdb3 -v 19.14.0.0.220118 

Example 16-134 Creating a Database associated with a CPU Pool

The following command creates a new database associated with a CPU pool:

# odacli create-database -j -n dbcpupl -r ACFS -cp testdbcpupool

odacli delete-database

Use the odacli delete-database command to delete a database.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To delete a database:

odacli delete-database -i dbid  [-ea] [-h] [-j] [-fd]

Parameters

Parameter	Description
--dbid, -i	Identifies the database home identifier (ID) to display. Use the odacli list-databases command to obtain the --dbid.
--force, -fd	(Optional) Forces the delete operation.
--eraseAll, -ea	(Optional) Removes all files.
--help, -h	(Optional) Displays help for using the command.
--json, -j	(Optional) Displays JSON output.

Usage

Note:

The odacli delete-database command deletes the database, the file system, and the underlying advm volumes assigned to the database. For example, deleting a database named hrdb also deletes the file system /u02/app/oracle/oradata/hrdb. Do not keep any other files on this database file location. If you have manually added static entries for the database you want to delete in your listener.ora file, then remove these entries before running the odacli delete-database command.

Example 16-135 Deleting a Database Named hrmsdb

In this example we want to delete a database named hrmsdb. Before we can delete the database, we need to know the database home identifier (dbid). This example shows how to run the odacli list-databases command to list the databases and their associated dbid, then how to delete database hrmsdb.

# odacli list-databases   

ID                                     DB Name  DB Version   CDB  Class 	
-------------------------------------  -------	----------   ----  ----- 	
a3f4a6c0-a0c9-4c79-bad7-898afcf9de46   hrmsdb  12.1.0.2      true   OLTP
7e28bf52-1a09-49fd-9391-841838d2c42f   crmdb   12.1.0.2      false  OLTP

(continued)
Shape 	Storage  Status 
------  ------   ---------- 
odb1 	ACFS 	 Configured
odb1 	ACFS 	 Configured

# odacli delete-database -i a3f4a6c0-a0c9-4c79-bad7-898afcf9de46

odacli describe-database

Use the odacli describe-database command to display database details.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

To display database details:

   odacli describe-database -i dbid [-h] [-j]

Parameters

Parameter	Description
--dbid, -i	Identifies the database home identifier (ID) to display. Use the odacli list-databases command to obtain the dbid.
--json, -j	(Optional) Displays JSON output.
--help, -h	(Optional) Displays help for using the command.

Example 16-136

Display information for a database.

# odacli describe-database -i odacn

Database details                                                  
---------------------------------------------------------------- 
                     ID: 896238139
            Description: odacn
                DB Name: odacn
             DB Version: 19.6.0.0.200114
                DB Type: Si
                DB Role: PRIMARY
    DB Target Node Name: node1
             DB Edition: EE
                   DBID: 896238139
 Instance Only Database: false
                    CDB: false
               PDB Name: 
    PDB Admin User Name: 
           SEHA Enabled: false
                  Class: Oltp
                  Shape: Odb1
                Storage: Asm
          DB Redundancy: MIRROR
           CharacterSet: AL32UTF8
  National CharacterSet: AL16UTF16
               Language: AMERICAN
              Territory: AMERICA
                Home ID: bcc3991a-0ffc-4d29-86ae-40f2b8721dc4
        Console Enabled: false
     Level 0 Backup Day: Sunday
     AutoBackup Enabled: true
                Created: March 30, 2020 9:33:09 AM PDT
         DB Domain Name: domain.com
    Associated Networks: Public-network

Example 16-137 Displaying Database Details

Display information for database named ac48e0d2-a7b0-4ffd-a27e-f8e42b028c5f :

# odacli describe-database -i ac48e0d2-a7b0-4ffd-a27e-f8e42b028c5f

Database details                                                   
----------------------------------------------------------------
ID: ac48e0d2-a7b0-4ffd-a27e-f8e42b028c5f
Description: rdb1
DB Name: rdb1
DB Version: 19.14.0.0.0
DBID: 1339792271
CDB: true
PDB Name: r1pdb1
PDB Admin User Name: pdbadmin
Class: OLTP
Shape: odb2
Storage: ASM
CharacterSet: DbCharacterSet(characterSet=AL32UTF8, nlsCharacterset=AL16UTF16, dbTerritory=AMERICA, dbLanguage=AMERICAN)
Home ID: fe87f30c-b810-45d1-8b96-13996ad7a255
Console Enabled: true
Created: December 8, 2021, 2016 6:21:14 PM

odacli list-databases

Use the odacli list-databases command to list all databases on the appliance.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odacli

Syntax

To display a list of all databases:

 odacli list-databases [-h]

Parameters