Using the Command-Line Interface

C H A P T E R 6

This chapter describes how to use the Embedded Lights Out Manager (ELOM) command-line interface (CLI). The sections include:

Logging In to the CLI.

Command Syntax.

Managing the Host.

Managing the Host Console.

Managing ELOM Network Settings.

Managing User Accounts.

Managing Alerts.

Displaying Information.

Updating the Firmware.

Logging In to the CLI

You can access the command-line interface through the serial port or over the Ethernet.

Serial port - The serial port provides access to the CLI and to the system console. IPMI terminal mode and PPP mode are not available on the serial port.

SSH - You can connect to the CLI using an Ethernet connection. Secure shell (SSH) connections are enabled by default.

The Sun Blade X6250 server module ELOM supports a maximum of 10 active sessions, including serial, SSH, and web interface sessions.

Note - Telnet connections to the ELOM are not supported.

To Log In Using SSH

This section describes how to log in to the service processor using Secure Shell.

1. If necessary, start your SSH client

2. Access the system command-line.

3. Log in to the ELOM using a user account that has administrator privilege, by entering the following command:

$ ssh administrator_account@ipaddress

administrator_account An account with administrator privileges.
ipaddress The IP address of the service processor.

A password prompt appears.

4. Enter the password when prompted.

For example:

$ ssh root@192.168.25.25

root@192.168.25.25's password:changeme

Sun (TM) Embedded Lights Out Manager

Version 1.0

Warning: password is set to factory default.

To Log In From the Serial Port

This section describes how to log-in to the service processor from the serial port using a terminal device.

1. Configure your terminal device or the terminal emulation software running on a laptop or PC to the following settings:

8N1: eight data bits, no parity, one stop bit

9600 baud

Disabled software flow control (CTS/RTS)

2. Connect a serial cable from the server RJ-45 Serial Mgt port to a terminal device.

An RJ-45 to DB9 cable is included with your server.

3. Press the Enter key on the terminal device to establish a connection between that terminal device and the SP.

You should see the following prompt:

SP ->SUNSP0016364A9934 login:

4. Log in to the SP and enter the user name and password.

The default user name is root, and the default password is changeme.

Note - Once you have logged in to the SP as root, change the default password for increased security.

Note - If you have changed the serial redirection output in the system BIOS from BMC (that is, from the SP) to system, the system output will be displayed on the serial connection. To view the SP output on the serial connection, change the system BIOS back to the default BMC.

Command Syntax

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 top of the hierarchical structure is designated by /. Namespaces directly below are /SP, /SYS, and /CH.

The /SP namespace allows you to manage, maintain, and configure the server. Children of this namespace include /users and /network, and, /AgentInfo.

The /SYS namespace allows you to view your server’s system information.

The /CH namespace allow you to view chassis information.

The CLI provides four privilege levels: administrator, user. operator, callback. Only the administrator privilege has full read and write access to all ELOM functionality.

Note - The default user, root, has administrator privileges. For information about how to create a user account with user privileges, see To Add a User Account.

CLI commands are case-sensitive.

Syntax

The syntax of a command is verb options target properties.

Command Verbs

TABLE 6-1 describes the CLI command verbs.

TABLE 6-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	Used to transfer a file from a server to update a target.
reset	Resets the target’s state.
`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 ELOM firmware that is running.

Options

The CLI supports the following options. However, not all options are supported for all commands. The only option that works with all commands is -help. Refer to a specific command section in this document or use the -help option to list the options that are valid for a particular command.

TABLE 6-2 CLI 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 you want to display.
`-examine`	`-x`	Examines the command but does not execute it.
`-force`	`-f`	Causes an immediate action instead of an orderly shutdown.
`-help`	`-h`	Displays Help information.
-keep	-k	Establishes a holding time for command job ID and status.
`-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.
-resetstate		Indicates to what target-specific state to reset the target.
`-script`		Skips warnings or prompts normally associated with the command.
`-source`		Indicates the location of a source image.

Targets

Every object in your namespace is a target. Not all targets are supported for all commands. Each command section lists the valid targets for that command.

