16 Oracle Database Appliance Command-Line Interface

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

About Oracle Database Appliance Command-Line Interface

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

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

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

The following classes of commands are available:

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

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

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

You can perform the following deployment and configuration tasks:

  • Configure the first network in the appliance

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

  • Set the number of CPU Cores for the system

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

  • Create and describe the appliance

  • Create, list, describe, and delete databases

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

  • Create, list, and describe the networks

  • List and describe the jobs

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

  • Show storage, disks, diskgroups, and controllers

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

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

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

Command-Line Interface Syntax

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

An odacli or odaadmclicommand uses the following command syntax:

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

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

Example 16-1 Command-Line Interface Syntax

# odacli create-database -h 

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

Oracle Database Appliance Manager Command-Line Interface Help

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

odacli -h

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

odacli describe-dbhome -h

Managing ODACLI Privileges and Security with SUDO

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

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

Allowing Root User Access Using SUDO

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

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

Caution:

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

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

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

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

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

Note:

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

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

odacli create-database --dbname newdb -m
Password for SYS,SYSTEM and PDB Admin: 

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

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

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

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

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

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

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

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

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

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

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

odacli Network Commands

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

odacli configure-firstnet

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Usage Notes

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

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

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

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

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

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

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

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

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

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

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

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

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

odacli create-network

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description

--defaultnetwork, -d

Identifies the default network.

--gateway, -g

Defines the network gateway. The gateway is required for the default network.

--help, -h

(Optional) Displays help for using the command.

--interface, -n        

Defines the name of the network interface.

--interfacetype, -t

Defines the network interface type {BOND|PHYSICAL|VLAN|INTERNAL} (non case-sensitive).

--ipaddress, -p Defines the network IP address. This can be specified in the format IPAddress or nodeNumber0:IPAddress0,nodeNumber1:IPAddress1,...

--json, -j

(Optional) Displays JSON output.

--networktype, -w

Defines the type of network. Options are: {Public|Dataguard|Database|Management|Backup|Other}. The default is Other.

--name, -m Name of the network.

--no-defaultnetwork, no–d

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

--subnetmask, -s

Defines the Network Subnet Mask.

--scanips, -sip Defines the SCAN IP addresses (in the format scanip0,scanip1,...)
--scanname, -sn Defines the SCAN name.
--nodeNumber, -u Defines the node number for High-Availability deployments. Note: This option is deprecated and will be desupported in a future release.
--vips, -vs List of virtual IP addresses. They can be specified in the format vipname0:nodeNumber0:vip0,vipname1:nodenumber1:vip1,...

--vlanid, -v

Add VLAN as a new network. This option is available for for High-Availability deployments.

Usage Notes

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

Example 16-6 Creating a Network

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

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

Example 16-7 Creating a VLAN Network

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

odacli delete-network

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To delete a network:

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

Parameters

Parameter Description

--id, -i

Defines the network identity.

--name, -m Specifies the network name.

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

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

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

Example 16-8 Deleting a Network

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

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

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

odacli delete-networkinterface

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To delete a network interface:

odacli  delete-networkinterface id [-h]

Parameters

Parameter Description

-id

Defines the network interface name.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

You cannot delete the network interface card in slot 7.

Example 16-9 Deleting a Network Interface

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

Example 16-10 Deleting btbond1 Network Interface is Not Allowed

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

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

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

odacli describe-network

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To display the details of a specific network:

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

Parameters

Parameter Description

--id, -i

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

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--name, -m Specifies the network name.

--nodeNumber, -u

(Optional) Displays the network interface information for the specified node. Note: This option is deprecated and will be desupported in a future release.

Example 16-12 Displaying Network Details

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

# odacli describe-network -m Public-network

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

Example 16-13 Displaying Network Details

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

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

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

odacli describe-networkinterface

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To display the details of a specific network interface:

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

Parameters

Parameter Description

--id, -i

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

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--nodeNumber, -u

(Optional) Displays the network interface information for the specified node. Note: This option is deprecated and will be desupported in a future release.

Usage Notes

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

Example 16-14 Displaying Network Details

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

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

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

odacli list-networks

Use the odacli list-networks command to display networks.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--nodeNumber, -u

(Optional) Displays the network interface information for the specified node. Note: This option is deprecated and will be desupported in a future release.

Example 16-15 Displaying a List of Networks

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

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

odacli list-networkinterfaces

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--nodeNumber, -u

(Optional) Displays the network interface information for the specified node. Note: This option is deprecated and will be desupported in a future release.

Example 16-16 Displaying a List of Network Interfaces

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

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

odacli update-network

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

File Path

$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] [-sip] [-sn] [-vs]
[-j] [-h]

Parameters

Parameter Description

--id, -i

Defines the network identity.

--gateway, -g

(Optional) Defines the network gateway.

--ipaddress, -p

(Optional) Defines the network IP address. This can be specified in the format IPAddress or nodeNumber0:IPAddress0,nodeNumber1:IPAddress1,...

--json, -j

(Optional) Displays JSON output.

--networktype, -w [Public|Dataguard|Backup|Other]

(Optional) Defines the type of network.

--scanips, -sip Defines the SCAN IP addresses (in the format scanip0,scanip1,...)
--scanname, -sn Defines the SCAN name.

--subnetmask, -s

(Optional) Defines the Network Subnet Mask.

--vips, -vs List of virtual IP addresses. They can be specified in the format vipname0:nodeNumber0:vip0,vipname1:nodenumber1:vip1,...

--help,-h

(Optional) Displays help for using the command.

Usage Notes

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

Example 16-17 Updating a Network

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

# odacli update-network -i 192.0.0.2 -w Backup

odacli Apply Patch and Update Commands

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

odacli cleanup-patchrepo

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

File Path

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

Syntax

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

Parameters

Parameter Description

--clones, -cl

Specifies the option to clean up clone files (DB and GI) from the repository /opt/oracle/oak/pkgrepos/orapkgs/clones/.

--version, -v

Defines the Oracle Database Appliance release you want to delete.

For example, 12.2.1.4.0.

--component, -comp

A comma-separated list of components as {DB,GI} to cleanup for a specific Oracle Database Appliance patch version. The default is both {DB,GI}.

--local, -l

(Optional) Cleans up the repository on the local node.

--node, -n

(Optional) Cleans up the repository on the specified nodes.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Usage Notes

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

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

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

Example 16-19 Deleting Clone Files

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

odacli create-prepatchreport

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

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description
--dbhome, –d

(Optional) Specifies the database home component for running the pre-checks.

--dbhomeid, –i

(Optional) Specifies the IDs of the database homes for running the pre-checks.

--files, -f

(Optional) Specifies files required to update repository, comma-separated if multiple files are required.

--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--local, -l

(Optional) Runs patch pre-checks only on the local node.

--operating-system, -os

(Optional) Specifies the operating system components. Use this option to run operating system upgrade. If you specify -c, then the only option is os. If you specify -c os, then you can also specify -local (optional).

--node, –n

(Optional) Runs patch pre-checks on specified nodes.

--repo, –r

(Optional) Specify this option to run the patch pre-checks for the repository components.

--server, –s

(Optional) Specify this option to run the patch pre-checks for the server components.

--storage, –st

(Optional) Specify this option to run the patch pre-checks for the storage components.

--version, –v

(Optional) Specifies the version for running the pre-checks.

--skip-orachk, –sko

(Optional) Specifies whether you want to skip ORAchk validations.

Usage Notes

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

Example 16-20 Creating Pre-Check Report

# odacli create-prepatchreport -v 19.8.0.0.0 -s

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

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

odacli delete-agentconfig-parameters

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli delete-agentconfig-parameters

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--name, -n

Specifies the name of the parameter.

--type, -t

(Optional) Deletes the configuration value for the given type. The default value is PUBLIC.

Usage Notes

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

Example 16-21 Deleting configuration parameters

# odacli delete-agentconfig-parameters -n HttpProxyHost

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

odacli delete-prepatchreport

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli delete-prepatchreport -i Report ID

Parameters

Parameter Description

Report ID

Describes the ID of the report to be deleted.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

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

Example 16-22 Deleting A Patch Pre-Checks Report

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

odacli describe-component

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

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description
--dbhomes, –d

(Optional) Lists the database home versions and available versions.

--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--local, -l

(Optional) Describes the components for the local node. Use to display details on the local node of multi-node high availability (HA) systems. This option is not needed to display component details on single-node systems.

--node, –n

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

--server, –s

(Optional) Lists the server components and versions and the available versions to which you can patch them.

