1. X11 Deployment and User’s Guide
  2. Oracle Database Appliance Command-Line Interface

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.

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, disk groups, 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.

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 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

Parent topic: Oracle Database Appliance Command-Line Interface

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-1 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
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-2 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.

Parent topic: Oracle Database Appliance Command-Line Interface

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

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

About the odacli-view command

In a multi-user access-enabled environment, to run automated scripts, that is, to generate a system report based on the output of odacli commands, you may need to provide the user credentials when prompted by the system. In such cases, the automation of scripts may fail. In such cases, use the odacli-view command instead of the odacli command. The odacli-view command allows you to run read-only odacli commands as root user without providing user credentials. Read-only odacli commands include commands to list, describe, get, read, or ping.

However, the security of the system is not compromised because the user credentials of a securely-generated internal user are used for this purpose. The odacli-view command can be used in Oracle Database Appliance deployments with or without multi-user access. In an Oracle Database Appliance environment where multi-user access is not enabled, odacli-view has the same functionality as odacli. In a multi-user access-enabled environment, odacli-view provides the information about all the resources in a system. For example, odacli-view list-databases command lists all the databases in the system.

Usage:
/opt/oracle/dcs/bin/odacli-view command_name
For example:
/opt/oracle/dcs/bin/odacli-view list-dbhomes
/opt/oracle/dcs/bin/odacli-view list-databases
/opt/oracle/dcs/bin/odacli-view list-users

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 modify-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 modify-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 modify-backupconfig ODA-ADMINISTRATOR, ODA-DB Must have primary or shared access
odacli modify-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 modify-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 update-database ODA-ADMINISTRATOR, ODA-DB User must have primary or shared access to the source database (the database being updated) 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 modify-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 modify-asr ODA-ADMINISTRATOR No change
odacli list-osconfigurations ODA-ADMINISTRATOR No change
odacli modify-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

Parent topic: Oracle Database Appliance Command-Line Interface

odacli Network Commands

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

Parent topic: Oracle Database Appliance Command-Line Interface

odacli configure-firstnet

Use the command odacli 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.

  • You can choose to enable Link Aggregation Control Protocol (LACP) on the bonding interface when you run odacli configure-firstnet.
  • You can use the -o option with the odacli configure-firstnet command to configure the network speed for Oracle Dual Port 25 Gb Ethernet Adapter.

  • You can also use the -o option with the odacli configure-firstnet command to enable or disable LACP on a bonding interface after deployment.

    Enabling LACP on a bonding interface after deployment:
    # odacli configure-firstnet -o
INFO: Configure network option
Select the Interface to configure the network on (btbond1 btbond3 btbond5) [btbond1]:btbond3
Use LACP bonding on btbond3 (yes/no) [no]: yes
INFO: network interface [btbond3] setup in LACP mode
    Disabling LACP on a bonding interface after deployment:
    # odacli configure-firstnet -o
INFO: Configure network option
Select the Interface to configure the network on (btbond1 btbond3 btbond5) [btbond1]:btbond3
Use LACP bonding on btbond3 (yes/no) [yes]: no
INFO: network interface [btbond3] setup in active-backup mode

Example 16-3 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-4 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 ]

Example 16-5 Configuring the Speed of the Network Interface

The following is an example of setting the speed of the network card manually.

# odacli configure-firstnet -o
INFO: Configure network option
Select the Interface to configure the network on (btbond1 btbond2 btbond3) [btbond1]:btbond3

Use LACP bonding on btbond3 (yes/no) [no]:
Set the network speed on btbond3 to 1) AUTO, 2) 1G, 3) 10G, 4) 25G [AUTO]: 3
INFO: The speed of the network port is set to '10G'
INFO: Please set the speed for the connected ports in the switch
INFO: stop the network 'btbond3'
INFO: start the network 'btbond3'
INFO: Network interface btbond3 (p2p1, p2p2) has been set to using speed '10G'

Parent topic: odacli Network Commands

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 name [-nn nodeName] [-lp listener_ports] [-sp scan_ports] [-f interface] [ -p ipaddress]  [-w {Public|Dataguard|Database|Management|Backup|Other}] [-s subnetmask] [-g gateway] [-h] [-sip] [-sn] [-vs] [-j]

Parameters

Parameter Description

--defaultnetwork, -d

(Optional) Identifies the default network.

--gateway, -g

(Optional) Defines the network gateway. The gateway is required for the default network.

--help, -h

(Optional) Displays help for using the command.

--interface, -f       

(Optional) Defines the name of the network interface.

--interfacetype, -t

(Optional) Defines the network interface type {BOND|PHYSICAL|VLAN|INTERNAL} (non case-sensitive).
--ipaddress, -p (Optional) Defines the network IP address. This can be specified in the format IPAddress or nodeNumber0:IPAddress0,nodeNumber1:IPAddress1,...

--listener-ports, -lp

(Optional) Specifies the comma-separated list of listener ports. The default value is 1521.

--scan-ports, -sp

(Optional) Specifies the comma-separated list of SCAN listener ports. The default value is 1521.

--json, -j

(Optional) Displays JSON output.

--networktype, -w

(Optional) Defines the type of network. Options are: {Public|Dataguard|Database|Management|Backup|Other}. The default is Other.
--name, -n (Mandatory) Name of the network.

--no-defaultnetwork, no–d

(Optional) Identifies a network as not the default network. Use --defaultnetwork -d to identify a default network.

--subnetmask, -s

(Optional) Defines the Network Subnet Mask.
--scanips, -sip (Optional) Defines the SCAN IP addresses (in the format scanip0,scanip1,...)
--scanname, -sn (Optional) Defines the SCAN name.
--nodeName, -nn (Optional) Defines the node name for High-Availability deployments.
--vips, -vs (Optional) List of virtual IP addresses. They can be specified in the format vipname0:nodeNumber0:vip0,vipname1:nodenumber1:vip1,...

--vlanid, -v

(Optional) 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-6 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 network1 -f sfpbond1 -p 192.0.2.15 -w Backup -s 255.255.255.0 -no-d

Example 16-7 Creating a VLAN Network

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

Parent topic: odacli Network Commands

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 [-n] [-h] [-j]

Parameters

Parameter Description

--id, -i

Defines the network identity.
--name, -n 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-8 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, 2024 23:14:32 PM EDT",
     "endTime" : "December 8, 2024 23:14:32 PM EDT",
     "status" : "Running",
     "taskDescription" : null,
     "parentTaskId" : "TaskSequential_135",
     "jobId" : "c26d217e-419b-4a91-8680-7b06bcfe9828",
     "tags" : [ ],
     "reportLevel" : "Info",
     "updatedTime" : "December 8, 2024 23:14:32 PM EDT"
   },{     
   "taskId" : "TaskZJsonRpcExt_142",
     "taskName" : "Setting up Network",
     "taskResult" : "Network setup success",
     "startTime" : "December 8, 2024 23:14:32 PM EDT",
     "endTime" : "December 8, 2024 23:14:32 PM EDT",
     "status" : "Success",
     "taskDescription" : null,
     "parentTaskId" : "TaskParallel_141",
     "jobId" : "c26d217e-419b-4a91-8680-7b06bcfe9828",
     "tags" : [ ],
     "reportLevel" : "Info",
     "updatedTime" : "December 8, 2024 23:14:32 PM EDT"   } ],
   "createTimestamp" : "December 8, 2024 23:14:32 PM EDT",
   "description" : "Network service delete",
   "updatedTime" : "December 8, 2024 23:14:32 PM EDT"
 }

Parent topic: odacli Network Commands

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 [-i id] [-n name] [-h] [-j]

Parameters

Parameter Description

--id, -i

Defines the network interface ID.

--name, -n

Defines the network interface name.

--help, -h

(Optional) Displays help for using the command.

--json, -j

  (Optional) Displays JSON output.

Usage Notes

You cannot delete the network interface card in slot 7.

Example 16-9 Deleting a Network Interface

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

Example 16-10 Deleting btbond1 Network Interface is Not Allowed

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

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

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

Parent topic: odacli Network Commands

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] [-nn node_name] [-n name] [-j][-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, -n Specifies the network name.

--node-name, -nn

(Optional) Displays the network interface information for the specified node name.

Example 16-12 Displaying Network Details

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

# odacli describe-network -n 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, 2023 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:  oda1-scan
               Scan Ips:  10.31.117.64 10.31.117.65
                   Vips:  [oda1-vip on node0: 10.31.116.61, oda2-vip on node1: 10.31.116.63]
   Associated Databases: odacn db122a db122b db122c db122d

Example 16-13 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 -nn oda1

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, 2023 10:54:16 PM PST

Parent topic: odacli Network Commands

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 -n name [-nn node_name] [-j][-h]

Parameters

Parameter Description

--id, -i

Identifies the network interface ID. Use the odacli list-networks command to obtain the id.

--name, -n Specifies the network interface name.

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--node-name, -nn

(Optional) Displays the network interface information for the specified node name.

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 name option (-nn).

Example 16-14 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 -nn oda1 

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

Parent topic: odacli Network Commands

odacli list-networks

Use the odacli list-networks command to display networks.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--node-name, -nn

(Optional) Displays the network interface information for the specified node name.

Example 16-15 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]

Parent topic: odacli Network Commands

odacli list-networkinterfaces

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-networkinterfaces [-nn node_name] [-j] [-h]

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--node-name, -nn

(Optional) Displays the network interface information for the specified node name.

Example 16-16 Displaying a List of Network Interfaces

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

# odacli list-networkinterfaces -nn oda1
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

Parent topic: odacli Network Commands

odacli modify-network

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To update a network:

odacli  modify-network -i id -n name [-p IP address] [-lp listener_ports] [-sp scan_ports] [-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.

--name, -n

Defines the network name.

--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,...

--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.

--listener-ports, -lp

(Optional) Specifies the comma-separated list of listener ports. The default value is 1521.

--scan-ports, -sp

(Optional) Specifies the comma-separated list of SCAN listener ports. The default value is 1521.

--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.

--json, -j

(Optional) Displays JSON output.

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-17 Modifying a Network

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

# odacli modify-network -i 192.0.0.2 -w Backup

Parent topic: odacli Network Commands

odacli Multi-User Access Commands

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

Note:

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.

Parent topic: Oracle Database Appliance Command-Line Interface

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-18 

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

Parent topic: odacli Multi-User Access Commands

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-19 

# 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

Parent topic: odacli Multi-User Access Commands

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-20 

[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

Parent topic: odacli Multi-User Access Commands

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-21 

[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

Parent topic: odacli Multi-User Access Commands

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-22 

[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, 2023 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, 2023 7:01:54 AM UTC
                Message:

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

Parent topic: odacli Multi-User Access Commands

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-23 

[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.

Parent topic: odacli Multi-User Access Commands

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-24 

[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

Parent topic: odacli Multi-User Access Commands

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-25 

[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

Parent topic: odacli Multi-User Access Commands

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-26 

[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.

Parent topic: odacli Multi-User Access Commands

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-27 

[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
---------------------------------------- ----------------------------------- ----------------------------------- ----------

Parent topic: odacli Multi-User Access Commands

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-28 

[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

Parent topic: odacli Multi-User Access Commands

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-29 

[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

Parent topic: odacli Multi-User Access Commands

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-30 

[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
...

Parent topic: odacli Multi-User Access Commands

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-31 

[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

Parent topic: odacli Multi-User Access Commands

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-32 

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

Operation Name           Operation Description      Is Active
----------------------------------- ----------------------------------------------------------------------------------------------- ----------
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

Parent topic: odacli Multi-User Access Commands

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-33 

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

Parent topic: odacli Multi-User Access Commands

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-34 

[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

Parent topic: odacli Multi-User Access Commands

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-35 

[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

Parent topic: odacli Multi-User Access Commands

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-36 

[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

Parent topic: odacli Multi-User Access Commands

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-37 

[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

Parent topic: odacli Multi-User Access Commands

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-38 

[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...

Parent topic: odacli Multi-User Access Commands

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-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...

Parent topic: odacli Multi-User Access Commands

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 modify-agentconfig-parameters
    Use the odacli modify-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-database
    Use the odacli update-database command to update a database to a specific database home with later version, and within the same major release.
  • 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 for DCS components 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, CLI, and controller.
  • odacli update-registry
    Use the odacli update-registry command to update the metadata for the components that are already present in the registry. For database home and grid home, this command updates the patch information, 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.
  • odacli update-server-postcheck
    Use the odacli update-server-postcheck command to perform deployment health checks after upgrading the oeprating system from Oracle Linux 6 to Oracle Linux 7.
  • odaadmcli orachk
    Use the odaadmcli orachk command to check configuration settings for Oracle Database Appliance components.

Parent topic: Oracle Database Appliance Command-Line Interface

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 [-nn node_name] [-cl clones] [-v version [-comp component] [-l local]

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-name, -nn

(Optional) Cleans up the repository on the specified node names.

--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-40 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, 2024 06:44:28 AM UTC",
"resourceList" : ,
"description" : "Cleanup patchrepos",
"updatedTime" : "April 17, 2024 06:44:28 AM UTC"

Example 16-41 Deleting Clone Files

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

Parent topic: odacli Apply Patch and Update Commands

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 [-db] [-dbid database_id] [-dp] [-d][-i dbhome_id] [-f files] [-l] [-nn node_name] [-os] [-r] [-s] [-sko] [-st] [-to dest_db_home_id] [-v version] [-j] [-h]

Parameters

Parameter Description
--database, –db

(Optional) Specifies the database component for running the pre-checks. This option cannot be used with the -dp and -d options.

--databaseid, –dbid

(Optional) Specifies the ID of the database to be updated and for which you want to run the pre-checks.
--datapatch, –dp

(Optional) Specifies the datapatch component for running the pre-checks. This option cannot be used with the -db and -d options.

--dbhome, –d

(Optional) Specifies the database home component for running the pre-checks. This option cannot be used with the -dp and -db options.

--dbhomeid, –i

(Optional) Specifies the IDs of the database homes to be updated and for which you want to run the pre-checks.

--files, -f

(Optional) Specifies files required to update repository, comma-separated if multiple files are required.
--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-name, –nn

(Optional) Runs patch pre-checks on specified node names.

--local, –l

(Optional) Runs patch pre-checks on local node only.
--operating-system, –os

(Optional) Specify this option to run the patch pre-checks for the operating system components.
--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.

--to-home, -to

(Optional) Specifies the destination Oracle Database Home on the target database for the update. Note that you must use this option with the -db option.

--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output. The default is false.

Usage Notes

Use the odacli create-prepatchreport command to generate a pre-check report. Use the --node or --local option to run the patch pre-checks on specific nodes or the local node.

Example 16-42 Creating Pre-Check Report

# odacli create-prepatchreport -v 19.26.0.0.0 -s

Job details 
----------------------------------------------------------------
                     ID: e07993d5-0a06-44e7-819a-36d708c52bb6
            Description: Patch pre-checks for [OS, ILOM, GI, ORACHKSERVER]
                 Status: Created
                Created: September 20, 2023 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   
---------------------------------------- ----------------------------------- -----------------------------

Example 16-43 Creating Pre-Check Report for Updating Database and Applying Datapatch

# odacli describe-prepatchreport -i efa93519-a365-4e9a-9f25-ad3c653cccef

Patch pre-check report
------------------------------------------------------------------------
                 Job ID: efa93519-a365-4e9a-9f25-ad3c653cccef
            Description: Patch pre-checks for [SINGLEDB, ORACHKSINGLEDB]: Target DB is db10181, Destination DbHome is OraDB19000_home8
                 Status: SUCCESS
                Created: October 18, 2023 11:19:03 AM PDT
                 Result: All pre-checks succeeded

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

Pre-Check Status Comments
------------------------------ -------- --------------------------------------
__SINGLEDB__
Is system provisioned Success Verified system is provisioned
Validate dbHomesOnACFS Success User has configured disk group for
configured Database homes on ACFS
Validate Oracle base Success Successfully validated Oracle Base
Evaluate DB clone availability Success Successfully validated clone file
                                          exists
Evaluate DB patching with RHP Success Successfully validated patching DB
                                          with RHP.
Validate command execution Success Validated command execution

__ORACHK__
Running orachk Success Successfully ran Orachk
Validate command execution Success Validated command execution
wandli: Node Name
---------------
node2

Pre-Check Status Comments
------------------------------ -------- --------------------------------------
__SINGLEDB__
Is system provisioned Success Verified system is provisioned
Validate dbHomesOnACFS Success User has configured disk group for
configured Database homes on ACFS
Validate Oracle base Success Successfully validated Oracle Base
Evaluate DB clone availability Success Successfully validated clone file
                                          exists
Evaluate DB patching with RHP Success Successfully validated patching DB
                                          with RHP.
Validate command execution Success Validated command execution

__ORACHK__
Running orachk Success Successfully ran Orachk
Validate command execution Success Validated command execution
wandli: example for applying datapatch,

[root@oda1 ~]# odacli describe-prepatchreport -i 2cdb0b6e-ce24-4857-86ab-91480a2ac4e8

Patch pre-check report
------------------------------------------------------------------------
                 Job ID: 2cdb0b6e-ce24-4857-86ab-91480a2ac4e8
            Description: Patch pre-checks for [SINGLEDB, ORACHKSINGLEDB]:
Target DB is season, Destination DbHome is OraDB19000_home6
                 Status: SUCCESS
                Created: September 16, 2023 10:38:58 PM UTC
                 Result: All pre-checks succeeded

Node Name
---------------
oda1

Pre-Check Status Comments
------------------------------ -------- --------------------------------------
__SINGLEDB__
Is system provisioned Success Verified system is provisioned
Validate dbHomesOnACFS Success User has configured disk group for
configured Database homes on ACFS
Validate Oracle base Success Successfully validated Oracle Base
Evaluate DB clone availability Success Successfully validated clone file
                                          exists
Evaluate DB patching with RHP Success Successfully validated patching DB
                                          with RHP.
Validate command execution Success Validated command execution

__ORACHK__
Running orachk Success Successfully ran Orachk
Validate command execution Success Validated command execution

Parent topic: odacli Apply Patch and Update Commands

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

/opt/oracle/dcs/bin/odacli

Syntax

odacli describe-prepatchreport -i ID [-j] [-h]

Parameters

Parameter Description
--id, -i

Specifies the Job ID for the pre-check report.

--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output. The default is false.

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

[root@oda1 opt]# odacli describe-prepatchreport -i 20d59005-f7f1-421d-bbb1-bfc4b5a26293
Patch pre-check report                                           
------------------------------------------------------------------------
                 Job ID:  20d59005-f7f1-421d-bbb1-bfc4b5a26293
            Description:  Patch pre-checks for [OS, ILOM, GI, ORACHKSERVER, SERVER]
                 Status:  SUCCESS
                Created:  May 13, 2022 7:31:24 AM HKT
                 Result:  All pre-checks succeeded

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

Pre-Check                      Status   Comments                              
------------------------------ -------- -------------------------------------- 
__OS__ 
Validate supported versions     Success   Validated minimum supported versions. 
Validate patching tag           Success   Validated patching tag: 19.15.0.0.0.  
Is patch location available     Success   Patch location is available.          
Verify OS patch                 Success   Verified OS patch                     
Validate command execution      Success   Validated command execution           

__ILOM__ 
Validate ILOM server reachable  Success   Successfully connected with ILOM      
                                          server using public IP and USB        
                                          interconnect                          
Validate supported versions     Success   Validated minimum supported versions. 
Validate patching tag           Success   Validated patching tag: 19.15.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       
Validate command execution      Success   Validated command execution           

__GI__ 
Validate GI metadata            Success   Successfully validated GI metadata    
Validate supported GI versions  Success   Validated minimum supported versions. 
Validate available space        Success   Validated free space under /u01       
Is clusterware running          Success   Clusterware is running                
Validate patching tag           Success   Validated patching tag: 19.15.0.0.0.  
Is system provisioned           Success   Verified system is provisioned        
Validate ASM in online          Success   ASM is online                         
Validate kernel log level       Success   Successfully validated the OS log     
                                          level                                 
Validate minimum agent version  Success   GI patching enabled in current        
                                          DCSAGENT version                      
Validate Central Inventory      Success   oraInventory validation passed        
Validate patching locks         Success   Validated patching locks              
Validate clones location exist  Success   Validated clones location             
Validate DB start dependencies  Success   DBs START dependency check passed     
Validate DB stop dependencies   Success   DBs STOP dependency check passed      
Evaluate GI patching            Success   Successfully validated GI patching    
Validate command execution      Success   Validated command execution           

__ORACHK__ 
Running orachk                  Success   Successfully ran Orachk               
Validate command execution      Success   Validated command execution           

__SERVER__ 
Validate local patching         Alert     Rolling patching is not possible: in  
                                          IB enabled environments               
Validate command execution      Success   Validated command execution           

Node Name       
---------------
node2 

Pre-Check                      Status   Comments                              
------------------------------ -------- -------------------------------------- 
__OS__ 
Validate supported versions     Success   Validated minimum supported versions. 
Validate patching tag           Success   Validated patching tag: 19.15.0.0.0.  
Is patch location available     Success   Patch location is available.          
Verify OS patch                 Success   Verified OS patch                     
Validate command execution      Success   Validated command execution           

__ILOM__ 
Validate ILOM server reachable  Success   Successfully connected with ILOM      
                                          server using public IP and USB        
                                          interconnect                          
Validate supported versions     Success   Validated minimum supported versions. 
Validate patching tag           Success   Validated patching tag: 19.15.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       
Validate command execution      Success   Validated command execution           

__GI__ 
Validate GI metadata            Success   Successfully validated GI metadata    
Validate supported GI versions  Success   Validated minimum supported versions. 
Validate available space        Success   Validated free space under /u01       
Is clusterware running          Success   Clusterware is running                
Validate patching tag           Success   Validated patching tag: 19.15.0.0.0.  
Is system provisioned           Success   Verified system is provisioned        
Validate ASM in online          Success   ASM is online                         
Validate kernel log level       Success   Successfully validated the OS log     
                                          level                                 
Validate minimum agent version  Success   GI patching enabled in current        
                                          DCSAGENT version                      
Validate Central Inventory      Success   oraInventory validation passed        
Validate patching locks         Success   Validated patching locks              
Validate clones location exist  Success   Validated clones location             
Validate DB start dependencies  Success   DBs START dependency check passed     
Validate DB stop dependencies   Success   DBs STOP dependency check passed      
Evaluate GI patching            Success   Successfully validated GI patching    
Validate command execution      Success   Validated command execution           

__ORACHK__ 
Running orachk                  Success   Successfully ran Orachk               
Validate command execution      Success   Validated command execution           

__SERVER__ 
Validate local patching         Alert     Rolling patching is not possible: in  
                                          IB enabled environments               
Validate command execution      Success   Validated command execution

Example 16-47 Pre-checks report for storage

# odacli describe-prepatchreport -i 95887f92-7be7-4865-a311-54318ab385f2

Patch pre-check report                                           
------------------------------------------------------------------------
                 Job ID:  95887f92-7be7-4865-a311-54318ab385f2
            Description:  Patch pre-checks for [STORAGE]
                 Status:  SUCCESS
                Created:  May 13, 2022 12:52:37 PM HKT
                 Result:  All pre-checks succeeded

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

Pre-Check                      Status   Comments                              
------------------------------ -------- -------------------------------------- 
__STORAGE__ 
Validate patching tag           Success   Validated patching tag: 19.15.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.15.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-48 Pre-checks report for updating database home

# odacli describe-prepatchreport -i 6f040374-d271-4711-a7db-e6c04597ad69

Patch pre-check report                                           
------------------------------------------------------------------------
                 Job ID:  6f040374-d271-4711-a7db-e6c04597ad69
            Description:  Patch pre-checks for [DB, ORACHKDB]: DbHome is OraDB19000_home1
                 Status:  SUCCESS
                Created:  May 13, 2022 8:59:48 AM HKT
                 Result:  All pre-checks succeeded

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

Pre-Check                      Status   Comments                              
------------------------------ -------- -------------------------------------- 
__DB__ 
Validate DB Home ID             Success   Validated DB Home ID:                 
                                          d03d5187-1c20-470a-9d51-49a0d6f60772  
Validate patching tag           Success   Validated patching tag: 19.15.0.0.0.  
Is system provisioned           Success   Verified system is provisioned        
Validate minimum agent version  Success   Validated minimum agent version       
Is GI upgraded                  Success   Validated GI is upgraded              
Validate available space for    Success   Validated free space required under   
db                                        /u01/app/odaorahome                   
Validate dbHomesOnACFS          Success   User has configured diskgroup for     
configured                                Database homes on ACFS                
Validate Oracle base            Success   Successfully validated Oracle Base    
Is DB clone available           Success   Successfully validated clone file     
                                          exists                                
Evaluate DBHome patching with   Success   Successfully validated updating       
RHP                                       dbhome with RHP.  and local patching  
                                          is possible                           
Validate command execution      Success   Validated command execution           

__ORACHK__ 
Running orachk                  Success   Successfully ran Orachk               
Validate command execution      Success   Validated command execution           

Node Name       
---------------
node2 

Pre-Check                      Status   Comments                              
------------------------------ -------- -------------------------------------- 
__DB__ 
Validate DB Home ID             Success   Validated DB Home ID:                 
                                          d03d5187-1c20-470a-9d51-49a0d6f60772  
Validate patching tag           Success   Validated patching tag: 19.15.0.0.0.  
Is system provisioned           Success   Verified system is provisioned        
Validate minimum agent version  Success   Validated minimum agent version       
Is GI upgraded                  Success   Validated GI is upgraded              
Validate available space for    Success   Validated free space required under   
db                                        /u01/app/odaorahome                   
Validate dbHomesOnACFS          Success   User has configured diskgroup for     
configured                                Database homes on ACFS                
Validate Oracle base            Success   Successfully validated Oracle Base    
Is DB clone available           Success   Successfully validated clone file     
                                          exists                                
Evaluate DBHome patching with   Success   Successfully validated updating       
RHP                                       dbhome with RHP.                      
Validate command execution      Success   Validated command execution           

__ORACHK__ 
Running orachk                  Success   Successfully ran Orachk               
Validate command execution      Success   Validated command execution

Parent topic: odacli Apply Patch and Update Commands

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-49 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

Parent topic: odacli Apply Patch and Update Commands

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

--id, -i

 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-50 Deleting A Patch Pre-Checks Report

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

Parent topic: odacli Apply Patch and Update Commands

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-51 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-52 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

Parent topic: odacli Apply Patch and Update Commands

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 on Oracle Database Appliance, then the output displays the version details for each of the installed homes and the databases in each database home. 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][-nn node_name]

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-name, –nn

(Optional) Describes the components for a specific node name on high availability (HA) systems. This option is not needed to display component details on single node systems.

--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-53 Displaying patch details for components for High-Availability Oracle Database Appliance Systems for a release

# odacli describe-component 
System Version
--------------
23.5.0.0.0

System Node Name
----------------
oak0

Local System Version
--------------------
23.5.0.0.0

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

DCSCONTROLLER 23.5.0.0.0 up-to-date

DCSCLI 23.5.0.0.0 up-to-date

DCSAGENT 23.5.0.0.0 up-to-date

DCSADMIN 23.5.0.0.0 up-to-date

OS 8.10 up-to-date

ILOM 5.1.4.20.r157857 up-to-date

BIOS 84060600 up-to-date

LOCAL CONTROLLER FIRMWARE {
     [c0, c1] E2MU200 up-to-date

     [c4, c5, c6] 26.33.1048 26.37.1014
}

SHARED CONTROLLER FIRMWARE {
     [c2, c3] 23.00.01.00 up-to-date
}

FIRMWAREEXPANDER {
     [c2x0, c3x0] 0310 up-to-date
}
SHARED DISK FIRMWARE {
     [c2d0, c2d1, c2d2, RXA0 up-to-date
     c2d3, c2d4, c2d5,
     c3d0, c3d1, c3d2,
     c3d3, c3d4, c3d5]

     [c2d6, c2d7, c2d8, A7B0 up-to-date
     c2d9, c2d10,
     c2d11, c2d12,
     c2d13, c2d14,
     c2d15, c2d16,
     c2d17, c2d18,
     c2d19, c2d20,
     c2d21, c2d22,
     c2d23, c3d6, c3d7,
     c3d8, c3d9, c3d10,
     c3d11, c3d12,
     c3d13, c3d14,
     c3d15, c3d16,
     c3d17, c3d18,
     c3d19, c3d20,
     c3d21, c3d22, c3d23]
}

HMP 2.4.9.2.600 up-to-date

System Node Name
----------------
oak1

Local System Version
--------------------
23.5.0.0.0
Component Installed Version Available Version
---------------------------------------- -------------------- --------------------
OAK 23.5.0.0.0 up-to-date

DCSCONTROLLER 23.5.0.0.0 up-to-date

DCSCLI 23.5.0.0.0 up-to-date

DCSAGENT 23.5.0.0.0 up-to-date

DCSADMIN 23.5.0.0.0 up-to-date

OS 8.10 up-to-date

ILOM 5.1.4.20.r157857 up-to-date

BIOS 84060600 up-to-date

LOCAL CONTROLLER FIRMWARE {
     [c0, c1] E2MU200 up-to-date

     [c4, c5, c6] 26.33.1048 26.37.1014
}

SHARED CONTROLLER FIRMWARE {
     [c2, c3] 23.00.01.00 up-to-date
}

FIRMWAREEXPANDER {
     [c2x0, c3x0] 0310 up-to-date
}
SHARED DISK FIRMWARE {
     [c2d0, c2d1, c2d2, RXA0 up-to-date
     c2d3, c2d4, c2d5,
     c3d0, c3d1, c3d2,
     c3d3, c3d4, c3d5]

     [c2d6, c2d7, c2d8, A7B0 up-to-date
     c2d9, c2d10,
     c2d11, c2d12,
     c2d13, c2d14,
     c2d15, c2d16,
     c2d17, c2d18,
     c2d19, c2d20,
     c2d21, c2d22,
     c2d23, c3d6, c3d7,
     c3d8, c3d9, c3d10,
     c3d11, c3d12,
     c3d13, c3d14,
     c3d15, c3d16,
     c3d17, c3d18,
     c3d19, c3d20,
     c3d21, c3d22, c3d23]
}

HMP 2.4.9.2.600 up-to-date

Example 16-54 List DB Home Details

# odacli describe-component -d

System Version
--------------
23.5.0.0.0

System Node Name
----------------
oak0

Local System Version
--------------------
23.5.0.0.0

System Node Name
----------------
oak1

Local System Version
--------------------
23.5.0.0.0

Example 16-55 List the Server Components and Versions

# odacli describe-component -s
[root@oak0 ~]# odacli describe-component -s
System Version
--------------
23.5.0.0.0

System Node Name
----------------
oak0

Local System Version
--------------------
23.5.0.0.0

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

DCSCONTROLLER 23.5.0.0.0 up-to-date

OS 8.10 up-to-date

DCSCLI 23.5.0.0.0 up-to-date

DCSADMIN 23.5.0.0.0 up-to-date

ILOM 5.1.4.20.r157857 up-to-date

BIOS 84060600 up-to-date
LOCAL CONTROLLER FIRMWARE {
     [c0, c1] E2MU200 up-to-date

     [c4, c5, c6] 26.33.1048 26.37.1014
}

SHARED CONTROLLER FIRMWARE {
     [c2, c3] 23.00.01.00 up-to-date
}

FIRMWAREEXPANDER {
     [c2x0, c3x0] 0310 up-to-date
}

SHARED DISK FIRMWARE {
     [c2d0, c2d1, c2d2, RXA0 up-to-date
     c2d3, c2d4, c2d5,
     c3d0, c3d1, c3d2,
     c3d3, c3d4, c3d5]

     [c2d6, c2d7, c2d8, A7B0 up-to-date
     c2d9, c2d10,
     c2d11, c2d12,
     c2d13, c2d14,
     c2d15, c2d16,
     c2d17, c2d18,
     c2d19, c2d20,
     c2d21, c2d22,
     c2d23, c3d6, c3d7,
     c3d8, c3d9, c3d10,
     c3d11, c3d12,
     c3d13, c3d14,
     c3d15, c3d16,
     c3d17, c3d18,
     c3d19, c3d20,
     c3d21, c3d22, c3d23]
}
System Node Name
----------------
oak1

Local System Version
--------------------
23.5.0.0.0

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

DCSCONTROLLER 23.5.0.0.0 up-to-date

OS 8.10 up-to-date

DCSCLI 23.5.0.0.0 up-to-date

DCSADMIN 23.5.0.0.0 up-to-date

ILOM 5.1.4.20.r157857 up-to-date

BIOS 84060600 up-to-date

LOCAL CONTROLLER FIRMWARE {
     [c0, c1] E2MU200 up-to-date

     [c4, c5, c6] 26.33.1048 26.37.1014
}

SHARED CONTROLLER FIRMWARE {
     [c2, c3] 23.00.01.00 up-to-date
}

FIRMWAREEXPANDER {
     [c2x0, c3x0] 0310 up-to-date
}
SHARED DISK FIRMWARE {
     [c2d0, c2d1, c2d2, RXA0 up-to-date
     c2d3, c2d4, c2d5,
     c3d0, c3d1, c3d2,
     c3d3, c3d4, c3d5]

     [c2d6, c2d7, c2d8, A7B0 up-to-date
     c2d9, c2d10,
     c2d11, c2d12,
     c2d13, c2d14,
     c2d15, c2d16,
     c2d17, c2d18,
     c2d19, c2d20,
     c2d21, c2d22,
     c2d23, c3d6, c3d7,
     c3d8, c3d9, c3d10,
     c3d11, c3d12,
     c3d13, c3d14,
     c3d15, c3d16,
     c3d17, c3d18,
     c3d19, c3d20,
     c3d21, c3d22, c3d23]
}

Parent topic: odacli Apply Patch and Update Commands

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

Parent topic: odacli Apply Patch and Update Commands

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, 2024 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, 2024 4:14:10 AM UTC       
HttpProxyPort   Http proxy server port   December 8, 2024 4:14:10 AM UTC       
HttpsProxyHost   Https proxy server host  December 8, 2024 4:14:10 AM UTC       
HttpsProxyPort  Https proxy server port  December 8, 2024 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

Related Topics

Parent topic: odacli Apply Patch and Update Commands

odacli modify-agentconfig-parameters

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli modify-agentconfig-parameters -n name_param [-adbs] [-a] [-bm] [-c comment_param] [-dbs dbsys_param] [-d description_param] [-r] [-t type_param] [-u] [-v value_param] [-j] [-h]

Parameters

Parameter Description

--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.

--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.

--json, -j

(Optional) Displays JSON output. The default is false.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

Use the odacli modify-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 modify-agentconfig-parameters -n HttpsProxyPort -v 80 -d "Http proxy port" 
-n HttpsProxyPort -v 80 -d "Https proxy port" -u

modify-agentconfig-parameters -n HttpsProxyPort -n HttpProxyPort -r

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

modify-agentconfig-parameters -n OSPatchRepos -v

Example 16-61 Setting Oracle RDBMS Parameters

# odacli modify-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                       December 8, 2024 5:24:45 PM UTC

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

# odacli modify-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                           December 8, 2024 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                           December 8, 2024 12:08:15 AM UTC
You can set the value for a specific DB system:
# odacli modify-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                          December 8, 2024 12:08:15 AM UTC

Parent topic: odacli Apply Patch and Update Commands

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 modify-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, 2024 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

Parent topic: odacli Apply Patch and Update Commands

odacli update-database

Use the odacli update-database command to update a database to a specific database home with later version, and within the same major release.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli update-database [-a] [-dp] [-f] [-i db_id] [-imp] [-l] [-n db_name] [-nn node_name] [-r] [-to db_home_id] [-j] [-h]

Parameters

Parameter Description

--to-home, -to

(Optional) Specifies the destination Oracle Database Home ID.

The -to option is not a mandatory option if you want to apply datapatch using the odacli update-database command. The -to option is only required when you want to use the odacli update-database command to patch a specific database to a specific database home.

--abort, –a

(Optional) Aborts the unfinished or failed patching operation.

--name, –n

(Optional) Specifies the database name the patch.

--ignore-missing-patch, –imp

(Optional) Ignores all missing patches and forces the operation.
--force, –f

(Optional) Ignores precheck error and forces the operation.
--local, –l

(Optional) Updates the database locally.
--node-name, –nn

(Optional) Specifies the node name to be updated.

--id, -i

(Optional) Specifies the database ID to be patched.

--datapatch, -dp

(Optional) Applies only the datapatch.

--revert, -r

(Optional) Reverts the unfinished or failed patching operation.

--help, -h

(Optional) Displays help for using the command.

--json, -j

  

(Optional) Displays JSON output. The default is false.

Usage Notes

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

  • The update-database command patches a database to a specific database home with later version, and within the same major release.

  • To patch a database to a specific database home, the database must be running.

  • To patch a database, it must have the status Configured. Use the odacli list-database command to see a list of configured databases. Patch requests for target databases in any other status are rejected during patching.

  • You can patch only the database homes in the Configured status. Use the odacli list-dbhomes command to see a list of configured database homes. Patch requests for target database homes in any other status are rejected during patching.

  • The --datapatch option applies the datapatch to the specific database. This option is helpful for databases that have moved to a destination database home without the datapatch. Examples of using the --datapatch option are as follows:
    • When you patch the database as a standby database and then switch the database as the primary database.
    • When you must apply additional or one-off data patches after patching your Oracle Database Appliance deployment.

Example 16-65 Updating an Oracle Database

To patch a specific database to a specific database home:

# odacli update-database -i e5b60db5-2ee9-4cfc-93ee-179302ee6ebc -to dc98eaa9-289c-4710-a898-ca6287a07a9c

When the database home version is earlier than the target database version, an error is encountered:

# odacli update-database -i c05458c7-0f1d-4260-8e62-003b3ec26d74 -to 7ef2449d-3583-47fd-a57a-6ba3fd224119
DCS-10045:Validation error encountered: Target database's version is higher than destination dbhome, no need to patch.

Parent topic: odacli Apply Patch and Update Commands

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 dbhome_id -v version [-f] [-imp] [-p] [-l] [-nn node_name] [-j] [-h]

Parameters

Parameter Description

--id, -i

Defines the Oracle Database Home to update.

--help-h

(Optional) Displays help for using the command.

--json, -j

  (Optional) Displays JSON output.
--precheck, –p

(Optional) Analyzes the patch.

--force, –f

(Optional) Ignores precheck error and forces the operation.
--local, –l

(Optional) Updates the Database Home locally.
--node-name, –n

(Optional) Specifies the node name to be updated.

--version, -v

Defines the Oracle Database Appliance version to update. For example, 19.23.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.

  • When you use the --local option, you can patch in the following way. Note that you can patch the nodes in any order, for example, you can patch the instance on node1 first, and then the instance on node0.
    • Run --local/--node 0 on node0, then --node 1 on node0.
    • Or, run --local/--node 0 on node0, then -local/--node 1 on node1.
    • Or, run --local/--node on either of the nodes, and then update the database home without using the --local/--node on either of the nodes.

Example 16-66 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.26.0.0.0

Parent topic: odacli Apply Patch and Update Commands

odacli update-dcsadmin

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

File Path

/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-67 Updating DCS Admin


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

Parent topic: odacli Apply Patch and Update Commands

odacli update-dcsagent

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

File Path

/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-68 Updating the Agent

To update the dcs-agent to version 19.26: 


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

Parent topic: odacli Apply Patch and Update Commands

odacli update-dcscomponents

Use the odacli update-dcscomponents command to update the DCS components such as the DCS agent, CLI, and controller.

File Path

/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 the DCS agent, CLI, and controller.

Example 16-69 Updating DCS Components


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

Parent topic: odacli Apply Patch and Update Commands

odacli update-registry

Use the odacli update-registry command to update the metadata for the components that are already present in the registry. For database home and grid home, this command updates the patch information, when you apply patches manually.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description

--component, -n

Defines the Oracle Database Appliance component for the registry update.

When you specify system, then the components discovered include gihome, dbnode, sysinstance. When you specify all, then the components discovered include dbhome, db, dbstorage, asr. You can also specify the individual component to be refreshed. The individual options include gihome, dbnode, sysinstance, dbhome, DB, dbstorage, ASR.

--db-unique-name, -u

(Optional) Specifies the global unique name for the database. This option is only applicable for components DB or dbstorage.

--force, -f

This option is deprecated.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Usage Notes

  • Starting with Oracle Database Appliance release 19.18, the odacli update-registry command does not require the -force option for metadata refresh of a component that already exists in the registry metadata. If the metadata for the component to be updated already exists in the appliance registry metadata, then the command rediscovers the attributes from the environment and updates the system registry.
  • The following attribute cannot be discovered with the odacli update-registry command:
    • DB component: rmanBkupPassword, enableEEHA, isBcfgInSync, dbConsoleEnable, cpupool, dbClass, backupConfigId, cloudStorageContainer, isAutoBackupDisabled, registerOnly, entitySource, instanceOnly, dbShape, enableSEHA.
  • Use the --db-unique-name, -u option to update the appliance registry metadata for a specific database or dbstorage. The odacli update-registry command then modifies only the registry metadata for the database or dbstorage associated with the database unique name. For example:
    odacli update-registry -n db -u db_unique_name
odacli update-registry -n dbstorage -u db_unique_name
  • The odacli update-registry command discovers and updates the metadata in the registry only for databases created using ODACLI commands or the Browser User Interace (BUI). An error is displayed when you run the odacli update-registry command to update the metadata for databases that were not created using ODACLI commands or BUI. Hence, for database migration cases, do not use the odacli update-registry command. Instead, use the odacli register-database command. For example:
    # odacli update-registry -n db -u provdb
DCS-10131: Database 'provdb' cannot discover because metadata does not exist

# dcserr 10131
10131, Discover_New_Database_Not_Supported, "Database ''{0}'' cannot discover because metadata does not exist."
// *Cause: The database did not support discovery of new entities.
// *Action: Use the 'odacli register-database' command.
  • Similarly, if you run the odacli update-registry -n dbstorage command to update the metadata for databases or dbstorage that were not created using ODACLI commands or BUI, then an error is displayed. While migrating a database, if the database runs on the appliance and dbstorage also exists, but the corresponding appliance registry metadata does not exist, then you cannot run the odacli update-registry -n dbstorage command to discover the registry metadata. Instead, use the odacli create-dbstorage command.
    # odacli update-registry -n dbstorage -u newstorage
DCS-10132: Dbstorage 'newstorage' cannot discover because metadata does not exist
 
# dcserr 10132
10132, Discover_New_Dbstorage_Not_Supported, "Dbstorage ''{0}'' cannot discover because metadata does not exist."
// *Cause: The database storage did not support discovery of new entities.
// *Action: Use the 'odacli create-dbstorage' command.
  • The odacli update-registry command rediscovers only the following DCS components:
    • System resources : Oracle Grid Infrastructure (gihome), Oracle Database node (dbnode), System instance (sysinstance)
    • Database Home (dbhome)
    • Database (db)
    • Database storage (dbstorage)
    • Oracle ASR (asr)
    The odacli update-registry command does not rediscover any other components not mentioned in the above 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.
  • A report is generated after the odacli update-registry command completes running. This report displays the values present before the command was run and the updated values. The report is saved in the location /opt/oracle/dcs/logs/discoveryReport.txt. If the command is run again, then the new report is appended to the same file along with the timestamp of the latest run of the command.

Example 16-70 Update Registry Report

# odacli update-registry -n system
-----------Begin Discovery at 2023-01-24_12-06-28.0666-------------
***********************
Database Storage Discovery
***********************
***********************
DbStorage Details : Vredf
***********************
           ================                ===========================================                             ===========================================                          
           Parameter Name                  Old Value                                                               New Value                                                            
           ================                ===========================================                             ===========================================                          
           Database Unique Name            Vredf                                                                   Vredf                                                                
           Name                            Vredf                                                                   Vredf                                                                
           State                           CONFIGURED                                                              CONFIGURED                                                           
           Entity Source                   null                                                                    null                                                                 
           Volume Name1                    datvredf                                                                datvredf                                                             
           Volume Type1                    Data                                                                    Data                                                                 
           Volume Disk Group1              data                                                                    data                                                                 
           Volume File System1             /u02/app/oracle/oradata/Vredf                                           /u02/app/oracle/oradata/Vredf                                        
           Volume Initial Size1            102400                                                                  102400                                                               
           Volume Name2                    orahome_sh                                                              orahome_sh                                                           
           Volume Type2                    Redo                                                                    Redo                                                                 
           Volume Disk Group2              data                                                                    data                                                                 
           Volume File System2             /u01/app/odaorahome                                                     /u01/app/odaorahome                                                  
           Volume Initial Size2            204800                                                                  204800                                                               
           Volume Name3                    reco                                                                    reco                                                                 
           Volume Type3                    Reco                                                                    Reco                                                                 
           Volume Disk Group3              reco                                                                    reco                                                                 
           Volume File System3             /u03/app/oracle/                                                        /u03/app/oracle/                                                     
           Volume Initial Size3            3050496                                                                 3050496                                                              
           =========================================================================================================================================
  
***********************
DbStorage Location : Vredf
***********************
           ================                =====================================                         =====================================                          
           Parameter Name                  Old Value                                                     New Value                                                            
           ================                ====================================                          =====================================                          
           DATA Destination                /u02/app/oracle/oradata/Vredf                                 /u02/app/oracle/oradata/Vredf                                        
           Database Unique Name            Vredf                                                         Vredf                                                                
           Database Id                     6909f458-9bc4-5d7d-7606-c765cd20b823                          6909f458-9bc4-5d7d-7606-c765cd20b823                                 
           Database Storage Type           Acfs                                                          Acfs                                                                 
           Flash Cache Destination         null                                                          null                                                                 
           Reco Destination                /u03/app/oracle/fast_recovery_area/                           /u03/app/oracle/fast_recovery_area/                                  
           Redo Destination                /u04/app/oracle/redo/                                         /u04/app/oracle/redo/                                                
           Name                            Vredf                                                         Vredf                                                                
           State                           CONFIGURED                                                    CONFIGURED                                                           
           =========================================================================================================================================
========================================================================================================================================= 
  
-----------Begin Discovery at 2023-01-24_12-43-48.0876-------------
***********************
Database Home : OraDB19000_home1
***********************
       ================                ===========================================                   =======================================
       Parameter Name                  Old Value                                                     New Value
       ================                ===========================================                   =======================================
       Database Edition                EE                                                            EE
       Database Home Location          /u01/app/odaorahome/oracle/product/19.0.0.0/dbhome_1          /u01/app/odaorahome/oracle/product/19.0.0.0/dbhome_1
       Database Version                19.18.0.0.230118                                              19.18.0.0.230118
  
  
  
       Entity Source                   null                                                          null
       Id                              976643xf-6fa9-7466-x7ws-391b6agb4d4c                          5bb324e4-361e-4f76-a40d-080f24d68faf
       Name                            OraDB19000_home1                                              OraDB19000_home1
       State                           CONFIGURED                                                    CONFIGURED
       Updated Time                    2023-01-24 03:33:31.65                                        Tue Jan 24 12:43:41 UTC 2023
       Unified Auditing                TRUE                                                          TRUE
       =========================================================================================================================================
***********************
Database Home : OraDB19000_home2
***********************
       ================                ===========================================                   ===========================================
       Parameter Name                  Old Value                                                     New Value
       ================                ===========================================                   ===========================================
       Database Edition                EE                                                            EE
       Database Home Location          /u01/app/odaorahome/oracle/product/19.0.0.0/dbhome_2          /u01/app/odaorahome/oracle/product/19.0.0.0/dbhome_2
       Database Version                19.18.0.0.230118                                              19.18.0.0.230118
       Entity Source                   null                                                          null
       Id                              5f3595fa-3509-49a1-8507-36441e12ba46                          b790a5f9-9792-421b-931a-fea341384f58
       Name                            OraDB19000_home2                                              OraDB19000_home2
       State                           CONFIGURED                                                    CONFIGURED
       Updated Time                    2023-01-24 08:21:30.65                                        Tue Jan 24 12:44:10 UTC 2023
       Unified Auditing                TRUE                                                          TRUE
       =========================================================================================================================================
  
***********************
Database : oneDb
***********************
       ================                ===========================================                   ======================================
       Parameter Name                  Old Value                                                     New Value
       ================                ===========================================                   =======================================
       Id                              24d62501-0b3e-44e5-bd09-0e49f57560c6                          e3c522ae-7d89-49cc-bd3c-291cef8fb606
       dbName                          oneDb                                                        oneDb
       State                           CONFIGURED                                                    CONFIGURED
       BackupConfigId                  null                                                          null
       CloudStorageContainer           null                                                          null
       CpuPool                         null                                                          null
       dbUniqueName                    oneDb0                                                       oneDb0
       Db Character Set                AL32UTF8                                                      AL32UTF8
       DbLanguage                      AMERICAN                                                      AMERICAN
       DbTerritory                     AMERICA                                                       AMERICA
       NlsCharacterSet                 AL16UTF16                                                     AL16UTF16
       DbClass                         Oltp                                                          Oltp
       DbConsoleEnable                 false                                                         false
       DbDomainName                    null                                                          us.oracle.com
       DbEdition                       EE                                                            EE
       DbHomeId                        976643xf-6fa9-7466-x7ws-391b6agb4d4c                          976643xf-6fa9-7466-x7ws-391b6agb4d4c
       DBId                            3409102472                                                    3409102472
       isCdb                           true                                                          true
       DbOnFlashStorage                null                                                          false
       DbRedundancy                    null                                                          null
       DbRole                          PRIMARY                                                       PRIMARY
       DbShape                         Odb1                                                          Odb1
       DbStorage                       ACFS                                                          ACFS
       DbTargetNodeName()              null                                                          null
       DbTargetNodeNumber()            0                                                             0
       pdbName                         PDB1                                                          PDB1
       pdbUserName                     null                                                          PDBADMIN
       Database Type                   Si                                                            Si
       DbVersion                       19.18.0.0.230118                                              19.18.0.0.230118
       enableEEHA                      false                                                         false
       enableSEHA                      false                                                         false
       enableTDE                       false                                                         false
       InstanceOnly                    false                                                         false
       isAutoBackupDisabled            true                                                          true
       IsBcfgInSync                    null                                                          null
       IsFileConversionComplete        null                                                          null
       Level0BackupDay                 null                                                          null
       RegisterOnly                    null                                                          null
       RmanBkupPassword                null                                                          null
       TdePassword                     null                                                          null
       TdeWalletManagement             null                                                          null
       =========================================================================================================================================

Parent topic: odacli Apply Patch and Update Commands

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-71 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.26.0.0.0-date-server.zip,/tmp/oda-sm-19.26.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, 2024 14:13:45 AM CST",
  "description" : "Repository Update",
  "updatedTime" : "December 8, 2024 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, 2024 14:19:05 AM CST    Success

Parent topic: odacli Apply Patch and Update Commands

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 [-c] -v version [-f][-ng] [-l] [-n node_name] [-j] [-h]

Parameters

Parameter Description
--version, –v

(Mandatory) Defines the version to update.
--component,–c (Optional) Component that is to be upgraded. Supported value is OS.
--force, –f

(Optional) Ignores precheck error and forces the patching operation.
--local, –l

(Optional) Updates the server on the local node.
--node-name, –nn

(Optional) Specifies the node name to be updated.

--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.
  • When you use the --local option, you can patch in the following way. Note that you can patch the nodes in any order, for example, you can patch the instance on node1 first, and then the instance on node0.
    • Run --local/--node 0 on node0, then --node 1 on node0.
    • Or, run --local/--node 0 on node0, then -local/--node 1 on node1.
    • Or, run --local/--node on either of the nodes, and then update the server without using the --local/--node on either of the nodes.

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-72 Updating the Server

Run the odacli update-server command to update the server to 19.26.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.26.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, 2024 14:13:45 PM CST",
  "resourceList" : [ ],
  "description" : "Server Patching",
  "updatedTime" : "December 8, 2024 14:13:45 PM CST"
}

Parent topic: odacli Apply Patch and Update Commands

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-73 Updating the Storage

# odacli update-storage -v 19.26.0.0.0

Parent topic: odacli Apply Patch and Update Commands

odacli update-server-postcheck

Use the odacli update-server-postcheck command to perform deployment health checks after upgrading the oeprating system from Oracle Linux 6 to Oracle Linux 7.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli update-server-postcheck -v version [-j] [-h]

Parameters

Parameter Description
--version, –v

(Required) Specifies the version to update.
--json, -j

(Optional) Displays JSON output. The default is false.
--help, -h

(Optional) Displays help for using the command.

Parent topic: odacli Apply Patch and Update Commands

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-74 Running odaadmcli orachk

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

Example 16-75 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

Parent topic: odacli Apply Patch and Update Commands

odacli Appliance Commands

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

  • odaconfigcli collectconfig
    Use the odaconfigcli collectconfig command to collect configuration data from the appliance.
  • odacli modify-asmport
    Use the odacli modify-asmport command to modify the Oracle ASM listener port number.
  • odacli set-credential
    Use the odacli set-credential command to change the oda-admin or oda-cliadmin user credentials on a deployment where multi user access is not enabled.
  • 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 ping-agent
    Use the odacli ping-agent command to ping the DCS agent resource.
  • odacli list-nodes
    Use the odacli list-nodes command to list all nodes in the deployment.
  • odacli list-featuretracking
    Use the odacli list-featuretracking command to display the latest feature tracking report.

Parent topic: Oracle Database Appliance Command-Line Interface

odaconfigcli collectconfig

Use the odaconfigcli collectconfig command to collect configuration data from the appliance.

File Path

/opt/oracle/odaconfig/bin/odaconfigcli

Syntax

To collect Oracle Database Appliance configuration information:

# odaconfigcli collectconfig [-loc] [-redact] [-silent]

Parameters

Parameter Description

--loc

(Optional) Specifies custom results location. The default is /opt/oracle/odaconfig/cnr_data.

--redact

(Optional) Redacts sensitive entities in configuration collection. Permitted values are sanitize and mask.

sanitize: Sensitive entities are replaced with a substitution string

mask: Sensitive entities are replaced with '*'

--silent

(Optional) Suppresses all confirmation prompts.

Example 16-76 Creating a diagnostics collection

# odaconfigcli collectconfig 

Oracle Database Appliance system config collection:

-- Performing validations:

-- Collecting configuration from the system test1
The config collection is being created at:
/opt/oracle/odaconfig/cnr_data/odaconfig_test1_23_01_2025_19_38_47

1. Collecting system info
Collecting system details [e.g. version, hardwaretype, etc] ....
Collecting storage details ....
Collecting RPM drift info ....
Collecting AFD state ....
Collecting network info ....

2. Collecting Baremetal database info
Collecting system info ....
Collecting component info ....
Collecting dbstorage info ....
Collecting database info ....
Collecting dbhome info ....
Collecting backupconfig info ....
Collecting cpupool info ....
Collecting network info ....
Collecting objectstoreswift info ....
Collecting backupreport info ....

3. Processing Odaconfig report. Please note ** it will take few minutes ** to collect all the command outputs
Collecting ODA stack information
Collecting fixed commands information
Generating html ODAConfig report

4. Setting file protection to the files on config collection.

5. Not redacting the collection

Finished config collection and creating jsons. Following is the collection summary:
Config collect bundle created at: /opt/oracle/odaconfig/cnr_data/odaconfig_testoda803c1n1_23_01_2025_19_38_47
HTML ODAConfig report can be found at: /opt/oracle/odaconfig/cnr_data/odaconfig_testoda803c1n1_23_01_2025_19_38_47/odaconfig_testoda803c1n1_23_01_2025_19_38_47.html
Logs for this run can be found at : /opt/oracle/odaconfig/cnr_data/odaconfig_testoda803c1n1_23_01_2025_19_38_47/logs

Parent topic: odacli Appliance Commands

odacli modify-asmport

Use the odacli modify-asmport command to modify the Oracle ASM listener port number.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli modify-asmport -p [-j] [-h]

Parameters

Parameter Description

--p, -p

(Mandatorty) Specifies the new port number for the Oracle ASM listener.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Usage Notes

  • You can modify the Oracle ASM listener port number on the bare metal system. All DB systems that you provision after changing the Oracle ASM listener port number use the new Oracle ASM port number.

Example 16-77 Command output details on bare metal system and DB system

[root@node1 tmp]# odacli modify-asmport -p 1528

[root@node1 tmp]# odacli describe-job -i 3f182c48-7ff8-4642-af13-e330b668c29e
 
Job details                                                     
----------------------------------------------------------------
                     ID:  3f182c48-7ff8-4642-af13-e330b668c29e
            Description:  Modify ASM listener port
                 Status:  Success
                Created:  July 18, 2024 4:03:05 PM CST
                Message: 
 
Task Name                                Start Time                               End Time                                 Status         
---------------------------------------- ---------------------------------------- ---------------------------------------- ----------------
Stop CRS on DB System(s)                 July 18, 2024 4:03:05 PM CST             July 18, 2024 4:14:44 PM CST             Success        
Modify the ASM listener port on BM       July 18, 2024 4:14:44 PM CST             July 18, 2024 4:14:48 PM CST             Success        
Change discovery address for DB Systems  July 18, 2024 4:14:48 PM CST             July 18, 2024 4:34:17 PM CST             Success

After running the command on the bare metal system, the DB system job details are as follows:

# Stopping Oracle Clusterware
 
[root@node1 ~]# odacli describe-job -i 72ed400c-c8ff-4d82-9d8c-b7561d3f3616
 
Job details                                                     
----------------------------------------------------------------
                     ID:  72ed400c-c8ff-4d82-9d8c-b7561d3f3616
            Description:  Stop Clusterware
                 Status:  Success
                Created:  July 18, 2024 10:14:12 AM CEST
                Message: 
 
Task Name                                Start Time                               End Time                                 Status         
---------------------------------------- ---------------------------------------- ---------------------------------------- ----------------
Stop crs with force option               July 18, 2024 10:14:13 AM CEST           July 18, 2024 10:14:23 AM CEST           Success        
 
 
 
# Updating the port
 
[root@node1 ~]# odacli describe-job -i b728b936-7426-463f-b6d4-b7ab9ff9f399
 
Job details                                                     
----------------------------------------------------------------
                     ID:  b728b936-7426-463f-b6d4-b7ab9ff9f399
            Description:  Modify ASM listener port
                 Status:  Success
                Created:  July 18, 2024 11:32:42 AM CEST
                Message: 
 
Task Name                                Start Time                               End Time                                 Status         
---------------------------------------- ---------------------------------------- ---------------------------------------- ----------------
Updating the ASM discovery address in    July 18, 2024 11:32:43 AM CEST           July 18, 2024 11:32:43 AM CEST           Success        
OLR                                                                                                                                       
Starting the clusterware                 July 18, 2024 11:32:43 AM CEST           July 18, 2024 11:33:44 AM CEST           Success        
Updating the ASM discovery address in    July 18, 2024 11:33:44 AM CEST           July 18, 2024 11:34:44 AM CEST           Success        
OCR                                                                                                                                       
Restarting Clusterware                   July 18, 2024 11:34:44 AM CEST           July 18, 2024 11:37:24 AM CEST           Success

Related Topics

Parent topic: odacli Appliance Commands

odacli set-credential

Use the odacli set-credential command to change the oda-admin or oda-cliadmin user credentials on a deployment where multi user access is not enabled.

Syntax

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

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

Parameters

Parameter Description

--username, -u

 User name credentials that you want to reset. The user name can be oda-admin or oda-cliadmin. The oda-admin user credentials allow access to the BUI and the oda-cliadmin user credentials allow ODACLI to communicate with the DCS agent internally.

--json, -j

  (Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

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

Example 16-78 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:

Parent topic: odacli Appliance Commands

odacli create-appliance

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

File Path

/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.

Usage Notes

For example JSON files, see the chapter Creating an Appliance Using a JSON File in this publication.

Parent topic: odacli Appliance Commands

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-79 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,

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

Parent topic: odacli Appliance Commands

odacli ping-agent

Use the odacli ping-agent command to ping the DCS agent resource.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli ping-agent [-j] [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Example 16-80 

# odacli ping-agent

Parent topic: odacli Appliance Commands

odacli list-nodes

Use the odacli list-nodes command to list all nodes in the deployment.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-nodes [-j] [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Example 16-81 

# odacli list-nodes

Parent topic: odacli Appliance Commands

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-82 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

Parent topic: odacli Appliance Commands

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.

Parent topic: Oracle Database Appliance Command-Line Interface

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 | -n 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.
--name, -n

Defines the database name.
--id, -i

Defines the Database Resource ID.
--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output.
--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.

  • For TDE-enabled databases with TDE keys stored in Oracle Key Vault, the TDE wallet of the database is not backed up because the wallet is stored outside Oracle Database Appliance.
  • 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-83 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-84 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-85 Create a Backup of only the TDE Wallet

# odacli create-backup -n testdb -c TDEWallet

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

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

Parent topic: odacli Backup and Recovery Commands

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-87 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-88 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-89 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-90 Create a Backup Configuration with single backup location for database backup

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

Parent topic: odacli Backup and Recovery Commands

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.

Parent topic: odacli Backup and Recovery Commands

odacli describe-backupconfig

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli  describe-backupconfig  [-i backup_configuration_id] [-n name] [-h] [-j]

Parameters

Parameter Description
--id, -i

Specifies the backup configuration identifier (ID).
--name, -n

Specifies the backup configuration name.
--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output.

Example 16-91 Describing a Backup Configuration

Describe a backup configuration named production

# odacli describe-backupconfig -n production

Parent topic: odacli Backup and Recovery Commands

odacli delete-backup

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli  delete-backup -i Database Resource ID -n name [-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.

--id, -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.
--name, -n

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-92 Delete a Level 0 or Level 1 Backup

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

Example 16-93 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

Parent topic: odacli Backup and Recovery Commands

odacli delete-backupconfig

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli  delete-backupconfig -n name -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).
--name, -n

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-94 Deleting a Backup Configuration

Delete a backup configuration named production

# odacli delete-backupconfig -n production

Parent topic: odacli Backup and Recovery Commands

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-95 Backup report for a TDE-enabled database (contains a keystoreType attribute)

odacli describe-backupreport -i d2326683-9766-4933-bee1-a2b59c9d7e9e
{
  "id" : "d2326683-9766-4933-bee1-a2b59c9d7e9e",
  "dbResId" : "96a98156-b657-403e-a87c-357c2069c285",
  "tag" : "auto",
  "dbId" : "1851419729",
  "dbName" : "db15",
  "dbUniqueName" : "db15",
  "backupType" : "Regular-L0",
  "keepDays" : null,
  "backupLocation" : "/nfs_backup/orabackups/dbsfb225975e/database/1851419729/db15/db",
  "cfBackupHandle" : "/nfs_backup/orabackups/dbsfb225975e/database/1851419729/db15/db/c-1851419729-20240326-03",
  "spfBackupHandle" : "/nfs_backup/orabackups/dbsfb225975e/database/1851419729/db15/db/c-1851419729-20240326-03",
  "pitrTimeStamp" : "March 26, 2024 04:15:06 AM PDT",
  "pitrSCN" : "1675444",
  "resetLogsTimeStamp" : "March 26, 2024 03:01:39 AM PDT",
  "resetLogsSCN" : "1575481",
  "oraHomeVersion" : "19.22.0.0.240116",
  "sqlPatches" : "35926646,34774667,35943157",
  "backupLogLoc" : "/nfs_backup/orabackups/dbsfb225975e/database/1851419729/db15/rmanlog/2024-03-26/rman_backup_auto_2024-03-26_04-14-29.0478.log",
  "tdeWalletLoc" : null,
  "dbConfigLoc" : "/nfs_backup/orabackups/dbsfb225975e/database/1851419729/db15/dbconfig/2024-03-26/DBCONFIG_auto_2024-03-26_04-15-19.0472.tar.gz",
  "name" : "Backup_Report_db15",
  "createTime" : "March 26, 2024 04:14:26 AM PDT",
  "state" : {
    "status" : "CONFIGURED"
  },
  "updatedTime" : "March 26, 2024 04:14:26 AM PDT",
  "backupReportLogDetail" : "/nfs_backup/orabackups/dbsfb225975e/database/1851419729/db15/rmandetaillogreport/2024-03-26/rman_list_backup_detail_auto_2024-03-26_04-15-16.0129.log",
  "dbInfo" : {
    "dbClass" : "OLTP",
    "dbType" : "RAC",
    "dbShape" : "odb2",
    "dbEdition" : "EE",
    "dbStorage" : "ASM",
    "dbRedundancy" : null,
    "pdbName" : null,
    "isCdb" : false
  },
  "dbDataSize" : "2441M",
  "dbRedoSize" : "16403M",
  "rmanBackupPieces" : "/nfs_backup/orabackups/dbsfb225975e/database/1851419729/db15/backuppieces/2024-03-26/backupPieces_auto_96a98156-b657-403e-a87c-357c2069c285_20240326041518.json",
  "compressionAlgo" : "BASIC",
  "cpuPool" : null,
  "numberOfCores" : null,
  "keystoreType" : "OKV" <<<< HERE
}

Example 16-96 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" : "September 08, 2024 12:43:14 PM UTC",
  "pitrSCN" : "1175058",
  "resetLogsTimeStamp" : "September 08, 2024 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"
}

Parent topic: odacli Backup and Recovery Commands

odacli describe-objectstoreswift

Use the command describe-objectstoreswift to describe a Swift ObjectStore.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli  describe-objectstoreswift -i Object Store_Swift_id -n Object Store_Swift_name  [-h] [-j]

Parameters

Parameter Description
--id, -i

Specifies the Object Store Swift identifier (ID).
--name, -n

Specifies the Object Store Swift name.
--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output. The default is false.

Example 16-97 Describing the Swift Object Store

# odacli  describe-objectstoreswift -i Object Store Swift id

Parent topic: odacli Backup and Recovery Commands

odacli delete-objectstoreswift

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli  delete-objectstoreswift -i Object Store Swift id -n 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.
--id, -i

Defines the Object Store Swift identifier (ID).
--name, -n

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-98 Deleting the Oracle Object Store Credentials

# odacli  delete-objectstoreswift -i Object Store Swift id

Parent topic: odacli Backup and Recovery Commands

 odacli describe-schedule

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

File Path

/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.
--id, -i

Defines the schedule with an identifier (ID).

Example 16-99 Display Schedule Details

#  odacli  describe-schedule -i scheduleid

Parent topic: odacli Backup and Recovery Commands

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 backup report.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

 odacli irestore-database -r [-tn] [-n] [-bp] [-cl] [-nn] [-co] [-s] [-ro] [-dr] [-y] [-c] [-oid] [-tf] [-bl] [-t] [-kt] [-ocp] [-tl] [-cp] [-dh] [-dn] [-de] [-f] [-rd] [-on] [-ha|-no-ha] [-own] [-osc] [-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.

--enable-tde, -t

Specifies whether to enable Transparent Data Encryption (TDE) which uses software keystore.

--keystore-type, -kt

Specifies the type of keystore which stores the TDE master encryption key. The value can be software or okv. The default is software.

--okvclient-path, -ocp

Specifies the absolute path to the okvclient.jar file. Multiple values must be comma-separated. Cannot be used with the --okv-server-config,-osc option.

--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.

--node-name, -tn

(Optional) Specifies the target host name (applicable only for Oracle RAC One Node Database and single-instance Oracle Database, where supported). This option is available for Oracle Database Appliance high-availability deployments.

--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.

--keystore-type, -kt

Specifies the type of keystore which stores the TDE master encryption key. The value can be software or okv. The default is software.

--okv-server-config, -osc

Specifies the name of the Oracle Key Vault server configuration object which serves as the metadata of the Oracle Key Vault user credentials used by the target database.

--okv-wallet-name, -own

Specifies the name of the wallet of the target database on the Oracle Key Vault server. Use this option only if the wallet is manually created on the Oracle Key Vault server.
--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:

  1. dbRedundancy that is specified in the irestore-database command.

  2. dbRedundancy in the backup report.

  3. 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.

--disable-ha, -no-ha

(Optional) Disables High Availability for single-instance Oracle Database 19c and later.

--enable-ha, -ha

(Optional) Enables High Availability for single-instance Oracle Database 19c and later.

Usage Notes

Caution:

When you create a database with Transparent Data Encryption (TDE) enabled, with TDE keys stored in software keystore, 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.
  • To create a database with role as standby in an Oracle Data Guard configuration on Oracle Database Appliance, you do not need to copy the wallet of the primary database when using Oracle Key Vault keystore for TDE-enabled databases. The same wallet can be specified in the odacli irestore-database command.

Example 16-100 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-101 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-102 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-103 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-104 Restoring to a standby database when Oracle Data Guard is configured

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

Example 16-105 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, 2024 11:20:08 AM UTC",
  "resourceList" : [ ],
  "description" : "Database service recovery with db name: irmendb3",
  "updatedTime" : "August 10, 2024 11:20:08 AM UTC"
}

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

Restore an Oracle single-instance database okvdb without using the Oracle Key Vault server configuration object as follows:

odacli irestore-database -r /tmp/bkpreport.json -n okvdb8 -y SI -t -kt OKV -ocp /tmp/okvclient.jar
Enter SYS and SYSTEM user password:
Retype SYS and SYSTEM user password:
Enter TDE wallet password:
 
Job details                                                     
----------------------------------------------------------------
                     ID:  dce7bde6-7fc4-48ec-891b-649525f1ce4f
            Description:  Database service recovery with DB name: okvdb8
                 Status:  Success
                Created:  August 28, 2024 2:50:46 PM CST
                Message:    
 
Task Name                                Node Name                 Start Time                               End Time                                 Status         
---------------------------------------- ------------------------- ---------------------------------------- ---------------------------------------- ----------------
Restore Database                         n1          August 28, 2024 2:51:09 PM CST           August 28, 2024 2:58:11 PM CST           Failure        
Restore Database                         n1          August 28, 2024 2:51:10 PM CST           August 28, 2024 2:58:10 PM CST           Failure        
Check if cluster ware is running         n1          August 28, 2024 2:51:14 PM CST           August 28, 2024 2:51:14 PM CST           Success        
Check if cluster ware is running         n2          August 28, 2024 2:51:14 PM CST           August 28, 2024 2:51:14 PM CST           Success        
Creating DbStorage for DbRestore         n1          August 28, 2024 2:51:14 PM CST           August 28, 2024 2:51:21 PM CST           Success        
Validating DiskSpace for DATA            n1          August 28, 2024 2:51:14 PM CST           August 28, 2024 2:51:15 PM CST           Success        
Setting up SSH equivalence               n1          August 28, 2024 2:51:15 PM CST           August 28, 2024 2:51:19 PM CST           Success        
Configuring user access to ACFS          n1          August 28, 2024 2:51:20 PM CST           August 28, 2024 2:51:20 PM CST           Success        
filesystems for okvdb8st                                                                                                                                            
Audit directory creation                 n1          August 28, 2024 2:51:20 PM CST           August 28, 2024 2:51:21 PM CST           Success        
Audit directory creation                 n2          August 28, 2024 2:51:21 PM CST           August 28, 2024 2:51:21 PM CST           Success        
Configure TDE for RestoreDb TaskFlow     n1          August 28, 2024 2:51:22 PM CST           August 28, 2024 2:51:39 PM CST           Success        
Auxiliary Instance Creation              n2          August 28, 2024 2:51:24 PM CST           August 28, 2024 2:51:36 PM CST           Success        
TDE Wallet directory creation            n1          August 28, 2024 2:51:36 PM CST           August 28, 2024 2:51:36 PM CST           Success        
Installing OKV Client Software           n2          August 28, 2024 2:51:36 PM CST           August 28, 2024 2:51:37 PM CST           Success        
Auto login TDE Wallet creation           n1          August 28, 2024 2:51:37 PM CST           August 28, 2024 2:51:38 PM CST           Success        
Password based TDE Wallet open           n1          August 28, 2024 2:51:38 PM CST           August 28, 2024 2:51:39 PM CST           Success        
Install Object Store Swift module        n2          August 28, 2024 2:51:58 PM CST           August 28, 2024 2:52:16 PM CST           Success        
Restoring Spfile From Casper             n2          August 28, 2024 2:52:16 PM CST           August 28, 2024 2:52:38 PM CST           Success        
Customize Db Parameters                  n2          August 28, 2024 2:52:38 PM CST           August 28, 2024 2:52:47 PM CST           Success        
Create spfile for restore db             n2          August 28, 2024 2:52:47 PM CST           August 28, 2024 2:52:48 PM CST           Success        
Restoring control file                   n2          August 28, 2024 2:52:48 PM CST           August 28, 2024 2:53:11 PM CST           Success        
Mounting db                              n2          August 28, 2024 2:53:11 PM CST           August 28, 2024 2:53:35 PM CST           Success        
Validating backup for RestoreDB          n2          August 28, 2024 2:53:35 PM CST           August 28, 2024 2:53:41 PM CST           Success        
Restoring DB for migration               n2          August 28, 2024 2:53:41 PM CST           August 28, 2024 2:54:26 PM CST           Success        
Change DBID and/or DBName                n2          August 28, 2024 2:54:27 PM CST           August 28, 2024 2:54:28 PM CST           Success        
Register Database taskflow               n1          August 28, 2024 2:54:31 PM CST           August 28, 2024 2:57:08 PM CST           Success        
Create SPFile in shared loc              n2          August 28, 2024 2:54:31 PM CST           August 28, 2024 2:54:37 PM CST           Success        
Delete Local Spfile                      n2          August 28, 2024 2:54:37 PM CST           August 28, 2024 2:54:37 PM CST           Success        
Register DB with clusterware             n2          August 28, 2024 2:54:37 PM CST           August 28, 2024 2:55:23 PM CST           Success        
Set SysPassword and Create PwFile        n1          August 28, 2024 2:55:23 PM CST           August 28, 2024 2:55:25 PM CST           Success        
Enable block change tracking             n2          August 28, 2024 2:55:26 PM CST           August 28, 2024 2:55:28 PM CST           Success        
Creating pfile                           n2          August 28, 2024 2:55:28 PM CST           August 28, 2024 2:55:29 PM CST           Success        
Updating db env                          n2          August 28, 2024 2:55:29 PM CST           August 28, 2024 2:55:30 PM CST           Success        
Enable DbSizing Template                 n2          August 28, 2024 2:55:30 PM CST           August 28, 2024 2:56:20 PM CST           Success        
Create tns entry                         n1          August 28, 2024 2:56:20 PM CST           August 28, 2024 2:56:21 PM CST           Success        
Create tns entry                         n2          August 28, 2024 2:56:21 PM CST           August 28, 2024 2:56:22 PM CST           Success        
Running datapatch                        n2          August 28, 2024 2:56:22 PM CST           August 28, 2024 2:56:23 PM CST           Success        
Set CPU pool                             n1          August 28, 2024 2:56:23 PM CST           August 28, 2024 2:56:23 PM CST           Success        
Reset Associated Networks for Database   n2          August 28, 2024 2:57:10 PM CST           August 28, 2024 2:57:13 PM CST           Success        
Reset Associated Networks                n1          August 28, 2024 2:57:13 PM CST           August 28, 2024 2:57:14 PM CST           Success        
Set log_archive_dest for Database        n2          August 28, 2024 2:57:14 PM CST           August 28, 2024 2:57:18 PM CST           Success        
Setting Database parameter for OKV       n1          August 28, 2024 2:57:18 PM CST           August 28, 2024 2:58:05 PM CST           Success        
Enable New Tablespace Encryption         n2          August 28, 2024 2:58:07 PM CST           August 28, 2024 2:58:08 PM CST           Success        
Deleting OKV Client Software Jar         n2          August 28, 2024 2:58:09 PM CST           August 28, 2024 2:58:09 PM CST           Success        
Copy Pwfile to Shared Storage            n1          August 28, 2024 2:58:09 PM CST           August 28, 2024 2:58:10 PM CST           Success

Parent topic: odacli Backup and Recovery Commands

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-107 Displaying a List of Backup Configuration

Display a list of backup configurations.

# odacli list-backupconfigs

Parent topic: odacli Backup and Recovery Commands

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-108 Display a List of all Backup Reports

#  odacli  list-backupreports 

Parent topic: odacli Backup and Recovery Commands

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-109 Displaying a List of ObjectStore Swift Credentials

# odacli list-objectstoreswifts

Parent topic: odacli Backup and Recovery Commands

 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

/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.

Starting with Oracle Database Appliance release 19.16, DCS software provides a cron job for cleaning up SSH equivalence that was set up by DCS. The SSH cleaner job runs every 30 minutes. If the SSH cleaner job finds that there are currently no DCS jobs which use SSH, then it cleans up SSH keys, and removes passwordless SSH equivalence across the Oracle Database Appliance nodes on high-availability systems. It also deletes any SSH keys (id_rsa and id_rsa.pub) present in the /root/.ssh and /home/operating_system_user/.ssh directories. The SSH cleaner job ensures that DCS jobs are thread safe because jobs (threads) do not interleave while operating on shared resources, such as SSH. To retain the SSH equivalence, or the SSH keys, you can disable the SSH cleaner job job using the odacli modify-schedule command.

Example 16-110 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
---------------------------------------- -------------------------    -------------------------------------------------- ------------------------------ --------
072dceea-9f09-4c1c-a155-6aa4e3d64669     AgentState metastore cleanup internal agentstateentry metastore maintenance     0 0 0 1/1 * ? *                false   
76e530bf-50db-4598-8b9b-6aa89e58b7d7     bom maintenance              bom reports generation                             0 0 1 ? * SUN *                false   
7b2a8981-fb88-480f-8280-90d463fcbff8     feature_tracking_job         Feature tracking job                               0 0 20 ? * WED *               false   
af5bc954-c867-4ba4-b587-c9d527cbe07b     Log files Cleanup            Auto log file purge bases on policy                0 0 3 1/1 * ? *                false   
c4b14c87-e975-43ba-adf3-cb54c72c9cf0     Rebalance Monitoring         Rebalance poll and Power modification              0 0/5 * 1/1 * ? *              true    
d21ccf0d-3341-4030-b204-f3eed892e443     SSHCleanerJob                SSH cleaner job to clean up stale SSH keys         0 0/30 * 1/1 * ? *             false

Parent topic: odacli Backup and Recovery Commands

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-111 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.

Parent topic: odacli Backup and Recovery Commands

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] [-h] [-j] [-r] [-t] [-p] [-s] [-n] [-tp] [-tl] [-tz] [-cp]

Parameters

Parameter Description
--backupReport, -br{Regular-L0|Regular-L1|Longterm}

(Optional) JSON input for a backup report.

--name, -n

Defines the database name.
--id, -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-112 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-113 Recovering a Database to the latest

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

Example 16-114 Recovering a Database to an SCN

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

Example 16-115 Restoring a TDE wallet when performing database recovery is not supported for TDE-enabled databases with TDE keys stored in Oracle Key Vault

The following error is displayed:

# odacli recover-database -n db15 -tl /nfs_backup/ewallet.p12 -t latest
 DCS-10045:Validation error encountered: Usage of TDE wallet related parameters is not allowed for a TDE database with OKV keystore type.

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

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

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

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

Parent topic: odacli Backup and Recovery Commands

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 -n database_name -i DB_ID -fs from_scn -ts to_scn -ft from_timestamp -tt to_timestamp [-h] [-j]

Parameters

Parameter Description
--name, -n

Specifies the Database Name.

--id, -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-118 Restoring archivelog

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

Parent topic: odacli Backup and Recovery Commands

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 [-i] [-n] [-tl] [-h] [-j]

Parameters

Parameter Description
--name, -n

Specifies the Database Name.
--id, -i

Specifies the Database ID.

--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.
  • This command is not supported for the TDE-enabled databases with TDE keys stored in Oracle Key Vault. The following error is displayed: 
    # odacli restore-tdewallet -n db15
Enter TDE wallet password:
DCS-10144:Restore TDE wallet operation is not supported for TDE databases with OKV keystore type.

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

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

Parent topic: odacli Backup and Recovery Commands

odacli modify-backupconfig

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description
--id, -i

Defines the Backup Config ID.
--name, -n

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.
--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.
--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output. The default is false.

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-120 Revise a Backup Configuration for Disk

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

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

Parent topic: odacli Backup and Recovery Commands

odacli modify-objectstoreswift

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli  modify-objectstoreswift [-n name] [-i id] [-p swiftpassword] [-u Object Store user name] [-h] [-j]

Parameters

Parameter Description
--id, -i

Defines the Object Store Swift identifier (ID).
--name, -n

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.
--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output. The default is false.

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 modify-backupconfig with objectstore as the destination. The credentials are not validated against endpoint URL and tenancy.

Example 16-121 Changing the Oracle Casper ObjectStore Password

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

Example 16-122 Changing the Oracle ObjectStore User Name

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

Parent topic: odacli Backup and Recovery Commands

 odacli modify-schedule

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

#  odacli modify-schedule  [-i] [-x cronExpression] [-t description] [-d] [-e] [-h] [-j]

Parameters

Parameter Description
--scheduleid, -i

Defines the schedule with an identifier (ID).
--cronExpression, -x

(Optional) Specifies the cron expression. Use 5 fields or 6 fields cron expression only.

--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.

Usage Notes

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

Starting with Oracle Database Appliance release 19.20, the DCS agent supports only 5 fields cron expressions or 6 fields cron expressions by default, in job schedules. When you patch your deployment from Oracle Database Appliance release 19.19 or earlier, the DCS agent automatically converts all 7 fields cron expression from existing job schedules into an equivalent 6 fields cron expression.

Example 16-123 Modify the Time the Backup Occurs

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

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

Example 16-124 Disable Scheduled Database Backups

#  odacli  modify-schedule -i scheduleid  -d

Parent topic: odacli Backup and Recovery Commands

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 register-dataguard
    Use the command odacli register-dataguard to register Oracle Data Guard with Oracle Database Appliance.
  •  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.

Parent topic: Oracle Database Appliance Command-Line Interface

 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-125 Configuring Oracle Data Guard interactively on the command line

Example with one standby configuration:

# odacli configure-dataguard
# /opt/oracle/dcs/bin/odacli configure-dataguard
Number of standby databases (enter 1 or 2 | default: 1):
Standby 1 site address: phxdbfzp04.dev3farm3phx.databasede3phx
BUI username for Standby site host1. If Multi-user Access/Multi-user Access Passwordless is not enabled on Standby site phxdbfzp04.dev3farm3phx.databasede3phx, enter 'oda-admin'; otherwise, enter the name of the user who has irestored the Standby database (default: oda-admin): oda-admin
BUI password for Standby site host2:
Password for root user on Standby site host2:
 
*******************************************************************************************
Data Guard configuration name: tdb_dg
Database name for Data Guard configuration: tdb
Primary database SYS password:
Protection mode [MAX_PROTECTION, MAX_PERFORMANCE, MAX_AVAILABILITY] (default: MAX_PERFORMANCE):
Enable Active Data Guard (Y/N, default:N):
*******************************************************************************************
 
Data Guard default settings for standby database - tdbstndby
Primary site network for Data Guard configuration: Public-network
Standby site network for Data Guard configuration: Public-network
Primary database listener port (TCP): 1521
Standby database listener port (TCP): 1521
Transport type: ASYNC
Do you want to edit this Data Guard configuration? (Y/N, default:N): N
*******************************************************************************************
Enter Primary database RMAN backup encryption password if any:
Do you want to provide another Primary database RMAN backup encryption password if any? [y/n] (default 'n'):
Standby database's SYS password will be set to Primary database's after Data Guard configuration. Ignore warning and proceed with Data Guard configuration? (Y/N, default:N): Y
{
  "jobId" : "e02cc0b3-bce3-4d6c-a1f5-5b121bb7f66a",
  "status" : "Created",
  "message" : "",
  "reports" : [ ],
  "createTimestamp" : "January 23, 2025 03:12:44 AM UTC",
  "resourceList" : [ ],
  "description" : "DG Config service for DB tdb",
  "updatedTime" : "January 23, 2025 03:12:44 AM UTC",
  "jobType" : null,
  "cpsMetadata" : null
}
 
[root@host1 work]# /opt/oracle/dcs/bin/odacli describe-job -i e02cc0b3-bce3-4d6c-a1f5-5b121bb7f66a
 
Job details                                                     
----------------------------------------------------------------
                     ID:  e02cc0b3-bce3-4d6c-a1f5-5b121bb7f66a
            Description:  DG Config service for DB tdb
                 Status:  Success
                Created:  January 23, 2025 03:12:44 UTC
                Message: 
 
Task Name                                Start Time                               End Time                                 Status         
---------------------------------------- ---------------------------------------- ---------------------------------------- ----------------
Validate configure primary request       January 23, 2025 03:13:10 UTC            January 23, 2025 03:13:21 UTC            Success        
(Primary site) (Host: host1/Job                                                                                                      
ID:                                                                                                                                       
901389f5-0cad-4ee6-91be-3f77b85652af)                                                                                                     
Validate configure standby request       January 23, 2025 03:13:21 UTC            January 23, 2025 03:13:29 UTC            Success        
(Standby site) (Host:                                                                                                                     
host2/Job ID:                                                                                                                    
856d86e4-dd51-41a7-9050-b0c39ae771f9)                                                                                                     
Uploading Primary DB Password File       January 23, 2025 03:13:29 UTC            January 23, 2025 03:13:52 UTC            Success        
(Standby site)                                                                                                                            
Configure primary database (Primary      January 23, 2025 03:13:52 UTC            January 23, 2025 03:15:29 UTC            Success        
site) (Host: host1/Job ID:                                                                                                           
5dd46e86-e07f-423f-9ebf-2515b4ac17d5)                                                                                                     
Configure standby request (Standby       January 23, 2025 03:15:29 UTC            January 23, 2025 03:17:30 UTC            Success        
site) (Host:                                                                                                                              
host2/Job ID:                                                                                                                    
2ab511a2-15c0-4371-bf30-9b7e27ff5288)                                                                                                     
Create archive log restore (Primary      January 23, 2025 03:17:30 UTC            January 23, 2025 03:17:52 UTC            Success        
site) (Host: host1/Job ID:                                                                                                           
96766874-6537-4972-81a9-971440e2acfb)                                                                                                     
Configure and enable Data Guard          January 23, 2025 03:17:53 UTC            January 23, 2025 03:19:19 UTC            Success        
(Primary site) (Host: host1/Job                                                                                                      
ID:                                                                                                                                       
7ad65ffa-ea06-479d-bb21-e0b81fb8c743)                                                                                                     
Enable Flashback (Standby site) (Host:   January 23, 2025 03:19:19 UTC            January 23, 2025 03:19:38 UTC            Success        
host2/Job ID:                                                                                                                    
a1768703-4dd4-4f1f-b9a3-9fe0f99615d5)                                                                                                     
Re-enable Data Guard (Primary site)      January 23, 2025 03:19:38 UTC            January 23, 2025 03:19:44 UTC            Success        
(Host: host1/Job ID:                                                                                                                 
3f6dd276-63e3-4804-a179-e10052386206)                                                                                                     
Create Data Guard status (Primary        January 23, 2025 03:19:44 UTC            January 23, 2025 03:19:49 UTC            Success        
site) (Host: host1/Job ID:                                                                                                           
8a3eb946-3501-4618-9d4a-ad8a6d298cc8)                                                                                                     
Create Data Guard status (Standby        January 23, 2025 03:19:49 UTC            January 23, 2025 03:19:57 UTC            Success        
site) (Host:                                                                                                                              
host2/Job ID:                                                                                                                    
d9d65942-6284-40d5-a991-b1d21edae96f)

Example 16-126 Configuring Oracle Data Guard with two standby configurations

Example with two standby databases configuration:
# odacli configure-dataguard
Number of standby databases (enter 1 or 2 | default: 1): 2
Standby 1 site address: standby1
BUI username for Standby site standby1. If Multi-user Access/Multi-user
Access Passwordless is not enabled on Standby site standby1, enter
'oda-admin'; otherwise, enter the name of the user who has irestored the Standby
database (default: oda-admin):
BUI password for Standby site standby1:
Password for root user on Standby site standby1:
Standby 2 site address: standby2
BUI username for Standby site standby2. If Multi-user Access/Multi-user
Access Passwordless is not enabled on Standby site standby2, enter
'oda-admin'; otherwise, enter the name of the user who has irestored the Standby
database (default: oda-admin):
BUI password for Standby site standby2:
Password for root user on Standby site standby2:
 
*******************************************************************************************
Data Guard configuration name: dgbb
Database name for Data Guard configuration: bb
Primary database SYS password:
Protection mode [MAX_PROTECTION, MAX_PERFORMANCE, MAX_AVAILABILITY] (default:
MAX_PERFORMANCE):
Enable Active Data Guard (Y/N, default:N):
*******************************************************************************************
 
Data Guard default settings for standby database - bb1
Primary site network for Data Guard configuration: Public-network
Standby site network for Data Guard configuration: Public-network
Primary database listener port (TCP): 1521
Standby database listener port (TCP): 1521
Transport type: ASYNC
Do you want to edit this Data Guard configuration? (Y/N, default:N):
 
Data Guard default settings for standby database - bb2
Primary site network for Data Guard configuration: Public-network
Standby site network for Data Guard configuration: Public-network
Primary database listener port (TCP): 1521
Standby database listener port (TCP): 1521
Transport type: ASYNC
Do you want to edit this Data Guard configuration? (Y/N, default:N):
Warning: in compliance with Oracle MAA best practices. DbType (RAC) of Primary
database bb is different from DbType (SI) of Standby database. Ignore warning
and proceed with Data Guard configuration? (Y/N, default:N): y
Warning: in compliance with Oracle MAA best practices. DbType (RAC) of Primary
database bb is different from DbType (SI) of Standby database. Ignore warning
and proceed with Data Guard configuration? (Y/N, default:N): y
*******************************************************************************************
Enter Primary database RMAN backup encryption password if any:
Do you want to provide another Primary database RMAN backup encryption password
if any? [y/n] (default 'n'):
Standby database's SYS password will be set to Primary database's after Data
Guard configuration. Ignore warning and proceed with Data Guard configuration?
(Y/N, default:N): y
{
  "jobId" : "f1df87d7-221c-4dc3-a15f-fa35d91560f5",
  "status" : "Created",
  "message" : "",
  "reports" : [ ],
  "createTimestamp" : "January 17, 2025 22:57:55 PM UTC",
  "resourceList" : [ ],
  "description" : "DG Config service for DB bb",
  "updatedTime" : "January 17, 2025 22:57:55 PM UTC",
  "jobType" : null,
  "cpsMetadata" : null
}
 
[root@host1 ~]# odacli describe-job -i
"f1df87d7-221c-4dc3-a15f-fa35d91560f5"
 
Job details                                                     
----------------------------------------------------------------
                     ID:  f1df87d7-221c-4dc3-a15f-fa35d91560f5
            Description:  DG Config service for DB bb
                 Status:  Success
                Created:  January 17, 2025 22:57:55 UTC
                Message: 
 
Task Name                                Node Name                 Start Time  End Time              Status     
    
---------------------------------------- --------------------------------------------------------------------------------------------------------- ----------------
Validate configure primary request       host1          January 17,2025 22:58:38 UTC            January 17, 2025 22:58:44 UTC            Success  
      
(Primary site) (Host:host1/Job ID:                                                         
eb8bbb43-159c-48e0-8dda-9e2bbd280669)                                          
    
Validate configure standby request       host1          January 17,2025 22:58:44 UTC            January 17, 2025 22:58:52 UTC            Success  
(Standby site) (Host: standby1/Job ID:                                                                            
86345f35-500c-4ba8-8ff9-f97c201ad3c7)                                          
   
Uploading Primary DB Password File       host1          January 17,2025 22:58:52 UTC            January 17, 2025 22:59:07 UTC            Success  
(Standby site)                                                                 

Configure primary database (Primary      host1          January 17,2025 22:59:07 UTC            January 17, 2025 22:59:58 UTC            Success  
site) (Host: host1/Job ID:                                          
23ee7263-a59e-40bd-bbec-4c17a5d4ba99)                                          
                                                                                 
    
Configure standby request (Standby       host1          January 17,2025 22:59:58 UTC            January 17, 2025 23:02:00 UTC            Success  
site) (Host: standby1/Job ID:                                               
af543839-85ba-4e83-89d3-af161d528256)                                          

Create archive log restore (Primary      host1          January 17,2025 23:02:00 UTC            January 17, 2025 23:02:37 UTC            Success  
site) (Host: host1/Job ID:                                          
b2940217-cec6-4b22-92d2-f4ec8f26b8b8)                                          
   
Configure and enable Data Guard          host1          January 17,2025 23:02:37 UTC            January 17, 2025 23:04:19 UTC            Success  
(Primary site) (Host:                                                            
host1/Job ID:                                                       
7882e1e5-0d71-48df-bd86-e79ee6b57a21)                                          
 
Enable Flashback (Standby site) (Host:   host1          January 17,2025 23:04:19 UTC            January 17, 2025 23:04:37 UTC            Success  
standby1/Job ID:                                                            
c2ef962c-f429-4e97-8bc3-1355cd7d0ca8)                                          
   
Re-enable Data Guard (Primary site)      host1          January 17,2025 23:04:37 UTC            January 17, 2025 23:04:43 UTC            Success  
(Host: host1/Job ID:                                                
fb4a7055-0049-4d44-a726-0871ed54ca07)                                          

Create Data Guard status (Primary        host1          January 17,2025 23:04:43 UTC            January 17, 2025 23:04:54 UTC            Success  
site) (Host: host1/Job ID:                                          
5aca5c16-632f-488b-aade-1c677030c81d)                                          
 
Create Data Guard status (Standby        host1          January 17,2025 23:04:54 UTC            January 17, 2025 23:05:07 UTC            Success  
site) (Host: standby1/Job ID:                                               
5f0c5460-4c38-4aed-8a5b-e70c0ca70df8)                                          
  
Validate configure primary request       host1          January 17,2025 23:05:07 UTC            January 17, 2025 23:05:13 UTC            Success  
(Primary site) (Host:host1/Job ID:                                                       
5ac64b32-5da6-48df-b8cc-020853363695)                                          
 
Validate configure standby request       host1          January 17,2025 23:05:13 UTC            January 17, 2025 23:05:21 UTC            Success  
(Standby site) (Host: standby2/Job ID:                                                                            
81aa6900-4460-408e-9ab2-fdcd92c8b7bf)                                          
 
Uploading Primary DB Password File       host1          January 17,2025 23:05:21 UTC            January 17, 2025 23:05:32 UTC            Success  
(Standby site)                                                                 

Configure primary database (Primary      host1          January 17,2025 23:05:32 UTC            January 17, 2025 23:06:14 UTC            Success  
site) (Host: host1/Job ID:                                          
c78a8072-8023-4278-bd94-3dd1ef97e066)                                          
  
Configure standby request (Standby       host1          January 17,2025 23:06:14 UTC            January 17, 2025 23:07:43 UTC            Success  
site) (Host: standby2/Job ID:                                               
46274a35-bb06-43a9-a8a5-66dc4d163463)                                          
 
Create archive log restore (Primary      host1          January 17,2025 23:07:43 UTC            January 17, 2025 23:08:15 UTC            Success  
site) (Host: host1/Job ID:                                          
2b20aaa2-fcb7-4bc5-b501-27ad9d45f34b)                                          
 
Configure standby TNS entry (New         host1          January 17,2025 23:08:15 UTC            January 17, 2025 23:08:24 UTC            Success  
standby site) (Host: standby2/Job ID:                                                                            
7e32db8c-999c-44fa-bdf5-3aed77c9590c)                                          
 
Configure standby TNS entry (Existing    host1          January 17,2025 23:08:24 UTC            January 17, 2025 23:08:28 UTC            Success  
standby site) (Host: standby1/Job ID:                                                                            
6a44539e-d5b9-4c45-ad2c-7bff8c871e37)                                          

Add standby database (Primary site)      host1          January 17,2025 23:08:28 UTC            January 17, 2025 23:09:50 UTC            Success  
(Host: host1/Job ID:                                                
1d7c6c93-bd85-496a-bb7d-67ae7b224d58)                                          
  
Enable Flashback (Standby site) (Host:   host1          January 17,2025 23:09:50 UTC            January 17, 2025 23:10:03 UTC            Success  
standby2/Job ID:                                                            
4a6b8623-efc0-4016-80be-305b0ed56363)                                          

Re-enable Data Guard (Primary site)      host1          January 17,2025 23:10:03 UTC            January 17, 2025 23:10:09 UTC            Success  
(Host: host1/Job ID:                                                
2afea759-752a-42a4-a077-bd85d4b687a3)                                          

Update Data Guard status (Primary        host1          January 17,2025 23:10:09 UTC            January 17, 2025 23:10:35 UTC            Success  
site) (Host: host1/Job ID:                                          
11d93988-ea4d-4e37-af30-763c2522693d)                                          

Create Data Guard status (New standby    host1          January 17,2025 23:10:35 UTC            January 17, 2025 23:10:53 UTC            Success  
site) (Host: standby2/Job ID:
aa5b286f-30f1-48d1-8c2d-2490d15ce408)                                          
 
Update Data Guard status (Existing host1          January 17,2025 23:10:53 UTC            January 17, 2025 23:11:06 UTC            Success  
standby site) (Host: standby1/JobID: 
7d8ffa16-6785-468a-bff9-baf8e13b38ec)

Example 16-127 Configuring Oracle Data Guard using JSON file

# /opt/oracle/dcs/bin/odacli configure-dataguard --requestjson /mnt/host1/nfsbackup/dgcmd.json
Number of standby databases (enter 1 or 2 | default: 1):
BUI password for Standby site standby1:
Password for root user on Standby site standby1:
Primary database SYS password:
*******************************************************************************************
Standby database's SYS password will be set to Primary database's after Data Guard configuration. Ignore warning and proceed with Data Guard configuration? (Y/N, default:N): Y
{
  "jobId" : "73adf616-3b6c-452f-bf93-e95abc675cc5",
  "status" : "Created",
  "message" : "",
  "reports" : [ ],
  "createTimestamp" : "January 23, 2025 05:08:50 AM UTC",
  "resourceList" : [ ],
  "description" : "DG Config service for DB tdb",
  "updatedTime" : "January 23, 2025 05:08:50 AM UTC",
  "jobType" : null,
  "cpsMetadata" : null
}
  
[root@host1 work]# /opt/oracle/dcs/bin/odacli describe-job -i 73adf616-3b6c-452f-bf93-e95abc675cc5
 
Job details                                                     
----------------------------------------------------------------
                     ID:  73adf616-3b6c-452f-bf93-e95abc675cc5
            Description:  DG Config service for DB tdb
                 Status:  Success
                Created:  January 23, 2025 05:08:50 UTC
                Message: 
 
Task Name                                Start Time                               End Time                                 Status         
---------------------------------------- ---------------------------------------- ---------------------------------------- ----------------
Validate configure primary request       January 23, 2025 05:09:19 UTC            January 23, 2025 05:09:30 UTC            Success        
(Primary site) (Host: host1/Job                                                                                                      
ID:                                                                                                                                       
7bd1a3d5-2f8c-4d9e-a381-61d04f01b514)                                                                                                     
Validate configure standby request       January 23, 2025 05:09:30 UTC            January 23, 2025 05:09:43 UTC            Success        
(Standby site) (Host:                                                                                                                     
host2/Job ID:                                                                                                                    
18731cf2-bf42-4a3a-b187-17e93cedbb7c)                                                                                                     
Uploading Primary DB Password File       January 23, 2025 05:09:43 UTC            January 23, 2025 05:10:03 UTC            Success        
(Standby site)                                                                                                                            
Configure primary database (Primary      January 23, 2025 05:10:03 UTC            January 23, 2025 05:11:35 UTC            Success        
site) (Host: host1/Job ID:                                                                                                           
d3030fe0-8885-42d6-a57f-ae38baef54af)                                                                                                     
Configure standby request (Standby       January 23, 2025 05:11:35 UTC            January 23, 2025 05:13:35 UTC            Success        
site) (Host:                                                                                                                              
host2/Job ID:                                                                                                                    
763881f4-ea4d-43bc-8e6a-c7f78765c0ff)                                                                                                     
Create archive log restore (Primary      January 23, 2025 05:13:35 UTC            January 23, 2025 05:13:54 UTC            Success        
site) (Host: host1/Job ID:                                                                                                           
5dfbe653-10c8-420f-bada-4c0c8cb6a9e1)                                                                                                     
Configure and enable Data Guard          January 23, 2025 05:13:54 UTC            January 23, 2025 05:15:26 UTC            Success        
(Primary site) (Host: host1/Job                                                                                                      
ID:                                                                                                                                       
137d29a2-9d2c-4ddc-85c8-3a729847e188)                                                                                                     
Enable Flashback (Standby site) (Host:   January 23, 2025 05:15:26 UTC            January 23, 2025 05:15:44 UTC            Success        
host2/Job ID:                                                                                                                    
70306983-40a2-4039-98cb-57ba5e11e9a5)                                                                                                     
Re-enable Data Guard (Primary site)      January 23, 2025 05:15:44 UTC            January 23, 2025 05:15:50 UTC            Success        
(Host: host1/Job ID:                                                                                                                 
4a5fb2aa-1b0b-45c8-b2f3-95103c9f1f00)                                                                                                     
Create Data Guard status (Primary        January 23, 2025 05:15:50 UTC            January 23, 2025 05:15:56 UTC            Success        
site) (Host: host1/Job ID:                                                                                                           
6848b9c1-356f-43ff-b6e0-5e9b1b01fc53)                                                                                                     
Create Data Guard status (Standby        January 23, 2025 05:15:56 UTC            January 23, 2025 05:16:09 UTC            Success        
site) (Host:                                                                                                                              
host2/Job ID:                                                                                                                    
3109148f-9ef8-4914-ab43-adab4851e126)

Example 16-128 Sample JSON for configuring Oracle Data Guard with two standby databases

To configure two standby databases using JSON file, you must specify two replicationGroups sections, where sourceEndpoints corresponds to the information about the primary database and targetEndPoints in each replicationGroups section corresponds to each standby database. For example: 

{
  "name": "dgname",
  "protectionMode": "MAX_PERFORMANCE",
  "databaseName": "vmdb1",
  "enableActiveDg": false,
  "databaseName": "tdb", ==> newly added field
  "standbyEndpoints": [ ==> newly added field
        {
            "name": "endpoint_test",
            "dcsUserName": "oda-admin"
        }
    ]
  "replicationGroups": [
    {
      "sourceEndPoints": [
        {
          "databaseUniqueName": "vmdb1",
          "ipAddress": "xx.xx.xx.xx",
          "hostName": "host_name",
          "listenerPort": 1521
        }
      ],
      "targetEndPoints": [
        {
          "databaseUniqueName": "bvmdb1",
          "ipAddress": "xx.xx.xx.xx",
          "hostName": "host_name,
          "listenerPort": 1521
        }
      ],
      "transportType": "ASYNC"
    },
    {
      "sourceEndPoints": [
        {
          "databaseUniqueName": "vmdb1",
          "ipAddress": "xx.xx.xx.xx",
          "hostName": "host_name",
          "listenerPort": 1521
        }
      ],
      "targetEndPoints": [
        {
          "databaseUniqueName": "avmdb1",
          "ipAddress": "xx.xx.xx.xx",
          "hostName": "host_name",
          "listenerPort": 1521
        }
      ],
      "transportType": "ASYNC"
    }
  ]
}

Parent topic: odacli Oracle Data Guard Commands

 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 [-f]

Parameters

Parameter Description
--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output. The default is false.
--id, -i

Specifies the Oracle Data Guard Configuration ID.
--force, -f

Forces the deconfiguration of Oracle Data Guard.

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-129 Deconfiguring Oracle Data Guard with one standby database

# /opt/oracle/dcs/bin/odacli deconfigure-dataguard --id "ee22f382-b04e-4658-a6c7-ab00fc7e3270"
Number of standby databases (enter 1 or 2 | default: 1):
Standby 1 site address: standby1
BUI username for Standby site standby1. If Multi-user Access/Multi-user Access Passwordless is not enabled on Standby site standby1, enter 'oda-admin'; otherwise, enter the name of the user who has irestored the Standby database (default: oda-admin): oda-admin
BUI password for Standby site standby1:
Password for root user on Standby site standby1:
Standby database will be deleted after Data Guard configuration is removed. Ignore warning and proceed with Data Guard deconfiguration? (Y/N): Y
{
  "jobId" : "0613c649-3da6-463a-8359-2f6d7d17399b",
  "status" : "Created",
  "message" : "",
  "reports" : [ ],
  "createTimestamp" : "January 23, 2025 03:42:41 AM UTC",
  "resourceList" : [ ],
  "description" : "DG Deconfig service",
  "updatedTime" : "January 23, 2025 03:42:41 AM UTC",
  "jobType" : null,
  "cpsMetadata" : null
}
 
[root@n1 oda]# /opt/oracle/dcs/bin/odacli describe-job -i 0613c649-3da6-463a-8359-2f6d7d17399b
 
Job details                                                     
----------------------------------------------------------------
                     ID:  0613c649-3da6-463a-8359-2f6d7d17399b
            Description:  DG Deconfig service
                 Status:  Success
                Created:  January 23, 2025 03:42:41 UTC
                Message: 
 
Task Name                                Start Time                               End Time                                 Status         
---------------------------------------- ---------------------------------------- ---------------------------------------- ----------------
De-configure Dataguard (Primary site)    January 23, 2025 03:42:44 UTC            January 23, 2025 03:44:22 UTC            Success        
(Host: phxdbfzp22/Job ID:                                                                                                                 
93758e42-2cf4-4aa1-949e-b6018c1c35d7)                                                                                                     
Delete Dataguard Status(Primary site)    January 23, 2025 03:44:22 UTC            January 23, 2025 03:44:28 UTC            Success        
(Host: phxdbfzp22/Job ID:                                                                                                                 
e090af71-9c6d-4d14-8e16-3c64c4aa7f14)                                                                                                     
Delete Dataguard Status(Standby site)    January 23, 2025 03:44:28 UTC            January 23, 2025 03:44:36 UTC            Success        
(Host:                                                                                                                                    
standby1           
/Job ID:                                                                                                                    
a5bf022a-c1ca-4c1a-8747-4ff6a0e938c0)                                                                                                     
Delete Standby Database (Standby site)   January 23, 2025 03:44:36 UTC            January 23, 2025 03:46:07 UTC            Success        
(Host:                                                                                                                                    
standby1           
/Job ID:                                                                                                                    
f93b1f26-69d9-4690-84f9-4c0c9947423a)

Parent topic: odacli Oracle Data Guard Commands

 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 -i [-h] [-j] [-s]

Parameters

Parameter Description
--id, -i

(Mandatory) Specifies the Oracle Data Guard Status ID.
--synchronous, -s

(Optional) Obtains the latest Oracle Data Guard status synchronously.
--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output. The default is false.

Usage Notes

Example 16-130 Viewing Oracle Data Guard configuration status

# odacli describe-dataguardstatus -i 1b13fddf-1648-44e9-b928-7aa6b36b783f -j
{
  "id" : "1b13fddf-1648-44e9-b928-7aa6b36b783f",
  "name" : "dgname",
  "databaseId" : "216697dd-c590-4807-8e15-98afc8624fa4",
  "protectionMode" : "MAX_PROTECTION",
  "role" : "STANDBY",
  "replicationGroups" : [ {
    "sourceEndPoints" : [ {
      "endpointType" : "PRIMARY",
      "databaseUniqueName" : "ctest",
      "ipAddress" : "xx.xx.xx.xx",
      "hostName" : "n1",
      "listenerPort" : 1521,
      "serviceName" : "serice_name",
      "sysPassword" : null,
      "openMode" : null,
      "state" : {
        "status" : "ENABLED"
      }
    } ],
    "targetEndPoints" : [ {
      "endpointType" : "STANDBY",
      "databaseUniqueName" : "ptest",
      "ipAddress" : "xx.xx.xx.xx",
      "hostName" : "n2",
      "listenerPort" : 1521,
      "serviceName" : "pservice_name",
      "sysPassword" : null,
      "openMode" : "READ ONLY WITH APPLY",
      "state" : {
        "status" : "ENABLED"
      }
    } ],
    "transportType" : "SYNC",
    "applyLag" : "0 seconds",
    "transportLag" : "0 seconds",
    "approximateRoleTransitionTime" : "30 seconds",
    "applyRate" : "3.00 KByte/s"
  }, {
    "sourceEndPoints" : [ {
      "endpointType" : "PRIMARY",
      "databaseUniqueName" : "ctest",
      "ipAddress" : "xx.xx.xx.xx",
      "hostName" : "n1",
      "listenerPort" : 1521,
      "serviceName" : "servic_nae",
      "sysPassword" : null,
      "openMode" : null,
      "state" : {
        "status" : "ENABLED"
      }
    } ],
    "targetEndPoints" : [ {
      "endpointType" : "STANDBY",
      "databaseUniqueName" : "dtest",
      "ipAddress" : "xx.xx.xx.xx",
      "hostName" : "host_name",
      "listenerPort" : 1521,
      "serviceName" : "service_name",
      "sysPassword" : null,
      "openMode" : null,
      "state" : {
        "status" : "ENABLED"
      }
    } ],
    "transportType" : "ASYNC",
    "applyLag" : "0 seconds",
    "transportLag" : "0 seconds",
    "approximateRoleTransitionTime" : "30 seconds",
    "applyRate" : "15.00 KByte/s"
  } ],
  "observers" : [ ],
  "createTime" : "November 22, 2024 23:47:13 CET",
  "state" : {
    "status" : "CONFIGURED"
  },
  "updatedTime" : "November 23, 2024 00:12:24 CET"
}

Parent topic: odacli Oracle Data Guard Commands

 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.
--id, -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-131 Performing Failover Oracle Data Guard

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

Parent topic: odacli Oracle Data Guard Commands

 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 [-s] [-h] [-j]

Parameters

Parameter Description
--synchronous, -s

(Optional) Obtains the latest Oracle Data Guard status synchronously.
--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output. The default is false.

Usage Notes

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

# odacli list-dataguardstatus
Updated about 5 second(s) ago
It can take up to several minutes to update Data Guard status. You can re-run the command to obtain the latest status.
ID                                       Name                             Database Name        Role       Protection Mode     Status   
---------------------------------------- -------------------------------- -------------------- ---------- ------------------ ----------
1b13fddf-1648-44e9-b928-7aa6b36b783f     dgname                           test                 PRIMARY    MAX_PROTECTION     CONFIGURED

Parent topic: odacli Oracle Data Guard Commands

 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.
--id, -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-133 Performing reinstate operation on Oracle Data Guard

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

Parent topic: odacli Oracle Data Guard Commands

 odacli register-dataguard

Use the command odacli register-dataguard to register Oracle Data Guard with Oracle Database Appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli register-dataguard [-h] [-j] [-r json_input_file]

Parameters

Parameter Description
--requestjson, -r

Specifies the JSON input for creation of Oracle Data Guard configuration in the advanced option.
--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output. The default is false.

Parent topic: odacli Oracle Data Guard Commands

 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.
--id, -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-134 Switching over Oracle Data Guard

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

Parent topic: odacli Oracle Data Guard Commands

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.
  • odacli modify-cpucore
    Use the odacli modify-cpucore command to enable the number of CPU cores in the system.

Parent topic: Oracle Database Appliance Command-Line Interface

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-135 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

Parent topic: odacli CPU Core Commands

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-136 Displaying the Current Core Configuration

# odacli describe-cpucore  

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

Parent topic: odacli CPU Core Commands

odacli modify-cpucore

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

 odacli modify-cpucore  -c cores [-j] [-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.

--json, -j

(Optional) Displays JSON output.

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-137 Enabling CPU Cores

The following command enables 8 CPU cores.

# odacli modify-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" : "December 8, 2024 10:29:37 AM UTC",
  "resourceList" : [ ],
  "description" : "CPU cores service update",
  "updatedTime" : "December 8, 2024 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

Parent topic: odacli CPU Core Commands

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.

Parent topic: Oracle Database Appliance Command-Line Interface

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]  [-urc] [-j] [-h]

Parameters

Parameter Description

--name, -n

Specifies the CPU Pool name.

--cores, -c

Specifies the CPU Pool cores.

--bm, -bm

(Optional) Specifies the CPU Pool as Bare Metal.

--vm, -vm

(Optional) Specifies the CPU Pool as Virtual Machine.

--dbsystem, -dbs

(Optional) Specifies the CPU Pool type as DB System.

--socket, -s

(Optional) Specifies the socket to use. If not specified, then use all available sockets.

--use-reserved-cores, -urc

(Optional) Specifies to use reserved CPU cores.

--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 to guest machines. VM CPU pools can be assigned to multiple VMs.
  • Attach dbsystem CPU pool to DB systems. dbsystem CPU pool can be assigned to multiple DB systems. After you create a dbsystem CPU pool, you can create a new DB system 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 DB system.
  • 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 must be 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.
  • 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

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

Parent topic: odacli CPU Pool Commands for Bare Metal and KVM

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 use odacli remap-cpupools command, after updating the bare metal CPU cores with the command odacli modify-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

Parent topic: odacli CPU Pool Commands for Bare Metal and KVM

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

Parent topic: odacli CPU Pool Commands for Bare Metal and KVM

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

Parent topic: odacli CPU Pool Commands for Bare Metal and KVM

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

Parent topic: odacli CPU Pool Commands for Bare Metal and KVM

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

Parent topic: odacli CPU Pool Commands for Bare Metal and 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.

Syntax

 odacli list-auditrecords -du dcs-username -f from_date-range -l latest -nn node_name -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-name, -nn

(Optional) Specifies the node name.

--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

Parent topic: odacli CPU Pool Commands for Bare Metal and KVM

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'

Parent topic: odacli CPU Pool Commands for Bare Metal and KVM

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.

Parent topic: Oracle Database Appliance Command-Line Interface

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] [-dh] [-nh] [-ro] [-s] [-t] [-j] [-f] [-nn] [-p] [-h] [-ha|-no-ha] [-cp]

Parameters

Parameter Description

--databaseUniqueName, -u

Defines a unique name for the database.

--dbname, -n

Defines the name given to the new database (dbname.)

--dbhomeid, -dh

Specifies the database home ID of the new database.

--newhome, -nh

Specifies that a new database home must be created.

--readonly, -ro

(Optional) Specifies to open the database in read-only mode.

--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-ha, -no-ha

(Optional) Disables High Availability for single-instance Oracle Database 19c and later.

--enable-ha, -ha

(Optional) Enables High Availability for single-instance Oracle Database 19c and later.

--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 be opened in either read-write mode, or read-only mode if it is a primary database. A standby database can be in mounted or read-only open mode.

  • 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.
  • All data files of the source database must be in the same Oracle ACFS directory.

Example 16-138 Cloning a Database in a new database home

# odacli list-databases
 
ID                                       DB Name    DB Type  DB Version           CDB        Class    Shape    Storage    Status        DbHomeID
---------------------------------------- ---------- -------- -------------------- ---------- -------- -------- ---------- ------------ ----------------------------------------
bb06935b-384d-482f-b494-45d368d2122a     mydb       SI       19.16.0.0.220719     true       OLTP     odb1     ACFS       CONFIGURED   542032e5-a76c-4d66-92e1-bb297ec6192d
a03b5971-bee5-4d9a-b003-009df6f018f6     primary    SI       19.16.0.0.220719     false      OLTP     odb1     ACFS       CONFIGURED   618b26d7-a49b-452f-a14b-cfc2c79d0555
a5173f68-6b5c-491f-b8b4-05bce0e7ec20     chome1     SI       19.16.0.0.220719     false      OLTP     odb1     ACFS       CONFIGURED   6339e2fc-7ae7-4de2-ac3c-9f5b2eaec131  
 
# odacli list-dbhomes
 
ID                                       Name                 DB Version                               Home Location                                 Status
---------------------------------------- -------------------- ---------------------------------------- --------------------------------------------- ----------
542032e5-a76c-4d66-92e1-bb297ec6192d     OraDB19000_home1     19.16.0.0.220719                         /u01/app/odaorahome/oracle/product/19.0.0.0/dbhome_1 CONFIGURED
6339e2fc-7ae7-4de2-ac3c-9f5b2eaec131     OraDB19000_home2     19.16.0.0.220719                         /u01/app/odaorahome/oracle/product/19.0.0.0/dbhome_2 CONFIGURED
618b26d7-a49b-452f-a14b-cfc2c79d0555     OraDB19000_home3     19.16.0.0.220719                         /u01/app/odaorahome/oracle/product/19.0.0.0/dbhome_3 CONFIGURED
 
# odacli clone-database -n chome4  -u chome4 -f primary -nh
Enter SYS user password:
Retype SYS user password:
 
Job details
----------------------------------------------------------------
                     ID:  f3052b47-e9b6-4825-bef3-91635db4f255
            Description:  Snap Database service creation with db name: chome4
                 Status:  Created
                Created:  August 4, 2022 12:23:41 PM UTC
                Message:
 
Task Name                                Start Time                          End Time                            Status
---------------------------------------- ----------------------------------- ----------------------------------- ----------
  
# odacli describe-job -i f3052b47-e9b6-4825-bef3-91635db4f255
 
Job details
----------------------------------------------------------------
                     ID:  f3052b47-e9b6-4825-bef3-91635db4f255
            Description:  Snap Database service creation with db name: chome4
                 Status:  Success
                Created:  August 4, 2022 12:23:41 PM UTC
                Message:
 
Task Name                                Start Time                          End Time                            Status
---------------------------------------- ----------------------------------- ----------------------------------- ----------
Validate HugeSpaces                      August 4, 2022 12:24:00 PM UTC      August 4, 2022 12:24:00 PM UTC      Success
Validate source database                 August 4, 2022 12:24:00 PM UTC      August 4, 2022 12:24:11 PM UTC      Success
Setting up ssh equivalance               August 4, 2022 12:24:11 PM UTC      August 4, 2022 12:24:12 PM UTC      Success
Creating volume rdochome4                August 4, 2022 12:24:12 PM UTC      August 4, 2022 12:24:28 PM UTC      Success
Creating ACFS filesystem for RECO        August 4, 2022 12:24:28 PM UTC      August 4, 2022 12:24:46 PM UTC      Success
Database home creation                   August 4, 2022 12:24:46 PM UTC      August 4, 2022 12:28:06 PM UTC      Success <========== New task
Creating ACFS database home              August 4, 2022 12:24:46 PM UTC      August 4, 2022 12:24:46 PM UTC      Success <========== New task
Validating dbHome available space        August 4, 2022 12:24:46 PM UTC      August 4, 2022 12:24:46 PM UTC      Success <========== New task
Creating DbHome Directory                August 4, 2022 12:24:46 PM UTC      August 4, 2022 12:24:46 PM UTC      Success <========== New task
Create required directories              August 4, 2022 12:24:46 PM UTC      August 4, 2022 12:24:46 PM UTC      Success <========== New task
Extract DB clone                         August 4, 2022 12:24:46 PM UTC      August 4, 2022 12:26:14 PM UTC      Success <========== New task
ProvDbHome by using RHP                  August 4, 2022 12:26:14 PM UTC      August 4, 2022 12:27:43 PM UTC      Success <========== New task
Enable DB options                        August 4, 2022 12:27:43 PM UTC      August 4, 2022 12:28:02 PM UTC      Success <========== New task
Creating wallet for DB Client            August 4, 2022 12:28:06 PM UTC      August 4, 2022 12:28:06 PM UTC      Success <========== New task
Audit directory creation                 August 4, 2022 12:28:06 PM UTC      August 4, 2022 12:28:06 PM UTC      Success <========== New task
Creation of snapshot database            August 4, 2022 12:28:06 PM UTC      August 4, 2022 12:32:46 PM UTC      Success
Removing Disabled Redo Threads           August 4, 2022 12:32:46 PM UTC      August 4, 2022 12:32:47 PM UTC      Success
Creation of SPFile for Shared location   August 4, 2022 12:32:50 PM UTC      August 4, 2022 12:32:56 PM UTC      Success
Delete SPFile from local location        August 4, 2022 12:32:56 PM UTC      August 4, 2022 12:32:56 PM UTC      Success
Register DB with clusterware             August 4, 2022 12:32:56 PM UTC      August 4, 2022 12:34:23 PM UTC      Success
Set SysPassword and Create PwFile        August 4, 2022 12:34:23 PM UTC      August 4, 2022 12:34:27 PM UTC      Success
Creating pfile                           August 4, 2022 12:34:27 PM UTC      August 4, 2022 12:34:28 PM UTC      Success
Disabling external references            August 4, 2022 12:34:28 PM UTC      August 4, 2022 12:34:29 PM UTC      Success
Set CPU pool                             August 4, 2022 12:34:29 PM UTC      August 4, 2022 12:34:29 PM UTC      Success
Enabling supplemental log data           August 4, 2022 12:35:45 PM UTC      August 4, 2022 12:35:46 PM UTC      Success
Enabling blockchange tracking            August 4, 2022 12:35:46 PM UTC      August 4, 2022 12:35:47 PM UTC      Success
Enabling flashback                       August 4, 2022 12:35:47 PM UTC      August 4, 2022 12:35:48 PM UTC      Success
Copy Pwfile to Shared Storage            August 4, 2022 12:35:48 PM UTC      August 4, 2022 12:35:51 PM UTC      Success
Create tns entry                         August 4, 2022 12:35:51 PM UTC      August 4, 2022 12:35:52 PM UTC      Success
Reset Associated Networks                August 4, 2022 12:35:52 PM UTC      August 4, 2022 12:35:55 PM UTC      Success
Set log_archive_dest for Database        August 4, 2022 12:35:55 PM UTC      August 4, 2022 12:35:58 PM UTC      Success
 
# odacli list-databases
 
ID                                       DB Name    DB Type  DB Version           CDB        Class    Shape    Storage    Status        DbHomeID
---------------------------------------- ---------- -------- -------------------- ---------- -------- -------- ---------- ------------ ----------------------------------------
bb06935b-384d-482f-b494-45d368d2122a     mydb       SI       19.16.0.0.220719     true       OLTP     odb1     ACFS       CONFIGURED   542032e5-a76c-4d66-92e1-bb297ec6192d
a03b5971-bee5-4d9a-b003-009df6f018f6     primary    SI       19.16.0.0.220719     false      OLTP     odb1     ACFS       CONFIGURED   618b26d7-a49b-452f-a14b-cfc2c79d0555
a5173f68-6b5c-491f-b8b4-05bce0e7ec20     chome1     SI       19.16.0.0.220719     false      OLTP     odb1     ACFS       CONFIGURED   6339e2fc-7ae7-4de2-ac3c-9f5b2eaec131
6bf06951-d89f-4acb-bb93-39ebdfcec4d7     chome4     SI       19.16.0.0.220719     false      OLTP     odb1     ACFS       CONFIGURED   31693275-85f5-4932-8ad6-8abe8c93ce46  
 
# odacli list-dbhomes
 
ID                                       Name                 DB Version                               Home Location                                 Status
---------------------------------------- -------------------- ---------------------------------------- --------------------------------------------- ----------
542032e5-a76c-4d66-92e1-bb297ec6192d     OraDB19000_home1     19.16.0.0.220719                         /u01/app/odaorahome/oracle/product/19.0.0.0/dbhome_1 CONFIGURED
6339e2fc-7ae7-4de2-ac3c-9f5b2eaec131     OraDB19000_home2     19.16.0.0.220719                         /u01/app/odaorahome/oracle/product/19.0.0.0/dbhome_2 CONFIGURED
618b26d7-a49b-452f-a14b-cfc2c79d0555     OraDB19000_home3     19.16.0.0.220719                         /u01/app/odaorahome/oracle/product/19.0.0.0/dbhome_3 CONFIGURED
31693275-85f5-4932-8ad6-8abe8c93ce46     OraDB19000_home4     19.16.0.0.220719                         /u01/app/odaorahome/oracle/product/19.0.0.0/dbhome_4 CONFIGURED <=== New DB Home
 
 
# odacli describe-database -n chome4
Database details
----------------------------------------------------------------
                     ID: 6bf06951-d89f-4acb-bb93-39ebdfcec4d7
            Description: chome4
                DB Name: chome4
             DB Version: 19.16.0.0.220719
                DB Type: SI
                DB Role: PRIMARY
    DB Target Node Name: scaoda8m002
             DB Edition: EE
                   DBID: 2169245064
 Instance Only Database: false
                    CDB: false
               PDB Name:
    PDB Admin User Name:
      High Availability: false
                  Class: OLTP
                  Shape: odb1
                Storage: ACFS
          DB Redundancy:
           CharacterSet: AL32UTF8
  National CharacterSet: AL16UTF16
               Language: AMERICAN
              Territory: AMERICA
                Home ID: 31693275-85f5-4932-8ad6-8abe8c93ce46 <====================== OraDB19000_home4
        Console Enabled: false
  TDE Wallet Management:
            TDE Enabled: false
     Level 0 Backup Day:
     AutoBackup Enabled: false
                Created: August 4, 2022 12:23:41 PM UTC
         DB Domain Name: example.com
    Associated Networks: Public-network
          CPU Pool Name:

Example 16-139 Cloning a Database in an existing database home

# odacli list-dbhomes
 
ID                                       Name                 DB Version                               Home Location                                 Status
---------------------------------------- -------------------- ---------------------------------------- --------------------------------------------- ----------
542032e5-a76c-4d66-92e1-bb297ec6192d     OraDB19000_home1     19.16.0.0.220719                         /u01/app/odaorahome/oracle/product/19.0.0.0/dbhome_1 CONFIGURED
 
# odacli create-dbhome -v 19.16.0.0.220719

# odacli describe-job -i e2e73a4a-cb54-4bef-90ba-e6d6aeff594a
 
 Job details
----------------------------------------------------------------
                     ID:  e2e73a4a-cb54-4bef-90ba-e6d6aeff594a
            Description:  Database Home OraDB19000_home2 creation with version :19.16.0.0.220719
                 Status:  Success
                Created:  August 4, 2022 11:00:48 AM UTC
                Message:  Create Database Home
 
Task Name                                Start Time                          End Time                            Status
---------------------------------------- ----------------------------------- ----------------------------------- ----------
Setting up ssh equivalance               August 4, 2022 11:01:04 AM UTC      August 4, 2022 11:01:05 AM UTC      Success
Setting up ssh equivalance               August 4, 2022 11:01:05 AM UTC      August 4, 2022 11:01:06 AM UTC      Success
Creating ACFS database home              August 4, 2022 11:01:06 AM UTC      August 4, 2022 11:01:06 AM UTC      Success
Validating dbHome available space        August 4, 2022 11:01:06 AM UTC      August 4, 2022 11:01:06 AM UTC      Success
Creating DbHome Directory                August 4, 2022 11:01:06 AM UTC      August 4, 2022 11:01:06 AM UTC      Success
Create required directories              August 4, 2022 11:01:06 AM UTC      August 4, 2022 11:01:06 AM UTC      Success
Extract DB clone                         August 4, 2022 11:01:06 AM UTC      August 4, 2022 11:02:35 AM UTC      Success
ProvDbHome by using RHP                  August 4, 2022 11:02:35 AM UTC      August 4, 2022 11:04:06 AM UTC      Success
Enable DB options                        August 4, 2022 11:04:06 AM UTC      August 4, 2022 11:04:25 AM UTC      Success
Creating wallet for DB Client            August 4, 2022 11:04:29 AM UTC      August 4, 2022 11:04:29 AM UTC      Success
 
# odacli list-dbhomes
 
ID                                       Name                 DB Version                               Home Location                                 Status
---------------------------------------- -------------------- ---------------------------------------- --------------------------------------------- ----------
542032e5-a76c-4d66-92e1-bb297ec6192d     OraDB19000_home1     19.16.0.0.220719                         /u01/app/odaorahome/oracle/product/19.0.0.0/dbhome_1 CONFIGURED
6339e2fc-7ae7-4de2-ac3c-9f5b2eaec131     OraDB19000_home2     19.16.0.0.220719                         /u01/app/odaorahome/oracle/product/19.0.0.0/dbhome_2 CONFIGURED
 
 
# odacli clone-database -n chome1 -u chome1 -f primary -dh 6339e2fc-7ae7-4de2-ac3c-9f5b2eaec131 <========== New DB Home OraDB19000_home2  [root@scaoda8m002 bin]# odacli describe-job -i ed76ad28-aff6-47c7-9233-6ef2f7c3e8cd
 
Job details
----------------------------------------------------------------
                     ID:  ed76ad28-aff6-47c7-9233-6ef2f7c3e8cd
            Description:  Snap Database service creation with db name: chome1
                 Status:  Success
                Created:  August 4, 2022 12:02:54 PM UTC
                Message:
 
Task Name                                Start Time                          End Time                            Status
---------------------------------------- ----------------------------------- ----------------------------------- ----------
Validate HugeSpaces                      August 4, 2022 12:02:59 PM UTC      August 4, 2022 12:03:00 PM UTC      Success
Validate source database                 August 4, 2022 12:03:00 PM UTC      August 4, 2022 12:03:11 PM UTC      Success
Setting up ssh equivalance               August 4, 2022 12:03:11 PM UTC      August 4, 2022 12:03:11 PM UTC      Success
Creating volume rdochome1                August 4, 2022 12:03:11 PM UTC      August 4, 2022 12:03:27 PM UTC      Success
Creating ACFS filesystem for RECO        August 4, 2022 12:03:27 PM UTC      August 4, 2022 12:03:45 PM UTC      Success
Audit directory creation                 August 4, 2022 12:03:45 PM UTC      August 4, 2022 12:03:45 PM UTC      Success
Creation of snapshot database            August 4, 2022 12:03:45 PM UTC      August 4, 2022 12:08:25 PM UTC      Success
Removing Disabled Redo Threads           August 4, 2022 12:08:25 PM UTC      August 4, 2022 12:08:26 PM UTC      Success
Creation of SPFile for Shared location   August 4, 2022 12:08:28 PM UTC      August 4, 2022 12:08:35 PM UTC      Success
Delete SPFile from local location        August 4, 2022 12:08:35 PM UTC      August 4, 2022 12:08:35 PM UTC      Success
Register DB with clusterware             August 4, 2022 12:08:35 PM UTC      August 4, 2022 12:10:00 PM UTC      Success
Set SysPassword and Create PwFile        August 4, 2022 12:10:00 PM UTC      August 4, 2022 12:10:03 PM UTC      Success
Creating pfile                           August 4, 2022 12:10:03 PM UTC      August 4, 2022 12:10:04 PM UTC      Success
Disabling external references            August 4, 2022 12:10:04 PM UTC      August 4, 2022 12:10:06 PM UTC      Success
Set CPU pool                             August 4, 2022 12:10:06 PM UTC      August 4, 2022 12:10:06 PM UTC      Success
Enabling supplemental log data           August 4, 2022 12:11:18 PM UTC      August 4, 2022 12:11:20 PM UTC      Success
Enabling blockchange tracking            August 4, 2022 12:11:20 PM UTC      August 4, 2022 12:11:21 PM UTC      Success
Enabling flashback                       August 4, 2022 12:11:21 PM UTC      August 4, 2022 12:11:22 PM UTC      Success
Copy Pwfile to Shared Storage            August 4, 2022 12:11:22 PM UTC      August 4, 2022 12:11:25 PM UTC      Success
Create tns entry                         August 4, 2022 12:11:25 PM UTC      August 4, 2022 12:11:26 PM UTC      Success
Reset Associated Networks                August 4, 2022 12:11:26 PM UTC      August 4, 2022 12:11:29 PM UTC      Success
Set log_archive_dest for Database        August 4, 2022 12:11:29 PM UTC      August 4, 2022 12:11:32 PM UTC      Success
 
# odacli list-databases
 
ID                                       DB Name    DB Type  DB Version           CDB        Class    Shape    Storage    Status        DbHomeID
---------------------------------------- ---------- -------- -------------------- ---------- -------- -------- ---------- ------------ ----------------------------------------
bb06935b-384d-482f-b494-45d368d2122a     mydb       SI       19.16.0.0.220719     true       OLTP     odb1     ACFS       CONFIGURED   542032e5-a76c-4d66-92e1-bb297ec6192d
a03b5971-bee5-4d9a-b003-009df6f018f6     primary    SI       19.16.0.0.220719     false      OLTP     odb1     ACFS       CONFIGURED   618b26d7-a49b-452f-a14b-cfc2c79d0555
a5173f68-6b5c-491f-b8b4-05bce0e7ec20     chome1     SI       19.16.0.0.220719     false      OLTP     odb1     ACFS       CONFIGURED   6339e2fc-7ae7-4de2-ac3c-9f5b2eaec131 <============== CLONE DB CREATED SUCCESSFULLY  

# odacli describe-database -n chome1
Database details
----------------------------------------------------------------
                     ID: a5173f68-6b5c-491f-b8b4-05bce0e7ec20
            Description: chome1
                DB Name: chome1
             DB Version: 19.16.0.0.220719
                DB Type: SI
                DB Role: PRIMARY
    DB Target Node Name: scaoda8m002
             DB Edition: EE
                   DBID: 2639447957
 Instance Only Database: false
                    CDB: false
               PDB Name:
    PDB Admin User Name:
      High Availability: false
                  Class: OLTP
                  Shape: odb1
                Storage: ACFS
          DB Redundancy:
           CharacterSet: AL32UTF8
  National CharacterSet: AL16UTF16
               Language: AMERICAN
              Territory: AMERICA
                Home ID: 6339e2fc-7ae7-4de2-ac3c-9f5b2eaec131
        Console Enabled: false
  TDE Wallet Management:
            TDE Enabled: false
     Level 0 Backup Day:
     AutoBackup Enabled: false
                Created: August 4, 2022 12:02:54 PM UTC
         DB Domain Name: example.com
    Associated Networks: Public-network
          CPU Pool Name:

Example 16-140 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 SYS user password:
Retype SYS user password:

Job details
----------------------------------------------------------------
                     ID:  74a80586-3523-4367-93a0-38401647c5a0
            Description:  Snap Database service creation with db name: dbclone
                 Status:  Created
                Created:  August 09, 2022 10:25:40 AM UTC
                Message:

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

Example 16-141 Cloning a Database and associating it with a different CPU pool

# odacli clone-database -f dbcpupin -n db1clone -u db1cloneUnique -cp testdbcpupool2
Enter SYS user password:
Retype SYS user password:

Job details
----------------------------------------------------------------
                     ID:  2fe285b5-2e3b-4e80-9121-e7c8380952b3
            Description:  Snap Database service creation with db name: db1clone
                 Status:  Created
                Created:  August 09, 2022 10:36:55 AM UTC
                Message:

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

Example 16-142 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:

Example 16-143 Cloning a database and opening the clone in read only mode

# odacli clone-database -n clonedb -u clonedb -f sourcedb -ro
Enter SYS user password:
Retype SYS user password:

The task Open Clone DB in READ ONLY mode is displayed as the last task in the description of the above job.

Related Topics

Parent topic: odacli Database Commands

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] [-tn node_name] [-h] [-rd] [-ha|-no-ha] [-t] [-cp] [-osc] [-kt] [-ocp]

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.

--keystore-type, -kt

Specifies the type of keystore which stores the TDE master encryption key. The value can be software or okv. The default is software.

--okv-server-config, -osc

Specifies the name of the Oracle Key Vault server configuration which serves as the metadata of the Oracle Key Vault user credentials. This option must be provided only when the --keystore-type,-kt option is specified..

--okvclient-path, -ocp

Specifies the absolute path to the okvclient.jar file. Multiple values must be comma-separated. Cannot be used with the --okv-server-config,-osc option.

--target-node, -tn

(Optional) Specifies the target node name (applicable only for Oracle RAC One Node Database and single-instance Oracle Database, where supported).

--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.

--disable-ha, -no-ha

(Optional) Disables High Availability for single-instance Oracle Database 19c and later.

--enable-ha, -ha

(Optional) Enables High Availability for single-instance Oracle Database 19c and later. The --enable-ha,-ha option is the default for single-instance databases on high availability deployments.

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. Underscores are not permitted only if the --dbname is set to RACOne, as it is used as a delimiter to identify the database instance. 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 19c and 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 on 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.24.0.0, 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.

  • You must specify either the Oracle Key Vault server configuration or the absolute path of the okvclient.jar file.
  • You cannot configure Oracle Key Vault on Oracle RAC One database and single-instance database with high-availability enabled.
  • For Oracle Key Vault configuration, you must specify one okvclient.jar file path for single-instance database. For Oracle RAC database, you must specify multiple okvclient.jar file path.
  • For TDE-enabled database configuration, if the keystore type is not specified, then, by default, the keystore is software keystore.

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-144 Creating a TDE-Enabled Database with Software Keystore

# 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-145 Creating a Database in Interactive Mode

This example creates a 19.26.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, 2024 03:54:03 AM EDT",
   "description" : "Database service creation with db name: hrdb",
   "updatedTime" : "December 8, 2024 03:54:03 AM EDT" 
}

Example 16-146 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.26.0.0.0       
# odacli create-database -n hrmsdb2 -v 19.26.0.0.250121

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

# odacli create-database -n hrmsdb3 -v 19.26.0.0.250121

Example 16-147 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

Example 16-148 Creating a TDE-Enabled Database with Credentials of a User on Oracle Key Vault

An example to create a database dbokv1 which uses Oracle Key Vault credentials represented by Oracle Key Vault server configuration okvobj1 is as follows: 

odacli create-database -n dbokv1 -t -osc okvobj1 -kt OKV
Enter SYS and SYSTEM user password:
Enter SYS and SYSTEM user password:

Example 16-149 Creating a TDE-Enabled Database with keys stored in Oracle Key Vault

Create an Oracle RAC database okvdbrac without using the Oracle Key Vault server configuration object. Specify the path to the okvclient.jar file for the local database instance first, followed by the path to okvclient.jar file for the remote database instance in the request.

odacli create-database -n okvdbrac -y RAC -t -kt OKV -ocp /tmp/okvracdb1/okvclient.jar,/tmp/okvracdb2/okvclient.jar
Enter SYS and SYSTEM user password:
Retype SYS and SYSTEM user password:
Enter TDE wallet password:
Retype TDE wallet password:
 
Job details                                                     
----------------------------------------------------------------
                     ID:  cb611ec2-ff87-44f9-a79b-3ab1a290644f
            Description:  Database service creation with DB name: okvdbrac
                 Status:  Created
                Created:  October 20, 2024 6:13:28 AM PDT
                Message: 
 
Task Name                                Start Time                               End Time                                 Status         
---------------------------------------- ---------------------------------------- ---------------------------------------- ----------------
 
 
odacli describe-job -i cb611ec2-ff87-44f9-a79b-3ab1a290644f
 
Job details                                                     
----------------------------------------------------------------
                     ID:  cb611ec2-ff87-44f9-a79b-3ab1a290644f
            Description:  Database service creation with DB name: okvdbrac
                 Status:  Success
                Created:  October 20, 2024 6:13:28 AM PDT
                Message: 
 
Task Name                                Node Name                 Start Time                               End Time                                 Status         
---------------------------------------- ------------------------- ---------------------------------------- ---------------------------------------- ----------------
Validating dbHome available space        n1             October 20, 2024 6:13:49 AM PDT          October 20, 2024 6:13:49 AM PDT          Success        
Validating dbHome available space        n2             October 20, 2024 6:13:49 AM PDT          October 20, 2024 6:13:49 AM PDT          Success        
Setting up SSH equivalence               n1             October 20, 2024 6:13:51 AM PDT          October 20, 2024 6:13:54 AM PDT          Success        
Setting up SSH equivalence               n1             October 20, 2024 6:13:54 AM PDT          October 20, 2024 6:13:57 AM PDT          Success        
Creating ACFS database home              n1             October 20, 2024 6:13:58 AM PDT          October 20, 2024 6:13:58 AM PDT          Success        
Validating dbHome available space        n1             October 20, 2024 6:13:59 AM PDT          October 20, 2024 6:13:59 AM PDT          Success 
.
.
.
Setting TDE Master Encryption Key        n1             October 20, 2024 6:34:15 AM PDT          October 20, 2024 6:34:56 AM PDT          Success        
Create Users tablespace                  n1             October 20, 2024 6:34:57 AM PDT          October 20, 2024 6:34:59 AM PDT          Success        
Clear all listeners from Database        n1             October 20, 2024 6:35:00 AM PDT          October 20, 2024 6:35:01 AM PDT          Success        
Deleting OKV Client Software Jar         n1             October 20, 2024 6:35:03 AM PDT          October 20, 2024 6:35:04 AM PDT          Success        
Deleting OKV Client Software Jar         n2             October 20, 2024 6:35:04 AM PDT          October 20, 2024 6:35:04 AM PDT          Success        
Encrypt all Tablespaces                  n1             October 20, 2024 6:35:04 AM PDT          October 20, 2024 6:36:15 AM PDT          Success

Parent topic: odacli Database Commands

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 -n name [-h] [-j] [-fd]

Parameters

Parameter Description

--id, -i

Identifies the database home identifier (ID) to display.

Use the odacli list-databases command to obtain the --id.

--name, -n

Defines the database name.

--force, -fd

(Optional) Forces the delete operation.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Usage

  • When you run the odacli delete-database command on a TDE-enabled database that uses software keystore to store TDE keys, the TDE wallet is also deleted.
  • When you run the odacli delete-database command on a TDE-enabled database that uses Oracle Key Vault to store TDE keys and was created using Oracle Key Vault user credentials, the TDE wallet and the corresponding endpoints in the Oracle Key Vault are also deleted.
  • However, when you run the odacli delete-database command on a TDE-enabled database that uses Oracle Key Vault to store TDE keys and was created using endpoints in Oracle Key Vault server, the TDE wallet and the corresponding endpoints in the Oracle Key Vault are not deleted automatically. You must manually delete the TDE wallet and the corresponding endpoints in the Oracle Key Vault.
  • 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.
  • The odacli delete-database command does not delete the database files. This is expected behavior so that you can archive the database files, if required, or manually restore the database with these database files. Use the --force option to delete the database files completely.

Example 16-150 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  19.22.0.0      true   OLTP
7e28bf52-1a09-49fd-9391-841838d2c42f   crmdb   19.22.0.0.      false  OLTP

(continued)
Shape 	Storage  Status 
------  ------   ---------- 
odb1 	ACFS 	 Configured
odb1 	ACFS 	 Configured

# odacli delete-database -i a3f4a6c0-a0c9-4c79-bad7-898afcf9de46

Parent topic: odacli Database Commands

odacli describe-database

Use the odacli describe-database command to display database details.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To display database details:

   odacli describe-database -i dbid -n name [-h] [-j]

Parameters

Parameter Description

--id, -i

Identifies the database home identifier (ID) to display.

Use the odacli list-databases command to obtain the --id.

--name, -n

Defines the database name.

--json, -j

  (Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Example 16-151

Display information for a database.

# odacli describe-database -n 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: 
High Availability 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-152 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.26.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, 2024, 2016 6:21:14 PM

Parent topic: odacli Database Commands

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

Parameter Description

--help, -h

(Optional) Displays help for using the command.

-all

(Optional) This option is available only when multi-user access is enabled. Provides a read-only view of all the databases in the system.

Example 16-153 Displaying a List of Databases

Display a list of databases:

# odacli  list-databases

ID                                     DB Name     DB Version  CDB
------------------------------------   ----------  ----------  ----
ad6c7326-e460-411e-94df-230dedbef743   rdb121a     19.26.0.0.0    true
fb4d02f3-2413-47ca-8584-a768e23ec2e7   ee12db      19.26.0.0.0    false

(Continued)
Class	Shape  Storage  Status
------ -------  ----------
OLTP	odb1   ACFS     Configured
IMDB	odb1   ASM      Configured

Parent topic: odacli Database Commands

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.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli modify-database [-i] [-dn] [-no-ha] [ha] [-lb] [-no-bkp] [-tn node_name] [-g] [-cl] [-rd] [-s] [-an] [-ctm] [-bi] [-bin] [-bp] [-id] [-n] [-y] [-cp] [-no-cpupool] [-rkt] [-ctp] [-h] [-j]

Parameters

Parameter Description
--name, -n

Defines the database name to be updated. Specify either --name or --id.

--id, -i

Defines the database ID to be updated. Specify either --name or --id.

--dbRedundancy, -rd

(Optional) 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.

--levelzerobackupday, -lb

(Optional) Specifies the Level zero Backup Day. For example, Monday|Tuesday|Wednesday...|Sunday

--backupconfigid, -bi

(Optional) Defines the backup configuration identifier for future use.

--backupconfigname, -bin

(Optional) Specifies the name of the backup configuration.

--bkuppassword, -bp

(Optional) Specifies the RMAN backup encryption password.
--no-backup, -no-bkp

(Optional) Disables database backups. Specify this option to also remove the database backup and archivelog backup schedulers.

To enable database backups again, you must update the database with a backupconfig object.

--dbclass, -cl

(Optional) Defines the database class. The default is OLTP. The options are OLTP, DSS, or IMDB.

--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. You cannot specify the database shape for an instance-only database.

--attachnetworks, -an

(Optional) Specifies the name of the networks to be attached. Specify the networks in the format network_name1, network_name1, network_name1.

--detachnetworks, -dn

(Optional) Specifies the name of the networks to be detached. Specify the networks in the format network_name1, network_name1, network_name1.

--dbtype, -y

Defines new database type. The only option is SI. The conversion to single-instance database is available only for Oracle Database Standard Edition.

--disable-ha, -no-ha

(Optional) Disables High Availability for single-instance Oracle Database 19c and later.

--enable-ha, -ha

(Optional) Enables High Availability for single-instance Oracle Database 19c and later.

--target-node, -tn

(Optional) Specifies the target node name (applicable only for Oracle RAC One Node Database and single-instance Oracle Database, where supported).

--cpupool, -cp

(Optional) Specifies the CPU pool name. Use this option to associate a CPU pool to a database that does not use any CPU pool or to change the existing association of a CPU pool to a new CPU pool for a database.

--no-cpupool

(Optional) Removes the attached CPU pool.

--change-tde-password,-ctp

(Optional) When specified, you are prompted for the current and new TDE Wallet password. Note that in this release, you cannot modify the TDE configuration to use Oracle Key Vault.

--change-tdewallet-mgmt,-ctm

(Optional) When specified, the TDE wallet is changed from external to ODA.

--rekey-tde,-rkt

(Optional) When specified, current TDE Wallet password is prompted to rekey the TDE master encryption key.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Usage Notes

Caution:

When you change the TDE wallet password for 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-154 Modifying the Database Shape (Template) and Database Class

# odacli modify-database -s database_shape  -cl database_class -i dbid
odacli modify-database -i 1941d594-c777-4eca-9fce-18b778d5c153 -s odb2 -cl DSS
{
  "jobId" : "833d43a7-bcc6-48a7-9f98-b42ffdab3fe1",
  "status" : "Created",
  "message" : null,
  "reports" : [ ],
  "createTimestamp" : "May 16, 2023 06:48:58 AM UTC",
  "resourceList" : [ ],
  "description" : "modify-database service with db ids: 1941d594-c777-4eca-9fce-18b778d5c153",
  "updatedTime" : "May 16, 2023 06:48:58 AM UTC"
}

Example 16-155 Converting Oracle RAC or Oracle RAC One Node Database to Single-instance Oracle Database

# odacli modify-database -n db18 -y SI
For moving a database between homes please use the command 'move-database'.
{
  "jobId" : "4b548365-dac5-4557-a6a8-2f65c2b725e7",
  "status" : "Created",
  "message" : "Modify database",
  "reports" : [ ],
  "createTimestamp" : "May 21, 2023 00:32:55 AM UTC",
  "resourceList" : [ {
    "resourceId" : "de2a7959-e31b-4dee-b600-6b16dfb78c34",
    "resourceType" : "DB",
    "resourceNewType" : null,
    "jobId" : "4b548365-dac5-4557-a6a8-2f65c2b725e7",
    "updatedTime" : "May 21, 2023 00:32:55 AM UTC"
  } ],
  "description" : "Modify database : db18",
  "updatedTime" : "May 21, 2023 00:32:55 AM UTC"
}

Example 16-156 Specifying the target node when converting database

# odacli modify-database -n db18 -y SI -g node_number
# odacli modify-database -n db18 -y SI -th node_name

Example 16-157 Changing the TDE Wallet Password

# odacli modify-database -n testdb -ctp
Enter current 'TDE wallet' password: 
Enter new 'TDE wallet' password: 
Confirm 'TDE wallet' password:

Example 16-158 Re-keying the TDE Master Encryption Password

# odacli modify-database -n testdb -rkt
Enter current 'TDE wallet' password:

Example 16-159 Removing a CPU pool

# odacli modify-database -n dbcpupin  -cp testdbcpupool2
DB will be restarted as part of CPU Pool operation. Do you want to continue [y/n]:y
For moving a database between homes please use the command 'move-database'.
{
  "jobId" : "c1d05fb3-828a-4644-af9a-9d82b4ef5a89",
  "status" : "Created",
  "message" : "Modify database",
  "reports" : [ ],
  "createTimestamp" : "May 09, 2023 16:18:54 PM UTC",
  "resourceList" : [ {
    "resourceId" : "ff9c138b-a003-40cf-b1fc-0b33cd955ebf",
    "resourceType" : "DB",
    "resourceNewType" : null,
    "jobId" : "c1d05fb3-828a-4644-af9a-9d82b4ef5a89",
    "updatedTime" : "May 09, 2023 16:18:54 PM UTC"
  } ],
  "description" : "Modify database : dbcpupin",
  "updatedTime" : "May 09, 2023 16:18:54 PM UTC"
}

Parent topic: odacli Database Commands

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.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli move-database [-i dbid] [-imp] [-nr] [-n dbname] [-dh dest-dbhome-id][-dhn dest-dbhome-name][-j] [-h]

Parameters

Parameter Description
--id, -i

(Optional) Defines the database ID.
--name, -n

(Optional) Defines the database name.
--non-rolling, -nr

(Optional) Specifies whether you want to move the target database in non-rolling manner. By default, the value is false and the database is moved in a rolling manner.
--ignore-missing-patch, –imp

(Optional) Ignores all missing patches and forces the operation.
--dest-db-home-id, -dh

(Optional) Defines the destination database home ID.
--dest-dbhome-name, -dhn

(Optional) Defines the destination database home name.
--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output. The default is false.

Usage Notes

Starting with Oracle Database Appliance release 19.19, when you run the odacli move-database, the database is moved in a rolling manner, unless you specify the --non-rolling,-nr option.

Example 16-160 Moving a Database from one Oracle home to another 

# ./odacli move-database -i database_ID -dh destination_database_home_ID

Parent topic: odacli Database Commands

odacli register-database

Use the odacli register-database command to register a migrated database with the appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli register-database -c {OLTP|DSS|IMDB} -s dbshape -t dbtype SI|RACOne|RAC -o hostname -sn servicename [-bi backupconfigid] [-co|-no-co] [-nn] [-tp] [-ha|-no-ha] [-h] [-j]

Parameters

Parameter Description

--backupconfigid, -bi

(Optional) Defines the backup configuration identifier for future use.

--dbclass, -c {OLTP|DSS|IMDB}

Defines the database class. The database class setting determines the database SGA memory and instance PGA memory configuration. The options are as follows:

  • Enterprise Edition: OLTP, DSS, or IMDB.

  • Standard Edition: OLTP

--dbconsole, -co

(Optional) Enables the Database Console. Use the -no-coflag to disable the Database Console. If not selected, the default is no Database Console.

--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.

--dbtype, -t [SI|RACOne|RAC]

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.

--help, -h

(Optional) Displays help for using the command.

--hostname, -o

Defines the host name. Default: local host name

--json, -j

(Optional) Displays JSON output.

--no-dbconsole, -no-co

(Optional) Disables Database Console. Use the -coflag to enable Database Console.

--servicename, -sn

Defines the Database Service Name. Using this service name, the EZCONNECT String is derived for connecting to the database. For example, hostname:port/servicename.

The Port number is the port configured for the listener, as part of the deployment.

--associated-networks, -nn

Specifies the associated network names (in the format networkName1,networkName2,...).

--disable-ha, -no-ha

(Optional) Disables High Availability for single-instance Oracle Database 19c and later.

--enable-ha, -ha

(Optional) Enables High Availability for single-instance Oracle Database 19c and later.

--tde-wallet-passwd, -tp

Specifies the password for the TDE wallet.

Usage Notes

Note:

It is a good practice to use Easy Connect (EZCONNECT) to test the database connectivity before registering the database.

Log in as the sys user and enter the following command: 

sqlplus sys/password@//hostname:1521/service name
  • The odacli register-database command is supported on the primary and the standby database. For the standby database, only the database is registered with Oracle Database Appliance. Oracle Data Guard is not registered with Oracle Database Appliance.

  • The migrated database is registered with the listener configured during the provisioning of the appliance. The migrated database must be in read-write or read-only mode for the registration to succeed.

  • The register-database command validates the datafile and log file locations and moves the controlfile and spfile to the correct locations.

  • Some init.ora parameters are set, or reset, as part of the registration.  Review the parameter changes before and after registration.

    The following are examples of changes implemented as part of registration:

    • The memory_target is reset.

    • The sga_target/pga_aggregate_target/log_buffer/inmemory_size is configured based on the database class and database shape settings used during registration.

    • The registration process sets or resets the recommended appliance-specific parameters. The database is restarted as part of the register database operation.

  • The database being registered must use Oracle Managed Files and the file location must match the DATA Location, REDO Location and RECO Location of the odacli describe-dbstorage command.

  • As part of the registration process, the database is registered with Oracle Clusterware. Only the primary database is registered with Oracle Clusterware.

  • TDE-enabled database can also be registered. If TDE is configured using software keystore and the database version is 18c and higher, then TDE wallet management is also supported similar to a TDE database created using the Oracle Database Appliance framework.
  • In this release, you cannot register a TDE-enabled database that uses Oracle Key Vault to store TDE keys.

Example 16-161 Registering a Migrated Database

The following is the syntax to register a single instance OLTP database that is using shape odb1. 

odacli register-database -c OLTP -s odb1 -sn crmdb.example.com
Enter new 'SYS user' password: 
Confirm 'SYS user' password:
{
  "jobId" : "317b430f-ad5f-42ae-bb07-13f053d266e2",
  "status" : "Created",
  "message" : null,
  "reports" : [ ],
  "createTimestamp" : "December 8, 2024 05:55:49 AM EDT",
  "description" : "Database service registration with db service name: crmdb.example.com",
  "updatedTime" : "December 8, 2024 05:55:49 AM EDT"
}
rpandrap: ]# odacli describe-job -i "317b430f-ad5f-42ae-bb07-13f053d266e2"

Job details
----------------------------------------------------------------
                     ID: 317b430f-ad5f-42ae-bb07-13f053d266e2
            Description: Database service registration with db service name: crmdb.example.com
                 Status: Success
                Created: December 8, 2024 5:55:49 AM EDT
                Message:

Task Name                       Start Time                  
----------------------------- ------------------------------ 
restore control file           December 8, 2024 5:55:49 AM EDT 
move spfile to right location  December 8, 2024 5:56:08 AM EDT  
register DB with clusterware   December 8, 2024 5:56:13 AM EDT  
reset db parameters            December 8, 2024 5:57:05 AM EDT  
Running DataPatch              December 8, 2024 5:57:36 AM EDT  

(Continued)
  End Time                     Status
------------------------------- --------
December 8, 2024 5:56:08 AM EDT   Success
December 8, 2024 5:56:13 AM EDT   Success
December 8, 2024 5:57:05 AM EDT   Success
December 8, 2024 5:57:36 AM EDT   Success
December 8, 2024 5:57:49 AM EDT   Success

Parent topic: odacli Database Commands

odacli upgrade-database

You can use the odacli upgrade-database command to upgrade a database from a supported release.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To upgrade an Oracle Database:

 odacli upgrade-database -i Comma separated list of database ids -n Comma separated list of database names -from source dbhome id -to destination dbhome id | -fn source dbhome name -tn destination dbhome name [-ctm] [-j] [-h] [-ha|-no-ha]

Parameters

Parameter Description

--ids, -i

(Optional) Defines the Database IDs to upgrade. You can use a comma separated list of database IDs.

--names, -n

(Optional) Defines the names of the databases to upgrade.

--dest-dbhome-id, -to

The DB HOME ID of the destination database home.

--dest-dbhome-name, -tn

The DB HOME name of the destination database home.

--source-dbhome-id, -from

The DB HOME ID of the source database home.

--source-dbhome-name, -fn

The DB HOME name of the source database home.

--change-tdewallet-mgmt, -ctm

(Optional) When specified, the TDE wallet management attribute is changed from External to ODA.

--json, -j

  (Optional) Displays JSON output. The default is false.

--disable-ha, -no-ha

(Optional) Disables High Availability for single-instance Oracle Database 19c and later.

--enable-ha, -ha

(Optional) Enables High Availability for single-instance Oracle Database 19c and later.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

You cannot upgrade Oracle RAC or Oracle RAC One Node Database to a destination database home of Standard Edition 19c or later. You must first convert Oracle RAC or Oracle RAC One Node Database to single-instance Oracle Database using the odacli modify-database command and then upgrade the single-instance Oracle Database to a destination database home of Standard Edition 19c or later.

You have the following options for defining the databases to upgrade:

  • When you define a single database ID, only the database of the source database home is upgraded.

  • When you define more than one database ID, only those databases of the source database home are upgraded.

  • When you do not define a database ID, all of the databases under the source database home are upgraded.

You can upgrade databases of the following releases:
  • Oracle Database 12.2 to 19c
  • Oracle Database 12.1 to 19c
  • Oracle Database 12.1 to 12.2

Example 16-162 Upgrading an Oracle Database

In this example, a single database is upgraded. Use the command odacli list-databases to display the database ID, then use the command odacli upgrade-databases to upgrade the database. After the upgrade is complete, you can run the command odacli list-databases again to verify the upgrade. 

# odacli  list-databases

ID                                     DB Name     DB Version  CDB
------------------------------------   ----------  ----------  ----
fb4d02f3-2413-47ca-8584-a768e23ec2e7   ee12db      12.1.0.2    false

(Continued)
Class	Shape    Storage  Status
------ -------  --------  ----------
OLTP	  odb1      ACFS     Configured
IMDB	  odb1      ASM      Configured


# odacli upgrade-database -i ad6c7326-e460-411e-94df-230dedbef743 -from fa4321f5-0543-477d-bb54-a429dcc8ee8d -to d752df28-ecdd-4af4-9454-38085ea17f8b
{
   "jobId" : "1bbe8boe-acb0-4296--9c8b-473b69da0c18",
   "status" : "Created",
   "message" : null,
   "reports" : [ ],
   "createTimestamp" : "October 24, 2017 03:54:03 AM EDT",
   "description" : "Database service upgrade with db ids: [ad6c7326-e460-411e-94df-230dedbef743]",
   "updatedTime" : "October 24, 2017  03:54:03 AM EDT" 
}

# odacli  list-databases

ID                                     DB Name     DB Version  CDB
------------------------------------   ----------  ----------  ----
ad6c7326-e460-411e-94df-230dedbef743   rdb121a     12.1.0.2    true
fb4d02f3-2413-47ca-8584-a768e23ec2e7   ee12db      12.1.0.2    false

(Continued)
Class	Shape    Storage  Status
------ -------  --------  ----------
OLTP	  odb1      ACFS     Configured
IMDB	  odb1      ASM      Configured

Parent topic: odacli Database Commands

odacli DBHome Commands

Use the odacli DBHome commands to manage database Home operations.

  • odacli configure-dbhome-storage
    Use the odacli configure-dbhome-storage command to configure the database home storage.
  • odacli list-dbhome-storages
    Use the odacli list-dbhome-storages command to view the database home storage resources after the volumes for ORACLE_HOME and ORACLE_BASE are created.
  • odacli describe-dbhome-storage
    Use the odacli describe-dbhome-storage command to view information such as how much space is available (at a volume or diskgroup level).
  • odacli modify-dbhome-storage
    Use the odacli modify-dbhome-storage command to modify database home storage and add additional disk space.
  • odacli create-dbhome
    Use the odacli create-dbhome command to create an Oracle Database Home.
  • odacli delete-dbhome
    Use the odacli delete-dbhome command to delete database home that is not associated with a database.
  • odacli describe-dbhome
    Use the odacli describe-dbhome command to display Oracle Database Home details.
  • odacli list-dbhomes
    Use the odacli list-dbhomes command to display a list of Oracle Home directories.

Parent topic: Oracle Database Appliance Command-Line Interface

odacli configure-dbhome-storage

Use the odacli configure-dbhome-storage command to configure the database home storage.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli configure-dbhome-storage -dg disk_group [-s volume_size] [-j] [-h]

Parameters

Parameter Description

--diskgroup, -dg

(Mandatory) Defines the name of the disk group.

--size, -s

(Optional) Defines the size, in gigabytes (GB), of the ORACLE_HOME volume. The default is: 80 GB. The minimum value that can be specified is 25GB and the maximum value is 1024GB.

--json, -j

(Optional) Displays the output in JSON format.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

  • Valid values for the --diskgroup option vary depending on the hardware. For the X5-2, X6-2 and X7-2 HA platforms, you can select between the DATA or RECO diskgroup. For all other platforms such as X8-2, you must select only the DATA diskgroup. With later hardware, you must still run the odacli configure-dbhome-storage command.

  • When you run the command to create a new database home, it also creates the volumes to hold the database homes. Till the volumes are created, you can run the odacli configure-dbhome-storage command to change the diskgroup or the inital size of the volume. Once the volumes for this feature are created, running this command results in an error: 

    # odacli configure-dbhome-storage -dg RECO
DCS-10606:Database homes storage has already been created, no changes are allowed.

Example 16-163 Creating Database Home Storage

# odacli configure-dbhome-storage -dg DATA
{
  "jobId" : "553bfeb9-0092-4d73-bbd4-43fcb590886f",
  "status" : "Created",
  "message" : null,
  "reports" : [ ],
  "createTimestamp" : "May 11, 2021 06:48:12 AM GMT",
  "resourceList" : [ ],
  "description" : "Configure database home storage",
  "updatedTime" : "May 11, 2021 06:48:12 AM GMT"
}

Parent topic: odacli DBHome Commands

odacli list-dbhome-storages

Use the odacli list-dbhome-storages command to view the database home storage resources after the volumes for ORACLE_HOME and ORACLE_BASE are created.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-dbhome-storages [-j] [-h]

Parameters

Parameter Description

--json, -j

(Optional) Displays the output in JSON format.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

  • Starting with Oracle Database Appliance release 19.26, Oracle Database homes are no longer created on the local disk. New Oracle Database homes are created on an Oracle ACFS-managed file system. To create an Oracle ACFS file system, ADVM volumes are created.

  • The command lists the resource ID, the node on which the volume is created, and the diskgroup on which the volume is created.

Example 16-164 Listing Database Home Storage on a Single-Node System

# odacli list-dbhome-storages

============================================================================================================= 
ID                                     Node Description          Disk Group Volume      Size(GB)   Status 
-------------------------------------- ---- -------------------- ---------- ----------- ---------- ----------
6801cabb-4e45-41d7-9f20-c75dc7cf30c2   0    ORACLE_HOME          DATA       orahome_sh  80         CONFIGURED
f5ad1258-a4a1-4cc1-980c-e2eeca738d99   0    ORACLE_BASE          DATA       odabase_n0  80         CONFIGURED
=============================================================================================================

Example 16-165 Listing Database Home Storage on a High-Availability System

# odacli list-dbhome-storages

=============================================================================================================
ID                                     Node Description          Disk Group Volume      Size(GB)   Status
-------------------------------------- ---- -------------------- ---------- ----------- ---------- ----------
67622ce6-0a00-4fec-b948-7a0ba7922311   0,1  SHARED ORACLE_HOME   DATA       orahome_sh  200        CONFIGURED
ac813348-2935-4903-b9a6-eb4f0d9637b3   0    ORACLE_BASE          DATA       odabase_n0  80         CONFIGURED
c8153e7b-6ab7-4a55-90ad-20d4196d2ac4   1    ORACLE_BASE          DATA       odabase_n1  80         CONFIGURED
=============================================================================================================

Parent topic: odacli DBHome Commands

odacli describe-dbhome-storage

Use the odacli describe-dbhome-storage command to view information such as how much space is available (at a volume or diskgroup level).

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli describe-dbhome-storage -i db_home_id [-j] [-h]

Parameters

Parameter Description

--id, -i

(Mandatory) Specifies the Oracle home storage ID. This is the ID listed in the odacli list-dbhome-storages command output.

--json, -j

(Optional) Displays the output in JSON format.

--help, -h

(Optional) Displays help for using the command.

Example 16-166 Describing Database Home Storage

odacli describe-dbhome-storage -i 67622ce6-0a00-4fec-b948-7a0ba7922311
ORACLE_HOME storage details:
================================================================
                     ID: 67622ce6-0a00-4fec-b948-7a0ba7922311
                  State: CONFIGURED
                Created: February 11, 2021 5:30:10 AM UTC
                Updated: February 18, 2021 4:33:30 PM UTC

Volume Details
--------------
                   Name: ORAHOME_SH
             Disk Group: DATA
            Description: SHARED ORACLE_HOME
            Node Number: 0,1
        Allocated Space: 200.0 GB
             Used Space: 12.10 GB
             Free Space: 187.89 GB
               Location: /u01/app/odaorahome

DiskGroup Details
-----------------
                   Name: DATA
        Allocated Space: 15.52 TB
             Used Space: 2.69 TB
             Free Space: 12.83 TB
================================================================

Parent topic: odacli DBHome Commands

odacli modify-dbhome-storage

Use the odacli modify-dbhome-storage command to modify database home storage and add additional disk space.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli modify-dbhome-storage -i db_home_id -s size[-j] [-h]

Parameters

Parameter Description

--id, -i

(Mandatory) Specifies the Oracle home storage ID. This is the ID listed in the odacli list-dbhome-storages command output.

--size, -s

(Mandatory) Specifies the new size in GB. The minimum value that can be specified is 25GB and the maximum value is 1024GB.

--json, -j

(Optional) Displays the output in JSON format.

--help, -h

(Optional) Displays help for using the command.

Example 16-167 Modifying Database Home Storage

odacli modify-dbhome-storage -i 9b9c9e0f-db04-4985-be48-3f1e263cd73a -s 30
{
  "jobId" : "badfad81-cfc1-4c82-a181-69ebdfb11c22",
  "status" : "Created",
  "message" : null,
  "reports" : [ ],
  "createTimestamp" : "May 11, 2021 14:04:09 PM CST",
  "resourceList" : [ ],
  "description" : "Modify database home storage",
  "updatedTime" : "May 11, 2021 14:04:09 PM CST"
}

Parent topic: odacli DBHome Commands

odacli create-dbhome

Use the odacli create-dbhome command to create an Oracle Database Home.

File Path

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

Syntax

To create an Oracle Database Home:

 odacli create-dbhome -v version [-j] [-h]    

Parameters

Parameter Description

-v version number

Defines the database bundle patch number.

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

For the version number, you can specify the database version, such as 18.7.0.0, 18.5.0.0, 12.2.0.1, or 12.1.0.2, or you can use a 5 digit format to specify a specific patch bundle version. For example, 19.26.0.0.250121. If you use the database version without specifying the bundle patch number, then the latest bundle patch is used.

Example 16-168 Creating an Oracle Database Home

The following example creates an Oracle Database Home version 19.26.0.0.250121. 

# odacli  create-dbhome -v 19.26.0.0.250121

Parent topic: odacli DBHome Commands

odacli delete-dbhome

Use the odacli delete-dbhome command to delete database home that is not associated with a database.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli delete-dbhome  -i db_home_ID | -n db_home_name [-h]

Parameters

Parameter Description

--id, -i

Identifies the database home using a database identifier (ID).

--name, -n

Identifies the database home using a database name.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

  • Use the odacli list-dbhomes command to locate the identifier.

  • To delete, or uninstall, a database home (dbhome), there must not be any associated databases in the dbhome.

  • Use the odacli delete-database command to delete an existing database.

Example 16-169 Deleting an Empty Database Home

# odacli delete-dbhome -i 0ce547ca-3df2-4178-a7e6-eefa613aeab4

Parent topic: odacli DBHome Commands

odacli describe-dbhome

Use the odacli describe-dbhome command to display Oracle Database Home details.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To display details about Oracle Database Home:

  odacli describe-dbhome -i dbhomeid -n name [-h] [-j] [-v]

Parameters

Parameter Description

--id, -i

Identifies the database home ID. Use the odacli list-dbhomes command to get the id.

--name, -n

Identifies the database home name. Use the odacli list-dbhomes command to get the database name.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output. The default is false.

--dbversion, -v

(Optional)  Identifies the Database Home Version. Use the odacli list-dbhomes —v command to get the dbversion.

Example 16-170 Displaying Oracle Database Home Details

The following output is an example of using the display Oracle Database Home details command:

# odacli  describe-dbhome -i b727bf80-c99e-4846-ac1f-28a81a725df6 

DB Home details 
----------------------------------------------------------------
                            ID: b727bf80-c99e-4846-ac1f-28a81a725df6
                          Name: OraDB19_home1 
                        Version: 19.19.0.0.0
               Home Location: /u01/app/orauser/product/19/dbhome_1
                       Created: Jun 2, 2023 10:19:23 AM

Parent topic: odacli DBHome Commands

odacli list-dbhomes

Use the odacli list-dbhomes command to display a list of Oracle Home directories.

File Path

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

Syntax

To display a list of Oracle Home directories:

   odacli  list-dbhomes  [-h] [-j]

Parameters

Parameter Description

--help,-h

(Optional) Displays help for using the command.

--json,-j

(Optional) Displays JSON output.

-all

(Optional) This option is available only when multi-user access is enabled. Provides a read-only view of all the database homes in the system.

Example 16-171 Displaying a List of Oracle Home Directories

Run the following command to display a list of Oracle Home directories:

# odacli list-dbhomes
ID                                   Name               DB Version  
------------------------------------ -----------------  ----------  
b727bf80-c99e-4846-ac1f-28a81a725df6 OraDB12102_home1  12.1.0.2     

(continued)
Home Location
-----------------------------------------
/u01/app/orauser/product/12.1.0.2/dbhome_1

Parent topic: odacli DBHome Commands

odacli Database Storage Commands

Use the Database Storage commands to list, describe, create, and delete Oracle database storage.

Parent topic: Oracle Database Appliance Command-Line Interface

odacli create-dbstorage

Use the odacli create-dbstorage command to create the file system for database migrations.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli create-dbstorage  -n dbname -s dataSize -u databaseUniqueName -r [ASM|ACFS] -rd [high|mirror] [-h]

Parameters

Parameter Description

--dbname, -n

Defines the name of the database.

--dataSize, -s

(Optional) Defines the size, in gigabytes (GB), of the filesystem for storing database files and temp files. The default is: 100 GB The minimum size is 10 GB. When entering the size, do not include GB. For example, for 50 GB, use 50.

--databaseUniqueName, -u

(Optional) Defines a unique name for the database. Specify only if the database unique name is different than the database name. The command creates the following mount point: /u02/app/oracle/oradata/db unique name

--dbstorage, -r [ASM|ACFS]

(Optional) Defines the type of database storage, either ASM or ACFS. When you select ASM, the command only creates the supporting directory structure for storing non-database files. The default is ASM.

--db-redundancy, -rd

(Optional) Defines the database redundancy. The values can be high or mirror.

The database redundancy is not applicable to database storages of Oracle ASM type, or database storages on normal or high redundancy disk groups. For database storages of Oracle ACFS type, specifying this option creates volumes of the specified redundancy on Oracle ASM disk groups of flex redundancy.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

  • The odacli create-dbstorage command registers the storage metadata with the Appliance Manager.

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

  • When you create ACFS database storage, the command creates a separate ACFS file system and creates the directory structure for other database files, such as archives and online logs.

  • When you create ASM database storage, the command only creates the corresponding directories for non-database files.

Example 16-172 Creating Database Storage

The following statement creates 50 GB ACFS database storage for the APPSDB database.

# odacli create-dbstorage -n APPSDB -s 50 -r ACFS 
{
   "jobId" : "fc6bf8fd-60c2-44f3-b8b7-efd0e9a2149f",
   "status" : "Created",
   "message" : null,
   "reports" : [ ],
   "createTimestamp" : "August 09, 2016 06:19:35 AM WSST",
   "description" : "Database storage service creation with db name: APPSDB",
   "updatedTime" : "August 09, 2016 06:19:35 AM WSST" 
}

Parent topic: odacli Database Storage Commands

odacli delete-dbstorage

Use the odacli delete-dbstorage command to delete database storage that is not associated with a database.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli delete-dbstorage -i ID -n name [-h] [-j]

Parameters

Parameter Description

--id, -i

Identifies the database storage using a database identifier (ID).

--name, -n

Specifies the database storage name.

--help, -h

(Optional) Displays help for using the command.

--json, -j

  (Optional) Displays JSON output.

Usage Notes

  • You can only use the delete-dbstorage when the storage is not associated with any databases.

  • Use the delete-database command to delete an existing database.

  • Use the list-dbstorages command to locate the identifier.

Example 16-173 Deleting Empty Database Storage

# odacli delete-dbstorage  -i 9fe39332-cc1a-4b4b-8393-165524a6ef6b

Parent topic: odacli Database Storage Commands

odacli describe-dbstorage

Use the odacli describe-dbstorage command to display storage configuration details.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli describe-dbstorage  -i ID -n name [-j] [-h]

Parameters

Parameter Description

--id, -i

Specifies the database storage ID.

--name, -n

Specifies the database storage name.

--json, -j

(Optional) Displays JSON output. The default is false.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

  • Use the odacli list-dbstorages command to get the database storage identifier (ID).

  • The DATA Location corresponds to the init.ora parameter db_create_file_dest.

  • RECO Location corresponds to the init.ora parameter db_recovery_file_dest

  • REDO Location corresponds to the init.ora parameter db_create_online_log_dest_1

Example 16-174 Displaying Database Oracle ACFS Storage Details

The following example displays Oracle ASM Cluster file system (ACFS) storage details:

# odacli describe-dbstorage -i 9fe39332-cc1a-4b4b-8393-165524a6ef6b 

DBStorage details 
---------------------------------------------------------------- 
ID: 9fe39332-cc1a-4b4b-8393-165524a6ef6b 
DB Name: rdb121a 
DBUnique Name: rdb121a 
DB Resource ID: ad6c7326-e460-411e-94df-230dedbef743 
Storage Type: Acfs 
DATA Location: /u02/app/oracle/oradata/rdb121a 
RECO Location: /u03/app/oracle/fast_recovery_area/ 
REDO Location: /u03/app/oracle/redo/ 
State: ResourceState(status=Configured) 
Created: July 22, 2016 12:07:12 PM SGT 
UpdatedTime: July 22, 2016 12:26:39 PM SGT

Example 16-175 Displaying Database Oracle ASM Storage Details

The following example displays Oracle Automatic Storage Management (Oracle ASM) storage details:

# odacli describe-dbstorage -i 4f2a1b59-ca66-4d80-951c-425ab7b0acae 

DBStorage details 
---------------------------------------------------------------- 
ID: 4f2a1b59-ca66-4d80-951c-425ab7b0acae 
DB Name: ee12db 
DBUnique Name: ee12db 
DB Resource ID: fb4d02f3-2413-47ca-8584-a768e23ec2e7 
Storage Type: Asm 
DATA Location: DATA 
RECO Location: RECO 
REDO Location: RECO 
State: ResourceState(status=Configured) 
Created: July 22, 2016 1:13:51 PM SGT 
UpdatedTime: July 22, 2016 1:13:52 PM SGT

Parent topic: odacli Database Storage Commands

odacli describe-dgstorage

Use the odacli describe-dgstorages command to display the disk group information.

File Path

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

Syntax

odacli describe-dgstorage  -d diskgroup -h

Parameters

Parameter Description

--diskgroup, -d

Specifies the disk group for which information is displayed.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

This command displays the storage information for all the databases backed by a disk group, for each disk group present in the system.

Example 16-176 Displaying Disk Group Storage

# odacli list-dgstorages –r  redundancy
Diskgroup storage details

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

Diskgroup: DATA

                  Redundancy: extern|normal|high|flex

                  Physical Free Space: wGB

                  Physical Total Space: xGB

                  Database Unique Name: rdbx




                                    Location: /u02/app/test/test1/rdbx

                                    Used Space: dGB  (acfsutil.total – acfsutil.freespace)

                                    Free Space: dGB  (acfsutil.freespace) 

                 Database Unique Name: rdby

                                    Location: +DATA/rdby

                                    Used Space: zGB  (v$asm_file.bytes)

                                    Free Space: xGB   (PhyFree/redundancy) 

                                    Physical Space: vGB(v$asm_diskgroup.total_mb)

                                    Physical Used : wGB (v$asm_file.space)

                                    Physical Free : uGB(v$asm_diskgroup.free_mb)

                                    Physical Reserved : uGB(Lookup Table)

Diskgroup: RECO

                  Redundancy: normal|high|flex

                  Physical Free Space: wGB

                  Physical Total Space: xGB

                  Database Unique Name: rdbx

                                    Location: /u02/app/test/fast_recovery_area




                                    Used Space: dGB  (acfsutil.total – acfsutil.freespace)

                                    Free Space: dGB  (acfsutil.freespace) 

                 Database Unique Name: rdby

                                    Location: +DATA/rdby

                                    Used Space: zGB  (v$asm_file.bytes)

                                    Free Space: xGB   (PhyFree/redundancy) 

                                    Physical Space: vGB(v$asm_diskgroup.total_mb)

                                    Physical Used : wGB (v$asm_file.space)

                                    Physical Free : uGB(v$asm_diskgroup.free_mb)

                                    Physical Reserved : uGB(Lookup Table)

Parent topic: odacli Database Storage Commands

odacli list-dbstorages

Use the odacli list-dbstorages command to display a list of all of the database storage configured in the appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli list-dbstorages  [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Usage Notes

This command displays a list of all of the filesystems that are configured with the create-database command and the create-dbstorage command.

Example 16-177 Displaying a List of all Database Storage

# odacli list-dbstorages  

ID Type                               DBUnique  Name         Status 
------------------------------------  --------  ----------- ---------- 
9fe39332-cc1a-4b4b-8393-165524a6ef6b  Acfs       rdb121a     Configured 
4f2a1b59-ca66-4d80-951c-425ab7b0acae  Asm        ee12db      Configured 
0266edac-c729-4539-861f-3f3d543be9e4  Acfs       db12SE      Configured

Parent topic: odacli Database Storage Commands

odacli list-dgstorages

Use the odacli list-dgstorages command to display the disk group information.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-dgstorages  -r redundancy -h

Parameters

Parameter Description

--redundancy, -r

Specifies the disk group redundancy for FLEX disk group.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

  • The command displays the storage-related information for all the disk groups present in the system.

  • The redundancy option is valid only for FLEX disk groups. For all disk groups that are not FLEX, logical free space is calculated using the redundancy obtained from v$asm_diskgroup rather than the CLI option.

  • Redundancy option can take the values MIRROR | HIGH. Use one of these options to specify the database redundancy for FLEX disk groups.

  • In the example below, Physical Total Space is the total space in the disk group. (V$ASM_DISKGROUP.total_mb) Physical Reserved Space is the reserved space required to handle disk failures. Physical Free Space is the free space in the disk group. (V$ASM_DISKGROUP.free_mb) Logical Free Space is the logical free space in the diskgroup. (V$ASM_DISKGROUP.free_mb / redundancy)

This command displays the storage information for all the databases backed by a disk group, for each disk group present in the system.

Example 16-178 Displaying Disk Group Storage

# odacli list-dgstorages –r  redundancy
Diskgroup  Redundancy   Physical Total Space  Physical Reserved Space Physical Free Space  Logical Free
 Space 

--------------   -----------------    -----------------------------   ---------------------------------
DATA          FLEX                xGB                              yGB                                 
        zGB                                 uGB

REDO         HIGH                xGB                              yGB                                 
        zGB                                 uGB

RECO         NORMAL         xGB                              yGB                                       
  zGB                                 uGB

Parent topic: odacli Database Storage Commands

odacli modify-dbstorage

Use the odacli modify-dbstorage command to resize the database storage.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli modify-dbstorage [-ds] [-in] [-fs] [-rcs] [-rds] [-h] [-j]

Parameters

Parameter Description

--datasize, -ds

(Optional) Specifies the extendable size in GB for the DATA volume. Specify at least one size from FLASH, RECO, REDO, or DATA volumes.
--dbname, -in

Defines the database name on which you want to extend the volumes.

--flashsize, -fs

(Optional) Specifies the extendable size in GB for the FLASH volume.

--recosize, -rcs

(Optional) Specifies the extendable size in GB for the RECO volume.

--redosize, -rds

(Optional) Specifies the extendable size in GB for the REDO volume.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Usage Notes

  • The command can resize DATA, RECO, REDO, and FLASH volumes.
  • Database name is a mandatory parameter. All other parameters are optional, however, one of the volume sizes must be specified. If you only provide the DATA size, then the DCS agent calculates the recommended RECO size for the given DATA size is internally calculated. The storage is then extended with the recommended values.
  • The mounted Oracle ACFS and its underlying Oracle ADVM storage is extended by the specified value.
  • The maximum resize value that can be specified in the command at a time is 100 GB. To resize with a value greater than 100 GB, run the command multiple times with a maximum value of 100 GB each time. For further resize, ensure that the command completes successfully before you run it again.
  • To check the result of the resize operation, use the odacli list-dbstorages command.
  • After database resize operation is completed, use the odacli describe-dbstorage command to display storage configuration details.

Example 16-179 Modifying the Database Storage

# odacli modify-dbstorage -ds 10 -rcs 15 -n amdb1
{ 
 "jobId" : "e6d54155-ed4c-4fd6-a3f6-454120fa5c18", 
 "status" : "Created",
 "message" : null,
 "reports" : [ ],
 "createTimestamp" : "June 03, 2019 06:06:42 AM UTC",
 "resourceList" : [ ],
 "description" : "Database storage modify operation",
 "updatedTime" : "June 03, 2019 06:06:42 AM UTC"
}

Parent topic: odacli Database Storage Commands

odacli modify-dgstorage

Use the odacli modify-dgstorage command to release disks.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To release disks:

   odacli modify-dgstorage [-f] [-rd list] [-j] [-h]

Parameters

Parameter Description

--force, -f

(Optional) Forces release of specified disks. When this option is specified, the check to verify that all disk groups are mounted on the current node is skipped.

--release-disk, -rd

Specifies the disks to release. Generally, this specifies a single storage device with partitions on different disk groups. You can also specify a comma-separated list of disks to release.

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

  • Run the odacli list-dgdisks to view details of the disk, before running the odacli modify-dgstorage command.
  • The odacli modify-dgstorage command runs a precheck to ensure all disk groups are mounted on the node. You can use the -f option to override the precheck.

Example 16-180 Releasing a physical disk HDD_E0_S10_577135552 which has two logical partitions on two different disk groups

# odacli modify-dgstorage -rd HDD_E0_S10_577135552
Job details                                                      
----------------------------------------------------------------
                    ID:  46bc736c-417b-4ac2-826e-aa857db50e29
            Description:  Release disks: [HDD_E0_S10_577135552]
                 Status:  Running
                Created:  December 8, 2024 6:24:27 PM PDT
                Message:  Release ASM disks

Verifying the result of the Release Disks operation:
# odacli describe-job -i 46bc736c-417b-4ac2-826e-aa857db50e29
Job details                                                      
----------------------------------------------------------------
                     ID:  46bc736c-417b-4ac2-826e-aa857db50e29
            Description:  Release disks: [HDD_E0_S10_577135552]
                 Status:  Success
                Created:  December 8, 2024 6:24:27 PM PDT
                Message:  Release ASM disks

Parent topic: odacli Database Storage Commands

odacli Diagnostics Collection Commands

Use the diagnostics collection commands to display diagnostics details.

Parent topic: Oracle Database Appliance Command-Line Interface

odacli create-diagcollection

Use the odacli create-diagcollection command to create diagnostics collection data from the appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To create diagnostics collection:

  odacli create-diagcollection -i id [-d] [-t] [-j] [-h]

Parameters

Parameter Description

--id, -i

(Mandatory) Specifies the DCS job ID for the collection.

--description, -d

(Optional) Description of the diagnostic collection.

--tag, -t

(Optional) Specifies tag name to identify the collection.

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Example 16-181 Creating a diagnostics collection

# odacli create-diagcollection -i ID 

Job details                                                     
----------------------------------------------------------------
                     ID:  f840feb8-7712-49a1-a525-1ee911176c50
            Description:  Diagnostic collection creation
                 Status:  Created
                Created:  April 11, 2023 7:15:30 PM UTC
                Message:

Parent topic: odacli Diagnostics Collection Commands

odacli describe-diagcollection

Use the odacli describe-diagcollection command to describe diagnostics collection data from the appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To describe diagnostics collection:

  odacli describe-diagcollection -i id [-j] [-h]

Parameters

Parameter Description

--id, -i

(Mandatory) Specifies the diagnostics collection ID.

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Example 16-182 Describing a diagnostics collection

# odacli describe-diagcollection -i ID 

Diagnostic collection details                                                  
--------------------------------------------------------------------------------
                       ID: f5c07af8-2635-466d-b487-0f04d15fba79
         Requested job ID: 016e74cb-01e0-4812-96ef-94602b5ea2c5
              Description: Diagnostic collection for job 'Agent State Update Job'
     Collection file path: /opt/oracle/dcs/commonstore/diag/2023/04/f5c07af8-2635-466d-b487-0f04d15fba79.tar.gz
          Collection size: 91.88 KB
               Start time: February 27, 2023 7:58:41 PM UTC
                 End time: February 27, 2023 7:59:39 PM UTC

Parent topic: odacli Diagnostics Collection Commands

odacli list-diagcollections

Use the odacli list-diagcollections command to list the diagnostics collections.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To list all diagnostics collections:

  odacli list-diagcollections [-j] [-h]

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Example 16-183 Listing all diagnostics collections

ID                                       Description                                                       Collection size  Start time                     End time                     
---------------------------------------- ----------------------------------------------------------------- ---------------- ------------------------------ ------------------------------
3c65bcd3-cd30-4332-88b7-fc25b256db75     Diagnostic collection for job 'DcsAdmin patching'                 8.37 MB          2023-03-08 15:37:02 UTC        2023-03-08 15:38:01 UTC      
7dd1d951-056c-47b2-ad78-8614d0b3bbd0     Diagnostic collection for job 'VM winvm1 start'                   6.59 MB          2023-03-08 15:37:02 UTC        2023-03-08 15:38:01 UTC

Parent topic: odacli Diagnostics Collection Commands

odacli delete-diagcollection

Use the odacli delete-diagcollection command to delete diagnostics collection data from the appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To delete diagnostics collection:

  odacli delete-diagcollection -i id [-j] [-h]

Parameters

Parameter Description

--id, -i

(Mandatory) Specifies the diagnostics collection ID to be deleted.

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Example 16-184 Deleting a diagnostics collection

# odacli delete-diagcollection -i ID

Parent topic: odacli Diagnostics Collection Commands

odacli Job Commands

Use the odacli list-jobs and odacli describe-job commands to display job details.

  • odacli create-jobdata-retention-policy
    Use the odacli create-jobdata-retention-policy command to create job data retention policy for default DCS jobs and specific auto scheduled jobs.
  • odacli create-purge-jobdata-job
    Use the odacli create-purge-jobdata-job command to create a job to delete data for default DCS jobs and specific auto scheduled jobs.
  • odacli delete-jobdata-retention-policy
    Use the odacli delete-jobdata-retention-policy command to delete job data retention for default DCS jobs and specific auto scheduled jobs.
  • odacli describe-job
    Use the odacli describe-job command to display details about a specific job, including the job ID, status, tasks, and the job created date and time stamp.
  • odacli list-jobs
    Use the odacli list-jobs command to display a list of jobs, including the job IDs, status, and the job created date and time stamp. The default number of jobs listed is 50 from the earliest to the latest.
  • odacli list-pendingjobs
    Use the odacli list-pendingjobs command to list all pending jobs.
  • odacli list-jobdata-retention-policy
    Use the odacli list-jobdata-retention-policy command to list job data retention policy for default DCS jobs and specific auto scheduled jobs.
  • odacli list-purge-jobdata-jobs
    Use the odacli list-purge-jobdata-jobs command to list purge job data for default DCS jobs and specific auto scheduled jobs.
  • odacli list-scheduled-executions
    Use the command odacli list-scheduled-executions to display a list of jobs that were executed.

Parent topic: Oracle Database Appliance Command-Line Interface

odacli create-jobdata-retention-policy

Use the odacli create-jobdata-retention-policy command to create job data retention policy for default DCS jobs and specific auto scheduled jobs.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To create job data retention policy:

   odacli create-jobdata-retention-policy [-j] [-h] [-w] [-s]

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--retentionWindow, -w

(Optional) Describes the time interval to retain the job data. Default is 30 days if not specified.

--retentionWindowUnit, -u

(Optional) Describes the unit for the retentionWindow. Possible values are Day|Hour|Minute. Default is Day if no value is specified.

--scheduleIds, -s

(Optional) Specifies the IDs, delimited by commas, of the scheduled jobs similar to the odacli list-schedules result. Use Default for all DCS jobs.

Usage Notes

  • Once a policy is created, an auto scheduled job is created to start purging DCS job records regularly, for example, every day at 4 AM, based on the retention policies you define.

Example 16-185 Creating a default policy to purge all the jobs and scheduled executions older than 30 days

# odacli create-jobdata-retention-policy 

Job details 
---------------------------------------------------------------- 
ID: 36d00489-39b1-425f-81bf-6d6e3bfede8b 
Description: set job data retention policy 
Status: Created 
Created: April 23, 2020 3:32:09 PM PDT 
Message: 

Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
[root@oda1]# ./odacli describe-job -i c40c17f0-4185-40fe-a126-30fe1f0e5cdd 

Job details 
---------------------------------------------------------------- 
ID: c40c17f0-4185-40fe-a126-30fe1f0e5cdd 
Description: set job data retention policy 
Status: Success 
Created: April 23, 2020 5:42:28 PM PDT 

Message: 
Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
set job data retention policy   April 23, 2020 5:42:28 PM PDT   April 23, 2020 5:42:28 PM PDT   Success 
create auto job data schedule   April 23, 2020 5:42:28 PM PDT   April 23, 2020 5:42:28 PM PDT   Success

Example 16-186 Set up a retention policy of 10 days for the schedule 'archive_log_backup' 

# odacli create-jobdata-retention-policy -s 284a22b5-41e6-4be1-a916-048eac74e076 -w 10 -u Day 

Job details 
---------------------------------------------------------------- 
ID: ea68a90e-a8e2-4fc4-a4f1-75461e12c387 
Description: set job data retention policy 
Status: Created 
Created: April 23, 2020 6:22:14 PM PDT 

Message: 
Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
[root@oda1]# ./odacli list-jobdata-retention-policy 

Schedule Id     Retention Window    Unit    Modified 
-------------------- -------------------- -------------------- ------------------------- 
Default     20      Day     April 23, 2020 6:16:59 PM PDT
284a22b5-41e6-4be1-a916-048eac74e076    10  Day     April 23, 2020 6:22:14 PM PDT

Parent topic: odacli Job Commands

odacli create-purge-jobdata-job

Use the odacli create-purge-jobdata-job command to create a job to delete data for default DCS jobs and specific auto scheduled jobs.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To create job data purge:

   odacli create-purge-jobdata-job [-j] [-h] [-i] [-o] [-u] [-s]

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--jobIds, -i

(Optional) Purges data for given DCS job IDs, delimited by commas.

--olderThan, -o

(Optional) Purges job data older than the specified time. If not specified, use the existing retentionWindow value.

--olderThanUnit, -u

(Optional) Describes the unit for the OlderThan option. Possible values are Day|Hour|Minute. If not specified, use the existing retentionWindow value.

--scheduleIds, -s

(Optional) Specifies the IDs, delimited by commas, of the scheduled jobs similar to the odacli list-schedules result.

Example 16-187 Creating a job to purge job data

# odacli create-purge-jobdata-job 

Job details 
---------------------------------------------------------------- 
ID: e43dbd56-dc7c-4812-b653-0fc3208e0929 
Description: purge job data 
Status: Created 
Created: April 23, 2020 6:27:40 PM PDT 

Message: 
Task Name Start Time End Time Status
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
[root@oda1]# odacli describe-job -i e43dbd56-dc7c-4812-b653-0fc3208e0929 
Job details 
---------------------------------------------------------------- 
ID: e43dbd56-dc7c-4812-b653-0fc3208e0929 
Description: purge job data 

Status: Success 
Created: April 23, 2020 6:27:40 PM PDT 
Message: Purged 21 metadata records and 10 files. Purge policies are: 
Purge all jobs and scheduled executions older than 30 Days 
Purge scheduled executions for ID:284a22b5-41e6-4be1-a916-048eac74e076 older than 10 Day 

Task Name   Start Time  End Time    Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
purge job data  April 23, 2020 6:27:40 PM PDT   April 23, 2020 6:27:40 PM PDT   Success

Example 16-188 Purging job data older than 5 hours, including all jobs and scheduled executions related records

# odacli create-purge-jobdata-job -o 5 -u Hour 
Job details 
---------------------------------------------------------------- 
ID: 4d065c96-a8eb-4974-a446-573b5ad3cb95 
Description: purge job data 
Status: Created 
Created: April 23, 2020 1:55:59 PM PDT 
Message:  
Task Name Start Time End Time Status 

---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
[root@oda1]# odacli describe-job -i 4d065c96-a8eb-4974-a446-573b5ad3cb95 

Job details 
---------------------------------------------------------------- 
ID: 4d065c96-a8eb-4974-a446-573b5ad3cb95 
Description: purge job data 
Status: Success 
Created: April 23, 2020 1:55:59 PM PDT 
Message: Purged 242 metadata records and 0 files. Purge policies are: 
Purge all jobs and scheduled executions older than 5 Hour 

Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
purge job data      April 23, 2020 1:55:59 PM PDT       April 23, 2020 1:55:59 PM PDT       Success

Example 16-189 Purging job data for multiple jobs

# odacli create-purge-jobdata-job -i 87a926cd-a243-49e0-ba02-9d8968e1de1e,0e2a38c0-041a-41d8-91ad-7f9f7c646f12 

Job details 
---------------------------------------------------------------- 
ID: 217cbdbf-15a5-47d3-9582-3f26d6b5eebf 
Description: purge job data 
Status: Created 
Created: April 23, 2020 2:01:25 PM PDT 
Message: Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 

[root@oda1]# odacli describe-job -i 217cbdbf-15a5-47d3-9582-3f26d6b5eebf 
Job details 
---------------------------------------------------------------- 
ID: 217cbdbf-15a5-47d3-9582-3f26d6b5eebf 
Description: purge job data 
Status: Success 
Created: April 23, 2020 2:01:25 PM PDT 
Message: Purged 11 metadata records and 0 files. Purge policies are: 
Purge job with ID:87a926cd-a243-49e0-ba02-9d8968e1de1e 
Purge job with ID:0e2a38c0-041a-41d8-91ad-7f9f7c646f12 

Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
purge job data      April 23, 2020 2:01:25 PM PDT       April 23, 2020 2:01:25 PM PDT       Success

Example 16-190 Purging job data for specific job data schedules older than 5 days

# odacli create-purge-jobdata-job -s 39cc86d6-30c2-4744-bfbc-e62535e2aa67,31b3a83b-76ca-44d3-9268-b4dac948e217 -o 5 -u Day 

Job details 
---------------------------------------------------------------- 
ID: be839a81-a79b-43ce-bf70-c8aba1a9cc91 
Description: purge job data 
Status: Created 
Created: April 23, 2020 2:44:54 PM PDT 
Message: 

Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
[root@oda1]# ./odacli describe-job -i be839a81-a79b-43ce-bf70-c8aba1a9cc91 

Job details 
---------------------------------------------------------------- 
ID: be839a81-a79b-43ce-bf70-c8aba1a9cc91 
Description: purge job data 
Status: Success 
Created: April 23, 2020 2:44:54 PM PDT 
Message: Purged 0 metadata records and 0 files. Purge policies are: 
Purge scheduled executions for ID:39cc86d6-30c2-4744-bfbc-e62535e2aa67 older than 5 Day 
Purge scheduled executions for ID:31b3a83b-76ca-44d3-9268-b4dac948e217 older than 5 Day 
Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
purge job data April 23, 2020 2:44:54 PM PDT April 23, 2020 2:44:54 PM PDT Success

Parent topic: odacli Job Commands

odacli delete-jobdata-retention-policy

Use the odacli delete-jobdata-retention-policy command to delete job data retention for default DCS jobs and specific auto scheduled jobs.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To delete job data retention:

   odacli delete-jobdata-retention-policy [-j] [-h][-s]

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--scheduleIds, -s

(Optional) Specifies the IDs applied by the job data retention policy. If not supplied, delete all the existing policies.

Example 16-191 Deleting the job data retention policies

# odacli delete-jobdata-retention-policy 

Job details 
---------------------------------------------------------------- 
ID: ab819d57-9e35-4f55-bd5e-d26fc6372448 
Description: delete job data retention policy 
Status: Running 
Created: April 23, 2020 7:34:05 PM PDT 

Message: 
Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
remove job data retention policy entries        April 23, 2020 7:34:05 PM PDT       April 23, 2020 7:34:05 PM PDT       Running 

[root@oda1]# odacli describe-job -i ab819d57-9e35-4f55-bd5e-d26fc6372448 

Job details 
---------------------------------------------------------------- 
ID: ab819d57-9e35-4f55-bd5e-d26fc6372448 
Description: delete job data retention policy 
Status: Success 
Created: April 23, 2020 7:34:05 PM PDT 
Message: 

Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
remove job data retention policy entries        April 23, 2020 7:34:05 PM PDT       April 23, 2020 7:34:05 PM PDT       Success 
remove auto job data schedule                   April 23, 2020 7:34:05 PM PDT       April 23, 2020 7:34:05 PM PDT       Success 

[root@oda1]# odacli list-jobdata-retention-policy 

DCS-10032:Resource JobDataRetentionPolicy is not found.

Parent topic: odacli Job Commands

odacli describe-job

Use the odacli describe-job command to display details about a specific job, including the job ID, status, tasks, and the job created date and time stamp.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To view a specific job, status, and tasks:

   odacli describe-job -i id [-e] [-n parent_task] [-sd sorted_by_duration] [-s status] [-j] [-h]

Parameters

Parameter Description

--id, -i

(Mandatory) Identifies the job. To get the job identifier (jobid), run the list-jobs command.

--ecr, -e

(Optional) Specifies to display the error correlation report.

--number, -n

(Optional) Specifies the number of parent tasks.

--sort-duration, -sd

(Optional) Sorts tasks by duration, either ascending (asc) or descending (desc).

--status, -s

(Optional) Specifies the status of the task, such as running, failure, success.

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Example 16-192 Displaying Details for a Job

To display details of a specific job with job ID 02df22c8-c21f-4162-8265-97f7826c243a: 

 # odacli describe-job -i 02df22c8-c21f-4162-8265-97f7826c243a

Example 16-193 Viewing Error Correlation Report

To view error correlation report using ODACLI command:

# odacli describe-job -i cb6faa85-d2b4-441a-864a-17a8532cf78d --ecr
ODA Assistant - Error Correlation report
----------------------------------------
          Failed job ID: cb6faa85-d2b4-441a-864a-17a8532cf78d
            Description: Database service deletion with DB name: zdjGIEn with id : 4ab1da3e-3918-4acf-bb7f-5529e750849f
             Start Time: 2023-04-14 07:24:37
               End Time: 2023-04-14 07:26:59
         EC report path:
/opt/oracle/dcs/da/da_repo/0ae47ffd-5641-47ed-b66f-f674a6c1fb1d.json

Failed Task Messages
--------------------
[Database service deletion with DB name: zdjGIEn with id : 4ab1da3e-3918-4acf-bb7f-5529e750849f] - DCS-10001:Internal error encountered: Failed to delete: RECO/ZDJGIENU for the database: zdjGIEn.

oda1 Log Messages
----------------------------
  DCS Agent
  ~~~~~~~~~
    Error Logs
    ==========
    [Kill Pmon Process] - No process running for database : zdjGIEnU
    [Database Files Deletion] - Failed to delete directory RECO/ZDJGIENU due
to error: ORA-29261: bad argument
    [Database Files Deletion] - ORA-15178: directory 'ZDJGIENU' is not empty;
cannot drop this directory
    [Database Files Deletion] - ORA-15028: ASM file '+RECO.431.1134101713'
not dropped; currently being accessed
    [Database Files Deletion] - ORA-06512: at "SYS.X$DBMS_DISKGROUP", line
666
    [Database Files Deletion] - ORA-06512: at line 2 (DBD ERROR:
OCIStmtExecute)
    [Database Files Deletion] - Failed to delete: RECO/ZDJGIENU for the
database: zdjGIEn
    [Database Service deletion for 4ab1da3e-3918-4acf-bb7f-5529e750849f] -
DCS-10001:Internal error encountered: Failed to delete: RECO/ZDJGIENU for the
database: zdjGIEn.
      Error code - DCS-10001
      Cause: An internal error occurred.
      Action: Contact Oracle Support for assistance.
RHP Error Logs
    ==========
    [jobid-cb6faa85-d2b4-441a-864a-17a8532cf78d] -
[BatchMoveOpImpl.getMoveDBStateInfo:9195] attempt to fetch metadata from repos failed with EntityNotExistsException : PRGR-110 : Repository object "dbsa03b123e2;;;/u01/app/oracle/product/19.0.0.0/dbhome_1" of type "MOVE" does not exist.
      Error code - PRGR-110
      Cause: The specified repository object does not exist in the repository
database.
      Action: Specify the correct repository object name.
    [jobid-cb6faa85-d2b4-441a-864a-17a8532cf78d] -[GridHomeFactoryImpl.getTempLocation:1437] Exception node : PRCR-1001 : Resource ora.rhpserver does not exist
      Error code - PRCR-1001
      Cause: An attempt was made to operate on a resource that does not
exist.
      Action: Check the resource using the command 'srvctl config <object>'
and if the resource does not exist, then create it using the command 'srvctl
add <object>'.

Release Notes
-------------
  No matching results were found.

Documentation
-------------
  1. Deleting a Database
      Abstract - Use the Oracle Appliance Manager Browser User Interface to delete an Oracle database.
      Link -
https://domainname:7093/docs/cmtxn/managing-databases-oda.html#GUID-D85D987A-1D9E-4615-B9DB-65B4B393B1D1

Parent topic: odacli Job Commands

odacli list-jobs

Use the odacli list-jobs command to display a list of jobs, including the job IDs, status, and the job created date and time stamp. The default number of jobs listed is 50 from the earliest to the latest.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To list jobs and view job details and status:

odacli list-jobs [-all] [-d] [-desc description_pattern] [-ec] [-o day]
    [-f from] [-hd head] [-l last] [-msg message_pattern]
    [-ndesc not_match_description_pattern]
    [-nmsg not_match_message_pattern] [-sd sorted_by_duration]
    [-s status] [-tl tail] [-t to] [-j] [-h]

Parameters

Parameter Description

--all-jobs, -all

(Optional) Displays jobs created by both DCS and error correlation framework.

--ec-jobs, -ec

(Optional) Displays jobs created by the error correlation framework.

--for, -o

(Optional) Describes a job created on a specific date. In the format YYYY-MM-DD, such as 2018-01-01 .

Example:

# odacli list-jobs -o 2018-08-09

--from, -f

(Optional) Describes a job created since a specific date. In the format YYYY-MM-DD or YYYY-MM-DD HH:mm:ss, such as 2018-01-01 or 2018-01-01 01:00:00.

Examples:

# odacli list-jobs -f 2018-08-27
# odacli list-jobs -f "2018-08-27 03:00:00"

--head, -hd

(Optional) Describes the maximum number of older jobs to be displayed, values can be 1 to 200.

Example:

odacli list-jobs -hd 10

--to, -t

(Optional) Describes a job created ahead of a specific date. In the format YYYY-MM-DD or YYYY-MM-DD HH:mm:ss, such as 2018-01-01 or 2018-01-01 01:00:00.

Example:

# odacli list-jobs -t 2018-08-07

--last, -l

(Optional) Describes jobs created from last 'n' time unit - where n can be any integer and time unit can be d for days, h for hours or m for minutes.

--tail, -tl

(Optional) Describes the maximum number of latest jobs to be displayed, values can be 1 to 200.

Example:

# odacli list-jobs -tl 10

--description, -desc

(Optional) Specifies the pattern to filter jobs based on their description. For example, .*a, b.*, .*a|b.*

--no-desc, -ndesc

(Optional) Specifies the pattern to filter jobs that do not match their description. For example, .*a, b.*, .*a|b.*

--message, -msg

(Optional) Specifies the pattern to filter jobs based on their message. For example, .*a, b.*, .*a|b.*

--no-message, -nmsg

(Optional) Specifies the pattern to filter jobs that do not match their message. For example, .*a, b.*, .*a|b.*

--sort-duration, -sd

(Optional) Specifies to sort jobs by duration, either asc or desc.

--status, -s

(Optional) Specifies the status of the job, such as created, scheduled, running, failure, success, internalerror.

Example:

# odacli list-jobs -s success

--describe-job, -d

(Optional) Specifies the description of the filtered job, if the filter returns a single job.

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Example 16-194 Displaying a List of Jobs

To display a list of jobs:

# odacli list-jobs

ID                           Description            Created
---------------------------- ---------------------  ----------------------------
a6084067-72a1-4625-bea7-efd  Provisioning service   creation Jun 2, 2018 10:19:23 AM

(Continued)
Status
-------
Success

Example 16-195 Displaying Specified Number of Older Jobs

To display a specified number of older jobs:

# odacli list-jobs -hd 5
ID Description Created Status 
--- --- --
643c6186-a667-43d7-847f-d756a96fa072 Create detailed Backup Report 
August 5, 2018 12:36:26 AM UTC Success 
f29cb82c-6150-487d-aaff-52d65f6ab972 Create recovery-pitr : time '08/05/2018 07:16:12' 
for db : igIyoz August 5, 2018 1:01:39 AM UTC Success 
cfe19337-ab2f-4ef3-85b5-24601ba31be2 Create detailed Backup Report 
August 5, 2018 1:17:46 AM UTC Success 
3749b5e2-240e-4df5-b3c1-32d345243b25 Create detailed Backup Report 
August 5, 2018 2:01:07 AM UTC Success 
64828852-bb16-4f06-aca9-4bdf9fe7b6f2 Create regular-5 Backup with TAG-iD5UNjBZ8HN2FYL 
for Db:igIyoz August 5, 2018 2:14:19 AM UTC Success

Example 16-196 Displaying Jobs in a Date Range

To display jobs created within a time frame:

# ./odacli list-jobs -f 2018-08-07 -t 2018-08-08
ID Description Created Status 
--- --- --
1fc5ef97-a9db-49b2-9664-7c551bd005f4 Authentication key update for test_user August 7, 2018 12:56:58 AM UTC Success 
e24f86cf-bb2e-4ebe-84e0-da5cedb27ad4 Provisioning service creation August 7, 2018 1:00:54 AM UTC Success 
7f67efd6-cce5-47b4-8dc4-fdb732491f99 CPU cores service update August 7, 2018 1:41:05 AM UTC Success 
0ae9a312-bac8-43be-8a64-5a12c24c2a02 SSH keys update August 7, 2018 1:42:59 AM UTC Success 
af41fdc1-87ff-46cd-bc41-26615e115ae7 SSH key delete August 7, 2018 1:44:56 AM UTC Success 
79e4cbb0-b474-48ab-9e04-d3d602bc0ed2 DcsCli patching August 7, 2018 1:50:18 AM UTC Success 
edd55e7d-f81f-4a10-942d-1121aef0bff3 DcsCli patching August 7, 2018 1:50:32 AM UTC Success 
acc22c60-3476-4566-8faa-4d36b116eded create backup config:aaaaaaaaaaaaaaaaaaaaaaaaaaaaa August 7, 2018 2:01:46 AM UTC Success 
d89efedf-9110-429a-a3b2-ccd6a53f8564 Database Home OraDB12201_home2 creation with version :12.2.0.1 August 7, 2018 2:36:05 AM UTC Success 
2a5532ae-41fa-47c2-bc90-010a5f26d6b2 Database service creation with db name: my122 August 7, 2018 3:52:38 AM UTC Success 
c4e533e9-c596-478f-92db-2f11f1384075 Discover Components : all August 7, 2018 4:07:09 AM UTC Success 
149e89b5-27d3-4c7c-9c03-f029ca3dd495 Discover Components : all August 7, 2018 4:08:45 AM UTC Success 
21d4c37b-49ad-48dd-a1db-1f25d9288312 Database Home OraDB11204_home1 creation with version :11.2.0.4 August 7, 2018 4:19:32 AM UTC Success 
b61dbbca-edc1-4a4a-9db2-82b0bdcb64e6 Database service deletion with db name: myTestDb with id : 6400c81d-5837-480c-b4a1-7c01591ee144 August 7, 2018 4:24:50 AM UTC Success 
d4a104df-5796-4e37-9173-82f0e263d642 create backup config:bkfgd August 7, 2018 4:28:54 AM UTC Success 
a121d40b-f33b-47a4-8fc6-4e3b84173f44 Database service creation with db name: my112 August 7, 2018 6:51:13 PM UTC Success 
42dd661f-9ba0-4877-ace9-39d3f212c071 Discover Components : all August 7, 2018 7:12:56 PM UTC Success 
2f648f5a-c9c5-42ec-adb0-98cf6497c89e Discover System Components : system August 8, 2018 3:28:12 AM UTC Success 
a5755f43-509d-4d4c-b7ef-9f99660c4de7 DB Home Patching: Home Id is 97df26b3-42f2-4189-805b-82d1b38737d0 August 8, 2018 3:52:08 AM UTC Success 
79b0e697-065f-4630-a524-8d072a4e139a Database Home OraDB12102_home1 creation with version :12.1.0.2 August 8, 2018 4:34:30 AM UTC Success 
112b75bc-3512-4c28-a479-3e0317eb0dc4 Database service creation with db name: mynew121 August 8, 2018 8:02:51 AM UTC Failure 
09f56fb0-1e91-4b02-a9b8-5add11a8da32 Database service creation with db name: my121a August 8, 2018 9:13:01 AM UTC Success 
5633ded9-07ea-4bf9-9533-31eb65789fe7 Database service deletion with db name: mynew121 with id : 24be4362-16c8-476f-903a-f6f2ef59f5e4 August 8, 2018 9:24:31 AM UTC Success 
458d1c45-02dc-456c-ae88-5da613faaa66 Database service creation with db name: mynew121 August 8, 2018 9:27:31 AM UTC Success 
f178f378-a9d7-4d5c-b6f5-6f62ea4e05bb Database service deletion with db name: myTestDb with id : ef50387b-0c62-4446-b210-f8d070e2a043 August 8, 2018 9:40:43 AM UTC Success 
7fab740f-a711-466a-ba6d-dd5643374c28 Database service deletion with db name: myTestDb with id : 6632a083-558a-4eb4-8c2b-af0710179980 August 8, 2018 9:41:04 AM UTC Success 
3121529d-2b9d-4bbe-bf58-996c2cf46996 Database service creation with db name: mydss August 8, 2018 9:42:06 AM UTC Success 
3d0a9261-19d7-42bb-8b92-00fcc4f8c41e Discover Components : db August 8, 2018 10:17:22 AM UTC Success

Parent topic: odacli Job Commands

odacli list-pendingjobs

Use the odacli list-pendingjobs command to list all pending jobs.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-pendingjobs [-j] [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Example 16-197 

# odacli list-pendingjobs

Parent topic: odacli Job Commands

odacli list-jobdata-retention-policy

Use the odacli list-jobdata-retention-policy command to list job data retention policy for default DCS jobs and specific auto scheduled jobs.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To list jobs and view job details and status:

   odacli list-jobdata-retention-policy [-j] [-h]

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Example 16-198 Listing all job retention policies

# odacli list-jobdata-retention-policy 

Schedule Id Retention Window Unit Modified 
---------------------------------------- -------------------- -------------------- ------------------------- 
Default     30  Days     April 23, 2020 6:16:59 PM PDT 
284a22b5-41e6-4be1-a916-048eac74e076    10  Days     April 23, 2020 6:22:14 PM PDT

Parent topic: odacli Job Commands

odacli list-purge-jobdata-jobs

Use the odacli list-purge-jobdata-jobs command to list purge job data for default DCS jobs and specific auto scheduled jobs.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To list job data purge policy:

   odacli list-purge-jobdata-jobs [-j] [-h]

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

The command describes the files that are purged, the purged count, the purged file size, and the time of purge.

Example 16-199 Listing history, statistics, and rules for job data purge jobs

# odacli list-purge-jobdata-jobs 

Purge By Job                             Purged Object             Count      Size       Type            Purged Time         
---------------------------------------- ---------------------- ---------- ---------- --------------- --------------------
4d065c96-a8eb-4974-a446-573b5ad3cb95        TaskReport              102                 Metadata        April 23, 2020 1:55:59 PM PDT 
4d065c96-a8eb-4974-a446-573b5ad3cb95        ServiceJobReport        24                  Metadata        April 23, 2020 1:55:59 PM PDT 
4d065c96-a8eb-4974-a446-573b5ad3cb95        LogCleanupSummary       2                   Metadata        April 23, 2020 1:55:59 PM PDT 
4d065c96-a8eb-4974-a446-573b5ad3cb95        JobExecutionResource    93                  Metadata        April 23, 2020 1:55:59 PM PDT 
4d065c96-a8eb-4974-a446-573b5ad3cb95        JobDataPurgeResult      21                  Metadata        April 23, 2020 1:55:59 PM PDT

Parent topic: odacli Job Commands

odacli list-scheduled-executions

Use the command odacli list-scheduled-executions to display a list of jobs that were executed.

File Path

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

Syntax

   odacli list-scheduled-executions [-e] [-1] [-j] [-h]

Parameters

Parameter Description
--executionid, -e

(Optional) Displays the execution ID.
--scheduleid, -i

(Optional) Displays the Schedule ID.
--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output. The default is false.

Example 16-200 Displaying a List of Scheduled and Executed Jobs

Display a list of scheduled tasks, the status, and the date and time that the task was executed. In the following example, three (3) scheduled tasks were executed. One task, Schedule ID 04b5750c-0d13-42cf-aba3-85416e8edafb, was executed twice.

# odacli list-scheduled-executions

ID                                     ScheduledId                            JobId                                  
-------------------------------------- -------------------------------------- -------------------------------------- 
9890508c-ff6d-4307-972f-7962ec390871   04b5750c-0d13-42cf-aba3-85416e8edafb                                          
10a33e08-695c-4d13-b970-7dc7215f3cdd   7ee1e2aa-80a8-4297-97f7-365b84bcce4d                                          
4a9e9796-4bed-4df7-af1e-de49362dda97   04b5750c-0d13-42cf-aba3-85416e8edafb

(Continued)
Status    Executed Time
--------- -------------------------------
Executed  February 4, 2018 12:00:00 AM UTC
Executed  February 4, 2018 12:00:00 AM UTC
Executed  February 5, 2018 12:00:00 AM UTC

To learn more about a scheduled backup, run the command odacli list-schedules. The output displays the ID, name, description, and schedule for each task. 

 # odacli list-schedules

ID                                       Name                         Description                                   
--------------------------------------- ---------------------------- -----------------------------------------------
d136cc72-4a80-4ab8-9f1e-120b995b2794    metastore maintenance         internal metastore maintenance                
04b5750c-0d13-42cf-aba3-85416e8edafb    AgentState metastore cleanup  internal agentstateentry metastore maintenance
7ee1e2aa-80a8-4297-97f7-365b84bcce4d    backupreport maintenance      backup reports deletion                       

(Continued)
CronExpression                 Disabled
------------------------------ --------
0 0 0 1/1 * ? *                true   
0 0 0 1/1 * ? *                false  
0 0 0 1/3 * ? *                false

Parent topic: odacli Job Commands

odacli Oracle Key Vault Server Configuration Commands

Use odacli commands to manage Oracle Key Vault server configuration for databases on Oracle Database Appliance.

Parent topic: Oracle Database Appliance Command-Line Interface

odacli create-okvserverconfig

Use the command odacli create-okvserverconfig to create an Oracle Key Vault server configuration.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli create-okvserverconfig -n name -u okv_user_name [-d okv_description] [-host okv_host_name] [-ip okv_ip_address] [-h] [-j]

Parameters

Parameter Description
--name, -n

(Mandatory) Specifies the name of the Oracle Key Vault server configuration object.
--user-name, -u

(Mandatory) Specifies the name of the Oracle Key Vault user on the Oracle Key Vault server.
--description, -d

(Optional) Describes the Oracle Key Vault server configuration object.
--hostname, -host

(Optional) Specifies the name of the Oracle Key Vault server where the Oracle Key Vault user has an account.
--server-ip, -ip

(Optional) Specifies the IP address of the Oracle Key Vault server where the Oracle Key Vault user has an account.
--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output. The default is false.

Usage Notes

To create an Oracle Key Vault server configuration okvobj1 for the Oracle Key Vault server user epokvusr1 on the specified server:

Example 16-201 Creating an Oracle Key Vault server configuration

odacli create-okvserverconfig -n okvobj1 -u epokvusr1 -ip xxx.xx.xxx.xxx
Enter OKV user password :
Retype OKV user password :

Parent topic: odacli Oracle Key Vault Server Configuration Commands

odacli copy-okvtdewallet

Use the command odacli copy-okvtdewallet to copy an Oracle Key Vault TDE wallet.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli copy-okvtdewallet -swn source_wallet_name -tosc target_okv_server_config -twn target_okv_wallet_name [-shn hostname] [-sip ip_address] [-su user_name] [-j] [-h]

Parameters

Parameter Description
--source-wallet-name, -swn

(Mandatory) Specifies the name of the wallet from which TDE keys must be copied to the target wallet in the Oracle Key Vault server.
--target-okvserverconfig, -tosc

(Mandatory) Specifies the name of the Oracle Key Vault server configuration object where the target wallet must be created.
--target-wallet-name, -twn

(Mandatory) Specifies the name of the wallet to which the TDE keys must be copied from the source wallet in the Oracle Key Vault server.
--source-hostname, -shn

(Optional) Specifies the fully-qualified domain name (FQDN) of the Oracle Key Vault server where the source wallet is created. Specify this value only if the source wallet and the target wallet use different Oracle Key Vault servers.
--source-ip, -sip

(Optional) Specifies the IP address of the Oracle Key Vault server where the source wallet is created. Specify this value only if the source wallet and the target wallet use different Oracle Key Vault servers.
--source-username, -su

(Optional) Specifies the name of the Oracle Key Vault user who owns the source wallet on the Oracle Key Vault server. Specify this value only if the source wallet and the target wallet use different Oracle Key Vault servers.
--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output. The default is false.

Example 16-202 Copying the TDE wallet in the same Oracle Key Vault server and owned by the same Oracle Key Vault user

The source TDE wallet and the target TDE wallet are on the same Oracle Key Vault server, and both are owned by the same user on the Oracle Key Vault server.

odacli copy-okvtdewallet -swn tdeokv_on_scaoda8m013-c -tosc okvobj1 -twn tdeokvss
Job details                                                     
----------------------------------------------------------------
                     ID:  50df7dcc-8e17-48db-9206-879c44e57c20
            Description:  Copy wallet in OKV server
                 Status:  Success
                Created:  June 20, 2024 2:56:02 AM CST
                Message: 
 
Task Name                                Start Time                               End Time                                 Status         
---------------------------------------- ---------------------------------------- ---------------------------------------- ----------------
Creating a TDE wallet copy in the OKV    June 20, 2024 2:56:03 AM CST             June 20, 2024 2:57:17 AM CST             Success        
server

Example 16-203 Copying the TDE wallet on the same Oracle Key Vault server but using a different Oracle Key Vault user

The source and the target wallet are on the same Oracle Key Vault server but are owned by different users on the Oracle Key Vault server. In this scenario, the target wallet user must copy the source wallet with the following command. Before running the ODACLI command to copy the wallet, the source wallet Oracle Key Vault user must provide read and manage access permissions on the wallet, to the target wallet Oracle Key Vault user. For more details, see the Restoring TDE-Enabled Database with TDE Keys Stored on Oracle Key Vaulttopic. 

odacli copy-okvtdewallet -swn tdeokv_on_scaoda8m013-c -tosc okvobj2 -twn tdeokvdu
Job details                                                     
----------------------------------------------------------------
                     ID:  50df7dcc-8e17-48db-9206-879c44e57c20
            Description:  Copy wallet in OKV server
                 Status:  Success
                Created:  June 20, 2024 2:56:02 AM CST
                Message: 
 
Task Name                                Start Time                               End Time                                 Status         
---------------------------------------- ---------------------------------------- ---------------------------------------- ----------------
Creating a TDE wallet copy in the OKV    June 20, 2024 2:56:03 AM CST             June 20, 2024 2:57:17 AM CST             Success        
server

Example 16-204 Copying the TDE wallet to a different Oracle Key Vault server

The source wallet and the target wallet are on different Oracle Key Vault servers. Specify the source wallet Oracle Key Vault server details also must be provided in the ODACLI command. Specify the source wallet Oracle Key Vault user password, when prompted. 

odacli copy-okvtdewallet -swn tdeokv_on_scaoda8m013-c -sip xxx.xx.x.xxx -su epokvusr1 -tosc okvobj3 -twn tdeokvds
Enter OKV user password:
Retype OKV user password:
 
Job details                                                     
----------------------------------------------------------------
                     ID:  50df7dcc-8e17-48db-9206-879c44e57c20
            Description:  Copy wallet in OKV server
                 Status:  Success
                Created:  June 20, 2024 2:56:02 AM CST
                Message: 
 
Task Name                                Start Time                               End Time                                 Status         
---------------------------------------- ---------------------------------------- ---------------------------------------- ----------------
Creating a TDE wallet copy in the OKV    June 20, 2024 2:56:03 AM CST             June 20, 2024 2:57:17 AM CST             Success        
server

Parent topic: odacli Oracle Key Vault Server Configuration Commands

odacli delete-okvserverconfig

Use the command odacli delete-okvserverconfig to delete an Oracle Key Vault server configuration.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli delete-okvserverconfig [-n name] [-h] [-j]

Parameters

Parameter Description
--name, -n

(Mandatory) Specifies the Oracle Key Vault server configuration to delete.
--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output. The default is false.

Usage Notes

Use the odacli delete-okvserverconfig command to delete Oracle Key Vault server configuration. You can delete the Oracle Key Vault server configuration only if the databases that used the Oracle Key Vault server configuration are already deleted.

Example 16-205 Deleting Oracle Key Vault server configuration

odacli delete-okvserverconfig -n okvobj1

Parent topic: odacli Oracle Key Vault Server Configuration Commands

odacli describe-okvserverconfig

Use the command odacli describe-okvserverconfig to view the Oracle Key Vault server configuration details.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli describe-okvserverconfig [-n name] [-h] [-j]

Parameters

Parameter Description
--name, -n

(Mandatory) Specifies the Oracle Key Vault server configuration.
--help, -h

(Optional) Displays help for using the command.
--json, -j

(Optional) Displays JSON output. The default is false.

Usage Notes

For example, the odacli describe-okvserverconfig command in a multi-user access enabled system displays the following:

Example 16-206 Viewing Oracle Key Vault server configuration details in a multi-user access enabled system

odacli describe-okvserverconfig -n okvobj1
 
OKV Server Config details                                            
----------------------------------------------------------------
                     ID: 441fb120-35f8-4c9a-9a5c-76aebaba1c36
                   Name: okvobj1
          OKV User Name: epadmin
          OKV Server IP: xxx.xx.xx.xxx
          Primary owner: okvusr1
       Secondary owners: [odaadmin,dbusr1, dbusr2]
 
 
 
odacli describe-okvserverconfig -n okvobj1 -j
 
{
    "ID" : "441fb120-35f8-4c9a-9a5c-76aebaba1c36",
    "Name" : "okvobj1"
    "Primary owner" : "okvusr1"
    "Secondary Owners : [ "odaadmin", "dbusr1", "dbusr2" ]
    "createTime" : "January 04, 2024 11:25:04 AM UTC",
    "updatedTime" : "January 04, 2024 11:37:48 AM UTC"
}

Example 16-207 Viewing Oracle Key Vault server configuration details in a non-multi user access enabled system

In a non-multi user access enabled system, the primary and secondary owner details are not displayed:

odacli describe-okvserverconfig -n okvobj1
 
OKV Server Config details                                            
----------------------------------------------------------------
                     ID: 441fb120-35f8-4c9a-9a5c-76aebaba1c36
                   Name: okvobj1
          OKV User Name: epadmin
          OKV Server IP: xxx.xxx.xx.xxx
 
odacli describe-okvserverconfig -n okvobj1 -j
 
{
    "ID" : "441fb120-35f8-4c9a-9a5c-76aebaba1c36",
    "Name" : "okvobj1",
    "OKV User Name" : "epadmin",
    "OKV Server IP": "xxx.xxx.xx.xxx",
    "createTime" : "January 04, 2024 11:25:04 AM UTC",
    "updatedTime" : "January 04, 2024 11:37:48 AM UTC"
}

Example 16-208 Viewing Oracle Key Vault server configuration details with the -j option 

odacli describe-okvserverconfig -n dokvobj1 -j
{
  "id" : "2348516e-37f4-41a6-b482-c70ce0e53bc8",
  "name" : "dokvobj1",
  "userName" : "user1",
  "hostname" : null,
  "ipAddress" : "xxx.xxx.xx.xxx",
  "description" : null,
  "createTime" : "October 20, 2024 05:49:22 AM PDT",
  "updatedTime" : "October 20, 2024 05:49:47 AM PDT",
  "state" : {
    "status" : "CONFIGURED"
  }
}

Parent topic: odacli Oracle Key Vault Server Configuration Commands

odacli list-okvserverconfigs

Use the command odacli list-okvserverconfigs to view all Oracle Key Vault server configurations.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli list-okvserverconfigs [-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-209 Viewing all Oracle Key Vault server configurations 

odacli list-okvserverconfigs
 
ID                                       Name                 User Name         IP address          Host Name           Description
---------------------------------------- -------------------- ---------------- ------------------- -------------------- -------------------
d017d35a-0757-460a-98f0-9f8d0944c872     okvobj1              epadmin           xxx.xx.xx.xxx       Null                 Brief description              
b6336173-666b-4d81-88bd-5ae384419114     okvobj2              epadmin2          xxx.xx.xx.xxx       Null                 Brief description

Parent topic: odacli Oracle Key Vault Server Configuration Commands

Log Commands

Use the odacli log commands to specify the options to collect and delete logs.

Parent topic: Oracle Database Appliance Command-Line Interface

odaadmcli manage diagcollect

Use the odaadmcli manage diagcollect command to collect diagnostic logs for Oracle Database Appliance components.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To collect diagnostic logs for components:

   odaadmcli manage diagcollect [-h] [--dataMask] [--dataSanitize] [--fromTime] [--toTime] [--Components]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--dataMask

(Optional) Masks sensitive data. The default is No.

--dataSanitize

(Optional) Sanitizes (redacts) sensitive data. The default is No.

--fromTime

(Optional) Specifies the time from when you want to collect data. The timestamp formats can be of the type: mon/dd/yyyy hh:mm:ss, or yyyy-mm-dd hh:mm:ss, or yyyy-mm-ddThh:mm:ss, or yyyy-mm-dd.

--toTime

(Optional) Specifies the time till when you want to collect data. The timestamp formats can be of the type: mon/dd/yyyy hh:mm:ss, or yyyy-mm-dd hh:mm:ss, or yyyy-mm-ddThh:mm:ss, or yyyy-mm-dd.

--Components

(Optional) Specifies the comma-separated list of components for which you want to collect data. The supported values are:

all, ips, oda, odalite, dcs, odabackup, odapatching, odadataguard, odaprovisioning, odaconfg, odasystem, odastorage, database, asm, crsclient, dbclient, dbwlm, tns, rhp, procinfo, afd, crs, cha, wls, emagent, oms, ocm, emplugins, em, acfs, install, cfgtools, os, ashhtml, ashtext, awrhtml, awrtext

--verbose

Displays detailed message.

Usage Notes

The following types of sensitive information can be redacted using the --dataMask or the --dataSanitize option:

  • Host names

  • IP addresses

  • Database names

  • Tablespace names

  • Service names

  • Ports

  • Operating System user names

For example, when the --dataMask option is used, all instances of a sensitive name such as a database name called "payrolldb" are replaced with "*********" in the TFA collection.

For example, when the --dataSanitize option is used, all instances of a sensitive name such as a database name called "payrolldb" are replaced with another string, such as "oCjlN7F8P", in the TFA collection.

Example 16-210 Masking Sensitive Data in Log Collection

# /opt/oracle/oak/bin/odaadmcli manage diagcollect --dataMask
DataMask is set as true
TFACTL command is: /opt/oracle/tfa/tfa_home/bin/tfactl
Data mask is set.
Collect data within last 12 hours as default
Please wait for several minutes for the collection to complete.

Parent topic: Log Commands

odacli create-auto-logclean-policy

Use the odacli create-auto-logclean-policy command to create a policy for a job to automatically purge log files for a specified time period when certain criteria are met.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

   odacli create-auto-logclean-policy [-h] [-c] [-o] [-u] [-uMB] [-f] [-uPer]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--components, -c

(Optional) Specifies the list of components, separated by comma. The values are gi|database|dcs For example, gi|dcs.

--olderthan, -o

(Optional) Cleans logs older than specified time interval. Default is 30 if it is not specified.

--olderThanUnit, -u

(Optional) Unit for the --olderthan parameter. Default is Day if it is not specified.

--freeSpaceBelowPercentage, -f

Starts purge when free disk space is below the specified number of percentage of the total partition size. Valid range is 20-50. Default is 20.

--usageOverMB, -uMB

Starts purge when log usage is over the specified number of MB. Valid range is 10%-50% of partition size.

--usageOverPercentage, -uPer

Starts purge when log usage is over the specified number of percentage of total partition space. Valid range is 10-50.

Example 16-211 Creating Automatic Jobs to Purge Logs

To create a policy for automatic jobs to purge logs:

# odacli create-auto-logclean-policy -c 'dcs' -o 30 -uPer 30
Component  UsageOverPercentage  freeSpaceBelowPercentage UsageOverMB OlderThan   OlderThanUnit       

-------------------- -------------- -------------------- -------------------- -------------
dcs                  30                   20                   0             30           Day

Parent topic: Log Commands

odacli delete-auto-logclean-policy

Use the odacli delete-auto-logclean-policy command to delete a policy for a job to automatically purge log files for a specified time period when certain criteria are met.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

   odacli odacli delete-auto-logclean-policy [-c] [-h] [-j]

Parameters

Parameter Description

--components, -c

(Optional) Specifies the list of components, separated by comma. The values are gi|database|dcs For example, gi|dcs.

--help, -h

(Optional) Displays help for using the command.

--json, -j

  (Optional) Displays JSON output. The default is false.

Parent topic: Log Commands

odacli create-logcleanjob

Use the odacli create-logcleanjob command to create a job to purge log files for a specified time period.

File Path

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

Syntax

To list jobs and view job details and status:

   odacli create-logcleanjob [-h] [-c] [-o] [-u]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--components, -c

(Optional) Specifies the list of components, separated by comma. The values are gi|database|dcs For example, gi,dcs.

--olderthan, -o

(Optional) Cleans logs older than specified time interval. Default is 30 if it is not specified.

--unit, -u

(Optional) Unit for the --olderthan parameter. Default is Day if it is not specified.

Example 16-212 Creating Jobs to Purge Logs

To create jobs to purge logs:

# odacli create-logcleanjob
Job details                                                     
----------------------------------------------------------------

                     ID:  e03d90b5-41dd-45e0-8b7a-1480d6d7f86f

            Description:  log file cleanup

                 Status:  Created

                Created:  July 25, 2018 8:06:56 PM UTC

                Message:  




Task Name   Start Time End Time  Status    

---------------------------------------- ----------------------------------- -------------
# ./odacli describe-job -i e03d90b5-41dd-45e0-8b7a-1480d6d7f86f

Job details                                                      

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

                     ID:  e03d90b5-41dd-45e0-8b7a-1480d6d7f86f

            Description:  log file cleanup

                 Status:  Success

                Created:  July 25, 2018 8:06:56 PM UTC

                Message:  



Task Name    Start Time    End Time      Status   
---------------------------------------- ----------------------------------- -
Clean TFA logs     July 25, 2018 8:06:56 PM UTC July 25, 2018 8:06:59 PM UTC  Success   

Clean DCS logs   July 25, 2018 8:06:56 PM UTC  July 25, 2018 8:06:56 PM UTC        Success

Parent topic: Log Commands

odacli describe-logcleanjob

Use the odacli describe-logcleanjobcommandto describe a log cleanup job.

File Path

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

Syntax

To list jobs and view job details and status:

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

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--json, -j

  (Optional) Displays JSON output.

--id, -i

Displays the summary of the log cleanup with the specified job ID.

Example 16-213 Displaying Log Cleanup Jobs

To display log cleanup jobs:

# odacli describe-logcleanjob  -i e03d90b5-41dd-45e0-8b7a-1480d6d7f86f
JobId    Files Deleted  Size Freed   Component  Top Path   TimeStamp           

-------------------- -------------------- -------------------- -------------------- -----
e03d90b5-41dd-45e0-8b7a-1480d6d7f86f 0 0 bytes dcs /opt/oracle/dcs/log  July 25, 2018 8:06:56 PM UTC

e03d90b5-41dd-45e0-8b7a-1480d6d7f86f 0 0 bytes  gi /u01/app/12.2.0.1/grid July 25, 2018 8:06:59 PM UTC

Parent topic: Log Commands

odacli list-auto-logclean-policy

Use the odacli list-auto-logclean-policy command to list the jobs to purge log files.

File Path

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

Syntax

To list jobs and view job details and status:

   odacli list-auto-logclean-policy [-h] [-c]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--components, -c

(Optional) Specifies the list of components, separated by comma. The values are gi|database|dcs For example, gi,dcs.

Example 16-214 Listing Jobs to Purge Logs

To list jobs to purge logs:

# odacli list-auto-logclean-policy
Component  UsageOverPercentage  freeSpaceBelowPercentage UsageOverMB  OlderThan OlderThanUnit  
--- -------------------- -------------------- ------------------------------------------------
gi                   40                   20                   0                    60        Day     

database             40                   20                   0                    60      Day   

dcs                  30                   20                   0                    30     Day

Parent topic: Log Commands

odacli list-logcleanjobs

Use the odacli list-logcleanjobs command to list the jobs to purge log files.

File Path

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

Syntax

To list jobs and view job details and status:

   odacli list-logcleanjobs [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example 16-215 Listing Jobs to Purge Logs

To list jobs to purge logs:

# odacli list-logcleanjobs
JobId   Files Deleted    Size Freed   Component    Top Path  TimeStamp  

-------------------- -------------------- -------------------- -------------------- -------------------a8ef8315-02e8-4979-ab1f-30251818c6eb 0  0 bytes gi /u01/app/12.2.0.1/grid July 25, 2018 7:45:10 PM UTC

e03d90b5-41dd-45e0-8b7a-1480d6d7f86f 0 0 bytes  gi   /u01/app/12.2.0.1/grid July 25, 2018 8:06:59 PM UTC

e03d90b5-41dd-45e0-8b7a-1480d6d7f86f 0  0 bytes dcs  /opt/oracle/dcs/log  July 25, 2018 8:06:56 PM UTC

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

Parent topic: Log Commands

odacli list-logspaceusage

Use the odacli list-logspaceusage command to display the log file usage.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To list jobs and view job details and status:

   odacli list-logspaceusage [-c] [-h]

Parameters

Parameter Description

--components, -c

Describes the list of components delimited by comma. The values can be gi|database|dcs. For example,gi,dcs.

--help, -h

(Optional) Displays help for using the command.

Example 16-216 Displaying a List of Logs

To display log file space usage for a list of components:

root@node1 ~]# odacli list-logspaceusage

              Timestamp: January 13, 2022 8:38:32 AM UTC
----------------------------------------------------------------

Node : node1
--------------------------------
Component Size(MB) Partition                          LogUsagePercentage PartitionFreePercentage
------------------------------------------------------------------------------------------------

dcs       685.00   /dev/mapper/VolGroupSys-LogVolOpt  0.76               84.00
gi        2293.76  /dev/mapper/VolGroupSys-LogVolU01  1.63               79.00
database  744.14   /dev/asm/odabase_n0-159            7.27               83.00

Node : node2
--------------------------------
Component Size(MB) Partition                         LogUsagePercentage PartitionFreePercentage
----------------------------------------------------------------------------------------------------

dcs       174.00   /dev/mapper/VolGroupSys-LogVolOpt 0.19                85.00
gi        1863.68  /dev/mapper/VolGroupSys-LogVolU01 1.32                79.00
database  299.36   /dev/asm/odabase_n1-159           2.92                90.00

Parent topic: Log Commands

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 configure-asr
    Use the odacli configure-asr command to configure Oracle Auto Service Request (Oracle ASR) after deploying the appliance.
  • odacli describe-asr
    Use the odacli describe-asr command to display Oracle Auto Service Request (Oracle ASR) configuration details.
  • odacli delete-asr
    Use the odacli delete-asr command to remove the Oracle Auto Service Request (Oracle ASR) configuration from the system.
  • odacli export-asrconfig
    Use the odacli export-asrconfig command to export the internal Oracle ASR Manager configuration files into a zip. The generated zip file can be used to configure the external Oracle ASR Manager on another Oracle Database Appliance.
  • odacli modify-asr
    Use the odacli modify-asr command to make changes to Oracle Auto Service Request (Oracle ASR) configuration details after deploying the appliance.
  • odacli test-asr
    Use the odacli test-asr command to test the Oracle Auto Service Request (Oracle ASR) configuration. When the command is run, an email alert is sent to each host and Oracle ILOM registered with Oracle ASR Manager.

Parent topic: Oracle Database Appliance Command-Line Interface

odacli configure-asr

Use the odacli configure-asr command to configure Oracle Auto Service Request (Oracle ASR) after deploying the appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli configure-asr -u asr_usr [-i asr_mgr_ip] [-e asr_type] [-p] [-t proxy_port] [-r proxy_server] [-y proxy_usr] [-hp HTTPS_port] [-j] [-h]

Parameters

Parameter Description

--username, -u

Specifies the Oracle ASR user name. The user name is the My Oracle Support user name under which the server is registered.

--asrtype, -e {internal | external}

Specifies the Oracle ASR Configuration Type. The default is internal.

--https-port, -hp

(Optional) Specifies the HTTPS port for Oracle ASR Manager. The default port is 16162.

--proxyport, -t

(Optional) Specifies the port on which Oracle ASR must be configured.

--proxyserver, -r

(Optional) Specifies the proxy server address that can enable connect to My Oracle Support.

--proxyuser, -y

(Optional) Specifies the proxy user name needed to authenticate the proxy server.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Usage Notes

  • All log files for Oracle ASR are located in the /var/opt/asrmanager/log/ directory.
  • To configure an external Oracle ASR Manager, you must define the Oracle ASR Configuration Type as external (-e external). For example, odacli configure-asr -e external.

Example 16-217 Configuring Oracle ASR with a Proxy Server

This example configures Oracle ASR for user name user@example.com. An HTTPS port 16165 is defined.

# odacli configure-asr -u user@example.com -hp 16165
Enter ASR user's password:
Retype ASR user's password:
 
Job details                                                     
----------------------------------------------------------------
                     ID:  2e6244e5-41e3-46cf-bd7a-43098dd071d8
            Description:  Configure ASR
                 Status:  Success
                Created:  September 5, 2023 2:08:56 PM CST
                Message: 
 
Task Name                                Start Time                          End Time                            Status         
---------------------------------------- ----------------------------------- ----------------------------------- ----------------
Modify JavaExec Path                     September 5, 2023 2:08:57 PM CST    September 5, 2023 2:08:57 PM CST    Success        
Install ASR                              September 5, 2023 2:08:57 PM CST    September 5, 2023 2:10:13 PM CST    Success        
Registering ASR Manager                  September 5, 2023 2:10:14 PM CST    September 5, 2023 2:10:22 PM CST    Success        
Creating ASR configuration folders       September 5, 2023 2:10:22 PM CST    September 5, 2023 2:10:22 PM CST    Success        
Enable HTTPS for ASR                     September 5, 2023 2:10:22 PM CST    September 5, 2023 2:10:46 PM CST    Success        
Importing ASR certificate into DCS       September 5, 2023 2:10:46 PM CST    September 5, 2023 2:10:48 PM CST    Success        
truststore                                                                                                                      
Registering Asset: ODA Host              September 5, 2023 2:10:48 PM CST    September 5, 2023 2:10:48 PM CST    Success        
ASR assets activation                    September 5, 2023 2:10:48 PM CST    September 5, 2023 2:10:49 PM CST    Success        
Remove AsrConfBackup File                September 5, 2023 2:10:55 PM CST    September 5, 2023 2:10:55 PM CST    Success

Example 16-218 Configuring an External Oracle ASR

This example configures Oracle Database Appliance to use an external Oracle ASR instance.

# odacli configure-asr -e External
 
Enter ASR user's password: 
Retype ASR user's password:
 
Job details
----------------------------------------------------------------
                     ID: cdd8445f-aefb-4f43-881a-145eaa1a1181
            Description: Configure ASR
                 Status: Success
                Created: September 5, 2023 1:41:33 PM CST
                Message:
 
Task Name                                 Start Time                         End Time                            Status
---------------------------------------- ----------------------------------- ----------------------------------- ----------
Creating ASR configuration folders        September 5, 2023 1:41:37 PM CST   September 5, 2023 1:41:38 PM CST    Success
Importing ASR certificate into DCS        September 5, 2023 1:41:38 PM CST   September 5, 2023 1:41:39 PM CST    Success
truststore
Registering Asset: ODA Host               September 5, 2023 1:41:39 PM CST   September 5, 2023 1:41:39 PM CST    Success
ASR assets activation                     September 5, 2023 1:41:39 PM CST   September 5, 2023 1:41:40 PM CST    Success

Parent topic: odacli Oracle Auto Service Request Commands

odacli describe-asr

Use the odacli describe-asr command to display Oracle Auto Service Request (Oracle ASR) configuration details.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  describe-asr [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example 16-219 Displaying Oracle ASR Details for ASR Type Internal

# odacli describe-asr
 
ASR details                                                    
----------------------------------------------------------------
                     ID: e0e31043-c312-4371-8301-e62642ef8a4a
                   Name: ASR
               ASR Type: Internal
        ASR Manager IP : 10.32.202.13
   ASR Manager username: username@example.com
      HTTPS port number: 16164
                  State: CONFIGURED
                Created: September 3, 2023 4:02:38 AM UTC
                Updated: September 3, 2023 4:03:32 AM UTC

Parent topic: odacli Oracle Auto Service Request Commands

odacli delete-asr

Use the odacli delete-asr command to remove the Oracle Auto Service Request (Oracle ASR) configuration from the system.

File Path

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

Syntax

# odacli delete-asr [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example 16-220 Deleting Oracle ASR From the System

# odacli delete-asr
{ 
"jobId" : "5d70bd17-ec4a-48da-8196-1364105db99d", 
"status" : "Running", 
"message" : null, 
"reports" : [ ], 
"createTimestamp" : 1469409622451, 
"description" : "Delete ASR", 
"updatedTime" : 1469409622458 
}

Parent topic: odacli Oracle Auto Service Request Commands

odacli export-asrconfig

Use the odacli export-asrconfig command to export the internal Oracle ASR Manager configuration files into a zip. The generated zip file can be used to configure the external Oracle ASR Manager on another Oracle Database Appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli export-asrconfig [-j] [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Example 16-221 Exporting the Internal Oracle ASR Configuration

# odacli export-asrconfig
Job details
----------------------------------------------------------------
                     ID: 7adb6cdc-31b8-42a4-83ac-a866307329fc
            Description: Export ASR Config
                 Status: Created
                Created: September 4, 2023 6:11:14 PM UTC
                Message: Run Update repository with the zip /opt/oracle/asr/asrConfiguration/ASRConfiguration.zip in the External ASR host once the current job is successful
 
Task Name Node Name Start Time End Time Status
---------------------------------------- ------------------------- ----------------------------------- -----------------------------------

Parent topic: odacli Oracle Auto Service Request Commands

odacli modify-asr

Use the odacli modify-asr command to make changes to Oracle Auto Service Request (Oracle ASR) configuration details after deploying the appliance.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli modify-asr -u username [-r proxyserver] [-t proxyport] [-y proxyuser] -e [internal|external][-hp HTTPS_port] [-j] [-h]

Parameters

Parameter Description

--username, -u

Defines the Oracle ASR user name. The user name is the My Oracle Support user name under which the server is registered.

--asrtype, -e [internal | external]

Defines the Oracle ASR configuration type. The default is internal.

--https-port, -hp

(Optional) Specifies the HTTPS port for Oracle ASR Manager. The default port is 16162.

--proxyport, -t

(Optional) Defines the proxy server port.

--proxyserver, -r

(Optional) Defines the proxy server address.

--proxyuser, -y

(Optional) Defines the proxy user name needed to authenticate the proxy server.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Usage Notes

  • Enter the ASR user password during Oracle ASR configuration.

  • All log files for Oracle ASR are located in the /var/opt/asrmanager/log/ directory.

  • You cannot use the modify-asr command to change the Oracle ASR type. For example, from internal to external. To change the Oracle ASR type, delete the existing configuration using the odacli delete-asr and then re-configure Oracle ASR using the odacli configure-asr command.

  • You cannot modify an external Oracle ASR Manager using the odacli modify-asr command. To modify external ASR, you must delete the existing Oracle ASR configuration and reconfigure Oracle ASR using the odacli configure-asr command. Before running the odacli configure-asr command, you must update the repository with the modified Oracle ASR Manager configuration zip file.

Example 16-222 Modifying Oracle ASR to use a New Proxy Server

This example updates Oracle ASR for user name scott.tiger@example.com. The password is not defined in the command-line. You are prompted to enter the password during configuration. The proxy server is updated to www-proxy2.example.com.

# odacli modify-asr -u scott.tiger@example.com --proxyserver www-proxy2.example.com --proxyport 80 
Enter ASR user's password:
Retype ASR user's password:

Job details
---------------------------------------------------------
ID: 79cb2baa-1644-45c5-a004-a303e3111807 
Description: Update ASR 
Status: Created 
Updated: December 8, 2024 9:53:54 AM PST 
Message:  

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

Parent topic: odacli Oracle Auto Service Request Commands

odacli test-asr

Use the odacli test-asr command to test the Oracle Auto Service Request (Oracle ASR) configuration. When the command is run, an email alert is sent to each host and Oracle ILOM registered with Oracle ASR Manager.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli test-asr [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example 16-223 Testing the Oracle ASR Configuration

# odacli test-asr

Job details
----------------------------------------------------------------
                     ID: 51522c07-1b32-4874-9bc7-bbee5885f1e5
            Description: Test ASR
                 Status: Success
                Created: October 20, 2022 1:02:49 PM UTC
                Message:

Task Name Start Time                      End Time                        Status
--------- ------------------------------- ------------------------------- --------
Test ASR  October 20, 2022 1:02:50 PM UTC October 20, 2022 1:02:50 PM UTC Success

Parent topic: odacli Oracle Auto Service Request Commands

Adaptive Classification and Redaction (ACR) Commands

Understand Adaptive Classification and Redaction (ACR) commands.

  • odacli describe-acr
    Use the odacli describe-acr command to check the status of ACR.
  • odacli enable-acr
    Use the odacli enable-acr command to enable ACR across all nodes, causing redaction of files during Oracle Trace File Analyzer diagnostic collections to occur.
  • odacli redact-acr
    Use the odacli redact-acr command to enable ACR across all nodes, causing redaction of files during Oracle Trace File Analyzer diagnostic collections to occur.
  • odacli list-acr
    Use the odacli list-acr command to print reverse map of sanitized entities.
  • odacli disable-acr
    Use the odacli disable-acr command to disable ACR across all nodes. Redaction of files during Oracle Trace File Analyzer diagnostic collections, then, does not occur.

Parent topic: Oracle Database Appliance Command-Line Interface

odacli describe-acr

Use the odacli describe-acr command to check the status of ACR.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli describe-acr [-j] [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Example 16-224 

# odacli describe-acr

Parent topic: Adaptive Classification and Redaction (ACR) Commands

odacli enable-acr

Use the odacli enable-acr command to enable ACR across all nodes, causing redaction of files during Oracle Trace File Analyzer diagnostic collections to occur.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli enable-acr [-j] [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Example 16-225 

# odacli enable-acr

Parent topic: Adaptive Classification and Redaction (ACR) Commands

odacli redact-acr

Use the odacli redact-acr command to enable ACR across all nodes, causing redaction of files during Oracle Trace File Analyzer diagnostic collections to occur.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli redact-acr -i path_name -m mode [-j] [-h]

Parameters

Parameter Description

--inpath, -i

(Required) Specifies the path of input file to be redacted.

--mode, -m

(Required) Specifies the redaction mode. The values can be mask or sanitize.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Example 16-226 

# odacli redact-acr -i path_name -m sanitize

Parent topic: Adaptive Classification and Redaction (ACR) Commands

odacli list-acr

Use the odacli list-acr command to print reverse map of sanitized entities.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-acr -l list [-j] [-h]

Parameters

Parameter Description

--list, -l

(Required) Specifies the list of sanitized entities.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Example 16-227 

# odacli list-acr -l list

Parent topic: Adaptive Classification and Redaction (ACR) Commands

odacli disable-acr

Use the odacli disable-acr command to disable ACR across all nodes. Redaction of files during Oracle Trace File Analyzer diagnostic collections, then, does not occur.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli disable-acr [-j] [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Example 16-228 

# odacli disable-acr

Parent topic: Adaptive Classification and Redaction (ACR) Commands

odacli OS Commands

Use the odacli OS commands to list and update operating system (OS) parameters.

  • odacli list-osconfigurations
    Use the command odacli list-osconfigurations to display the current HugePage and memlock values and view suggested values based on the total available space.
  • odacli modify-osconfigurations
    Use the command odacli modify-osconfigurations to update the HugePage and memlock values.

Parent topic: Oracle Database Appliance Command-Line Interface

odacli list-osconfigurations

Use the command odacli list-osconfigurations to display the current HugePage and memlock values and view suggested values based on the total available space.

File Path

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

Syntax

odacli list-osconfigurations [-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 displays the configured values for HugePage and memlock from the /etc/sysctl.conf and /etc/security/limits.conffiles. Based on the total available space, suggested values are calculated for the parameters.

Example 16-229 Displaying a List of Configured and Suggested Memlock and HugePage Configurations

# odacli list-osconfigurations

Parameter       User            ConfiguredValue                SuggestedValue
--------------- --------------- ------------------------------ ---------------
Memlock         grid            295971180KB                    289034355KB

Memlock         oracle          295971180KB                    289034355KB

HugeSpace       default         101430MB                       101161MB

Parent topic: odacli OS Commands

odacli modify-osconfigurations

Use the command odacli modify-osconfigurations to update the HugePage and memlock values.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli modify-osconfigurations [-hs hugepage] [-m memlock] [-nhp number_of_hugepages] [-j] [-h]

Parameters

Parameter Description
--memlock, -m

(Optional) Updates only the memlock value.
--hugepage, -hs

(Optional) Updates only the HugePage value.
--number-hugepages, -nhp

(Optional) Updates HugePages value.
--json, -j

(Optional) Displays JSON output. The default is false.
--help, -h

(Optional) Displays help for using the command.

Usage Notes

The command updates memlock in the /etc/security/limits.conffile and HugePage in the/etc/sysctl.conf file with the suggested values.

You can modify memlock or hugepage. If no option is provided, then both parameters are updated to the suggested values.

Example 16-230 Updating the HugePage and Memlock Parameters to the Suggested Values

odacli modify-osconfigurations
{
"jobId" : "954cf7a5-9cad-451c-8820-3140a716af26",
"status" : "Created",
"message" : "Successfully submitted a request to configure OS
parameters.",
"reports" : [ ],
"createTimestamp" : "December 8, 2024 00:03:51 AM MST",
"resourceList" : [ ],
"description" : "Configuring OS Parameter",
"updatedTime" : "December 8, 2024 00:03:51 AM MST"
[root@rwsoda6s002 ~]# odacli describe-job -i
"954cf7a5-9cad-451c-8820-3140a716af26"
Job details
----------------------------------------------------------------
ID: 954cf7a5-9cad-451c-8820-3140a716af26
Description: Configuring OS Parameter
Status: Success
Created: December 8, 2024 12:03:51 AM MST
Message:
Task Name             Start Time                         End Time                          Status
--------------------  --------------------------------   --------------------------------  -------
Setting up memlock.   December 8, 2024 12:03:51 AM MST   December 8, 2024 12:03:51 AM MST  Success
Setting up HugeSpace  December 8, 2024 12:03:51 AM MST   December 8, 2024 12:03:51 AM MST  Success

Parent topic: odacli OS Commands

odaadmcli Hardware Monitoring Commands

Use the hardware monitoring commands to display hardware configurations.

Parent topic: Oracle Database Appliance Command-Line Interface

odaadmcli show localdisk

Use the odaadmcli show localdisk command to show cooling details.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To show cooling details:

odaadmcli show localdisk [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example

# odaadmcli show localdisk
        NAME            PATH            TYPE            STATUS                  STATE_IN_ILOM

        lpd_0           /dev/sda        SSD             PredictiveFailure       OK
        lpd_1           /dev/sdb        SSD             OK                      OK

Parent topic: odaadmcli Hardware Monitoring Commands

odaadmcli show cooling

Use the odaadmcli show cooling command to show cooling details.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To show cooling details:

odaadmcli show cooling [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Parent topic: odaadmcli Hardware Monitoring Commands

odaadmcli show env_hw

Use the odaadmcli show env_hw command to display information about the environment and hardware.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To display environment and hardware details:

odaadmcli show env_hw [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example 16-231 Displaying Environment and Hardware Details

To display the hardware details, enter the command odaadmcli show env_hw. The results show a bare metal Oracle Database Appliance system. 

# odaadmcli show env_hw 

BM X7-2 Medium

Parent topic: odaadmcli Hardware Monitoring Commands

odaadmcli show fs

Use the odaadmcli show fs command to display filesystem details.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To display filesystem details:

   odaadmcli show fs [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example 16-232 Displaying Filesystem Details

# odaadmcli show fs

Type 	Total Space   Free Space  	Total DG Space  Free DG Space
ext3    30237M         7763M            -               -
ext3    484M            416M            -               -
ext3    60475M        38149M            -               -
ext3    100793M       22060M            -               -

acfs    102400M       102158M         4894016M        2418668M
acfs    102400M       100501M         4894016M        2418668M
acfs    102400M       100601M         4894016M        2418668M

(Continued)
Diskgroup Mount Point
          /
          /boot
          /opt
          /u01
DATA      /u02/app/oracle/oradata/ACFSDB1
DATA      /u02/app/oracle/oradata/ACFSDB2
DATA      /u02/app/oracle/oradata/EE12NCDB

Parent topic: odaadmcli Hardware Monitoring Commands

odaadmcli show memory

Use the odaadmcli show memory command to display memory details.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To show memory details:

   odaadmcli show memory [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example 16-233 Display Memory Details

# odaadmcli show memory

NAME     HEALTH  HEALTH_DETAILS   PART_NO.         SERIAL_NO.
DIMM_0   OK       -               3A4K40BB1-CRC	    00CE01154602EADA96
DIMM_11  OK       -               3A4K40BB1-CRC	    00CE01154602EADADA
DIMM_3   OK       -               3A4K40BB1-CRC	    00CE01154602EADBC7
DIMM_8   OK       -               3A4K40BB1-CRC	    00CE01154602EADBA0

(Continued)
LOCATION MANUFACTURER  MEMORY_SIZE  CURR_CLK_SPEED  ECC_Errors
P0/D0    Samsung        32 GB       2400 MHz        0
P0/D1    Samsung        32 GB       2400 MHz        0
P0/D3    Samsung        32 GB       2400 MHz        0
P0/D8    Samsung        32 GB       2400 MHz        0

Parent topic: odaadmcli Hardware Monitoring Commands

odaadmcli show network

Use the odaadmcli show network command to show network details.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To show network details:

odaadmcli show network [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example 16-234 Showing Network Details

# odaadmcli show network
NAME 	       HEALTH HEALTH_DETAILS LOCATION PART_NO MANUFACTURER MAC_ADDRESS LINK_DETECTED DIE_TEMP 

Ethernet_NIC_0     OK     -              NET0     i210    INTEL        00:10:E0:DD:9D:14 no (em1) N/A 
Ethernet_NIC_1     OK     -              NET1     X710/X557-AT Intel   3C:FD:FE:78:93:92 no (p2p3) N/A 
Ethernet_NIC_2     OK     -              NET2     X710/X557-AT Intel   3C:FD:FE:78:93:91 yes (p2p2) N/A 
Ethernet_NIC_3     OK     -              NET3     X710/X557-AT Intel   3C:FD:FE:78:93:90 yes (p2p1) N/A 
Ethernet_NIC_4     OK     -              NET4     BCM57414 Broadcom    B0:26:28:3F:D8:B8 yes (p7p2) N/A 
Ethernet_NIC_5     OK     -              NET5     X710/X557-AT Intel   3C:FD:FE:78:93:93 no (p2p4) N/A 
Ethernet_NIC_6     OK     -              NET6     BCM57414 Broadcom    B0:26:28:3F:D8:B0 yes (p7p1) N/A

Parent topic: odaadmcli Hardware Monitoring Commands

odaadmcli show power

Use the odaadmcli show power command to display power supply details.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

Run this command on the first node, to display power supply details on Oracle Database Appliance High-Availability (HA) models:

   odaadmcli show power [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example 16-235 Displaying Power Supply Details

# odaadmcli show power

NAME            HEALTH  HEALTH_DETAILS   PART_NO.  	SERIAL_NO.
Power_Supply_0  OK            -          7079395     476856Z+1514CE056G

(Continued)
LOCATION    INPUT_POWER   OUTPUT_POWER   INLET_TEMP         EXHAUST_TEMP
PS0         Present       112 watts      28.000 degree C    34.938 degree C

Parent topic: odaadmcli Hardware Monitoring Commands

odaadmcli show processor

Use the odaadmcli show processor command to display processor details.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To show processor details:

odaadmcli show processor  [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example 16-236 Displaying Processor Details

# odaadmcli show processor 

NAME 	HEALTH HEALTH_DETAILS  PART_NO.  LOCATION   MODEL
CPU_0 	OK      -              060F P0   (CPU 0)    Intel(R) Xeon(R) CPU E5-2630									

(Continued)
MAX_CLK_SPEED   TOTAL_CORES 	ENABLED_CORES
2.200 GHz        10              10

Parent topic: odaadmcli Hardware Monitoring Commands

odaadmcli show server

Use the odaadmcli show server command to display server details.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To show server details:

   odaadmcli show server [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example 16-237 Displaying Server Details

# odaadmcli show server

Power State : On         
Open Problems : 0         
Model : ORACLE SERVER X7-2      
Type : Rack Mount         
Part Number : 7320190         
Serial Number : 1605NM10JJ         
Primary OS : Not Available         
ILOM Address : 10.209.8.215         
ILOM MAC Address : 00:10:E0:95:98:F0         
Description : Oracle Database Appliance X7-2 Small 1606NM1s02         
Locator Light : Off         
Actual Power Consumption : 135 watts         
Ambient Temperature : 24.250 degree C         
Open Problems Report : System is healthy

Parent topic: odaadmcli Hardware Monitoring Commands

Storage Commands

Understand the commands to perform storage operations and diagnostics.

  • odaadmcli asmops diskgroup
    Use the odaadmcli asmops diskgroup command to manage Oracle ASM disk group.
  • odaadmcli expand storage
    Use the odaadmcli expand storage command to expand storage.
  • odacli list-dgdisks
    Use the odacli list-dgdisks command to display details about the available disks.
  • odacli validate-storagetopology
    Use the odacli validate-storagetopology command to check the cable connections between the system controllers and the storage shelf, as well as the cable connection to the storage expansion shelf (if one is installed).
  • odaadmcli power disk
    Use the odaadmcli power disk command to power a disk on or off for NVMe drives only.
  • odaadmcli show controller
    Use the odaadmcli show controller command to display details of the controller.
  • odaadmcli show disk
    Use the odaadmcli show disk command to display the status of a single disk or of all disks on the system.
  • odaadmcli show diskgroup
    Use the odaadmcli show diskgroup command to list configured diskgroups or display a specific diskgroup configuration.
  • odaadmcli show raidsyncstatus
    Use the odaadmcli show raidsyncstatus command to display the RAID SYNC status.
  • odaadmcli show storage
    Use the odaadmcli show storage command to show the storage controllers, expanders, and disks.
  • odaadmcli stordiag
    Use the odaadmcli stordiag command to collect detailed information for each disk or NVMe.

Parent topic: Oracle Database Appliance Command-Line Interface

odaadmcli asmops diskgroup

Use the odaadmcli asmops diskgroup command to manage Oracle ASM disk group.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

  odaadmcli asmops diskgroup -G diskgroup_name  -o {add|remove|offline|online} -p path -D disk_name -f -w -t timeout [-h]

Parameters

Parameter Description
-G

(Mandatory) Specifies the disk group name.
-o

(Mandatory) Specifies the operation to be performed on Oracle ASM disk. Add disk to disk group, remove from disk group, offline the disk or online the disk.
-p

(Mandatory for addition of disks) Specify the disk path during addition of disk to Oracle disk group.
-D

(Mandatory) Specify Oracle ASM disk name or alias.
--help, -h

(Optional) Displays help for using the command.
-f

(Optional) Specifies if you want to force the operation.
-w

(Optional) Specifies if you want to wait for the operation to complete. This option is valid for the disk online operation.
-t

(Optional) Specifies the duration after which the disks are dropped by Oracle ASM after a disk offline operation. The time out values can be specified in the format 35m, 2h, and so on. This option is valid for the disk offline operation.

Usage Notes

Run the command on the Oracle Database Appliance system to manage Oracle ASM disk group.

Parent topic: Storage Commands

odaadmcli expand storage

Use the odaadmcli expand storage command to expand storage.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

  odaadmcli expand storage -ndisk number of disks to be added -enclosure {0|1} [-h]

Parameters

Parameter Description
--enclosure {0|1}

Defines the JBOD or shelf number. The base storage shelf is 0. The storage expansion shelf is 1.

This option is only available for multi-node platforms. It is not supported on Oracle Database Appliance single node platforms.
--help, -h

(Optional) Displays help for using the command.
-ndisk

Defines the number of disks to be added in the enclosure.

Usage Notes

On high-availability (HA) Oracle Database Appliance hardware models, run the command only on the first node.

Various storage options are available. On multi-node platforms, the base storage is SSD and you can choose to add either SSD or HDD disks. When adding a storage expansion shelf, all disks must be the same type (you cannot combine SSD and HDD disks).

Note:

In addition to reviewing the expand storage command, it is important to follow the procedures for adding storage. Cabling validation and disk placement is important. In some cases, you must move disks to different slots to successfully expand storage.

Parent topic: Storage Commands

odacli list-dgdisks

Use the odacli list-dgdisks command to display details about the available disks.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To list available disk details:

   odacli list-dgdisks [-h] [-dg] [-dp] [-j]

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--diskgroup, -dg

(Optional) Displays all disks in the specified disk group. The possible values are: ALL, DATA, RECO, REDO, FLASH. If no value is specified, then ALL disks are displayed.

--diskpath, -dp

(Optional) Displays all disks that contains the specified value in the path. If no value is specified, then all disks are displayed.

Usage Notes

Example 16-238 Listing All Available Disks on the System

# odacli list-dgdisks -dg ALL

Name                      Group Mount St Group Num Mode St State    Redundancy Fail Grp                  Path                           Health Inc
------------------------- ----- -------- --------- ------- -------- ---------- ------------------------- ------------------------------ ------ ---
HDD_E0_S19_576667504P1    DATA  CACHED   1         ONLINE  NORMAL   UNKNOWN    HDD_E0_S19_576667504P1    AFD:HDD_E0_S19_576667504P1     0      0 
HDD_E0_S08_577087696P1    DATA  CACHED   1         ONLINE  NORMAL   UNKNOWN    HDD_E0_S08_577087696P1    AFD:HDD_E0_S08_577087696P1     0      0 
HDD_E0_S11_576021940P1    DATA  CACHED   1         ONLINE  NORMAL   UNKNOWN    HDD_E0_S11_576021940P1    AFD:HDD_E0_S11_576021940P1     0      0 
HDD_E0_S13_576660012P1    DATA  CACHED   1         ONLINE  NORMAL   UNKNOWN    HDD_E0_S13_576660012P1    AFD:HDD_E0_S13_576660012P1     0      0 
HDD_E0_S15_577131668P1    DATA  CACHED   1         ONLINE  NORMAL   UNKNOWN    HDD_E0_S15_577131668P1    AFD:HDD_E0_S15_577131668P1     0      0 
HDD_E0_S09_576662448P1    DATA  CACHED   1         ONLINE  NORMAL   UNKNOWN    HDD_E0_S09_576662448P1    AFD:HDD_E0_S09_576662448P1     0      0 
HDD_E0_S18_577136300P1    DATA  CACHED   1         ONLINE  NORMAL   UNKNOWN    HDD_E0_S18_577136300P1    AFD:HDD_E0_S18_577136300P1     0      0

Example 16-239 Listing Disks with the Specified Disk Path on the System

# odacli list-dgdisks -dp HDD_E0_S10_577135552

Name                   Group Mount St Group Num Mode St State    Redundancy Fail Grp               Path                        Health Inc
---------------------- ----- -------- --------- ------- -------- ---------- ---------------------- --------------------------- ------ ---
HDD_E0_S10_577135552P1 DATA  CACHED   1         ONLINE  NORMAL   UNKNOWN    HDD_E0_S10_577135552P1 AFD:HDD_E0_S10_577135552P1  0      0  
HDD_E0_S10_577135552P2 RECO  CACHED   2         ONLINE  NORMAL   UNKNOWN    HDD_E0_S10_577135552P2 AFD:HDD_E0_S10_577135552P2  0      0

Parent topic: Storage Commands

odacli validate-storagetopology

Use the odacli validate-storagetopology command to check the cable connections between the system controllers and the storage shelf, as well as the cable connection to the storage expansion shelf (if one is installed).

Oracle recommends that you run the odacli validate-storagetopology command before deploying the system to ensure that the cabling is correct. This will avoid and prevent problems during deployment due to incorrect or missing cable connections. If the cabling is not correct, you will see errors in your output.

File Path

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

Syntax

odacli validate-storagetopology [–h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Parent topic: Storage Commands

odaadmcli power disk

Use the odaadmcli power disk command to power a disk on or off for NVMe drives only.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To power an NVMe disk on or off:

   odaadmcli power disk {on|off|status} disk_name [-h]

Parameters

Parameter Description

disk_name

Defines the disk resource name. The resource name format is pd_[0..3].

{on|off|status}

Power on a disk, power off a disk, display status.

--help, -h

(Optional) Displays help for using the command.

Example 16-240 Powering a Disk Off

This example shows how to power off a disk.

# odaadmcli power disk off pd_00 
Disk 'pd_00' is already part of ASM

Are you sure you want to power OFF the disk?: 'pd_00'? 
[yes/no]:
yes 
Powered OFF pd_00

Example 16-241 Checking the Disk Status

This example shows how to get the status of disk pd_00.

# odaadmcli power disk status pd_00 
The disk is powered ON

Parent topic: Storage Commands

odaadmcli show controller

Use the odaadmcli show controller command to display details of the controller.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To display details of the controller:

   odaadmcli show controller id [-h]

Parameters

Parameter Description

controller_id, id

Defines the controller.

--help, -h

(Optional) Displays help for using the command.

Example 16-242 Showing Controller Details

 # odaadmcli show controller 1
Controller [1] information:
        sun-controller-id = nvme:1b:00.00
        sun-id = nvme:1b:00.00
        sun-controller-manufacturer = Samsung
        pci-vendor-id = 0x0000144d
        sun-controller-model = 0xa821
        pci-device-id = 0x0000a821
        sun-controller-type = NVMe
        sun-card-manufacturer = Sun Microsystems
        pci-subvendor-id = 0x0000108e
        sun-card-model = 0xa803
        pci-subdevice-id = 0x0000a803
        pci-address = 1b:00.0
        sun-version-firmware = KPYA7R3Q
        sun-serial-number = S2LHNAAH101008
        sun-product-name = MS1PC2DD3ORA3.2T
        pci-slot-number = 11
        nvme-power-control = 1
        sun-nac-name = /SYS/DBP/NVME1

Parent topic: Storage Commands

odaadmcli show disk

Use the odaadmcli show disk command to display the status of a single disk or of all disks on the system.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To display the status of all disks on the system:

   odaadmcli show  disk [-h]

To display the status of a single disk:

  odaadmcli show disk disk_name [-h]

Parameters

Parameter Description

disk_name

(Optional) Define the disk resource name. The resource name format is pd_[0..3].

--help, -h

(Optional) Displays help for using the command.

Example 16-243 Displaying the Status of All Disks

To display the status of all the disks on the system:

# odaadmcli show disk         
NAME		PATH 			TYPE 	STATE 	STATE_DETAILS          
pd_00 	/dev/nvme0n1 NVD 		ONLINE 	Good         
pd_01 	/dev/nvme1n1 NVD 		ONLINE 	Good

Example 16-244 Displaying the Status of a Single Disk

To display the status of a disk named pd_00: 

# odaadmcli show disk pd_00 

The Resource is : pd_00         
ActionTimeout : 1500         
ActivePath : /dev/nvme0n1        
 AsmDiskList : |data_00||reco_00|         
AutoDiscovery : 1         
AutoDiscoveryHi : |data:80:NVD||reco:20:NVD|         
CheckInterval : 300         
ColNum : 0         
CriticalWarning : 0         
DependListOpr : add        
 Dependency : |0|         
DiskId : 360025380144d5332         
DiskType : NVD         
Enabled : 1         
ExpNum : 19         
HbaPortNum : 10         
IState : 0         
Initialized : 0         
IsConfigDepende : false        
 ModelNum : MS1PC2DD3ORA3.2T        
 MonitorFlag : 1         
MultiPathList : |/dev/nvme0n1|         
Name : pd_00         
NewPartAddr : 0         
OSUserType : |userType:Multiuser|         
PlatformName : X7_1_LITE_S         
PrevState : Invalid         
PrevUsrDevName :         
SectorSize : 512         
SerialNum : S2LHNAAH000001         
Size : 3200631791616         
SlotNum : 0         
SmartDiskWarnin : 0        
SmartTemperatur : 37         
State : Online         
StateChangeTs : 1465263789         
StateDetails : Good         
TotalSectors : 6251233968         
TypeName : 0         
UsrDevName : NVD_S00_S2LHNAAH101026         
VendorName : Samsung         
gid : 0        
 mode : 660         
uid : 0

Parent topic: Storage Commands

odaadmcli show diskgroup

Use the odaadmcli show diskgroup command to list configured diskgroups or display a specific diskgroup configuration.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To list configured diskgroups:

   odaadmcli show diskgroup [-h]

To display DATA configurations:

   odaadmcli show diskgroup [DATA] [-h]

To display RECO configurations:

   odaadmcli show diskgroup [RECO] [-h]

Parameters

Parameter Description

DATA

(Optional) Displays the DATA diskgroup configurations.

RECO

(Optional) Displays the RECO diskgroup configurations.

--help, -h

(Optional) Displays help for using the command.

Example 16-245 Listing All Diskgroups

To list all diskgroups:
# odaadmcli show diskgroup 

DiskGroups
---------- 
DATA
RECO

Example 16-246 Displaying DATA Configurations

To display DATA configurations:
# odaadmcli show diskgroup DATA

ASM_DISK  PATH                           DISK   STATE   STATE_DETAILS          
data_00   /dev/NVD_S00_S2LHNAAH101026p1  pd_00  ONLINE   Good         
data_01   /dev/NVD_S01_S2LHNAAH101008p1  pd_01  ONLINE   Good

Parent topic: Storage Commands

odaadmcli show raidsyncstatus

Use the odaadmcli show raidsyncstatus command to display the RAID SYNC status.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To display the status of RAID SYNC:

   odaadmcli show raidsyncstatus [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example 16-247 Displaying the RAID SYNC Status

To display the RAID SYNC details and status:

# odaadmcli show raidsyncstatus

Raid Type  Raid Device  Raid Status  maintainPdFailHistory  Rebuildrate
H/W Raid    /dev/sda     Optimal       ON                    30%

Parent topic: Storage Commands

odaadmcli show storage

Use the odaadmcli show storage command to show the storage controllers, expanders, and disks.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To display the storage controllers, expanders, and disks:

   odaadmcli show storage [-h]    

To show storage errors:

   odaadmcli show storage -errors [-h]   

Parameters

Parameter Description

--errors

(Optional) Shows storage errors.

--help, -h

(Optional) Displays help for using the command.

Example 16-248 Displaying Storage Devices

The following example displays details about the storage devices on an appliance.

# odaadmcli show storage

==== BEGIN STORAGE DUMP ======== 
Host Description: Oracle Corporation:ORACLE SERVER X6-2 
Total number of controllers: 2         
	Id = 0         
	Pci Slot = 10
	Serial Num = S2LHNAAH101026
     Vendor = Samsung
   Model = MS1PC2DD3ORA3.2T         
   FwVers = KPYA7R3Q         
   strId = nvme:19:00.00
      Pci Address = 19:00.0

      Id = 1
      Pci Slot = 11
      Serial Num = S2LHNAAH101008
      Vendor = Samsung         
	Model = MS1PC2DD3ORA3.2T         
	FwVers = KPYA7R3Q
     strId = nvme:1b:00.00         
  Pci Address = 1b:00.0  


Total number of expanders: 0 
Total number of PDs: 2         
   /dev/nvme0n1 Samsung NVD 3200gb slot: 0 pci : 19         
   /dev/nvme1n1 Samsung NVD 3200gb slot: 1 pci : 1 

==== END STORAGE DUMP =========

Parent topic: Storage Commands

odaadmcli stordiag

Use the odaadmcli stordiag command to collect detailed information for each disk or NVMe.

File Path

/opt/oracle/oak/bin/odaadmcli

Syntax

To collect storage diagnostics for disks and NVM Express (NVMe):

   odaadmcli stordiag [-n] [-h]

Parameters

Parameter Description

-ndisk_name

Defines the disk resource name. The resource name format is pd_[0..3].

--help, -h

(Optional) Displays help for using the command.

Example 16-249 Displaying NVMe Details

To display detailed information for NVMe pd_00: 

# odaadmcli stordiag pd_00

Parent topic: Storage Commands