C H A P T E R  7

Configuring and Managing the Server Using the CLI

This chapter describes how to use the Embedded Lights Out Manager (ELOM) command-line interface (CLI) to configure, manage, and maintain the server. The sections in this chapter:


Configuration and Management Tasks

The majority of the CLI configuration and management tasks are located in the following /SP namespaces:


/SP Namespace

Tasks

Section

/SP/Timeout

Change the session timeout.

Setting the CLI Timeout

/SP/users

/SP/users/username

Create, delete users, change user status, permission and password.

Managing User Accounts

/SP/network

Configure MAC address, IP address, netmask, gateway, DNS, DHCP or static, and host name.

Managing ELOM Network Settings

/SP/clock

Set date and time, enable/disable NTP, designate IP address of NTP server, and view timezone list.

Managing the Clock

/SP/TftpUpdate

Configure server IP address, designate update file, and intiatre update process.

Updating the Firmware

/SP/AgentInfo/PEF]

/SP/AgentInfo/PET

Configure platform event filters and traps.

Managing Alerts

/SP/AgentInfo/SEL

Clear event log.

Managing the System Event Log

/SP/AgentInfo/Console

Start and stop the console.

Managing the Console

/SP/AgentInfo/Mail

Configure SMTP settings and receiver email addresses.

Managing Mail

/SP/AgentInfo/SNMP

Configure settings, community, and users

Configuring SNMP on the ELOM and Managing SNMP User Accounts


Power control configuration and management tasks are available in the following /SYS namespace:


/SYS Namespace

Tasks

Section

/SYS/CtrlInfo

 

Control power, control boot and display boot status, control ID LED, and control Fault LED

Managing the Power State of the Server


For information about using the CLI, see Appendix A.


Setting the CLI Timeout

The CLI has a timeout function that you can change. The default timeout is 300 seconds.


procedure icon  To Set the CLI Timeout

single-step bullet  To set the CLI timeout, enter the following command:

-> set /SP/Timeout=time_in_seconds


Managing User Accounts

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

The ELOM supports up to 10 user accounts. One of those, root, is predefined 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. For more information about user permissions, see User Accounts and Permissions Levels. TABLE 7-1 summarizes acceptable user name and password length and character set.


TABLE 7-1 User Name and Password Length and Character Set

 

Length

Characters

 

User Name

4-16 Characters

a-z, A-Z, 0-9

 

Password

8-20 Characters

a-z, A-Z, 0-9


Do not include spaces in user names and passwords.


procedure icon  To Add a User Account

single-step bullet  Enter the following commands:

-> cd /SP/users
-> create username

username The name 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).


procedure icon  To Delete a User Account

single-step bullet  Enter the following command:

-> cd /SP/users

-> delete username


procedure icon  To View User Accounts

single-step bullet  Enter the following command:

-> cd /SP/users

-> show


procedure icon  To Configure User Accounts

single-step bullet  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.


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:

-> cd /SP/users/user1234

-> set permssion=operator

To change password for user1234, enter:

-> cd /SP/users/user1234

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

Managing ELOM Network Settings

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


procedure icon  To Display network Settings

single-step bullet  Enter the following command:

-> cd /SP/network

-> show

The above command displays the seven network properties:

To display individual network settings, enter:

-> show property

property One of the seven network properties.


procedure icon  To Configure Network Settings

single-step bullet  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 target [propertyname=value]

Targets, Properties, and Values

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


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:

-> cd /SP/network

-> set IPAddress=xxx.xxx.xxx.xxx

To set the Gateway address for the ELOM, enter:

-> cd /SP/network

-> set Gateway=xxx.xxx.xxx.xxx

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

-> cd /SP/network

-> set IPSource=dhcp

Managing the Clock

You can set the date and time and configure an NTP server using the CLI.


procedure icon  To Manage the Clock

1. Enter the following commands:

-> cd /SP/clock
-> show

a. To set the date, enter the following command:

-> set Date=mm/dd/yyyy

Where mm/dd/yyyy is the two-digit month, two-digit day, and four-digit year, respectively.

b. To set the time, enter:

-> set Time=hh:mm:ss

Where hh:mm:ss is the two-digit hour, two-digit minute, and two-digit seconds, respectively.

c. To enable or disable NTP, enter:

-> set NTPStatus=[enable|disable]

d. To set the IP address of the NTP server, enter:

-> set NTPServer=ip_address

Where ip_address is the IP address of the NTP server.
This setting is only effective if NTPStatus is set to enable (Step c).

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.


procedure icon To Update the Firmware



caution icon 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 icon Caution - The file system could become corrupted if the host OS is not shut down before the update process begins. If the OS is running when the update process starts, the SP shuts 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 graceful 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 ServerIPAddress=tfp-server-ip-address

tfp-server-ip-address The IP address of the tftp server.

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 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 settings, enter:

-> set SaveFlag=yes

This method preserves the CMOS settings.

6. Start the tftp download:

-> set Update=action

7. Select Yes to continue, or select No to exit.

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

Managing Alerts

