C H A P T E R 6 |
Using the Command-Line Interface |
This chapter describes how to use the Embedded Lights Out Manager (ELOM) command-line interface (CLI). The sections include:
You can access the command-line interface through the serial port or over the Ethernet.
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.
4. Enter the password when prompted.
root@192.168.25.25's password:changeme
Sun (TM) Embedded Lights Out Manager
Copyright 2006 Sun Microsystems, Inc. All rights reserved.
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:
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:
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. |
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.
The syntax of a command is verb options target properties.
TABLE 6-1 describes the CLI command verbs.
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.
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 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.
You can use the ELOM to change the host’s state and to access the host console.
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 /SYS/CtrlInfo BootCtrl=PCCheck_disable
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:
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:
For example, the following command shows the state of sensor /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.
You can display or configure the ELOM network settings from the CLI.
To Display network Settings |
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.
set /SP/network property=value
These targets, properties, and values are valid for ELOM network settings.
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
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.
-> set permssion=[administrator|operator|user|callback]
To Add a User Account |
-> 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 |
To Display User Accounts |
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. |
set target [propertyname=value]
These targets, properties, and values are valid for local user accounts.
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
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 |
To Configure Alerts |
Use the set command to change properties and values for alerts from the CLI.
set target [propertyname=value]
These targets, properties, and values are valid for IPMI PEF alerts.
-> 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
-> set /SP/AgentInfo/PEF/1 level=disable
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:
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
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
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:
Enter the show command to display your settings:
-> show
Enter the following command to configure the platform Event Filter table properties:
-> set SP/AgentInfo/PEF property=value
To show a PEF global control, enter:
To enable the PEF global power cycle, enter:
-> cd /SP/AgentInfo/PEF/EventFilterTable1
-> set PEFActionGlobalCtlPowerCycle=enable
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 |
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:
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:
a. To set the update method to overwrite existing custom settings, enter:
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.
Copyright © 2008, Sun Microsystems, Inc. All Rights Reserved.