C H A P T E R  3

ILOM Command-Line Interface and Log In

The ILOM command-line interface (CLI) enables you to use keyboard commands to configure and manage many ILOM features and functions. Any task that you can perform using the ILOM web interface has an equivalent ILOM CLI command.

This chapter includes the following sections:



Note - Syntax examples in this chapter use the target starting with /SP/, which could be interchanged with the target starting with /CMM/ depending on your Sun server platform. Subtargets are common across all Sun server platforms.



CLI Overview

The ILOM command-line interface (CLI) is based on the Distributed Management Task Force specification, Server Management Command-Line Protocol Specification, version 11.0a.8 Draft (DMTF CLP). You can view the entire specification at the following site:

http://www.dmtf.org/

The DMTF CLP provides a management interface for one or more servers regardless of server state, method of access, or installed operating system.

The DMTF CLP architecture models a hierarchical namespace, a predefined tree that contains every managed object in the system. In this model, a small number of commands operate on a large namespace of targets, which can be modified by options and properties. This namespace defines the targets for each command verb.


CLI Hierarchical Architecture

The following table lists the various hierarchy methods you can use with the ILOM CLI, depending on the particular Sun server platform that you are using.


TABLE 3-1 ILOM Target Types

Target Type

Description

* /SP

The targets and properties below this target type are used for configuring the ILOM service processor (SP) and for viewing logs and consoles.

* /CMM

On blade platforms, this target type replaces /SP and is used

for configuring the ILOM Chassis Monitoring Module (CMM).

* /SYS

The targets and properties below this target type provide inventory, environmentals, and hardware management. The targets directly correspond to nomenclature for all hardware components, some of which are printed onto the physical hardware.

* /CH

On blade platforms, this target type replaces /SYS and provides inventory, environmentals, and hardware management at the chassis level. The target types directly correspond to nomenclature names for all hardware components, some of which are printed onto the the physical hardware.

* /HOST

The targets and properties below this target type are used for monitoring and managing the host operating system. This is only available for use with SPARC systems.




Note - Your access to some of these subtrees within the hierarchy is dependent on the Sun server platform you are using.


Service processors can access two namespaces: the /SP namespace and the overall system namespace /SYS or /HOST for SPARC-based systems. In the /SP namespace, you can manage and configure the service processor. In the /SYS or /HOST namespace you can access other information for managed system hardware.

FIGURE 3-1 /SP Example of the ILOM CLI Target Tree


Graphic showing an / SP example of the ILOM CLI Target Tree

For information about user privilege levels, see Roles for ILOM User Accounts.


CLI Command Syntax

When using the ILOM CLI, information is entered in the following order:

Command syntax: <command> <options> <target> <properties>

The following sections include more information about each part of the syntax.

CLI Commands

The ILOM CLI supports the DMTF CLP commands listed in the following table.

CLI commands are case-sensitive.


TABLE 3-2 CLI Commands

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

help

Displays Help information for 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 service processor running.


Command Options

The ILOM CLI supports the following options, but note that not every command supports every option. The help option can be used with any command.


TABLE 3-3 CLI Options

Option Long Form

Short Form

Description

-default

 

Causes the command to perform its default functions only.

-destination

 

Specifies the destination for data.

-display

-d

Shows the data the user wants to display.

-force

-f

Specifies that the action will be performed immediately.

-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. ILOM only supports -o table, which displays targets and properties in tabular form.

-script

 

Skips warnings or prompts normally associated with the command.

-source

 

Indicates the location of a source image.


Command Targets

Every object in your namespace is a target.

Command Properties

Properties are the configurable attributes specific to each object.


Command Execution

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


procedure icon  Execute Commands Individually

1. Navigate to the namespace using the cd command.

For example:

cd /SP/services/http

2. Enter the command, target, and value.

For example:

set port=80

or

set prop1=x

set prop2=y


procedure icon  Execute Combined Commands

single-step bullet  Using the syntax <command><target>=value, enter the command on a single command line.

For example:

set /SP/services/http port=80

or

set /SP/services/http prop1=x prop2=y

The following table provides an example and description of the individual and combined command execution methods..


TABLE 3-4 Executing an Individual Command and a Combined Command

Command Syntax

Command Description

Execute command individually:

> cd /SP/services/http

 

> set port=80

Navigate to the namespace
/SP/services/http

Enter the command, target, and value:

set “port” to “80”

Execute combined command:

> cd /SP/services/http port=80

In the namespace /SP/services/http,

set target “port” to “80”



Connect to ILOM Using the CLI

This section describes how to log in to and log out of ILOM. You should first refer to Assign IP Addresses to the Sun Server Platform SP Interfaces to configure ILOM before logging in to the ILOM CLI.

ILOM supports from 5 to 10 active sessions depending on your platform, including serial, SSH, and web interface sessions. Telnet connections to ILOM are not supported.


procedure icon  Log In to ILOM

You can access the ILOM CLI remotely through a Secure Shell (SSH) or serial connection. Secure Shell connections are enabled by default.

The following procedure shows an example using an SSH client on a UNIX system. Use an appropriate SSH client for your operating system. The default user name is root and default password is changeme.

Follow these steps to log in to ILOM using the default enabled SSH connection:

1. Type this command to log in to ILOM:

$ ssh root@ipaddress

where ipaddress is the IP address of the server SP.

2. Type this password when prompted:

Password: changeme

After you log in to ILOM using the default user name and password, you should change the the ILOM root account password (changeme). For information about changing the root account password, see Change ILOM Root Account Password Using the CLI.


procedure icon  Log Out of ILOM

Follow this step to log out of ILOM:

single-step bullet   Type this command to log out of ILOM:

-> exit