Skip Headers
Oracle® Database Appliance Getting Started Guide
Release 2.9 for Linux x86-64

E22692-35
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

D Oracle Appliance Manager (OAKCLI) Reference

This appendix describes how to use Oracle Appliance Manager (OAKCLI), the command line interface utility for managing Oracle Database Appliance. This appendix contains the following topics:

About Oracle Appliance Manager (OAKCLI)

Depending on your version of Oracle Appliance Manager and your hardware, you may not have all of the commands described in this Appendix available to you. To see which OAKCLI commands are supported on your version of Oracle Appliance Manager and your hardware, enter the following command: /opt/oracle/oak/bin/oakcli -h

This section contains the following OAKCLI topics:

Overview of Oracle Appliance Manager (OAKCLI)

Use OAKCLI to perform Oracle Database Appliance management tasks such as configuring core keys, applying patches, and deploying Oracle Database Appliance. Perform the following types of task with OAKCLI:

  • Apply the core configuration key

  • Configure the network for Oracle Database Appliance deployment

  • Copy the deployment configuration file

  • Deploy Oracle Database Appliance

  • Locate a disk on Oracle Database Appliance

  • Manage the Oracle Database Appliance repository

  • Manage the Oracle Database Appliance diagnostics collection

  • Update Oracle Database Appliance

  • Unpack packages into the OAKCLI repository

  • Validate Oracle Database Appliance

OAKCLI Operational Notes

Usage Information

The OAKCLI utility is in the following directory:

/opt/oracle/oak/bin/oakcli 

Oracle Database Appliance maintains logs of completed OAKCLI command runs in the following directory.

/opt/oracle/oak/log/hostname/client/oakcli.log

Using OAKCLI Help

Run the following command to see OAKCLI usage information:

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

Privileges and Security

Use OAKCLI by logging in as the root user. If you are logged in as a user other than root, then you may view storage information but not modify the configuration.

OAKCLI Command Reference

OAKCLI Command Syntax and Options

OAKCLI commands, object names, and options are case sensitive. OAKCLI 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 oakcli performs the operation, such as a disk or controller. You may also use object abbreviations.

  • parameters extend the use of a preceding command combination to include additional options for the command.

Table D-1 OAKCLI Utility Commands

Command Description

oakcli apply

Reconfigures Oracle Database Appliance core capacity

oakcli clone

Clones a virtual machine template

oakcli configure

Configures Oracle Database Appliance components

oakcli copy

Prepares a copy of the configuration file for use during deployment

oakcli create

Creates Oracle Database Appliance components

oakcli delete

Removes Oracle Database Appliance components

oakcli deploy

Deploys Oracle Database Appliance

oakcli disable validation storage

Disables reporting of validation storage errors

oakcli enable validation storage

Enables reporting of validation storage errors

oakcli import vmtemplate

Imports a virtual machine template

oakcli locate

Locates a disk

oakcli manage diagcollect

Collects diagnostic statistics and information, primarily for use when working with Oracle Support

oakcli modify

Add, updates, or removes a network from a virtual machine or template configuration

oakcli odachk

Audits configuration settings

oakcli show

Displays information about various Oracle Database Appliance components

oakcli show vmconsole

Opens a GUI VM console for a virtual machine.

oakcli start

Starts a virtual machine or the ODA_BASE domain

oakcli stop

Stops a virtual machine or the ODA_BASE domain

oakcli stordiag

Runs tests on a storage shelf or storage expansion shelf device

   

oakcli unpack

Unpacks the given package to the OAKCLI repository

oakcli update

Updates Oracle Database Appliance

oakcli validate

Validates Oracle Database Appliance


oakcli apply

Use the oakcli apply command to re-configure your Oracle Database Appliance core capacity.

Syntax

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]

Parameters

Table D-2 oakcli apply Command Parameters

Parameter Description

-h

Displays help

core_config_key_file

Full path and name of the configuration key file.


Usage Notes

  • Run the oakcli apply command from the first node in Oracle Database Appliance as root.

  • After you run the oakcli apply command, Oracle Database Appliance reboots both nodes.

Examples

Example 1   Configuring core capacity with a new configuration key file:

Re-configure 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'

oakcli clone

Use the oakcli clone command to clone a virtual machine template.

Syntax

Use the following syntax for the oakcli clone command:

oakcli clone vm vm_name -vmtemplate template_name -repo repo_name [-node 0|1]

Parameters

Table D-3 oakcli clone Command Parameters

Parameter Description

vm_name

vm_name is the virtual machine name.

-vmtemplate vmtemplate_name

vmtemplate_name is the name of the template that you want to clone.

-repo repo_name

repo_name is the name of the repository that contains the template being cloned.

-node 0 | 1

Use the value "0" to clone the virtual machine from a shared repository on Node 0 and the value "1" to clone the virtual machine from a shared repository on Node 1 .

The -node parameter must be used when cloning from a shared repository and is invalid for non-shared repositories.


Examples

Example 1   Create a Virtual Machine Image

Create a virtual machine image named myol15u_test from the virtual machine template named myol15u which is stored in the Node 0 repository:

oakcli clone vm myol15u_test -vmtemplate myol5u -repo odarepo1
Example 2   Create a Virtual Machine Image in a Shared Repository

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

oakcli configure

Use the oakcli configure command to configure components on Oracle Database Appliance.

Table D-4 oakcli configure Command Summary

Command Description

oakcli configure asr

Configures Oracle Auto Service Request for Oracle Database Appliance

oakcli configure cpupool

Configures a CPU pool

oakcli configure firstnet

Configures initial network information

oakcli configure oda_base

Configures CPU core count, memory allocation, virtual local area networks for the ODA_BASE domain

oakcli configure vm

Configures a virtual machine

oakcli configure vmtemplate

Configures a virtual machine template


oakcli configure asr

Use the oakcli configure asr command to configure Oracle Auto Service Request (Oracle ASR) on Oracle Database Appliance.

Syntax
oakcli configure asr [-h]

where -h will display online help for the command.

Usage Notes

  • The oakcli configure asr command initiates an interactive script that requests the following information to implement Oracle ASR on your Oracle Database Appliance:

    • Action to be performed (internal or external install, deinstall, or reconfigure)

    • PROXY server name, port, user ID, and password

    • ASR user ID and password

    • ASR Manager IP and port

oakcli configure cpupool

Use this command to configure a CPU pool on one Oracle Database Appliance Virtualized Platform node.

Syntax
oakcli configure cpupool poolname -numcpu cpu_count -node nodenum [-h]
Parameters

Table D-5 oakcli configure cpupool Command Parameters

Parameter Description

poolname

Uniquely names the CPU pool.

-numcpu cpu_count

Defines the number of CPUs for the CPU pool.

-node nodenum

Defines the node where the CPU pool will be created (0 or 1).

-h

(Optional) Displays the help usage for this command.


Examples

Example 1   Configuring a Two Core CPU Pool:

Configure a CPU pool with two cores on Node 1 of Oracle Database Appliance Virtualized Platform:

oakcli configure cpupool twonode -numcpu 2 -node 1

oakcli configure firstnet

Use the oakcli configure firstnet command to configure an initial network on Oracle Database Appliance that enables you to download deployment software.

Syntax
oakcli configure firstnet

Examples

Example 1   Configuring the Initial Network on Bare Metal Oracle Database Appliance

The following command creates an initial network on a new Oracle Database Appliance using the interactive script, as shown in the following:

oakcli configure firstnet
Select the interface to configure network on [bond0 bond1 bond2 xbond0]:bond0
Configure DHCP on bond0?(yes/no):no
       INFO: Static configuration selected
       Enter the IP address to configure:192.0.2.18
       Enter the netmask address to configure:255.255.252.0
       Enter the gateway address to configure:192.0.2.1
Plumbing the IPs now
Restarting the network
:::::::::::::::::