Properties

Properties are the configurable attributes specific to each object. An object can have one or more properties. Each command section lists the valid properties for each target.

Managing the Host

You can use the ELOM to change the host’s state and to access the host console.

Managing the Host State

To Manage the Host State

To power on the host, enter the following command:

-> set /SYS/CtrlInfo PowerCtrl=on

To power off the host gracefully, enter the following command:

-> set /SYS/CtrlInfo PowerCtrl=gracefuloff

To power off the host, enter the following command:

-> set /SYS/CtrlInfo PowerCtrl=off

To reset the host, enter the following command:

-> set /SYS/CtrlInfo PowerCtrl=reset

To reboot and enter the BIOS automatically, enter the following command:

-> set /SYS/CtrlInfo BootCtrl=BIOSSetup

To reboot and enter PXE automatically, enter the following command:

-> set /SYS/CtrlInfo BootCtrl=PXE

To reboot and enter Pc-Check diagnostic automatically, enter the following commands:

-> set /SYS/CtrlInfo PowerCtrl=PCCheck_enable

-> set BootCtrl=PCCheck_enable

To disable the option to boot to Pc-Check, and set the option to boot normally, enter the following commands:

-> set BootCtrl=regular

-> set /SYS/CtrlInfo BootCtrl=PCCheck_disable

Managing the Host Console

You can manage the host console by using the start and stop commands.

To Manage the Host Console

To start a session to the server console, enter this command:

-> start /SP/AgentInfo/Console

Note - After running the start command, no output will be displayed until the server is rebooted.

