Oracle Database Appliance Command-Line Interface

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 Web Console 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 Web Console or CLI utilities.

The following classes of commands are available:

Deployment and Configuration: Use the deployment and configuration commands as part of the initial deployment of the appliance and to configure CPU cores.
Lifecycle management: Use odacli commands to perform database and system administration tasks for the appliance. The odacli commands are the primary interface to perform life cycle activities for the appliance.
Administration: Use odaadmcli commands to perform hardware administration tasks for the appliance. The odaadmcli commands are the interface for infrequent administration activities needed to manage appliance hardware components, storage, and VLAN.

You can perform the following deployment and configuration tasks:

Configure the first network in the appliance
Unzip and copy the Oracle Database Appliance software to the correct locations
Set the number of CPU Cores for the system

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

Create and describe the appliance
Create, list, describe, and delete databases
Create, list, describe, and delete Oracle Database Homes
Create, list, and describe the networks
List and describe the jobs

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

Show storage, disks, diskgroups, and controllers
Display storage diagnostics for disks and NVM Express (NVMes)
Locate disks
Show server, memory, processor, power, cooling, and network details

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

Command-Line Interface Syntax

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

An odacli or odaadmclicommand uses the following command syntax:

odacli command [options]

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

Example 15-1 Command-Line Interface Syntax

# odacli create-database -h 

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

Oracle Database Appliance Manager Command-Line Interface Help

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

odacli -h

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

odacli describe-dbhome -h

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.

Configure Command

Use the configure and update commands to configure the appliance.

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

Parent topic: Oracle Database Appliance Command-Line Interface

configure-firstnet

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

File Path

$ORACLE_HOME/opt/oracle/oak/bin/configure-firstnet

Syntax

  #  configure-firstnet

Usage Notes

Oracle Database Appliance X7-2 has two dual-port public network interfaces, a 10GBase-T (copper) and a 25GbE SFP28 (fiber) network interface. Oracle Database Appliance uses the interface to create the initial network connection and to create virtual local area networks (VLANs). This command ensures that the system is available in the network, enabling you to manage the deployment through the Oracle Appliance Manager Web Console.

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. Default setting.
Non-bonded network configuration: Two separate physical network interfaces, this configuration does not support VLANs. The non-bonded network configuration uses em2 and em3 as public interfaces.
To change a non-bonded network configuration to a bonded configuration, run the Oracle Database Appliance Cleanup Script and redeploy the appliance.

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

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

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

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

# 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 15-5 Configuring the First Network as a Non-Bonded Network

The following is an example of a non-bonded configuration. For a non-bonded configuration, answer no to using a bonding public interface.

# 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 interface p1p1:                              [  OK  ]
Shutting down interface p1p2:                              [  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  ]
Bringing up interface p1p1:  Determining if ip address 192.168.16.24 is already in use for device p1p1...
                                                           [  OK  ]
Bringing up interface p1p2:  Determining if ip address 192.168.17.24 is already in use for device p1p2...
                                                           [  OK  ]
INFO: Restarting the network
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.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
/usr/share/system-config-network/netconfpkg/NCHostsList.py:100: DeprecationWarning: BaseException.message has been deprecated as of Python 2.6
  badlines.append((num, value_exception.message))
