This chapter describes the content and use of the Oracle Appliance Manager command-line interface, or the oakcli commands, also known as known as the Oracle Appliance Kit Command Line Interface, or OAKCLI. The current set of commands along with their syntax and usage notes are included, as well as examples of many of the commands. This chapter contains the following sections:
Oracle Appliance Manager Command-Line Interface Operational Notes
Oracle Appliance Manager Command-Line Interface Command Reference
Use Oracle Appliance Manager command-line interface to perform Oracle Database Appliance management tasks such deploying the software, configuring core keys, applying patches, monitoring and troubleshooting, managing virtual machines, and creating Oracle Database homes and databases. Specific tasks that you can complete with Oracle Appliance Manager command-line interface include:
Applying the core configuration key
Configuring the network for Oracle Database Appliance deployment
Copying the deployment configuration file
Deploying Oracle Database Appliance
Locating a disk on Oracle Database Appliance
Managing the Oracle Database Appliance repository
Managing the Oracle Database Appliance diagnostics collection
Updating Oracle Database Appliance
Unpacking packages into the Oracle Appliance Manager command-line interface repository
Validating Oracle Database Appliance
Depending on your version of Oracle Appliance Manager and your hardware, some of the commands described in this chapter may not be available to you. To see which Oracle Appliance Manager command-line interface commands are supported on your version of Oracle Appliance Manager and your hardware, enter the following command: oakcli -h.
Oracle Appliance Manager command-line interface is in the following directory:
/opt/oracle/oak/bin/oakcli
The root user account should have the oakcli environment variable defined as this directory's path name.
Oracle Database Appliance maintains logs of oakcli command output in the following directory.
/opt/oracle/oak/log/hostname/client/oakcli.log
Using Oracle Appliance Manager Command-Line Interface Help
Run the following command to see the usage information for all oakcli commands:
oakcli -h
Run the following command to see detailed help about a specific oakcli command:
oakcli command -h
Run the following command to see detailed help about a specific oakcli command's objects and its options:
oakcli command object -h
You should typically use Oracle Appliance Manager command-line interface when logged into Oracle Database Appliance as the root user. If you are not logged in as root, then you will be unable to complete particular tasks. For example, you could view storage information but not modify the storage configuration.
Oracle Appliance Manager command-line interface commands and parameters are not case sensitive. An oakcli command uses the following command syntax:
oakcli command object [parameters]
In oakcli syntax:
command is a verb such as show, locate, apply, and so on
object (also known as a noun) is the target or object on which the oakcli command performs the operation, such as a disk or controller. You can also use object abbreviations.
parameters extend the use of a preceding command combination to include additional options for the command. Parameter names are preceded with a dash, for example, -h, which is the help parameter available with every command.
The remainder of this chapter contains syntax and other details about the oakcli commands available in this release, sorted alphabetically as shown in the following table.
Table 4-1 Oracle Appliance Manager Command-Line Interface Commands
| Command | Description |
|---|---|
|
Adds a local disk to the system after physically replacing a failed disk. This command is available only for V1, X4-2, and X3-2. |
|
|
Reconfigures Oracle Database Appliance core capacity |
|
|
Clones virtual components |
|
|
Configures Oracle Database Appliance components |
|
|
Prepares a copy of the configuration file for use during deployment |
|
|
Creates Oracle Database Appliance components |
|
|
Removes Oracle Database Appliance components |
|
|
Deploys Oracle Database Appliance |
|
|
Manages disk write cache |
|
|
Imports a virtual machine template |
|
|
Locates a disk |
|
|
Collects diagnostic statistics and information, primarily for use when working with Oracle Support |
|
|
Add, updates, or removes a network from a virtual machine or template configuration |
|
|
Audits configuration settings |
|
|
Resizes the space used for an ACFS storage structure. |
|
|
Restarts ODA_BASE on the local node |
|
|
Displays information about various Oracle Database Appliance components |
|
|
Starts a Domain U or ODA_BASE virtual machine |
|
|
Stops a Domain U or ODA_BASE virtual machine |
|
|
Runs tests on a storage shelf or storage expansion shelf device |
|
|
Checks if Oracle Auto Service Request (Oracle ASR) is functioning properly |
|
|
Unpacks the given package to the Oracle Appliance Manager command-line interface repository |
|
|
Updates Oracle Database Appliance |
|
|
Upgrades one or more databases to a newer version |
|
|
Validates Oracle Database Appliance |
Use the oakcli add disk -local command to add a local disk to the system after physically replacing a failed disk.
oakcli add disk -local
You cannot add more than two disks per node.
The oakcli add disk -local command works only in bare metal deployments.
Use the oakcli apply command to reconfigure your Oracle Database Appliance core capacity.
Use the following syntax where core_config_key_file is the full path name of a configuration key file generated on My Oracle Support and copied to Oracle Database Appliance:
oakcli apply core_configuration_key core_config_key_file [-h]
Table 4-2 oakcli apply Command Parameters
| Parameter | Description |
|---|---|
|
|
Displays help |
|
|
Identifies the full path and name of the configuration key file |
Run the oakcli apply command from the first node in Oracle Database Appliance as root.
After you run the oakcli apply command, Oracle Database Appliance reboots both the nodes.
Reconfigure Oracle Database Appliance with a new core count using the configuration key file /tmp/set8cores.conf:
oakcli apply core_configuration_key /tmp/set8cores.conf ...................done INFO: Cluster will be rebooted after applying the core_configuration_key successfully INFO: .................................... INFO: Applying core_configuration_key on '192.0.2.21' INFO: ........................................................................ INFO: Running as root: /usr/bin/ssh -1 root 192.0.2.21 /tmp/tmp_lic_exec.pl INFO: Running as root: /usr/bin/ssh -1 root 192.0.2.21 /opt/oracle/oak/bin/oakcli enforce core_configuration_key /tmp/.lic_file INFO: Applying core_configuration_key on '192.0.2.20' INFO: ........................................................................ INFO: Running as root: /usr/bin/ssh -1 root 192.0.2.20 /tmp/tmp_lic_exec.pl INFO: Running as root: /usr/bin/ssh -1 root 192.0.2.20 /opt/oracle/oak/bin/oakcli enforce core_configuration_key /tmp/.lic_file INFO: Applying core_configuration_key on '192.0.2.20'
Use the oakcli clone command to clone virtual machines or virtual disks.
Table 4-3 oakcli clone Command Summary
| Command | Description |
|---|---|
|
Creates a clone of an existing virtual disk. |
|
|
Creates a clone or snapshot clone of an existing virtual machine. |
Use the oakcli clone vdisk command to create clones of virtual disks.
Use the following syntax for the oakcli clone vdisk command to create a clone of virtual disk:
oakcli clone vdisk new_vdisk_name -repo repo_name -src source_vdisk_name [-h]
where new_vdisk_name is the name given to the clone virtual disk, repo_name is the name of the repository source for the virtual disk being cloned, source_vdisk_name is the name of the virtual disk being cloned, and -h optionally displays the help usage for this command.
Clone a virtual disk named my_vdisk2 from an existing virtual disk named vdisk1 that is stored in the repository named vrepo1:
oakcli clone vdisk my_vdisk2 -repo vrepo1 -src vdisk1
Use the oakcli clone vm command to create clones and snap clones of virtual machines.
Use the following syntax for the oakcli clone vm command to create a virtual machine from a template:
oakcli clone vm vm_name -vmtemplate template_name -repo repo_name [-node 0|1]
Use the following syntax for the oakcli clone vm command to create a snapshot clone of an existing virtual machine:
oakcli clone vm vm_name -vm src_name -snap
Use the following syntax for the oakcli clone vm command to create a virtual machine snapshot from a template:
oakcli clone vm vm_name -vmtemplate template_name -snap
Table 4-4 oakcli clone vm Command Parameters and Variables
| Parameter | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Identifies the Oracle Database Appliance node that contains the shared repository from which the virtual machine is to be cloned. The -node parameter must be used when cloning from a shared repository and is invalid for non-shared repositories. |
|
|
src_name is the name of the virtual machine that is to be cloned. |
|
|
Creates a snapshot of the source virtual machine or virtual machine template. |
Create a virtual machine image named myol15u_test from the virtual machine template named myol15u which is stored in the Node 0 repository:
oakcli clone vm myol15u_test -vmtemplate myol5u -repo odarepo1
Create a virtual machine image named myol6u_test from the virtual machine template named myol6u_15gb1, which is stored in the shared repository named repo2 on Node 0:
oakcli clone vm myol6u_test -vmtemplate myol6u_15gb1 -repo repo2 -node 0
Use the oakcli configure command to configure components on Oracle Database Appliance.
Table 4-5 oakcli configure Command Summary
| Command | Description |
|---|---|
|
Configures Oracle Auto Service Request for Oracle Database Appliance |
|
|
Configures a CPU pool |
|
|
Configures initial network information |
|
|
Configures the network after either replacing a network card or swapping the public network from copper to fiber and vice versa |
|
|
Configures CPU core count, memory allocation, virtual local area networks for ODA_BASE |
|
|
Configure a shared repository by increasing its size |
|
|
Configures a virtual machine |
|
|
Configures a virtual machine template |
Use the oakcli configure asr command to configure Oracle Auto Service Request (Oracle ASR) on Oracle Database Appliance.
The oakcli configure asr command initiates an interactive script that requests the following information to implement Oracle ASR on your Oracle Database Appliance:
Action to be performed (internal or external install, deinstall, or reconfigure)
PROXY server name, port, user ID, and password
ASR user ID and password
ASR Manager IP and port
Use the oakcli configure cpupool command to configure a CPU pool on one Oracle Database Appliance Virtualized Platform node.
Table 4-6 oakcli configure cpupool Command Parameters
| Parameter | Description |
|---|---|
|
poolname |
Uniquely names the CPU pool. |
|
-numcpu cpu_count |
Defines the number of CPUs for the CPU pool. |
|
-node nodenum |
Defines the node where the CPU pool will be created (0 or 1). |
|
|
(Optional) Displays the help usage for this command. |
Use the oakcli configure firstnet command to configure an initial network on Oracle Database Appliance that enables you to download deployment software.
The following command creates an initial network on a new Oracle Database Appliance using the interactive script, as shown in the following:
oakcli configure firstnet Select the interface to configure network on [bond0 bond1 bond2 xbond0]:bond0 Configure DHCP on bond0?(yes/no):no INFO: Static configuration selected Enter the IP address to configure:192.0.2.18 Enter the netmask address to configure:255.255.252.0 Enter the gateway address to configure:192.0.2.1 Plumbing the IPs now Restarting the network :::::::::::::::::
Note:
Oracle recommends using theoakcli configure firstnet command only one time on Oracle Database Appliance. Subsequent use after configuring the initial network can cause unpredictable changes to your network settings.Use the oakcli configure network command to configure the network after either replacing a network card or swapping the public network from copper to fiber and vice versa. The meaning of the command changes depending on which parameter you use.
Table 4-7 oakcli configure network Command Parameters
| Parameter | Description |
|---|---|
|
|
Configures the network card after it has been replaced. You must run the |
|
|
Used to swap the public network from copper to fiber and vice versa. You must run the |
|
|
(Optional) Displays the help usage for this command. |
Use the oakcli configure oda_base command to change the CPU core count assigned to ODA_BASE or to add or remove virtual local area networks an initial network on Oracle Database Appliance that enables you to download deployment software.
To change the CPU core count assigned to ODA_BASE
To change the amount of memory assigned to ODA_BASE
To add virtual local area networks to ODA_BASE
To remove virtual local area networks to ODA_BASE
Change the CPU core count from six to eight in ODA_BASE:
# oakcli configure oda_base
Core Licensing Options:
1. 2 CPU Cores
2. 4 CPU Cores
3. 6 CPU Cores
4. 8 CPU Cores
5. 10 CPU Cores
6. 12 CPU Cores
Current CPU Cores :6
Selection[1 : 6](default 12 CPU Cores) : 4
ODA base domain memory in GB(min 8, max 88)(Current Memory 64G)[default
32] :
INFO: Using default memory size i.e. 32 GB
Additional vlan networks to be assigned to oda_base? (y/n) [n]:
Vlan network to be removed from oda_base (y/n) [n]
INFO: Node 0:Configured oda base pool
INFO: Node 1:Configured oda base pool
INFO: Node 0:ODA Base configured with new memory
INFO: Node 0:ODA Base configured with new vcpus
INFO: Changes will be incorporated after the domain is restarted on Node 0
INFO: Node 1:ODA Base configured with new memory
INFO: Node 1:ODA Base configured with new vcpus
INFO: Changes will be incorporated after the domain is restarted on Node 1
Use the oakcli configure repo command to increase the size of a shared repository.
Use the oakcli configure vm command to configure a virtual machine on Oracle Database Appliance Virtualized Platform.
oakcli configure vm name [-vcpu cpucount -maxvcpu maxcpu -cpuprio priority -cpucap cap -memory memsize -maxmemory max_memsize -os sys -keyboard lang -mouse mouse_type -domain dom -network netlist -autostart astart -disk disks -bootoption bootstrap -cpupool pool -prefnode 0|1 -failover true|false]
Table 4-8 oakcli configure vm Command Parameters
| Parameter | Description |
|---|---|
|
|
The name assigned to the virtual machine. |
|
|
Number of nodes assigned to the virtual machine. This number depends on your Oracle Database Appliance configuration:
|
|
|
Maximum number of CPUs that the virtual machine can consume. This number depends on your Oracle Database Appliance configuration:
|
|
|
Priority for CPU usage, where larger values have higher priority (1 - 256). |
|
|
Percentage of a CPU the virtual machine can receive (1 - 100). |
|
|
Amount of memory given to the virtual machine: (1-88)G or (1-90112)M. Default is M. |
|
|
Maximum amount of memory allowed for the virtual machine: (1-88)G or (1-90112)M. Default is M. |
|
|
Operating system used by the virtual machine (WIN_2003, WIN_2008, WIN_7, WIN_VISTA, OTHER_WIN, OL_4, OL_5, OL_6, RHL_4, RHL_5, RHL_6, LINUX_RECOVERY, OTHER_LINUX, SOLARIS_10, SOLARIS_11, OTHER_SOLARIS, or NONE). |
|
|
Keyboard used by virtual machine (en-us, ar, da, de, de-ch, en-gb, es, et, fi, fo, fr, fr-be, fr-ca, hr, hu, is, it, ja, lt, lv, mk, nl, n--be, no, pl, pt, pt-br, ru, sl, sv, th, or tr). |
|
|
Mouse type used by the virtual machine (OS_DEFAULT, PS2_MOUSE, USB_MOUSE, or USB_TABLET). |
|
|
Domain type from the following options:
|
|
|
MAC address and list of networks used by the virtual machine. |
|
|
Startup option for virtual machine (always, restore, or never). |
|
|
List of disks (slot, disktype, and content) used by virtual machine. |
|
|
Boot option used to bootstrap virtual machine (PXE, DISK, or CDROM). |
|
|
Assign the named CPU pool to virtual machine. |
|
|
Define the node, 0 or 1, where the virtual machine should attempt to start. This parameter is only valid for virtual machines created in shared repositories. |
|
|
Allow (use the keyword "true") or disallow (use the keyword "false") the virtual machine to start or restart on a node other than the node defined by the |
All of the parameters, except for name, are optional.
You must include at least one optional parameter for the command to work.
See Also:
Oracle VM Release 3.1 documentation athttp://docs.oracle.com/cd/E27300_01 for more information about the options in the preceding table. For example, see http://docs.oracle.com/cd/E27300_01/E27309/html/vmusg-ovm-vms.html for details about the -domain dom optionsUse the oakcli configure vmtemplate command to configure a virtual machine template on Oracle Database Appliance Virtualized Platform.
oakcli configure vmtemplate name [-vcpu cpucount -maxvcpu maxcpu -cpuprio priority -cpucap cap -memory memsize -maxmemory max_memsize -os sys -keyboard lang -mouse mouse_type -domain dom -network netlist -disk disks]
Table 4-9 oakcli configure vmtemplate Command Parameters
| Parameter | Description |
|---|---|
|
|
The name assigned to the virtual machine template. |
|
|
Number of nodes assigned to virtual machines cloned from the template.
|
|
|
Maximum number of CPUs that virtual machines cloned from the template can consume.
|
|
|
Priority for CPU usage, where larger values have higher priority (1 - 256). |
|
|
Percentage of a CPU that virtual machines cloned from the template can receive (1 - 100). |
|
|
Amount of memory given to virtual machines cloned from the template (1G - 88 G or 1M - 90112M). |
|
|
Maximum amount of memory allowed for virtual machines cloned from the template. |
|
|
Operating system used by virtual machines cloned from the template (WIN_2003, WIN_2008, WIN_7, WIN_VISTA, OTHER_WIN, OL_4, OL_5, OL_6, RHL_4, RHL_5, RHL_6, LINUX_RECOVERY, OTHER_LINUX, SOLARIS_10, SOLARIS_11, OTHER_SOLARIS, or NONE). |
|
|
Keyboard used by virtual machines cloned from the template (en-us, ar, da, de, de-ch, en-gb, es, et, fi, fo, fr, fr-be, fr-ca, hr, hu, is, it, ja, lt, lv, mk, nl, n--be, no, pl, pt, pt-br, ru, sl, sv, th, or tr). |
|
|
Mouse type used by virtual machines cloned from the template (OS_DEFAULT, PS2_MOUSE, USB_MOUSE, or USB_TABLET). |
|
|
Domain type from the following options:
|
|
|
MAC address and list of networks used by virtual machines cloned from the template. |
|
|
List of disks (slot, disktype, and content) used by virtual machines cloned from the template. |
All of the parameters, except for name, are optional.
You must include at least one optional parameter for the command to work.
See Also:
Oracle VM Release 3.1 documentation athttp://docs.oracle.com/cd/E27300_01 for more information about the options in the preceding table. For example, see http://docs.oracle.com/cd/E27300_01/E27309/html/vmusg-ovm-vms.html for details about the -domain dom optionsSet values for the following configuration values in the virtual machine template named myol5u7_10gb:
Number of CPUs assigned when the virtual machine starts up (vcpu)
Maximum number of CPUs that can be assigned to the virtual machine (maxvcpu)
Maximum percentage of a CPU's capacity that will be assigned to the virtual machine (cpucap)
Amount of memory assigned when the virtual machine starts up (memory)
Maximum amount of memory that can be assigned to the virtual machine (maxmemory)
Network used to access the virtual machine (network)
Operating system used by the virtual machine (os)
oakcli configure vmtemplate myol5u7_10gb -vcpu 2 -maxvcpu 4 -cpucap 40 -memory 1536M -maxmemory 2G -network "['type=netfront,bridge=net1']" -os OTHER_LINUX
Use the oakcli copy command to prepare a copy of the configuration file for use during the configuration of Oracle Database Appliance.
Run the oakcli copy command as follows, where absolute_conf_file is the full path name of an existing configuration file:
oakcli copy -conf absolute_conf_file [-h]
If you created a configuration file previously and copied this file to Oracle Database Appliance, then prepare the configuration file to be used during the configuration process. For example, if you copied the file myserver1.conf to /tmp, then enter the following command:
oakcli copy -conf /tmp/myserver1.conf
Use the oakcli create command to create components on Oracle Database Appliance.
Table 4-11 oakcli create Command Summary
| Command | Description |
|---|---|
|
Creates a new CPU pool |
|
|
Creates a new database |
|
|
Creates a new database home |
|
|
Creates a new ACFS storage structure |
|
|
Creates a database configuration file |
|
|
Creates a virtual local area network on a Oracle Database Appliance Virtualized Platform node |
|
|
Creates a snapshot database from an existing database |
|
|
Creates a virtual disk in a shared repository on Oracle Database Appliance Virtualized Platform |
|
|
Creates a virtual local area network on a Oracle Database Appliance Virtualized Platform node |
Use the oakcli create cpupool command to create a CPU pool on one Oracle Database Appliance Virtualized Platform node.
Table 4-12 oakcli configure cpupool Command Parameters
| Parameter | Description |
|---|---|
|
poolname |
Uniquely names the CPU pool. |
|
-numcpu cpu_count |
Defines the number of CPUs for the CPU pool. |
|
-node nodenum |
Defines the node where the CPU pool will be created (0 or 1). |
|
|
(Optional) Displays the help usage for this command. |
Use the oakcli create database command to create additional databases on Oracle Database Appliance.
When you run oakcli create database, the command prompts you for further inputs. See "Creating a new database showing prompts" in the Examples section.
oakcli create database -db db_name [[[-oh home] | [-version version]] [-params params_file] [-cdb]]
Table 4-13 oakcli create database Command Parameters
| Parameter | Description |
|---|---|
|
|
|
|
|
(Optional) |
|
|
(Optional) |
|
|
(Optional) |
|
|
(Optional) create the database as a container database |
The -oh and the -version parameters are mutually exclusive. Attempting to use both in the same command will generate an error.
When a database is created without identifying an Oracle Home, a new Oracle Home is created, using a standard naming convention, for example, OraDb11203_home3. The number at the end of the name is incremented by one for each new home created with the same version number.
When you upgrade the database, infrastructure, and Oracle Grid Infrastructure, you must specify an existing home to create a new database.
If you try to create a database using the option -version version before downloading and unpacking the the specific version DB clone files, then the command will fail.
You can create configuration files with the oakcli create db_config_params command.
The prompt "Do you want to keep the data files on FLASH storage: [ Y | N ] " is only shown if you choose the OLTP database type and if there is some free space available on flash storage. See "Improving I/O Performance for Database Files" for more information about this option.
Creating a new database showing prompts
When you run oakcli create database you are prompted for several inputs. The options listed for each input requested depend on the platform you run the command on. For example, Database Class options 9 and 10 are only available on Oracle Database Appliance X5-2.
oakcli create database -db mydb -oh OraDb12102_home1 Please enter the 'root' password : Please re-enter the 'root' password: Please enter the 'oracle' password : Please re-enter the 'oracle' password: Please enter the 'SYSASM' password : (During deployment we set the SYSASM password to 'welcome1'): Please re-enter the 'SYSASM' password: Please select one of the following for Database type [1 .. 3]: 1 => OLTP 2 => DSS 3 => In-Memory 1 Selected value is : OLTP Please select one of the following for Database Deployment [1 .. 3]: 1 => EE : Enterprise Edition 2 => RACONE 3 => RAC 3 Selected value is : RAC Do you want to keep the data files on FLASH storage: [ Y | N ]?N Specify the Database Class (1. odb-01 '1 core, 8 GB memory' 2. Others) [1]:2 Please select one of the following for Database Class [1 .. 10]: 1 => odb-01s ( 1 cores , 4 GB memory) 2 => odb-01 ( 1 cores , 8 GB memory) 3 => odb-02 ( 2 cores , 16 GB memory) 4 => odb-04 ( 4 cores , 32 GB memory) 5 => odb-06 ( 6 cores , 48 GB memory) 6 => odb-12 ( 12 cores , 96 GB memory) 7 => odb-16 ( 16 cores , 128 GB memory) 8 => odb-24 ( 24 cores , 192 GB memory) 9 => odb-32 ( 32 cores , 256 GB memory) 10 => odb-36 ( 36 cores , 256 GB memory)
Creating a new database in an existing Oracle Home
The following command creates a database called sales1 in OraDb11203_home2:
oakcli create database -db sales1 -oh OraDb11203_home2
Creating a new database from a template
The following command creates a database called sales2 from the salesdbtemplated.dbconf file (by appending the default file extension to the file name provided). The command also creates a new Oracle Home:
oakcli create database -db sales2 -params salesdbtemplate
Creating a new database as a container database
The following command creates a container database called sales3:
oakcli create database -db sales3 -version 12.1.0.2 -cdb
Use the oakcli create dbhome command to create a new database home on Oracle Database Appliance.
Use the oakcli create dbstorage command to create a storage structure for migrating databases from ASM to ACFS.
Table 4-15 oakcli create dbstorage Command Parameters
| Parameter | Description |
|---|---|
|
|
Set up the required ACFS storage structure for the database to be created called db_name |
|
-cdb |
Must be passed if you are creating a multitenant container database |
|
|
(Optional) Displays the help usage for this command |
The oakcli create dbstorage command requests user input to determine the size of the storage structure to create as shown in this example.
oakcli create dbstorage -db sales Please enter the 'root' password : Please re-enter the 'root' password: Please enter the 'oracle' password : Please re-enter the 'oracle' password: Please enter the 'SYSASM' password : (During deployment we set the SYSASM password to 'welcome1'): Please re-enter the 'SYSASM' password: Specify the Database Class (1. odb-01 '1 core, 8 GB memory' 2. Others) [1]:2 Please select one of the following for Database Class [1 .. 8] : 1 => odb-01s ( 1 cores , 4 GB memory) 2 => odb-01 ( 1 cores , 8 GB memory) 3 => odb-02 ( 2 cores , 16 GB memory) 4 => odb-04 ( 4 cores , 32 GB memory) 5 => odb-06 ( 6 cores , 48 GB memory) 6 => odb-12 ( 12 cores , 96 GB memory) 7 => odb-16 ( 16 cores , 128 GB memory) 8 => odb-24 ( 24 cores , 192 GB memory) Selected value is: odb-01s ( 1 cores , 4 GB memory) ...
Use the oakcli create db_config_params command to generate a database configuration file. The configuration file is created in /opt/oracle/oak/install/dbconf and is given the default extension .dbconf.
The following command creates the database parameter file /opt/oracle/oak/install/dbconf/newconf.dbconf:
# oakcli create db_config_params -conf newconf Please select one of the following for Database Block Size [1 .. 4]: 1 ==> 4096 2 ==> 8192 3 ==> 16384 4 ==> 32768 2 Selected value is: 8192 Specify the Database Language (1. AMERICAN 2. Others) [1]: Selected value is: AMERICAN Specify the Database Characterset (1. AL32UTF8 2. Others) [1]:2 Please select one of the following for Database Characterset [0 .. 10] : 0 => Others 1 => AL32UTF8 2 => AR8ADOS710 3 => AR8ADOS710T 4 => AR8ADOS720 5 => AR8ADOS720T 6 => AR8APTEC715 7 => AR8APTEC715T 8 => AR8ARABICMACS 9 => AR8ASMO708PLUS 10 => AR8ASMO8X 1 Selected value is: AL32UTF8 Specify the Database Territory (1. AMERICA 2. Others) [1]:2 Please select one of the following for Database Territory [0 .. 10] : 0 => Others 1 => ALBANIA 2 => ALGERIA 3 => AMERICA 4 => ARGENTINA 5 => AUSTRALIA 6 => AUSTRIA 7 => AZERBAIJAN 8 => BAHRAIN 9 => BANGLADESH 10 => BELARUS 3 Selected value is: AMERICA Specify the Component Language (1. en 2. Others) [1]:2 Please select one of the following for Component Language [0 .. 10] : 0 => Others 1 => en : English 2 => fr : French 3 => ar : Arabic 4 => bn : Bengali 5 => pt_BR : Brazilian Portuguese 6 => bg : Bulgarian 7 => fr_CA : Canadian French 8 => ca : Catalan 9 => hr : Croatian 10 => cs : Czech 1 Selected value is: en Successfully generated the Database parameter file 'newconf'
Use the oakcli create repo command to create a new shared repository on Oracle Database Appliance Virtualized Platform.
oakcli create repo repo_name -size size [M|G] -dg DATA|RECO -h
where repo_name is the name assigned to the shared repository and the parameters are described in the following table (Table 4-17).
Table 4-17 oakcli create repo Command Parameters
| Parameter | Description |
|---|---|
|
|
The amount of storage to be assigned to the shared repository which can be defined as megabytes, with the M option or in gigabytes with the G option. |
|
|
The ASM disk group in which the shared repository is to be stored, either the DATA+ disk group or the RECO+ disk group, selected by using the DATA or RECO option respectively. |
|
|
(Optional) Displays the help usage for this command. |
The -size parameter requires a whole number for size.
The minimum value for size is 500 when M is used or 1 when G is used for the sizing unit.
The default sizing unit for size is G (gigabytes).
A shared repository should only be used for the virtual machine and not as a file staging area. Avoid copying or moving files into a shared repository.
Use the oakcli create snapshotdb command to create a snapshot database from an existing database.
oakcli create snapshotdb [-db snap_dbname -from dbname] | [-h]
where snap_dbname is the name of the snapshot database to be created, dbname is the name of the source database and the parameters are described in the following table (Table 4-18).
Table 4-18 oakcli create snapshotdb Command Parameters
| Parameter | Description |
|---|---|
|
|
This parameter precedes the name to be given to the new snapshot database. |
|
|
This parameter precedes the name of the database from which the snapshot database is to be built. |
|
|
(Optional) Displays the help usage for this command. |
Use the oakcli create vdisk command to create a new virtual disk in a shared repository on Oracle Database Appliance Virtualized Platform.
oakcli create vdisk vdisk_name -repo repository_name -size size -type shared|local -h
where vdisk_name is the name assigned to the virtual disk that is unique within the name repository and the parameters are described in the following table (Table 4-20).
Table 4-19 oakcli create vdisk Command Parameters
| Parameter | Description |
|---|---|
|
|
|
|
|
|
|
|
Sets the option of allowing the virtual disk to be shared by more than one virtual machine ( |
|
|
(Optional) Displays the help usage for this command. |
Use the oakcli create vlan command to create a new virtual local area network (VLAN) on an Oracle Database Appliance Virtualized Platform node.
oakcli create vlan vlan_name -vlanid tag_id -if interface_name -node 0|1 -h
where vlan_name is the name assigned to the VLAN and the parameters are described in the following table (Table 4-20).
Table 4-20 oakcli create vlan Command Parameters
| Parameter | Description |
|---|---|
|
|
|
|
|
|
|
|
The node on which the VLAN is created, either 1 or 2. |
|
|
(Optional) Displays the help usage for this command. |
The following command creates a VLAN named sample10 on Node 1 using the bond1 interface and a tag with the number 10:
oakcli create vlan sample10 -vlanid 10 -if bond1 -node 1
The following command creates the same VLAN as Example 1 (named sample10) on Node 0:
oakcli create vlan sample10 -vlanid 10 -if bond1 -node 0
Use the oakcli delete command to delete components from Oracle Database Appliance.
Table 4-21 oakcli delete Command Summary
| Command | Description |
|---|---|
|
Deletes an existing CPU pool |
|
|
Removes an existing database |
|
|
Deletes an existing database home |
|
|
Deletes an ACFS storage structure |
|
|
Deletes a database configuration file |
|
|
Deletes an existing shared repository |
|
|
Deletes a virtual disk from a shared repository |
|
|
Deletes an existing virtual machine |
|
|
Deletes an existing virtual machine |
|
|
Deletes an existing VM template |
Use the oakcli delete cpupool command to delete a CPU pool from one Oracle Database Appliance Virtualized Platform node.
Use the oakcli delete database command to delete a database from Oracle Database Appliance.
Use the oakcli delete dbhome command to delete a database home from Oracle Database Appliance.
Use the oakcli delete dbstorage command to delete a storage structure that was created for the purpose of migrating databases from ASM to ACFS. For example, run this command if you created a storage structure using create dbstorage that is no longer required.
Use the oakcli delete db_config_params command to delete a database configuration file.
Use the oakcli delete repo command to remove a shared repository.
Use the oakcli delete vdisk command to remove a virtual disk from a shared repository on Oracle Database Appliance Virtualized Platform.
Use the oakcli delete vlan command to remove a virtual local area network.
Use the following syntax for the oakcli delete vlan command:
oakcli delete vlan vlan_name -node node_number [-h]
Table 4-26 oakcli delete vm Command Parameters
| Parameter | Description |
|---|---|
|
|
|
|
|
|
|
|
(Optional) Displays the help text. |
Use the oakcli delete vm command to remove a virtual machine.
Use the following syntax for the oakcli delete vm command:
oakcli delete vm vm_name [-server node_number] [-h]
Table 4-27 oakcli delete vm Command Parameters
| Parameter | Description |
|---|---|
|
|
(Optional) |
|
|
|
|
|
(Optional) Displays the help text. |
Use the oakcli delete vmtemplate command to remove a virtual machine template.
Use the following syntax for the oakcli delete vmtemplate command:
oakcli delete vmtemplate template_name [-server=node_number][-h]
Table 4-28 oakcli delete vmtemplate Command Parameters
| Parameter | Description |
|---|---|
|
|
|
|
|
|
|
|
(Optional) Displays the help text. |
Use the oakcli deploy command to deploy Oracle Grid Infrastructure for a cluster on Oracle Database Appliance.
Use the following syntax for the oakcli deploy command:
oakcli deploy [config] [-conf config_file] [-advance][-h]
Table 4-29 oakcli deploy Command Parameters
| Parameter | Description |
|---|---|
|
|
(Optional) Runs the Oracle Appliance Manager Configurator. |
|
|
(Optional) Preloads the configuration stored in the named configuration file, |
|
-advance |
(Optional) Performs the deployment, or runs the deployment configurator, in advance mode. |
|
-h |
Optional) Displays the help text. |
Use the oakcli diskwritecache command to locate disks with write cache enabled and to disable disk write cache for those disks. Enabled write caches should be disabled as soon as downtime for Oracle Database Appliance can be scheduled. During the downtime, use this command with the disable option for each disk in turn that has an enabled write cache.
Use the oakcli import vmtemplate command to import virtual machine templates.
Use the following syntax for the oakcli import vmtemplate command:
oakcli import vmtemplate vmtemplatename -files image_files | -assembly assembly_file -repo repo_name [- node 0 | 1 ]
Table 4-30 oakcli import vmtemplate Command Parameters
| Parameter | Description |
|---|---|
|
|
|
|
|
Use the |
|
|
|
|
-assembly |
Use the |
|
|
|
|
|
|
|
|
Use the |
Include only one of the options, -files or -assembly, each time you run this command. You cannot include both of these options in the same statement.
If the command imports more than one template from an assembly, then each template will automatically be given a unique name. These template names will include the name given in the vmtemplate vmtemplatename clause followed by a sequence number, such as vmtemplatename1, vmtemplatename2, vmtemplatename3, and so on.
When importing into a shared repository, you must include the -node option with a valid node number, 0 or 1. Using the -node option for imports into non-shared repositories will cause the command to fail.
The following command imports the required template (OVM_OL5U7_X86_64_PVM_10GB.tgz) from the /OVS directory in Dom0 into the odarepo1 repository:
oakcli import vmtemplate OL5U7 -files /OVS/OVM_OL5U7_X86_64_PVM_10GB.tgz -repo odarepo1
The following command imports a template from a remote server using a URL to identify the server and the template file:
oakcli import vmtemplate OL5U6 -files 'http://example.com/vm-template/OEL-5/OVM_OL5U6_X86_64_PVM_10GB.tgz' -repo odarepo2
The following command imports the templates contained in the assembly stored on a remote server at the URL provided:
oakcli import vmtemplate OL6U1 -assembly 'http://example.com/assemblies/OEL6/OVM_OL6U1_x86_PVHVM.ova' -repo odarepo1
The following command imports the templates contained in the assembly stored on a remote server at the URL provided into a shared repository named repo4 on Node 1:
oakcli import vmtemplate OL6U1 -assembly 'http://example.com/assemblies/OEL6/OVM_OL6U1_x86_PVHVM.ova' -repo repo4 -node 1
The oakcli locate command helps you locate the physical disk that is associated with a named Oracle Automatic Storage Management disk by turning on (or off) the disk's LED light.
Use the following oakcli locate command syntax where diskname is the name of the ASM disk that you want to locate:
oakcli locate disk diskname on|off
Use the oakcli manage diagcollect command to collect diagnostic information about your Oracle Database Appliance for troubleshooting purposes, and for working with Oracle Support.
oakcli manage diagcollect [--all | --crs [--crshome crs_home_dir] [--core] | --install | --chmos [--incidenttime time [--incidentduration time] | --adr adr_location [--afterdate date] [--aftertime time] [--beforetime time] ] [excl comp1,comp2,...] [--clean] [--storage]
Table 4-32 oakcli manage diagcollect Command Parameters
attach virtual disks to or detach virtual disks from virtual machines
transmit first-boot installation configuration messages to virtual machines
assign networks to or delete networks from virtual machines and virtual machine templates
Use the following oakcli modify command syntax to modify a virtual machine or virtual machine template:
oakcli modify [vm vmname [-attachvdisk vdisk_name | -detachvdisk vdisk_name | -s key1:value1;key2:value2;...]] | [[vm vmname | vmtemplate vmtemplatename] [-addnetwork network | -deletenetwork network]] [-h]
where name is the vmname of the virtual machine or vmtemplatename is the virtual machine template being modified and the objects and parameters are described in the following table, Table 4-33.
Table 4-33 oakcli modify Command Objects and Parameters
| Parameter | Description |
|---|---|
|
|
Attaches the named virtual disk to the named virtual machine. |
|
|
Detaches the named virtual disk from the named virtual machine. |
|
|
Identifies a message consisting of one or more key/value pairs to send to the ovmd utility, where each key and value is separated by a colon (:) and each key/value pair is separated from the next key/value pair by a semicolon (;). |
|
|
Identifies a new network to be assigned to the named virtual machine or template. |
|
|
Identifies the network to be deleted from the named virtual machine or template. |
|
|
(Optional) Displays the help text. |
The vmtemplate object is valid with only the -addnetwork or -deletenetwork parameters.
Do not use the -attachvdisk or the -detachvdisk option with the -addnetwork, -deletenetwork, or -s parameters.
Include only one of the -addnetwork, -deletenetwork, or -s parameters when you use this command.
The following command replaces the network assigned to the gc_11g virtual machine template with the net1 network:
oakcli modify vmtemplate gc_11g -addnetwork net1
The following command updates the root user password for the gc_11g virtual machine:
oakcli modify vm gc_11g -s "com.oracle.linux.root-password:root123"
Use the oakcli orachk command to audit configuration settings with the ORAchk utility.
oakcli orachk [-abvhpfm[u -o][o]ct] [-clusternodes list | -localonly] [-debug] [-dbnames list |-dbnone | -dball] [upgrade]
Table 4-34 oakcli orachk Command Parameters
| Parameter | Description |
|---|---|
|
|
Perform best practice check and recommended patch check. |
|
|
Perform best practice check only without the recommended patch check. |
|
|
Display version. |
|
|
Display command usage (help). |
|
|
Perform patch check only. |
|
-f |
Run the command offline. |
|
|
Exclude checks for Maximum Availability scorecards. |
|
|
Perform check on pre-upgrade best practices (-u -o pre) or on post-upgrade best practices (-u -o post) |
|
|
As an argument to an option, if |
|
|
Determines granularity of information displayed on the screen. For use only when working with Oracle Support. |
|
|
list is a comma delimited list containing the names of the nodes where the command should run. |
|
|
Run the command only on the local node. |
|
--debug |
Creates a debug log. |
|
-dbnames list |
list is a comma delimited list containing the names of the subset of databases on which the command should run. |
|
-dbnone |
Skip all database-related checks on all databases without prompting to select which database to skip. |
|
-dball |
Run all database-related checks on all databases without prompting to select which databases to check. |
|
-upgrade |
Force upgrade of the version of the orachk being run. |
The command offers multiple options that are generic to the orachk command when run on servers other than Oracle Database Appliance. You can find details about these options by running the oakcli orachk -h command. The options are grouped into the following categories, but this document does not list the options for each category:
Report Options
Auto Restart Options
Daemon Options
Profile Run Options
For more information about ORAchk, see the My Oracle Support note 1268927.2, "ORAchk Health Checks for the Oracle Stack" at https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&id=1268927.2.
Use the oakcli resize dbstorage command to resize the space used for a storage structure that was created for the purpose of migrating databases from ASM to ACFS. You can check the current space usage using oakcli show fs and then add or remove space using oakcli resize dbstorage.
Table 4-35 oakcli resize dbstorage Command Parameters
| Parameter | Description |
|---|---|
|
|
Extendable size in GB for the DATA volume |
|
|
Extendable size in GB for the REDO volume |
|
|
Extendable size in GB for the RECO volume |
|
|
Database for which these volumes must be resized |
|
|
(Optional) Displays the help usage for this command |
Use the oakcli restart oda_base command to stop and restart ODA_BASE on the local node. Use this command when you are not concerned about the current status of ODA_BASE because it performs a forced shut down. You must run this command from Dom0 and, typically, if ODA_BASE needs to be restarted, you need to restart it on both nodes.
Use the oakcli show command to display the status of Oracle Database Appliance components. The information displayed is for the node where you run the command. Use the help option, oakcli show -h, to see the list of components available on the current node.
Table 4-36 oakcli show Command Summary
| Command | Description |
|---|---|
|
Displays the Oracle Auto Service Request configuration |
|
|
Displays the status of the cooling units |
|
|
Displays information about the disk controllers |
|
|
Displays information about the core deployment |
|
|
Displays information about mappings between cores and virtual machines |
|
|
Displays information about the databases |
|
|
Displays information about the database homes |
|
|
Displays configuration file names and parameters |
|
|
Displays database storage information for databases created on ASM Cluster File System (ACFS) |
|
|
Displays information about shared or local disks |
|
|
Displays information about Oracle ASM disk groups |
|
|
Displays the current server's environment type and hardware version |
|
|
Displays information about the expanders |
|
|
Displays information about the storage enclosure |
|
|
Displays information about all database and cloudfs file systems created on ASM Cluster File System (ACFS) in addition to the local file systems on the Oracle Database Appliance node |
|
|
Displays information about the infiniBand card and port |
|
|
Displays information about the internal RAID |
|
|
Displays information about the memory subsystem |
|
|
Displays information about the network subsystem |
|
|
Displays the status of the power supply subsystem |
|
|
Displays processor (CPU) information |
|
|
Displays internal RAID sync information |
|
|
Displays information about virtual machine repositories |
|
|
Displays information about the server subsystem |
|
|
Displays information about the storage |
|
|
Displays status (enabled or disabled) of validation storage error reporting |
|
|
Displays hard storage errors |
|
|
Displays soft storage errors |
|
|
Displays information about virtual disks |
|
|
Displays version information for the software and firmware |
|
|
Displays version information about virtual local area networks |
|
|
Displays version information about virtual machines |
|
|
Opens a GUI VM console for a virtual machine. |
|
|
Displays information about virtual machine templates |
Note:
Depending on your model and version of Oracle Database Appliance software, theoakcli show command options may differ from the ones shown in the preceding table and explained in the following sections. Run the command oakcli show -h for an annotated list of components covered on your system.Use the oakcli show asr command to display your Oracle Auto Service Request configuration details.
Use the oakcli show cooling command to show information about the cooling subsystem.
The following command to display the cooling unit information for the node where the command is executed:
oakcli show cooling NAME HEALTH HEALTH_DETAILS LOCATION FAN % FAN SPEED Fan_0 OK - FM0 30 % 6300 RPM Fan_1 OK - FM0 19 % 3800 RPM Fan_10 OK - FM2 34 % 6600 RPM Fan_11 OK - FM2 23 % 4100 RPM Fan_12 OK - FM3 32 % 6300 RPM Fan_13 OK - FM3 22 % 3900 RPM Fan_14 OK - FM3 24 % 4700 RPM Fan_15 OK - FM3 14 % 2500 RPM Fan_2 OK - FM0 29 % 6400 RPM Fan_3 OK - FM0 18 % 3700 RPM Fan_4 OK - FM1 32 % 6400 RPM Fan_5 OK - FM1 20 % 3700 RPM Fan_6 OK - FM1 33 % 6400 RPM Fan_7 OK - FM1 22 % 3800 RPM Fan_8 OK - FM2 33 % 6400 RPM Fan_9 OK - FM2 22 % 3900 RPM
Use the oakcli show controller command to display information about the controllers.
Use the oakcli show core_config_key command to display information about how to deploy your Oracle Database Appliance cores.
The following command shows the core count status on a new Oracle Database Appliance that has not been configured:
oakcli show core_config_key Optional core_config_key is not applied on this machine yet!
Use the oakcli show cpupool command to display core allocations to virtual machine mappings.
Display the core mapping information for Node 0:
oakcli show cpupool -node 0
Pool Cpu List VM List
default-unpinned-pool [14, 15, 16, 17, ['test1_odarepo1','sample5_odarepo1',
18, 19, 20, 21, 'vm_very_long_name_sample1_odarepo1',
22, 23] 'win_vm1']
twocpu [12, 13] ['vm1_odarepo1']
odaBaseCpuPool [0, 1, 2, 3, 10 ['oakDom1']
, 11]
Use the oakcli show databases command to display information about each existing database, including database name, database type, database home name and location, and database version.
Use the oakcli show dbhomes command to display information about each existing Oracle database home, including home name, home location, and database version.
Use the oakcli show db_config_params command to display information about each existing Oracle database home, including home name, home location, and database version. By default, the command will search for files with the extension .dbconf located in the /opt/oracle/oak/install/dbconf directory.
Table 4-41 oakcli show dbhomes Command Parameters
| Parameter | Description |
|---|---|
|
|
(Optional) Name of configuration file to be displayed. If not included, then the command displays all configuration files. |
|
|
(Optional) Displays the parameter values stored in the configuration file or files. |
|
|
(Optional) Displays the help usage for this command. |
The following command displays the default configuration parameter values:
oakcli show db_config_params -detail
Available DB configuration files are:
Default
DATABASE_BLOCK_SIZE => 8192
DATABASE_LANGUAGE => AMERICAN
DATABASE_CHARACTERSET => AL32UTF8
DATABASE_TERRITORY => AMERICA
COMPONENT_LANGUAGES => en
Use the oakcli show dbstorage command to display database storage information for databases created on ASM Cluster File System (ACFS). By default, all non-cdb databases will be listed together as they share a common set of volumes. Each cdb database will be listed separately.
Use the oakcli show disk command to display disk information.
Table 4-43 oakcli show disk Command Parameters
| Parameter | Description |
|---|---|
|
|
(Optional) Specifies that information for all of the local disks should be displayed. |
|
|
(Optional) Specifies that information for all of the shared disks should be displayed. |
|
|
(Optional) Specifies that information for only the specific shared disk should be displayed. |
|
|
(Optional) Specifies that complete details of the selected disk or disks be displayed. |
|
|
(Optional) Displays the help usage for this command. |
The following command displays information about all the local disks:
oakcli show disk -local
Use the oakcli show diskgroup command to display Oracle ASM disk group information.
Use the oakcli show env_hw command to display the environment type and hardware version of the current node.
Use the oakcli show enclosure command to display information about the storage enclosure subsystem on the node where the command is executed.
Display the storage enclosure subsystem information of the node where the command is executed:
oakcli show enclosure NAME SUBSYSTEM STATUS METRIC E0_FAN0 Cooling OK 3000 rpm E0_FAN1 Cooling OK 3220 rpm E0_FAN2 Cooling OK 3520 rpm E0_FAN3 Cooling OK 3070 rpm E0_IOM0 Encl_Electronics OK - E0_IOM1 Encl_Electronics OK - E0_PSU0 Power_Supply OK - E0_PSU1 Power_Supply OK - E0_TEMP0 Amb_Temp OK 25 C E0_TEMP1 Midplane_Temp OK 32 C E0_TEMP2 PCM0_Inlet_Temp OK 34 C E0_TEMP3 PCM0_Hotspot_Temp OK 44 C E0_TEMP4 PCM1_Inlet_Temp OK 31 C E0_TEMP5 PCM1_Hotspot_Temp OK 42 C E0_TEMP6 IOM0_Temp OK 42 C E0_TEMP7 IOM1_Temp OK 50 C
Use the oakcli show fs command to display all database and cloudfs file systems created on ASM Cluster File System (ACFS) in addition to the local file systems on the Oracle Database Appliance node.
Use the oakcli show ib command to display InfiniBand card and port information if Infiniband exists in the system.
Use the oakcli show iraid command to display internal RAID and local disk information. This command is only available on X5-2 systems and later.
Display the memory information of the node where the command is executed:
oakcli show memory
NAME HEALTH HEALTH_DETAILS PART_NO. SERIAL_NO. LOCATION MANUFACTURER MEMORY_SIZE CURR_CLK_SPEED ECC_Errors
DIMM_0 OK - 001-0003-01 00CE02124685D963AC P0/D0 Samsung 16 GB 1600 MHz 0
DIMM_1 OK - 001-0003-01 00CE02124634F65B85 P0/D1 Samsung 16 GB 1600 MHz 0
DIMM_10 OK - 001-0003-01 00CE02124685D963B2 P1/D2 Samsung 16 GB 1600 MHz 0
DIMM_11 OK - 001-0003-01 00CE02124634F6565B P1/D3 Samsung 16 GB 1600 MHz 0
DIMM_12 OK - 001-0003-01 00CE02124634F6598B P1/D4 Samsung 16 GB 1600 MHz 0
DIMM_13 OK - 001-0003-01 00CE02124685D963B4 P1/D5 Samsung 16 GB 1600 MHz 0
DIMM_14 OK - 001-0003-01 00CE02124634F65956 P1/D6 Samsung 16 GB 1600 MHz 0
DIMM_15 OK - 001-0003-01 00CE02124685D96348 P1/D7 Samsung 16 GB 1600 MHz 0
DIMM_2 OK - 001-0003-01 00CE02124685D963B1 P0/D2 Samsung 16 GB 1600 MHz 0
DIMM_3 OK - 001-0003-01 00CE02124634F65B6E P0/D3 Samsung 16 GB 1600 MHz 0
DIMM_4 OK - 001-0003-01 00CE02124634F65C65 P0/D4 Samsung 16 GB 1600 MHz 0
DIMM_5 OK - 001-0003-01 00CE02124685D963AB P0/D5 Samsung 16 GB 1600 MHz 0
DIMM_6 OK - 001-0003-01 00CE02124634F6598E P0/D6 Samsung 16 GB 1600 MHz 0
DIMM_7 OK - 001-0003-01 00CE02124685D9659E P0/D7 Samsung 16 GB 1600 MHz 0
DIMM_8 OK - 001-0003-01 00CE02124685D963A3 P1/D0 Samsung 16 GB 1600 MHz 0
DIMM_9 OK - 001-0003-01 00CE02124634F656F7 P1/D1 Samsung 16 GB 1600 MHz 0
Use the oakcli show network command to display information about the network subsystem.
Display the network information of the node where the command is executed:
oakcli show network
NAME HEALTH HEALTH_DETAILS LOCATION PART_NO MANUFACTURER MAC_ADDRESS LINK_DETECTED DIE_TEMP
Ethernet_NIC_0 OK - NET0 X540 INTEL 00:10:e0:23:f1:08 yes (eth0) 61.000 degree C
Ethernet_NIC_1 OK - NET1 X540 INTEL 00:10:e0:23:f1:09 yes (eth1) 61.000 degree C
Ethernet_NIC_2 OK - NET2 X540 INTEL 00:10:e0:23:f1:0a yes (eth4) 53.750 degree C
Ethernet_NIC_3 OK - NET3 X540 INTEL 00:10:e0:23:f1:0b yes (eth5) 53.750 degree C
Ethernet_NIC_4 - - NET4 82599EB INTEL 00:1B:21:B6:09:F1 yes (eth3) -
Ethernet_NIC_5 - - NET5 82599EB INTEL 00:1B:21:B6:09:F0 yes (eth2) -
Use the oakcli show power command to display information about the power supply subsystem.
Display the power supply information of the node where the command is executed:
oakcli show power
NAME HEALTH HEALTH_DETAILS PART_NO. SERIAL_NO. LOCATION INPUT_POWER OUTPUT_POWER INLET_TEMP EXHAUST_TEMP
Power_Supply_0 OK - 7047410 476856F+1242CE0020 PS0 Present 113 watts 33.250 degree C 36.688 degree C
Power_Supply_1 OK - 7047410 476856F+1242CE004J PS1 Present 89 watts 37.000 degree C 39.438 degree C
Use the oakcli show processor command to display information about CPU processors.
Display the CPU processor information of the node where the command is executed:
oakcli show processor
NAME HEALTH HEALTH_DETAILS PART_NO. LOCATION
MODEL MAX_CLK_SPEED TOTAL_CORES ENABLED_CORES
CPU_0 OK - 060D P0 (CPU 0)
Intel(R) Xeon(R) CPU E5-2690 2.900 GHZ 8 8
CPU_1 OK - 060D P1 (CPU 1)
Intel(R) Xeon(R) CPU E5-2690 2.900 GHZ 8 8
Use the oakcli show raidsyncstatus command to display the status of the RAID rebuild after a failed local disk is replaced. This command applies only to V1, X3-2 and X4-2.
Use the oakcli show repo command to display information about virtual machine repositories. To see all repositories, do not include the repository name and node number. To see a specific shared repository, include the repository name and node.
Display the virtual machined repositories on the two nodes of your Oracle Database Appliance Virtualized Platform:
oakcli show repo
NAME REPOTYPE NODENUM
odarepo1 local 0
odarepo2 local 1
repo1 shared 0
repo1 shared 1
Display information about the repository named repo1 on Node 1:
oakcli show repo repo1 -node 1
Resource: repo1_1
AutoStart : restore
DG : DATA
Device : /dev/asm/repo1-286
ExpectedState : Online
MountPoint : /u01/app/repo1
Name : repo1_0
Node : all
RepoType : shared
Size : 102400
State : Online
Use the oakcli show server command to display information about the server subsystem.
Display the server information of the node where the command is executed:
oakcli show server
Power State : On Open Problems : 1 Model : SUN FIRE X4170 M3 Type : Rack Mount Part Number : 31324979+1+1 Serial Number : 1250FML046 Primary OS : Not Available ILOM Address : 10.210.57.26 ILOM MAC Address : 00:10:E0:23:F1:0C Description : Oracle Database Appliance X3-2 AK00050333 Locator Light : Off Actual Power Consumption : 268 watts Ambient Temperature : 22.000 degree C Open Problems Report :Open Problem 1 Problem time : Tue Apr 2 06:10:37 2013 Problem subsystem : System Problem location : /SYS (Host System) Problem description : An error has occurred in which no automated diagnosis is available to identify faulty component. (Probability: 100, UUID: a72b4e35-140d-c86d-b87b-daf3eb43f5c7, Part Number: 31324979+1+1, Serial Number: 1250FML046, Reference Document: http://www.sun.com/msg/SPX86-8003-JP)
Use the oakcli show validation storage command to show whether validation storage is enabled or disabled.
Use the oakcli show validation storage errors command to show hard storage errors. Hard errors include having the wrong type of disk inserted into a particular slot, an invalid disk model, or an incorrect disk size.
Use the oakcli show validation storage failures command to show soft storage errors. A typical soft disk error would be an invalid version of the disk firmware.
Use the oakcli show vdisk command to display information about virtual disks on Oracle Database Appliance Virtualized Platform.
Display information about all vdisks on your Oracle Database Appliance:
# oakcli show vdisk
NAME SIZE TYPE REPOSITORY
myvdisk 10G local vdiskrepo
newv 1G local vdiskrepo
Display information for the vdisk named myvdisk:
# oakcli show vdisk myvdisk1
Resource: myvdisk_vdiskrepo
Name : myvdisk_vdiskrepo
RepoName : vdiskrepo
Size : 10G
Type : local
VmAttached : 0
Use the oakcli show version command to display patch versions for Oracle Database Appliance software and firmware.
Use the oakcli show vlan command to display information about virtual local area networks configured on Oracle Database Appliance.
Display the names, tag ID numbers, networks, and node assignments for the available local virtual area networks:
oakcli show vlan
NAME ID INTERFACE NODENUM net1 1 bond0 0 net1 1 bond0 1 net2 1 bond1 0 net2 1 bond1 1 net3 2 bond1 0 net3 4 bond0 1 net10 20 bond1 0 net10 20 bond1 1
Use the oakcli show vm command to display information about virtual machines.
Table 4-45 oakcli show vm Command Parameters
| Parameter | Description |
|---|---|
|
|
(Optional) The name of the virtual machine for which details should be displayed. If you do not specify this parameter, then information for all of the virtual machines is displayed. |
|
|
(Optional) Displays the help usage for this command. |
Display the virtual machine names, memory and vCPU allocations, status, virtual disks, and repository name for all virtual machines:
oakcli show vm
NAME MEMORY VCPU STATE REPOSITORY sample5_odarepo1 2048 2 OFFLINE odarepo1 sample6_odarepo1 2048 2 OFFLINE odarepo2 test1_odarepo1 2048 2 OFFLINE odarepo1 test2_odarepo2 2048 2 OFFLINE odarepo2 vm1_odarepo1 4096 4 ONLINE odarepo1 vm2_odarepo2 2048 2 OFFLINE odarepo2 win_vm1 1500 1 ONLINE odarepo1
The following command displays information about the vm1_odarepo1 virtual machine:
oakcli show vm vm1_odarepo1
Resource: vm1_odarepo1
AutoStart : restore
CPUPriority : 100
Disks : |file:/OVS/Repositories/odarepo1/Vi
rtualMachines/vm1_odarepo1/System.i
mg,xvda,w||file:/OVS/Repositories/o
darepo1/VirtualMachines/vm1_odarepo
1/u01.img,xvdb,w|
Domain : XEN_PVM
ExpectedState : online
FailOver : false
IsSharedRepo : false
Keyboard : en-us
MaxMemory : 3000
MaxVcpu : 4
Memory : 4096
Mouse : OS_DEFAULT
Name : vm1_odarepo1
Networks : |mac=00:21:F6:00:00:E4|
NodeNum : 0
NodeNumStart :
OS : OL_5
PrivateIP : None
ProcessorCap : 100
RepoName : odarepo1
State : Online
TemplateName : otml_sample1_odarepo1
Vcpu : 4
cpupool : twocpu
vncport : 5901
Use the oakcli show vmtemplate command to display information about virtual machine templates.
Table 4-46 oakcli show vmtemplate Command Parameters
| Parameter | Description |
|---|---|
|
|
(Optional) The name of the virtual template for which details should be displayed. If you do not specify this parameter, then information for all of the virtual templates is displayed. |
|
|
(Optional) Displays the help usage for this command. |
The following command displays information about the sample1_odarepo1 virtual template:
oakcli show vmtemplate sample_odarepo1
Resource: sample1_odarepo1
CPUPriority : 100
Disks : |file:/OVS/Repositories/odarepo1/Te
mplates/otml_sample1_odarepo1/Syste
m.img,xvda,w||file:/OVS/Repositorie
s/odarepo1/Templates/otml_sample1_o
darepo1/u01.img,xvdb,w|
Domain : XEN_PVM
Keyboard : en-us
MaxMemory : 2048
MaxVcpu : 2
Memory : 2048
Mouse : OS_DEFAULT
Name : sample1_odarepo1
Networks : |bridge=priv1||bridge=net1||bridge=
net2|
NodeNum : 0
OS : OL_5
ProcessorCap : 100
RepoName : odarepo1
Vcpu : 2
Use the oakcli start command to start a virtual machine, to start a shared repository on a node, or to start ODA_BASE on the local node.
Table 4-47 oakcli start Command Summary
| Command | Description |
|---|---|
|
Starts ODA_BASE on the local node |
|
|
Starts a shared repository on the specified node |
|
|
Starts a virtual machine on the specified node |
Use the oakcli start oda_base command to start ODA_BASE on the local node.
oakcli start oda_base [-h]
Table 4-48 oakcli start oda_base Command Parameters
| Parameter | Description |
|---|---|
|
|
(Optional) Displays the online help. |
Connect to Dom0 on the desired node and enter the following command to start ODA_BASE on that node:
oakcli start oda_base
Use the oakcli start repo command to start a shared repository on a node.
oakcli start repo repo_name [-node node_number] [-h]
Table 4-49 oakcli start repo Command Parameters
| Parameter | Description |
|---|---|
|
|
|
|
-node |
Specifies the node on which to start the shared repository. |
|
|
(Optional) Displays the online help. |
The following command starts the shared repository named repo1 on Node 0:
oakcli start repo repo1 -node 0
Use the oakcli start vm command to start a virtual machine on a node.
oakcli start vm vm_name [-node node_number] [-d] [-h]
Table 4-50 oakcli start vm Command Parameters
| Parameter | Description |
|---|---|
|
|
|
|
|
Specifies the node on which to start the virtual machine. |
|
|
Provides details about the virtual machine starting procedure |
|
|
(Optional) Displays the online help. |
The following command starts the virtual machine named vm1_odarepo1 on Node 0.
oakcli start vm vm_odarepo1 -node 0
Use the oakcli stop command to stop a virtual machine, to stop a shared repository on a node, or to stop ODA_BASE on the local node.
Table 4-51 oakcli stop Command Parameters
| Parameter | Description |
|---|---|
|
|
(Optional) Displays the online help. |
|
vm |
|
|
|
(Optional) forces the virtual machine to stop. |
|
repo |
|
|
-node |
|
|
|
stops ODA_BASE on the local node. |
Enter the following command to force the virtual machine named vm1_odarepo1 to stop:
oakcli stop vm vm_odarepo1 -force
Use the oakcli stordiag command to run diagnostic tests on a disk in the storage shelf or storage expansion shelf.
oakcli stordiag resource_typen | -h
where resource_type is a prefix that depends on the configuration, n is the disk number (starting with 0 and increasing to one less than the number of disks), and -h shows the help for this command. Select the value for resource_type based from one of the following options:
on Oracle Database Appliance Version 1, use d
on Oracle Database Appliance with a single storage shelf, use pd_
on Oracle Database Appliance with an expansion storage shelf, use e0_pd_ for a disk in the storage shelf and use e1_pd_ for a disk in the expansion storage shelf
For Oracle Database Appliance systems that have internal storage, use the format d_[..] to identify the disk to be diagnosed, for Oracle Database Appliance system that have connected a connected shelf (and optional storage expansion shelf), use the format e[0..1]_p[0..23] to identify the disk to be diagnosed.
The following command runs the diagnostic tests on the fourth storage unit in the storage shelf, where there is no expansion storage shelf:
# oakcli stordiag e1_pd_3
Node Name : hr0
Test : Diagnostic Test Description
1 : OAK Check
NAME PATH TYPE STATE STATE_DETAILS
pd_03 /dev/sdw HDD ONLINE Good
2 : ASM Check
. . .
<output truncated>
Use the oakcli test asr command to send a test trap to determine if Oracle Auto Service Request (Oracle ASR) is configured and working correctly. The command returns a success message if Oracle ASR is functioning properly.
Use the oakcli unpack command to unpack packages into the Oracle Appliance Manager command-line interface repository.
oakcli unpack -package absolute_package_name
where absolute_package_name identifies the package to be unpacked using the package's full absolute path and file name.
The following command unpacks the p13982331_23000_Linux-86-64.zip package, which was previously copied to /tmp on the current node, into the node's Oracle Appliance Manager command-line interface repository:
oakcli unpack -package /tmp/p13982331_23000_Linux-86-62.zip
Use the oakcli update command to apply Oracle Database Appliance patches. For upgrading only the Oracle Database software, see the oakcli upgrade command.
oakcli update -patch version [[--infra] | [[--gi][--database]]] [--noreboot] | [--clean] | [--verify]
Table 4-52 oakcli update Command Parameters
Use the oakcli upgrade command to upgrade Oracle Databases on Oracle Database Appliance. For patching Oracle Database Appliance itself, see the oakcli update command.
Table 4-53 oakcli upgrade Command Parameters
| Parameter | Description |
|---|---|
|
|
Specifies the name or names (in a comma-delimited list) of the database or databases you want to upgrade. |
|
|
Specifies the current Oracle Database home of the databases you are upgrading. |
|
|
Specifies the Oracle Database home containing the version to which you want to upgrade the databases |
|
--h |
(Optional) Displays the online help. |
You must include either a -db parameter or a -from parameter.
Running the command with a -db parameter upgrades only the named databases, regardless of their current Oracle Database homes. If you include a -from parameter, in addition to a -db parameter, then the command ignores the -from parameter. That is, the command upgrades named databases from other homes and ignores the databases in the named home if they are not listed in the -db parameter.
Running the command without a -db parameter will upgrade all of the databases in the named Oracle Database home.
You must always provide a -to parameter which names an existing Oracle Database home.
Use the oakcli validate command to validate the state of an Oracle Database Appliance or the viability of an operating system patch.
Use the following oakcli validate syntax to validate an Oracle Database Appliance:
oakcli validate [[-V | -l | -h]] | [[-v][-f output_file] [-a | -d | -c checklist][-ver patch_version]]
Table 4-54 oakcli validate Command Parameters
| Parameter | Description |
|---|---|
|
-V |
Display the version of oakValidation. |
|
-l |
List the items that can be checked along with their descriptions. |
|
|
Display the online help. |
|
-v |
Show verbose output (must be used with a parameter that generates a validation report). |
|
-f |
Send output to a file with a fully-qualified file name, |
|
-a |
Run all system checks, including |
|
-d |
Run only the default checks. |
|
-c |
Run the validation checks for the items identified in |
|
-ver |
Report any reasons for not being able to patch Oracle Database Appliance with the patch named in patch_version. |
List all of the checks available with oakcli validate along with their descriptions:
oakcli validate -l
Checkname -- Description
========= ===========
*SystemComponents -- Validate system components based on ilom sensor data
readings
*OSDiskStorage -- Validate OS disks and filesystem information
*SharedStorage -- Validate Shared storage and multipathing information
DiskCalibration -- Check disk performance with orion
*NetworkComponents -- Validate public and private network components
*StorageTopology -- Validate external JBOD connectivity
asr -- Validate asr components based on asr config file and ilom sensor
data readings
* -- These checks are also performed as part of default checks
Note:
TheNetworkComponents validation check is not available on hardware prior to Oracle Database Appliance X3-2.Enter the following syntax to run all checks
oakcli validate -a
Enter the following syntax to validate the connections to you storage shelf and, if connected, your storage expansion shelf:
oakcli validate -c storagetopology
Enter the following syntax to validate your ASR configuration:
# oakcli validate -c asr INFO: oak Asr information and Validations RESULT: /opt/oracle/oak/conf/asr.conf exist RESULT: ASR Manager ip:10.139.154.17 RESULT: ASR Manager port:1162 SUCCESS: ASR configuration file validation successfully completed RESULT: /etc/hosts has entry 141.146.156.46 transport.oracle.com RESULT: ilom alertmgmt level is set to minor RESULT: ilom alertmgmt type is set to snmptrap RESULT: alertmgmt snmp_version is set to 2c RESULT: alertmgmt community_or_username is set to public RESULT: alertmgmt destination is set to 10.139.154.17 RESULT: alertmgmt destination_port is set to 1162 SUCCESS: Ilom snmp confguration for asr set correctly RESULT: notification trap configured to ip:10.139.154.17 RESULT: notification trap configured to port:1162 SUCCESS: Asr notification trap set correctly INFO: IP_ADDRESS HOST_NAME SERIAL_NUMBER ASR PROTOCOL SOURCE PRODUCT_NAME INFO: --------------- ------------------------------ ------------------------------ -------- --------- -------------- ------------------------------ 10.170.79.98 oda-02-c 1130FMW00D Enabled SNMP ILOM SUN FIRE X4370 M2 SERVER 10.170.79.97 oda-01-c 1130FMW00D Enabled SNMP ILOM SUN FIRE X4370 M2 SERVER INFO: Please use My Oracle Support 'http://support.oracle.com' to view the activation status. SUCCESS: asr log level is already set to Fine. RESULT: Registered with ASR backend. RESULT: test connection successfully completed. RESULT: submitted test event for asset:10.139.154.17 RESULT: bundle com.sun.svc.asr.sw is in active state RESULT: bundle com.sun.svc.asr.sw-frag is in resolved state RESULT: bundle com.sun.svc.asr.sw-rulesdefinitions is in resolved state RESULT: bundle com.sun.svc.ServiceActivation is in active state SUCCESS: ASR diag successfully completed
Use the following command before attempting to patch Oracle Database Appliance to determine if it will succeed or if changes need to be made before applying the patch. Warning and error labels are highlighted in magenta and red font respectively.
# oakcli validate ospatch -ver 12.1.2.3.0 INFO: Validating the OS patch for the version 12.1.2.3.0 WARNING: 2015-02-10 06:30:32: Patching sub directory /opt/oracle/oak/pkgrepos/orapkgs/OEL/5.10/Patches/5.10.1 is not existing INFO: 2015-02-10 06:30:32: May need to unpack the Infra patch bundle for the version: 12.1.2.3.0 ERROR: 2015-02-10 06:30:32: No OS patch directory found in the repository