The system is equipped with sensors that read several system critical parameters, such as voltages and temperatures (for imformation about how to view these sensors, see Viewing Server Module Sensor Information). The system monitors these sensors and creates an alert when a sensor reading crosses an upper or lower critical threshold level.

You can manage these alerts, by using the CLI to create filters that trap alerts based on the sensor type. You can then have the filters perform various preconfigured actions in response to the alert. Configuring alerts with the CLI is a two step process:

1. Configure a destination IP address in the PET.

2. Configure a platform event filter (PEF) to enable and perform various alert-triggered actions.

You manage alerts from the /SP/AgentInfo namespace, using the show and set commands. The show command allows you to display current alert property and value settings. The set command allows you to configure alert property and value settings.

Displaying Alerts

Use the show command to display PET and PEF targets, properties, and values.


procedure icon  To Display Alerts

single-step bullet  To display targets, properties, and target commands for PET, enter the following command:

-> show /SP/AgentInfo/PET

single-step bullet  To display targets, properties, and target commands for PEF, enter the following command:

-> show /SP/AgentInfo/PEF

Before configuring alerts, you might want to display a target’s current settings. This allows you to examine the current status of alerts. Use the cd command and the show command, respectively, to navigate to targets and display property values. For example:

-> cd /SP/AgentInfo/PET

-> show

The output of the show command appears:


-> show
/SP/AgentInfo/PET
    Targets:
        Destination1
        Destination2
        Destination3
        Destination4
 
    Properties:
 
    Target Commands:
        show
        cd
        set

Displaying PET Target Properties

Use the show command to view PET target properties.


procedure icon  To Display PET Target Properties

To display properties, enter the following commands:

-> cd Destination1

-> show

The result of executing the show command for the target, Destination1 appears:


-> show
/SP/AgentInfo/PET/Destination1
     Targets:
 
     Properties:
        IPAddress = 10.5.157.112
 
     Target Commands:
        show
        set

Configuring Alerts

The first step to configuring alerts is to configure the PET IP address. After you configure the IP address, you need to configure the individual PEF filter tables. Filter tables are where you designate the specific alert-triggered actions

Use the set command to configure alerts in PET and PEF:

Syntax

set target propertyname=value

Targets, Properties, and Values

This target, property, and value is valid when using the set command to set the IPMI PET IP address:


Target

Property

Value

Default

/SP/AgentInfo/PET/[Destination1...Destination4]

IPAddress

ipaddress

(None)


Configuring the PET IP Address


procedure icon  To Configure the PET IP Address

To set the IP address for Destination1, enter the following commands:

-> cd /SP/AgentInfo/PET/Destination1

-> set IPAddress=xxx.xxx.xxx.xxx

xxx.xxx.xxx.xxx The IP address.

Repeat the above set command to configure the IP address for additional destination targets.

Configuring the PEF Global Controls

PEF Global Controls allow you to enable PEF actions globally. These settings override settings in the PEF filter table. These targets and properties are valid for configuring the global PEF controls:


Target

Property

/SP/AgentInfo/PEF/PEFGlobalCtrl

= enable|disable (default)

/SP/AgentInfo/PEF/PEFActionGlobalCtrlPowerOff

= enable|disable (default)

/SP/AgentInfo/PEF/PEFActionGlobalCtrlPowerCycle

= enable|disable (default)

/SP/AgentInfo/PEF/PEFActionGlobalCtrlPowerReset

= enable|disable (default)

/SP/AgentInfo/PEF/PEFActionGlobalCtrlAlert

= enable|disable (default)

/SP/AgentInfo/PEF/PEFActionGlobalCtrlMail

= enable|disable (default)

/SP/AgentInfo/PEF/PEFActionGlobalCtrlInterrupt

= enable|disable (default)



procedure icon  To Configure the PEF Global Controls

1. To configure the PEF global controls, you must first enable global control by entering the following commands:

-> cd /SP/AgentInfo/PEF

-> set PEFGlobalCtrl=enable

After enabling global control, you can enable global control for specific actions.

2. To enable global PEF control for a specific action, enter the following commands for each PEFActionGlobalCtrl that you want to enable:

This example shows how to enable the power reset PEF global action:

-> cd /SP/AgentInfo/PEF

-> set PEFActionGlobalCtrlPowerReset=enable

Configuring the Event Filter Tables

The event filter table is where you designate the specific alert-triggered actions. You can configure up to six event filter tables. These targets, properties, and values are valid for setting the PEF:


Target

Property

/SP/AgentInfo/PEF/EventFilterTable[1-6]/status

enable|disable

/SP/AgentInfo/PEF/EventFilterTable[1-6]/sensortype

All, Memory, Processor, Temperature, Voltage, Fan

/SP/AgentInfo/PEF/EventFilterTable[1-6]/powercrtl

enable|disable

/SP/AgentInfo/PEF/EventFilterTable[1-6]/diagnosticinterrupt

enable|disable

/SP/AgentInfo/PEF/EventFilterTable[1-6]/sendalert

enable|disable

/SP/AgentInfo/PEF/EventFilterTable[1-6]/sendmail

enable|disable



procedure icon  To Configure the Event Filter Tables

