Copyright (c) 2023, Oracle. All rights reserved. Oracle Confidential.

ODA ODACLI and ODAADMCLI Command Line Reference (Doc ID 2411941.1)

In this Document

Purpose
Scope
Details
  Products
  Three Classes of Oracle Database Appliance Manager Tools 
  Configuration & Deployment
  Storage Admin:  odaadmcli
  HW Admin: odaadmcli
  ODACLI commands
  General ODACLI Commands
  ODACLI:  List of Commands 
  ODACLI:  By Operations

APPLIES TO:

Oracle Database Appliance Software - Version 18.3.0.0.0 Bare Metal and later
Information in this document applies to any platform.

PURPOSE

This is a quick reference guide to the Oracle Database Appliance command line interface. ODACLI and ODAADMCLI
commands that will replace OAKCLI in legacy ODA Hardware Types (HW_type). The same commands are used for ODA X6-
2 S/M/L X7-2 S/M and HA HW_types.

NOTE: The current odacli and odaadmcli commands and details are updated in the ODA Oracle Documentation
(docs.oracle.com) since this note was originally created.

Always refer to the documentation for the most current list of commands, implementation details and options which
can change and be version specific.

SCOPE

 This note may not include all commands available in the most current documentation for the ODA. Also there may some
commands which have changed, been added or deprecated depending on the version.

DETAILS

Products
ODA X6-2 Small  ODAX6-2 Medium and ODA X6-2 Large
ODA X7-2 Small  ODA X7-2 Medium ODA X7-2 HA

 
 Mandatory Information for Every ODA SR
ODA V1, Pre-18.3 HA and ODAVP         Bare Metal 18.x and ODA Lite Configurations
oakcli show env_hw  odaadmcli show env_hw
oakci validate -d (each node) odacli describe-component
 oakcli show version -detail (optional) odacli list-jobs

Three Classes of Oracle Database Appliance Manager Tools 

Three Classes of Oracle Database Appliance Manager Tools 

Class of Command  Command Description

Configuration & Deployment FirstNet Used after racking and cabling ; odacli update-cpucore to set cover

Lifecycle Management odacli Primary commands used to perform database and system administration tas
appliance

System Administration odaadmcli Used to perform hardware administration tasks for the appliance

Configuration & Deployment

Configuration & Deployment                                              

   configure-firstnet Use to configure the first network in the appliance after racking and connecting

Storage Admin:  odaadmcli

Storage Admin:  odaadmcli /opt/oracle/oak/bin/odaadmcl

  odaadmcli expand storage Use the odaadmcli expand storage command to expand storage.

  odaadmcli show disk Use the odaadmcli show disk command to display the status of a single disk o

  odaadmcli show diskgroup Use the odaadmcli show diskgroup command to list configured diskgroups or

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

  odaadmcli show iraid Use the odaadmcli show iraid command to display details of the internal RAI

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

  odaadmcli show storage Use the odaadmcli show storage command to show the storage controllers, e

  odaadmcli stordiag Use the odaadmcli stordiag command to collect detailed information for each

  odaadmcli manage diagcollect Use the odaadmcli manage diagcollect command to collect diagnostic logs f

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

HW Admin: odaadmcli
 HW Admin:   odaadmcli /opt/oracle/oak/bin/odaadmcli
  odaadmcli show env_hw Use the odaadmcli show env_hw command to display information about the env

  odaadmcli show cooling Use the odaadmcli show cooling command to show cooling details.

  odaadmcli show fs Use the odaadmcli show fs command to display filesystem details.

  odaadmcli show memory Use the odaadmcli show memory command to display memory details.

  odaadmcli show network Use the odaadmcli show network command to show network details.

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

  odaadmcli show processor Use the odaadmcli show processor command to display processor details.

  odaadmcli show server Use the odaadmcli show server command to display server details.

  odaadmcli show enclosure Use the odaadmcli show enclosure command to display enclosure details.

all ODAVP

ODACLI commands

General Commands
By Operation
Commands List

General ODACLI Commands

General ODACLI Commands    /opt/oracle/dcs/bin/odacli

  ODACLI  
  odacli Apply Patch and Update   Use the odacli update and apply patch commands to apply patches and update the
  odacli Appliance  Use the odacli appliance commands to perform lifecycle activities for the appliance
  odacli CPU Core  Use the CPU Core commands to enable CPU cores and display current and historica
  odacli Database  Use the odacli database commands to perform database lifecycle operations.
  odacli DBHome   Use the odacli DBHome commands to manage database Home operations.
  odacli Database Storage   Use the Database Storage commands to list, describe, create, and delete Oracle da
  odacli Job  Use the odacli list-jobs and odacli describe-job commands to display job details.
  odacli Network                              Use the odacli network commands to list and describe network interfaces.
  odacli Oracle Auto Service Request  Use the Oracle Auto Service Request (Oracle ASR) commands to configure, update
  odacli-adm set-credential  Use the odacli-adm set-credential command to change the oda-admin user credent

 usage: odacli   [-h/--help]

                <category> [-h/--help]
                <operation> [-h/--help]
                <command> [-h/--help]
                <command> [<args>]

ODACLI:  List of Commands 

ODACLI:  List of Commands

    Command Version args
  appliance:      

    create-appliance    

    describe-appliance    

  asr:      

    configure-asr    

    delete-asr    

    describe-asr    

    test-asr    

    update-asr    

  component:      

    describe-component    

  cpucore:      

    describe-cpucore    

    list-cpucores    

    update-cpucore    

  credential:      

    set-credential    

  database:      

    create-database    

    delete-database    

    describe-database    

    list-databases    

    register-database    

    upgrade-database    

  dbhome:      

    create-dbhome    

    delete-dbhome    

    describe-dbhome    

    list-dbhomes    

    update-dbhome    

  dbstorage:      

    create-dbstorage    

    delete-dbstorage    

    describe-dbstorage    

    list-dbstorages    

  dcsagent:      

    update-dcsagent    
   job:      

    describe-job    

    list-jobs    

  latestpatch:      

    describe-latestpatch    

  network:      

    create-network    

    delete-network    

    describe-network    

    list-networks    

    update-network    

  networkinterface:      

    describe-    
networkinterface

    list-networkinterfaces    

  repository:      

    update-repository    

  server:      

    update-server    

  storage:      

    update-storage    

ODACLI:  By Operations

ODACLI:  By Operations
  Operation Command Version arg

  configure:      

    configure-asr    

  create:      

    create-appliance    

    create-database    

    create-dbhome    

    create-dbstorage    

    create-network    

  delete:      

    delete-asr    

    delete-database    

    delete-dbhome    
    delete-dbstorage    

    delete-network    

  describe:      

    describe-appliance    

    describe-asr    

    describe-component    

    describe-cpucore    

    describe-database    

    describe-dbhome    

    describe-dbstorage    

    describe-job    

    describe-latestpatch    

    describe-network    

    describe-    
networkinterface

  list:      

    list-cpucores    

    list-databases    

    list-dbhomes    

    list-dbstorages    

    list-jobs    

    list-networkinterfaces    

    list-networks    

  register:      

    register-database    

  set:      

    set-credential    

  test:      

    test-asr    

  update:      

    update-asr    

    update-cpucore    

    update-dbhome    

    update-dcsagent    

    update-network    

    update-repository    

    update-server    
     update-storage    

  upgrade:      

    upgrade-database    

         

 
Didn't find what you are looking for?