CLI Tools Command Syntax

The CLI tools must conform to one of the following two command syntax formats:

Note - The biosconfig tool does not conform to the above syntax. See Using the biosconfig Tool for more information.

The following table describes the command fields:

Command Field	Description	Examples
`command`	The action that you want to perform. 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` options is used immediately following the command.	`list`, `update`, `reset, expander-boot-record, sas_bridgefirmware`
`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
`-?`	`--help`	Help—Displays help information.
`-V`	`--version`	Version—Displays the tool version.
`-q`	`--quiet`	Quiet—Suppresses informational message output and returns only error codes.
`-y`	`--yes`	Yes—Confirms operation. Does not prompt user for confirmation on the operation when running.

When using command options 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

Skip Navigation Links
Exit Print View
	Oracle Server CLI Tools and IPMItool 2.1 User's Guide