Note:

Oracle recommends using the oakcli 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.

oakcli configure oda_base

Use the oakcli configure oda_base command: to change the CPU core count assigned to the ODA_BASE domain or to add or remove virtual local area networks an initial network on Oracle Database Appliance that enables you to download deployment software.

  • To change the CPU core count assigned to the ODA_BASE domain

  • To change the amount of memory assigned to ODA_BASE

  • To add virtual local area networks to the ODA_BASE domain

  • To remove virtual local area networks to the ODA_BASE domain

Syntax
oakcli configure oda_base

Examples

Example 1   Changing the CPU core count in ODA_BASE:

Enter the following command to change the CPU core count from six to eight in ODA_BASE:

/opt/oracle/oak/bin/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

oakcli configure vm

Use the oakcli configure vm command to configure a virtual machine on Oracle Database Appliance Virtualized Platform.

Syntax
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]
Parameters

Table D-6 oakcli configure vm Command Parameters

Parameter Description

name

The name assigned to the virtual machine.

-vcpu cpucount

Number of nodes assigned to the virtual machine. This number depends on your Oracle Database Appliance configuration:

  • On Oracle Database Appliance X4-2, the range is from 1 to 48.

  • On Oracle Database Appliance X3-2, the range is from 1 to 32

  • On Oracle Database Appliance, the range is 1 to 24

-maxvcpu maxcpu

Maximum number of CPUs that the virtual machine can consume. This number depends on your Oracle Database Appliance configuration:

  • On Oracle Database Appliance X4-2, the range is from 1 to 48.

  • On Oracle Database Appliance X3-2, the range is from 1 to 32

  • On Oracle Database Appliance, the range is 1 to 24

-cpuprio priority

Priority for CPU usage, where larger values have higher priority (1 - 256).

-cpucap cap

Percentage of a CPU the virtual machine can receive (1 - 100).

-memory memsize

Amount of memory given to the virtual machine: (1-88)G or (1-90112)M. Default is M.

-maxmemory max_memsize

Maximum amount of memory allowed for the virtual machine: (1-88)G or (1-90112)M. 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:

  • Hardware virtualized guest (XEN_HVM)

    - The kernel or operating system is not virtualization-aware and can run unmodified.

    - Device drivers are emulated.

  • Para virtualized guest (XEN_PVM)

    - The guest is virtualization-aware and is optimized for a virtualized environment.

    - PV guests use generic, idealized device drivers.

  • Hardware virtualized guest (XEN_HVM_PV_DRIVERS)

    The PV drivers are hypervisor-aware and significantly reduce the overhead of emulated device input/output.

-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 virtual machine (PXE, DISK, or CDROM).

-cpupool pool

Assign the named CPU pool to virtual machine.

-prefnode 0|1

Define the node, 0 or 1, where the virtual machine should attempt to start. This parameter is only valid for virtual machines created in shared repositories.

-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.


Usage Notes

  • 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 at http://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 options

Examples

Example 1   Changing virtual machine count and virtual memory size for a virtual machine

Enter the following command to change 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 

oakcli configure vmtemplate

Use the oakcli configure vmtemplate command to configure a virtual machine template on Oracle Database Appliance Virtualized Platform.

Syntax
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]
Parameters

Table D-7 oakcli configure vmtemplate Command Parameters

Parameter Description

name

The name assigned to the virtual machine template.

-vcpu cpucount

Number of nodes assigned to virtual machines cloned from the template.

  • On Oracle Database Appliance X4-2, the range is from 1 to 48.

  • On Oracle Database Appliance X3-2, the range is from 1 to 32

  • On Oracle Database Appliance, the range is 1 to 24

-maxvcpu maxcpu

Maximum number of CPUs that virtual machines cloned from the template can consume.

  • On Oracle Database Appliance X4-2, the range is from 1 to 48.

  • On Oracle Database Appliance X3-2, the range is from 1 to 32

  • On Oracle Database Appliance, the range is 1 to 24

-cpuprio priority

Priority for CPU usage, where larger values have higher priority (1 - 256).

-cpucap cap

Percentage of a CPU that virtual machines cloned from the template can receive (1 - 100).

-memory memsize

