ILOM Command-Line Interface Reference

A P P E N D I X A

This appendix contains the following sections:

CLI Command Quick Reference

CLI Command Reference

CLI Command Quick Reference

This section contains the most common ILOM commands used to administer your Sun server from the command-line interface (CLI).

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.

TABLE A-1 Command Syntax and Usage
Content	Typeface	Description
Your input	`Fixed-width bold`	Text that you type. Type it exactly as shown.
Onscreen output	`Fixed-width regular`	Text that the computer displays
Variable	Italic	Replace these with a name or value you choose.
Square brackets [ ]		Text in square brackets is optional.
Vertical bars \|		Text separated by a vertical bar represents the only available values. Select one.

TABLE A-2 General Commands
Description	Command
Show all valid targets	`help targets`
Log out of the CLI	`exit`
Display the version of ILOM firmware running on ILOM	`version`
Display clock information	`show /SP/clock`
Display all of the CLI commands	`show /SP/cli/commands`
Display the active ILOM sessions	`show /SP/sessions`
Display information about commands and targets	`help`
Display information about a specific command	`help` create
Update ILOM and BIOS firmware	`load -source` tftp://newSPimage
Display a list of ILOM event logs	`show /SP/logs/event/list`

TABLE A-3 User Commands
Description	Command
Add a local user	`create /SP/users/`user1 `password=`password`role=administrator\|operator`
Delete a local user	`delete /SP/users/`user1
Change a local user's properties	`set /SP/users/`user1 `role=operator`
Display information about all local users	`show -display [targets\|properties\|all] -level all /SP/users`
Display information about LDAP settings	`show /SP/clients/ldap`
Change LDAP settings	`set /SP/clients/ldap binddn=`proxyuser`bindpw=`proxyuserpassword`defaultrole=administrator\|operator` `ipaddress=`ipaddress

TABLE A-4 Network and Serial Port Setting Commands
Description	Command
Display network configuration information	`show /SP/network`
Change network properties for ILOM. Changing certain network properties, like the IP address, will disconnect your active session	`set /SP/network pendingipaddress=`ipaddress`pendingipdiscovery=dchp\|static pendingipgateway=`ipgateway`pendingipnetmask=`ipnetmask `commitpending=true`
Display information about the external serial port	`show /SP/serial/external`
Change the external serial port configuration	`set /SP/serial/external pendingspeed=`integer `commitpending=true`
Display information about the serial connection to the host	`show /SP/serial/host`
Change the host serial port configuration. Note: This speed setting must match the speed setting for serial port 0, COM1 or /dev/ttyS0 on the host operating system	`set /SP/serial/host pendingspeed=`integer `commitpending=true`

TABLE A-5 Alert Management Commands
Description	Command
Display information about alerts. You can configure up to 15 alerts	`show /SP/alertmgmt/rules/1...15`
Configure an IPMI PET alert	`set /SP/alertmgmt/rules/1...15 type=ipmipet destination=`ipaddress `level=down\|critical\|major\|minor`
Configure a v3 SNMP trap alert	`set /SP/alertmgmt/rules/1...15 type=snmptrap snmp_version=3 comunity_or_username=`username `destination=`ipaddress `level=down\|critical\|major\|minor`
Configure an email alert	`set /SP/alertmgmt/rules/1...15 type=email destination=`email_address `level=down\|critical\|major\|minor`

TABLE A-6 System Management Access Commands
Description	Command
Display information about HTTP settings	`show /SP/services/http`
Change HTTP settings, such as enabling automatic redirection to HTTPS	`set /SP/services/http port=`portnumber `secureredirect enabled\|disabled` `servicestate=enabled\|disabled`
Display information about HTTPS access	`show /SP/services/https`
Change HTTPS settings	`set /SP/services/https port=`portnumber `servicestate=enabled\|disabled`
Display SSH DSA key settings	`show /SP/services/ssh/keys/dsa`
Display SSH RSA key settings	`show /SP/services/ssh/keys/rsa`

