1. Oracle Hardware Management Pack 2.4 Server CLI Tools User's Guide
  2. CLI Tools Command Syntax and Conventions
  3. CLI Tools Command Syntax

CLI Tools Command Syntax

Most CLI tools commands conform to one of the following two command syntax formats:

  • command [option]

  • command subcommand target [option]

Note:

The biosconfig tool does not conform to the above syntax. See Using biosconfig to Update the BIOS for more information.

The following table describes the command fields.

Command Field Description Examples

command

The action that you want to perform. Identifies that CLI tool that you are using. Consists of lower-case letters only.

biosconfig, fwupdate, raidconfig, ilomconfig

subcommand

Further defines the task to be performed by the command.

Generally used as verbs.

Consists of lower-case letters, hyphens, or the underscore character.

The subcommand is not required when the --version or --help option is used immediately following the command.

list, update, reset

target

Describes the object or target that is being acted upon by the subcommand. Application specific.

all, disk, expander, bridge, controller, user, snmp-community

option

Modifies the command or subcommand and can be optional or mandatory depending on the command or subcommand.

There are long and short options that have identical functionality and are provided for ease of use:

Short-option is a hyphen followed by a single letter.

Long-option is two hyphens followed by a string.

-n or --device_name

-f or --filename

-r or --reset

The following options apply to all CLI Tools commands.

Short Option Long Option Description

-?, -h

--help

Displays help information.

-V

--version

Displays the tool version.

-q

--quiet

Suppresses informational message output and returns only error codes.

-y

--yes

Confirms operation. Does not prompt user for confirmation on the operation when running.

When using a command option and its corresponding value or device name, you can use an equal sign (=) or a space as shown in the following examples:

  • Using a command with spaces:

    raidconfig create raid -c c2 --raid-level 1 --number-disks 2

  • Using a command with equal signs (=):

    raidconfig create raid -c=c2 --raid-level=1 --number-disks=2

Parent topic: CLI Tools Command Syntax and Conventions