Amount of memory given to virtual machines cloned from the template (1G - 88 G or 1M - 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:

  • Hardware virtualized guest (XEN_HVM)

    - The kernel or operating system is not virtualization-aware and can run unmodified.

    - Device drivers are emulated.

  • Para virtualized guest (XEN_PVM)

    - The guest is virtualization-aware and is optimized for a virtualized environment.

    - PV guests use generic, idealized device drivers.

  • Hardware virtualized guest (XEN_HVM_PV_DRIVERS)

    The PV drivers are hypervisor-aware and significantly reduce the overhead of emulated device input/output.

-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.


Usage Notes

  • 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 at http://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 options

Examples

Example 1   Configure a Virtual Machine Template

Set values for the following configuration values in the virtual machine template named myol5u7_10gb:

  • Number of CPUs assigned when the virtual machine starts up (vcpu)

  • Maximum number of CPUs that can be assigned to the virtual machine (maxvcpu)

  • Maximum percentage of a CPU's capacity that will be assigned to the virtual machine (cpucap)

  • Amount of memory assigned when the virtual machine starts up (memory)

  • Maximum amount of memory that can be assigned to the virtual machine (maxmemory)

  • Network used to access the virtual machine (network)

  • Operating system used by the virtual machine (os)

oakcli configure vmtemplate myol5u7_10gb
-vcpu 2 -maxvcpu 4 -cpucap 40 -memory 1536M -maxmemory 2G
-network "['type=netfront,bridge=net1']" -os OTHER_LINUX

oakcli copy

Use the oakcli copy command to prepare a copy of the configuration file for use during the configuration of Oracle Database Appliance.

Syntax

Run the oakcli copy command as follows, where absolute_conf_file is the full path name of an existing configuration file:

oakcli copy -conf absolute_conf_file [-h]

Parameters

Table D-8 oakcli copy Command Parameters

Parameter Description

-conf absolute_conf_file

Specifies the full path name of the configuration file.

-h

(Optional) Displays help


Examples

Example 1   Preparing a copy of the configuration file

If you created a configuration file previously and copied this file to Oracle Database Appliance, then prepare the configuration file to use 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

oakcli create

Use the oakcli create command to create components on Oracle Database Appliance.

Table D-9 oakcli create Command Summary

Command Description

oakcli create cpupool

Creates a new CPU pool

oakcli create database

Creates a new database

oakcli create dbhome

Creates a new database home

oakcli create db_config_params

Creates a database configuration file

oakcli create repo

Creates a virtual local area network on a Oracle Database Appliance Virtualized Platform node

oakcli create vlan

Creates a virtual local area network on a Oracle Database Appliance Virtualized Platform node


oakcli create cpupool

Use this command to create a CPU pool on one Oracle Database Appliance Virtualized Platform node.

Syntax
oakcli create cpupool poolname -numcpu cpu_count -node nodenum [-h]
Parameters

Table D-10 oakcli configure cpupool Command Parameters

Parameter Description

poolname

Uniquely names the CPU pool.

-numcpu cpu_count

Defines the number of CPUs for the CPU pool.

-node nodenum

Defines the node where the CPU pool will be created (0 or 1).

-h

(Optional) Displays the help usage for this command.


Examples

Example 1   Creating a Two Core CPU Pool:

Create a CPU pool with two CPUs on Node 1 of Oracle Database Appliance Virtualized Platform:

oakcli create cpupool twonode -numcpu 2 -node 1

oakcli create database

Use the oakcli create database command to create additional databases on Oracle Database Appliance.

syntax

oakcli create database -db db_name [-oh home | -version version] [-params params_file]

Parameters

Table D-11 oakcli create database Command Parameters

Parameter Description

-db db_name

db_name is the name of the database that you want to create

-oh home

home is the 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 is the version that you want to install. By default, Oracle Database Appliance uses the latest version.

-params params_file

(Optional) params_file is the configuration file. By default, Oracle Database Appliance uses the default configuration file.


Usage Notes
  • The -oh parameter and the -version parameters are mutually exclusive. Attempting to use both in the same command will generate an error.

  • When a database is created without identifying an Oracle Home, a new Oracle Home is created, using a standard naming convention, for example, OraDb11203_home3. The number at the end of the name is incremented by one for each new home created with the same version number.

  • When you upgrade the database, infrastructure, and Oracle Grid Infrastructure, you must specify an existing home to create a new database.

  • If you try to create a database using the option -version version before downloading and unpacking the the specific version DB clone files, then the command will fail.

Examples
Example 1   Creating a new database in an existing Oracle Home

The following command creates a database called sales1 in OraDb11203_home2.

oakcli create database -db sales1 -oh OraDb11203_home2
Example 2   Creating a new database from a template

The following command creates a database called sales2 from the salesdbtemplated.dbconf file (by appending the default file extension to the file name provided). The command also creates a new Oracle Home.

oakcli create database -db sales2 -params salesdbtemplate

oakcli create dbhome

Use the oakcli create dbhome command to create a new database home on Oracle Database Appliance.

syntax

oakcli create dbhome [-version version] [-h]

Parameters

Table D-12 oakcli create dbhome Command Parameters

Parameter Description

-version version

(Optional) version is the version that you want to install. If not provided, Oracle Database Appliance uses the latest available version.

-h

(Optional) Displays the help usage for this command


Examples
Example 1   Creating a new database home for version 11.2.0.2

The following command creates a database called sales1 using version 11.2.0.2:

oakcli create dbhome -version 11.2.0.2

oakcli create db_config_params

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.

Syntax
oakcli create db_config_params -conf filename -h
Parameters

Table D-13 oakcli create db_config_params Command Parameters

Parameter Description

-conf filename

filename is the name you want to give to the configuration file, without its pathname.

-h

(Optional) Displays the help usage for this command


Examples
Example 1   Creating a new database configuration file

The following command creates the database parameter file /opt/oracle/oak/install/dbconf/newconf.dbconf.

oakcli create db_config_params -conf newconf

oakcli create repo

Use the oakcli create repo command to create a new shared repository on Oracle Database Appliance Virtualized Platform.

Syntax
oakcli create repo repo_name -dg data|reco -size size_in_gigabytes -h

where repo_name is the name assigned to the shared repository and the parameters are described in the following table (Table D-15).

Parameters

Table D-14 oakcli create repo Command Parameters

Parameter Description

-dg data | recotag_id

The ASM disk group in which the shared repository is to be stored, either data (for the DATA+ disk group) or reco (for the RECO+ disk group)

-size size_in_gigabytes

size_in_gigabytes is the number of gigabytes of storage to be assigned to the shared repository.

-node 0 | 1

The node on which the VLAN is created, either 1 or 2.

-h

(Optional) Displays the help usage for this command.


Examples
Example 1   Creating a new shared repository

The following command creates a 25 gigabyte shared repository named repoprod1 in the DATA+ disk group.

oakcli create repo repoprod1 -dg data -size 25

oakcli create vlan

Use the oakcli create vlan command to create a new virtual local area network (VLAN) on an Oracle Database Appliance Virtualized Platform node.

Syntax
oakcli create vlan vlan_name -vlanid tag_id -if interface_name -node 0|1 -h

where vlan_name is the name assigned to the VLAN and the parameters are described in the following table (Table D-15).

Parameters

Table D-15 oakcli create vlan Command Parameters

Parameter Description

-vlanid tag_id

tag_id is a tag number, used for packet routing, from 2 to 4096 inclusive that uniquely identifies the VLAN on a node. The same tag number can be used on both nodes.

-if interface_name

interface_name is the name of the interface on which the VLAN network is created.

-node 0 | 1

The node on which the VLAN is created, either 1 or 2.

-h

(Optional) Displays the help usage for this command.


Examples
Example 1   Creating a new virtual local area network

The following command creates a VLAN named sample10 on Node 1 using the bond1 interface and a tag with the number 10.

oakcli create vlan sample10 -vlanid 10 -if bond1 -node 1
Example 2   Duplicating a virtual local area network on the second node

The following command creates the same VLAN as Example 1 (named sample10) on Node 0.

oakcli create vlan sample10 -vlanid 10 -if bond1 -node 0

oakcli delete

Use the oakcli delete command to delete components from Oracle Database Appliance.

Table D-16 oakcli delete Command Summary

Command Description

oakcli delete cpupool

Deletes an existing CPU pool

oakcli delete database

Removes an existing database

oakcli delete dbhome

Deletes an existing database home

oakcli delete db_config_params

Deletes a database configuration file

oakcli delete repo

Deletes an existing shared repository

oakcli delete vlan

Deletes an existing virtual machine

oakcli delete vm

Deletes an existing virtual machine

oakcli delete vmtemplate

Deletes an existing VM template


oakcli delete cpupool

Use this command to delete a CPU pool from one Oracle Database Appliance Virtualized Platform node.

Syntax
oakcli delete cpupool poolname -node nodenum [-h]
Parameters

Table D-17 oakcli configure cpupool Command Parameters

Parameter Description

poolname

Names the CPU pool to be deleted.

-node nodenum

Defines the node from which the CPU pool will be deleted (0 or 1).

-h

(Optional) Displays the help usage for this command.


Examples
Example 1   Deleting a CPU Pool:

Delete the CPU pool named twonode from Node 1 of Oracle Database Appliance Virtualized Platform:

oakcli delete cpupool twonode -node 1

oakcli delete database

Use the oakcli delete database command to delete a database from Oracle Database Appliance.

syntax

oakcli delete database -db db_name [-h]

where and displays the help usage for this command.

Examples
Example 1   Deleting a database

The following command deletes the database named sales1:

oakcli delete database -db sales2

oakcli delete dbhome

Use the oakcli delete dbhome command to delete a database home from Oracle Database Appliance.

syntax

oakcli delete dbhome -oh oracle_home [-h]

Parameters

Table D-18 oakcli delete dbhome Command Parameters

Parameter Description

oracle_home

oracle_home is the database home to be deinstalled.

-h

(Optional) Displays the help usage for this command


Examples
Example 1   Deleting an existing database home

The following command deletes a database home called ora11_1:

oakcli delete dbhome -oh ora11_1

oakcli delete db_config_params

Use the oakcli delete db_config_params command to delete a database configuration file.

Syntax
oakcli delete db_config_params -conf filename -h
Parameters

Table D-19 oakcli delete db_config_params Command Parameters

Parameter Description

-conf filename

filename is the name of the configuration file you want to remove, without its pathname.

-h

(Optional) Displays the help usage for this command


oakcli delete repo

Use the oakcli delete repo command to remove a shared repository.

Syntax

Use the following syntax for the oakcli delete repo command:

oakcli delete repo repository_name [-h]

where repository_name is the name of the shared repository to be deleted.

Examples
Example 1   Deleting a shared repository

The following command deletes the testrepo01 shared repository:

oakcli delete repo testrepo01

The command will not succeed if testrepo01 is active one or both nodes.

oakcli delete vlan

Use the oakcli delete vlan command to remove a virtual local area network.

Syntax

Use the following syntax for the oakcli delete vlan command:

oakcli delete vlan vlan_name -node node_number [-h]
Parameters

Table D-20 oakcli delete vm Command Parameters

Parameter Description

vlan vlan_name

vlan_name is the name of the virtual local area network to be deleted.

-node node_number

node_number is the Oracle Database Appliance node from which you want to remove the virtual local area network.

-h

(Optional) Displays the help text.


Examples
Example 1   Deleting a virtual local area network

The following command deletes the sample1 virtual local area network from node 1:

oakcli delete vlan sample1 -node 1

oakcli delete vm

Use the oakcli delete vm command to remove a virtual machine.

Syntax

Use the following syntax for the oakcli delete vm command:

oakcli delete vm vm_name [-server node_number] [-h]
Parameters

Table D-21 oakcli delete vm Command Parameters

Parameter Description

vm vm_name

(Optional) vm_name is the name of the virtual machine to be deleted.

-server node_number

node_number is the 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) Displays the help text.