TABLE A-7 SNMP Commands
Description	Command
Display information about SNMP settings. By default, the SNMP port is 161 and v3 is enabled	s`how /SP/services/snmp engineid`=snmpengineid `port=`snmpportnumber `sets=enabled\|disabled` `v1=enabled\|disabled` `v2c=enabled\|disabled` `v3`=`enabled\|disabled`
Display SNMP users	`show /SP/services/snmp/users`
Add an SNMP user	`create /SP/services/snmp/users/`snmpusername `authenticationpassword=`password`authenticationprotocol=MD5\|SHApermissions=rw\|ro privacypassword=`password `privacyprotocol=none\|DES`
Delete an SNMP user	`delete /SP/services/snmp/users/`snmpusername
Display information about SNMP public (read-only) communities	`show /SP/services/snmp/communities/public`
Add this device to an SNMP public community	`create /SP/services/snmp/communities/ public/`comm1
Delete this device from an SNMP public community	`delete /SP/services/snmp/communities/ public/`comm1
Display information about SNMP private (read-write) communities	`show /SP/services/snmp/communities/private`
Add this device to an SNMP private community	`create /SP/services/snmp/communities/ private/`comm2
Delete this device from an SNMP private community	`delete /SP/services/snmp/communities/ private/`comm2

TABLE A-8 Host System Commands
Description	Command
Start the host system or chassis power	`start /SYS` or `start /CH`
Stop the host system or chassis power (graceful shutdown)	`stop /SYS` or `stop /CH`
Stop the host system or chassis power (forced shutdown)	`stop [-f\|force] /SYS` or `stop [-f\|force] /CH`
Reset the host system or chassis	`reset /SYS` or `reset /CH`
Start a session to connect to the host console	`start /SP/console`
Stop the session connected to the host console (graceful shutdown)	`stop /SP/console`
Stop the session connected to the host console (forced shutdown)	`stop [-f\|force] /SP/console`

TABLE A-9 Clock Settings Commands
Description	Command
Set ILOM clock to synchronize with a primary NTP server	`set /SP/clients/ntp/server/1 address=`ntpIPaddress
Set ILOM clock to synchronize with a secondary NTP server	`set /SP/clients/ntp/server/2 address=`ntpIPaddress2

CLI Command Reference

This section provides reference information about the CLI commands.

Using the `cd` Command

Use the cd command to navigate the namespace. When you cd to a target location, that location then becomes the default target for all other commands. Using the
-default option with no target returns you to the top of the namespace. Typing
cd -default is the equivalent of typing cd /. Typing just cd displays your current location in the namespace. Typing help targets displays a list of all targets in the entire namespace.

Syntax

cd target

Options

[-default] [-h|help]

Targets and Properties

Any location in the namespace.

Examples

To create a user named emmett, cd to /SP/users, then execute the create command with /SP/users as the default target.

-> cd /SP/users
-> create emmett

To find your location, type cd.

-> cd /SP/users

Using the `create` Command

Use the create command to set up an object in the namespace. Unless you specify properties with the create command, they are empty.

Syntax

create [options] target [propertyname=value]

Options

[-h|help]

Targets, Properties, and Values

TABLE A-10 Targets, Properties and Values for `create` Command
Valid Targets	Properties	Values	Default
`/SP/users/`username	password role	<string> administrator\|operator	(none) operator
`/SP/services/snmp/communities/`communityname	permissions	ro\|rw	ro
`/SP/services/snmp/user/`username	authenticationprotocol authenticationpassword permissions privacyprotocol privacypassword	MD5 <string> ro\|rw none\|DES <string>	MD5 (null string) ro DES (null string)

Example

-> create /SP/users/susan role=administrator

Using the `delete` Command

Use the delete command to remove an object from the namespace. You will be prompted to confirm a delete command. Eliminate this prompt by using the
-script option.

Syntax

delete [options] [-script] target

Options

[-h|help] [-script]

Targets

TABLE A-11 Targets for `delete` Command
Valid Targets
`/SP/users/`username
`/SP/services/snmp/communities/`communityname
`/SP/services/snmp/user/`username

Examples

-> delete /SP/users/susan
-> delete /SP/services/snmp/communities/public

Using the `exit` Command

Use the exit command to terminate a session to the CLI.

Syntax

exit [options]

Options

[-h|help]

Using the `help` Command

Use the help command to display Help information about commands and targets. Using the -o|output terse option displays usage information only.
The -o|output verbose option displays usage, description, and additional information including examples of command usage. If you do not use the
-o|output option, usage information and a brief description of the command are displayed.

Specifying command targets displays a complete list of valid targets for that command from the fixed targets in /SP and /SYS. Fixed targets are targets that cannot be created by a user.