1. To configure a PEF EventFilterTable target, enter the following commands:

-> cd /SP/AgentInfo/PEF

-> show

The result of executing the show command appears:


-> show
/SP/AgentInfo/PEF
    Targets:
        EventFilterTable1
        EventFilterTable2
        EventFilterTable3
        EventFilterTable4
        EventFilterTable5
        EventFilterTable6
 
    Properties:
        PEFGlobalCtrl = enable
        PEFActionGlobalCtrlPowerOff = enable
        PEFActionGlobalCtrlPowerCycle = enable
        PEFActionGlobalCtrlPowerReset = enable
        PEFActionGlobalCtrlAlert = enable
        PEFActionGlobalCtrlMail = enable
        PEFActionGlobalCtrlInterrupt = enable
 
    Target Commands:
        show
        cd
        set

By examining the output of the show command, you can view the current global control configuration. If necessary use the cd and show commands to navigate to and examine the individual event filter table targets. You will need to decide which table you are going to configure.

2. When you have decided which EventFilterTable to configure, enable the table by entering the following commands:

This example uses EventFilterTable1:

-> cd EventFilterTable1

-> set status=enable

3. To display EventFilterTable1, enter the following command:

-> show

The result of executing the show command appears:


-> show
 
/SP/AgentInfo/PEF/EventFilterTable1
    Targets:
 
    Properties:
        Status = enable
        SensorType = All
        PowerCtrl = disable
        DiagnosticInterrupt = disable
        SendAlert = disable
        SendMail = disable
 
    Target Commands:
        show
        set

Next, set the sensor type. There are six values for the sensor type:


All

Memory

Processor

Temperature

Voltage

Fan


4. Use the set command to configure the sensor type:

-> set sensortype=value

For example, to set the temperature sensor, enter:

-> set sensortype=Temperature

5. Use the set command to enable (or disable) actions.

For example, to set the sendalert and sendmail actions, enter:

-> set sendalert=enable

-> set sendmail=enable

6. When you are finished, use the show command to verify the PEF configuration:

-> show

The output from the command appears:


-> show
/SP/AgentInfo/PEF/EventFilterTable1
    Targets:
 
    Properties:
        Status = enable
        SensorType = temperature
        PowerCtrl = disable
        DiagnosticInterrupt = disable
        SendAlert = enable
        SendMail = enable
 
    Target Commands:
        show
        set

In the example above, EventFilterTable1 is enabled to activate the SendAlert and SendMail actions, based on temperature related alerts.

Managing the System Event Log

You can use the CLI to view and clear the System Event Log (SEL).


procedure icon  To Manage the System Event Log

1. To view the SEL, navigate to the SEL namespace and execute the show command:

-> cd /SP/AgentInfo/SEL
-> show

The content of SEL appears.

2. To clear the SEL, navigate to the SEL namespace and use the set command and the ClearEventlog property:

-> cd /SP/AgentInfo/SEL
-> set ClearEventlog=

Managing the Console

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


procedure icon  To Manage the 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

Managing Mail

You can use the CLI to configure mail parameters, including up to 10 email recipients.


procedure icon  To Manage Mail

1. Navigate to the Mail namespace:

-> cd /SP/AgentInfo/Mail

2. Use the set command to configure the IP address of the SMTP server and the sending server:

-> set SMTPServer=xxx.xxx.xxx
-> set Sender=xxx.xxx.xxx

xxx.xxx.xxx The IP addresses of the SMTP and sending servers.

3. Setup a email recipient:

-> cd receiver[1-10]

1-10 One of the 10 recipients

-> set EmailAddress=xxx.xxx.xxx

xxx.xxx.xxx The IP address of the receiving server.

Managing the Power State of the Server

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


procedure icon  To Manage the Power State of the Server

1. Navigate to the /SYS/CtrlInfo namespace:

-> cd /SYS/CtrlInfo

-> show

Example:

 -> cd /SYS/CtrlInfo
/SYS/CtrlInfo
 
 -> show
 
  /SYS/CtrlInfo
    Targets:
        FaultLed
 
    Properties:
        PowerStatus = on
        PowerCtrl = (Could not show property)
        BootCtrl = regular
        IdLedCtrl = off
 
    Target Commands:
        show
        cd
        set
 
 ->

The above example shows the available targets and properties.

a. To power on the server module, enter:

-> set /SYS/CtrlInfo PowerCtrl=on

b. To power off the server module gracefully, enter:

-> set PowerCtrl=gracefuloff

c. To power off the host, enter the following command:

-> set PowerCtrl=off

d. To reset the server module, enter:

-> set PowerCtrl=reset

e. To reboot the server module and enter BIOS automatically, enter:

-> set BootCtrl=BIOSSetup

f. To reboot the server module, and boot using PXE, enter:

-> set BootCtrl=PXE

g. To reboot and enter the Pc-Check diagnostic utility, enter:

-> set BootCtrl=PCCheck_enable

h. To disable the option to reboot into Pc-Check, and boot normally, enter the following commands:

-> set BootCtrl=PCCheck_disable
->
set BootCtrl=regular