Examples
Example 1   Deleting a virtual machine

The following command deletes the ovu22 virtual machine from node 1:

oakcli delete vm ovu22 -server 1

oakcli delete vmtemplate

Use the oakcli delete vmtemplate command to remove a virtual machine template.

Syntax

Use the following syntax for the oakcli delete vmtemplate command:

oakcli delete vmtemplate template_name [-server=node_number][-h]
Parameters

Table D-22 oakcli deploy Command Parameters

Parameter Description

vmtemplate template_name

template_name is the name of the virtual machine template to be removed.

-server node_number

node_number is the Oracle Database Appliance node 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) Displays the help text.


Examples
Example 1   Deleting a virtual machine template

The following command deletes the ovu22 virtual machine template from both nodes:

oakcli delete vmtemplate ovu22

oakcli deploy

Use the oakcli deploy command to deploy Oracle Grid Infrastructure for a Cluster on Oracle Database Appliance.

Syntax

Use the following syntax for the oakcli deploy command:

oakcli deploy [config] [-conf config_file] [-h]

Parameters

Table D-23 oakcli deploy Command Parameters

Parameter Description

config

(Optional) Indicates whether the Deployment Configuration should be run.

-conf config_file

(Optional) Indicates the file name and location of an existing configuration file to use for a deployment. You may also specify the configuration file to use as part of the Oracle Appliance Manager configuration interview.


Usage Notes

  • Running the command with no objects or parameters, that is, using only, deploys the complete Oracle Database Appliance configuration.

  • The -h parameter displays the help text usage for the command.

oakcli disable validation storage

Use the oakcli disable validation storage command to turn off storage validation.

Syntax

oakcli disable validation storage | -h

where -h displays the help text for this command.

Examples
Example 1   Disabling Storage Validation

The following command disables storage validation and reports the new status:

oakcli disable validation storage
Disabled

oakcli enable validation storage

Use the oakcli enable validation storage command to turn on storage validation.

Syntax

oakcli enable validation storage | -h

where -h displays the help text for this command.

Examples
Example 1   Enabling Storage Validation

The following command enables storage validation and reports the new status:

oakcli enable validation storage
Enabled

oakcli import vmtemplate

Use the oakcli import vmtemplate command to import virtual machine templates.

Syntax

Use the following syntax for the oakcli import vmtemplate command:

oakcli import vmtemplate vmtemplatename -files image_files | -assembly assembly_file -repo repo_name [- node 0 | 1 ]

Parameters

Table D-24 oakcli import vmtemplate Command Parameters

Parameter Description

vmtemplatename

vmtemplatename is the 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:

  • a single template file name

  • a comma-separated list of files that comprise a single template

  • a URL enclosed in single quotes that links to a template file

-assembly

Use the -assembly option when importing an assembly file.

assembly_file

assembly_file is an assembly file or a URL enclosed in single quotes that links to an assembly file.

repo_name

repo_name is the name of the repository to store the template or templates that you are importing.

-node

Use the -node option when importing into a shared repository with a value of 0 or 1 to identify the node.


Usage Notes

  • Include only one of the options, -files or -assembly, each time you run this command. You cannot include both of these options in the same statement.

  • If the command imports more than one template from an assembly, then each template will automatically be given a unique name. These template names will include the name given in the vmtemplate vmtemplatename clause followed by a sequence number, such as vmtemplatename1, vmtemplatename2, vmtemplatename3, and so on.

  • When importing into a shared repository, you must include the -node option with a valid node number, 0 or 1. Using the -node option for imports into non-shared repositories will cause the command to fail.

Examples

Example 1   Importing a VM Template from Dom 0

The following command imports the required template (OVM_OL5U7_X86_64_PVM_10GB.tgz) from the /OVS directory in Dom 0 into the odarepo1 repository:

oakcli import vmtemplate OL5U7 -files /OVS/OVM_OL5U7_X86_64_PVM_10GB.tgz -repo odarepo1
Example 2   Importing a VM Template from a Remote Server

The following command imports a template from a remote server using a URL to identify the server and the template file:

oakcli import vmtemplate OL5U6 -files 'http://example.com/vm-template/OEL-5/OVM_OL5U6_X86_64_PVM_10GB.tgz' -repo odarepo2
Example 3   Importing VM Templates from an Assembly on a Remote Server

The following command imports the templates contained in the assembly stored on a remote server at the URL provided:

oakcli import vmtemplate OL6U1 -assembly 'http://example.com/assemblies/OEL6/OVM_OL6U1_x86_PVHVM.ova' -repo odarepo1
Example 4   Importing VM Templates into a Shared Repository from an Assembly on a Remote Server

The following command imports the templates contained in the assembly stored on a remote server at the URL provided into a shared repository named repo4 on Node 1:

oakcli import vmtemplate OL6U1 -assembly 'http://example.com/assemblies/OEL6/OVM_OL6U1_x86_PVHVM.ova' -repo repo4 -node 1

oakcli locate

The oakcli locate command helps you locate the physical disk that is associated with a named Oracle Automatic Storage Management (Oracle ASM) disk by turning on (or off) the disk's LED light.

Syntax

Use the following oakcli locate command syntax where diskname is the name of the ASM disk that you want to locate:

oakcli locate disk diskname on|off 

Parameters/Options

Table D-25 oakcli locate Command Parameters and Options

Parameter Description

disk diskname

Specifies the 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.


Examples

Example 1   Turning on the LED of a selected disk

The following command turns on the LED of the ASM disk disk_pd_23:

oakcli locate disk pd_23 on

oakcli manage diagcollect

Use the oakcli manage diagcollect command to collect diagnostic information about your Oracle Database Appliance for troubleshooting purposes, and for working with Oracle Support.

Syntax

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]

Parameters

Table D-26 oakcli manage diagcollect Command Parameters

Parameter Description

--all

For collecting all of the diagnostic information excluding Automatic Diagnostic Repository (ADR) and Cluster Health Monitor (OS). This is the default option.

--crs

For collecting Oracle Clusterware diagnostic information.

--crshome crs_home_dir

Specifies the location of the Oracle Clusterware home directory.

--core

For packaging core files with the Oracle Clusterware diagnostic data.

--install

For collecting the installation logs when the installation failed before running the script root.sh

--adr adr_location

For collecting diagnostic information for ADR, where adr_location specifies the location of the ADR information.

--afterdate date

Collects archives from the specified date. Specify the date in the mm/dd/yyyy format.

--aftertime time

Supported only the with the -adr parameter. Collects the archives after the specified time. Enter the time using the format YYYYMMDDHHMISS24.

--beforetime time

Supported only the with the -adr parameter. Collects the archives before the specified time. Enter the time using the format: YYYYMMDDHHMISS24.

--chmos

For collecting Cluster Health Monitor (OS) data.

--incidenttime time

Collects Cluster Health Monitor (OS) data from the specified time. Enter the time using the format: YYYYMMDDHHMISS24.

If you do not use the --incidenttime option, then OAKCLI collects the Cluster Health Monitor (OS) data for the past 24 hours.

--incidentduration time

Collects Cluster Health Monitor (OS) data for the duration after the specified time. Enter the time using the format: HH:MM. If you do not specify a duration, then OAKCLI collects all Cluster Health Monitor (OS) data after the specified incident time.

--excl [comp1,comp2]