Specifying command targets legal displays copyright information and product use rights.

Syntax

help [options] command targets

Options

[-h|help] [-o|output terse|verbose]

Commands

cd, create, delete, exit, help, load, reset, set, show, start, stop, version

Examples

-> help load

The load command is used to transfer a file from a server to a target.

Usage: load -source URL target

-source: Specify the location to get a file.

-> help -output verbose reset

The reset command is used to reset a target.

Usage: reset [-script] target

Available options for this command:

-script: Do not prompt for yes/no confirmation and act as if yes were specified.

Using the `load` Command

Use the load command to transfer an image file from a source, indicated by a Uniform Resource Indicator (URI), to update ILOM firmware. The URI can specify a protocol and credentials used for the transfer. Only the TFTP protocol is supported, so the URI must begin with tftp://. If credentials are required and not specified, the command prompts you for a password. Using the -script option eliminates the prompt for a yes or no confirmation and the command acts as if yes were specified.

Note - Use this command to update your ILOM firmware and BIOS.

Syntax

load -source URI

Options

[-h|help] [-script]

Example

-> load -source tftp://ip_address/newmainimage

Note - A firmware upgrade will cause the server and ILOM to be reset. It is recommended that a clean shutdown of the server be done prior to the upgrade procedure. An upgrade takes about five minutes to complete. ILOM will enter a special mode to load new firmware. No other tasks can be performed in ILOM until the firmware upgrade is complete and ILOM is reset.

 -> load -source tftp://archive/newmainimage
Are you sure you want to load the specified file (y/n)? y
File upload is complete.
Firmware image verification is complete.
Do you want to preserve the configuration (y/n)? n
Updating firmware in flash RAM: 
.
Firmware update is complete.
ILOM will not be restarted with the new firmware.

Using the `reset` Command

Use the reset command to reset the state of the target. You will be prompted to confirm a reset operation. Eliminate this prompt by using the -script option.

Note - The reset command does not affect the power state of hardware devices.

Syntax

reset [options] target

Options

[-h|help] [-script]

Targets

TABLE A-12 Targets for `reset` Command
Valid Targets
`/SP`
`/SYS`

Examples

-> reset /SP
-> reset /SYS

Using the `set` Command

Use the set command to specify the properties of the target.

Syntax

set [options] target [propertyname=value]

Options

[-h|help]

Targets, Properties, and Values

TABLE A-13 Targets, Properties, and Values for `set` Command
Valid Targets	Properties	Values	Default
`/SP/users/`username	password role	<string> administrator\|operator	(none) operator
`/SP/alertmgmt/rules`	testalert	true	(none)
`/SP/alertmgmt/rules/`rulename (rulename = 1 through 15)	community_or_username destination level snmp_version type	<string> email_address down\|critical\|major\|minor 1\|2c\|3 email \| ipmipet \| snmptrap	public (none) (none) 3 (none)
`/SP/clock`	usentpserver datetime	enabled\|disabled day month date time year	disabled <string>
`/SP/services/http`	port secureredirect servicestate	<integer> enabled\|disabled enabled\|disabled	80 enabled disabled
`/SP/services/https`	port servicestate	<integer> enabled\|disabled	443 disabled
`/SP/services/snmp`	engineid port sets v1 v2c v3	<hexadecimal> <integer> enabled\|disabled enabled\|disabled enabled\|disabled enabled\|disabled	IP address 161 disabled disabled disabled enabled
/SP/services/snmp/ communities/private	permission	ro \|rw	rw
/SP/services/snmp/ communities/public	permission	ro\|rw	ro
`/SP/services/snmp/user`/username	authenticationprotocol authenticationpassword permissions privacyprotocol privacypassword	MD5 <string> ro\|rw none\|DES <string>	MD5 (null string) ro DES (null string)
`/SP/services/ssh`	generate_new_key_action generate_new_key_type restart_sshd_action state	true rsa\|dsa true enabled\|disabled	(none) (none) (none) enabled
`/SP/services/sso`	state	enabled\|disabled	enabled
`/SP/users/`username	role password	administrator \| operator <string>	(none) (none)
/SP/clients/ activedirectory	state certfilestatus defaultrole getcertfile ipaddress port strictcertmode timeout	enabled \| disabled <string> <string> <string> <string> <string> enabled \| disabled <integer>	disabled (none) (none) (none) (none) (none) disabled (none)
/SP/clients/ activedirectory/ admingroups/n where n is 1-5	name	<string>	(none)
/SP/clients/ activedirectory/ opergroups/n where n is 1-5	name	<string>	(none)
/SP/clients/ activedirectory/ userdomains/n where n is 1-5	domain	<string>	(none)
`/SP/clients/ldap`	binddn bindpw defaultrole ipaddress port searchbase state	<username> <string> administrator\|operator <ipaddress>\|none <integer> <string> enable\|disabled	(none) (none) operator (none) 389 (none) disabled
/SP/clients/ntp/server/ [1\|2]	address	<ipaddress>	(none)
/SP/clients/radius	defaultrole ipaddress port secret state	administrator\|operator <ipaddress>\|none <integer> <string>\|none enable\|disabled	operator (none) 1812 (none) disabled
/SP/clients/smtp	address port state	<ipaddress> <integer> enabled \| disabled	IP address 25 enabled
SP/clients/syslog	destination_ip1 destination_ip2	<ipaddress> <ipaddress>	IP address IP address
`/SP/network`	commitpending pendingipaddress pendingdiscovery pendingipgateway pendingipnetmask	true <ipaddress>\|none dhcp\|static <ipaddress>\|none <IP dotted decimal>	(none) (none) dhcp (none) 255.255.255.255
`/SP/serial/external`	commitpending flowcontrol pendingspeed speed	true none <integer from list> <integer from list>	(none) none 9600 9600
`/SP/serial/host`	commitpending pendingspeed speed	true <integer from list>	(none) 9600 9600
`/SP/`	system_identifier	<string>	(none)
`/SP/`	hostname	<string>	default is based on MAC address