To revert to CLI once the console has been started, press Esc-Shift-9 (Esc-().

Note - Key combinations in this manual are based on the U.S. keyboard, which might differ from other keyboards. For a U.S. keyboard map, see Appendix B.

Enter this command to terminate a server console session started by another user:

-> stop /SP/AgentInfo/Console

Viewing Host Sensors

Host systems are equipped with sensors that read the state of critical components. For example, the sensors read temperatures, voltages, and fan speeds.

To View Host Sensors

The show command can be used to show the state of sensors. Use the command:

-> show /SYS/CPU/sensor

sensor The particular sensor.

For example, the following command shows the state of sensor /CPU/CPU0:

-> show /SYS/CPU/CPU0

For more information about sensors, including how to view them using a browser, see Monitoring the System.

For details on individual sensors, see your platform supplement.

Managing ELOM Network Settings

You can display or configure the ELOM network settings from the CLI.

To Display network Settings

Enter the following command:

-> show /SP/network

The above command displays the seven network properties, MACaddress, IPAddress, Netmask, Gateway, DNS, IPSource, and Hostname.

To display individual network settings, enter:
-> show /SP/network property

property One of the seven network properties.

To Configure Network Settings

Use the set command to change a property’s value.

Tip - Ensure that the same IP address is always assigned to an ELOM by either assigning a static IP address to your ELOM after initial setup, or configuring your DHCP server to always assign the same IP address to an ELOM. This enables the ELOM to be easily located on the network.

Syntax

set /SP/network property=value

Targets, Properties, and Values

These targets, properties, and values are valid for ELOM network settings.

TABLE 6-3
Target	Property	Value
`/SP/network`	IPAddress Netmask Gateway DNS IPSource	ipaddress\|none xxx.xxx.xxx.xxx IP address x.x.x.x dhcp\|static

Examples

Note - Changing the IP address will disconnect your active session if you are connected to the ELOM via a network.

To change the IP address for the ELOM, enter:

-> set /SP/network IPAddress=xxx.xxx.xxx.xxx

To set the Gateway address for the ELOM, enter:

-> set /SP/network Gateway=xxx.xxx.xxx.xxx

To change the network settings from static to DHCP settings, enter:

-> set /SP/network IPSource=dhcp

Managing User Accounts

This section describes how to add, modify, and delete user accounts using the CLI.

The ELOM supports up to 10 user accounts. One of those, root, is set by default and cannot be removed. Therefore, you can configure up to 9 additional accounts.

Each user account consists of a user name, a password, and a permission.

The permissions are:

Administrator - Enables access to all ELOM software features, functions, and commands. If a new user is given administrator privileges, those privileges are also automatically granted for the command-line interface (CLI) and Intelligent Platform Management Interface (IPMI) to the service processor’s Sun Blade X6250 server module software.

Operator - Enables limited access to SP software features, functions, and commands.

User and Callback - Enables limited access to the system on a read-only basis.

The syntax is:

-> set permssion=[administrator|operator|user|callback]

To Add a User Account

Enter the following commands:

-> cd /SP/users-> create username

username The name (8-16 characters in length) that the new user will use to log in to the ELOM. The system will then prompt you for a password (8-16 characters in length).

To Delete a User Account

Enter the following command:

-> delete /SP/users/username

To Display User Accounts

Enter the following command:

-> show /SP/users

To Configure User Accounts

Use the set command to change passwords and permissions for configured user accounts.

Note - You must have administrator privileges to change user properties.

Syntax

set target [propertyname=value]

Targets, Properties, and Values

These targets, properties, and values are valid for local user accounts.

TABLE 6-4
Target	Property	Value	Default
`/SP/users/username`	permission password	administrator\|operator\|user\|callback string 8-16 characters in length	operator

Examples

When changing the permissions for user1234 from administrator to operator enter:

-> set /SP/users/user1234 permssion=operator

To change password for user1234, enter:

-> set /SP/users/user1234 password=new_password

Managing Alerts

The system is equipped with a number of sensors that measure voltages, temperatures, and other things. It polls the sensors and posts an event in the system event log (SEL) when they cross a threshold. Some of these readings are also used to perform actions such as adjusting fan speeds, illuminating LEDs, and powering off the chassis.

The alert management view allows you to configure the system to send alerts to IP addresses.

An alert is an IPMI platform event filter (PEF) generated when a sensor crosses the specified threshold. For example, if you configure an alert for critical thresholds, the SP sends an IPMI trap to the specified destination when any sensor crosses the upper or lower critical threshold (CT).

All alerts are IPMI PEF traps, as defined in the Intelligent Platform Management Interface (IPMI) v2.0.

Special informational criteria are reserved for system events that are not related to sensors.

To Display Alerts

Enter the following command:

show /SP/AgentInfo/PEF

To Configure Alerts

Use the set command to change properties and values for alerts from the CLI.

Syntax

set target [propertyname=value]

Targets, Properties, and Values

These targets, properties, and values are valid for IPMI PEF alerts.

TABLE 6-5
Target	Property	Value	Default
`/SP/AgentInfo/PEF/`	PEFGlobalCtrl PEFActionGlobalCtrlPowerOff PEFActionGlobalCtrlPowerCycle PEFActionGlobalCtrlPowerReset PEFActionGlobalCtrlAlert PEFActionGlobalCtrlMail PEFActionGlobalCtrlInterrupt	disable\|enable disable\|enable disable\|enable disable\|enable disable\|enable disable\|enable disable\|enable	disable enable enable enable enable disable disable

The parameters are:

rule - The number of the alert rule. A number from 1 to 4.

ipaddress - The IP address to which the alert will be sent.

level - The severity level of the alert (see TABLE 6-6).

TABLE 6-6 Alert Levels
Alert Levels	Name in Sensor Readings View	Description
Informational	N/A	This level traps system events that are not related to sensors, such as “The host has booted.”
Warning	NC	The sensor is outside of its normal range but not critical.
Critical	CT	The sensor has crossed a critical threshold.
Nonrecoverable	NR	The sensor has reached a threshold beyond the tolerance level of the corresponding components.
Disable	N/A	Do not send alerts at this level.

Examples

To configure an alert, enter:

-> set /SP/AgentInfo/PEF/Destination1=128.145.77.21 level=critical

To change an alert level to critical, enter:

-> set /SP/AgentInfo/PEF/1 level=critical

To turn off an alert, enter:

-> set /SP/AgentInfo/PEF/1 level=disable

Displaying Information

You can display active session, current versions, and other information about the SP using the CLI.

To Display Version Information

Enter the following command to display the current SP version:

version

To Display Available Target Information

To display the available valid PEF targets, enter the following commands:

-> cd /SP/AgentInfo/PEF-> show

The displayed PEF targets are: EventFilterTable[1...6].

To navigate to and display the Platform Event Filter table properties, enter the following commands:

-> cd SP/AgentInfo/PEF/EventFilterTable1

-> show

TABLE 6-7 PEF Table Target Properties
	Property	Value
	status	enable\|disable
	sensortype	all\|voltage\|temperature\|memory
	powerctrl	PowerDown\|Reset\|PowerCycle
	diagnosticinterrupt	enable\|disable
	SendAlert	enable\|disable
	SendMail	enable\|disable

Examples

To show a specific PEF table target property for EventFilterTable1, enter:

-> cd /SP/AgentInfo/PEF/EventFilterTable1-> show property

To enable a PEF table target property:

Set the status, by navigating to the target, and using the set command:

-> cd /SP/AgentInfo/PEF/EventFilterTable1

-> set status=enable

Then set the property and the value (see TABLE 6-7). For example, to set the sensortype property to the voltage value, enter the following command:

-> set sensortype=voltage

Enter the show command to display your settings:
-> show

Syntax

set [target=value]

Enter the following command to configure the platform Event Filter table properties:

-> set SP/AgentInfo/PEF property=value

TABLE 6-8 Platform Event Filter Table Properties
	Property:	Value:
	PEFGlobalCtrl	enable\|disable
	PEFActionGlobalCtrlPowerOff	enable\|disable
	PEFActionGlobalCtrlPowerCycle	enable\|disable
	PEFActionGlobalCtrlPowerReset	enable\|disable
	PEFActionGlobalCtrlAlert	enable\|disable
	PEFActionGlobalCtrlMail	enable\|disable
	PEFActionGlobalCtrlInterrupt	enable\|disable

Examples

To show a PEF global control, enter:

-> cd /SP/AgentInfo/PEF/

-> show

To enable the PEF global power cycle, enter:

-> cd /SP/AgentInfo/PEF/EventFilterTable1

-> set PEFActionGlobalCtlPowerCycle=enable

Updating the Firmware

You can use CLI to update the SP firmware. Updating the ELOM from the command line enables you to update both the firmware, and the BIOS at the same time.

To Update the Firmware

Caution - Power interruptions during the update process could leave the SP in a unbootable or nonrecoverable state. Before upgrading your firmware, ensure that you have reliable power and protect against accidental power interruptions.

Caution - The file system would become corrupted if the host operating system is not shut down before the update process begins. If the OS is running when the update process starts, the SP will shut the host down ungracefully, which could cause file system corruption.

Note - The upgrade takes about 5 minutes to complete, depending on network traffic. During this time, no other tasks can be performed in the Embedded Lights Out Manager software.

1. Copy the combined bios/bmc image to your Tftp server.

2. If the server OS is running, perform a clean shutdown.

3. Log in to the CLI, and navigate to the TftpUpdate directory. Enter:

-> cd /SP/TftpUpdate

Note - A network failure during the file upload will result in a timeout. This causes the SP to reboot with the prior version of the firmware.

4. To set the IP address of the TFTP server, enter the following command:

-> set ServerIP=129.148.53.204

5. To set the file name of the combined bmc.bios image, enter the following command:

-> set Filename=filename

a. To set the update method to overwrite existing custom settings, enter:

-> set Update=action

This is the default method. It clears the CMOS, and overwrites all customized BIOS settings.

b. To set the update method to preserve existing custom settings, enter:

-> set UpdateMethod=PreserveCMOS

This method preserves the CMOS settings.

6. Start the tftp download:

-> set Update=action

Example:

-> cd /SP/TftpUpdate
-> set ServerIPAddress=129.148.53.204 
-> set FileName=filename
-> set Update=action 
getting image...
getting image successfully.
prepare to update...
Prepare OK!
Update Successful
starting update...