Excludes the specified component logs. Valid components are: acfs, invt, sys, ocr, crs, home, and base.

--clean

Removed the diagnosability information gathered by this command.


oakcli modify

The oakcli modify command either assigns networks to or deletes networks from virtual machines and virtual machine templates, or transmits first-boot installation configuration messages to virtual machines.

Syntax

Use the following oakcli modify command syntax where name is the name virtual machine or template that you want to modify:

oakcli modify vm | vmtemplate name  -addnetwork network | -deletenetwork network | -s [-h]

where name is the name of the virtual machine or virtual machine template being modified and the parameters are described in the following table, Table D-27.

Parameters

Table D-27 oakcli modify Command Parameters

Parameter Description

-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.

-s message_key_value

Identifies a message consisting of key/value pairs to send to the ovmd utility

-h

(Optional) Displays the help text.


Usage Notes
  • Include either the vm or the vmtemplate option, but not both, when you use this command with the -addnetwork or -deletenetwork parameter.

  • Use only the vm option, not the vmtemplate option, when you use this command with the -s parameter.

  • Include only one of the -addnetwork, -deletenetwork, or -s parameters when you use this command.

Examples
Example 1   Modifying the Network Defined in a Virtual Machine Template

The following command replaces the network assigned to the gc_11g virtual machine template with the net1 network:

oakcli modify vmtemplate gc_11g -addnetwork net1
Example 2   Sending a Message to a Running Virtual Machine

The following command updates the root user password for the gc_11g virtual machine:

oakcli modify vm gc_11g -s "com.oracle.linux.root-password:root123"

oakcli odachk

Use the oakcli odacheck command to audit configuration settings.

Syntax

oakcli odacheck [-abhvpmuorc] [-clusternodes list | -localonly] [-nopass] [-profile]

Parameters

Table D-28 oakcli odachk Command Parameters

Parameter Description

-a

Perform best practice check and recommended patch check.

-b

Perform best practice check only without the recommended patch check..

-h

Display command usage.

-v

Display version.

-p

Perform patch check only.

-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)

-f

Run the command offline

-o

When followed by v, V, Verbose, or VERBOSE, the screen output will include checks that are passed. The default screen output contains only failures.

-r

Include High Availability best practices checks.

-c

For use only when working with Oracle Support.

-clusternode 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.

-outfile output_html

output_html is an output HTML file.

-nopass

For HTML reports, do not include checks that are passed.

-diff [report1 report2]

Difference report between two odachk reports defined in report1 and report2 as a directory name, zip file, or HTML report.

-profile profile

profile is a specific ASR profile: asm, clusterware, dba, maa, or sysadmin.


oakcli restart oda_base

Use the oakcli restart oda_base command to stop and restart ODA_BASE on the local node.

Syntax

oakcli restart oda_base | -h

where the ODA_BASE to be restarted is on the same node as the Dom 0 from which you run this command.

oakcli show

Use the oakcli show command to display the status of Oracle Database Appliance components. The information displayed is for the node where you run the command. Use the help option, oakcli show -h, to see the list of components available on the current node.

Table D-29 oakcli show Command Summary

Command Description

oakcli show asr

Displays the Oracle Auto Service Request configuration

oakcli show cooling

Displays the status of the cooling units

oakcli show controller

Displays information about the disk controllers

oakcli show core_config_key

Displays information about the core deployment

oakcli show cpupool

Displays information about mappings between cores and virtual machines

oakcli show databases

Displays information about the databases

oakcli show dbhomes

Displays information about the database homes

oakcli show db_config_params

Displays configuration file names and parameters

oakcli show disk

Displays information about shared or local disks

oakcli show diskgroup

Displays information about Oracle ASM disk groups.

oakcli show env_hw

Displays the current server's environment type and hardware version

oakcli show expander

Displays information about the expanders

oakcli show enclosure

Displays information about the storage enclosure

oakcli show memory

Displays information about the memory subsystem

oakcli show network

Displays information about the network subsystem

oakcli show power

Displays the status of the power supply subsystem

oakcli show processor

Displays processor (CPU) information

oakcli show repo

Displays information about virtual machine repositories

oakcli show server

Displays information about the server subsystem

oakcli show storage

Displays information about the storage

oakcli show validation storage

Displays status (enabled or disabled) of validation storage error reporting

oakcli show validation storage errors

Displays hard storage errors

oakcli show validation storage failures

Displays soft storage errors

oakcli show version

Displays version information for the software and firmware

oakcli show vlan

Displays version information about virtual local area networks

oakcli show vm

Displays version information about virtual machines

oakcli show vmtemplate

Displays information about virtual machine templates


oakcli show asr

Use this command to display your Oracle Auto Service Request configuration details.

Syntax
oakcli show asr [-h]
Parameters

Table D-30 oakcli show asr Command Parameters

Parameter Description

-h

(Optional) Displays the help usage for this command.


oakcli show cooling

Use the oakcli cooling command to show information about the cooling subsystem.

Syntax
oakcli show cooling

Examples

Example 1   Displaying the cooling unit information

The following command to display the cooling unit information for the node where the command is executed:

oakcli show cooling        NAME   HEALTH HEALTH_DETAILS LOCATION FAN % FAN SPEED        Fan_0  OK     -              FM0      30 %  6300 RPM        Fan_1  OK     -              FM0      19 %  3800 RPM        Fan_10 OK     -              FM2      34 %  6600 RPM        Fan_11 OK     -              FM2      23 %  4100 RPM        Fan_12 OK     -              FM3      32 %  6300 RPM        Fan_13 OK     -              FM3      22 %  3900 RPM        Fan_14 OK     -              FM3      24 %  4700 RPM        Fan_15 OK     -              FM3      14 %  2500 RPM        Fan_2  OK     -              FM0      29 %  6400 RPM        Fan_3  OK     -              FM0      18 %  3700 RPM        Fan_4  OK     -              FM1      32 %  6400 RPM        Fan_5  OK     -              FM1      20 %  3700 RPM        Fan_6  OK     -              FM1      33 %  6400 RPM        Fan_7  OK     -              FM1      22 %  3800 RPM        Fan_8  OK     -              FM2      33 %  6400 RPM        Fan_9  OK     -              FM2      22 %  3900 RPM

oakcli show controller

Use this command to display information about the controllers.

Syntax
oakcli show controller controller_id [-h]
Parameters

Table D-31 oakcli show controller Command Parameters

Parameter Description

controller_id

Specifies the controller for which the information should be displayed.

-h

(Optional) Displays the help usage for this command.


Examples

Example 1   Displaying information about controller 0 or controller 1

The following command displays details of controller 0:

oakcli show controller 0

oakcli show core_config_key

Use the oakcli show core_config_key command to display information about how to deploy your Oracle Database Appliance cores.

Syntax
oakcli show core_config_key

Examples

Example 1   Determining whether the Oracle Database Appliance core configuration key has been applied

The following command shows the core count status on a new Oracle Database Appliance that has not been configured:

oakcli show core_config_key
Optional core_config_key is not applied on this machine yet!
Example 2   Displaying the Oracle Database Appliance core count status on a configured Oracle Database Appliance

The following command shows the core count status on a previously configured Oracle Database Appliance:

oakcli show core_config_key
Host's serialnumber = 1132FMW003
Configured Cores = 20

oakcli show cpupool

Use the oakcli show cpupool command to display core allocations to virtual machine mappings.

Syntax
oakcli show cpupool -node nodenum

where nodenum is the number of the Oracle Database Appliance node that you wish to examine, either 0 or 1.

Examples

Example 1   Displaying core allocations to virtual machine mappings for a node:

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]

oakcli show databases

Use this command to display information about each existing database, including database name, database type, database home name and location, and database version.

Syntax
oakcli show databases [-h]
Parameters

Table D-32 oakcli show databases Command Parameters

Parameter Description

-h

(Optional) Displays the help usage for this command.