--systemversion, –v (Optional) Displays only the system version. This option is available only on high-availability systems.

Usage Notes

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

Example 16-23 Displaying Patch Details for Components for High-Availability Oracle Database Appliance Systems for a Release

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

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

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

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

GI                                        18.8.0.0.191015       up-to-date

DB                                        18.8.0.0.191015       up-to-date

DCSAGENT                                  18.8.0.0.0            up-to-date

ILOM                                      4.0.4.41.r130359      up-to-date

BIOS                                      25080100              up-to-date

OS                                        6.10                  up-to-date

FIRMWARECONTROLLER                        11.05.03.00           up-to-date

FIRMWAREEXPANDER                          0018                  001e

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

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

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

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

GI                                        18.8.0.0.191015       up-to-date

DB                                        18.8.0.0.191015       up-to-date

DCSAGENT                                  18.8.0.0.0            up-to-date

ILOM                                      4.0.2.27.b.r125869    4.0.4.41.r130359

BIOS                                      25060400              25080100

OS                                        6.10                  up-to-date

FIRMWARECONTROLLER                        11.05.03.00           up-to-date

FIRMWAREEXPANDER                          0018                  001e

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

Example 16-24 List DB Home Details

# odacli describe-component -d

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

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

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

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

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

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

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

Example 16-25 List the Server Components and Versions

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

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

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

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

GI                                        18.7.0.0.190716       up-to-date

ILOM                                      4.0.4.38.r130206      up-to-date

BIOS                                      52010400              up-to-date

OS                                        6.10                  up-to-date

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

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

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

GI                                        18.7.0.0.190716       up-to-date

ILOM                                      4.0.4.38.r130206      up-to-date

BIOS                                      52010400              up-to-date

OS                                        6.10                  up-to-date

odacli describe-latestpatch

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

File Path

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

Syntax

