Oracle Appliance Manager Command-Line Interface has different classes of tools to manage Oracle Database Appliance.
Topics:
configure
and update
commands to configure the appliance.odacli update
and apply patch
commands to apply patches and update the appliance.odacli appliance
commands to perform lifecycle activities for the appliance.odacli database
commands to perform database lifecycle operations.odacli DBHome
commands to manage database Home operations.odacli list-jobs
and odacli describe-job
commands to display job details.odacli network
commands to list and describe network interfaces.odaadmcli storage
commands to perform storage diagnostics.hardware monitoring
commands to display hardware configurations.odacli-adm set-credential
command to change the oda-admin
user credentials.Three classes of tools are available to perform configuration, lifecycle management, and system administration on Oracle Database Appliance.
Oracle Database Appliance X6-2 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 ODAADMCLI utilities combine the capabilities of the SYS
database administrator role and the operating system Superuser (root
user). Always perform administrative tasks using the command-line 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 in-frequent administration activities needed to manage appliance hardware components.
You can perform the following deployment and configuration tasks:
Configure the first network in the appliance
Unzip and copy the Oracle Database Appliance Single Instance Software Bundle to the correct locations
Set the number of CPU Cores for the system
You can perform the following appliance lifecycle tasks with odacli
commands:
Create and describe the appliance
Create, list, describe, and delete databases
Create, list, describe, and delete Oracle Database Homes
Create, list, and describe the networks
List and describe the jobs
You can perform the following appliance administration tasks with odaadmcli
commands:
Show storage, disks, diskgroups, and controllers
Display storage diagnostics for disks and NVM Express (NVMes)
Locate disks
Show server, memory, processor, power, cooling, and network details
Depending on your version of Oracle Appliance Manager and your hardware, some of the odacli
commands may not be available to you. To see which commands are supported on your version of Oracle Appliance Manager and your hardware, run the odacli
help command: odacli -h
.
ODACLI Command Location and Path Configuration
The Oracle Appliance Manager command-line interface is in the following directory:
/opt/oracle/dcs/bin/odacli
Configure the root user account on your Oracle Database Appliance servers to have the PATH variable defined to search for odacli
commands in the path /opt/oracle/oda/bin/odacli
.
ODACLI Syntax
Oracle Appliance Manager command-line interface commands and parameters are case-sensitive.
An odacli command uses the following command syntax:
odacli command [options]
command is an action you want to perform on the appliance. For example: list-networks
, create-appliance
, or 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. 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 10-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 Default: false --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 Default: false --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 Default: false --instanceonly, -io Create Instance Only (For Standby) Default: false --json, -j json output Default: false --nlscharacterset, -ns NLS Character Set (default:AL16UTF16) Default: AL16UTF16 --pdbadmin, -d Pluggable Database Admin User --pdbname, -p Pluggable Database Name --version, -v Database Version Default: 12.1.0.2
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
Use the configure
and update
commands to configure the appliance.
Topics:
configure-firstnet
command to configure the first network in the appliance after racking and connecting the power and network cables. This command ensures that the system is available in the network, enabling you to manage the deployment through the Oracle Appliance Manager Web Console.update-image
command to unzip and copy the Single Instance Software Bundle to the appropriate locations so that the system is ready for deployment.Use the configure-firstnet
command to configure the first network in the appliance after racking and connecting the power and network cables. This command ensures that the system is available in the network, enabling you to manage the deployment through the Oracle Appliance Manager Web Console.
Syntax
To ensure that the system is available in the network:
configure-firstnet
Example 10-2 Configuring the First 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. 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.
# configure-firstnet Select the Interface to configure the network on (btbond1 sfpbond1): 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:
Use the update-image
command to unzip and copy the Single Instance Software Bundle to the appropriate locations so that the system is ready for deployment.
Syntax
To update an image:
update-image --image-files absolute file names
Parameters
Parameter | Description |
---|---|
|
Identifies the file names. Use a comma separated list of absolute file names. Ensure that there are no spaces after the comma. |
|
(Optional) Displays help for using the command. |
Example 10-3 Updating the Image
To update the Single Instance Software Bundle:
# update-image --image-files file1,file2,file3
Use the odacli update
and apply patch
commands to apply patches and update the appliance.
Topics:
odacli update-repository
command to update the repository with the new patches.odacli update-dcsagent
command to update the agent.odacli update-server
command to update the operating system, firmware, Oracle Appliance Kit, Oracle Clusterware, and all other infrastructure components.odacli update-dbhome
command to update a specific RDBMS Home to the latest patch bundle version.Use the odacli update-repository
command to update the repository with the new patches.
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 |
---|---|
|
Defines the zip filename of patch bundle or RDBMS clones downloaded from My Oracle Support. Provide a comma-separated list of absolute file paths. |
|
(Optional) Displays JSON output. The default is false. |
|
(Optional) Displays help for using the command. |
Usage Notes
Note:
Before updating the repository, ensure that you do not have any jobs running or pending during the update window.Example 10-4 Updating the Repository
To update the dcs-repository
with the latest patches:
# odacli update-repository -f /root/12.1.2.8/oda-sm-12.1.2.8.0-160719-GI-12.1.0.2.zip { "jobId" : "d3510276-da05-447b-990e-6d30964f8f79", "status" : "Created", "message" : null, "reports" : [ ], "createTimestamp" : "August 08, 2016 03:45:39 AM EDT", "description" : "Repository Update", "updatedTime" : "August 08, 2016 03:45:39 AM EDT" }
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 |
---|---|
|
Defines the Oracle Database Appliance version after update. For 12.1.2.8.0, the version is 12.1.2.8. |
|
(Optional) Displays help for using the command. |
Usage Notes
The update dcsagent
command updates the dcs-agent
to the RPM package that is located in the location and restarts the dcs-agent
. After the update is applied, the agent automatically restarts. It will take a few minutes to reconnect to the dcs-agent
. Wait until the agent shuts down and completes restarting before performing any tasks.
Note:
Before updating the agent, ensure that you do not have any jobs running or pending during the update window.Example 10-5 Updating the Agent
To update the dcs-agent
to version 12.1.2.8:
# /opt/oracle/dcs/bin/odacli update-dcsagent -v 12.1.2.8
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 |
---|---|
|
Defines the version to update. |
|
(Optional) Displays JSON output. The default is false. |
|
(Optional) Displays help for using the command. |
Usage Notes
The update-server command applies the patches to various infrastructure components and Oracle Clusterware. Before executing the update-server
command , use the update-dcsagent
command to update the agent to the current version.
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.
Note:
Before updating the server, ensure that you do not have any jobs running or pending during the update window.Example 10-6 Updating the Server
To update the server to version 12.1.2.8:
# update-server -v 12.1.2.8
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 -dh dbhomeid -v version [-j] [-h]
Parameters
Parameter | Description |
---|---|
|
Defines the Oracle Database Home to update. |
|
(Optional) Displays JSON output. The default is false. |
|
Defines the Oracle Database Appliance version to update. For example, 12.1.2.8. |
|
(Optional) Displays help for using the command. |
Usage Notes
The update-dbhome
command applies the latest bundle patch for Oracle Database version 12.1 and the latest patch set updates (PSU) for Oracle Database 11.2.0.4.x home.
Example 10-7 Updating an Oracle Database Home
To apply the latest patch bundle to update an Oracle Database:
# odacli update-dbhome dh ad6c7326-e460-411e-94df-230dedbef743 -v 12.1.2.8
Use the odacli appliance
commands to perform lifecycle activities for the appliance.
Topics:
odacli create-appliance
command in a JSON file format to provision Oracle Database Appliance.odacli describe-appliance
command to display appliance details.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 |
---|---|
|
JSON input for appliance creation. |
|
(Optional) Displays JSON output. |
|
(Optional) Displays help for using the command. |
Use the odacli describe-appliance
command to display appliance details.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli describe-appliance [-j] [-h]
Parameters
Parameter | Description |
---|---|
|
(Optional) Displays JSON output. |
|
(Optional) Displays help for using the command. |
Example 10-8 Displaying Appliance Details
To display the appliance details:
# odacli describe-appliance Appliance Information ---------------------------------------------------------------- ID: 18911fba-dc46-499e-a565-ec52c8fe3b96 Platform: OdaliteS Data Disk Count: 2 CPU Core Count: 8 Created: July 22, 2016 12:07:12 PM SGT System Information ---------------------------------------------------------------- Name: rwsoda6s002 Domain Name: Time Zone: Asia/Singapore DB Edition: EE DNS Servers: 10.246.6.65 NTP Servers: Disk Group Information ---------------------------------------------------------------- DG Name Redundancy Percentage ----------- ------------- ------------ Data Normal 80 Reco Normal 20
Use the CPU Core commands to enable CPU cores and display current and historical CPU core configurations.
Topics:
odacli list-cpucores
command lists the history of core configuration changes in the system.odacli describe-cpucore
command to display the current core configuration and the modification date and time.odacli update-cpucore
command to enable the number of CPU cores in the system.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 |
---|---|
|
(Optional) Displays help for using the command. |
Example 10-9 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
Use the odacli describe-cpucore
command to display the current core configuration and the modification date and time.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli describe-cpucore [-h]
Parameters
Parameter | Description |
---|---|
|
(Optional) Displays help for using the command. |
Example 10-10 Displaying the Current Core Configuration
# odacli describe-cpucore Node Cores Modified Job Status ----- ------ ------------------------------ --------------- 0 8 July 25, 2016 9:39:59 AM SGT Configured
Use the odacli update-cpucore
command to enable the number of CPU cores in the system.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli update-cpucore -c cores [-h]
Parameters
Parameter | Description |
---|---|
|
Defines the number of cores to be enabled in the system. |
|
(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 10-11 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 }
Use the odacli database
commands to perform database lifecycle operations.
Topics:
odacli list-databases
command to list all databases on the appliance.odacli describe-database
command to display database details.odacli create-database
command to create a new database.odacli register-database
command to register a migrated database with the appliance.odacli delete-database
command to delete a database.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 |
---|---|
|
(Optional) Displays help for using the command. |
Example 10-12 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 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
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 |
---|---|
|
Identifies the database home identifier (ID) to display. Use the |
|
(Optional) Displays JSON output. |
|
(Optional) Displays help for using the command. |
Example 10-13 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: 12.1.0.2 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: Jun 14, 2016 6:21:14 PM
Use the odacli create-database
command to create a new database.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli create-database -n database_name -m -cs characterset -cl {OLTP|DSS|IMDB} -l dblanguage -s dbshape -r {ACFS|ASM} -dt dbterritory -y dbtype -ns nlscharacterset -d pdbadmin -p pdbname -v version [-u databaseUniqueName] [-dh Database Home ID] [-co dbconsole] [-c cdb] [-bi backupconfigid] [-io] [-j] [-h]
Parameters
Parameter | Description |
---|---|
|
Defines the password for To use non-interactive mode, use the |
|
(Optional) Defines the backup configuration identifier for future use. |
|
(Optional) Creates the database as a container database. The default is false. |
|
Defines the character set. The default is AL32UTF8. |
|
(Optional) Defines a unique name for the database. |
|
Defines the database class. The default is OLTP. The options are as follows:
|
|
(Optional) Enables the Database Console. The default is false. |
|
(Optional) Identifies the existing Database Home ID. |
|
Defines the database language. The default language is AMERICAN. |
|
Defines the name given to the new database ( |
|
Identifies the database shape (template). For example, odb1 and odb2. The default is |
|
Defines the Database Storage, either ACFS or ASM. The default value is ACFS. |
|
Defines the database territory. The default territory is AMERICA. |
|
Defines the database type. The default database type is SI. |
|
(Optional) Creates only the instance for standby. The default is false. |
|
(Optional) Displays JSON output. The default is false. |
|
Defines the NLS Character Set. The default is AL16UTF16. |
|
Defines the Pluggable Database (PDB) Admin User. |
|
Defines the Pluggable Database (PDB) name. The default value is |
|
Defines the database bundle patch number. To install the latest bundle patch for a release, specify 11.2.0.4 or 12.1.0.2. The default version is 12.1.0.2. To specify a specific supported bundle, use the 5 digit format. For example, (12.1.0.2.160419). |
|
(Optional) Displays help for using the command. |
Usage Notes
You cannot mix Oracle Database Standard Edition and Enterprise Edition databases on the same appliance.
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 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 is supported on both Oracle Automatic Storage Management (Oracle ASM) and Oracle ASM Cluster file system (ACFS). The default is Oracle ACFS.
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.
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 one of the following options to specify the adminpassword
:
Interactive mode: Use the -m
option and enter the password when prompted.
Non-interactive mode: Use the -hm
option and specify the adminpassword
in the command-line.
For the version, you can specify the database version, either 12.1.0.2 or 11.2.0.4, or you can use a 5 digit format to specify a specific patch bundle version. If you use the database version without specifying the bundle patch number, the latest bundle patch is used. The following values are supported:
12.1.0.2
12.1.0.2.160719
12.1.0.2.160419
11.2.0.4
11.2.0.4.160719
11.2.0.4.160419
Example 10-14 Creating a Database in Interactive Mode
This example creates an 12.1.0.2 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 true -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" : "August 08, 2016 03:54:03 AM EDT", "description" : "Database service creation with db name: hrdb", "updatedTime" : "August 08, 2016 03:54:03 AM EDT" }
Example 10-15 Creating a Database in Non-Interactive Mode
This example creates an 12.1.0.2 OLTP container database named crmdb
with shape odb2
and enables you to specify the password in the command-line. To define the password in the command-line, use the –hm
option and define the password.
# odacli create-database -n crmdb -hm WelCome__12 -cl OLTP -s odb2 { "jobId" : "30b5e2a6-493b-4461-98b8-78e9a15f8cdd", "status" : "Created", "message" : null, "reports" : [ ], "createTimestamp" : "August 08, 2016 03:59:22 AM EDT", "description" : "Database service creation with db name: crmdb", "updatedTime" : "August 08, 2016 03:59:22 AM EDT" }
Example 10-16 Creating a Database Against a Different Version
Either of the following statements creates a database against a home with July Database Bundle (160419) applied:
# odacli create-database -m -n hrmsdb1 -v 12.1.0.2 # odacli create-database -m -n hrmsdb2 -v 12.1.0.2.160719
The following statement creates a new database against a home with April PSU (160419):
# odacli create-database -m -n hrmsdb3 -v 12.1.0.2.160419
odacli register-database
command to register a migrated database with the appliance.File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli register-database -c [OLTP|DSS|IMDB] -a dbshape -t dbtypeSI -o hostname -sn servicename -p syspassword [-h]
Parameters
Parameter | Description |
---|---|
|
Specifies the database class. The database class setting determines the database SGA memory and instance PGA memory configuration. |
|
Determines the total memory allocated to the database. |
|
Defines the type of database. The database type is Single Instance. The default is SI. |
|
Defines the host name. Default : localhost |
|
Defines the Database Service Name. Using this service name, the EZCONNECT String is derived for connecting to the database. For example, The Port number is the port configured for the listener, as part of the deployment. |
|
Defines the proxy user password. |
|
(Optional) Displays help for using the command. |
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/welcome1@//hostname:1521/service name
To execute the command in non-interactive mode, use the hidden parameter -hp
to specify the password in the command line instead of using the -p
parameter to specify the password.
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 12c : 12.1.0.2
Oracle Database 11g : 11.2.0.4
Some init.ora
parameters are set, or reset, as part of the registration. Review the parameter changes before and after registration.
The following are examples of changes implemented as part of registration:
The memory_target
is reset.
The sga_target/pga_aggregate_target/log_buffer/inmemory_size
is configured based on the database class and database shape settings used during registration.
The registration process sets, or resets, the recommended appliance-specific parameters.
The database being registered must use Oracle Managed Files and the file location must match the DATA Location, REDO Location and RECO Location of the odacli describe-dbstorage
command.
As part of the registration process, the database is registered with Oracle Clusterware. Depending on the database role, the database is registered as Primary or Standby database with Oracle Clusterware.
Example 10-17 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" : "August 08, 2016 05:55:49 AM EDT", "description" : "Database service registration with db service name: crmdb.example.com", "updatedTime" : "August 08, 2016 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: August 8, 2016 5:55:49 AM EDT Message: Task Name Start Time ----------------------------- ------------------------------ restore control file August 8, 2016 5:55:49 AM EDT move spfile to right location August 8, 2016 5:56:08 AM EDT register DB with clusterware August 8, 2016 5:56:13 AM EDT reset db parameters August 8, 2016 5:57:05 AM EDT Running DataPatch August 8, 2016 5:57:36 AM EDT (Continued) End Time Status ------------------------------- -------- August 8, 2016 5:56:08 AM EDT Success August 8, 2016 5:56:13 AM EDT Success August 8, 2016 5:57:05 AM EDT Success August 8, 2016 5:57:36 AM EDT Success August 8, 2016 5:57:49 AM EDT Success
Use the odacli delete-database
command to delete a database.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
To delete a database:
odacli delete-database -i dbid [-h] [-j]
Parameters
Parameter | Description |
---|---|
|
Identifies the database home identifier (ID) to display. Use the |
|
(Optional) Displays help for using the command. |
|
(Optional) Displays JSON output. |
Usage
Note:
Thedelete-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 10-18 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
Use the odacli DBHome
commands to manage database Home operations.
Topics:
odacli list-dbhomes
command to display a list of Oracle Home directories.odacli describe-dbhome
command to display Oracle Database Home details.odacli create-dbhome
command to create an Oracle Database Home.odacli delete-dbhome
command to delete database home that is not associated with a database.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 [-v] [-h] [-j]
Parameters
Parameter | Description |
---|---|
|
(Optional) Displays help for using the command. |
|
(Optional) Displays JSON output. |
|
(Optional) Identifies the Database Home Version. |
Example 10-19 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
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 |
---|---|
|
Identifies the database home ID. Use the |
|
(Optional) Displays help for using the command. |
|
(Optional) Displays JSON output. The default is false. |
|
(Optional) Identifies the Database Home Version. Use the |
Example 10-20 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
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 |
---|---|
|
Defines the database bundle patch number. |
|
(Optional) Displays JSON output. |
|
(Optional) Displays help for using the command. |
Usage Notes
For the version number, you can specify the database version, either 12.1.0.2 or 11.2.0.4, or you can use a 5 digit format to specify a specific patch bundle version. For example, 12.1.0.2.160419. If you use the database version without specifying the bundle patch number, then the latest bundle patch is used.
The following values are supported:
12.1.0.2
12.1.0.2.160719
12.1.0.2.160419
11.2.0.4
11.2.0.4.160719
11.2.0.4.160419
Example 10-21 Creating an Oracle Database Home
The following example creates an Oracle Database Home version 12.1.0.2 that installs the latest version, 12.1.0.2.160719.
# odacli create-dbhome -v 12.1.0.2
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 |
---|---|
|
Identifies the database home using a database identifier (ID). |
|
(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 10-22 Deleting an Empty Database Home
# odacli delete-dbhome -i 0ce547ca-3df2-4178-a7e6-eefa613aeab4
Use the Database Storage commands to list, describe, create, and delete Oracle database storage.
Topics:
odacli list-dbstorages
command to display a list of all of the database storage configured in the appliance.odacli describe-dbstorage
command to display storage configuration details.odacli create-dbstorage
command to create the file system for database migrations.odacli delete-dbstorage
command to delete database storage that is not associated with a database.Use the odacli list-dbstorages
command to display a list of all of the database storage configured in the appliance.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
# odacli list-dbstorages [-h]
Parameters
Parameter | Description |
---|---|
|
(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 10-23 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
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 |
---|---|
|
Identifies the database storage. |
|
(Optional) Displays JSON output. The default is false. |
|
(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 10-24 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 10-25 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
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 |
---|---|
|
Defines the name of the database. |
|
(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. |
|
(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: |
|
(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: ACFS |
|
(Optional) Displays help for using the command. |
Usage Notes
The odacli create-dbstorage
command registers the storage metadata with the Appliance Manager.
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 10-26 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" }
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 |
---|---|
|
Identifies the database storage using a database identifier (ID). |
|
(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 10-27 Deleting Empty Database Storage
# odacli delete-dbstorage -i 9fe39332-cc1a-4b4b-8393-165524a6ef6b
Use the odacli list-jobs
and odacli describe-job
commands to display job details.
Topics:
odacli list-jobs
command to display a list of jobs, including the job IDs, status, and the job created date and time stamp.odacli describe-job
command to display details about a specific job, including the job ID, status, tasks, and the job created date and time stamp.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]
Parameters
Parameter | Description |
---|---|
|
(Optional) Displays JSON output. |
|
(Optional) Displays help for using the command. |
Example 10-28 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, 2016 10:19:23 AM (Continued) Status ------- Success
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 |
---|---|
|
Identifies the job. To get the job identifier (jobid), run the |
|
(Optional) Displays JSON output. |
|
(Optional) Displays help for using the command. |
Example 10-29 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
Use the odacli network
commands to list and describe network interfaces.
Topics:
odacli list-networks
command to display networks.odacli describe-network
command to display the details of a specific network.odacli create-network
command to create a network.odacli update-network
command to update an existing network configuration.odacli delete-network
command to delete a network.Use the odacli list-networks
command to display networks.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli list-networks [-j] [-h]
Parameters
Parameter | Description |
---|---|
|
(Optional) Displays JSON output. |
|
(Optional) Displays help for using the command. |
Example 10-30 Displaying a List of Networks
Use the odacli list-networks
command to display a list of networks:
# odacli list-networks ID Name NIC IP Address ------------------------------------ ---------------- ------- ------------ 7e3fd7e7-0975-4c74-9720-a01a2a7a838d Private-network priv0 192.0.2.1 e37b0ae9-1420-4e05-943b-7a8ee912cafb Public-network btbond1 10.20.30.100 (Continued) Subnet Mask Gateway ----------------- --------- 255.255.255.240 255.255.252.0 10.20.30.1
Use the odacli describe-network
command to display the details of a specific network.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
To display the details of a specific network:
odacli describe-network -i id [-j][-h]
Parameters
Parameter | Description |
---|---|
|
Identifies the network ID. Use the |
|
(Optional) Displays JSON output. |
|
(Optional) Displays help for using the command. |
Example 10-31 Displaying Network Details
Enter the following command to display the details of network ID 9e5ba92b-3f64-4ca7-9067-48be0952510a:
# odacli describe-network -i 9e5ba92b-3f64-4ca7-9067-48be0952510a Network details ---------------------------------------------------------------- ID: 9e5ba92b-3f64-4ca7-9067-48be0952510a Name: Public-network NIC: btbond1 IP Address: 192.0.2.1 Subnet Mask: 255.255.252.0 Gateway: 10.20.30.1 Type: Public Default: true Created: July 28, 2016 10:10:49 AM EDT
Use the odacli create-network
command to create a network.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli create-network -d defaultnetwork -n interface -p ipaddress -w {Public|Private|Dataguard|Backup|Other} -s subnetmask -g gateway [-j] [-h]
Parameters
Parameter | Description |
---|---|
|
Identifies the default network. |
|
Defines the network gateway. |
|
Defines the name of the network interface. |
|
Defines the network IP address. |
|
(Optional) Displays JSON output. |
|
Defines the type of network. Options are: {Public|Private|Dataguard|Backup|Other} |
|
Defines the Network Subnet Mask. |
|
(Optional) Displays help for using the command. |
Usage Notes
Use this command to create an additional network not done in create-appliance
.
You are only allowed to create a network on the bond interface.
Example 10-32 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
.
# odacli create-network -n sfpbond1 -p 192.0.2.15 -w Backup -s 255.255.255.0
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|Private|Dataguard|Backup|Other]] [-s network subnet mask] [-g network gateway] [-j] [-h]
Parameters
Parameter | Description |
---|---|
|
Defines the network identity. |
|
(Optional) Defines the network gateway. |
|
(Optional) Defines the network IP address. |
|
(Optional) Displays JSON output. |
|
(Optional) Defines the type of network. |
|
(Optional) Defines the Network Subnet Mask. |
|
(Optional) Displays help for using the command. |
Usage Notes
You cannot modify the Public and Private-interfaces after the system is deployed.
Example 10-33 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
Use the odacli delete-network
command to delete a network.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
To delete a network:
odacli delete-network -i id [-j] [-h]
Parameters
Parameter | Description |
---|---|
|
Defines the network identity. |
|
(Optional) Displays JSON output. |
|
(Optional) Displays help for using the command. |
Usage Notes
You cannot delete the Public-network or Private-network after the system is deployed.
Example 10-34 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" : "July 30, 2016 23:14:32 PM EDT", "endTime" : "July 30, 2016 23:14:32 PM EDT", "status" : "Running", "taskDescription" : null, "parentTaskId" : "TaskSequential_135", "jobId" : "c26d217e-419b-4a91-8680-7b06bcfe9828", "tags" : [ ], "reportLevel" : "Info", "updatedTime" : "July 30, 2016 23:14:32 PM EDT" },{ "taskId" : "TaskZJsonRpcExt_142", "taskName" : "Setting up Network", "taskResult" : "Network setup success", "startTime" : "July 30, 2016 23:14:32 PM EDT", "endTime" : "July 30, 2016 23:14:32 PM EDT", "status" : "Success", "taskDescription" : null, "parentTaskId" : "TaskParallel_141", "jobId" : "c26d217e-419b-4a91-8680-7b06bcfe9828", "tags" : [ ], "reportLevel" : "Info", "updatedTime" : "July 30, 2016 23:14:32 PM EDT" } ], "createTimestamp" : "July 30, 2016 23:14:32 PM EDT", "description" : "Network service delete", "updatedTime" : "July 30, 2016 23:14:32 PM EDT" }
Use the Oracle Auto Service Request (Oracle ASR) commands to configure, update, test, and delete Oracle ASR on the system.
Topics:
odacli configure-asr
command to configure Oracle Auto Service Request (Oracle ASR) after deploying the appliance.odacli update-asr
command to make changes to Oracle Auto Service Request (Oracle ASR) configuration details after deploying the appliance.odacli describe-asr
command to display Oracle Auto Service Request (Oracle ASR) configuration details.odacli test-asr
command to test the Oracle Auto Service Request (Oracle ASR) configuration.odacli delete-asr
command to remove the Oracle Auto Service Request (Oracle ASR) configuration from the system.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 [-r proxyserver] [-t proxyport] [-y proxyuser] [-ppwd proxypassword] [-s snmpversion] [-h]
Parameters
Parameter | Description |
---|---|
|
Defines the Oracle ASR user name. The user name is the My Oracle Support user name under which the server is registered. |
|
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. To use non-interactive mode, use the |
|
(Optional) Defines the Proxy Server Address. |
|
(Optional) Defines the proxy server port. |
|
(Optional) Defines the proxy user name needed to authenticate the proxy server. |
|
(Optional) Defines the proxy user password. |
|
(Optional) Defines Simple Network Management Protocol (SNMP) Version 2 or SNMP Version 3. The default is V3. |
|
(Optional) Displays help for using the command. |
Usage Notes
To execute the command in non-interactive mode and specify the password in the command-line itself, use the option -ha
instead of -a
.
All log files for Oracle ASR are located in the /var/opt/asrmanager/log/
directory.
Example 10-35 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 ---------------- ---------------- ----------------- ----------
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 [-r proxyserver] [-t proxyport] [-y proxyuser [-ppwd proxypassword] [-s snmpversion] [-h]
Parameters
Parameter | Description |
---|---|
|
Defines the Oracle ASR user name. The user name is the My Oracle Support user name under which the server is registered. |
|
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. To use non-interactive mode, use the |
|
(Optional) Defines the Proxy Server Address. |
|
(Optional) Defines the proxy server port. |
|
(Optional)Defines the proxy user name needed to authenticate the proxy server. |
|
(Optional) Defines the proxy user password. |
|
(Optional) Defines Simple Network Management Protocol (SNMP) Version 2 or SNMP Version 3. The default is V3. |
|
(Optional) Displays help for using the command. |
Usage Notes
You can define the password as a command- line argument or enter the password during Oracle ASR configuration. To support non-interactive mode and pass the password in the command-line, use the -ha
option instead of the -a
option.
All log files for Oracle ASR are located in the /var/opt/asrmanager/log/
directory.
Example 10-36 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 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 |
---|---|
|
(Optional) Displays help for using the command. |
Example 10-37 Displaying Oracle ASR Details
(Optional) Describe the example here.
# 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
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 |
---|---|
|
(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 10-38 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 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 |
---|---|
|
(Optional) Displays help for using the command. |
Example 10-39 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 }
Use the odaadmcli storage
commands to perform storage diagnostics.
Topics:
odaadmcli expand storage
command to expand storage.odaadmcli show disk
command to display the status of a single disk or of all disks on the system.odaadmcli show diskgroup
command to list configured diskgroups or display a specific diskgroup configuration.odaadmcli show controller
command to display details of the controller.odaadmcli show iraid
command to display details of the internal RAID sub-system.odaadmcli show raidsyncstatus
command to display the RAID SYNC status.odaadmcli show storage
command to show the storage controllers, expanders, and disks.odaadmcli stordiag
command to collect detailed information for each disk or NVMe.odaadmcli manage diagcollect
command to collect diagnostic logs for storage components.odaadmcli power
command to power a disk on or off.Use the odaadmcli expand storage
command to expand storage.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli
Syntax
To expand storage:
odaadmcli expand storage [-h]
Parameters
Parameter | Description |
---|---|
|
(Optional) Displays help for using the command. |
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 [-n] [-h]
Parameters
Parameter | Description |
---|---|
|
(Optional) Defines the disk resource name. The resource name format is |
|
(Optional) Displays help for using the command. |
Example 10-40 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 10-41 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 : X6_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
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. |
|
(Optional) Displays help for using the command. |
Example 10-42 Listing All Diskgroups
To list all diskgroups:# odaadmcli show diskgroup DiskGroups ---------- DATA RECO
Example 10-43 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
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 |
---|---|
|
Defines the controller. |
|
(Optional) Displays help for using the command. |
Example 10-44 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
Use the odaadmcli show iraid
command to display details of the internal RAID sub-system.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli
Syntax
To display details of the internal RAID subsystem:
odaadmcli show iraid [-h]
Parameters
Parameter | Description |
---|---|
|
(Optional) Displays help for using the command. |
Example 10-45 Displaying Details of the Internal RAID Sub-system
To display details of the internal RAID sub-system:
# odaadmcli show iraid NAME CTRL# PRODUCT SERIAL_NO BIOS_VER FW_VER IR_0_0_0 0 LSI MegaRAID 9361-8i SV52756042 6.17.04.2_4.16.08.00_0x06060A IR_0_0_1 0 LSI MegaRAID 9361-8i SV52756042 6.17.04.2_4.16.08.00_0x06060A VDISK_TYPE VDISK_STATE PDISK_MODEL 4.230.40-3739 RAID1 Optl MS4SC2JH2ORA480G 4.230.40-3739 RAID1 Optl MS4SC2JH2ORA480G EID:SLT PDISK_STATE SIZE CV_MODEL CV_STATE CV_TEMP 252:0 Onln 446.102 GB CVPM02 Optimal 25C 252:1 Onln 446.102 GB CVPM02 Optimal 25C
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 |
---|---|
|
(Optional) Displays help for using the command. |
Example 10-46 Displaying the RAID SYNC Status
To display the RAID SYNC details and status:
# odaadmcli show raidsyncstatus Raid Type Raid Device Raid Status maintainPdFailHistory Rebuildrate H/W Raid /dev/sda Optimal ON 30%
Use the odaadmcli show storage
command to show the storage controllers, expanders, and disks.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli
Syntax
To display the storage controllers, expanders, and disks:
odaadmcli show storage [-h]
To show storage errors:
odaadmcli show storage -errors [-h]
Parameters
Parameter | Description |
---|---|
|
(Optional) Shows storage errors. |
|
(Optional) Displays help for using the command. |
Example 10-47 Displaying Storage Devices
To display storage devices:
# odaadmcli show storage ==== BEGIN STORAGE DUMP ======== Host Description: Oracle Corporation:ORACLE SERVER X6-2 Total number of controllers: 2 Id = 0 Pci Slot = 10 Serial Num = S2LHNAAH101026 Vendor = Samsung Model = MS1PC2DD3ORA3.2T FwVers = KPYA7R3Q strId = nvme:19:00.00 Pci Address = 19:00.0 Id = 1 Pci Slot = 11 Serial Num = S2LHNAAH101008 Vendor = Samsung Model = MS1PC2DD3ORA3.2T FwVers = KPYA7R3Q strId = nvme:1b:00.00 Pci Address = 1b:00.0 Total number of expanders: 0 Total number of PDs: 2 /dev/nvme0n1 Samsung NVD 3200gb slot: 0 pci : 19 /dev/nvme1n1 Samsung NVD 3200gb slot: 1 pci : 1 ==== END STORAGE DUMP =========
Use the odaadmcli stordiag
command to collect detailed information for each disk or NVMe.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli
Syntax
To collect storage diagnostics for disks and NVM Express (NVMe):
odaadmcli stordiag n [-h]
Parameters
Parameter | Description |
---|---|
|
Defines the disk resource name. The resource name format is |
|
(Optional) Displays help for using the command. |
Example 10-48 Displaying NVMe Details
To display detailed information for NVMe pd_00
:
# odaadmcli stordiag pd_00
Use the odaadmcli manage diagcollect
command to collect diagnostic logs for storage components.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli
Syntax
To collect diagnostic logs for storage components:
odaadmcli manage diagcollect --storage [-h]
Parameters
Parameter | Description |
---|---|
|
Collects storage logs. |
|
(Optional) Displays help for using the command. |
Example 10-49 Collecting Storage Logs
# odaadmcli manage diagcollect --storage Logs are collected to : /opt/oracle/oak/log/rwsoda6s002/oakdiag/oakStorage-rwsoda6s002-20160607_1505.tar.gz
Use the odaadmcli power
command to power a disk on or off.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli
Syntax
To power a disk on or off:
odaadmcli power {on|off|status} disk_name [-h]
Parameters
Parameter | Description |
---|---|
disk_name |
Defines the disk resource name. The resource name format is pd_[0..3]. |
|
Power on a disk, power off a disk, display status. |
|
(Optional) Displays help for using the command. |
Example 10-50 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 10-51 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
Use the hardware monitoring
commands to display hardware configurations.
Topics:
odaadmcli show cooling
command to show cooling details.odaadmcli show env_hw
command to display information about the environment and hardware.odaadmcli show fs
command to display filesystem details.odaadmcli show memory
command to display memory details.odaadmcli show network
command to show network details.odaadmcli show power
command to display power supply details.odaadmcli show processor
command to display processor details.odaadmcli show server
command to display server details.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 |
---|---|
|
(Optional) Displays help for using the command. |
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 |
---|---|
|
(Optional) Displays help for using the command. |
Example 10-52 Displaying Environment and Hardware Details
To display the hardware details, enter odaadmcli show env_hw
. The results show a bare metal Oracle Database Appliance X6–2S system.
# odaadmcli show env_hw BM ODA_Lite X6-2 Small
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 |
---|---|
|
(Optional) Displays help for using the command. |
Example 10-53 Displaying Filesystem Details
# odaadmcli show fs Type Total Space Free Space Total DG Space Free DG Space Diskgroup Mount Point ext3 30237M 7763M - - / ext3 484M 416M - - /boot ext3 60475M 38149M - - /opt ext3 100793M 22060M - - /u01 acfs 102400M 102158M 4894016M 2418668M DATA /u02/app/oracle/oradata/ACFSDB1 acfs 102400M 100501M 4894016M 2418668M DATA /u02/app/oracle/oradata/ACFSDB2 acfs 102400M 100601M 4894016M 2418668M DATA /u02/app/oracle/oradata/EE12NCDB
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 |
---|---|
|
(Optional) Displays help for using the command. |
Example 10-54 Display Memory Details
# odaadmcli show memory NAME HEALTH HEALTH_DETAILS PART_NO. SERIAL_NO. LOCATION DIMM_0 OK - 3A4K40BB1-CRC 00CE01154602EADA96 P0/D0 DIMM_11 OK - 3A4K40BB1-CRC 00CE01154602EADADA P0/D1 DIMM_3 OK - 3A4K40BB1-CRC 00CE01154602EADBC7 P0/D3 DIMM_8 OK - 3A4K40BB1-CRC 00CE01154602EADBA0 P0/D8 (Continued) MANUFACTURER MEMORY_SIZE CURR_CLK_SPEED ECC_Errors Samsung 32 GB 2400 MHz 0 Samsung 32 GB 2400 MHz 0 Samsung 32 GB 2400 MHz 0 Samsung 32 GB 2400 MHz 0
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 |
---|---|
|
(Optional) Displays help for using the command. |
Example 10-55 Showing Network Details
# odaadmcli show network NAME HEALTH HEALTH_DETAILS LOCATION PART_NO MANUFACTURER Ethernet_NIC_0 OK - NET0 X540 INTEL Ethernet_NIC_1 OK - NET1 X540 INTEL Ethernet_NIC_2 - - NET2 X540 INTEL Ethernet_NIC_3 - - NET3 X540 INTEL (Continued) MAC_ADDRESS LINK_DETECTED DIE_TEMP 00:10:e0:95:98:ec yes (em1) 61.250 degree C 00:10:e0:95:98:ed yes (em2) 61.250 degree C 90:e2:ba:ae:1e:ad no (em4) - 90:e2:ba:ae:1e:ac no (em3) -
Use the odaadmcli show power
command to display power supply details.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli
Syntax
To show power supply details:
odaadmcli show power [-h]
Parameters
Parameter | Description |
---|---|
|
(Optional) Displays help for using the command. |
Example 10-56 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
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 |
---|---|
|
(Optional) Displays help for using the command. |
Example 10-57 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
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 |
---|---|
|
(Optional) Displays help for using the command. |
Example 10-58 Displaying Server Details
# odaadmcli show server Power State : On Open Problems : 0 Model : ORACLE SERVER X6-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 X6-2 Small 1606NM1s02 Locator Light : Off Actual Power Consumption : 135 watts Ambient Temperature : 24.250 degree C Open Problems Report : System is healthy
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]
To reset the oda-admin
user credentials in non-interactive mode:
odacli-adm set-credential --hp password --username username [-j] [-h]
Parameters
Parameter | Description |
---|---|
|
Agent password. The Agent password is needed to access the Oracle Appliance Manager Web Console. The default password is welcome1 . To define the password in non-interactive mode, use --hp instead of --password . |
|
User name required to access the Oracle Appliance Manager Web Console. The default user name is oda-admin . |
|
(Optional) Displays JSON output. |
|
(Optional) Displays help for using the command. |
Usage Notes
Only root
user can reset the oda-admin
user credentials.
Example 10-59 Resetting the oda-admin Password in Interactive Mode
To reset the oda-admin
user password to welcome2
in interactive mode:
# odacli-adm set-credential --password --username oda-admin Agent password: welcome2
Example 10-60 Resetting the oda-admin Password in Non-Interactive Mode
To reset the oda-admin
user password to welcome2
in non-interactive mode:
# odacli-adm set-credential --password welcome2 --username oda-admin