This chapter describes the content and use of the Oracle Appliance Manager command-line interface known as OAKCLI. The current set of oakcli commands along with their syntax and usage notes are included, as well as examples of many of the commands.
OAKCLI is a command line interface (CLI) dedicated to Oracle Database Appliance that allows you to:
List the hardware components
Validate and diagnose the hardware components
Install and upgrade software
Apply software patches
Create and drop databases
Install and uninstall Oracle Homes
Deploy and manage virtual machines
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 oakcli commands are supported on your version of Oracle Appliance Manager and your hardware, enter the following command: oakcli -h.
The Oracle Appliance Manager command-line interface is in the following directory:
/opt/oracle/oak/bin/oakcli
The root user account should have the oakcli PATH variable defined as the path to the directory where oakcli is located.
Oracle Database Appliance maintains logs of oakcli command executions and output in the following directory.
/opt/oracle/oak/log/hostname/client/oakcli.log
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. -h, which is the help parameter, is available with every command.
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 in to 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.
Allowing Root User Access in SUDO
In environments where the system administration is handled by a different group than the database administration or where security is a large concern, you may want to limit access to the root user account and password. SUDO allows a system administrator to give certain users (or groups of users) the ability to run commands as root while logging all commands and arguments.
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 SUDO administration.
Caution:
Configuring SUDO to allow a user to perform any operation is equivalent to giving that userroot privileges. Consider carefully if this is appropriate for your security needs.SUDO Example 1: Allow a User to Perform Any OAKCLI Operation
To configure SUDO to allow a user to perform any OAKCLI operation, add lines to the commands section in the /etc/sudoers file as follows:
## The commands section may have other options added to it. ## Cmnd_Alias OAKCLI_CMDS=/opt/oracle/oak/bin/oakcli * jdoe ALL = OAKCLI_CMDS
In this example, jdoe is the user name. ALL= OAKCLI_CMDS grants the jdoe user permission to run all oakcli commands defined in the command alias OAKCLI_CMDS. The sudoers file is designed so that one sudoers file can be copied to multiple hosts with different rules on each host.
Note:
Note the SSH equivalent must already be set up or the root password will be required during database creation.After you configure the sudoer file with the user, the oakcli commands can be run by jdoe as follows:
[jdoe@servernode1 ~]$ sudo /opt/oracle/oak/bin/oakcli create database -db newdbINFO: 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 detailsINFO: 2015-08-05 14:40:59: Database parameter file is not provided. Will be using default parameters for DB creationPlease enter the 'SYSASM' password : (During deployment we set the SYSASM password to 'welcome1'):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_3Please select one of the following for Database type [1 .. 3]:1 => OLTP 2 => DSS 3 => In-Memory
SUDO Example 2: Allow a User to Perform Only Selected OAKCLI Operations
To configure SUDO to allow a user to perform only selected OAKCLI operations, add lines to the commands section in the /etc/sudoers file as follows:
[jdoe2@servernode1 ~]$ sudo /opt/oracle/oak/bin/oakcli create database -db test INFO: 2015-09-30 15:49:07: Look at the logfile '/opt/oracle/oak/log/servernode1/tools/12.1.2.4.0/createdb_test_59955.log' for more details INFO: 2015-09-30 15:49:12: Database parameter file is not provided. Will be using default parameters for DB creation Please enter the 'SYSASM' password : (During deployment we set the SYSASM password to 'welcome1'): Please re-enter the 'SYSASM' password: INFO: 2015-09-30 15:49:27: Installing a new home: OraDb12102_home2 at /u01/app/oracle/product/12.1.0.2/dbhome_2 Please select one of the following for Database type [1 .. 3]: 1 => OLTP 2 => DSS 3 => In-Memory
Here the user jdoe2 tries to run the oakcli show databases command and gets an error message:
[jdoe2@servernode1 ~]$ sudo /opt/oracle/oak/bin/oakcli show database
Sorry, user jdoe2 is not allowed to execute '/opt/oracle/oak/bin/oakcli show database' as root on servernode1.
Note:
The SSH equivalent must already be set up or the root password will be required during database creation.For more information about configuring and using SUDO, refer to the SUDO man pages at >http://www.sudo.ws/sudo.html
The remainder of this chapter contains syntax and other details about the oakcli commands available in this release, sorted alphabetically.
Here is a list of the commands in this release.
Adds a local disk to the system after the physical replacement of a failed disk. This command is available only for Oracle Database Appliance V1, X4-2, and X3-2.
Reconfigures Oracle Database Appliance core capacity. This command applies only to bare metal implementations.
Commands to clone virtual machines and virtual disks.
Commands for configuring Oracle Database Appliance components.
Prepares a copy of the configuration file for use during deployment.
Commands for creating Oracle Database Appliance components.
Commands for removing Oracle Database Appliance components.
Deploys Oracle Database Appliance.
Manages disk write cache.
Imports a virtual machine template.
Locates a shared disk on a storage shelf by turning on an indicator light.
Collects diagnostic statistics and information, primarily for use when working with Oracle Support.
Migrates a currently running virtual machine to another node.
Attaches and detaches virtual disks to and from virtual machines, transmits first-boot installation messages to virtual machines, and assigns and deletes networks from virtual machines and virtual machine templates.
Audits configuration settings.
Resizes the space used for an ACFS storage structure.
Restarts ODA_BASE on the local node.
Commands for displaying information about various Oracle Database Appliance components.
Commands for starting a Domain U or ODA_BASE virtual machine.
Commands to stop a virtual machine, stop a shared repository on a node, or to stop ODA_BASE on the local node.
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 software such as the infrastructure, grid infrastructure, and database, and verifies patching.
Upgrades Oracle databases on Oracle Database Appliance.
Validates the state of Oracle Database Appliance or the viability of an operating system patch.
Use the oakcli add disk -local command to add a local disk to the system after physically replacing a failed disk.
Note:
This command is available only for Oracle Database Appliance X4-2, X3-2, and V1oakcli add disk -local
You cannot add more than two disks per node.
You must remove the failed drive and replace it with a new drive before running the oakcli add disk -local command.
The new disk must be inserted into the slot before you run this command.
The oakcli add disk -local command is supported only on bare metal deployments. It is not supported on virtualized configurations.
Use the oakcli apply command from Node 0 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]
| Parameter | Description |
|---|---|
core_config_key_file |
Identifies the full path and name of the configuration key file |
-h |
(Optional) Display help for using the command. |
Run the oakcli apply command from the first node in Oracle Database Appliance as the root user.
After you run the oakcli apply command, Oracle Database Appliance applies the key to both nodes and reboots both nodes.Run the oakcli show core_config_key command to view the core configuration key. See oakcli show core_config_key.
The core key application is applicable only to bare metal implementations. It is not available on Oracle Database Appliance Virtualized Platform.
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 commands to clone virtual machines or virtual disks.
Use the oakcli clone vdisk command to create clones of virtual disks.
oakcli clone vdisk new_vdisk_name -repo repo_name -src source_vdisk_name [-h]
| Parameter | Description |
|---|---|
new_vdisk_name |
Name given to the clone virtual disk |
repo_name |
Name of the repository source for the virtual disk being cloned |
source_vdisk_name |
Name of the virtual disk being cloned |
-h |
(Optional) Display help for using the 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.
To create a virtual machine from a template:
oakcli clone vm vm_name -vmtemplate template_name -repo repo_name [-node 0|1][h]
To create a snapshot clone of an existing virtual machine:
oakcli clone vm vm_name -vm src_name -snap
To create a virtual machine snapshot from a template:
oakcli clone vm vm_name -vmtemplate template_name -snap
| Parameter | Description |
|---|---|
vm_name |
Name given to the cloned virtual machine |
-vmtemplate template_name |
Name of the template containing the virtual machine that you want to clone |
-repo repo_name |
Name of the repository that contains the template being cloned |
-node 0 | 1 |
Identifies the Oracle Database Appliance node that contains the shared repository from which the virtual machine is to be cloned
The |
-vm src_name |
Name of the virtual machine that is to be cloned |
-snap |
Creates a snapshot of the source virtual machine or virtual machine template |
-h |
(Optional) Display help for using the command. |
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 commands to configure components on Oracle Database Appliance.
oakcli configure additionalnet
Configures any unconfigured public networks in Bare Metal, Domain 0, and ODA_BASE
Configures Oracle Auto Service Request (Oracle ASR) for Oracle Database Appliance
Configures a CPU pool
Configures initial network connection
Configures 10GbE SFP+ (fiber) cards after they have been replaced by InfiniBand cards
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
Configures a shared repository by increasing its size
Configures a virtual machine
Configures a virtual machine template
Use the oakcli configure additionalnet command to configure any unconfigured public networks in bare metal, Domain 0, and ODA_BASE. This command automatically detects any unconfigured networks and runs a script which guides you through how to configure the network.
oakcli configure additionalnet [-h]
-h displays online help for using the command.
The oakcli configure additionalnet command runs an interactive script that requires the following input:
Interface name
DHCP [Y/N]
IP
Netmask
Note:
If you are running the command on a bare metal deployment, then the interface name expects a bond name. If you are running the command on Dom0, then the interface name expects a net name. If you are running the command on Dom1, then the interface name expects an eth name.Use the oakcli configure asr command to configure Oracle Auto Service Request (Oracle ASR) on Oracle Database Appliance.
oakcli configure asr [-h]
-h displays help for using the command.
The oakcli configure asr command initiates an interactive script that requests the following information to implement Oracle ASR on Oracle Database Appliance:
Action to be performed (internal or external install, deinstall, or reconfigure)
PROXY server name, port, user ID, and password
Oracle ASR user ID and password
Oracle ASR Manager IP and port
# oakcli configure asr INFO : Logging all actions in /opt/oracle/oak/onecmd/tmp/scaoda1011-20150805153300.log and traces in /opt/oracle/oak/onecmd/tmp/scaoda1011-20150805153300.trc Please enter 1 to setup Internal ASR 2 to setup External ASR 3 to Deinstall ASR 0 to Exit [1]:INFO : Logging all actions in /opt/oracle/oak/onecmd/tmp/scaoda1011-20150805153300.log and traces in /opt/oracle/oak/onecmd/tmp/scaoda1011-20150805153300.trc
Use the oakcli configure cpupool command to configure a CPU pool on one Oracle Database Appliance Virtualized Platform node.
oakcli configure cpupool poolname -numcpu cpu_count -node nodenum [-h]
| Parameter | Description |
|---|---|
poolname |
Unique name for the CPU pool |
-numcpu cpu_count |
Number of CPUs for the CPU pool |
-node nodenum |
Node where the CPU pool will be created (0 or 1) |
-h |
(Optional) Display help for using the command. |
Configure a CPU pool named twonode with two cores on Node 1 of Oracle Database Appliance Virtualized Platform:
oakcli configure cpupool twonode -numcpu 2 -node 1
Use the oakcli configure firstnet command to configure an initial network on Oracle Database Appliance that enables you to download deployment software.
oakcli configure firstnet
The oakcli configure firstnet command creates an initial network on a new Oracle Database Appliance using an interactive script. The following example shows how to configure the initial network on a bare metal Oracle Database Appliance:
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.Run the oakcli configure ib2fiber command after replacing InfiniBand 10GbE SFP+ cards (fiber) cards and before deployment to unconfigure IB setup and configure fiber cards.
Note:
The command is supported only on X5-2. If you are using Oracle Database Appliance Virtualized Platform, then you must execute the command from Dom0.This command must be run before deployment to configure 10GbE SFP+ (fiber) cards.
oakcli configure ib2fiber [-h]
-h displays help for using the command.
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.
oakcli configure network [-changeNetCard|-publicNet][-h]
| Parameter | Description |
|---|---|
-changeNetCard |
Configures the network card after it has been replaced. You must run the oakcli configure network -changeNetCard command on each node if the network card was replaced. This parameter is supported on all Oracle Database Appliance hardware models. This command must be executed from Dom0 on virtualized platforms. |
-publicNet |
Configures the network after you have swapped the public network from copper to fiber and vice versa. You must run the oakcli configure network -publicNet command on each node, and this requires the stack to be down. The stack includes GI and RDBMS. If you are using Oracle Database Appliance Virtualized Platform, the virtual machines must be down. The virtual machines may need some configuration changes, especially if they are using VLANs. This parameter is supported only on Oracle Database Appliance X4-2 hardware models. |
-h |
(Optional) Display help for using the command. |
Use the oakcli configure oda_base command to:
Change the CPU core count assigned to ODA_BASE.
Add or remove virtual local area networks assigned to ODA_BASE.
Adjust resource allocation among user domains and between ODA_BASE and other user domains.
Increase or decrease resource allocation to the ODA_BASE domain.
You must restart the domain for the resource allocation change to take effect.
oakcli configure oda_base
Changing the CPU Core Count in 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
Changing the Amount of Memory Allocated to ODA_BASE
Log in to Dom0.
Execute the oakcli configure oda_base command and change the configuration.
Restart ODA_BASE.
Log in to Dom0.
Execute the oakcli configure oda_base command.
Change the setting for Additional vlan networks to be assigned to oda_base? (y/n) to y.
Follow the prompts to assign additional VLANs to ODA_BASE.
Restart ODA_BASE.
Use the oakcli configure repo command to increase the size of a shared repository.
oakcli configure repo reponame -incsize size [M|G][-h]
| Parameter | Description |
|---|---|
reponame |
Name of the shared repository |
size |
Number that can be followed by M to define the size as megabytes or by G to define as size as gigabytes |
-h |
(Optional) Display help for using the command. |
Increase the size of the repo1 shared repository by 2 gigabytes:
# oakcli configure repo repo1 -incsize 2G Configured Shared Repo : repo1 with new size 3712.0.
Use the oakcli configure vm command to configure a virtual machine on Oracle Database Appliance Virtualized Platform and to increase or decrease resource allocation to user domains. You must restart the domain for the resource allocation change to take effect.
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][-h]
| Parameter | Description |
|---|---|
name |
The name assigned to the virtual machine. |
-vcpu cpucount |
Number of nodes assigned to the virtual machine. The range is 1 to 72. This number depends on your Oracle Database Appliance configuration:
|
-maxvcpu maxcpu |
Maximum number of CPUs that the virtual machine can consume. The range is 1 to 72. This number depends on your Oracle Database Appliance configuration:
|
-cpuprio priority |
Priority for CPU usage, where larger values have higher priority. The range is 1 to 65535, |
-cpucap cap |
Percentage of a CPU the virtual machine can receive. The range is 10 to 100. |
-memory memsize |
Amount of memory given to the virtual machine: (1 to 248)G to (1to 760G) or (1 to 253952)M to (1 to 778240)M, based on RAM. The default is M. |
-maxmemory max_memsize |
Maximum amount of memory allowed for the virtual machine: (1 to 248)G to (1 to 760)G or (1-253952)M to (1-778240)M, based on RAM. The default is M. |
-os sys |
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 lang |
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 mouse_type |
Mouse type used by the virtual machine (OS_DEFAULT, PS2_MOUSE, USB_MOUSE, or USB_TABLET) |
-domain dom |
Domain type from the following options:
|
-network netlist |
MAC address and list of networks used by the virtual machine |
-autostart astart |
Startup option for virtual machine (always, restore, or never) |
-disk disks |
List of disks (slot, disktype, and content) used by virtual machine |
-bootoption bootstrap |
Boot option used to bootstrap the virtual machine (PXE, DISK, or CDROM) |
-cpupool pool |
Named CPU pool assigned to the virtual machine |
-prefnode 0|1 |
Preferred node on which the virtual machine will attempt to start (Node 0 or Node 1). This parameter is only valid for virtual machines created in shared repositories. |
-failover true|false |
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 -prefnode parameter. This parameter is only valid for virtual machines created in shared repositories. |
-h |
(Optional) Display help for using the command. |
All of the parameters, except for name, are optional.
You must include at least one optional parameter for the command to work.
When you create a virtual machine, select the Processor Cap as a percentage, between 10 and 100%. The default is 100%. This value is then converted to a CPU utilization limit in the vm.cfg file for the virtual machine. The value set in the vm.cfg file limits the amount of CPU a guest is allowed to consume. If the Processor Cap is set at 100% in Oracle VM, then the value set in vm.cfg is 0, which means there is no limit to CPU utilization.
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 optionsChange the number of virtual CPUs to 3 and the virtual memory size to 4GB in a virtual machine named sample_odarep01:
oakcli configure vm sample_odarep01 -vcpu 3 -memory 4196
Use 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][h]
| Parameter | Description |
|---|---|
name |
Name assigned to the virtual machine template |
-vcpu cpucount |
Number of nodes assigned to virtual machines cloned from the template:
|
-maxvcpu maxcpu |
Maximum number of CPUs that virtual machines cloned from the template can consume:
|
-cpuprio priority |
Priority for CPU usage, where larger values have higher priority (1 to 256). |
-cpucap cap |
Percentage of a CPU that virtual machines cloned from the template can receive (1 to 100). |
-memory memsize |
Amount of memory given to virtual machines cloned from the template (1G to 88 G or 1M to 90112M) |
-maxmemory max_memsize |
Maximum amount of memory allowed for virtual machines cloned from the template |
-os sys |
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 lang |
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 mouse_type |
Mouse type used by virtual machines cloned from the template (OS_DEFAULT, PS2_MOUSE, USB_MOUSE, or USB_TABLET) |
-domain dom |
Domain type from the following options:
|
-network netlist |
MAC address and list of networks used by virtual machines cloned from the template |
-disk disks |
List of disks (slot, disktype, and content) used by virtual machines cloned from the template |
-h |
(Optional) Display help for using the command. |
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:
oakcli configure vmtemplate myol5u7_10gb -vcpu 2 -maxvcpu 4 -cpucap 40 -memory 1536M -maxmemory 2G -network "['type=netfront,bridge=net1']" -os OTHER_LINUX
-vcpu 2 = Two CPUs will assigned when the virtual machine starts up
-maxvcpu 4 = The maximum number of CPUs that can be assigned to the virtual machine is 4.
-cucap 40 = The maximum percentage of a CPU's capacity that will be assigned to the virtual machine is 40%.
-memory 1536M = The amount of memory assigned when the virtual machine starts up is 1536 MB.
-maxmemory 2G = The maximum amount of memory that can be assigned to the virtual machine is 2 GB.
-network type=netfront,bridge=net1 = This is the list of networks used by virtual machines cloned from the template.
-os = The operating system used by the virtual machine is OTHER_LINUX.
Use the oakcli copy command to prepare a copy of the configuration file for use during the configuration of Oracle Database Appliance.
oakcli copy -conf absolute_conf_file [-h]
| Parameter | Description |
|---|---|
-conf absolute_conf_file |
Specifies the full path name of the configuration file |
-h |
(Optional) Display help for using the command. |
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 commands to create components on Oracle Database Appliance.
Creates a new CPU pool
Creates a new database
oakcli create db_config_params
Creates a database configuration file
Creates a new database home
Creates a new Oracle ACFS storage structure
Creates a new shared repository on an 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 an 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.
oakcli create cpupool poolname -numcpu cpu_count -node nodenum [-h]
| 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) |
-h |
(Optional) Display help for using the command. |
Create a CPU pool with two CPUs on Node 1 of Oracle Database Appliance Virtualized Platform:
oakcli create cpupool twonode -numcpu 2 -node 1
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.
oakcli create database -db db_name [[[-oh home] | [-version version]] [-params params_file] [-cdb]][h]
| Parameter | Description |
|---|---|
-db db_name |
Name of the database that you want to create |
-oh home |
(Optional) Name of an existing Oracle home to use when creating the database. By default, the command creates a new database home. |
-version version |
(Optional) Version of the database that you want to create. By default, Oracle Database Appliance uses the highest version that you have downloaded. |
-params params_file |
(Optional) Name of the configuration file. By default, Oracle Database Appliance uses the default configuration file. |
-cdb |
(Optional) Creates the database as a container database |
-h |
(Optional) Display help for using the command. |
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 specific version database 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 available only on Oracle Database Appliance X5-2.
The following command creates a database named mydb using an existing Oracle home named OraDb12102_home1.
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 Deployment [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
Create a database called sales1 in OraDb11203_home2:
oakcli create database -db sales1 -oh OraDb11203_home2
Creating a New Database from a Template
Create a database called sales2 from the salesdbtemplate.bconf file (by appending the default file extension to the file name provided). This example also creates a new Oracle home:
oakcli create database -db sales2 -params salesdbtemplate
Creating a New Database as a Container Database
Create a version 12.1.0.2 container database called sales3:
oakcli create database -db sales3 -version 12.1.0.2 -cdb
Creating an Enterprise Edition Database
Create a version 12.1.0.2 database named DBPROD from the database configuration file named dbprodconf:
oakcli create database -db DBPROD -version 12.1.0.2 -params dbprodconf
The oakcli create database command starts a wizard that requires some basic inputs such has the root, oracle and SYSASM password. See "Creating a New Database Showing Prompts" for an example. After you enter the password information, specify the type of database and running node:
Please select one of the following for Database Deployment [1 .. 3]: Selected value is: ODADBI2-base 1 => EE : Enterprise Edition2 => RACONE3 => RAC1Selected value is: EEPlease select one of the following for Node Number [1 .. 2]:1 => ODADBI1-base2 => ODADBI2-base2 Selected value is: ODADBI2-base Specify the Database Class (1. Medium 2. Others) [1]:2Please 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)9 => odb-32 ( 32 cores , 256 GB memory)10 => odb-36 ( 36 cores , 256 GB memory)3 Selected value is: 2 cores
The database class only defines the Oracle Database Configuration Assistant (DBCA) template to be used for the database creation. Oracle Database Appliance comes with eight templates and none can be added. See Appendix B, "Database Templates for Oracle Database Appliance" for template specifications.
Use the oakcli create dbhome command to create a new database home on Oracle Database Appliance.
oakcli create dbhome [-version version] [-h]
| Parameter | Description |
|---|---|
-version version |
(Optional) Version that you want to install. If this is not provided, then Oracle Database Appliance uses the latest available version. |
-h |
(Optional) Display help for using the command. |
Create a database home called sales1 using Oracle Database version 12.1.0.2.4.
oakcli create dbhome -version 12.1.0.2.4
Use the oakcli create dbstorage command to create a storage structure for migrating databases from Oracle ASM to Oracle ACFS.
oakcli create dbstorage -db db_name [-cdb][-h]
| Parameter | Description |
|---|---|
-db db_name |
Sets up the required Oracle ACFS storage structure for the database to be created called db_name |
-cdb |
Must be passed if you are creating a multitenant container database |
-h |
(Optional) Display help for using the 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.
oakcli create db_config_params -conf filename [-h]
| Parameter | Description |
|---|---|
-conf filename |
Name you want to give to the configuration file, without its path name. |
-h |
(Optional) Display help for using the command |
Create 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]
| Parameter | Description |
|---|---|
repo_name |
Name assigned to the shared repository |
-size size [M|G] |
Amount of storage to be assigned to the shared repository. It can be defined in megabytes with the M option or in gigabytes with the G option. |
-dg DATA|RECO |
Oracle 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 |
-h |
(Optional) Display help for using the 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 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.
Create a 25-gigabyte shared repository named repoprod1 in the DATA+ disk group:
oakcli create repo repoprod1 -dg DATA -size 25
Use the oakcli create snapshotdb command to create a snapshot database from an existing database.
oakcli create snapshotdb [-db snap_dbname -from dbname] | [-h]
| Parameter | Description |
|---|---|
-db snap_dbname |
Name of the snapshot database to be created |
-from source_dbname |
Name of the source database |
-h |
(Optional) Display help for using the command |
Create a new snapshot database, name snapprod, from the database named prod:
oakcli create snapshotdb -db snapprod -from prod
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 -sparse [-h]
| Parameter | Description |
|---|---|
vdisk_name |
Name assigned to the virtual disk that is unique within the name repository |
-repo repository_name |
Name of the shared repository where the virtual disk will be created and from which it will acquire its storage |
-size size |
Amount of storage to be assigned from the shared repository to the shared disk. The default unit is G (for gigabytes) and the minimum size is 500 M (for megabytes) |
-type shared | local |
Sets the option of allowing the virtual disk to be shared by more than one virtual machine (shared) or used by only one virtual machine (local) |
-sparse |
Creates a sparse vdisk |
-h |
(Optional) Display help for using the command. |
Create a virtual disk named t2g in the shared repository named repoprod1 for use by only one virtual machine at a time in that repository. Assign the t2g virtual disk 2 GB in the repoprod1 shared repository.
oakcli create vdisk t2g -repo repoprod1 -type local -size 2G
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]
| Parameter | Description |
|---|---|
vlan_name |
Name assigned to the VLAN |
-vlanid tag_id |
Tag number, used for packet routing, from 2 to 4096 inclusive. It uniquely identifies the VLAN on a node. The same tag number can be used on both nodes. |
-if interface_name |
Name of the interface on which the VLAN network is created |
-node 0 | 1 |
Node on which the VLAN is created, either 1 or 2 |
-h |
(Optional) Display help for using the command. |
Create 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
Duplicating a VLAN on the Second Node
Create a VLAN named sample10 on Node 0:
oakcli create vlan sample10 -vlanid 10 -if bond1 -node 0
Use the oakcli delete commands to delete components from Oracle Database Appliance.
Deletes a CPU pool
Removes a database
oakcli delete db_config_params
Deletes a database configuration file
Deletes a database home
Deletes an ACFS storage structure
Deletes a shared repository
Deletes a virtual disk from a shared repository
Deletes an a VLAN
Deletes a virtual machine
Deletes a virtual machine template
Use the oakcli delete cpupool command to delete a CPU pool from one Oracle Database Appliance Virtualized Platform node.
oakcli delete cpupool poolname -node nodenum [-h]
| Parameter | Description |
|---|---|
poolname |
Name of the CPU pool to be deleted |
-node nodenum |
Node from which the CPU pool will be deleted (0 or 1) |
-h |
(Optional) Display help for using the command. |
Delete the CPU pool named twonode from Node 1 of Oracle Database Appliance Virtualized Platform:
oakcli delete cpupool twonode -node 1
Use the oakcli delete database command to delete a database from Oracle Database Appliance.
oakcli delete database -db db_name [-h]
| Parameter | Description |
|---|---|
db_name |
Name of the database to be deleted. |
-h |
(Optional) Display help for using the command |
Delete the database named sales1:
oakcli delete database -db sales1
Use the oakcli delete db_config_params command to delete a database configuration file.
oakcli delete db_config_params -conf filename [-h]
| Parameter | Description |
|---|---|
-conf filename |
Name of the configuration file that you want to remove, without its path name |
-h |
(Optional) Display help for using the command |
Use the oakcli delete dbhome command to delete a database home from Oracle Database Appliance.
oakcli delete dbhome -oh oracle_home [-h]
| Parameter | Description |
|---|---|
-oh oracle_home |
The database home to be uninstalled |
-h |
(Optional) Display help for using the command. |
Delete a database home called ora11_1:
oakcli delete dbhome -oh ora11_1
Use the oakcli delete dbstorage command to delete a storage structure that was created for the purpose of migrating databases from Oracle ASM to Oracle ACFS. For example, run this command if you created a storage structure using create dbstorage that is no longer required.
oakcli delete dbstorage -db db_name [-cdb] [-h]
| Parameter | Description |
|---|---|
db db_name |
Name of the database structure to be deleted |
-cdb |
Must be passed if you are deleting a multitenant container database |
-h |
(Optional) Display help for using the command |
Delete the sales storage structure:
oakcli delete dbstorage -db sales
Use the oakcli delete repo command to delete a shared repository.
oakcli delete repo repository_name [-h]
| Parameter | Description |
|---|---|
repository_name |
The name of the shared repository to be deleted |
-h |
(Optional) Display help for using the command. |
Delete the testrepo01 shared repository:
oakcli delete repo testrepo01
The command will not succeed if testrepo01 is active on one or both nodes.
Use the oakcli delete vdisk command to delete a virtual disk from a shared repository on Oracle Database Appliance Virtualized Platform.
oakcli delete vdisk vdisk_name -repo repository_name [-h]
| Parameter | Description |
|---|---|
vdisk_name |
Name assigned to the virtual disk |
-repo repository_name |
Name of the shared repository where the virtual disk was created |
-h |
(Optional) Display help for using the command. |
Remove a virtual disk named t2g from the shared repository named repoprod1:
oakcli delete vdisk t2g -repo repoprod1
Use the oakcli delete vlan command to delete a virtual local area network.
oakcli delete vlan vlan_name -node node_number [-h]
| Parameter | Description |
|---|---|
vlan vlan_name |
Name of the virtual local area network to be deleted |
-node node_number |
Oracle Database Appliance node from which you want to remove the virtual local area network |
-h |
(Optional) Display help for using the command. |
Delete the sample1 virtual local area network from Node 1:
oakcli delete vlan sample1 -node 1
Use the oakcli delete vm command to delete a virtual machine.
oakcli delete vm vm_name [-server node_number] [-h]
| Parameter | Description |
|---|---|
vm vm_name |
(Optional) Name of the virtual machine to be deleted |
-server node_number |
(Optional) Oracle Database Appliance node from which you want to remove the virtual machine. If this optional parameter is not included, then the virtual machine is removed from both nodes. |
-h |
(Optional) Display help for using the command. |
Delete the ovu22 virtual machine from Node 1:
oakcli delete vm ovu22 -server 1
Use the oakcli delete vmtemplate command to delete a virtual machine template.
oakcli delete vmtemplate template_name [-server=node_number][-h]
| Parameter | Description |
|---|---|
template_name |
Name of the virtual machine template to be removed |
-server node_number |
(Optional) Oracle Database Appliancenode from which you want to remove the virtual machine template. If this optional parameter is not included, then the virtual machine template is removed from both nodes. |
-h |
(Optional) Display help for using the command. |
Delete the ovu22 virtual machine template from both nodes:
oakcli delete vmtemplate ovu22
Use the oakcli deploy command to deploy Oracle Grid Infrastructure for a cluster on Oracle Database Appliance.
oakcli deploy [-config] [-conf config_file] [-advance][-h]
| Parameter | Description |
|---|---|
-config |
(Optional) Run the Oracle Appliance Manager configurator. |
-conf config_file |
(Optional) Preload the configuration stored in the named configuration file, config_file. |
-advance |
(Optional) Perform the deployment, or run the Oracle Appliance Manager configurator, in advance mode. |
-h |
(Optional) Display help for using the command. |
Deploying the Complete Oracle Database Appliance
oakcli deploy
oakcli deploy -config
Preloading an Existing Configuration File
Preload the configuration stored in the MYCONFIG-VM configuration file:
oakcli deploy -conf myconfig -vm_file
The oakcli deploy command creates a log file with the file name STEP* at /opt/oracle/oak/onecmd/tmp/.
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.
oakcli diskwritecache [disable disk_name | enable disk_name | status ] [-h]
| Parameter | Description |
|---|---|
disable disk_name |
(Optional) Disable disk write cache for named disk. |
enable disk_name |
(Optional) Enable disk write cache for named disk. |
status |
(Optional) Show the write cache status of all disks. |
-h |
(Optional) Display help for using the command. |
Show the write cache status of all disks:
oakcli diskwritecache status
Use the oakcli import vmtemplate command to import virtual machine templates.
oakcli import vmtemplate vmtemplatename -files image_files | -assembly assembly_file -repo repo_name [- node 0 | 1 ][-h]
| Parameter | Description |
|---|---|
vmtemplatename |
Name that you want to assign to the template |
-files |
Use the -files option when importing one or more files that comprise a template. |
image_files |
image_files is one of the following:
|
-assembly |
Use the -assembly option when importing an assembly file. |
assembly_file |
An assembly file, or a URL enclosed in single quotation marks, that links to an assembly file |
repo_name |
Name of the repository to store the template or templates that you are importing |
-node |
When you are importing to a shared repository, use the -node option with a value of 0 or 1 to identify the node. |
-h |
(Optional) Display help for using the command. |
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, and vmtemplatename3.
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 nonshared repositories will cause the command to fail.
Importing a VIrtual Machine Template from Dom0
Import the required template (OVM_OL5U7_X86_64_PVM_10GB.tgz) from the /OVS directory in Dom0 into the odarepo1 repository and name the template file OL5U7:
oakcli import vmtemplate OL5U7 -files /OVS/OVM_OL5U7_X86_64_PVM_10GB.tgz -repo odarepo1
Importing a Virtual Machine Template from a Remote Server
Import 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
Importing Virtual Machine Templates from an Assembly on a Remote Server
Import the templates contained in the assembly file stored on a remote server at the URL provided into the odarepo1 repository:
oakcli import vmtemplate OL6U1 -assembly 'http://example.com/assemblies/OEL6/OVM_OL6U1_x86_PVHVM.ova' -repo odarepo1
Importing Virtual Machine Templates Into a Shared Repository From an Assembly on a Remote Server
Import the templates contained in the assembly file 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 ASM disk by turning the disk's LED light on or off.
oakcli locate disk diskname [on|off][-h]
| Parameter | Description |
|---|---|
diskname |
Name of the Oracle ASM disk to locate |
on |
(Optional) Turns on the LED of the named disk |
off |
(Optional) Turns off the LED of the named disk |
-h |
(Optional) Display help for using the command. |
Turn on the LED of the Oracle ASM disk named disk pd_23:
oakcli locate disk pd_23 on
Use the oakcli manage diagcollect command to collect diagnostic information about Oracle Database Appliance for troubleshooting purposes, and for working with Oracle Support Services.
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][-h]
Use the oakcli migrate vm command to migrate a currently running virtual machine to another node.
oakcli migrate vm vmname [-h]
| Parameter | Description |
|---|---|
vmname |
Name of the virtual machine to be migrated |
-h |
(Optional) Display help for using the command. |
Use the oakcli modify command to:
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]
| Parameter | Description |
|---|---|
vmname |
Name of the virtual machine |
vmtemplatename |
Virtual machine template being modified |
-attachvdisk vdisk_name |
Attach the named virtual disk to the named virtual machine. |
-detachvdisk vdisk_name |
Detach the named virtual disk from the named virtual machine. |
-s key1:value1;key2:value2;... |
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 quotation marks |
-addnetwork network |
Identifies a new network to be assigned to the named virtual machine or template |
-deletenetwork network |
Identifies the network to be deleted from the named virtual machine or template |
-h |
(Optional) Display help for using the command. |
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.
Modifying the Network Defined in a Virtual Machine Template
Replace the network assigned to the gc_11g virtual machine template with the net1 network:
oakcli modify vmtemplate gc_11g -addnetwork net1
Sending a Message to a Running Virtual Machine
Update 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 [-a|-b|-v|-h|-p|-f|-m[-u -o][o]-c -t][-clusternodes |-localonly][-debug][-dbnames |-dbnone|-dball][upgrade]listlist
| Parameter | Description |
|---|---|
-a |
Perform a best practice check and recommended patch check. |
-b |
Perform a best practice check only without the recommended patch check. |
-v |
Display version. |
-h |
Display command usage (help). |
-p |
Perform patch check only. |
-f |
Run the command offline. |
-m |
Exclude checks for Maximum Availability scorecards. |
-u -o |
Perform check on pre-upgrade best practices (-u -o pre) or on post-upgrade best practices (-u -o post). |
-o |
As an argument to an option, if -o is followed by v, V, Verbose, or VERBOSE, output will display checks that pass on the display. Without the -o option, only failures will display on the screen. |
-c |
Determines granularity of information displayed on the screen. For use only when working with Oracle Support Services. |
-clusternodes list |
list is a comma-delimited list containing the names of the nodes where the command should run. |
-localonly |
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 utility being run. |
The command offers multiple options that are generic to the ORAchk command when run on servers other than the Oracle Database Appliance server. 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 Oracle ASM to Oracle ACFS. You can check the current space usage using oakcli show fs and then add or remove space using oakcli resize dbstorage.
oakcli resize dbstorage -data size -reco size -redo size -db db_name [-h]
| Parameter | Description |
|---|---|
-data size |
Extendable size in GB for the DATA volume |
-reco size |
Extendable size in GB for the REDO volume |
-redo size |
Extendable size in GB for the RECO volume |
-db db_name |
Database for which these volumes must be resized |
-h |
(Optional) Display help for using the command. |
Increase the size of the volume by 10 GB on the DATA volume:
oakcli resize dbstorage -data 10G
Use the oakcli restart oda_base command to stop and restart ODA_BASE on the local node. Use this command only when you are not concerned about the current status of ODA_BASE, because it performs a forced shutdown. You must run this command from Dom0 and, typically, if ODA_BASE needs to be restarted, you must restart it on both nodes.
oakcli restart oda_base [-h]
The ODA_BASE to be restarted is on the same node as the Dom0 from which you run this command.
(Optional) -h displays help for using the command.
Use the oakcli show commands to display the status of Oracle Database Appliance components.
The oakcli show commands display status information 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.
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 configuration file names and parameters
Displays information about the database homes
Displays database storage information for databases created on Oracle Automatic Storage Management Cluster File System (ACFS)
Displays information about shared or local disks
Displays information about Oracle ASM disk groups
Displays the current node's environment type and hardware version
Displays information about the SAS 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 the status of the RAID rebuild after a failed local disk is replaced
Displays information about virtual machine repositories
Displays information about the server subsystem
Displays information about the storage for controllers, expanders, and disks
oakcli show validation storage
Displays status (enabled or disabled) of validation storage
oakcli show validation storage errors
Displays hard storage errors
oakcli show validation storage failures
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 virtual machine names, memory and vCPU allocations, status, virtual disks, and the repository name for a virtual machine
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 this section 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.
oakcli show asr [-h]
(Optional) -h displays the help for using this command.
Use the oakcli show cooling command to display the status of the cooling units.
oakcli show cooling [-h]
(Optional) -h displays the help for using this command.
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 disk controllers.
oakcli show controller controller_id [-h]
| Parameter | Description |
|---|---|
controller_id |
Specifies the controller for which the information should be displayed |
-h |
(Optional) Display help for using the command. |
Display details of controller 0:
oakcli show controller 0
Use the oakcli show core_config_key command to display information about how to deploy your Oracle Database Appliance cores.
oakcli show core_config_key
Determining Whether the Oracle Database Appliance Core Configuration Key Has Been Applied
Show 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!
Displaying the Oracle Database Appliance Core Count Status on a Configured Oracle Database Appliance
Show the core count status on a previously configured Oracle Database Appliance:
oakcli show core_config_key Host's serialnumber = 1132FMW003 Configured Cores = 20
Use the oakcli show cpupool command to display core allocations to virtual machine mappings.
oakcli show cpupool -node nodenum
nodenum is the number of the Oracle Database Appliance node that you want to examine, either 0 or 1.
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.
oakcli show databases [-h]
(Optional) -h displays help for using the command.
#oakcli show databases Name Type Storage HomeName HomeLocation Version ---- ---- ------- -------- ------------ ------- db1 RAC ACFS OraDb12102_home1 /u01/app/oracle/product/12.1.0.2/dbhome_1 12.1.0.2.5(21359755,21359758) db2 SINGLE ACFS OraDb12102_home2 /u01/app/oracle/product/12.1.0.2/dbhome_2 12.1.0.2.5(21359755,21359758) db3 RACOneNode ACFS OraDb12102_home3 /u01/app/oracle/product/12.1.0.2/dbhome_3 12.1.0.2.5(21359755,21359758) db4 RAC ACFS OraDb12102_home4 /u01/app/oracle/product/12.1.0.2/dbhome_4 12.1.0.2.5(21359755,21359758)
Use the oakcli show db_config_params command to display configuration file names and parameters. By default, the command will search for files with the extension .dbconf located in the /opt/oracle/oak/install/dbconf directory.
oakcli show db_config_params [-conf filename] [-detail] [-h]
| Parameter | Description |
|---|---|
-conf filename |
(Optional) Name of configuration file to be displayed. If not included, then the command displays all configuration files. |
-detail |
(Optional) Display the parameter values stored in the configuration file or files. |
-h |
(Optional) Display help for using the command. |
Display the default database configuration parameter values stored in the configuration file or files:
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 dbhomes command to display information about each existing Oracle database home, including home name, home location, and database version.
oakcli show dbhomes [-detail] [-h]
| Parameter | Description |
|---|---|
-detail |
(Optional) Include a list of databases associated with each home. |
-h |
(Optional) Display help for using the command. |
oakcli show dbhomes -detail Oracle HomeName Oracle Home Version Oracle HomeLocation Database Name Database Type --------------- ------------------- ------------------- ------------- ------------- OraDb11203_home1 11.2.0.3.15(20760997,17592127) /u01/app/oracle/product/11.2.0.3/dbhome_1 no DB available OraDb11204_home1 11.2.0.4.8(21352635,21352649) /u01/app/oracle/product/11.2.0.4/dbhome_1 no DB available OraDb12102_home1 12.1.0.2.5(21359755,21359758) /u01/app/oracle/product/12.1.0.2/dbhome_1 one43 RACOneNode OraDb12102_home1 12.1.0.2.5(21359755,21359758) /u01/app/oracle/product/12.1.0.2/dbhome_1 ee120 SINGLE OraDb12102_home1 12.1.0.2.5(21359755,21359758) /u01/app/oracle/product/12.1.0.2/dbhome_1 one311 RACOneNode OraDb12102_home1 12.1.0.2.5(21359755,21359758) /u01/app/oracle/product/12.1.0.2/dbhome_1 ee311 SINGLE OraDb12102_home1 12.1.0.2.5(21359755,21359758) /u01/app/oracle/product/12.1.0.2/dbhome_1 rac311 RAC OraDb12102_home1 12.1.0.2.5(21359755,21359758) /u01/app/oracle/product/12.1.0.2/dbhome_1 ee43 SINGLE OraDb12102_home1 12.1.0.2.5(21359755,21359758) /u01/app/oracle/product/12.1.0.2/dbhome_1 one120 RACOneNode OraDb12102_home1 12.1.0.2.5(21359755,21359758) /u01/app/oracle/product/12.1.0.2/dbhome_1 odacn RAC OraDb12102_home1 12.1.0.2.5(21359755,21359758) /u01/app/oracle/product/12.1.0.2/dbhome_1 rac43 RAC OraDb12102_home1 12.1.0.2.5(21359755,21359758) /u01/app/oracle/product/12.1.0.2/dbhome_1 rac120 RAC
Use the oakcli show dbstorage command to display database storage information for databases created on Oracle Automatic Storage Management Cluster File System (Oracle ACFS). By default, all non-cdb databases will be listed together, because they share a common set of volumes. Each CDB database will be listed separately.
oakcli show dbstorage [-db ][-h]db_name
| Parameter | Description |
|---|---|
-db dbname |
(Optional) Display the name of the database for the storage information. |
-h |
(Optional) Display help for using the command. |
Example 1: Oracle Database Appliance X3-2 or X4-2 with a Storage Expansion Shelf
Here is an example of the oakcli show dbstorage command output for an Oracle Database Appliance plus the storage expansion shelf. The output includes both CDB and non-CDB databases. The Available heading shows the available AFCS storage, which can be auto-extended. Half of the available disk group storage is allocated to Oracle ACFS, except for the FLASH disk group. In the FLASH disk group, all storage is allocated to Oracle ACFS.
# oakcli show dbstorage
All the DBs with DB TYPE as non-CDB share the same volumes
DB_NAMES DB_TYPE Filesystem Size Used Available AutoExtend Size DiskGroup
-------- ------- ---------- ---- ---- --------- --------------- ---------
odacn CDB /u01/app/oracle/oradata/rdoodacn 5G 3.15G 1.85G 1G REDO
/u02/app/oracle/oradata/datodacn 100G 3.86G 96.14G 10G DATA
/u01/app/oracle/fast_recovery_area/rcoodacn 132G 0.92G 131.08G 13G RECO
rac120, rac401, ra non-CDB /u01/app/oracle/oradata/datastore 60G 11.30G 48.70G 5G REDO
c408
/u02/app/oracle/oradata/datastore 1027G 5.77G 1021.23G 102G DATA
/u01/app/oracle/fast_recovery_area/datastore 1336G 7.27G 1328.73G 133G RECO
cdbracon CDB /u01/app/oracle/oradata/rdocdbracon 6G 4.15G 1.85G 1G REDO
/u02/app/oracle/oradata/datcdbracon 100G 4.05G 95.95G 10G DATA
/u01/app/oracle/fast_recovery_area/rcocdbracon 132G 0.79G 131.21G 13G RECO
Example 2: Oracle Database Appliance X5-2 with a Storage Expansion Shelf and Non-CDB Databases
Here is an example of the oakcli show dbstorage command output for an Oracle Database Appliance plus the storage expansion shelf. The output includes only non-CDB databases. Half of the available disk group storage is allocated to Oracle ACFS, except for the FLASH disk group. In the FLASH disk group, all storage is allocated to Oracle ACFS.
# oakcli show dbstorage
All the DBs with DB TYPE as non-CDB share the same volumes
DB_NAMES DB_TYPE Filesystem Size Used Available AutoExtend Size DiskGroup
-------- ------- ---------- ----- ---- --------- --------------- ---------
db1, db2, db3, db4 non-CDB /u01/app/oracle/oradata/datastore 62G 27.26G 34.74G 6G REDO
/u02/app/oracle/oradata/datastore 3730G 7.86G 3722.14G 373G DATA
/u02/app/oracle/oradata/flashdata 558G 205.25G 352.75G 55G FLASH
/u01/app/oracle/fast_recovery_area/datastore
4958G 21.05G 4936.95G 495G RECO
Use the oakcli show disk command to display disk information.
oakcli show disk [-shared | -local | -shared_disk_name |-asm [-all][-h]
| Parameter | Description |
|---|---|
-local |
(Optional) Display information for all of the local disks. |
-shared |
(Optional) Display information for all of the shared disks. |
-shared_disk_name |
(Optional) Display information for only the specified shared disk. |
-asm |
(Optional) Displays information for an assembly. |
-all |
(Optional) Display complete details of the selected disk or disks. |
-h |
(Optional) Display help for using the command. |
Running the command with no parameters is identical to running the oakcli show disk -shared command.
The -all parameter produces valid output only when used with the shared_disk_name parameter. All other parameters are optional and cannot be combined with other parameters.
Displaying Information About the Local Disks
oakcli show disk -local
Displaying Information About the Shared Disks
oakcli show disk -shared
Displaying Information About a Specific Shared Disk
Display information about the shared disk named pd_01:
oakcli show disk -shared pd_01
Use the oakcli show diskgroup command to display Oracle Automatic Storage Management (Oracle ASM) disk group information.
oakcli show diskgroup [disk_group_name][-h]
| Parameter | Description |
|---|---|
disk_group_name |
(Optional) The name of an Oracle ASM disk group for which complete details should be displayed. If you do not specify this parameter, then information for all of the Oracle ASM disk groups is displayed. |
-h |
(Optional) Display help for using the command. |
Use the oakcli show enclosure command to display information about the storage enclosure subsystem on the node where the command is executed.
oakcli show enclosure [-h]
-h displays help for using the command.
Use the oakcli show env_hw command to display the environment type and hardware version of the current node.
oakcli show env_hw [-h]
(Optional) -h displays help for using the command.
Show the environment type and hardware model when logged in to ODA_BASE on Oracle Database Appliance X3-2 Virtualized Platform:
oakcli show env_hw VM-ODA_BASE ODA X3-2
Use the oakcli show expander command to display information about a SAS expander.
oakcli show expander [expander_id] [-h]
| Parameter | Description |
|---|---|
expander_id |
(Optional) Identifies the specific SAS expander |
-h |
(Optional) Display help for using the command. |
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.
oakcli show fs [-h]
(Optional) -h displays help for using the command.
Use the oakcli show ib command to display InfiniBand card and port information if InfiniBand exists in the system.
oakcli show ib [-h]
(Optional) -h displays help for using the command.
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.
oakcli show iraid [-h]
(Optional) -h displays help for using the command.
Use the oakcli show memory command to display information about memory modules.
oakcli show memory [-h]
(Optional) -h displays help for using the command.
Use the oakcli show network command to display information about the network subsystem.
oakcli show network
(Optional) -h displays help for using the command.
Use the oakcli show power command to display information about the power supply subsystem.
oakcli show power [-h]
(Optional) -h displays help for using the command.
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.
oakcli show processor [-h]
(Optional) -h displays help for using the command.
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.
Note:
Theshow raidsyncstatus command is only supported on a bare metal platform; it is not supported on the virtualized platform. For general RAID information, use the oakcli show iraid command.oakcli show raidsyncstatus [-h]
(Optional) -h displays help for using the command.
Use the oakcli show repo command to display information about virtual machine repositories. To see all repositories, omit the repository name and node number. To see a specific shared repository, include the repository name and node.
oakcli show repo [reponame -node 0|1] [-h]
| Parameter | Description |
|---|---|
reponame |
[Optional] Identifies a specific repository name |
-node |
[Optional] Identifies the node number 0 or 1 |
-h |
[Optional] Display help for using the command. |
Displaying the Available Virtual Machine Repositories
Display the virtual machine repositories on Oracle Database Appliance Virtualized Platform nodes:
oakcli show repo
NAME REPOTYPE NODENUM
odarepo1 local 0
odarepo2 local 1
repo1 shared 0
repo1 shared 1
Displaying Details About a Specific Shared Repository
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.
oakcli show server [-h]
(Optional) -h displays help for using the command.
Use the oakcli show storage command to display information about the storage for controllers, expanders, and disks.
oakcli show storage -errors [-h]
| Parameter | Description |
|---|---|
-errors |
Display detailed information about reported errors. |
-h |
(Optional) Display help for using the command. |
Use the oakcli show validation storage command to show whether validation storage is enabled or disabled.
oakcli show validation storage [-h]
(Optional) -h displays help for using the command.
oakcli show validation storage Enabled
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.
oakcli show validation storage errors [-h]
(Optional) -h displays help for using the command.
Use the oakcli show validation storage failures command to show soft validation errors. A typical soft disk error would be an invalid version of the disk firmware.
oakcli show validation storage failures [-h]
(Optional) -h displays help for using the command.
Use the oakcli show vdisk command to display information about virtual disks on Oracle Database Appliance Virtualized Platform.
oakcli show vdisk [vdisk_name -repo repository_name] [-h]
| Parameter | Description |
|---|---|
vdisk_name |
(Optional) Display information for just one virtual disk. |
-repo repository_name |
Required parameter if a virtual disk is specified in the command |
-h |
(Optional) Display help for using the command. |
Display the Information for All Virtual Disks
Display information about all virtual disks on Oracle Database Appliance Virtualized Platform:
# oakcli show vdisk
NAME SIZE TYPE REPOSITORY
myvdisk 10G local vdiskrepo
newv 1G local vdiskrepo
Display Information for a Single Virtual Disk
Display information for the virtual disk named myvdisk1:
# 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.
oakcli show version [-detail][-h]
| Parameter | Description |
|---|---|
-detail |
(Optional) Display detailed version information. |
-h |
(Optional) Display help for using the command. |
Display the version information for the software and firmware on Oracle Database Appliance:
oakcli show version Version ------- 12.1.2.5.0
Use the oakcli show vlan command to display information about virtual local area networks configured on Oracle Database Appliance.
oakcli show vlan [-h]
(Optional) -h displays help for using the command.
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 bond1 0
net1 1 bond1 1
net2 1 bond2 0
net2 1 bond2 1
net3 1 bond3 0
net3 1 bond3 1
net4 1 xbond0 0
net4 1 xbond0 1
priv1 1 bond0 0
priv1 1 bond0 1
Use the oakcli show vm command to display information about virtual machines.
oakcli show vm [vm_name | -h]
| Parameter | Description |
|---|---|
vm_name |
(Optional) The name of the virtual machine for which details should be displayed. If you do not specify this parameter, then information for all the virtual machines is displayed. |
-h |
(Optional) Display help for using the command. |
Displaying Details for All Virtual Machines
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
Displaying Information for a Single Virtual Machine
Display 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 vmconsole command to open a GUI virtual machine console to manage a specific virtual machine.
oakcli show vmconsole vm_name [-h]
| Parameter | Description |
|---|---|
vm_name |
Name of the virtual machine for which you want to open a console |
-h |
(Optional) Display help for using the command. |
Open a console for the virtual machine named vm1_odarepo1:
oakcli show vmconsole vm1_odarepo1
Use the oakcli show vmtemplate command to display information about virtual machine templates.
oakcli show vmtemplate [vmtemplate_name | -h]
| Parameter | Description |
|---|---|
vmtemplate_name |
(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. |
-h |
(Optional) Display help for using the command. |
Display 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 commands to start a virtual machine, to start a shared repository on a node, or to start ODA_BASE on the local node.
Starts ODA_BASE on the local node
Starts a shared repository on the specified node, or if none is specified, both nodes
Starts a virtual machine on the specified node, or if none is specified, both nodes
Use the oakcli start oda_base command to start ODA_BASE on the local node.
oakcli start oda_base [-h]
(Optional) -h displays help for using the command.
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]
| Parameter | Description |
|---|---|
repo_name |
repo_name is the name of the shared repository to be started. |
-node node_number |
Specifies the node on which to start the shared repository. node_number is the number of the node where it is to be started, either 0 or 1. If -node is not specified, the shared repository is started on both nodes. |
-h |
(Optional) Displays help for using the command. |
Start 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]
| Parameter | Description |
|---|---|
vm_name |
vm_name is the name of the virtual machine to be started. |
-node node_number |
Specifies the node on which to start the virtual machine. node_number is the number of the node where it is to be started, either 0 or 1. If -node is not specified, a virtual machine is started on both nodes. |
-d |
Provides details about the virtual machine starting procedure |
-h |
(Optional) Display help for using the command. |
Start 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.
oakcli stop [vm vm_name [-force] | repo repo_name [-node node_number] | oda_base ] [-h]
| Parameter | Description |
|---|---|
vm vm_name |
vm_name is the name of the virtual machine to be stopped. |
-force |
(Optional) forces the virtual machine to stop. |
repo repo_name |
repo_name is the name of the shared repository to be stopped. |
-node node_number |
node_number is the number of the node where the shared repository is to be stopped, either 0 or 1. The -node parameter is only valid when stopping a virtual machine on a shared repository. If -node is not specified, the shared repository is stopped on both nodes. |
oda_base |
Stops ODA_BASE on the local node |
-h |
(Optional) Displays help for using the command. |
Forcing a Virtual Machine to Stop
Force the virtual machine named vm1_odarepo1 to stop:
oakcli stop vm vm_odarepo1 -force
Stop the shared repository named repo1 on Node 0:
oakcli stop repo repo1 -node 0
Connect to Dom0 on the desired node and enter the following command to stop ODA_BASE on that node:
oakcli stop oda_base
Use the oakcli stordiag command to run diagnostic tests on a disk in the storage shelf or storage expansion shelf. The tool produces a list of 14 disk checks for each node.
oakcli stordiag resource_type [n| -h]
| Parameter | Description |
|---|---|
resource_type |
Prefix that depends on the configuration. See "Usage Notes." |
n |
(Optional) Disk number (starting with 0 and increasing to one less than the number of disks) |
-h |
(Optional) Display help for using the 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 systems that have connected a storage shelf (and optional storage expansion shelf), use the format e[0..1] pd_[0..23] to identify the disk to be diagnosed.
Runs the diagnostic tests on disk 3 in the 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.
oakcli test asr [-h]
(Optional) -h displays help for using the command.
Use the oakcli unpack command to unpack packages into the Oracle Appliance Manager repository.
oakcli unpack -package absolute_package_name
| Parameters | Description |
|---|---|
absolute_package_name |
Identifies the package to be unpacked using the package's full absolute path and file name |
-h |
(Optional) Display help for using the command. |
Unpack the p13982331_23000_Linux-86-62.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][-h]
Update the current node with the 12.1.2.5.0 patch:
oakcli update -patch 12.1.2.5.0
Use the oakcli upgrade command to upgrade the Oracle Database software on Oracle Database Appliance. For patching Oracle Database Appliance itself, see the oakcli update command.
oakcli upgrade database [-db db_names | -from source_home] -to destination_home
| Parameter | Description |
|---|---|
-db db_names |
Specifies the name or names (in a comma-delimited list) of the database or databases you want to upgrade |
-from source_home |
Specifies the current Oracle Database home of the databases you are upgrading |
-to destination_home |
Specifies the Oracle Database home containing the version to which you want to upgrade the databases |
-h |
(Optional) Display help for using the command. |
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 that names an existing Oracle Database home.
Upgrade an Oracle 11.2.0.2.5 database named tpcc from Oracle Database 11.2.0.2.5 to Oracle Database 11.2.0.3.1 using the Oracle Database home directory OraDb11203_home1:
oakcli upgrade database -db tpcc -to OraDb11203_home1
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]]
| Parameter | Description |
|---|---|
-V |
Display the version of oakValidation. |
-l |
List the items that can be checked (and their descriptions). |
-h |
(Optional) Display help for using the command. |
-v |
Show verbose output (must be used with a parameter that generates a validation report). |
-f output_file |
Send output to a file with a fully qualified file name, output_file, instead of to the screen (stdout). |
-a |
Run all system checks, including DiskCalibration. Oracle recommends that you use this command to validate system readiness before deployment. Do not run oakcli validate with this option on a busy production system, because the DiskCalibration system check can cause performance issues.
See Table 5-2, "Oracle Database Appliance Validation Checks" for details about each check. |
-d |
Run only the default checks. The default checks are NetworkComponents, OSDiskStorage, SharedStorage, and SystemComponents. See Table 5-2, "Oracle Database Appliance Validation Checks" for details about each check. |
-c checklist |
Run the validation checks for the items identified in checklist, a comma-delimited list. Use this parameter to check either a single item or subset of items. |
-c ospatch |
Run the validation checks for the patch version identified in -ver patch_version. |
-ver patch_version |
Report any reasons for not being able to patch Oracle Database Appliance with the patch named in patch_version. |
See "Examples of OAKCLI Validate Command Checks," for examples of how to use the oakcli validate command to perform validation checks.