odacli describe-latestpatch [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--json, -j

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

Example 16-26 Listing the Latest Supported Versions

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

odacli 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 16-27 Displaying the Patch Pre-Checks Report


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

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

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

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

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

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

Example 16-28 Example of a Successful Patch Pre-Checks Report

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

odacli list-agentconfig-parameters

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--name, -n

Specifies the name of the parameter.

--type, -t

(Optional) Specifies the configuration value for the given type. The default value is PUBLIC.

Usage Notes

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

Example 16-29 Displaying the HttpProxyPort


./odacli list-agentconfig-parameters -n HttpProxyPort

Name      Value      Description      Updated                            
------------------------------------------------------
HttpProxyPort  Http proxy server port    May 18, 2020 4:14:10 AM UTC       

Example 16-30 Displaying the agent configuration


# odacli list-agentconfig-parameters

Name          Value     Description   Updated                            
------------------------------ ----------------------------------------------------------------- 
HttpProxyHost   Http proxy server host  May 18, 2020 4:14:10 AM UTC       
HttpProxyPort   Http proxy server port   May 18, 2020 4:14:10 AM UTC       
HttpsProxyHost   Https proxy server host  May 18, 2020 4:14:10 AM UTC       
HttpsProxyPort  Https proxy server port  May 18, 2020 4:14:10 AM UTC         

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

odacli list-prepatchreports

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

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--json, -j

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

Usage Notes

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

Example 16-32 Displaying All Patch Pre-Checks Reports

# odacli list-prepatchreports 
ID   Description  Created                             Status    

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

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

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

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

odacli update-agentconfig-parameters

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli update-agentconfig-parameters

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--append, -a

(Optional) Appends the parameter values. For example, -n p1 -v v1 -n p2 -v v2 -a.

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

--update, -u

Replaces the parameter with the specified value. For example: -n p1 -v v1 -n p2 -v v2 -u.

--value, -v

Specifies the value of the parameter. Provide multiple parameter values in the format -n p1 -v v1 -n p2 -v v2.

--type, -t

(Optiona) Specifies the type of the parameter. The default is PUBLIC.

Usage Notes

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

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

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

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 16-34 Updating an Oracle Database Home

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

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

odacli update-dcsadmin

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

File Path

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

Syntax

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

Parameters

Parameter Description

--version, -v

Defines the Oracle Database Appliance version after update.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Usage Notes

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

Example 16-35 Updating DCS Admin


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

odacli update-dcsagent

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

File Path

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

Syntax

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

Parameters

Parameter Description

--version, -v

Defines the Oracle Database Appliance version after update.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Usage Notes

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

Note:

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

Example 16-36 Updating the Agent

To update the dcs-agent to version 19.8:


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

odacli update-dcscomponents

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

File Path

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

Syntax

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

Parameters

Parameter Description

--version, -v

Defines the Oracle Database Appliance version after update.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Usage Notes

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

Example 16-37 Updating DCS Components


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

odacli update-registry

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

File Path

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

Syntax

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

Parameters

Parameter Description

--component, -n

Defines the Oracle Database Appliance component for the registry update. The values can be system {gihome, dbnode, sysinstance} or all {dbhome, db, dbstorage, asr}. You can also specify the individual component to be refreshed.

Note: Refresh system components before you refresh all components.

-f

(Optional) Forces the refresh of the specified component even if it already exists in the appliance registry metadata.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Usage Notes

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

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

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

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

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

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

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

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

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

odacli update-repository

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

Prerequisites

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

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

Parameters

Parameter Description

--filename, –f

Defines the zip filename of patch bundle or RDBMS clones downloaded from My Oracle Support. Provide a comma-separated list of absolute file paths of the end user and patch bundles.

--json, -j

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

--help,-h

(Optional) Displays help for using the command.

Usage Notes

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

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

Example 16-39 Updating the Repository

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

# /opt/oracle/dcs/bin/odacli update-repository -f /tmp/oda-sm-19.8.0.0.0-200718-server1of2.zip,/tmp/oda-sm-19.8.0.0.0-200718-server2of2.zip
{
  "jobId" : "d3510276-da05-447b-990e-6d30964f8f79",
  "status" : "Created",
  "message" : "/u01/tmpdir/oda-sm-12.2.1.1.0-171031-server.zip",
  "reports" : [ ],
  "createTimestamp" : "May 18, 2020 14:13:45 AM CST",
  "description" : "Repository Update",
  "updatedTime" : "May 18, 2020 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   May 18, 2020 14:19:05 AM CST    Success 

odacli update-server

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli update-server  -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 16-40 Updating the Server

Run the odacli update-server command to update the server to 19.8.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 19.8.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" : "May 18, 2020 14:13:45 PM CST",
  "resourceList" : [ ],
  "description" : "Server Patching",
  "updatedTime" : "May 18, 2020 14:13:45 PM CST"
} 

odacli update-storage

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description
--version, –v

Defines the version to update.

--json, -j

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

--help, -h

(Optional) Displays help for using the command.

--rolling, -r

(Optional) Enables to patch shared disks in rolling fashion without stopping Oracle Clusterware. The shared disks must be online.

Usage Notes

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

Example 16-41 Updating the Storage

# odacli update-storage -v 19.8.0.0.0

odaadmcli orachk

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

File Path

/opt/oracle/dcs/bin/odaadmcli

Syntax

To perform diagnostic checks of components:

   odaadmcli orachk [-h]  

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Components such as -a, -acchk, -applypatch, -autostop

(Optional) Specifies the comma-separated list of components for which you want to collect data. Specify the component to be checked in the command. For example:

# odaadmcli orachk -a

--verbose

Displays detailed message.

Usage Notes

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

Example 16-42 Running odaadmcli orachk

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

Example 16-43 Running odaadmcli orachk for a component

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

odacli Appliance Commands

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

odacli-adm set-credential

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

Syntax

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

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

Parameters

Parameter Description

--password, -p

Agent password. The Agent password is needed to access the Oracle Appliance Manager Browser User Interface.

--username, -u

User name required to access the Oracle Appliance Manager Browser User Interface. The default user name is oda-admin.

--json, -j

 

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

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

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

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

# odacli-adm set-credential --password --username oda-admin
  Agent password: password

odacli create-appliance

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

File Path

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

Syntax

To view help for the odacli create-appliance command:

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

Note:

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

Parameters

Parameter Description

--requestjson, -r

JSON input for appliance creation.

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

odacli describe-system

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

File Path

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

Syntax

To list jobs and view job details and status:

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

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--bom, -b

(Optional) Displays the bill of materials for the installed components on the appliance.

--details, -d

(Optional) Display on the command-line, the details of all installed components on the appliance.

Usage Notes

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

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

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

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

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

odacli list-featuretracking

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

File Path

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

Syntax

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

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

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

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


# odacli list-featuretracking
                                    DCS Feature Tracking Report

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

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

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


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

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

odacli Backup and Recovery Commands

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

Topics:

odacli create-backup

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli  create-backup -i Database Resource ID [-bt] [-c] [-h] [-j] [-k] [-t] [-ka]

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. The supported option is Database. The option is not case-sensitive.

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

--keep-archivelog, -ka

(Optional) Keep archive logs. The default is false.

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 16-47 Create a Manual Database Backup

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

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

Example 16-48 Create a Level 0 Database Backup

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

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

odacli create-backupconfig

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description
--backupconfigtype, -bct

Defines the Backup Config type. The values can be System or Database. The options are not case sensitive. The default is Database.

--backupdestination, –d {Disk|ObjectStore|NFS|None}

Defines the backup destination. The options are not case sensitive.

--compression-algo, –ca{BASIC|LOW|MEDIUM|HIGH}

Defines the Compression Algorithm that RMAN must use. The default is BASIC for Disk and NFS backup and MEDIUM for ObjectStore backup.

--container, -c

(Optional) Defines the object store container. This is the object store container name or absolute path to the parent directory for NFS destination for backups.

--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. The length must not exceed 30 characters. The name must be wrapped in single quotes when it starts with a special character.

--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. Applicable to Database type backup config.

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 16-49 Create a Backup Configuration for disk

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

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

Example 16-50 Create a Backup Configuration for NFS location

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

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

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

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

odacli create-objectstoreswift

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description
--endpointurl, –e

Defines the swift end point URL.

--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--name, -n

Defines the Object Store Swift name.

--tenantname, -t

Defines the Object Store Swift tenant name.

--username, -u

Defines the Object Store Swift user name.

Usage Notes

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

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

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 Browser User Interface or use the command odacli list-databases.

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

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

Example 16-53 Delete a Long Term Backup Report

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

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

odacli delete-backupconfig

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

File Path

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

Syntax

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

Parameters

Parameter Description
--help, -h

(Optional) Displays help for using the command.

--id, -i

Defines the Backup Config identifier (ID).

--json, -j

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

Usage Notes

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

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

odacli describe-backupreport

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

File Path

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

Syntax

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

Parameters

Parameter Description
--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--id, -i

Defines the backup report ID.

Example 16-55 Display Details of a Specific Backup Report

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

odacli delete-objectstoreswift

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

File Path

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

Syntax

# odacli  delete-objectstoreswift [-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 16-56 Deleting the Oracle Object Store Credentials

# odacli  delete-objectstoreswift -i Object Store Swift id 

 odacli describe-schedule

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

File Path

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

Syntax

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

Parameters

Parameter Description
--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--scheduleid, -id

Defines the schedule with an identifier (ID).

Example 16-57 Display Schedule Details

#  odacli  describe-schedule -i scheduleid 

odacli irestore-database

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

 odacli irestore-database [-bp] [-r] [-cl] [-nn] [-co] [-s] [-ro] [-dr] [-y] [-h] [-j] [-c] [-oid] [-tf] [-bl] [-rDBID] [-sh|-no-sh]

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

--dbEdition, -de

(Optional) Defines the Oracle Database Edition.

--databaseHome, -dh

(Optional) Defines the database home.

--dbName, -n

(Optional) Defines the database name.

--dbUniqueName, -u

(Optional) Defines the database unique name.

--dbDomainName, -dn

Defines the database domain name.

--dbrole, -ro

Defines the database role for Oracle Data Guard operations. The options are PRIMARY|STANDBY.

--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--noOfRmanChannels, -c

(Optional) Defines the number of RMAN channels (parallelism) Default: SE Edition: 1, Other Enterprise Editions: 5 

--objectStoreId, -oid

Defines the Swift Object Store credential ID.

--objectStoreName, -on

Defines the Swift Object Store resource name.

--backuplocation, -bl

(Optional) Specifies the NFS or local directory path where backups are available.

--dbRedundancy, -rd

Specifies the database redundancy value, that is, {HIGH|MIRROR}. To specify the dbRedundancy option for an Oracle ASM or ACFS storage-based database, at least one disk group of FLEX redundancy must exist. To specify the dbRedundancy option for an Oracle ASM storage database, the dbVersion or dbHomeVersion must be 12.2 or later.

The precedence logic for setting the dbRedundancy is:

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

  2. dbRedundancy in the backup report.

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

--resetDBID,-rDBID

Resets the DB ID. The default is TRUE.

--associated-networks, -nn

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

--disable-seha, -no-sh

Specifies whether you want to disable Standard Edition High-Availability for Oracle Database Standard Edition 19c and later single-instance databases.

--enable-seha, -sh

Specifies whether you want to enable Standard Edition High-Availability for Oracle Database Standard Edition 19c and later single-instance databases.

--dbOnFlashStorage, -f

(Optional) Specifies whether to enable data on Flash storage.

--no-dbOnFlashStorage, -no-f

(Optional) Specifies whether to disable data on Flash storage.

Usage Notes

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

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

Example 16-58 Restoring a Database to the Same System

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

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

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

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

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

odacli list-backupconfigs

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description
--help, -h

(Optional) Displays help for using the command.

--json, -j

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

Example 16-61 Displaying a List of Backup Configuration

Display a list of backup configurations.

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

odacli list-backupreports

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

File Path

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

Syntax

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

Parameters

Parameter Description
--help, -h

(Optional) Displays help for using the command.

--json, -j

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

Usage Notes

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

Example 16-62 Display a List of all Backup Reports

#  odacli  list-backupreports 

odacli list-objectstoreswifts

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

File Path

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

Syntax

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

Parameters

Parameter Description
--help, -h

(Optional) Displays help for using the command.

--json, -j

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

Example 16-63 Displaying a List of ObjectStore Swift Credentials

# odacli list-objectstoreswifts 

 odacli list-schedules

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

File Path

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

Syntax

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

Parameters

Parameter Description
--help, -h

(Optional) Displays help for using the command.

--json, -j

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

Usage Notes

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

Example 16-64 Display a List of Scheduled Database Backups

Display a list of all scheduled database backups and details.

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

odacli recover-database

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

  odacli  recover-database -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 16-65 Recovering a Database to a Point-in-Time

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

Example 16-66 Recovering a Database to the latest

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

Example 16-67 Recovering a Database to an SCN

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

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 [-i] [-in] [-ca] -d backup destination{Disk|ObjectStore|None} [-c] [-cr] [-h] [-j] [-no-cr] [-o][-w]

Parameters

Parameter Description
--backupconfigid, -i

Defines the Backup Config ID.

--backupconfigname, -in

Defines the Backup Config name.

--backupdestination, –d{Disk|ObjectStore|None}

Defines the backup destination. The options are not case sensitive. Applicable to System type backup config.

--compression-algo, –ca{BASIC|LOW|MEDIUM|HIGH}

Defines the Compression Algorithm that RMAN must use. The default is BASIC for Disk and NFS backup and MEDIUM for ObjectStore backup.

--container, -c

(Optional) Defines the object store container or absolute path to the parent directory of NFS destination for backups.

--crosscheck, -cr

(Optional) Enable Crosscheck. Applicable to Database type backup config.

--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--name, -n

Defines the backup configuration name.

--no-crosscheck, -no-cr

(Optional) Disable crosscheck.

--objectstoreswiftId, -o

(Optional) Defines the swift object store credential ID.

--recoverywindow, -w

Disk: {1-14}

ObjectStore: {1-30}

(Optional) Defines the Recovery Window in days. {1-14} days for Disk and {1-30} days for Object store. Applicable to Database type backup config.

Usage Notes

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

    • Disk: 1-14 days

    • ObjectStore in Casper: 1-30 days

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

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 16-69 Changing the Oracle Casper ObjectStore Password

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

Example 16-70 Changing the Oracle ObjectStore User Name

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

 odacli update-schedule

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

File Path

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

Syntax

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

Parameters

Parameter Description
--cronExpression, -x

(Optional) Defines the date and time for the update.

--description, -t

(Optional) Provides a description for the update schedule.

--disable, -d

(Optional) Disables the schedule.

--enable, -e

(Optional) Enables a disabled schedule.

--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--scheduleid, -id

Defines the schedule with an identifier (ID).

Usage Notes

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

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

Example 16-71 Change What Time the Backup Occurs

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

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

Example 16-72 Disable Scheduled Database Backups

#  odacli  update-schedule -i scheduleid  -d

Oracle Data Guard odacli Commands

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

 odacli configure-dataguard

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description
--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--requestjson, -r

(Optional) Specifies the JSON file for creating the appliance.

--skip-password-copy, -s

(Optional) Specifies that step to copy the password from primary database to standby database can be skipped.

Usage Notes

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

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

# odacli configure-dataguard
Standby site address: test_domain
BUI username for Standby site (default: oda-admin): 
BUI password for Standby site: 
TrustStore path for Standby DCS server (copy from /opt/oracle/dcs/dcscli/cacerts on Standby site to this machine and set file permissions to 400): /cacerts.a
TrustStore password for Standby DCS server: 
Database name for Data Guard configuration: test1
Primary site network for Data Guard configuration [vlan162, Public-network] (default: vlan162): 
Standby site network for Data Guard configuration [Public-network] (default: Public-network):
Transport type [ASYNC, FASTSYNC, SYNC] (default: ASYNC): 
Primary machine listener port (default: 1521): 
Primary database syspassword: 
Standby machine listener port (default: 1521): 
Standby database syspassword: 
Data Guard configuration name (default: test1_test2): 
Data Guard protection mode [MAX_PROTECTION, MAX_PERFORMANCE, MAX_AVAILABILITY] (default: MAX_PERFORMANCE):
Enable Active Data Guard? (Y/N, default:N): N
The TrustStore of the Standby site should be removed unless it is necessary for some other purpose. Do you want to delete it? (Y/N, default:Y): n
As a requirement, Standby database’s SYS password will be set to Primary database’s after Data Guard configuration. Are you sure you want to proceed? (Y/N): y
Data Guard configuration for database 'test' started
*******************************************************************************************
Step 1: Validate Data Guard configuration request (Primary site)
Description: Validate DG Config Creation
Job ID: a7053469-1bbe-4fb9-b559-5a3a0d976d7c
Started
Validate create Data Guard configuration request
Finished
*******************************************************************************************
Step 2: Validate Data Guard configuration request (Standby site)
Description: Validate DG Config Creation
Job ID: e240ec9a-c9bb-472a-9b26-2549c0b1d0b9
Started
Validate create Data Guard configuration request
Finished
*******************************************************************************************
Step 3: Download password file from Primary database (Primary site)
Description: Download orapwd file from Primary database
Started
Prepare orapwd file for Primary database test1
Finished
*******************************************************************************************
Step 4: Upload password file to Standby database (Standby site)
Description: Upload orapwd file to Standby database
Started
Write orapwd file to Standby database test1
Finished
*******************************************************************************************
Step 5: Configure Primary database (Primary site)
Description: DG Config service creation - ConfigurePrimary
Job ID: 8e3ccee3-4ee0-4c78-be9f-7c5a991ca680
Started
Configure host DNS on primary env
Configure Data Guard Tns on primary env
Enable Data Guard related Db parameters for primary env
Enable force logging and archivelog mode in primary env
Enable FlashBack
Configure network parameters for local listener on primary env
Restart listener on primary env
Create services for primary db
Finished
*******************************************************************************************
Step 6: Configure Standby database (Standby site)
Description: DG Config service creation - ConfigureStandby
Job ID: 55520496-24d8-4c6f-8b67-3ff59a86a79a
Started
Configure Data Guard Tns on standby env
Configure host DNS on standby env
Clear Data Guard related Db parameters for standby env
Enable Data Guard related Db parameters for standby env
Enable force logging and archivelog mode in standby env
Populate standby database metadata
Configure network parameters for local listener on standby env
Reset Db sizing and hidden parameters for ODA best practice
Create services for standby db
Finished
*******************************************************************************************
Step 7: Configure and enable Data Guard (Primary site)
Description: DG Config service creation - ConfigureDg
Job ID: c79dea2d-3d2f-4179-bbe2-aee254d5ec32
Started
Config and enable Data Guard
Post check Data Guard configuration
Finished
*******************************************************************************************
Step 8: Enable Flashback (Standby machine)
Description: DG Config service creation - EnableFlashback
Job ID: 8220286f-e6d6-4a37-a886-ae9af7c29a6e
Started
Enable FlashBack
Finished
*******************************************************************************************
Step 9: Enable Active Data Guard (Standby machine)
Description: DG Config service creation - EnableActivedg
Job ID: 3117c046-2d71-453d-9950-c85bed19f5f2
Started
Open standby db
Restart standby db
Finished
*******************************************************************************************
Step 10: Create Data Guard status (Primary site)
Description: DG Status service creation - NewDgconfig
Job ID: 6fb707c5-5f9f-41ab-bc89-7da5e3f3996c
Started
Create Data Guard status
Finished
*******************************************************************************************
Step 11: Create Data Guard status (Standby site)
Description: DG Status service creation - NewDgconfig
Job ID: d47aad99-0e64-40aa-bffd-6f76ec00555d
Started
Create Data Guard status
Finished
*******************************************************************************************
Configure Data Guard test1_test2 completed
*******************************************************************************************

Example 16-74 Configuring Oracle Data Guard using JSON file

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

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

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

 odacli deconfigure-dataguard

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description
--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--dgconfigid, -i

Specifies the Oracle Data Guard Configuration ID.

Usage Notes

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

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

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

 odacli describe-dataguardstatus

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description
--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--dgid, -i

Specifies the Oracle Data Guard Status ID.

Usage Notes

Example 16-77 Viewing Oracle Data Guard configuration status

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

 odacli failover-dataguard

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description
--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--dgid, -i

Specifies the Oracle Data Guard Status ID.

--databaseUniqueName, -u

Specifies the unique name of the database to failover to.

Usage Notes

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

Example 16-78 Performing Failover Oracle Data Guard

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

 odacli list-dataguardstatus

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description
--help, -h

(Optional) Displays help for using the command.

--json, -j

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

Usage Notes

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

# odacli list-dataguardstatus

 odacli reinstate-dataguard

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description
--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--dgid, -i

Specifies the Oracle Data Guard Status ID.

--databaseUniqueName, -u

(Optional) Specifies the unique name of the database to reinstate.

Usage Notes

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

Example 16-80 Performing reinstate operation on Oracle Data Guard

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

 odacli switchover-dataguard

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description
--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--dgid, -i

Specifies the Oracle Data Guard Status ID.

--databaseUniqueName, -u

(Optional) Specifies the unique name of the database to switchover to.

Usage Notes

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

Example 16-81 Switching over Oracle Data Guard

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

odacli CPU Core Commands

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

odacli list-cpucores

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

File Path

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

Syntax

odacli list-cpucores  [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example 16-82 Displaying a List of Cores

# odacli list-cpucores  

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

odacli describe-cpucore

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

 odacli describe-cpucore  [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example 16-83 Displaying the Current Core Configuration

# odacli describe-cpucore  

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

update-cpucore

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

 odacli update-cpucore  -c cores [-h]

Parameters

Parameter Description

--cores, -c

Defines the number of cores to be enabled in the system.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

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

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

Example 16-84 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
}

odacli Database Commands

Use the odacli database commands to perform database lifecycle operations.

odacli clone-database

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

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, -t [SI]

Defines the database type. The default database type is the source database type, if the option is not specified.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

--sourcedbname, -f

Specifies the name of the source database

--syspassword, -m

Specifies the password for SYS user.

--associated-networks, -nn

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

--disable-seha, -no-sh

Specifies whether you want to disable Standard Edition High-Availability for Oracle Database Standard Edition 19c and later single-instance databases.

--enable-seha, -sh

Specifies whether you want to enable Standard Edition High-Availability for Oracle Database Standard Edition 19c and later single-instance databases.

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 16-85 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 -m password

odacli create-database

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description

--backupconfigid, -bi

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

--cdb, -c

(Optional) Creates the database as a container database. Use the -c flag to create a container database and use the -no-c flag to create a non-CDB database. The default is -no-c.

--characterset, -cs

Defines the character set. The default is AL32UTF8.

--databaseUniqueName, -u

(Optional) Defines a unique name for the database.

--dbdomainname, -dn

Defines the database domain name.

--dbEdition, -de

Defines the Database Edition.

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

Defines the database class. The default is OLTP. The options are as follows:

  • Enterprise Edition: OLTP, DSS, or IMDB.

  • Standard Edition: OLTP

--dbconsole, -co

(Optional) Enables the Database Console. Use the -no-co flag to disable the Database Console. If not selected, the default is no database console.

--dbhomeid, -dh

(Optional) Identifies the existing Database Home ID.

--dblanguage, -l

Defines the database language. The default language is AMERICAN.

--dbname, -n

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

--dbshape, -s

Identifies the database shape (template) and determines the total memory allocated to the database. For example, odb1 and odb2. The default is odb1. You cannot specify the database shape when you create a instance-only database.

--dbstorage, -r{ACFS|ASM}

Defines the Database Storage, either Oracle ACFS or Oracle ASM. The default value is Oracle ASM.

--dbterritory, -dt

Defines the database territory. The default territory is AMERICA.

--dbtype, -y [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 for an Oracle ASM or ACFS storage-based database, at least one disk group of FLEX redundancy must exist. To specify the dbRedundancy option for an Oracle ASM storage database, the dbVersion or dbHomeVersion must be 12.2 or later.

--associated-networks, -nn

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

--disable-seha, -no-sh

Specifies whether you want to disable Standard Edition High-Availability for Oracle Database Standard Edition 19c and later single-instance databases.

--enable-seha, -sh

Specifies whether you want to enable Standard Edition High-Availability for Oracle Database Standard Edition 19c and later single-instance databases.

--targethost, -th

(Optional) Specifies the target host name (applicable only for Oracle RAC One Node Database and Standard Edition High Availability single-instance Oracle Database 19c and later).

--targetnode, -g

(Optional) Specifies the target node number (applicable only for Oracle RAC One Node database and Standard Edition High Availability single-instance Oracle Database 19c and later). The values are 0 or 1.

--levelzerobackupday, -lb

(Optional) Specifies the level zero backup day. The values can be Monday|Tuesday|Wednesday...|Sunday. The default is Sunday.

--backupconfigname, -bn

(Optional) Specifies the name of the backup configuration.

--bkuppassword, -bp

(Optional) Specifies the RMAN backup encryption password.

--enableFlashCache, -fc

(Optional) Specifies whether to enable Flash Cache.

--no-enableFlashCache, -no-fc

(Optional) Specifies whether to disable Flash Cache.

--dbOnFlashStorage, -f

(Optional) Specifies whether to enable data on Flash storage.

--no-dbOnFlashStorage, -no-f

(Optional) Specifies whether to disable data on Flash storage.

Usage Notes

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

  • Flash cache is disabled by default.

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

  • For Standard Edition Oracle Database 19c or later, you cannot create Oracle RAC Or Oracle RAC One Node Database. For Standard Edition, you can only deploy single-instance Oracle Database with or without high-availability enabled.
  • The dbname and databaseUniqueName can contain underscores (-), lowercase and uppercase alphabet (a-zA-Z, and numeric characters (0-9), must start with an alphabet, and must not exceed 8 characters in length. The dbname and databaseUniqueName must not also be an Oracle reserved key word.
  • Use the --cdb or --no-cdb flag to indicate whether or not the database is a container database. When neither flag is specified, the default database created is a non-CDB database.

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

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

  • When you use the command to create an instance-only database, then you cannot specify the database shape (template).
  • When you specify both the --version and the--dbhomeid, the version is ignored and the database is created against the existing database home.

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

  • 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, such as 18.8.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.

    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 16-86 Creating a Database in Interactive Mode

This example creates a 19.8.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" : "May 18, 2020 03:54:03 AM EDT",
   "description" : "Database service creation with db name: hrdb",
   "updatedTime" : "May 18, 2020 03:54:03 AM EDT" 
}

Example 16-87 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 19.8.0.0.0       
# odacli create-database -m -n hrmsdb2 -v 19.8.0.0.200714  

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

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

odacli delete-database

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To delete a database:

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

Parameters

Parameter Description

--dbid, -i

Identifies the database home identifier (ID) to display.

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

--force, -fd

(Optional) Forces the delete operation.

--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 16-88 Deleting a Database Named hrmsdb

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

# odacli list-databases   

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

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

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

odacli describe-database

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

File Path

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

Syntax

To display database details:

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

Parameters

Parameter Description

--dbid, -i

Identifies the database home identifier (ID) to display.

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

--json, -j

 

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Example 16-89

Display information for a database.

# odacli describe-database -i odacn

Database details                                                  
---------------------------------------------------------------- 
                     ID: 896238139
            Description: odacn
                DB Name: odacn
             DB Version: 19.6.0.0.200114
                DB Type: Si
                DB Role: PRIMARY
    DB Target Node Name: node1
             DB Edition: EE
                   DBID: 896238139
 Instance Only Database: false
                    CDB: false
               PDB Name: 
    PDB Admin User Name: 
           SEHA Enabled: false
                  Class: Oltp
                  Shape: Odb1
                Storage: Asm
          DB Redundancy: MIRROR
           CharacterSet: AL32UTF8
  National CharacterSet: AL16UTF16
               Language: AMERICAN
              Territory: AMERICA
                Home ID: bcc3991a-0ffc-4d29-86ae-40f2b8721dc4
        Console Enabled: false
     Level 0 Backup Day: Sunday
     AutoBackup Enabled: true
                Created: March 30, 2020 9:33:09 AM PDT
         DB Domain Name: domain.com
    Associated Networks: Public-network

Example 16-90 Displaying Database Details

Display information for database named ac48e0d2-a7b0-4ffd-a27e-f8e42b028c5f :

# odacli describe-database -i ac48e0d2-a7b0-4ffd-a27e-f8e42b028c5f

Database details                                                   
----------------------------------------------------------------
ID: ac48e0d2-a7b0-4ffd-a27e-f8e42b028c5f
Description: rdb1
DB Name: rdb1
DB Version: 19.8.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: May 18, 2020, 2016 6:21:14 PM

odacli list-databases

Use the odacli list-databases command to list all databases on the appliance.

File Path

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

Syntax

To display a list of all databases:

 odacli list-databases [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example 16-91 Displaying a List of Databases

Display a list of databases:

# odacli  list-databases

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

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

odacli modify-database

Use the odacli modify-database command to modify the configuration of a database, such as backup configuration, database class, and database type.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli modify-database [-i] [-dn] [-no-sh] [-sh] [-lb] [-nobkp] [-th] [-g] [-cl] [-rd] [-s] [-an] [-bi] [-bin] [noab] [-bp] [-id] [-in] [-y]  [-h] [-j]

Parameters

Parameter Description

--databaseid, -id

Defines the database identifier.

--dbName, -in

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

--dbid, -i

Defines the database ID to be updated. Specify either --dbName or --dbid.

--dbRedundancy, -rd

(Optional) Specifies the database redundancy value, that is, {HIGH|MIRROR}. To specify the dbRedundancy option for an Oracle ASM or ACFS storage-based database, at least one disk group of FLEX redundancy must exist. To specify the dbRedundancy option for an Oracle ASM storage database, the dbVersion or dbHomeVersion must be 12.2 or later.

--levelzerobackupday, -lb

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

--backupconfigid, -bi

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

--backupconfigname, -bin

(Optional) Specifies the name of the backup configuration.

--bkuppassword, -bp

(Optional) Specifies the RMAN backup encryption password.

--no-autobackup, -noab

(Optional) Disables automatic database backups.

--no-backup, -nobkp

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

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

--dbclass, -cl

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

--dbshape, -s

(Optional) Identifies the database shape (template) and determines the total memory allocated to the database. For example, odb1 and odb2. The default is odb1. You cannot specify the database shape for an instance-only database.

--attachnetworks, -an

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

--detachnetworks, -dn

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

--dbtype, -y

Defines new database type. The only option is SI.

--disable-seha, -no-sh

Disables Standard Edition High Availability for single-instance Oracle Database 19c and later.

--enable-seha, -sh

Enables Standard Edition High Availability for single-instance Oracle Database 19c and later.

--targethost, -th

(Optional) Specifies the target host name (applicable only for Oracle RAC One Node Database and Standard Edition High Availability single-instance Oracle Database 19c and later).

--targetnode, -g

(Optional) Specifies the target node number (applicable only for Oracle RAC One Node database and Standard Edition High Availability single-instance Oracle Database 19c and later). The values are 0 or 1.

--help, -h

(Optional) Displays help for using the command.

--json, -j

(Optional) Displays JSON output.

Example 16-92 Modifying the Database Shape (Template) and Database Class

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

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

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

Example 16-94 Specifying the target node when converting database

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

odacli move-database

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

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

Parameters

Parameter Description
--dbid, -i

(Optional) Defines the database ID.

--dbName, -in

(Optional) Defines the database name.

--help, -h

(Optional) Displays help for using the command.

--json, -j

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

--dest-db-home-id, -dh

(Optional) Defines the destination database home ID.

--dest-dbhome-name, -dhn

(Optional) Defines the destination database home name.

Usage Notes

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

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

odacli register-database

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli register-database  -c {OLTP|DSS|IMDB} -s dbshape -t dbtypeSI -o hostname -sn servicename [-bi backupconfigid] [-co|-no-co] [-nn] [-h] [-j] [-sh|-no-sh]

Parameters

Parameter Description

--backupconfigid, -bi

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

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

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

  • Enterprise Edition: OLTP, DSS, or IMDB.

  • Standard Edition: OLTP

--dbconsole, -co

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

--dbshape, -s

Identifies the database shape (template) and determines the total memory allocated to the database. For example, odb1 and odb2. The default is odb1.

--dbtype, -t [SI]

Defines the type of database. Only single-instance databases can be registered.

--help, -h

(Optional) Displays help for using the command.

--hostname, -o

Defines the host name. Default: local host name

--json, -j

(Optional) Displays JSON output.

--no-dbconsole, -no-co

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

--servicename, -sn

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

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

--associated-networks, -nn

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

--disable-seha, -no-sh

Specifies whether you want to disable Standard Edition High-Availability for Oracle Database Standard Edition 19c and later single-instance databases.

--enable-seha, -sh

Specifies whether you want to enable Standard Edition High-Availability for Oracle Database Standard Edition 19c and later single-instance databases.

Usage Notes

Note:

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

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

sqlplus sys/password@//hostname:1521/service name
  • The odacli register-database command is supported only on the primary database.
  • 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. Only the primary database is registered with Oracle Clusterware.

Example 16-96 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" : "May 18, 2020 05:55:49 AM EDT",
  "description" : "Database service registration with db service name: crmdb.example.com",
  "updatedTime" : "May 18, 2020 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: May 18, 2020 5:55:49 AM EDT
                Message:

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

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

odacli upgrade-database

You can the odacli upgrade-database command to upgrade a database from a supported release. This command is deprecated and will be desupported in a future release. Instead, use the command odacli move-database to move databases from one Oracle Database home to another.

File Path

/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] [-sh|-no-sh]

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.

--disable-seha, -no-sh

Specifies whether you want to disable Standard Edition High-Availability for Oracle Database Standard Edition 19c and later single-instance databases.

--enable-seha, -sh

Specifies whether you want to enable Standard Edition High-Availability for Oracle Database Standard Edition 19c and later single-instance databases.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

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

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

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

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

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

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

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

odacli DBHome Commands

Use the odacli DBHome commands to manage database Home operations.

odacli create-dbhome

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

File Path

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

Syntax

To create an Oracle Database Home:

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

Parameters

Parameter Description

-v version number

Defines the database bundle patch number.

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

For the version number, you can specify the database version, such as 18.7.0.0, 18.5.0.0, 12.2.0.1, 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, 19.8.0.0.200714. If you use the database version without specifying the bundle patch number, then the latest bundle patch is used.

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 16-98 Creating an Oracle Database Home

The following example creates an Oracle Database Home version 19.8.0.0.200714.

# odacli  create-dbhome -v 19.8.0.0.200714

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 16-99 Deleting an Empty Database Home

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

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

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

odacli Database Storage Commands

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

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 16-102 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" 
}

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 16-103 Deleting Empty Database Storage

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

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 16-104 Displaying Database Oracle ACFS Storage Details

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

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

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

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

odacli describe-dgstorage

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

File Path

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

Syntax

odacli describe-dgstorage  -d diskgroup -h

Parameters

Parameter Description

--diskgroup, -d

Specifies the disk group for which information is displayed.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

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

Example 16-106 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)

odacli list-dbstorages

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

# odacli list-dbstorages  [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Usage Notes

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

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

odacli list-dgstorages

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

odacli list-dgstorages  -r redundancy -h

Parameters

Parameter Description

--redundancy, -r

Specifies the disk group redundancy for FLEX disk group.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

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

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

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

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

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

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

odacli update-dgstorage

Use the odacli update-dgstorage command to release disks.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To release disks:

   odacli update-dgstorage [-h] [-f] [-rd] [-j] 

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--force, -f

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

--release-disk, -rd

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

Usage Notes

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

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

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

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

odacli Job Commands

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

odacli create-jobdata-retention-policy

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To create job data retention policy:

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

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--retentionWindow, -w

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

--retentionWindowUnit, -u

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

--scheduleIds, -s

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

Usage Notes

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

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

# odacli create-jobdata-retention-policy 

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

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

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

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

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

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

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

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

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

odacli create-purge-jobdata-job

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To create job data purge:

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

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--jobIds, -i

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

--olderThan, -o

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

--olderThanUnit, -u

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

--scheduleIds, -s

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

Example 16-112 Creating a job to purge job data

# odacli create-purge-jobdata-job 

Job details 
---------------------------------------------------------------- 
ID: e43dbd56-dc7c-4812-b653-0fc3208e0929 
Description: purge job data 
Status: Created 
Created: April 23, 2020 6:27:40 PM PDT 

Message: 
Task Name Start Time End Time Status
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
[root@oda1]# odacli describe-job -i e43dbd56-dc7c-4812-b653-0fc3208e0929 
Job details 
---------------------------------------------------------------- 
ID: e43dbd56-dc7c-4812-b653-0fc3208e0929 
Description: purge job data 

Status: Success 
Created: April 23, 2020 6:27:40 PM PDT 
Message: Purged 21 metadata records and 10 files. Purge policies are: 
Purge all jobs and scheduled executions older than 30 Days 
Purge scheduled executions for ID:284a22b5-41e6-4be1-a916-048eac74e076 older than 10 Day 

Task Name   Start Time  End Time    Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
purge job data  April 23, 2020 6:27:40 PM PDT   April 23, 2020 6:27:40 PM PDT   Success

Example 16-113 Purging job data older than 5 hours, including all jobs and scheduled executions related records

# odacli create-purge-jobdata-job -o 5 -u Hour 
Job details 
---------------------------------------------------------------- 
ID: 4d065c96-a8eb-4974-a446-573b5ad3cb95 
Description: purge job data 
Status: Created 
Created: April 23, 2020 1:55:59 PM PDT 
Message:  
Task Name Start Time End Time Status 

---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
[root@oda1]# odacli describe-job -i 4d065c96-a8eb-4974-a446-573b5ad3cb95 

Job details 
---------------------------------------------------------------- 
ID: 4d065c96-a8eb-4974-a446-573b5ad3cb95 
Description: purge job data 
Status: Success 
Created: April 23, 2020 1:55:59 PM PDT 
Message: Purged 242 metadata records and 0 files. Purge policies are: 
Purge all jobs and scheduled executions older than 5 Hour 

Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
purge job data      April 23, 2020 1:55:59 PM PDT       April 23, 2020 1:55:59 PM PDT       Success

Example 16-114 Purging job data for multiple jobs

# odacli create-purge-jobdata-job -i 87a926cd-a243-49e0-ba02-9d8968e1de1e,0e2a38c0-041a-41d8-91ad-7f9f7c646f12 

Job details 
---------------------------------------------------------------- 
ID: 217cbdbf-15a5-47d3-9582-3f26d6b5eebf 
Description: purge job data 
Status: Created 
Created: April 23, 2020 2:01:25 PM PDT 
Message: Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 

[root@oda1]# odacli describe-job -i 217cbdbf-15a5-47d3-9582-3f26d6b5eebf 
Job details 
---------------------------------------------------------------- 
ID: 217cbdbf-15a5-47d3-9582-3f26d6b5eebf 
Description: purge job data 
Status: Success 
Created: April 23, 2020 2:01:25 PM PDT 
Message: Purged 11 metadata records and 0 files. Purge policies are: 
Purge job with ID:87a926cd-a243-49e0-ba02-9d8968e1de1e 
Purge job with ID:0e2a38c0-041a-41d8-91ad-7f9f7c646f12 

Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
purge job data      April 23, 2020 2:01:25 PM PDT       April 23, 2020 2:01:25 PM PDT       Success

Example 16-115 Purging job data for specific job data schedules older than 5 days

# odacli create-purge-jobdata-job -s 39cc86d6-30c2-4744-bfbc-e62535e2aa67,31b3a83b-76ca-44d3-9268-b4dac948e217 -o 5 -u Day 

Job details 
---------------------------------------------------------------- 
ID: be839a81-a79b-43ce-bf70-c8aba1a9cc91 
Description: purge job data 
Status: Created 
Created: April 23, 2020 2:44:54 PM PDT 
Message: 

Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
[root@oda1]# ./odacli describe-job -i be839a81-a79b-43ce-bf70-c8aba1a9cc91 

Job details 
---------------------------------------------------------------- 
ID: be839a81-a79b-43ce-bf70-c8aba1a9cc91 
Description: purge job data 
Status: Success 
Created: April 23, 2020 2:44:54 PM PDT 
Message: Purged 0 metadata records and 0 files. Purge policies are: 
Purge scheduled executions for ID:39cc86d6-30c2-4744-bfbc-e62535e2aa67 older than 5 Day 
Purge scheduled executions for ID:31b3a83b-76ca-44d3-9268-b4dac948e217 older than 5 Day 
Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
purge job data April 23, 2020 2:44:54 PM PDT April 23, 2020 2:44:54 PM PDT Success

odacli delete-jobdata-retention-policy

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To delete job data retention:

   odacli delete-jobdata-retention-policy [-j] [-h][-s]

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--scheduleIds, -s

(Optional) Specifies the IDs applied by the job data retention policy. If not supplied, delete all the existing policies.

Example 16-116 Deleting the job data retention policies

# odacli delete-jobdata-retention-policy 

Job details 
---------------------------------------------------------------- 
ID: ab819d57-9e35-4f55-bd5e-d26fc6372448 
Description: delete job data retention policy 
Status: Running 
Created: April 23, 2020 7:34:05 PM PDT 

Message: 
Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
remove job data retention policy entries        April 23, 2020 7:34:05 PM PDT       April 23, 2020 7:34:05 PM PDT       Running 

[root@oda1]# odacli describe-job -i ab819d57-9e35-4f55-bd5e-d26fc6372448 

Job details 
---------------------------------------------------------------- 
ID: ab819d57-9e35-4f55-bd5e-d26fc6372448 
Description: delete job data retention policy 
Status: Success 
Created: April 23, 2020 7:34:05 PM PDT 
Message: 

Task Name Start Time End Time Status 
---------------------------------------- ----------------------------------- ----------------------------------- ---------- 
remove job data retention policy entries        April 23, 2020 7:34:05 PM PDT       April 23, 2020 7:34:05 PM PDT       Success 
remove auto job data schedule                   April 23, 2020 7:34:05 PM PDT       April 23, 2020 7:34:05 PM PDT       Success 

[root@oda1]# odacli list-jobdata-retention-policy 

DCS-10032:Resource JobDataRetentionPolicy is not found.

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

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 16-118 Displaying a List of Jobs

To display a list of jobs:

# odacli list-jobs

ID                           Description            Created
---------------------------- ---------------------  ----------------------------
a6084067-72a1-4625-bea7-efd  Provisioning service   creation Jun 2, 2018 10:19:23 AM

(Continued)
Status
-------
Success 

Example 16-119 Displaying Specified Number of Older Jobs

To display a specified number of older jobs:

# odacli list-jobs -hd 5
ID Description Created Status 
--- --- --
643c6186-a667-43d7-847f-d756a96fa072 Create detailed Backup Report 
August 5, 2018 12:36:26 AM UTC Success 
f29cb82c-6150-487d-aaff-52d65f6ab972 Create recovery-pitr : time '08/05/2018 07:16:12' 
for db : igIyoz August 5, 2018 1:01:39 AM UTC Success 
cfe19337-ab2f-4ef3-85b5-24601ba31be2 Create detailed Backup Report 
August 5, 2018 1:17:46 AM UTC Success 
3749b5e2-240e-4df5-b3c1-32d345243b25 Create detailed Backup Report 
August 5, 2018 2:01:07 AM UTC Success 
64828852-bb16-4f06-aca9-4bdf9fe7b6f2 Create regular-5 Backup with TAG-iD5UNjBZ8HN2FYL 
for Db:igIyoz August 5, 2018 2:14:19 AM UTC Success 

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

odacli list-jobdata-retention-policy

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To list jobs and view job details and status:

   odacli list-jobdata-retention-policy [-j] [-h]

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Example 16-121 Listing all job retention policies

# odacli list-jobdata-retention-policy 

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

odacli list-purge-jobdata-job

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

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To list job data purge policy:

   odacli list-purge-jobdata-job [-j] [-h]

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

Usage Notes

The command describes the files that are purged, the purged count, the purged file size, and the time of purge.

Example 16-122 Listing history, statistics, and rules for job data purge jobs

# odacli list-purge-jobdata-jobs 

Purge By Job                             Purged Object             Count      Size       Type            Purged Time         
---------------------------------------- ---------------------- ---------- ---------- --------------- --------------------
4d065c96-a8eb-4974-a446-573b5ad3cb95        TaskReport              102                 Metadata        April 23, 2020 1:55:59 PM PDT 
4d065c96-a8eb-4974-a446-573b5ad3cb95        ServiceJobReport        24                  Metadata        April 23, 2020 1:55:59 PM PDT 
4d065c96-a8eb-4974-a446-573b5ad3cb95        LogCleanupSummary       2                   Metadata        April 23, 2020 1:55:59 PM PDT 
4d065c96-a8eb-4974-a446-573b5ad3cb95        JobExecutionResource    93                  Metadata        April 23, 2020 1:55:59 PM PDT 
4d065c96-a8eb-4974-a446-573b5ad3cb95        JobDataPurgeResult      21                  Metadata        April 23, 2020 1:55:59 PM PDT

odacli list-scheduled-executions

Use the command odacli list-scheduled-executions to display a list of jobs that were executed.

File Path

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

Syntax

   odacli list-scheduled-executions [-e] [-1] [-j] [-h]

Parameters

Parameter Description
--executionid, -e

(Optional) Displays the execution ID.

--scheduleid, -i

(Optional) Displays the Schedule ID.

--help, -h

(Optional) Displays help for using the command.

--json, -j

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

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

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.

File Path

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

Syntax

To collect diagnostic logs for components:

   odaadmcli manage diagcollect [-h] [--dataMask] [--dataSanitize] [--fromTime] [--toTime] [--Components] 

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--dataMask

(Optional) Masks sensitive data. The default is No.

--dataSanitize

(Optional) Sanitizes (redacts) sensitive data. The default is No.

--fromTime

(Optional) Specifies the time from when you want to collect data. The timestamp formats can be of the type: mon/dd/yyyy hh:mm:ss, or yyyy-mm-dd hh:mm:ss, or yyyy-mm-ddThh:mm:ss, or yyyy-mm-dd.

--toTime

(Optional) Specifies the time till when you want to collect data. The timestamp formats can be of the type: mon/dd/yyyy hh:mm:ss, or yyyy-mm-dd hh:mm:ss, or yyyy-mm-ddThh:mm:ss, or yyyy-mm-dd.

--Components

(Optional) Specifies the comma-separated list of components for which you want to collect data. The supported values are:

all, ips, oda, odalite, dcs, odabackup, odapatching, odadataguard, odaprovisioning, odaconfg, odasystem, odastorage, database, asm, crsclient, dbclient, dbwlm, tns, rhp, procinfo, afd, crs, cha, wls, emagent, oms, ocm, emplugins, em, acfs, install, cfgtools, os, ashhtml, ashtext, awrhtml, awrtext

--verbose

Displays detailed message.

Usage Notes

The following types of sensitive information can be redacted using the --dataMask or the --dataSanitize option:

  • Host names

  • IP addresses

  • Database names

  • Tablespace names

  • Service names

  • Ports

  • Operating System user names

For example, when the --dataMask option is used, all instances of a sensitive name such as a database name called "payrolldb" are replaced with "*********" in the TFA collection.

For example, when the --dataSanitize option is used, all instances of a sensitive name such as a database name called "payrolldb" are replaced with another string, such as "oCjlN7F8P", in the TFA collection.

Example 16-124 Masking Sensitive Data in Log Collection

# /opt/oracle/oak/bin/odaadmcli manage diagcollect --dataMask
DataMask is set as true
TFACTL command is: /opt/oracle/tfa/tfa_home/bin/tfactl
Data mask is set.
Collect data within last 12 hours as default
Please wait for several minutes for the collection to complete.

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

odacli create-logcleanjob

Use the odacli create-logcleanjob command to create a job to purge log files for a specified time period.

File Path

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

Syntax

To list jobs and view job details and status:

   odacli create-logcleanjob [-h] [-c] [-o] [-u]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--components, -c

(Optional) Specifies the list of components, separated by comma. The values are gi|database|dcs For example, gi,dcs.

--olderthan, -o

(Optional) Cleans logs older than specified time interval. Default is 30 if it is not specified.

--unit, -u

(Optional) Unit for the --olderthan parameter. Default is Day if it is not specified.

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

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

odacli list-auto-logclean-policy

Use the odacli list-auto-logclean-policy command to list the jobs to purge log files.

File Path

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

Syntax

To list jobs and view job details and status:

   odacli list-auto-logclean-policy [-h] [-c]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

--components, -c

(Optional) Specifies the list of components, separated by comma. The values are gi|database|dcs For example, gi,dcs.

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

odacli list-logcleanjobs

Use the odacli list-logcleanjobs command to list the jobs to purge log files.

File Path

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

Syntax

To list jobs and view job details and status:

   odacli list-logcleanjobs [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

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

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

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

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.

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

(Optional) Defines Simple Network Management Protocol (SNMP) Version 3.

--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 16-131 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 16-132 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.

odacli delete-asr

Use the odacli delete-asr command to remove the Oracle Auto Service Request (Oracle ASR) configuration from the system.

File Path

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

Syntax

# odacli delete-asr [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

Example 16-133 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 
}

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

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

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

(Optional) Defines Simple Network Management Protocol (SNMP) Version 3.

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

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.

File Path

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

Syntax

odacli list-osconfigurations [-h] [-j] 

Parameters

Parameter Description
--help, -h

(Optional) Displays help for using the command.

--json, -j

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

Usage Notes

The command displays the configured values for HugePage and memlock from the /etc/sysctl.conf and /etc/security/limits.conffiles. Based on the total available space, suggested values are calculated for the parameters.

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

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

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.

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.

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

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


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

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 16-142 Showing Network Details

# odaadmcli show network
NAME 	       HEALTH HEALTH_DETAILS LOCATION PART_NO MANUFACTURER MAC_ADDRESS LINK_DETECTED DIE_TEMP 

Ethernet_NIC_0     OK     -              NET0     i210    INTEL        00:10:E0:DD:9D:14 no (em1) N/A 
Ethernet_NIC_1     OK     -              NET1     X710/X557-AT Intel   3C:FD:FE:78:93:92 no (p2p3) N/A 
Ethernet_NIC_2     OK     -              NET2     X710/X557-AT Intel   3C:FD:FE:78:93:91 yes (p2p2) N/A 
Ethernet_NIC_3     OK     -              NET3     X710/X557-AT Intel   3C:FD:FE:78:93:90 yes (p2p1) N/A 
Ethernet_NIC_4     OK     -              NET4     BCM57414 Broadcom    B0:26:28:3F:D8:B8 yes (p7p2) N/A 
Ethernet_NIC_5     OK     -              NET5     X710/X557-AT Intel   3C:FD:FE:78:93:93 no (p2p4) N/A 
Ethernet_NIC_6     OK     -              NET6     BCM57414 Broadcom    B0:26:28:3F:D8:B0 yes (p7p1) N/A

odaadmcli show power

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

File Path

/opt/oracle/dcs/bin/odaadmcli

Syntax

Run this command on the first node, to display power supply details on Oracle Database Appliance High-Availability (HA) models:

   odaadmcli show power [-h]

Parameters

Parameter Description

--help, -h

(Optional) Displays help for using the command.

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

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

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

Storage Commands

Understand the commands to perform storage operations and diagnostics.

odaadmcli expand storage

Use the odaadmcli expand storage command to expand storage.

File Path

/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 single node platforms.

--help, -h

(Optional) Displays help for using the command.

-ndisk

Defines the number of disks to be added in the enclosure.

Usage Notes

On high-availability (HA) Oracle Database Appliance hardware models, run the command only on the first node.

Various storage options are available. On multi-node platforms, the base storage is SSD and you can choose to add either SSD or HDD disks. When adding a storage expansion shelf, all disks must be the same type (you cannot combine SSD and HDD disks).

Note:

In addition to reviewing the expand storage command, it is important to follow the procedures for adding storage. Cabling validation and disk placement is important. In some cases, you must move disks to different slots to successfully expand storage.

odacli list-dgdisks

Use the odacli list-dgdisks command to display details about the available disks.

File Path

/opt/oracle/dcs/bin/odacli

Syntax

To list available disk details:

   odacli list-dgdisks [-h] [-dg] [-dp] [-j] 

Parameters

Parameter Description

--json, -j

(Optional) Displays JSON output.

--help, -h

(Optional) Displays help for using the command.

--diskgroup, -dg

(Optional) Displays all disks in the specified disk group. The possible values are: ALL, DATA, RECO, REDO, FLASH. If no value is specified, then ALL disks are displayed.

--diskpath, -dp

(Optional) Displays all disks that contains the specified value in the path. If no value is specified, then all disks are displayed.

Usage Notes

Example 16-146 Listing All Available Disks on the System

# odacli list-dgdisks -dg ALL

Name                      Group Mount St Group Num Mode St State    Redundancy Fail Grp                  Path                           Health Inc
------------------------- ----- -------- --------- ------- -------- ---------- ------------------------- ------------------------------ ------ ---
HDD_E0_S19_576667504P1    DATA  CACHED   1         ONLINE  NORMAL   UNKNOWN    HDD_E0_S19_576667504P1    AFD:HDD_E0_S19_576667504P1     0      0 
HDD_E0_S08_577087696P1    DATA  CACHED   1         ONLINE  NORMAL   UNKNOWN    HDD_E0_S08_577087696P1    AFD:HDD_E0_S08_577087696P1     0      0 
HDD_E0_S11_576021940P1    DATA  CACHED   1         ONLINE  NORMAL   UNKNOWN    HDD_E0_S11_576021940P1    AFD:HDD_E0_S11_576021940P1     0      0 
HDD_E0_S13_576660012P1    DATA  CACHED   1         ONLINE  NORMAL   UNKNOWN    HDD_E0_S13_576660012P1    AFD:HDD_E0_S13_576660012P1     0      0 
HDD_E0_S15_577131668P1    DATA  CACHED   1         ONLINE  NORMAL   UNKNOWN    HDD_E0_S15_577131668P1    AFD:HDD_E0_S15_577131668P1     0      0 
HDD_E0_S09_576662448P1    DATA  CACHED   1         ONLINE  NORMAL   UNKNOWN    HDD_E0_S09_576662448P1    AFD:HDD_E0_S09_576662448P1     0      0 
HDD_E0_S18_577136300P1    DATA  CACHED   1         ONLINE  NORMAL   UNKNOWN    HDD_E0_S18_577136300P1    AFD:HDD_E0_S18_577136300P1     0      0

Example 16-147 Listing Disks with the Specified Disk Path on the System

# odacli list-dgdisks -dp HDD_E0_S10_577135552

Name                   Group Mount St Group Num Mode St State    Redundancy Fail Grp               Path                        Health Inc
---------------------- ----- -------- --------- ------- -------- ---------- ---------------------- --------------------------- ------ ---
HDD_E0_S10_577135552P1 DATA  CACHED   1         ONLINE  NORMAL   UNKNOWN    HDD_E0_S10_577135552P1 AFD:HDD_E0_S10_577135552P1  0      0  
HDD_E0_S10_577135552P2 RECO  CACHED   2         ONLINE  NORMAL   UNKNOWN    HDD_E0_S10_577135552P2 AFD:HDD_E0_S10_577135552P2  0      0

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.

odaadmcli power disk

Use the odaadmcli power disk command to power a disk on or off for NVMe drives only.

File Path

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

Syntax

To power an NVMe disk on or off:

   odaadmcli power disk {on|off|status} disk_name [-h]

Parameters

Parameter Description

disk_name

Defines the disk resource name. The resource name format is pd_[0..3].

{on|off|status}

Power on a disk, power off a disk, display status.

--help, -h

(Optional) Displays help for using the command.

Example 16-148 Powering a Disk Off

This example shows how to power off a disk.

# odaadmcli power disk off pd_00 
Disk 'pd_00' is already part of ASM

Are you sure you want to power OFF the disk?: 'pd_00'? 
[yes/no]:
yes 
Powered OFF pd_00

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

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

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 16-151 Displaying the Status of All Disks

To display the status of all the disks on the system:

# odaadmcli show disk         
NAME		PATH 			TYPE 	STATE 	STATE_DETAILS          
pd_00 	/dev/nvme0n1 NVD 		ONLINE 	Good         
pd_01 	/dev/nvme1n1 NVD 		ONLINE 	Good

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

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 16-153 Listing All Diskgroups

To list all diskgroups:
# odaadmcli show diskgroup 

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

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

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