Examples

-> set /SP/users/susan role=administrator
-> set /SP/clients/ldap state=enabled binddn=proxyuser bindpw=ez24get

Using the `show` Command

Use the show command to display information about targets and properties.

Using the -display option determines the type of information shown. If you specify -display targets, then all targets in the namespace below the current target are shown. If you specify -display properties, all property names and values for the target are shown. With this option you can specify certain property names, and only those values are shown. If you specify -display all, all targets in the namespace below the current target are shown, and the properties of the specified target are shown. If you do not specify a -display option, the show command acts as if -display all were specified.

The -level option controls the depth of the show command and it applies to all modes of the -display option. Specifying -level 1 displays the level of the namespace where the object exists. Values greater than 1 return information for the target's current level in the namespace and the <specified value> levels below. If the argument is -level all, it applies to the current level in the namespace and everything below.

The -o|output option specifies the output and form of command output. ILOM only supports -o table. When you use the -o table option, the output is formatted in a condensed, three-column table of targets, properties, and values.

The alias, show components, is a shortcut for the following CLI command:

-> show -o table -level all /SYS component_state

The show components alias produces the same output as the above command. Thus, it enables you to restrict the table output to a single property below each target.

Syntax

show [options] [-display targets|properties|all] [-level value|all] target [propertyname]

Options

[-d|-display] [-l|level] [-o|output]

Targets and Properties

TABLE A-14 Targets for `show` Command
Valid Targets	Properties
`/SYS`
`/SP`
`/SP/alertmgmt/rules/`rulename (rulename = 1 through 15)	community\|username destination level snmp_version type
/SP/clients/ activedirectory	state certfilestatus defaultrole getcertfile ipaddress port strictcertmode timeout
/SP/clients/ activedirectory/ admingroups/n where n is 1-5	name
/SP/clients/ activedirectory/ opergroups/n where n is 1-5	name
/SP/clients/ activedirectory/ userdomains/n where n is 1-5	domain
`/SP/clients/ldap`	binddn bindpw defaultrole ipaddress port searchbase state
`/SP/clients/ntp/server/[1\|2]`	ipaddress
`/SP/clock`	datetime usentpserver
`/SP/logs/event`	clear
`/SP/network`	ipaddress ipdiscovery ipgateway ipnetmask macaddress pendingipaddress pendingdiscovery pendingipgateway pendingipnetmask
`/SP/serial/external`	flowcontrol pendingspeed speed
`/SP/serial/host`	pendingspeed speed
`/SP/services/http`	port secureredirect servicestate
`/SP/services/https`	port servicestate
`/SP/services/snmp`	engineid port sets v1 v2c v3
/SP/services/snmp/communities/private	permissions
`/SP/services/snmp/communities/public`	permissions
`/SP/services/snmp/users/`username	password role
`/SP/services/ssh`	state
`/SP/services/ssh/keys/dsa`	fingerprint length publickey
`/SP/services/ssh/keys/rsa`	fingerprint length publickey
`/SP/services/sso`	state
`/SP/sessions`	username starttime date
`/SP/sessions/`sessionid	starttime source type user
`/SP/users/`username	role password