oakcli show dbhomes

Use this command to display information about each existing Oracle database home, including home name, home location, and database version.

Syntax
oakcli show dbhomes [-h]
Parameters

Table D-33 oakcli show dbhomes Command Parameters

Parameter Description

-h

(Optional) Displays the help usage for this command.


oakcli show db_config_params

Use this command to display information about each existing Oracle database home, including home name, home location, and database version. By default, the command will search for files with the extension .dbconf located in the /opt/oracle/oak/install/dbconf directory.

Syntax
oakcli show db_config_params [-conf filename] [-detail] [-h]
Parameters

Table D-34 oakcli show dbhomes Command Parameters

Parameter Description

-conf filename

(Optional) Name of configuration file to be displayed. If not included, then the command displays all configuration files.

-detail

(Optional) Displays the configuration file contents. If not specified, then the command lists the file name (or file names if no file name is defined).

-h

(Optional) Displays the help usage for this command.


Examples

Example 1   Displaying the default database configuration parameter values

The following command displays the default configuration parameter values

oakcli show db_config_params -detail
Available DB configuration files are:
          Default
          DATABASE_BLOCK_SIZE       =>    8192
          DATABASE_LANGUAGE         =>    AMERICAN
          DATABASE_CHARACTERSET     =>    AL32UTF8
          DATABASE_TERRITORY        =>    AMERICA
          COMPONENT_LANGUAGES       =>    en

oakcli show disk

Use the oakcli show disk command to display disk information.

Syntax
oakcli show disk [-local | -shared | shared_disk_name [-all]| -h]
Parameters

Table D-35 oakcli show disk Command Parameters

Parameter Description

-local

(Optional) Specifies that information for all of the local disks be displayed

-shared

(Optional) Specifies that information for all shared disks should be displayed.

shared_disk_name

(Optional) Specifies that information for the specific shared disk should be displayed.

-all

(Optional) Specifies that the physical information for the specific shared disk should be displayed.

-h

(Optional) Displays the help usage for this command.


Usage Notes
  • 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.

Examples

Example 1   Displaying information about the local disks

The following command displays information about all the local disks

oakcli show disk -local
Example 2   Displaying information about the shared disks

The following command displays information about all the shared disks

oakcli show disk -shared
Example 3   Displaying information about a specific shared disk

The following command displays information about the shared disk named pd_01

oakcli show disk pd_01

oakcli show diskgroup

Use the oakcli show diskgroup command to display Oracle ASM disk group information.

Syntax
oakcli show diskgroup [disk_group_name]
Parameters

Table D-36 oakcli show disk group Command Parameter

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.


oakcli show env_hw

Use the oakcli show env_hw command to display the environment type and hardware version of the current node.

Syntax
oakcli show env_hw [-h]

where -h will generate the help information for the command.

Examples

Example 1   Showing the environment type and hardware version:

The following example shows the output from the oakcli show env_hw command when logged onto Dom 1 on Oracle Database Appliance X3-2 Virtualized Platform:

oakcli show env_hw
VM-ODA_BASE ODA X3-2

oakcli show expander

Use the oakcli show expander command to display information about the expanders.

Syntax
oakcli show expander expander_id

Use expander_id to identify a specific expander.

oakcli show enclosure

Use the oakcli show enclosure command to display information about the storage enclosure subsystem on the node where the command is executed.

Syntax
oakcli show enclosure

Examples

Example 1   Displaying storage enclosure subsystem information:

Display the storage enclosure subsystem information of the node where the command is executed:

oakcli show enclosure

NAME        SUBSYSTEM         STATUS      METRIC

E0_FAN0  Cooling              OK          3000 rpm
E0_FAN1  Cooling              OK          3220 rpm
E0_FAN2  Cooling              OK          3520 rpm
E0_FAN3  Cooling              OK          3070 rpm
E0_IOM0  Encl_Electronics     OK          -
E0_IOM1  Encl_Electronics     OK          -
E0_PSU0  Power_Supply         OK          -
E0_PSU1  Power_Supply         OK          -
E0_TEMP0 Amb_Temp             OK          25 C
E0_TEMP1 Midplane_Temp        OK          32 C
E0_TEMP2 PCM0_Inlet_Temp      OK          34 C
E0_TEMP3 PCM0_Hotspot_Temp    OK          44 C
E0_TEMP4 PCM1_Inlet_Temp      OK          31 C
E0_TEMP5 PCM1_Hotspot_Temp    OK          42 C
E0_TEMP6 IOM0_Temp            OK          42 C
E0_TEMP7 IOM1_Temp            OK          50 C

oakcli show memory

Use the oakcli show memory command to display information about memory modules.

Syntax
oakcli show memory

Examples

Example 1   Displaying memory module information:

Display the memory information of the node where the command is executed:

oakcli show memory
        NAME    HEALTH HEALTH_DETAILS PART_NO.    SERIAL_NO.         LOCATION MANUFACTURER MEMORY_SIZE CURR_CLK_SPEED ECC_Errors
 
        DIMM_0  OK     -              001-0003-01 00CE02124685D963AC P0/D0    Samsung      16 GB       1600 MHz       0
        DIMM_1  OK     -              001-0003-01 00CE02124634F65B85 P0/D1    Samsung      16 GB       1600 MHz       0
        DIMM_10 OK     -              001-0003-01 00CE02124685D963B2 P1/D2    Samsung      16 GB       1600 MHz       0
        DIMM_11 OK     -              001-0003-01 00CE02124634F6565B P1/D3    Samsung      16 GB       1600 MHz       0
        DIMM_12 OK     -              001-0003-01 00CE02124634F6598B P1/D4    Samsung      16 GB       1600 MHz       0
        DIMM_13 OK     -              001-0003-01 00CE02124685D963B4 P1/D5    Samsung      16 GB       1600 MHz       0
        DIMM_14 OK     -              001-0003-01 00CE02124634F65956 P1/D6    Samsung      16 GB       1600 MHz       0
        DIMM_15 OK     -              001-0003-01 00CE02124685D96348 P1/D7    Samsung      16 GB       1600 MHz       0
        DIMM_2  OK     -              001-0003-01 00CE02124685D963B1 P0/D2    Samsung      16 GB       1600 MHz       0
        DIMM_3  OK     -              001-0003-01 00CE02124634F65B6E P0/D3    Samsung      16 GB       1600 MHz       0
        DIMM_4  OK     -              001-0003-01 00CE02124634F65C65 P0/D4    Samsung      16 GB       1600 MHz       0
        DIMM_5  OK     -              001-0003-01 00CE02124685D963AB P0/D5    Samsung      16 GB       1600 MHz       0
        DIMM_6  OK     -              001-0003-01 00CE02124634F6598E P0/D6    Samsung      16 GB       1600 MHz       0
        DIMM_7  OK     -              001-0003-01 00CE02124685D9659E P0/D7    Samsung      16 GB       1600 MHz       0
        DIMM_8  OK     -              001-0003-01 00CE02124685D963A3 P1/D0    Samsung      16 GB       1600 MHz       0
        DIMM_9  OK     -              001-0003-01 00CE02124634F656F7 P1/D1    Samsung      16 GB       1600 MHz       0

oakcli show network

Use the oakcli show network command to display information about the network subsystem.

Syntax
oakcli show network

Examples

Example 1   Displaying the network information:

Display the network information of the node where the command is executed:

oakcli show network
        NAME           HEALTH HEALTH_DETAILS LOCATION PART_NO MANUFACTURER MAC_ADDRESS        LINK_DETECTED DIE_TEMP
 
        Ethernet_NIC_0 OK     -              NET0     X540    INTEL        00:10:e0:23:f1:08  yes (eth0)    61.000 degree C
        Ethernet_NIC_1 OK     -              NET1     X540    INTEL        00:10:e0:23:f1:09  yes (eth1)    61.000 degree C
        Ethernet_NIC_2 OK     -              NET2     X540    INTEL        00:10:e0:23:f1:0a  yes (eth4)    53.750 degree C
        Ethernet_NIC_3 OK     -              NET3     X540    INTEL        00:10:e0:23:f1:0b  yes (eth5)    53.750 degree C
        Ethernet_NIC_4 -      -              NET4     82599EB INTEL        00:1B:21:B6:09:F1  yes (eth3)    -
        Ethernet_NIC_5 -      -              NET5     82599EB INTEL        00:1B:21:B6:09:F0  yes (eth2)    -

oakcli show power

Use the oakcli show power command to display information about the power supply subsystem.

Syntax
oakcli show power

Examples

Example 1   Displaying the power supply information:

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

oakcli show processor

Use the oakcli show processor command to display information about CPU processors.

Syntax
oakcli show processor

Examples

Example 1   Displaying the CPU processor information:

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

oakcli show repo

Use the oakcli show repo command to display information about virtual machine repositories. To see all repositories, do not include the repository name and node number. To see a specific shared repository, include the repository name and node.

Syntax
oakcli show repo [reponame -node 0|1]

Examples

Example 1   Displaying the available virtual machine repositories:

Display the virtual machined repositories on the two nodes of your Oracle Database Appliance Virtualized Platform:

oakcli show repo
        NAME      REPOTYPE  NODENUM
        odarepo1  local     0
        odarepo2  local     1
        repo1     shared    0
        repo1     shared    1
Example 2   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

oakcli show server

Use the oakcli show server command to display information about the server subsystem.

Syntax
oakcli show server

Examples

Example 1   Displaying the server information:

Display the server information of the node where the command is executed:

oakcli show server
        Power State              : On        Open Problems            : 1        Model                    : SUN FIRE X4170 M3        Type                     : Rack Mount        Part Number              : 31324979+1+1        Serial Number            : 1250FML046        Primary OS               : Not Available        ILOM Address             : 10.210.57.26        ILOM MAC Address         : 00:10:E0:23:F1:0C        Description              : Oracle Database Appliance X3-2 AK00050333        Locator Light            : Off        Actual Power Consumption : 268 watts        Ambient Temperature      : 22.000 degree C        Open Problems Report     :Open Problem 1        Problem time        : Tue Apr  2 06:10:37 2013        Problem subsystem   : System        Problem location    : /SYS (Host System)        Problem description : An error has occurred in which no automated diagnosis is available to identify faulty component. (Probability: 100, UUID: a72b4e35-140d-c86d-b87b-daf3eb43f5c7, Part Number: 31324979+1+1, Serial Number: 1250FML046, Reference Document: http://www.sun.com/msg/SPX86-8003-JP)

oakcli show storage

Use the oakcli show storage command to display information about the storage hardware.

Syntax
oakcli show storage

The oakcli show storage command displays information about the controllers, expanders, and disks.

oakcli show validation storage

Use the oakcli show validation storage command to show whether validation storage is enabled or disabled.

Syntax
oakcli show validation storage

oakcli show validation storage errors

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.

Syntax
oakcli show validation storage errors

oakcli show validation storage failures

Use the oakcli show validation storage failures command to show soft storage errors. A typical soft disk error would be an invalid version of the disk firmware.

Syntax
oakcli show validation storage failures

oakcli show version

Use the oakcli show version command to display patch versions for Oracle Database Appliance software and firmware.

Syntax
oakcli show version [-detail]

Use the -detail option to display detailed version information.

Examples

Example 1   Displaying basic version information:

Display the version information for the software and firmware on your Oracle Database Appliance:

oakcli show version

oakcli show vlan

Use the oakcli show vlan command to display information about virtual local area networks configured on Oracle Database Appliance.

Syntax
oakcli show vlan

Examples

Example 1   Displaying Virtual Local Area Network Information:

Display the names, tag ID numbers, networks, and node assignments for the available local virtual area networks:

oakcli show vlan
NAME                  ID    INTERFACE   NODENUM

net1                  1     bond0       0
net1                  1     bond0       1
net2                  1     bond1       0
net2                  1     bond1       1
net3                  2     bond1       0
net3                  4     bond0       1
net10                 20    bond1       0
net10                 20    bond1       1

oakcli show vm

Use the oakcli show vm command to display information about virtual machines.

Syntax
oakcli show vm [vm_name | -h]
Parameters

Table D-37 oakcli show vm Command Parameters

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 of the virtual machines is displayed.

-h

(Optional) Displays the help usage for this command.


Examples

Example 1   Displaying details for all virtual machines:

Display the virtual machine names, memory and vCPU allocations, status, 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       
Example 2   Displaying information for a single virtual machine:

The following command displays information about the vm1_odarepo1 virtual machine:

oakcli show vm vm1_odarepo1
Resource: vm1_odarepo1
        AutoStart       :       restore       
        CPUPriority     :       100           
        Disks           :       |file:/OVS/Repositories/odarepo1/Vi
                                rtualMachines/vm1_odarepo1/System.i
                                mg,xvda,w||file:/OVS/Repositories/o
                                darepo1/VirtualMachines/vm1_odarepo
                                1/u01.img,xvdb,w|
        Domain          :       XEN_PVM       
        ExpectedState   :       offline       
        Keyboard        :       en-us         
        MaxMemory       :       3000           
        MaxVcpu         :       4             
        Memory          :       4096          
        Mouse           :       OS_DEFAULT    
        Name            :       vm1_odarepo1  
        Networks        :       |bridge=priv1||bridge=net1||bridge=
                                net2|         
        NodeNum         :       0             
        OS              :       OL_5          
        PrivateIP       :       None          
        ProcessorCap    :       100           
        RepoName        :       odarepo1      
        State           :       Online        
        TemplateName    :       otml_sample1_odarepo1
        Vcpu            :       4             
        cpupool         :       twocpu        
        vncport         :       0              

oakcli show vmtemplate

Use the oakcli show vm template command to display information about virtual machine templates.

Syntax
oakcli show vmtemplate [vmtemplate_name | -h]
Parameters

Table D-38 oakcli show vmtemplate Command Parameters

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) Displays the help usage for this command.


Examples

Example 1   Displaying details for a single virtual template:

The following command displays information about the sample1_odarepo1 virtual template:

oakcli show vmtemplate sample_odarepo1
Resource: sample1_odarepo1
        CPUPriority     :       100           
        Disks           :       |file:/OVS/Repositories/odarepo1/Te
                                mplates/otml_sample1_odarepo1/Syste
                                m.img,xvda,w||file:/OVS/Repositorie
                                s/odarepo1/Templates/otml_sample1_o
                                darepo1/u01.img,xvdb,w|
        Domain          :       XEN_PVM       
        Keyboard        :       en-us         
        MaxMemory       :       2048          
        MaxVcpu         :       2             
        Memory          :       2048          
        Mouse           :       OS_DEFAULT    
        Name            :       sample1_odarepo1
        Networks        :       |bridge=priv1||bridge=net1||bridge=
                                net2|         
        NodeNum         :       0             
        OS              :       OL_5          
        ProcessorCap    :       100           
        RepoName        :       odarepo1      
        Vcpu            :       2 

oakcli show vmconsole

Use the oakcli show vmconsole command to open a GUI VM console to manage a specific virtual machine.

Syntax

oakcli show vmconsole vmname [-h]

where vm_name is the name of the virtual machine for which you want to open a console and -h displays the help usage for the command.

Examples

Example 1   Opening a virtual machine console

The following command opens a console for the virtual machine named vm1_odarepo1:

oakcli show vmconsole vm1_odarepo1

oakcli start

Use the oakcli start command to start a virtual machine, to start a shared repository on a node, or to start ODA_BASE on the local node.

Syntax

oakcli start [vm vm_name | repo repo_name -node node_number | oda_base ] [-h]