/usr/share/system-config-network/netconfpkg/NCHostsList.py:105: DeprecationWarning: BaseException.message has been deprecated as of Python 2.6
  """ % (value_exception.message, num)
/usr/share/system-config-network/netconfpkg/NCProfileList.py:142: DeprecationWarning: BaseException.message has been deprecated as of Python 2.6
  self.error = e.message
INFO: Restarting the network
Shutting down interface em1:                               [  OK  ]
Shutting down interface em2:                               [  OK  ]
Shutting down interface em3:                               [  OK  ]
Shutting down interface p1p1:                              [  OK  ]
Shutting down interface p1p2:                              [  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.1.10.2 is already in use for device em2...
                                                           [  OK  ]
Bringing up interface em3:                                 [  OK  ]
Bringing up interface p1p1:  Determining if ip address 192.0.2.24 is already in use for device p1p1...
                                                           [  OK  ]
Bringing up interface p1p2:  Determining if ip address 192.0.2.25 is already in use for device p1p2...
                                                           [  OK  ]

Parent topic: Configure Command

odacli Apply Patch and Update Commands

Use the commands odacli update and apply patch to apply patches and update the 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 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 update-agentconfig-parameters
Use the odacli update-agentconfig-parameters command to modify configuration variables used by the appliance.
odacli list-agentconfig-parameters
Use the odacli list-agentconfig-parameters command to list configuration variables used by the appliance.
odacli list-availablepatches
Use the odacli list-availablepatches command to display all available patches for Oracle Database Appliance.
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 update-dbhome
Use the odacli update-dbhome command to update a specific RDBMS Home to the latest patch bundle version.
odacli update-dcsagent
Use the odacli update-dcsagent command to update the agent.
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.

Parent topic: Oracle Database Appliance Command-Line Interface

odacli describe-component

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

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

File Path

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

Syntax

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

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`	(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`, `–v`	(Optional) Describes the components for a specific node on multi-node high availability (HA) systems. This option is not needed to display component details on single node systems. {0\|1}
`--server`, `–s`	(Optional) Lists the server components and versions and the available versions to which you can patch them.

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.

Example 15-6 Displaying Patch Details for Components

# odacli describe-component
System Version
---------------
18.5.0.0.0

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

Local System Version
---------------
18.5.0.0.0

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

GI                                        18.5.0.0.190115       up-to-date      

DB                                        18.5.0.0.190115       up-to-date      

DCSAGENT                                  18.5.0.0.0            up-to-date      

ILOM                                      4.0.4.21.r126801      up-to-date      

BIOS                                      41040100              up-to-date      

OS                                        6.10                  up-to-date      

FIRMWARECONTROLLER                        13.00.00.00           up-to-date      

FIRMWAREEXPANDER                          0306                  up-to-date      

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

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

Local System Version
---------------
18.5.0.0.0

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

GI                                        18.5.0.0.190115       up-to-date      

DB                                        18.5.0.0.190115       up-to-date      

DCSAGENT                                  18.5.0.0.0            up-to-date      

ILOM                                      4.0.4.21.r126801      up-to-date      

BIOS                                      41040100              up-to-date      

OS                                        6.10                  up-to-date      

FIRMWARECONTROLLER                        13.00.00.00           up-to-date      

FIRMWAREEXPANDER                          0306                  up-to-date      

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

Example 15-7 List DB Home Details

# odacli describe-component -d

System Version
---------------
18.5.0.0.0

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

Local System Version
---------------
18.5.0.0.0

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

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

Local System Version
---------------
18.5.0.0.0

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

Example 15-8 List the Server Components and Versions

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

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

Local System Version
---------------
18.5.0.0.0

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

GI                                        18.5.0.0.190115       up-to-date      

ILOM                                      4.0.4.21.r126801      up-to-date      

BIOS                                      41040100              up-to-date      

OS                                        6.10                  up-to-date      

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

Local System Version
---------------
18.5.0.0.0

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

GI                                        18.5.0.0.190115       up-to-date      

ILOM                                      4.0.4.21.r126801      up-to-date      

BIOS                                      41040100              up-to-date      

OS                                        6.10                  up-to-date

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 15-9 Listing the Latest Supported Versions

#  odacli describe-latestpatch
 
componentType   availableVersion
--------------- --------------------
gi              18.5.0.0.190115
db              18.5.0.0.190115
db              12.2.0.1.190115
oak             18.5.0.0.0
ilom            4.0.4.21.r126801
bios            41040100
os              6.10

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 attempting to patch, and ensure all components are ready for updates.

File Path

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

Syntax

odacli create-prepatchreport -v -s

Parameters

Parameter	Description
`--dbhome`, `–d`	(Optional) Specifies the database home component for running the pre-checks.
`--dbhomeid`, `–i`	(Optional) Specifies the IDs of the database homes for running the pre-checks.
`--help`, `-h`	(Optional) Displays help for using the command.
`--json`, `-j`	(Optional) Displays JSON output. The default is false.
`--local`, `-l`	(Optional) Runs patch pre-checks only on the local node.
`--node`, `–n`	(Optional) Runs patch pre-checks on specified nodes.
`--server`, `–s`	(Optional) Specify this option to run the patch pre-checks for the server components.
`--version`, `–v`	(Optional) Specifies the version for running the pre-checks.

Usage Notes

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

Example 15-10 Creating Pre-Check Report

# odacli create-prepatchreport -v 18.5 -s
Job details                                                      
----------------------------------------------------------------
                     ID:  e54ff307-84d1-40e4-b604-4b3e47f315de
            Description:  Run pre-checks for patching
                 Status:  Created
                Created:  May 18, 2018 6:14:18 AM GMT
                Message:   
Task Name        Start Time     End Time         Status    
---------------------------------------- ----------------------------------- -----------------------------

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

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

Syntax

odacli describe-prepatchreport -i

Parameters

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

Usage Notes

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

Example 15-11 Displaying the Patch Pre-Checks Report

# odacli describe-prepatchreport -i 39ef1eeb-70d3-47ad-b3f5-48960ca0607b
Patch pre-check report 
----------------------------------------------------------------
                 Job ID:  39ef1eeb-70d3-47ad-b3f5-48960ca0607b
            Description:  Pre-Check report for patching [GI, ILOM, OS]
                 Status:  COMPLETED
                 Result:  One or more pre-checks failed for [GI]
  Node Name       
---------------
node n1
Pre-Check                      Status     Comments                           
------------------------------ ---------- ----------------------------------- 
 __OS__ 
Validate patching tag           Success     Validated patching tag: 12.2.1.2.0
Is patch location available     Success     Patch location is available        
Verify OS patch                 Success     There are no packages available    
                                            for an update                      
 __ILOM__ 
Validate patching tag           Success     Validated patching tag: 12.2.1.2.0
Is patch location available     Success     Patch location is available        
Checking Ilom patch Version     Success     Successfully verified the versions 
Patch location validation       Success     Successfully validated location    
 __GI__ 
Is clusterware running          Success     Clusterware is running             
Validate patching tag           Success     Validated patching tag: 12.2.1.2.0
Validate available space        Success     Validated free space under /u01    
Is system provisioned           Success     Verified system is provisioned     
Validate minimum agent version  Success     GI patching enabled in current     
                                            DCSAGENT version                   
Validate GI patch metadata      Failed      Internal error encountered:        
                                            patchmetadata for 12.2.1.2.0      
                                            missing target version for GI.     
Is patch location available     Success     Patch location is available        
Patch location validation       Failed      Internal error encountered:        
                                            specified location                 
Patch verification              Failed      Internal error encountered: Unable 
                                            to get patch number on node        
                                            n1.                       
Opatch updation                 Success     Successfully updated the opatch in 
                                            GiHome /u01/app/12.2.0.1/grid on   
                                            node n1                   
Patch conflict check            Failed      Internal error encountered:        
                                            Invalid patch location in metadata.

Example 15-12 Example of a Successful Patch Pre-Checks Report

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

Parent topic: odacli Apply Patch and Update Commands

odacli update-agentconfig-parameters

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

File Path

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

Syntax

odacli update-agentconfig-parameters

Parameters

Parameter	Description
`--help`, `-h`	(Optional) Displays help for using the command.
`--append`, `-a`	(Optional) Appends the parameter values. For example, `-n p1 -v v1 -n p2 -v v2 -a`. The default is false.
`--comment`, `-c`	(Optional) Specifies the comment for the parameter.
`--description`, `-d`	(Optional) Specifies the description of the parameter.
`--json`, `-j`	(Optional) Displays JSON output. The default is false.
`--name`, `-n`	Specifies the name of the parameter. Provide multiple parameter values in the format `-n p1 -v v1 -n p2 -v v2`.
`--reset`, `-r`	Resets the parameter to the default value. For example: `-n p1 -n p2 -r`. The default is false.
`--update`, `-u`	Replaces the parameter with the specified value. For example: `-n p1 -v v1 -n p2 -v v2 -u`. The default is false.
`--value`, `-v`	Specifies the value of the parameter. Provide multiple parameter values in the format `-n p1 -v v1 -n p2 -v v2`.

Usage Notes

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

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

Example 15-13 Setting Multiple Parameters

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

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

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

update-agentconfig-parameters -n OSPatchRepos -v

Related Topics

Configuring Agent Proxy Settings for Object Store Access

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

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

Syntax

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

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.

Usage Notes

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

Example 15-14 Example Command


./odacli list-agentconfig-parameters -n HttpProxyPort




Name      Value      Description      Updated                            

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

HttpProxyPort  Http proxy server port    June 24, 2018 4:14:10 AM UTC       
./odacli list-agentconfig-parameters

Name          Value     Description   Updated                            

------------------------------ ----------------------------------------------------------------- 
HttpProxyHost   Http proxy server host  June 24, 2018 4:14:10 AM UTC       

HttpProxyPort   Http proxy server port   June 24, 2018 4:14:10 AM UTC       

HttpsProxyHost   Https proxy server host  June 24, 2018 4:14:10 AM UTC       

HttpsProxyPort  Https proxy server port  June 24, 2018 4:14:10 AM UTC       

OSPatchRepos Repo list for OS patching June 24, 2018 4:14:10 AM UTC

Related Topics

Configuring Agent Proxy Settings for Object Store Access

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

$ORACLE_HOME/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 15-15 Displaying All Patch Pre-Checks Reports

# odacli list-availablepatches
latest Patch Version
--------------------
18.3.0.0.0

Available Patches    Db Version
-------------------- --------------------
18.3.0.0.0           12.2.0.1.180717, 12.1.0.2.180717, 11.2.0.4.180717

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 15-16 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
`Report ID`	Describes the ID of the report to be deleted.
`--help`, `-h`	(Optional) Displays help for using the command.

Usage Notes

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

Example 15-17 Deleting A Patch Pre-Checks Report

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

Parent topic: odacli Apply Patch and Update Commands

odacli update-dbhome

Use the odacli update-dbhome command to update a specific RDBMS Home to the latest patch bundle version.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter	Description
`--dbhomeid`, `-i`	Defines the Oracle Database Home to update.
`--help-h`	(Optional) Displays help for using the command.
`--json`, `-j`	(Optional) Displays JSON output. The default is false.
`--precheck`, `–p`	Analyzes the patch.
`--version`, `-v`	Defines the Oracle Database Appliance version to update. For example, 12.2.1.1.

Usage Notes

The update-dbhome command applies the latest release update (RU) for Oracle Database home.
To be updated with the latest patches, the database must be running.
Only databases in the Configured status are updated. Use the odacli list-database command to see a list of configured databases. Databases in any other status are skipped during the update.

Example 15-18 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 18.5.0.0.0

Parent topic: odacli Apply Patch and Update Commands

odacli update-dcsagent

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

File Path

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

Syntax

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

Parameters

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

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 15-19 Updating the Agent

To update the dcs-agent to version 18.5:


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

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.

The following is an example of the steps to get the files from My Oracle Support, extract, and concatenate the files:

Note:

The file names in the examples might not reflect actual file names.

(Optional) Create a temporary directory in the /u01 directory. You will upload your Oracle Database Appliance software to this directory before adding the files to the update repository. You can use the existing /tmp directory, but it might not have sufficient space for the zip files. It is a good practice to clean the /tmpdir directory after you update the repository.
```
/u01/tmpdir
```
Download the Oracle Database Appliance software files from My Oracle Support, then upload the files to a temporary location in the /u01 directory in Oracle Database Appliance. For example:

p26433721_122110_Linux-x86-64_1of2.zip and p26433721_122110_Linux-x86-64_2of2.zip
If the patch contains more than one zip file, then extract the zip files and concatenate the files into a single zip file. For example, a file named oda-sm-12.2.1.1.0-171031-server.zip before updating the repository.

When inflated, the files are named oda-sm-12.2.1.1.0-171031-server_1of2.zippart and oda-sm-12.2.1.1.0-171031-server_2of2.zippart
```
# cat oda-sm-12.2.1.1.0-171031-server_1of2.zippart oda-sm-12.2.1.1.0-171031-server_2of2.zippart > oda-sm-12.2.1.1.0-171031-server.zip
```
Concatenate the zip files into a single zip file. For example, a file named oda-sm-12.2.1.1.0-171031-server.zip.
```
# cat oda-sm-12.2.1.1.0-171031-server_1of2.zippart oda-sm-12.2.1.1.0-171031-server_2of2.zippart > oda-sm-12.2.1.1.0-171031-server.zip
```
The file is named oda-sm-12.2.1.1.0-171031-server.zip
Use the concatenated zip file to update the repository

File Path

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

Example 15-20 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:

# ./odacli update-repository -f /u01/tmpdir/oda-sm-12.2.1.1.0-171031-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" : "March 18, 2019 14:13:45 AM CST",
  "description" : "Repository Update",
  "updatedTime" : "March 18, 2019 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   March 18, 2019 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  -v version [-j] [-h]

Parameters

Parameter	Description
`--precheck`, `–p`	Analyzes the patch.
`--version`, `–v`	Defines the version to update.
`--local`,`–l`	Updates the server on the local node of multi-node high availability (HA) systems. This option is not needed for single-node systems.
`--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.

Note:

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

Example 15-21 Updating the Server

Run the odacli update-server command to update the server to 18.5.0.0.0. On a multi-node HA system, you must run the command on both nodes to update the server version.

# odacli update-server -v 18.5.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" : "March 18, 2019 14:13:45 PM CST",
  "resourceList" : [ ],
  "description" : "Server Patching",
  "updatedTime" : "March 18, 2019 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

Example 15-22 Updating the Storage

# odacli update-storage -v 18.5.0.0

Parent topic: odacli Apply Patch and Update Commands

odacli Appliance Commands

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

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

Parent topic: Oracle Database Appliance Command-Line Interface

odacli create-appliance

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

File Path

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

Syntax

To view help for the odacli create-appliance command:

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

Note:

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

Parameters

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

Parent topic: odacli Appliance Commands

odacli describe-appliance

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

File Path

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

Syntax

odacli describe-appliance [-d|-no-d][-j][-h]

Parameters

Parameter	Description
`--details`, `-d`	(Optional) Displays the agent CLI build details.
`--help`, `-h`	(Optional) Displays help for using the command.
`--json`, `-j`	(Optional) Displays JSON output.
`--no-details`, `-no-d`	(Optional) Displays no detailed information. Use this flag if you do not want to display details.

Example 15-23 Displaying Appliance Details

# odacli describe-appliance -d

Appliance Information 
----------------------------------------------------------------
ID: 78e9a6b8-c4f8-42b2-9e72-7d23c2636544                
Platform: OdaliteL         
Data Disk Count: 6         
CPU Core Count: 20                 
Created: March 18, 2019 5:14:41 AM EST 

System Information 
----------------------------------------------------------------                   
Name: rwsoda6f002             
Domain Name: example.com               
Time Zone: America/New_York              
DB Edition: EE             
DNS Servers: 10.204.32.1             
NTP Servers: 10.68.0.41 10.68.0.42  

Disk Group Information 
---------------------------------------------------------------- 
DG Name     Redundancy     Percentage 
----------- ------------- ------------ 
Data         High           80 
Reco         High           20

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 15-24 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                Comonent Details                                             
---------------               ----------------------------------------------------------------------------------------------- 
NODE                          Name : rwsoda6m003 
                              Domain Name :  
                              Time Stamp : July 29, 2018 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 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 15-25 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.

Topics:

odacli create-backup
Use the command odacli create-backup to create a Level 0, Level 1, archivelog, or Longterm backup.
odacli create-backupconfig
Use the command odacli create-backupconfig to create a backup configuration.
odacli create-objectstoreswift
Use the command odacli create-objectstoreswift to create and store the Oracle credential details required to backup to Oracle Object Store.
odacli delete-backup
Use the command odacli delete-backup to delete backups.
odacli delete-backupconfig
Use the command odacli delete-backupconfig to delete a backup configuration.
odacli delete-objectstoreswift
Use the command odacli delete-objectstoreswift to delete the credentials for the ObjectStore account.
odacli describe-backupreport
Use the command odacli describe-backupreport to display details of a specific backup report.
odacli describe-schedule
Use the command odacli describe-schedule to display details for a specific schedule.
odacli irestore-database
Use the command odacli irestore-database to restore a database from one system to other system from ObjectStore based on a LongTerm BackupReport.
odacli list-backupreports
Use the command odacli list-backupreports to display a list of all backup reports.
odacli list-backupconfigs
Use the command odacli list-backupconfig to list all backup configurations.
odacli list-objectstoreswifts
Use the command odacli list-objectstoreswifts to display a list of credentials for the ObjectStore account.
odacli list-schedules
Use the command odacli list-schedules to display a list of the scheduled backups.
odacli recover-database
Use the odacli recover-database command to recover or restore a database from backup.
odacli update-backupconfig
Use the command odacli update-backupconfig to update a backup configuration.
odacli update-database
Use the command odacli update-database to associate a backup configuration to a database.
odacli update-objectstoreswift
Use the command odacli update-objectstoreswift to change the credentials for the ObjectStore account.
odacli update-schedule
Use the command odacli update-schedule to update the schedule for a database, or to disable the database backup schedule.

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

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

Syntax

  odacli  create-backup -iDatabase Resource ID [-bt] [-c] [-h] [-j] [-k] [-t]

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}`	(Optional) Defines the component. Database is the only supported option.
`--dbid`, `-i`	Defines the Database Resource ID.
`--help`, `-h`	(Optional) Displays help for using the command.
`--json`, `-j`	(Optional) Displays JSON output. The default is false.
`--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.

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. If you do not select a backup type (level 0, level 1, or LongTerm), a level 1 backup is performed.
- Longterm: Longterm backups are only available when backing up to 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.
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 15-26 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 15-27 Create a Level 0 Database Backup

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

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

Parent topic: odacli Backup and Recovery Commands

odacli create-backupconfig

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

File Path

$ORACLE_HOME/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]

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

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
- Object Storage: 1-31 days

Example 15-28 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 15-29 Create a Backup Configuration for NFS Location

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

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

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

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

Syntax

# odacli  create-objectstoreswift -e swift end point URL [-h] [-j] -n Object Store Swift name [-p] swiftpassword -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.
`--swiftpassword`, `-p`	(Optional) Defines the Object Store Swift password.
`--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 the command odacli create-backupconfig with objectstore as the destination. The credentials are not validated against endpoint URL and tenancy.

Parent topic: odacli Backup and Recovery Commands

odacli delete-backup

Use the command odacli delete-backup to delete backups.

File Path

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

Syntax

  odacli  delete-backup -iDatabase Resource ID [-br] [-h] [-j]

Parameters

Parameter	Description
`--backupreport`, `-br`	(Optional) Defines the backup report. To delete a Long Term backup, use a JSON input file for the backupreport.
`--dbid`, `-i`	Defines the Database Resource Identifier (ID). To delete a level 0 or level 1 backup, use the database resource ID.
`--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 backups 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 from Oracle Object Storage by using a JSON file with the --backupreport option.
To locate the database ID, view the databases in the Web Console or use the command odacli list-databases.

Example 15-30 Delete a Level 0 or Level 1 Backup

# odacli delete-backup -i20576eb1-bc32-4e34-bf97-fda0b60ca15b

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

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

Syntax

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

Parameters

Parameter	Description
`--help`, `-h`	(Optional) Displays help for using the command.
`--id`, `-i`	Defines the Backup Config identifier (ID).
`--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 15-32 Deleting a Backup Configuration

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

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

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

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

Syntax

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

Parameters

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

Usage Notes

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

Example 15-33 Deleting the Oracle Object Store Credentials

# odacli  delete-objectstoreswift -i Object Store Swift id

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 15-34 Display Details of a Specific Backup Report

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

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

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

Syntax

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

Parameters

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

Example 15-35 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 ObjectStore based on a LongTerm BackupReport.

File Path

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

Syntax

  odacli  irestore-database -iDatabase Resource ID [-bp] [-r] [-cl] [-co] [-s] [-dr] [-y] [-h] [-j] [-c] [-oid] [-tp] [-tf] [-bl] [-rDBID]

Parameters

Parameter	Description
`--backupPassword(s)`, `-bp`	(Optional) Defines the RMAN password for recovery. You can provide more than one password, but the passwords must be separated by a comma(,).
`--backupReport`, `-r`	JSON input for a backup report.
`--dbClass`, `-cl {EE: OLTP/DSS/IMDB, SE: OLTP}`	(Optional) Defines the Database class.
`--dbConsoleEnable`, `-co`	(Optional) Enables the Database Console.
`--dbShape`, `-s` {odb1,odb2, and so on}	(Optional) Defines the database shape.
`--dbStorage`, `-dr` {ACFS\|ASM}	(Optional) Defines the database storage. Database Storage {ACFS\|ASM} (non case-sensitive). The default is ASM.
`--dbType`, `-y`	(Optional) Defines the type of database. The default is single instance (SI).
`--help`, `-h`	(Optional) Displays help for using the command.
`--json`, `-j`	(Optional) Displays JSON output. The default is false.
`--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
`--sysPassword`, `-m`	Defines the password for the SYS user.
`--tdePassword`, `-tp`	(Optional) Defines the password for the TDE Wallet.
`--tdefilesLocation`, `-tf`	(Optional) Identifies the TDE Wallet location in Objectstore.
`--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, at least one disk group of FLEX redundancy must exist, and `dbStorage` must be ASM, and the `dbVersion` or `dbHomeVersion` must later than 12.1. If the disk group redundancy is FLEX, then the default `dbRedundancy` value is MIRROR. The precedence logic for setting the `dbRedundancy` is: `dbRedundancy` that is specified in the `irestore-database` command. `dbRedundancy` in the backup report If the disk group redundancy is FLEX, then the default `dbRedundancy` value is MIRROR.
`-rDBID`	Enables target database to run in the same system as source database.

Usage Notes

The command odacli irestore-database restores a database to a system using the Backup Report of a long term backup that is in the Oracle Object Store. 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.

Example 15-36 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 -m

Example 15-37 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 -m

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

#  odacli  list-backupreports

Parent topic: odacli Backup and Recovery Commands

odacli list-backupconfigs

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

File Path

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

Syntax

  odacli  list-backupconfig  [-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 15-39 Displaying a List of Backup Configuration

Display a list of backup configurations.

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

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 15-40 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 a list of the scheduled backups.

File Path

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

Syntax

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

Parameters

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

Usage Notes

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

Example 15-41 Display a List of Scheduled Database Backups

Display a list of all scheduled database backups and details.

#  odacli  list-schedules

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

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

Syntax

  odacli  recover-database -iDatabase Resource ID [-br] [-i] [-h] 
[-j] [-r] [-t] [-p] [-s] [-in]

Parameters

Parameter	Description
`--backupReport`, `-br`{Regular-L0\|Regular-L1\|Longterm}	(Optional) JSON input for a backup report.
`--dbName`, `-in`	Defines the Database Name.
`--dbid`, `-i`	Defines the Database Resource ID.
`--help`, `-h`	(Optional) Displays help for using the command.
`--json`, `-j`	(Optional) Displays JSON output. The default is false.
`--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.

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

Example 15-42 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 15-43 Recovering a Database to the Latest

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

Example 15-44 Recovering a Database to an SCN

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

Parent topic: odacli Backup and Recovery Commands

odacli update-backupconfig

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

File Path

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

Syntax

  odacli  update-backupconfig  -n backup configuration name 
-d backup destination{Disk|ObjectStore|None} [-c] [-cr] [-h] [-j] [-no-cr] [-o][-w]

Parameters

Parameter	Description
`--backupdestination`, `–d`{Disk\|ObjectStore\|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.
`--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.

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

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

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

Parent topic: odacli Backup and Recovery Commands

odacli update-database

Use the command odacli update-database to associate a backup configuration to a database.

File Path

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

Syntax

  odacli  update-database  [-bi] [-i] [-h] [-j] [-bp] [-in] [-bin] [-id] [-lb]

Parameters

Parameter	Description
`--backupconfigid`, `-bi`	(Optional) Defines the Backup Config ID.
`--backupconfign`, `-bin`	(Optional) Defines the Backup Config Name.
`--dbid`, `-i`	Defines the Database Resource ID.
`--dbName`, `-in`	Defines the Database Name.
`--help`, `-h`	(Optional) Displays help for using the command.
`--json`, `-j`	(Optional) Displays JSON output. The default is false.
`--bkuppassword`, `-bp`	(Optional) Defines the RMAN backup encryption password.
`--databaseid`, `-id`	(Optional) Defines the database identifier stored in database file headers.
`--levelzerobackupday`, `-lb`	(Optional) Specifies the Level zero Backup Day. For example, Monday\|Tuesday\|Wednesday...\|Sunday

Usage Notes

For backup to the Oracle Object Store, you can set an RMAN backup password. The password is encrypted and stored in an Oracle wallet. The password is used when using the command odacli create-backup to create a database backup.

Example 15-46 Associating a Backup Configuration with a Database

# odacli  update-database  -i database resource ID -bi backup configuration ID

Example 15-47 Updating an Existing Database Using the Resource ID

Update an existing database to attach the backup configuration to the database using the Database Resource ID.

 # odacli update-database -i d3c4d8f6-5eb7-4f9e-ab27-7bdd5013ac90 
-bi 9d942e0a-ba00-4cbc-9bfb-0de83ed279e5 -bp

Example 15-48 Updating an Existing Database Using the Resource Name

Update an existing database to attach the backup configuration to the database using the Database Resource Name.

In the following example, the Database Resource Name is mydb:

# odacli update-database -in mydb -bi 9d942e0a-ba00-4cbc-9bfb-0de83ed279e5 -bp

In the following example, the Database Resource Name is mydb and the backup configuration name is mybcfg:

# odacli update-database -in mydb -bin mybcfg -bp

Parent topic: odacli Backup and Recovery Commands

odacli update-objectstoreswift

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

File Path

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

Syntax

# odacli  update-objectstoreswift [-h] [-j] -i Object Store Swift id [-p] swift password  [-u] Object Store user name

Parameters

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

Usage Notes

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

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

Example 15-49 Changing the Oracle Casper ObjectStore Password

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

Example 15-50 Changing the Oracle ObjectStore User Name

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

Parent topic: odacli Backup and Recovery Commands

odacli update-schedule

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

File Path

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

Syntax

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

Parameters

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

Usage Notes

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

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

Example 15-51 Change What Time the Backup Occurs

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

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

Example 15-52 Disable Scheduled Database Backups

#  odacli  update-schedule -i scheduleid  -d

Parent topic: odacli Backup and Recovery 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.
update-cpucore
Use the odacli update-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 15-53 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 15-54 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

update-cpucore

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

File Path

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

Syntax

 odacli update-cpucore  -c cores [-h]

Parameters

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

Usage Notes

The number of cores you enable must be a multiple of 2.
After the initial configuration, you cannot reduce the number of cores. You can only increase the number of cores.

Example 15-55 Enabling CPU Cores

The following command enables 8 CPU cores.

# odacli update-cpucore -c 8
 
{ 
"jobId" : "2807f6ae-3ba5-48a5-8941-b8b365d89d24",
"status" : "Created",
"message" : null, 
"reports" : [ ], 
"createTimestamp" : 1469410799194, 
"description" : "CPU cores service update", 
"updatedTime" : 1469410799194
}

Parent topic: odacli CPU Core Commands

odacli Database Commands

Use the odacli database commands to perform database lifecycle operations.

odacli list-databases
Use the odacli list-databases command to list all databases on the appliance.
odacli describe-database
Use the odacli describe-database command to display database details.
odacli create-database
Use the odacli create-database command to create a new database.
odacli clone-database
Use the odacli clone-database command to clone a new database from a source database.
odacli modify-database
Use the odacli modify-database command to move a database from one database home to another database home of same base version.
odacli register-database
Use the odacli register-database command to register a migrated database with the appliance.
odacli upgrade-database
Use the odacli upgrade-database command to upgrade a database from a supported release.
odacli delete-database
Use the odacli delete-database command to delete a database.

Parent topic: Oracle Database Appliance Command-Line Interface

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.

Example 15-56 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     18.5.0.0.0    true
fb4d02f3-2413-47ca-8584-a768e23ec2e7   ee12db      18.5.0.0.0    false

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

Parent topic: odacli Database Commands

odacli describe-database

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

File Path

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

Syntax

To display database details:

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

Parameters

Parameter Description

Parameter	Description
`--dbid`, `-i`	Identifies the database home identifier (ID) to display. Use the `odacli list-databases` command to obtain the `dbid`.
`--json`, `-j`	(Optional) Displays JSON output.
`--help`, `-h`	(Optional) Displays help for using the command.

--dbid, -i

Identifies the database home identifier (ID) to display.

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

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Example 15-57 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: 18.5.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: March 18, 2019, 2016 6:21:14 PM

Parent topic: odacli Database Commands

odacli create-database

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

File Path

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

Syntax

odacli create-database -n database_name -m -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] [-j] [-h] [-rd]

Parameters

Parameter	Description
`--adminpassword`, `-m`	Defines the password for `SYS`, `SYSTEM`, and `PDB Admin`. Use this option to specify the password interactively. When using this option, do not enter the password in the command-line.
`--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.
`--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 [SI]`	Defines the database type. The default database type 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. For example, 12.1.0.2.170814 or 11.2.0.4.170814.
`--dbRedundancy`, `-rd`	Specifies the database redundancy value, that is, `{HIGH\|MIRROR}`. To specify the `dbRedundancy` option, at least one disk group of FLEX redundancy must exist, and `dbStorage` must be ASM, and the `dbVersion` or `dbHomeVersion` must later than 12.1.

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.
Use the --cdb or --no-cdb flag to indicate whether or not the database is a container database. When neither flag is specified, the default database created is a non-CDB database.
When --dbhomeid is not provided, the create-database command creates a new Oracle Database Home.
When --dbhomeid is provided, the create-database command creates the database using the existing Oracle Home. Use the odacli list-dbhomes command to obtain the dbhomeid.
When you use the command to create an instance-only database, then you cannot specify the database shape (template).
When you specify both the --version and the--dbhomeid, the version is ignored and the database is created against the existing database home.
Oracle Database 12.1 or later is supported on both Oracle Automatic Storage Management (Oracle ASM) and Oracle ASM Cluster file system (ACFS). The default is Oracle ASM.
Oracle Database 11.2 is only supported on Oracle ACFS.
When databases are created in Oracle ACFS, each database is configured with its own Oracle ACFS file system for the datafiles and uses the following naming convention: /u02/app/db user/oradata/db unique name. The default size of this mount point is 100 GB.

Note:
Oracle recommends not sharing the mount point across different databases.
Online logs are stored in the /u03/app/db user/redo/ directory.
Oracle Fast Recovery Area (FRA) is located in the /u03/app/db user/fast_recovery_area directory.
Use the following option to specify the adminpassword:
- Interactive mode: Use the -m option and enter the password when prompted.
For the version, you can specify the database version, either 18.5.0.0, 12.2.0.1, 12.1.0.2 or 11.2.0.4, 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. The following values are supported:
- 18.5.0.0
- 12.2.0.1
- 12.2.0.1.171017
- 12.2.0.1.170814
- 12.1.0.2
- 12.1.0.2.171017
- 12.1.0.2.170718
- 12.1.0.2.170418
- 12.1.0.2.161018
- 12.1.0.2.160719
- 12.1.0.2.160419
- 11.2.0.4
- 11.2.0.4.171017
- 11.2.0.4.170718
- 11.2.0.4.170418
- 11.2.0.4.161018
- 11.2.0.4.160719
Note:
Oracle Database 11.2.0.4.160419 is not supported. Attempts to create an Oracle Database 11.2 against an 11.2.0.4.160419 database home will fail.

Example 15-58 Creating a Database in Interactive Mode

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

Note:

To provide a password interactively, use the -m option, but do not provide the password until prompted.

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

Password for SYS,SYSTEM and PDB Admin: 
{
   "jobId" : "f12485f2-dcbe-4ddf-aee1-de24d37037b6",
   "status" : "Created",
   "message" : null,
   "reports" : [ ],
   "createTimestamp" : "March 18, 2019 03:54:03 AM EDT",
   "description" : "Database service creation with db name: hrdb",
   "updatedTime" : "March 18, 2019 03:54:03 AM EDT" 
}

Example 15-59 Creating a Database Against a Different Version

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

# odacli create-database -m -n hrmsdb1 -v 12.1.0.2       
# odacli create-database -m -n hrmsdb2 -v 12.1.0.2.170718

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

# odacli create-database -m -n hrmsdb3 -v 12.1.0.2.170814

Parent topic: odacli Database Commands

odacli clone-database

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

File Path

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

Syntax

odacli clone-database [-u] [-n] [-s] [-y|SI|RAC|RACONE] [-j] [-from] [-m] [-p] [-h]

Parameters

Parameter	Description
`--databaseUniqueName`, `-u`	(Optional) Defines a unique name for the database. If the `--databaseUniqueName` option is not provided, then the name of the database is set to the `--dbname` value.
`--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`.
`--dbtype, -y [SI]`	Defines the database type. The default database type is SI.
`--help`, `-h`	(Optional) Displays help for using the command.
`--json`, `-j`	(Optional) Displays JSON output.
`--sourcedbname`, `-from`	Specifies the name of the source database
`--syspassword`, `-m`	Specifies the password for the `SYS` user.
`--tdepassword`, `-p`	Specifies the password for the source TDE Wallet.

Usage Notes

The source database must be up and running.
The source database must use Oracle ACFS storage.
The source database must not be a multitenant container database (CDB)

Example 15-60 Cloning a Database

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

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

Related Topics

Cloning a Database

Parent topic: odacli Database Commands

odacli modify-database

Use the odacli modify-database command to move a database from one database home to another database home of same base version.

File Path

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

Syntax

odacli modify-database [-i] [-n] [-h] [-j]

Parameters

Parameter	Description
`--databaseid`, `-i`	Defines the Database ID.
`--destdbhomeid`, `-n`	Defines the database ID of the destination database home.
`--help`, `-h`	(Optional) Displays help for using the command.
`--json`, `-j`	(Optional) Displays JSON output.

Example 15-61 Modifying a Database

# ./odacli modify-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

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

Syntax

odacli register-database  -c {OLTP|DSS|IMDB} -s dbshape -t dbtypeSI 
-o hostname -sn servicename -p syspassword[-bi backupconfigid] [-co|-no-co] [-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-co`flag 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]	Defines the type of database. The database type is Single Instance. The default 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 `-co`flag 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.
`--syspassword`, `-p`	Defines the proxy user password for SYS.

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 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.
The following are the minimum compatible parameters set, based on the database version:
- Oracle Database 18c : 18.3.0.0
- Oracle Database 12c : 12.1.0.2
- Oracle Database 11 g : 11.2.0.4
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 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. Depending on the database role, the database is registered as Primary or Standby database with Oracle Clusterware.
If you are registering the database as a standby database, then open the database in read-only mode before executing the odacli register-database command.

Example 15-62 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 -p
Password for SYS:
{
  "jobId" : "317b430f-ad5f-42ae-bb07-13f053d266e2",
  "status" : "Created",
  "message" : null,
  "reports" : [ ],
  "createTimestamp" : "March 18, 2019 05:55:49 AM EDT",
  "description" : "Database service registration with db service name: crmdb.example.com",
  "updatedTime" : "March 18, 2019 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: March 18, 2019 5:55:49 AM EDT
                Message:

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

(Continued)
  End Time                     Status
------------------------------- --------
March 18, 2019 5:56:08 AM EDT   Success
March 18, 2019 5:56:13 AM EDT   Success
March 18, 2019 5:57:05 AM EDT   Success
March 18, 2019 5:57:36 AM EDT   Success
March 18, 2019 5:57:49 AM EDT   Success

Parent topic: odacli Database Commands

odacli upgrade-database

Use the odacli upgrade-database command to upgrade a database from a supported release.

File Path

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

Syntax

To upgrade an Oracle Database:

 odacli upgrade-database -i Comma separated list of database ids -from source dbhome id -to destination dbhome id [-j] [-h]

Parameters

Parameter	Description
`--databaseids`, `-i`	(Optional) Defines the Database IDs to upgrade. You can use a comma separated list of database IDs.
`--destDbHomeId`, `-to`	The DB HOME ID of the destination database home.
`--sourceDbHomeId`, `-from`	The DB HOME ID of the source database home.
`--json`, `-j`	(Optional) Displays JSON output. The default is false.
`--help`, `-h`	(Optional) Displays help for using the command.

Usage Notes

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 18c
Oracle Database 12.1 to 18c
Oracle Database 11c to 18c
Oracle Database 12.1 to 12.2
Oracle Database 11c to 12.2
Oracle Database 11c to 12.1

Example 15-63 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 11.2.0.4 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
------------------------------------   ----------  ----------  ----
ad6c7326-e460-411e-94df-230dedbef743   rdb121a     11.2.0.4    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


# 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

Related Topics

About Upgrading to a Different Database Home

Parent topic: odacli Database Commands

odacli delete-database

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

File Path

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

Syntax

To delete a database:

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

Parameters

Parameter Description

Parameter	Description
`--dbid`, `-i`	Identifies the database home identifier (ID) to display. Use the `odacli list-databases` command to obtain the `--dbid`.
`--help`, `-h`	(Optional) Displays help for using the command.
`--json`, `-j`	(Optional) Displays JSON output.

--dbid, -i

Identifies the database home identifier (ID) to display.

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

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Usage

Note:

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

Example 15-64 Deleting a Database Named hrmsdb

In this example we want to delete a database named hrmsdb. Before we can delete the database, we need to know the database home identifier (dbid). This example shows how to run the odacli list-databases command to list the databases and their associated dbid, then how to delete database hrmsdb.

# odacli list-databases   

ID                                     DB Name  DB Version   CDB  Class 	
-------------------------------------  -------	----------   ----  ----- 	
a3f4a6c0-a0c9-4c79-bad7-898afcf9de46   hrmsdb  12.1.0.2      true   OLTP
7e28bf52-1a09-49fd-9391-841838d2c42f   crmdb   12.1.0.2      false  OLTP

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

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

Parent topic: odacli Database Commands

odacli DBHome Commands

Use the odacli DBHome commands to manage database Home operations.

odacli list-dbhomes
Use the odacli list-dbhomes command to display a list of Oracle Home directories.
odacli describe-dbhome
Use the odacli describe-dbhome command to display Oracle Database Home details.
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.

Parent topic: Oracle Database Appliance Command-Line Interface

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.

Example 15-65 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 describe-dbhome

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

File Path

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

Syntax

To display details about Oracle Database Home:

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

Parameters

Parameter	Description
`-i dbhomeid`	Identifies the database home ID. Use the `odacli list-dbhomes` command to get the dbhomeid.
`--help`, `-h`	(Optional) Displays help for using the command.
`--json`, `-j`	(Optional) Displays JSON output. The default is false.
`-vdbversion`	(Optional) Identifies the Database Home Version. Use the `odacli list-dbhomes —v` command to get the dbversion.

Example 15-66 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: OraDB12102_home1 
                        Version: 12.1.0.2
               Home Location: /u01/app/orauser/product/12.1.0.2/dbhome_1
                       Created: Jun 2, 2016 10:19:23 AM

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, either 18.5.0.0, 12.2.0.1, 12.1.0.2 or 11.2.0.4, or you can use a 5 digit format to specify a specific patch bundle version. For example, 12.1.0.2.161018. If you use the database version without specifying the bundle patch number, then the latest bundle patch is used.

The following values are supported:

18.5.0.0
12.2.0.1
12.2.0.1.170814
12.1.0.2
12.1.0.2.170718
12.1.0.2.170418
12.1.0.2.161018
12.1.0.2.160719
12.1.0.2.160419
11.2.0.4
11.2.0.4.170718
11.2.0.4.170418
11.2.0.4.161018
11.2.0.4.160719

Note:

Oracle Database 11.2.0.4.160419 is not supported. Attempts to create an Oracle Database 11.2 against an 11.2.0.4.160419 database home will fail.

Example 15-67 Creating an Oracle Database Home

The following example creates an Oracle Database Home version 18.5.0.0.190115.

# odacli  create-dbhome -v 18.5.0.0.190115

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

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

Syntax

odacli delete-dbhome  -i [-h]

Parameters

Parameter	Description
`--id`, `-i`	Identifies the database home using a database identifier (ID).
`--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 15-68 Deleting an Empty Database Home

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

Parent topic: odacli DBHome Commands

odacli Database Storage Commands

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

odacli list-dbstorages
Use the odacli list-dbstorages command to display a list of all of the database storage configured in the appliance.
odacli describe-dbstorage
Use the odacli describe-dbstorage command to display storage configuration details.
odacli create-dbstorage
Use the odacli create-dbstorage command to create the file system for database migrations.
odacli delete-dbstorage
Use the odacli delete-dbstorage command to delete database storage that is not associated with a database.
odacli describe-dgstorage
Use the odacli describe-dgstorages command to display the disk group information.
odacli list-dgstorages
Use the odacli list-dgstorages command to display the disk group information.

Parent topic: Oracle Database Appliance Command-Line Interface

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

$ORACLE_HOME/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 15-69 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 describe-dbstorage

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

File Path

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

Syntax

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

Parameters

Parameter	Description
`--id`, `-i`	Identifies the database storage.
`--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 15-70 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 15-71 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 create-dbstorage

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

File Path

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

Syntax

odacli create-dbstorage  -n dbname -s dataSize -u databaseUniqueName -r [ASM|ACFS] [-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
`--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 15-72 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

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

Syntax

odacli delete-dbstorage  -i [-h]

Parameters

Parameter	Description
`--id`, `-i`	Identifies the database storage using a database identifier (ID).
`--help`, `-h`	(Optional) Displays help for using the command.

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 15-73 Deleting Empty Database Storage

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

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 15-74 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-dgstorages

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

File Path

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

Syntax

odacli list-dgstorages  -r redundancy -h

Parameters

Parameter	Description
`--redundancy`, `-r`	Specifies the disk group redundancy.
`--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 EXTERN | NORMAL | HIGH. Use any of these options to specify the 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 15-75 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 Job Commands

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

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

File Path

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

Syntax

To list jobs and view job details and status:

   odacli list-jobs [-j] [-h] [-o] [-f] [-t] [-hd] [-tl] [-k] [-s]

Parameters

Parameter	Description
`--json`, `-j`	(Optional) Displays JSON output.
`--help`, `-h`	(Optional) Displays help for using the command.
`--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`
`--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`
`--keyword`, `-k`	(Optional) Specifies the keyword that the job description contains. Example: `# odacli list-jobs -k OraDB`
`--status`, `-s`	(Optional) Specifies the status of the job, such as Created, Scheduled, Running, Failure, Success, InternalError. Example: `# odacli list-jobs -s Failure`

Example 15-76 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 15-77 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 15-78 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 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

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

Syntax

To view a specific job, status, and tasks:

   odacli describe-job   -i jobid [-j] [-h]

Parameters

Parameter	Description
`--jobid`, `-i` jobid	Identifies the job. To get the job identifier (jobid), run the `list-jobs` command.
`--json`, `-j`	(Optional) Displays JSON output.
`--help`, `-h`	(Optional) Displays help for using the command.

Example 15-79 Displaying Details for a Job

To display details of a specific job with jobid 02df22c8-c21f-4162-8265-97f7826c243a:

 # odacli describe-job -i 02df22c8-c21f-4162-8265-97f7826c243a

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

Parameters

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

Example 15-80 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 Network Commands

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

odacli list-networks
Use the odacli list-networks command to display networks.
odacli describe-network
Use the odacli describe-network command to display the details of a specific network.
odacli create-network
Use the odacli create-network command to create a network.
odacli update-network
Use the odacli update-network command to update an existing network configuration.
odacli delete-network
Use the command odacli delete-network to delete a network.
odacli describe-networkinterface
Use the odacli describe-networkinterface command to display the details of any network interface.
odacli list-networkinterfaces
Use the odacli list-networkinterfaces command to display network interfaces.

Parent topic: Oracle Database Appliance Command-Line Interface

odacli list-networks

Use the odacli list-networks command to display networks.

File Path

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

Syntax

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

Parameters

Parameter	Description
`--json`, `-j`	(Optional) Displays JSON output.
`--help`, `-h`	(Optional) Displays help for using the command.
`--nodeNumber`, `-u`	(Optional) Displays the network interface information for the specified node. By default, the node number is always the first node (Node0).

Example 15-81 Displaying a List of Networks

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

# odacli list-networks
ID                                       Name                 NIC        InterfaceType 
IP Address         Subnet Mask        Gateway            VlanId    
---------------------------------------- --------------------   
93c07043-3002-494a-8fa0-f3ae932fb4c5     Private-network      ibbond0    BOND       
192.168.16.25      255.255.255.0

Parent topic: odacli Network Commands

odacli describe-network

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

File Path

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

Syntax

To display the details of a specific network:

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

Parameters

Parameter	Description
`--id`, `-i`	Identifies the network ID. Use the `odacli list-networks` command to obtain the `id`.
`--json`, `-j`	(Optional) Displays JSON output.
`--help`, `-h`	(Optional) Displays help for using the command.
`--nodeNumber`, `-u`	(Optional) Displays the network interface information for the specified node. By default, the node number is always the first node (Node0).

Example 15-82 Displaying Network Details

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

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

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

Parent topic: odacli Network Commands

odacli create-network

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

File Path

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

Syntax

odacli create-network [-d|-no-d] -n interface -p ipaddress
 -w {Public|Private|Dataguard|Backup|Other} -s subnetmask -g 
gateway[-h] [-j] VLAN [-p]

Parameters

Parameter	Description
`--defaultnetwork`, `-d`	Identifies the default network.
`--gateway`, `-g`	Defines the network gateway. The gateway is required for the default network.
`--help`, `-h`	(Optional) Displays help for using the command.
`--interface`, `-n`	Defines the name of the network interface.
`--ipaddress`, `-p`	Defines the network IP address.
`--json`, `-j`	(Optional) Displays JSON output.
`--networktype`, `-w`	Defines the type of network. Options are: {Public\|Private\|Dataguard\|Backup\|Other}
`--no-defaultnetwork`, `no–d`	Identifies a network as not the default network. Use `--defaultnetwork. -d` to identify a default network.
`subnetmask`, `-s`	Defines the Network Subnet Mask.
`VLAN`, `-p`	Add VLAN as a new network.

Usage Notes

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.

Example 15-83 Creating a Network

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

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

Example 15-84 Creating a VLAN Network

odacli create-network -u 0 -n btbond1 -t VLAN -p 192.0.2.1 -m vlan123 
-w Database -s 255.255.255.0 -g 192.0.2.1 -v 123

odacli create-network -u 1 -n btbond1 -t VLAN -p 192.0.2.1 -m vlan123 
-w Database -s 255.255.255.0 -g 192.0.2.1 -v 123

Parent topic: odacli Network Commands

odacli update-network

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

File Path

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

Syntax

To update a network:

odacli  update-network -i id [-p IP address] 
[-w [Public|Dataguard|Backup|Other]] [-s  network subnet mask] 
[-g network gateway] [-j] [-h]

Parameters

Parameter	Description
`--id`, `-i`	Defines the network identity.
`--gateway`, `-g`	(Optional) Defines the network gateway.
`--ipaddress`, `-p`	(Optional) Defines the network IP address.
`--json`, `-j`	(Optional) Displays JSON output.
`--networktype`, `-w` [Public\|Dataguard\|Backup\|Other]	(Optional) Defines the type of network.
`subnetmask`, `-s`	(Optional) Defines the Network Subnet Mask.
`--help`,`-h`	(Optional) Displays help for using the command.

Usage Notes

You cannot modify the Public and Private-interfaces after the system is deployed.

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 15-85 Updating a Network

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

# odacli update-network -i 192.0.0.2 -w Backup

Parent topic: odacli Network Commands

odacli delete-network

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

File Path

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

Syntax

To delete a network:

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

Parameters

Parameter	Description
`--id`, `-i`	Defines the network identity.
`--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.

Example 15-86 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" : "March 18, 2019 23:14:32 PM EDT",
     "endTime" : "March 18, 2019 23:14:32 PM EDT",
     "status" : "Running",
     "taskDescription" : null,
     "parentTaskId" : "TaskSequential_135",
     "jobId" : "c26d217e-419b-4a91-8680-7b06bcfe9828",
     "tags" : [ ],
     "reportLevel" : "Info",
     "updatedTime" : "March 18, 2019 23:14:32 PM EDT"
   },{     
   "taskId" : "TaskZJsonRpcExt_142",
     "taskName" : "Setting up Network",
     "taskResult" : "Network setup success",
     "startTime" : "March 18, 2019 23:14:32 PM EDT",
     "endTime" : "March 18, 2019 23:14:32 PM EDT",
     "status" : "Success",
     "taskDescription" : null,
     "parentTaskId" : "TaskParallel_141",
     "jobId" : "c26d217e-419b-4a91-8680-7b06bcfe9828",
     "tags" : [ ],
     "reportLevel" : "Info",
     "updatedTime" : "March 18, 2019 23:14:32 PM EDT"   } ],
   "createTimestamp" : "March 18, 2019 23:14:32 PM EDT",
   "description" : "Network service delete",
   "updatedTime" : "March 18, 2019 23:14:32 PM EDT"
 }

Parent topic: odacli Network Commands

odacli describe-networkinterface

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

File Path

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

Syntax

To display the details of a specific network interface:

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

Parameters

Parameter	Description
`--id`, `-i`	Identifies the network interface ID. Use the `odacli list-networks` command to obtain the `id`.
`--json`, `-j`	(Optional) Displays JSON output.
`--help`, `-h`	(Optional) Displays help for using the command.
`--nodeNumber`, `-u`	(Optional) Displays the network interface information for the specified node. By default, the node number is always the first node (Node0).

Usage Notes

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

Example 15-87 Displaying Network Details

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

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

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

Parent topic: odacli Network Commands

odacli list-networkinterfaces

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

File Path

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

Syntax

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

Parameters

Parameter	Description
`--json`, `-j`	(Optional) Displays JSON output.
`--help`, `-h`	(Optional) Displays help for using the command.
`--nodeNumber`, `-u`	(Optional) Displays the network interface information for the specified node. By default, the node number is always the first node (Node0).

Example 15-88 Displaying a List of Network Interfaces

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

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

Parent topic: odacli Network Commands

Log Commands

Use the odacli log commands to specify the options to collect and delete logs.

odaadmcli manage diagcollect
Use the odaadmcli manage diagcollect command to collect diagnostic logs for Oracle Database Appliance components.
odacli list-logspaceusage
Use the odacli list-logspaceusage command to display the log file usage.
odacli create-logcleanjob
Use the odacli create-logcleanjob command to create a job to purge log files for a specified time period.
odacli list-logcleanjobs
Use the odacli list-logcleanjobs command to list the jobs to purge log files.
odacli describe-logcleanjob
Use the odacli describe-logcleanjobcommandto describe a log cleanup job.
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.
odacli list-auto-logclean-policy
Use the odacli list-auto-logclean-policy command to list the jobs to purge log files.

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

$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli

Syntax

To collect diagnostic logs for components:

   odaadmcli manage diagcollect [-h] [--dataMask] [--dataSanitize]

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.

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 15-89 Masking Sensitive Data in Log Collection

# odaadmcli manage diagcollect --dataMask
invoke /opt/oracle/dcs/bin/diagcollector.py
DataMask is set as 1
Datasanitize is set as 0
Current TFA version is:  183000

Parent topic: Log Commands

odacli list-logspaceusage

Use the odacli list-logspaceusage command to display the log file usage.

File Path

$ORACLE_HOME/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 15-90 Displaying a List of Logs

To display log file space usage for a list of components:


odacli list-logspaceusage
Timestamp:  July 25, 2018 7:31:39 PM UTC

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

Component    Size(MB)   Partition            LogUsagePercentage   PartitionFreePercentage

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

dcs    477.00       /dev/mapper/VolGroupSys-LogVolOpt 0.79                 81.00               

gi  1863.68      /dev/mapper/VolGroupSys-LogVolU01 1.85                 86.00

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 15-91 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 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 15-92 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 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 [-h]

Parameters

Parameter	Description
`--help`, `-h`	(Optional) Displays help for using the command.
`--jobid`, `-i`	Displays the summary of the log cleanup with the specified job ID.

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

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

Syntax

To list jobs and view job details and status:

   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 15-94 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 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 15-95 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 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 update-asr
Use the odacli update-asr command to make changes to Oracle Auto Service Request (Oracle ASR) configuration details after deploying the appliance.
odacli describe-asr
Use the odacli describe-asr command to display Oracle Auto Service Request (Oracle ASR) configuration details.
odacli test-asr
Use the odacli test-asr command to test the Oracle Auto Service Request (Oracle ASR) configuration.
odacli delete-asr
Use the odacli delete-asr command to remove the Oracle Auto Service Request (Oracle ASR) configuration from the system.

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

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

Syntax

odacli  configure-asr  -u username -a asrpassword [-r proxyserver] [-t proxyport] 
[-y proxyuser] [-ppwd proxypassword] [-s snmpversion] -i[asrip] -e [internal|external] [-j] [-h]

Parameters

Parameter	Description
`--asrip`, `-i`	(Optional) Identifies the external Oracle ASR Manager IP address.
`--asrpassword`, `-a`	Defines the My Oracle Support password associated with the user name. Use this option to specify the password interactively. When using this option, do not enter the password in the command-line.
`--asrtype`, `-e` {internal \| external}	Defines the Oracle ASR Configuration Type. The default is internal.
`--help`, `-h`	(Optional) Displays help for using the command.
`--json`, `-j`	(Optional) Displays JSON output.
`--proxypassword`, `-ppwd`	(Optional) Defines the proxy user password.
`--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.
`--snmpversion`, `-s` `[V2\|V3]`	(Optional) Defines Simple Network Management Protocol (SNMP) Version 2 or SNMP Version 3. The default is V3.
`--username`, `-u`	Defines the Oracle ASR user name. The user name is the My Oracle Support user name under which the server is registered.

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

Example 15-96 Configuring Oracle ASR with a Proxy Server

This example configures Oracle ASR for user name scott.tiger@example.com. A proxy server, www-proxy.example.com, and port 80 are defined.

# odacli configure-asr -u john.smithl@example.com -a -t 80 -r www-proxy.example.com 
Asr User password:  

Job details 
----------------------------------------------------------------                      
ID: d99559b6-d98d-4cb7-b44d-8577cab26667             
Description: Configure ASR                  
Status: Created                 
Created: August 9, 2016 6:12:19 AM WSST                 
Message:

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

Example 15-97 Configuring an External Oracle ASR

This example configures Oracle Database Appliance to use an external Oracle ASR instance at IP address 10.20.30.40.

# odacli configure-asr --asrip 10.20.30.40 --asrtype External
{
  "jobId" : "ea054a2f-d18d-4253-83bc-b57434e3598e",
  "status" : "Created",
  "message" : "Please run the script '/tmp/activateExternalAssets.pl' on the ASRManager host once the current job is successful.",
  "reports" : [ ],
  "createTimestamp" : "November 20, 2016 22:12:34 PM EST",
  "description" : "Configure ASR",
  "updatedTime" : "November 20, 2016 22:12:34 PM EST"
}

When the job completes successfully, run the /tmp/activateExternalAssets.pl script on the Oracle ASR Manager host.

Parent topic: odacli Oracle Auto Service Request Commands

odacli update-asr

Use the odacli update-asr command to make changes to Oracle Auto Service Request (Oracle ASR) configuration details after deploying the appliance.

File Path

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

Syntax

  update-asr  -u username -a asrpassword [-r proxyserver] [-t proxyport] [-y proxyuser [-ppwd proxypassword] [-s snmpversion] -i[asrip] -e [internal|external] [-j] [-h]

Parameters

Parameter	Description
`--asrip`, `-i`	(Optional) Identifies the external Oracle ASR Manager IP address.
`--asrpassword`, `-a`	Defines the My Oracle Support password associated with the user name. Use this option to specify the password interactively. When using this option, do not enter the password in the command-line.
`--asrtype`, `-e` [internal \| external]	Defines the Oracle ASR Configuration Type. The default is internal.
`--help`, `-h`	(Optional) Displays help for using the command.
`--json`, `-j`	(Optional) Displays JSON output.
`--proxypassword`, `-ppwd`	(Optional) Defines the proxy user password.
`--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.
`--snmpversion`, `-s` `[v2\|v3]`	(Optional) Defines Simple Network Management Protocol (SNMP) Version 2 or SNMP Version 3. The default is v2.
`--username`, `-u`	Defines the Oracle ASR user name. The user name is the My Oracle Support user name under which the server is registered.

Usage Notes

Enter the password during Oracle ASR configuration.
All log files for Oracle ASR are located in the /var/opt/asrmanager/log/ directory.
You cannot use the update-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.
To configure an external Oracle ASR Manager, you must define the Oracle ASR Configuration Type as external (-e external). For example, odacli update-asr -e external -i 198.51.100.1

Example 15-98 Updating Oracle ASR with 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 update-asr -u scott.tiger@example.com --asrpassword --proxyserver www-proxy2.example.com --proxyport 80 
Asr User password:  

Job details
---------------------------------------------------------
ID: 79cb2baa-1644-45c5-a004-a303e3111807 
Description: Update ASR 
Status: Created 
Updated: July 15, 2016 9:53:54 AM PST 
Message:  

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

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

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

Syntax

  describe-asr [-h]

Parameters

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

Example 15-99 Displaying Oracle ASR Details

# odacli describe-asr  

ASR details 
---------------------------------------------------------------- 
ID: e841d74a-687b-4e87-9548-1baa2090d48e 
Name: UserName: scott.tiger@example.com 
ProvyServerName: www-proxy.example.com 
ProxyPort: 80 
ProxyUserName: 
SnmpVersion: V3 
State: N/A 
Created: July 15, 2016 8:53:54 AM PST 
Updated: July 15, 2016 8:53:54 AM PST

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.

File Path

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

Syntax

# odacli test-asr [-h]

Parameters

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

Usage Notes

This command internally invokes the SNMP test trap by invoking /SP/alertmgmt/rules/1 testrule=true.

Example 15-100 Testing the Oracle ASR Configuration

# odacli test-asr

Job details
---------------------------------------------------------------- 
ID: ec6783f4-551d-4686-ab1b-22e2d9e59c98 
Description: Test ASR 
Status: Created 
Created: July 25, 2016 9:03:15 AM SGT 
Message:  

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

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 15-101 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 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 update-osconfigurations
Use the command odacli update-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 15-102 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 update-osconfigurations

Use the command odacli update-osconfigurations to update the HugePage and memlock values.

File Path

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

Syntax

odacli update-osconfigurations [-h] [-hs] [-j] [-m]

Parameters

Parameter	Description
`--help`, `-h`	(Optional) Displays help for using the command.
`--hugespace`, `-hs`	(Optional) Updates the HugePage value.
`--json`, `-j`	(Optional) Displays JSON output. The default is false.
`--memlock`, `-m`	(Optional) Updates the memlock value.

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 update memlock or hugepage. If no option is provided, then both parameters are updated to the suggested values.

Example 15-103 Updating the HugePage and Memlock Parameters to the Suggested Values

odacli update-osconfigurations
{
"jobId" : "954cf7a5-9cad-451c-8820-3140a716af26",
"status" : "Created",
"message" : "Successfully submitted a request to configure OS
parameters.",
"reports" : [ ],
"createTimestamp" : "February 06, 2018 00:03:51 AM MST",
"resourceList" : [ ],
"description" : "Configuring OS Parameter",
"updatedTime" : "February 06, 2018 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: February 6, 2018 12:03:51 AM MST
Message:
Task Name             Start Time                         End Time                          Status
--------------------  --------------------------------   --------------------------------  -------
Setting up memlock.   February 6, 2018 12:03:51 AM MST   February 6, 2018 12:03:51 AM MST  Success
Setting up HugeSpace  February 6, 2018 12:03:51 AM MST   February 6, 2018 12:03:51 AM MST  Success

Parent topic: odacli OS 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: Oracle Database Appliance Command-Line Interface

odaadmcli Hardware Monitoring Commands

Use the hardware monitoring commands to display hardware configurations.

odaadmcli show cooling
Use the odaadmcli show cooling command to show cooling details.
odaadmcli show env_hw
Use the odaadmcli show env_hw command to display information about the environment and hardware.
odaadmcli show fs
Use the odaadmcli show fs command to display filesystem details.
odaadmcli show memory
Use the odaadmcli show memory command to display memory details.
odaadmcli show network
Use the odaadmcli show network command to show network details.
odaadmcli show power
Use the odaadmcli show power command to display power supply details.
odaadmcli show processor
Use the odaadmcli show processor command to display processor details.
odaadmcli show server
Use the odaadmcli show server command to display server details.

Parent topic: Oracle Database Appliance Command-Line Interface

odaadmcli show cooling

Use the odaadmcli show cooling command to show cooling details.

File Path

$ORACLE_HOME/opt/oracle/dcs/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

$ORACLE_HOME/opt/oracle/dcs/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 15-104 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 ODA_Lite X7-2 Medium

Parent topic: odaadmcli Hardware Monitoring Commands

odaadmcli show fs

Use the odaadmcli show fs command to display filesystem details.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli

Syntax

To display filesystem details:

   odaadmcli show fs [-h]

Parameters

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

Example 15-105 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

$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli

Syntax

To show memory details:

   odaadmcli show memory [-h]

Parameters

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

Example 15-106 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

Syntax

$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli

To show network details:

odaadmcli show network [-h]

Parameters

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

Example 15-107 Showing Network Details

# odaadmcli show network
NAME             HEALTH	HEALTH_DETAILS LOCATION PART_NO  MANUFACTURER  	
Ethernet_NIC_0   OK      -              NET0    X540      INTEL
Ethernet_NIC_1   OK      -              NET1    X540      INTEL
Ethernet_NIC_2   -       -              NET2    X540      INTEL
Ethernet_NIC_3   -       -              NET3    X540      INTEL

(Continued)
MAC_ADDRESS         LINK_DETECTED   DIE_TEMP
00:10:e0:95:98:ec   yes (em1)       61.250 degree C
00:10:e0:95:98:ed   yes (em2)       61.250 degree C
90:e2:ba:ae:1e:ad   no (em4)        -
90:e2:ba:ae:1e:ac   no (em3)        -

Parent topic: odaadmcli Hardware Monitoring Commands

odaadmcli show power

Use the odaadmcli show power command to display power supply details.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli

Syntax

Run this command on the master 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 15-108 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

$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli

Syntax

To show processor details:

odaadmcli show processor  [-h]

Parameters

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

Example 15-109 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

$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli

Syntax

To show server details:

   odaadmcli show server [-h]

Parameters

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

Example 15-110 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

odaadmcli Storage Commands

Use the odaadmcli storage commands to perform storage diagnostics.

odaadmcli expand storage
Use the odaadmcli expand storage command to expand storage.
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 controller
Use the odaadmcli show controller command to display details of the controller.
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.
odaadmcli power disk
Use the odaadmcli power disk command to power a disk on or off.

Parent topic: Oracle Database Appliance Command-Line Interface

odaadmcli expand storage

Use the odaadmcli expand storage command to expand storage.

File Path

$ORACLE_HOME/opt/oracle/dcs/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 X7-2S and X7-2M 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 master 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: odaadmcli 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

$ORACLE_HOME/opt/oracle/dcs/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 15-111 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 15-112 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: odaadmcli Storage Commands

odaadmcli show diskgroup

Use the odaadmcli show diskgroup command to list configured diskgroups or display a specific diskgroup configuration.

File Path

$ORACLE_HOME/opt/oracle/dcs/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 15-113 Listing All Diskgroups

To list all diskgroups:

# odaadmcli show diskgroup 

DiskGroups
---------- 
DATA
RECO

Example 15-114 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: odaadmcli Storage Commands

odaadmcli show controller

Use the odaadmcli show controller command to display details of the controller.

File Path

$ORACLE_HOME/opt/oracle/dcs/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 15-115 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: odaadmcli Storage Commands

odaadmcli show raidsyncstatus

Use the odaadmcli show raidsyncstatus command to display the RAID SYNC status.

File Path

$ORACLE_HOME/opt/oracle/dcs/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 15-116 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: odaadmcli Storage Commands

odaadmcli show storage

Use the odaadmcli show storage command to show the storage controllers, expanders, and disks.

File Path

$ORACLE_HOME/opt/oracle/dcs/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 15-117 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: odaadmcli Storage Commands

odaadmcli stordiag

Use the odaadmcli stordiag command to collect detailed information for each disk or NVMe.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli

Syntax

To collect storage diagnostics for disks and NVM Express (NVMe):

   odaadmcli stordiag n [-h]

Parameters

Parameter	Description
`-n` disk_name	Defines the disk resource name. The resource name format is `pd_[0..3]`.
`--help`, `-h`	(Optional) Displays help for using the command.

Example 15-118 Displaying NVMe Details

To display detailed information for NVMe pd_00:

# odaadmcli stordiag pd_00

Parent topic: odaadmcli Storage Commands

odaadmcli power disk

Use the odaadmcli power disk command to power a disk on or off.

File Path

$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli

Syntax

To power a 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 15-119 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 15-120 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: odaadmcli Storage Commands

Parameter	Description
`--password`, `-p`	Agent password. The Agent password is needed to access the Oracle Appliance Manager Web Console.
`--username`, `-u`	User name required to access the Oracle Appliance Manager Web Console. The default user name is `oda-admin`.
`--json`, `-j`	(Optional) Displays JSON output.
`--help`, `-h`	(Optional) Displays help for using the command.