The command-line interface has different classes of tools to manage Oracle Database Appliance.
root
system privileges for most administration actions. You may want to use SUDO as part of your system auditing and security policy.configure
and update
commands to configure the appliance.odacli update
and apply patch
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.odacli OS
commands to list and update operating system (OS) parameters.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).hardware monitoring
commands to display hardware configurations.odaadmcli storage
commands to perform storage diagnostics.odacli-adm set-credential
command to change the oda-admin
user credentials.Three classes of tools are available to perform deployment, lifecycle management, and system administration on Oracle Database Appliance.
The command-line interface (CLI) is an alternative to Oracle Database Appliance Web Console for some appliance configuration and patching tasks, database management, and job activity.
Oracle Database Appliance uses a role-based command-line interface. Use the odacli
commands to perform lifecycle management tasks and the odaadmcli
commands to perform storage and hardware monitoring maintenance. Many tasks related to managing Oracle Databases are also required with databases on Oracle Database Appliance. Tasks common to Oracle Database generally are described in the Oracle Database documentation library. However, to simplify tasks, use the Oracle Database Appliance command-line interface. The odacli
and odaadmcli
utilities combine the capabilities of the SYS
database administrator role and the operating system Superuser (root
user). Always perform administrative tasks using the Oracle Database Appliance Web Console or CLI utilities.
The following classes of commands are available:
Deployment and Configuration: Use the deployment and configuration commands as part of the initial deployment of the appliance and to configure CPU cores.
Lifecycle management: Use odacli
commands to perform database and system administration tasks for the appliance. The odacli
commands are the primary interface to perform life cycle activities for the appliance.
Administration: Use odaadmcli
commands to perform hardware administration tasks for the appliance. The odaadmcli
commands are the interface for in-frequent administration activities needed to manage appliance hardware components, storage, and VLAN.
You can perform the following deployment and configuration tasks:
Configure the first network in the appliance
Unzip and copy the Oracle Database Appliance software to the correct locations
Set the number of CPU Cores for the system
You can perform the following appliance lifecycle tasks with odacli
commands:
Create and describe the appliance
Create, list, describe, and delete databases
Create, list, describe, and delete Oracle Database Homes
Create, list, and describe the networks
List and describe the jobs
You can perform the following appliance administration tasks with odaadmcli
commands:
Show storage, disks, diskgroups, and controllers
Display storage diagnostics for disks and NVM Express (NVMes)
Locate disks
Show server, memory, processor, power, cooling, and network details
Depending on your version of Oracle Appliance Manager and your hardware, some of the odacli
commands may not be available to you. To see which commands are supported on your version of Oracle Appliance Manager and your hardware, run the odacli
help command: odacli -h
.
Command-Line Interface Syntax
The command-line interface commands and parameters are case-sensitive.
An odacli
or odaadmcli
command 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 14-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
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.
See Also:
The SUDO man pages for more information about configuring and using SUDO:
Example 14-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/oak/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:
$ sudo odacli create database -db newdb INFO: 2015-08-05 14:40:55: Look at the logfile '/opt/oracle/oak/log/scaoda1011/tools/12.1.2.4.0/createdb_newdb_91715.log' for more details INFO: 2015-08-05 14:40:59: Database parameter file is not provided. Will be using default parameters for DB creation Please enter the 'SYSASM' password : Please re-enter the 'SYSASM' password: INFO: 2015-08-05 14:41:10: Installing a new home: OraDb12102_home3 at /u01/app/oracle/product/12.1.0.2/dbhome_3 Please select one of the following for Database type [1 .. 3]: 1 => OLTP 2 => DSS 3 => In-Memory
Example 14-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/oak/bin/odacli list-databases Sorry, user jdoe2 is not allowed to execute '/opt/oracle/oak/bin/odacli list-databases' as root on servernode1.
Use the configure
and update
commands to configure the appliance.
configure-firstnet
command to configure the first network in the appliance after racking and connecting the power and network cables.Use the configure-firstnet
command to configure the first network in the appliance after racking and connecting the power and network cables.
File Path
$ORACLE_HOME/opt/oracle/oak/bin/configure-firstnet
Syntax
# configure-firstnet
Example 14-4 Configuring the First Network
This command ensures that the system is available in the network, enabling you to manage the deployment through the Oracle Appliance Manager Web Console.
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.
Note:
On multi-node systems, you must run the command configure-firstnet
on both nodes.
The following is an example of the command on a single node platform:
# configure-firstnet Select the Interface to configure the network on (btbond1): btbond1 Configure DHCP on btbond1 (yes/no): no INFO: You have chosen Static configuration Enter the IP address to configure: 10.1.10.2 Enter the Netmask address to configure: 255.255.255.0 Enter the Gateway address to configure: 10.1.10.1 INFO: Plumbing the IPs now INFO: Restarting the network Shutting down interface btbond1: bonding: btbond1: Removing slave em2. bonding: btbond1: releasing active interface em2 bonding: btbond1: making interface em3 the new active one. bonding: btbond1: Removing slave em3. bonding: btbond1: releasing active interface em3 ::::::::::
Use the commands odacli update
and apply patch
to apply patches and update the appliance.
odacli describe-component
command to display the installed version and the latest available version for each component.odacli describe-latestpatch
command to display a list of the latest supported patch versions for each component.odacli update-dbhome
command to update a specific RDBMS Home to the latest patch bundle version.odacli update-dcsagent
command to update the agent.odacli update-repository
command to update the repository with the new Oracle Database Appliance software.odacli update-server
command to update the operating system, firmware, Oracle Appliance Kit, Oracle Clusterware, and all other infrastructure components.odacli update-storage
command to update the storage.Use the odacli describe-component
command to display the installed version and the latest available version for each component.
If there are multiple DB Homes installed in Oracle Database Appliance, then the output will display the version details for each of the installed homes. You can use this command to check the component version after applying a patch.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli describe-component [-d][-j][-h][-s][-v]
Parameters
Parameter | Description |
---|---|
--dbhomes , –d |
(Optional) Lists the database home versions and available versions. |
|
(Optional) Displays help for using the command. |
--json , -j |
(Optional) Displays JSON output. The default is false. |
--local |
(Optional) Describes the components for the local node. Use to display details on the local node of multi-node high availability (HA) systems. This option is not needed to display component details on single node systems. |
--node , –v |
(Optional) Describes the components for a specific node on multi-node high availability (HA) systems. This option is not needed to display component details on single node systems. {0|1} |
--server , –s |
(Optional) Lists the server components and versions and the available versions to which you can patch them. |
Usage Notes
Use the odacli describe-component
command to get component details. On a multi-node environment, such as Oracle Database Appliance X7-2-HA, the command provides details across all nodes. Use the --node
or --local
option to get component details for a specific node.
Example 14-5 Displaying Patch Details for Components
# odacli describe-component System Version --------------- 12.2.1.1.0 Component Installed Version Available Version ---------------------------------------- -------------------- -------------------- OAK 12.2.1.1.0 up-to-date GI 12.2.0.1.170814 up-to-date DB { [ OraDB12102_home1 ] 12.1.0.2.170814 up-to-date [ OraDB11204_home1 ] 11.2.0.4.170814 up-to-date } ILOM 4.0.0.22.r120818 up-to-date BIOS 41017100 up-to-date OS 6.8 up-to-date
Example 14-6 List DB Home Details
# odacli describe-component -d System Version --------------- 12.2.1.1.0 Component Installed Version Available Version ---------------------- -------------------- -------------------- DB { [ OraDB12201_home1 ] 12.2.0.1.170814 up-to-date [ OraDB12102_home1 ] 12.1.0.2.170814 up-to-date [ OraDB11204_home1 ] 11.2.0.4.170814 up-to-date }
Example 14-7 List the Server Components and Versions
# odacli describe-component -s System Version --------------- 12.2.1.1.0 Component Installed Version Available Version ---------------- -------------------- -------------------- OAK 12.2.1.1.0 up-to-date GI 12.2.0.1.170814 up-to-date ILOM 4.0.0.22.r119604 4.0.0.22.r120818 BIOS 41016500 41017100 OS 6.8 up-to-date
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 |
---|---|
|
(Optional) Displays help for using the command. |
--json , -j |
(Optional) Displays JSON output. The default is false. |
Example 14-8 Listing the Latest Supported Versions
# odacli describe-latestpatch componentType availableVersion --------------- -------------------- gi 12.1.0.2.170117 db 11.2.0.4.161018 db 12.1.0.2.170117 oak 12.1.2.10.0 ilom 3.2.8.24.114611 bios 39070000 os 6.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 -i dbhomeid -v version [-j] [-h]
Parameters
Parameter | Description |
---|---|
|
Defines the Oracle Database Home to update. |
|
(Optional) Displays help for using the command. |
|
(Optional) Displays JSON output. The default is false. |
--local , –v |
Updates the Database Home locally. |
--precheck , –v |
Analyzes the patch. |
|
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 version 12.2.1, bundle patch (BP) for Oracle Database version 12.1 and Oracle Database patch set update (PSU) for Oracle Database 11.2.0.4.x 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 14-9 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 12.2.1
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. |
|
(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 14-10 Updating the Agent
To update the dcs-agent
to version 12.2.1.1.012.1.2.10:
# odacli update-dcsagent -v 12.2.1.1.0 { "jobId" : "77e454d3-eb68-4130-a247-7633f8d6192b", "status" : "Created", "message" : null, "reports" : [ ], "createTimestamp" : "November 26, 2017 14:09:24 PM CST", "description" : "DcsAgent patching", "updatedTime" : "November 26, 2017 14:09:24 PM CST" }
Use the odacli update-repository
command to update the repository with the new Oracle Database Appliance software.
Prerequisites
Before updating the repository, you must upload the Oracle Database Appliance software to the appliance. If the patch contains more than one zip file, then extract and concatenate the zip files before updating the repository.
The following is an example of the steps to get the files from My Oracle Support, extract, and concatenate the files:
Note:
The file names in the examples and might not reflect actual file names.(Optional) Create a temporary directory in the /u01
directory. You will upload your Oracle Database Appliance software to this directory before adding the files to the update repository. You can use the existing /tmp
directory, but it might not have sufficient space for the zip files. It is a good practice to clean the /tmpdir
directory after you update the repository.
/u01/tmpdir
Download the Oracle Database Appliance software files from My Oracle Support, then upload the files to a temporary location in the /u01
directory in Oracle Database Appliance. For example:
p26433721_122110_Linux-x86-64_1of2.zip
and p26433721_122110_Linux-x86-64_2of2.zip
If the patch contains more than one zip file, then extract the zip files and concatenate the files into a single zip file. For example, a file named oda-sm-12.2.1.1.0-171031-server.zip
before updating the repository.
When inflated, the files are named oda-sm-12.2.1.1.0-171031-server_1of2.zippart
and oda-sm-12.2.1.1.0-171031-server_2of2.zippart
# cat oda-sm-12.2.1.1.0-171031-server_1of2.zippart oda-sm-12.2.1.1.0-171031-server_2of2.zippart > oda-sm-12.2.1.1.0-171031-server.zip
Concatenate the zip files into a single zip file. For example, a file named oda-sm-12.2.1.1.0-171031-server.zip
.
# cat oda-sm-12.2.1.1.0-171031-server_1of2.zippart oda-sm-12.2.1.1.0-171031-server_2of2.zippart > oda-sm-12.2.1.1.0-171031-server.zip
The file is named oda-sm-12.2.1.1.0-171031-server.zip
Use the concatenated zip file to update the repository
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
To unpack and copy the patch bundle to the correct locations in the file system:
odacli update-repository -f filename [-j] [-h]
Parameters
Parameter | Description |
---|---|
|
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. |
|
(Optional) Displays JSON output. The default is false. |
|
(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.
This command only updates the repository on the local node. On Oracle Database Appliance X7-2-HA, run the command on each node.
Example 14-11 Updating the Repository
The server patch zip file is located in the /u01/tmpdir
directory. The following example updates the repository with the latest server patch and then lists the job to verify that the update is successful:
# ./odacli update-repository -f /u01/tmpdir/oda-sm-12.2.1.1.0-171031-server.zip { "jobId" : "d3510276-da05-447b-990e-6d30964f8f79", "status" : "Created", "message" : "/u01/tmpdir/oda-sm-12.2.1.1.0-171031-server.zip", "reports" : [ ], "createTimestamp" : "November 8, 2017 14:13:45 AM CST", "description" : "Repository Update", "updatedTime" : "November 8, 2017 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 November 8, 2017 14:19:05 AM CST Success
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 |
---|---|
--local , –v |
Updates the Database Home locally. |
--precheck , –v |
Analyzes the patch. |
--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. |
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.
On Oracle Database Appliance X7-2-HA, you must run the command on both nodes.
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 14-12 Updating the Server
Run the odacli update-server command to update the server to version 12.2.1.1. On a multi-node HA system, you must run the command on both nodes to update the server version.
# odacli update-server -v 12.2.1.1 { "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" : "November 7, 2017 14:13:45 PM CST", "resourceList" : [ ], "description" : "Server Patching", "updatedTime" : "November 7, 2017 14:13:45 PM CST" }
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]
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. |
Usage Notes
Example 14-13 Updating the Storage
# odacli update-storage -v 12.2.1.1.0
Use the odacli appliance
commands to perform lifecycle activities for the appliance.
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 [-d|-no-d][-j][-h]
Parameters
Parameter | Description |
---|---|
|
(Optional) Displays the agent CLI build details. |
|
(Optional) Displays help for using the command. |
|
(Optional) Displays JSON output. |
|
(Optional) Displays no detailed information. Use this flag if you do not want to display details. |
Example 14-14 Displaying Appliance Details
# odacli describe-appliance -d Appliance Information ---------------------------------------------------------------- ID: 78e9a6b8-c4f8-42b2-9e72-7d23c2636544 Platform: OdaliteL Data Disk Count: 6 CPU Core Count: 20 Created: November 17, 2016 5:14:41 AM EST System Information ---------------------------------------------------------------- Name: rwsoda6f002 Domain Name: example.com Time Zone: America/New_York DB Edition: EE DNS Servers: 10.204.32.1 NTP Servers: 10.68.0.41 10.68.0.42 Disk Group Information ---------------------------------------------------------------- DG Name Redundancy Percentage ----------- ------------- ------------ Data High 80 Reco High 20
Use the odacli backup and recover commands to backup to and restore from Oracle Cloud Infrastructure Object Storage or disk.
Topics:
odacli create-backup
to create a Level 0, Level 1, or Longterm backup configuration.odacli create-backupconfig
to create a backup configuration.odacli create-objectstoreswift
to create and store the Oracle credential details required to backup to Oracle Object Store.odacli delete-backup
to delete backups.odacli delete-backupconfig
to delete a backup configuration.odacli delete-objectstoreswift
to delete the credentials for the ObjectStore account.odacli describe-backupreport
to display details of a specific backup report.odacli describe-schedule
to display details for a specific schedule.odacli irestore-database
to restore a database from one system to other system from ObjectStore based on a LongTerm BackupReport.odacli list-backupreports
to display a list of all backup reports.odacli list-backupconfig
to list a backup configuration.odacli list-objectstoreswifts
to display a list of credentials for the ObjectStore account.odacli list-schedules
to display a list of the scheduled backups.odacli list-schedule
to display details for a specific schedule.odacli recover-database
command to recover or restore a database from backup.odacli update-backupconfig
to create a backup configuration.odacli update-database
to associate a backup configuration to a database.odacli update-objectstoreswift
to change the credentials for the ObjectStore account.odacli update-schedule
to update the schedule for a database, or to disable the database backup schedule.Use the command odacli create-backup
to create a Level 0, Level 1, or Longterm backup configuration.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli create-backup -iDatabase Resource ID [-bt] [-c] [-h] [-j] [-k] [-t]
Parameters
Parameter | Description |
---|---|
--backupType , -bt {Regular-L0|Regular-L1|Longterm} |
Defines the type of backup. The options are not case sensitive. |
--component , -c {Database} |
(Optional) Defines the component. Database is the only supported option. |
--dbid , -i |
Defines the Database Resource ID. |
--help , -h |
(Optional) Displays help for using the command. |
--json , -j |
(Optional) Displays JSON output. The default is false. |
--keepDays , -k |
Defines the Keep Days. For Longterm Backup Type only. |
--tag , -t |
Defines the name of the backup. A tag is alphanumeric, up to 30 characters. Required for Longterm Backup Type. |
Usage Notes
Three types of backups are available:
Level 0: An RMAN incremental backup that backs up all data blocks in the data files being backed up. An incremental backup at level 0 is identical in content to a full backup, but unlike a full backup, the level 0 backup is part of an incremental backup strategy.
Level 1: An RMAN incremental backup that includes only those blocks that have been changed since the "parent" backup was taken. A parent backup can be either a level 0 or a level 1 backup.
Longterm: Longterm backups are only available when backing up to Oracle Cloud Infrastructure Object Storage (Oracle Object Storage).
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 14-15 Create a Manual 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
Use the command odacli create-backupconfig
to create a backup configuration.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli create-backupconfig -n backup configuration name -d backup destination{Disk|ObjectStore|None} [-c] [-cr] [-h] [-j] [-no-cr] [-o][-w]
Parameters
Parameter | Description |
---|---|
--backupdestination , –d {Disk|ObjectStore|None} |
Defines the backup destination. The options are not case sensitive. |
--container , -c |
(Optional) Defines the object store container. |
--crosscheck , -cr |
(Optional) Enable crosscheck. |
--help , -h |
(Optional) Displays help for using the command. |
--json , -j |
(Optional) Displays JSON output. The default is false. |
--name , -n |
Defines the backup configuration name. |
--no-crosscheck , -no-cr |
(Optional) Disable crosscheck. |
--objectstoreswiftId , -o |
(Optional) Defines the swift object store credential ID. |
--recoverywindow , -w Disk: {1-14} | ObjectStore: {1-31} |
(Optional) Defines the Recovery Window in days. {1-14} days for Disk and {1-31} days for Object Storage in the cloud. |
Usage Notes
The recovery window that is defined in the backup configuration determines when backups are considered obsolete. The following are guidelines:
Disk: 1-14 days
Object Storage: 1-31 days
Example 14-16 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
Use the command odacli create-objectstoreswift
to create and store the Oracle credential details required to backup to Oracle Object Store.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
# odacli create-objectstoreswift -e swift end point URL [-h] [-j] -n Object Store Swift name [-p] swiftpassword -t Object Store tenant name -u Object Store user name
Parameters
Parameter | Description |
---|---|
--endpointurl , –e |
Defines the swift end point URL. |
--help , -h |
(Optional) Displays help for using the command. |
--json , -j |
(Optional) Displays JSON output. The default is false. |
--name , -n |
Defines the Object Store Swift name. |
--swiftpassword , -p |
(Optional) Defines the Object Store Swift password. |
--tenantname , -t |
Defines the Object Store Swift tenant name. |
--username , -u |
Defines the Object Store Swift user name. |
Usage Notes
The command creates and stores the Oracle Cloud Infrastructure Object Storage credential details in the system and stores the password in an encrypted Oracle wallet. You can attach the credentials to one or more backup configurations.
The credentials are validated during the command odacli create-backupconfig
with objectstore
as the destination. The credentials are not validated against endpoint URL and tenancy.
Use the command odacli delete-backup
to delete backups.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli delete-backup -iDatabase Resource ID [-br] [-h] [-j]
Parameters
Parameter | Description |
---|---|
--backupreport , -br |
(Optional) Defines the backup report. To delete a Long Term backup, use a JSON input file for the backupreport. |
--dbid , -i |
Defines the Database Resource Identifier (ID). To delete a level 0 or level 1 backup, use the database resource ID. |
--help , -h |
(Optional) Displays help for using the command. |
--json , -j |
(Optional) Displays JSON output. The default is false. |
Usage Notes
Delete older, obsolete level 0 and level 1 backups with the Database Resource ID. The recovery window that is defined in the backup configuration determines when backups are considered obsolete.
Delete long term backups from Oracle Object Storage by using a JSON file with the --backupreport
option.
To locate the database ID, view the databases in the Web Console or use the command odacli list-databases
.
Example 14-17 Delete a Level 0 or Level 1 Backup
# odacli delete-backup -i20576eb1-bc32-4e34-bf97-fda0b60ca15b
Example 14-18 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
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 14-19 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
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 14-20 Deleting the Oracle Object Store Credentials
# odacli delete-objectstoreswift -i Object Store Swift id
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 14-21 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" }
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 14-22 Display Schedule Details
# odacli describe-schedule -i scheduleid
Use the command odacli irestore-database
to restore a database from one system to other system from ObjectStore based on a LongTerm BackupReport.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli recover-database -iDatabase Resource ID [-bp] [-r] [-cl] [-co] [-s] [-dr] [-y] [-h] [-j] [-c] [-oid] [-tp] [-tf]
Parameters
Parameter | Description |
---|---|
--backupPassword(s) , -bp |
(Optional) Defines the RMAN password for recovery. You can provide more than one password, but the passwords must be separated by a comma(,). |
--backupReport , -r |
JSON input for a backup report. |
--dbClass , -cl {EE: OLTP/DSS/IMDB, SE: OLTP} |
(Optional) Defines the Database class. |
--dbConsoleEnable , -co |
(Optional) Enables the Database Console. |
--dbShape , -s {odb1,odb2, and so on} |
(Optional) Defines the database shape. |
--dbStorage , -dr {ACFS|ASM} |
(Optional) Defines the database storage. Database Storage {ACFS|ASM} (non case-sensitive). The default is ASM. |
--dbType , -y |
(Optional) Defines the type of database. The default is single instance (SI). |
--help , -h |
(Optional) Displays help for using the command. |
--json , -j |
(Optional) Displays JSON output. The default is false. |
--noOfRmanChannels , -c |
(Optional) Defines the number of RMAN channels (parallelism) Default: SE Edition: 1, Other Enterprise Editions: 5 |
--objectStoreId , -oid |
Defines the Swift Object Store credential ID |
--sysPassword , -m |
Defines the password for the SYS user. |
--tdePassword , -tp |
(Optional) Defines the password for the TDE Wallet. |
--tdefilesLocation , -tf |
(Optional) Identifies the TDE Wallet location in Objectstore. |
Usage Notes
The command odacli irestore-database
restores a database to a system using the Backup Report of a long term backup that is in the Oracle Object Store. You can restore a database from one appliance to another appliance, or to the same appliance after the source database is deleted.
An Oracle wallet (ObjectStoreSwift credentials) must be created to access the backups in Oracle Object Store. This command performs the environment checks, validation checks, and tasks needed to restore a database to an Oracle Database Appliance system.
Example 14-23 Restoring a Database to the Same System
To restore to the same system, delete the source database, then use the backup report to restore.
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 14-24 Restoring a Database to a Different System
To restore to a different system, copy the backup report to the other machine's \bin
folder, 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
Related Topics
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 14-25 Display a List of all Backup Reports
# odacli list-backupreports
Use the command odacli list-backupconfig
to list a backup configuration.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli list-backupconfig [-h] [-j]
Parameters
Parameter | Description |
---|---|
--help , -h |
(Optional) Displays help for using the command. |
--json , -j |
(Optional) Displays JSON output. The default is false. |
Example 14-26 Displaying a List of Backup Configuration
Display a list of backup configurations.
# odacli list-backupconfig -d Disk -n production -w 14
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 14-27 Displaying a List of ObjectStore Swift Credentials
# odacli list-objectstoreswifts
Use the command odacli list-schedules
to display a list of the scheduled backups.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
# odacli list-schedules [-h] [-j]
Parameters
Parameter | Description |
---|---|
--help , -h |
(Optional) Displays help for using the command. |
--json , -j |
(Optional) Displays JSON output. The default is false. |
Usage Notes
The command lists all of the schedules in the system, including database backup schedules and some internal maintenance schedules.
Example 14-28 Display a List of Scheduled Database Backups
Display a list of all scheduled database backups and details.
# odacli list-schedules
Use the command odacli list-schedule
to display details for a specific schedule.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
# odacli describe-schedule [-e] [-h] [-j] [-i]
Parameters
Parameter | Description |
---|---|
--executionid , -e |
(Optional) Displays the execution ID. |
--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 14-29 Display a List of Executed Schedules
# odacli list-schedule
Use the odacli recover-database
command to recover or restore a database from backup.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli recover-database -iDatabase Resource ID [-br] [-i] [-h] [-j] [-r] [-t] [-p] [-s]
Parameters
Parameter | Description |
---|---|
--backupReport , -br {Regular-L0|Regular-L1|Longterm} |
(Optional) JSON input for a backup report. |
--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 datafile loss or controlfile loss.
Example 14-30 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 14-31 Recovering a Database to the Latest
# odacli recover-database -i b5fc646e-01a6-4c8b-8286-7633346c4 -t Latest -p
Example 14-32 Recovering a Database to an SCN
# odacli recover-database -i b5fc646e-01a6-4c8b-8286-7633346c4 -t SCN -s 392375947
Use the command odacli update-backupconfig
to create a backup configuration.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli update-backupconfig -n backup configuration name -d backup destination{Disk|ObjectStore|None} [-c] [-cr] [-h] [-j] [-no-cr] [-o][-w]
Parameters
Parameter | Description |
---|---|
--backupdestination , –d {Disk|ObjectStore|None} |
Defines the backup destination. The options are not case sensitive |
--container , -c |
(Optional) Defines the object store container. |
--crosscheck , -cr |
(Optional) Enable Crosscheck. |
--help , -h |
(Optional) Displays help for using the command. |
--json , -j |
(Optional) Displays JSON output. The default is false. |
--name , -n |
Defines the backup configuration name. |
--no-crosscheck , -no-cr |
(Optional) Disable crosscheck. |
--objectstoreswiftId , -o |
(Optional) Defines the swift object store credential ID. |
--recoverywindow , -w
Disk: {1-14} ObjectStore: {1-30} |
(Optional) Defines the Recovery Window in days. {1-14} days for Disk and {1-30} days for Object store. |
Usage Notes
The recovery window that is defined in the backup configuration determines when backups are considered obsolete. The following are guidelines:
Disk: 1-14 days
ObjectStore in Casper: 1-30 days
Example 14-33 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
Use the command odacli update-database
to associate a backup configuration to a database.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli update-database -bi backup configuration ID [-i database resource ID] [-h] [-j] [-hrp hidden RMAN backup password] [-rp RMAN backup password]
Parameters
Parameter | Description |
---|---|
--backupconfigid , -bi |
(Optional) Defines the Backup Config ID. |
--backupconfign , -bin |
(Optional) Defines the Backup Config Name. |
--dbid , -i |
Defines the Database Resource ID. |
--dbin , -in |
Defines the Database Name. |
--help , -h |
(Optional) Displays help for using the command. |
--json , -j |
(Optional) Displays JSON output. The default is false. |
--hiddenrmanbkuppassword , -hrp |
(Optional) Defines the Rman backup password. |
--rmanbkuppassword , -rp |
(Optional) Defines the RMAN backup password. |
Usage Notes
For backup to the Oracle Object Store, you can set an RMAN backup password. The password is encrypted and stored in an Oracle wallet. The password is used when using the command odacli create-backup
to create a database backup.
Example 14-34 Associating a Backup Configuration with a Database
# odacli update-database -i database resource ID -bi backup configuration ID -hrp hidden RMAN backup password
Example 14-35 Updating an Existing Database Using the Resource ID
Update an existing database to attach the backup configuration to the database using the Database Resource ID.
# odacli update-database -i d3c4d8f6-5eb7-4f9e-ab27-7bdd5013ac90 -bi 9d942e0a-ba00-4cbc-9bfb-0de83ed279e5 -bp
Example 14-36 Updating an Existing Database Using the Resource Name
Update an existing database to attach the backup configuration to the database using the Database Resource Name.
In the following example, the Database Resource Name is mydb
:
# odacli update-database -in mydb -bi 9d942e0a-ba00-4cbc-9bfb-0de83ed279e5 -bp
In the following example, the Database Resource Name is mydb
and the backup configuration name is mybcfg
:
# odacli update-database -in mydb -bin mybcfg -bp
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 14-37 Changing the Oracle Casper ObjectStore Password
# odacli update-objectstoreswift -i Object Store Swift id -p swift password
Example 14-38 Changing the Oracle ObjectStore User Name
# odacli update-objectstoreswift -i Object Store Swift id -u Object Store user name
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 14-39 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 * ? *
Example 14-40 Disable Scheduled Database Backups
# odacli update-schedule -i scheduleid -d
Use the CPU Core commands to enable CPU cores and display current and historical CPU core configurations.
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 14-41 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
/opt/oracle/dcs/bin/odacli
Syntax
odacli describe-cpucore [-h]
Parameters
Parameter | Description |
---|---|
|
(Optional) Displays help for using the command. |
Example 14-42 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 14-43 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.
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 upgrade-database
command to upgrade a database from version 11.2.0.4 to version 12.1.0.2 or 12.2.0.1.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 14-44 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 14-45 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] [-c|-no-c] [-co|-no-co] [-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. Use the |
|
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. Use the |
|
(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) and determines the total memory allocated to the database. For example, odb1 and odb2. The default is |
|
Defines the Database Storage, either Oracle ACFS or Oracle ASM. The default value is Oracle ASM. |
|
Defines the database territory. The default territory is AMERICA. |
|
Defines the database type. The default database type is SI. |
|
(Optional) Displays help for using the command. |
|
(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. |
|
(Optional) Displays JSON output. |
|
Defines the NLS National Character Set. The default is AL16UTF16. |
|
(Optional) Creates a database that is not a container database. Use this flag when you want to create a non-CDB database. Use the |
|
(Optional) Disables Database Console. Use the |
|
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.170814 or 11.2.0.4.170814. |
Usage Notes
Flash cache is disabled by default.
You cannot mix Oracle Database Standard Edition and Enterprise Edition databases on the same appliance.
Use the --cdb
or --no-cdb
flag to indicate whether or not the database is a container database. When neither flag is specified, the default database created is a non-CDB database.
When --dbhomeid
is not provided, the create-database
command creates a new Oracle Database Home.
When --dbhomeid
is provided, the create-database
command creates the database using the existing Oracle Home. Use the odacli list-dbhomes
command to obtain the dbhomeid
.
When you 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 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 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.2.0.1, 12.1.0.2 or 11.2.0.4, or you can use a 5 digit format to specify a specific patch bundle version. If you use the database version without specifying the bundle patch number, the latest bundle patch is used. The following values are supported:
12.2.0.1
12.2.0.1.171017
12.2.0.1.170814
12.1.0.2
12.1.0.2.171017
12.1.0.2.170718
12.1.0.2.170418
12.1.0.2.161018
12.1.0.2.160719
12.1.0.2.160419
11.2.0.4
11.2.0.4.171017
11.2.0.4.170718
11.2.0.4.170418
11.2.0.4.161018
11.2.0.4.160719
Note:
Oracle Database 11.2.0.4.160419 is not supported. Attempts to create an Oracle Database 11.2 against an 11.2.0.4.160419 database home will fail.Example 14-46 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 -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" : "November 26, 2017 03:54:03 AM EDT", "description" : "Database service creation with db name: hrdb", "updatedTime" : "November 26, 2017 03:54:03 AM EDT" }
Example 14-47 Creating a Database in Non-Interactive Mode
This example creates an 12.1.0.2 OLTP 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. Because the container database flag (-c
) is not used, the database created is not a container database.
# odacli create-database -n crmdb -hm WelCome__12 -cl OLTP -s odb2 { "jobId" : "30b5e2a6-493b-4461-98b8-78e9a15f8cdd", "status" : "Created", "message" : null, "reports" : [ ], "createTimestamp" : "November 26, 2017 03:59:22 AM EDT", "description" : "Database service creation with db name: crmdb", "updatedTime" : "November 26, 2017 03:59:22 AM EDT" }
Example 14-48 Creating a Database Against a Different Version
Either of the following statements creates a database against a home with Oracle Database Bundle (170718) applied:
# odacli create-database -m -n hrmsdb1 -v 12.1.0.2 # odacli create-database -m -n hrmsdb2 -v 12.1.0.2.170718
The following statement creates a new database against a home with Oracle Database Bundle patch 170814:
# odacli create-database -m -n hrmsdb3 -v 12.1.0.2.170814
Use the odacli register-database
command to register a migrated database with the appliance.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli register-database -c {OLTP|DSS|IMDB} -s dbshape -t dbtypeSI -o hostname -sn servicename -p syspassword[-bi backupconfigid] [-co|-no-co] [-h][-j]
Parameters
Parameter | Description |
---|---|
|
(Optional) Defines the backup configuration identifier for future use. |
|
Defines the database class. The database class setting determines the database SGA memory and instance PGA memory configuration. The options are as follows:
|
|
(Optional) Enables the Database Console. Use the |
|
Identifies the database shape (template) and determines the total memory allocated to the database. For example, odb1 and odb2. The default is |
|
Defines the type of database. The database type is Single Instance. The default is SI. |
|
(Optional) Displays help for using the command. |
|
Defines the host name. Default: local host name |
|
(Optional) Displays JSON output. |
|
(Optional) Disables Database Console. Use the |
|
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 for SYS. |
Usage Notes
Note:
It is a good practice to use Easy Connect (EZCONNECT) to test the database connectivity before registering the database.Log in as the sys
user and enter the following command:
sqlplus sys/password@//hostname:1521/service name
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 11 g : 11.2.0.4
Some init.ora
parameters are set, or reset, as part of the registration. Review the parameter changes before and after registration.
The following are examples of changes implemented as part of registration:
The memory_target
is reset.
The sga_target/pga_aggregate_target/log_buffer/inmemory_size
is configured based on the database class and database shape settings used during registration.
The registration process sets, or resets, the recommended appliance-specific parameters.
The database being registered must use Oracle Managed Files and the file location must match the DATA Location, REDO Location and RECO Location of the odacli describe-dbstorage
command.
As part of the registration process, the database is registered with Oracle Clusterware. Depending on the database role, the database is registered as Primary or Standby database with Oracle Clusterware.
If you are registering the database as a standby database, then open the database in read-only mode before executing the odacli register-database
command.
Example 14-49 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 upgrade-database
command to upgrade a database from version 11.2.0.4 to version 12.1.0.2 or 12.2.0.1.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
To upgrade an Oracle Database:
odacli upgrade-database -i Comma separated list of database ids -from source dbhome id -to destination dbhome id [-j] [-h]
Parameters
Parameter | Description |
---|---|
|
(Optional) Defines the Database IDs to upgrade. You can use a comma separated list of database IDs. |
|
The DB HOME ID of the destination database home. |
|
The DB HOME ID of the source database home. |
|
(Optional) Displays JSON output. The default is false. |
|
(Optional) Displays help for using the command. |
Usage Notes
You have the following options for defining the databases to upgrade:
When you define a single database ID, only the database of the source database home is upgraded.
When you define more than one database ID, only those databases of the source database home are upgraded.
When you do not define a database ID, all of the databases under the source database home are upgraded.
You can only upgrade from 11.2.0.4 to 12.1.0.2 or 12.2.0.1.
Example 14-50 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
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 14-51 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.
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 [-h] [-j]
Parameters
Parameter | Description |
---|---|
|
(Optional) Displays help for using the command. |
|
(Optional) Displays JSON output. |
Example 14-52 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 14-53 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.2.0.1, 12.1.0.2 or 11.2.0.4, or you can use a 5 digit format to specify a specific patch bundle version. For example, 12.1.0.2.161018. If you use the database version without specifying the bundle patch number, then the latest bundle patch is used.
The following values are supported:
12.2.0.1
12.2.0.1.170814
12.1.0.2
12.1.0.2.170718
12.1.0.2.170418
12.1.0.2.161018
12.1.0.2.160719
12.1.0.2.160419
11.2.0.4
11.2.0.4.170718
11.2.0.4.170418
11.2.0.4.161018
11.2.0.4.160719
Note:
Oracle Database 11.2.0.4.160419 is not supported. Attempts to create an Oracle Database 11.2 against an 11.2.0.4.160419 database home will fail.Example 14-54 Creating an Oracle Database Home
The following example creates an Oracle Database Home version 12.1.0.2.170718.
# odacli create-dbhome -v 12.1.0.2.170718
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 14-55 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.
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 14-56 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 14-57 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 14-58 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: ASM |
|
(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 14-59 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 14-60 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.
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.odacli list-scheduledExecutions
to display a list of jobs that were executed.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 14-61 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 14-62 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-scheduledExecutions
to display a list of jobs that were executed.File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odacli
Syntax
odacli list-scheduledExecutions [-j] [-h]
Parameters
Parameter | Description |
---|---|
--help , -h |
(Optional) Displays help for using the command. |
--json , -j |
(Optional) Displays JSON output. The default is false. |
Example 14-63 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-scheduledExecutions 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
Use the odacli network
commands to list and describe network interfaces.
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
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 14-64 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 14-65 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
$ORACLE_HOME/directory_name
Syntax
odacli create-network [-d|-no-d] -n interface -p ipaddress -w {Public|Private|Dataguard|Backup|Other} -s subnetmask -g gateway[-h] [-j]
Parameters
Parameter | Description |
---|---|
|
Identifies the default network. |
|
Defines the network gateway. The gateway is required for the default network. |
|
(Optional) Displays help for using the command. |
|
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} |
|
Identifies a network as not the default network. Use |
|
Defines the Network Subnet Mask. |
Usage Notes
Use this command to create an additional network not done in create-appliance
.
If you plumbed the initial network as a non-bonded interface, then you can create a second physical network. Breaking the bonded network when you plumb the initial network (configure first-net
), creates two physical network interfaces, em2 and em3. One of the interfaces is the public network, the second interface is available for you to create a network.
To use VLANs with Oracle Database Appliance, you must configure them before you deploy the appliance.
Example 14-66 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
Use the command odacli update-network
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 14-67 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 14-68 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.
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 asrpassword [-r proxyserver] [-t proxyport] [-y proxyuser] [-ppwd proxypassword] [-s snmpversion] -i[asrip] -e [internal|external] [-j] [-h]
Parameters
Parameter | Description |
---|---|
|
(Optional) Identifies the external Oracle ASR Manager IP address. |
|
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 |
|
Defines the Oracle ASR Configuration Type. The default is internal. |
|
(Optional) Displays help for using the command. |
|
(Optional) Displays JSON output. |
|
(Optional) Defines the proxy user password. |
|
(Optional) Defines the proxy server port. |
|
(Optional) Defines the Proxy Server Address. |
|
(Optional) Defines the proxy user name needed to authenticate the proxy server. |
|
(Optional) Defines Simple Network Management Protocol (SNMP) Version 2 or SNMP Version 3. The default is V2. |
|
Defines the Oracle ASR user name. The user name is the My Oracle Support user name under which the server is registered. |
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.
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 14-69 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 14-70 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 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 |
---|---|
|
(Optional) Identifies the external Oracle ASR Manager IP address. |
|
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 |
|
Defines the Oracle ASR Configuration Type. The default is internal. |
|
(Optional) Displays help for using the command. |
|
(Optional) Displays JSON output. |
|
(Optional) Defines the proxy user password. |
|
(Optional) Defines the proxy server port. |
|
(Optional) Defines the Proxy Server Address. |
|
(Optional) Defines the proxy user name needed to authenticate the proxy server. |
|
(Optional) Defines Simple Network Management Protocol (SNMP) Version 2 or SNMP Version 3. The default is v2. |
|
Defines the Oracle ASR user name. The user name is the My Oracle Support user name under which the server is registered. |
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.
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 14-71 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 14-72 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
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 14-73 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 14-74 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 odacli OS
commands to list and update operating system (OS) parameters.
odacli list-osconfigurations
to display the current HugePage and memlock values and view suggested values based on the total available space.odacli update-osconfigurations
to update the HugePage and memlock values.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.conf
files. Based on the total available space, suggested values are calculated for the parameters.
Example 14-75 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
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.conf
file 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 14-76 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
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 |
---|---|
|
(Optional) Displays help for using the command. |
Use the hardware monitoring
commands to display hardware configurations.
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 14-77 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 X7-2M system.
# odaadmcli show env_hw
BM ODA_Lite X7-2 Medium
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 14-78 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
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 14-79 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
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 14-80 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 14-81 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 14-82 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 14-83 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
Use the odaadmcli storage
commands to perform storage diagnostics.
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 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 disk
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
odaadmcli expand storage -ndisk number of disks to be added -enclosure {0|1} [-h]
Parameters
Parameter | Description |
---|---|
--enclosure {0|1} |
Defines the JBOD or shelf number. The base storage shelf is 0. The storage expansion shelf is 1. This option is only available for multi-node platforms. It is not supported on Oracle Database Appliance X7-2S and X7-2M single node platforms. |
--help , -h |
(Optional) Displays help for using the command. |
-ndisk |
Defines the number of disks to be added in the enclosure. |
Usage Notes
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 theexpand 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.The following storage options are available on single node platforms:
Oracle Database Appliance X7-2S platforms have fixed storage that cannot be expanded.
Oracle Database Appliance X7-2M platforms are configured with two (2) NVME disks. You can expand storage to five (5) or eight (8) NVME disks.
The following SSD storage options are available on multi-node Oracle Database Appliance X7-2-HA platforms:
Base configuration.
Base configuration plus five (5), 10, or 15 SSD disks.
Second storage shelf base configuration plus 15 SSD disks (fully populated). The base configuration must be fully populated before adding an expansion shelf. The expansion shelf must be fully populated.
The following HDD storage options are available on multi-node Oracle Database Appliance X7-2-HA platforms:
Base configuration.
Base configuration plus 15 HDD disks (fully populated).
Second storage shelf base configuration plus 24 HDD disks (fully populated). The base configuration must be fully populated before adding an expansion shelf. The expansion shelf must be fully populated.
Example 14-84 Adding Six NVMe Disks to a Single Node Platform
You can expand storage on Oracle Database Appliance X7-2M. In this example, five (5) NVMe disks are added to the platform.
# odaadmcli expand storage -ndisk 5
Example 14-85 Adding 15 SSD Disks to a Multi-Node Platform
The SSD disks are available in packs of 5 (5, 10, or 15). This example adds three 5 packs of SSD disks to the base configuration.
#odaadmcli expand storage -ndisk 15 -enclosure 0 Precheck passed. Successfully formatted 3.2TB SSD disks... Check the progress of expansion of storage by executing 'odaadmcli show disk' Waiting for expansion to finish ...
Example 14-86 Adding an SSD Storage Expansion Shelf to a Multi-Node Platform
In this example, the base configuration is fully populated and a fully populated expansion shelf of SSD disks is added.
# odaadmcli expand storage -ndisk 24 -enclosure 1 Precheck passed. Successfully formatted 3.2TB SSD disks... Check the progress of expansion of storage by executing 'odaadmcli show disk' Waiting for expansion to finish ...
Example 14-87 Adding an HDD Storage Expansion Shelf to a Multi-Node Platform
In this example, the base configuration is fully populated with SSD and 15 HDD disks, and a fully populated expansion shelf of HDD disks is added.
# odaadmcli expand storage -ndisk 24 -enclosure 1 Precheck passed. Successfully formatted 10TB HDD disks... Check the progress of expansion of storage by executing 'odaadmcli show disk' Waiting for expansion to finish ...
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 |
|
(Optional) Displays help for using the command. |
Example 14-88 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 14-89 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
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 14-90 Listing All Diskgroups
To list all diskgroups:# odaadmcli show diskgroup DiskGroups ---------- DATA RECO
Example 14-91 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 14-92 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 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 14-93 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 14-94 Displaying Storage Devices
The following example displays details about the storage devices on an appliance.
# odaadmcli show storage ==== BEGIN STORAGE DUMP ======== Host Description: Oracle Corporation:ORACLE SERVER X6-2 Total number of controllers: 2 Id = 0 Pci Slot = 10 Serial Num = S2LHNAAH101026 Vendor = Samsung Model = MS1PC2DD3ORA3.2T FwVers = KPYA7R3Q strId = nvme:19:00.00 Pci Address = 19:00.0 Id = 1 Pci Slot = 11 Serial Num = S2LHNAAH101008 Vendor = Samsung Model = MS1PC2DD3ORA3.2T FwVers = KPYA7R3Q strId = nvme:1b:00.00 Pci Address = 1b:00.0 Total number of expanders: 0 Total number of PDs: 2 /dev/nvme0n1 Samsung NVD 3200gb slot: 0 pci : 19 /dev/nvme1n1 Samsung NVD 3200gb slot: 1 pci : 1 ==== END STORAGE DUMP =========
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 14-95 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 14-96 Collecting Storage Logs
# odaadmcli manage diagcollect --storage Collecting storage log data. It will take a while, please wait... Collecting oak data. It will take a while, please wait... tar: Removing leading `/' from member names tar: /opt/oracle/oak/onecmd/tmp/OakCli-Command-Output.log: file changed as we read it Logs are collected to : /opt/oracle/oak/log/rwsoda6f002/oakdiag/oakStorage-rwsoda6f002-20161120_2217.tar.gz
Use the odaadmcli power disk
command to power a disk on or off.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli
Syntax
To power a disk on or off:
odaadmcli power disk {on|off|status} disk_name [-h]
Parameters
Parameter | Description |
---|---|
disk_name |
Defines the disk resource name. The resource name format is pd_[0..3]. |
|
Power on a disk, power off a disk, display status. |
|
(Optional) Displays help for using the command. |
Example 14-97 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 14-98 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 odaadmcli VLAN commands to list and manage virtual local area networks (VLANs) for Oracle Database Appliance bare metal platform.
Topics:
odaadmcli create vlan
command to create a virtual local area network (VLAN).odaadmcli delete vlan
command to delete a VLAN.odaadmcli show vlan
command to display a list of virtual local area networks (VLANs) and details.Use the odaadmcli create vlan
command to create a virtual local area network (VLAN).
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli
Syntax
odaadmcli create vlan vlanname -vlanid identifier -if {bond0|bond1} -node {0|1} -setuptype type {backup | management | public | custom} -ip address -netmask address -gateway address [–h] [–j]
Parameters
Parameter | Description |
---|---|
-gateway |
Defines the gateway address. Define the gateway as |
--help , -h |
(Optional) Displays help for using the command. |
-if {bond0|bond1} |
Defines the name of the interface on which the VLAN network is created. The options are bond0 or bond1. |
--json , -j |
(Optional) Displays JSON output. |
-netmask |
Defines the netmask address. |
-node {0|1} |
Defines the node for the VLAN. The options are 0 or 1. The default is 0. |
-setuptype {backup | management | public | custom} |
Defines the setup type. For example, management. The default is public. |
-vlanid |
Defines the VLAN identifier (ID) to which the VLAN network belongs. The VLAN ID must be unique for a single node platform. For a multi-node platform, you can use the same ID to create a network on Node0 and Node1. |
Usage Notes
Two physical ports, either copper or fiber, are bonded as bond0. When you create a VLAN, you create it on bond0 of a specific node, Node0 or Node1.
Use the odaadmcli show vlan
command to obtain the existing VLAN names and details.
When naming the VLAN, use a logical name for the network. The name must be unique in a given node. However, you can create the same named network on both Node0 and Node1 of a multi-node platform.
Because a virtual machine (VM) that resides on a shared repository can be started on either node, create a VLAN network with the same name on both nodes. If the needed network is not available, then the VM cannot be started on that node.
The supported setup types are as follows:
Backup: Configure for backup operations.
Management: Configure for management traffic, such as Oracle Enterprise Manager, and access to the management capabilities of a switch. You must provide an IP address and default gateway for the Management VLAN. A best practice is that the Management VLAN is not the primary VLAN (VLAN1) and does not carry user data traffic.
Public: Configure for the public access. This is the default public interface. Only one VLAN should be a public VLAN.
Custom: Configure for VLAN for other uses.
Dynamic Host Configuration Protocol (DHCP) is not supported.
Example 14-99 Creating a VLAN on Node0
Use the odaadmcli create vlan
command to create a VLAN named vlan105
on Node0:
# odaadmcli create vlan vlan105 -vlanid 105 -if bond0 -node 0 -setuptype management -ip 10.0.2.254 -netmask 255.255.0.0 -gateway 10.214.0.1 Created Vlan : vlan105
Example 14-100 Creating a VLAN on Node1
Use the odaadmcli create vlan
command to create a VLAN named vlan105
on Node1:
# odaadmcli create vlan vlan105 -vlanid 105 -if bond0 -node 1 -setuptype management -ip 10.0.2.254 -netmask 255.255.0.0 -gateway 10.214.0.1 Created Vlan : vlan105
Use the odaadmcli delete vlan
command to delete a VLAN.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli
Syntax
odaadmcli delete vlan vlanname -node {0|1} [–h]
Parameters
Parameter | Description |
---|---|
--help , -h |
(Optional) Displays help for using the command. |
--json , -j |
(Optional) Displays JSON output. |
-node {0|1} |
Defines the node for the VLAN. The options are 0 or 1. |
Usage Notes
Use the odaadmcli show vlan
command to obtain the VLAN name and node location.
Example 14-101 Deleting a VLAN
Use the odaadmcli delete vlan
command to delete a VLAN named vlan105
on Node0:
# odaadmcli delete vlan vlan105 -node 0 Deleted Vlan : vlan105
Example 14-102 Deleting a VLAN on Node1
Use the odaadmcli delete vlan
command to delete a VLAN named vlan105
on Node1:
# odaadmcli delete vlan vlan105 -node 1 Deleted Vlan : vlan105
Use the odaadmcli show vlan
command to display a list of virtual local area networks (VLANs) and details.
File Path
$ORACLE_HOME/opt/oracle/dcs/bin/odaadmcli
Syntax
odaadmcli show vlan [–h]
Parameters
Parameter | Description |
---|---|
--help , -h |
(Optional) Displays help for using the command. |
--json , -j |
(Optional) Displays JSON output. |
Example 14-103 Displaying VLANs
Use the odaadmcli show vlan
command to display a list of VLANs:
# odaadmcli show vlan NAME ID INTERFACE CONFIG_TYPE IP_ADDRESS NETMASK GATEWAY NODENUM vlan101 101 bond1 management 10.0.2.254 255.255.0.0 10.214.0.1 0 vlan101 101 bond1 management 10.0.2.254 255.255.0.0 10.214.0.1 1 vlan102 102 bond1 management 10.0.2.254 255.255.0.0 10.214.0.1 0 vlan102 102 bond1 management 10.0.2.254 255.255.0.0 10.214.0.1 1 vlan103 103 bond0 management 10.0.2.254 255.255.0.0 10.214.0.1 0 vlan103 103 bond0 management 10.0.2.254 255.255.0.0 10.214.0.1 1
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. 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 14-104 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
Example 14-105 Resetting the oda-admin Password in Non-Interactive Mode
To reset the oda-admin
user password to a new password in non-interactive mode:
# odacli-adm set-credential --password password --username oda-admin