Parameters/Options

Table D-39 oakcli start Command Parameters

Parameter Description

-h

(Optional) Displays the online help.

vm vm_name

vm_name is the name of the virtual machine to be started.

repo repo_name

repo_name is the name of the shared repository to be started.

-node node_number

node_number is the number of the node where the shared repository is to be started, either 0 or 1.

oda_base

starts ODA_BASE on the local node.


Examples

Example 1   Starting a virtual machine

The following command starts the virtual machine named vm1_odarepo1:

oakcli start vm vm_odarepo1
Example 2   Starting a Shared Repository

The following command starts the shared repository named repo1 on Node 0:

oakcli start repo repo1 -node 0
Example 3   Starting the local ODA_BASE domain

Connect to Dom0 on the desired node and enter the following command to start ODA_BASE on that node.

oakcli stop oda_base

oakcli stop

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.

Syntax

oakcli stop [vm vm_name [-force] | repo repo_name -node node_number | oda_base ] [-h]

Parameters/Options

Table D-40 oakcli stop Command Parameters

Parameter Description

-h

(Optional) Displays the online help.

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.

oda_base

stops ODA_BASE on the local node.


Examples

Example 1   Forcing a virtual machine to stop

Enter the following command to force the virtual machine named vm1_odarepo1 to stop:

oakcli stop vm vm_odarepo1 -force
Example 2   Stopping a Shared Repository

Enter the following command to stop the shared repository named repo1 on Node 0:

oakcli stop repo repo1 -node 0
Example 3   Stopping the local ODA_BASE domain

Connect to Dom0 on the desired node and enter the following command to stop ODA_BASE on that node.

oakcli stop oda_base

oakcli stordiag

Use the oakcli stordiag command to run diagnostic tests on a disk in the storage shelf or storage expansion shelf.

Syntax

oakcli stordiag resource_name -h

where resource_name identifies a storage unit using the format

[e[0..1]_p]d_[0..23]

where e0 is the storage shelf, e1 is the storage expansion shelf, the final number identified the storage unit, and -h shows the help text usage for this command.

Usage Notes

For Oracle Database Appliance systems that have internal storage, use the format d_[..] to identify the disk to be diagnosed, for Oracle Database Appliance system that have connected a connected shelf (and optional storage expansion shelf), use the format e[0..1]_p[0..23] to identify the disk to be diagnosed.

Examples

Example 1   Run diagnostic tests on a disk in a storage expansion shelf

The following command runs the diagnostic tests on the fourth storage unit in the storage expansion shelf:

oakcli stordiag e1_pd_3

oakcli test asr

Use the oakcli test asr command to set a trap for you 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.

Syntax

oakcli test asr [-h]

oakcli unpack

Use the oakcli unpack command to unpack packages into the OAKCLI repository.

Syntax

oakcli unpack -package absolute_package_name

Examples

Example 1   Unpacking a patch package into the OAKCLI repository

The following command unpacks the p13982331_23000_Linux-86-64.zip package, which was previously copied to /tmp on the current node, into the node's OAKCLI repository:

oakcli unpack -package /tmp/p13982331_23000_Linux-86-62.zip

oakcli update

Use the oakcli update command to apply Oracle Database Appliance patches.

Syntax

oakcli update -patch version [[--infra] | [[--gi][--database]]] [--noreboot] | [--clean] | [--verify]

Parameters

Table D-41 oakcli update Command Parameters

Parameter Description

-patch version

Specifies the patch update that you want to install

--infra

Specifies that the infrastructure is to be patched, including firmware, OS, ASR, HMP, OAK, and so on. This is the default option.

--gi

Specifies that the Grid Infrastructure is to be patched.

--database

Specifies that the database homes are to be patched.

--noreboot

Node will not be rebooted after patching.

--clean

Clean up all temporary files on the local node.

--verify

Show the patchable components on the node.


Examples

Example 1   Patching a node

The following command updates the current node with the 2.5.0.0.0 patch:

oakcli update -patch 2.5.0.0.0

oakcli validate

Use the oakcli validate command to validate the state of an Oracle Database Appliance.

Syntax

Use the following oakcli validate syntax to validate an Oracle Database Appliance:

oakcli validate
oakcli validate [-V | -l | -h]
oakcli validate [-f output_file_name] [-a | -d | -c checklist]

Parameters/Options

Table D-42 oakcli validate Command Parameters

Parameter Description

-h

(Optional) Displays the online help.

-f output_file_name

The output is sent to the named file instead of to the screen (stdout). output_file_name must include the absolute path name to the file as well as the name of the file.

-a

Run all checks

-d

Run only the default checks.

-c checklist

Run the single check or all of the checks in a comma-delimited list contained in checklist.

-l

List the checks and their descriptions.

-V

Display the version.


Examples

Example 1   Listing all checks and their descriptions

List all of the checks available with oakcli validate along with their descriptions:

oakcli validate -l

         Checkname -- Description
         =========    ===========
         *SystemComponents -- Validate system components based on ilom sensor data
         readings
         *OSDiskStorage -- Validate OS disks and filesystem information
         *SharedStorage -- Validate Shared storage and multipathing information
         DiskCalibration -- Check disk performance with orion
         *NetworkComponents -- Validate public and private network components
         *StorageTopology -- Validate external JBOD connectivity
         asr -- Validate asr components based on asr config file and ilom sensor
         data readings

* -- These checks are also performed as part of default checks

Note:

The NetworkComponents validation check is not available on hardware prior to Oracle Database Appliance X3-2.
Example 2   Running all checks

Enter the following syntax to run all checks

oakcli validate -a
Example 3   Validating storage cable connections

Enter the following syntax to validate the connections to you storage shelf and, if connected, your storage expansion shelf:

oakcli validate -c storagetopology
Example 4   Validating ASR

Enter the following syntax to validate your ASR configuration:

oakcli validate -c asr
INFO: oak Asr information and Validations
RESULT: /opt/oracle/oak/conf/asr.conf exist
RESULT: ASR Manager ip:10.139.154.17
RESULT: ASR Manager port:1162
SUCCESS: ASR configuration file validation successfully completed
RESULT: /etc/hosts has entry 141.146.156.46 transport.oracle.com
RESULT: ilom alertmgmt level is set to minor
RESULT: ilom alertmgmt type is set to snmptrap
RESULT: alertmgmt snmp_version is set to 2c
RESULT: alertmgmt community_or_username is set to public
RESULT: alertmgmt destination is set to 10.139.154.17
RESULT: alertmgmt destination_port is set to 1162
SUCCESS: Ilom snmp confguration for asr set correctly
RESULT: notification trap configured to ip:10.139.154.17
RESULT: notification trap configured to port:1162
SUCCESS: Asr notification trap set correctly
INFO: IP_ADDRESS HOST_NAME SERIAL_NUMBER ASR PROTOCOL SOURCE PRODUCT_NAME
INFO: --------------- ------------------------------ ------------------------------ -------- --------- -------------- ------------------------------
10.170.79.98 oda-02-c 1130FMW00D Enabled SNMP ILOM SUN FIRE X4370 M2 SERVER
10.170.79.97 oda-01-c 1130FMW00D Enabled SNMP ILOM SUN FIRE X4370 M2 SERVER
INFO: Please use My Oracle Support 'http://support.oracle.com' to view the activation status.
SUCCESS: asr log level is already set to Fine.
RESULT: Registered with ASR backend.
RESULT: test connection successfully completed.
RESULT: submitted test event for asset:10.139.154.17
RESULT: bundle com.sun.svc.asr.sw is in active state
RESULT: bundle com.sun.svc.asr.sw-frag is in resolved state
RESULT: bundle com.sun.svc.asr.sw-rulesdefinitions is in resolved state
RESULT: bundle com.sun.svc.ServiceActivation is in active state
SUCCESS: ASR diag successfully completed