C H A P T E R 3 - Using the Command-Line Interface

C H A P T E R 3

Using the Command-Line Interface

This chapter describes how to use the ILOM's command-line interface (CLI). The sections include:

Section 3.1, Using CLI Commands

Section 3.2, Command Syntax

To connect to the CLI, see Section 2.1, Connecting to the ILOM

3.1 Using CLI Commands

This section describes how to use CLI commands. CLI commands are case-sensitive.

3.1.1 CLI Namespace

The CLI architecture is based on a hierarchical namespace, which is a predefined tree that contains every managed object in the system. This namespace defines the targets for each command verb.

The ILOM includes two namespaces: the /SP namespace and the /SYS namespace.

The /SP namespace manages the ILOM. For example, you use this space to manage users, clock settings, and other ILOM issues. FIGURE 3-1 shows the /SP namespace.

The /SYS namespace manages the host system. For example, you can change the host state, read sensor information, and access other information for managed system hardware. Your /SYS namespace diagram is determined by the managed hardware devices in your server.

You can view your /SYS namespace by typing the show /SYS command from the command line. FIGURE 3-1 shows the /SP namespace. The /SYS namespace is unique to each platform.

FIGURE 3-1 Typical SP Namespace

Graphic showing block diagram of SP namespace.

3.1.2 Privilege Levels

The CLI provides two privilege levels: administrator and operator. Administrators have full access to ILOM functionality and operators have read-only access to ILOM information.

Note - The default user, root, has administrator privileges. To create a user account with operator privileges, see Chapter 5.

3.1.3 CLI Command Syntax

The syntax of a command is: verb options target properties

The following sections describe each of these.

3.1.3.1 Command Verbs

The CLI supports the following command verbs.

TABLE 3-1 CLI Command Verbs
Command	Description
`cd`	Navigates the object namespace.
`create`	Sets up an object in the namespace.
`delete`	Removes an object from the namespace.
`exit`	Terminates a session to the CLI.
`help`	Displays Help information about commands and targets.
`load`	Transfers a file from an indicated source to an indicated target.
`reset`	Resets the state of the target.
`set`	Sets target properties to the specified value.
`show`	Displays information about targets and properties.
`start`	Starts the target.
`stop`	Stops the target.
`version`	Displays the version of ILOM firmware.

3.1.3.2 Command Options

The CLI supports the options listed in TABLE 3-2. Not all options are supported for all commands. See a specific command section for the options that are valid with that command. The help option can be used with any command.

TABLE 3-2 Command Options
Option Long Form	Short Form	Description
`-default`		Causes the verb to perform only its default functions.
`-destination`		Specifies the destination for data.
`-display`	`-d`	Shows the data the user wants to display.
`-force`	`-f`	Causes an immediate action instead of an orderly shutdown.
`-help`	`-h`	Displays Help information.
`-level`	`-l`	Executes the command for the current target and all targets contained through the level specified.
`-output`	`-o`	Specifies the content and form of command output.
`-script`		Skips warnings or prompts normally associated with the command.
`-source`		Indicates the location of a source image.

3.1.3.3 Command Targets

Every object in your namespace is a target. Not all targets are supported for all commands. Section A.2, CLI Command Reference lists each command, with its targets and properties.

3.1.3.4 Command Properties

Properties are the configurable attributes specific to each object. An object can have one or more properties. Section A.2, CLI Command Reference lists each command, with its targets and properties.

3.2 Command Syntax

To execute most commands, you need to specify the location of the target, then enter the command. You can execute commands individually, or you can combine them on the same command line.

1. To execute commands individually:

a. Navigate to the namespace using the CD command.

For example:

cd /SP/services/http

b. Enter the verb, target, and value.

For example:

set port=80

2. To combine commands, use the form verb path/target=value.

For example:

set /SP/services/http port=80

The following display shows both methods:

-> cd /SP/services/http          - Navigate to namespace

/SP/services/http

-> set port=80

Set 'port' to '80'               - Enter the verb, target, and value

-> set /SP/services/http port=80 - Combine path and show command

Set 'port' to '80'

->