Examples

-> show -display properties /SP/users/susan

/SP/users/susan

Properties:

role = Administrator

`-> show /SP/clients -level 2`
`/SP/clients`
	`Targets:` `ldap` `ntp`
	`Properties:`
	`Commands:` cd show
`/SP/clients/ldap`
	`Targets:`
	`Properties:` `binddn = cn=Manager,dc=sun,dc=com` `bindpw = secret` `defaultrole = Operator` `ipaddress = 129.144.97.180` `port = 389` `searchbase = ou=people,dc=sun,dc=com` `state = disabled`
	`Commands:` cd show
`/SP/clients/ntp`
	`Targets:` server
	`Properties:`
	`Commands:` cd show

-> show components

Target    | Property        | Value
----------+-----------------+--------------
/SYS/FRU1 | component_state | Enabled
/SYS/FRU2 | component_state | Disabled
/SYS/FRU3 | component_state | Enabled

-> show -o table -level all /SP/sessions

Target          | Property  | Value
----------------+-----------+-------------------------
/SP/sessions/90 | username  | root
/SP/sessions/90 | starttime | Tue Apr 10 10:57:22 2007
/SP/sessions/90 | type      | shell

Using the `start` Command

Use the start command to turn on the target or to initiate a connection to the host console. Using the -script option eliminates the prompt for a yes or no confirmation and the command acts as if yes were specified. The -f|force option specifies that the action will be performed immediately.

Syntax

start [options] target

Options

[-h|help] [-script] [-f|force]

Targets

TABLE A-15 Targets for `start` Command
Valid Targets	Description
`/SYS` or `/CH`	Starts (powers on) the system or chassis.
`/SP/console`	Starts an interactive session to the console stream.

Examples

-> start /SP/console
-> start /SYS

Using the `stop` Command

Use the stop command to shut down the target or to terminate another user's connection to the host console. You will be prompted to confirm a stop command. Eliminate this prompt by using the -script option. The -f|force option specifies that the action will be performed immediately.

Syntax

stop [options] [-script] target

Options

[-f|force] [-h|help]

Targets

TABLE A-16 Targets for `stop` Command
Valid Targets	Description
`/SYS` or `/CH`	Perform an orderly shutdown, followed by a power off of the specified system or chassis. Use the -force option to skip the orderly shutdown and force an immediate power off.
`/SP/console`	Terminate another user's connection to the host console.

Examples

-> stop /SP/console
-> stop -force /SYS

Using the `version` Command

Use the version command to display ILOM version information.

Syntax

version

Options

[-h|help]

Example

-> version
version SP firmware version: 2.0.0
SP firmware build number: 4415
SP firmware date: Mon Mar 28 10:39:46 EST 2007
SP filesystem version: 0.1.9

CLI Command Quick Reference

CLI Command Reference

Using the cd Command

Syntax

Options

Targets and Properties

Examples

Using the create Command

Syntax

Options

Targets, Properties, and Values

Example

Using the delete Command

Syntax

Options

Targets

Examples

Using the exit Command

Syntax

Options

Using the help Command

Syntax

Options

Commands

Examples

Using the load Command

Syntax

Options

Example

Using the reset Command

Syntax

Options

Targets

Examples

Using the set Command

Syntax

Options

Targets, Properties, and Values

Examples

Using the show Command

Syntax

Options

Targets and Properties

Examples

Using the start Command

Syntax

Options

Targets

Examples

Using the stop Command

Syntax

Options

Targets

Examples

Using the version Command

Syntax

Options

Example

Using the `cd` Command

Using the `create` Command

Using the `delete` Command

Using the `exit` Command

Using the `help` Command

Using the `load` Command

Using the `reset` Command

Using the `set` Command

Using the `show` Command

Using the `start` Command

Using the `stop` Command

Using the `version` Command