ShMM CLI and Commands

This appendix provides information about using the ShMM CLI and most commonly used ShMM commands.

C.1 Shelf Manager Command-Line Interface

The Shelf Manager command-line interface (CLI) can be used to communicate with the intelligent management controllers of the shelf, with blade servers, and with the Shelf Manager itself, through text commands. The CLI is an IPMI-based set of commands that can be accessed directly or through a higher-level management application or a script. Administrators can access the CLI through a Telnet connection or the shelf management card serial port. Using the CLI, operators can access information about the current state of the shelf including current FRU population, current sensor values, threshold settings, recent events, and overall shelf health.

1. To use the CLI, first log on to the Linux operation system on the shelf management card.

2. Once logged in, run the executable clia from the command line with specific parameters.

The first parameter is the command verb. The clia executable is located on the virtual root file system maintained by Linux running on the shelf management card. The clia executable connects to the main Shelf Manager software process, passes the command information to it, and retrieves the results. The Shelf Manager must be running prior to starting the CLI. For example:

# clia ipmc 20
 
Pigeon Point Shelf Manager Command Line Interpreter
 
20: Entity: (d0, 0) Maximum FRU device ID: 20
    PICMG Version 2.0
    Hot Swap State: M4, Previous: M3, Last State Change Cause: Normal State Change (0)
#

If started without parameters, clia enters an interactive mode. In that mode, the program repeatedly issues a prompt to the terminal, accepts user input as the next command with parameters, executes that command, and shows the results on the terminal, until the user types the command exit or quit. For example:

# clia
 
Pigeon Point Shelf Manager Command Line Interpreter
 
CLI> ipmc 20
 
20: Entity: (d0, 0) Maximum FRU device ID: 20
    PICMG Version 2.0
    Hot Swap State: M4, Previous: M3, Last State Change Cause: Normal State Change (0)
 
CLI> exit
#

C.2 Shelf Manager CLI Commands

The Shelf Manager CLI implements the following commands. They are described in detail in the Netra CT 900 Server System Administration Manual (819-1177), with a subsection for each command, in alphabetical order of the command names. For the web site URL, see Related Documentation.

TABLE C-1 Shelf Manager CLI Command Summary
Command	Parameters	Description
`activate`	IPMB address FRU device ID	Activates the specified FRU.
`alarm`	alarm type	Activates or clears Telco alarms.
`board -v`	slot number (optional)	Shows information about blade servers.
`boardreset`	slot number	Resets the specified ATCA blade server.
`console`	slot number	Opens a console session on the node blade server in the specified slot.
`deactivate`	IPMB address FRU device ID	Deactivates the specified FRU.
`exit`\|`quit`		Exits from the interpreter in interactive mode.
`fans`	IPMB address (optional) FRU device ID (optional)	Shows information about fans.
`fru`	IPMB address (optional) FRU device ID (optional) FRU type (optional)	Shows information about one or a group of FRUs in the shelf; FRUs are selected by type or by the parent IPM controller.
`frudata`	IPMB address (optional) FRU device ID (optional) block/byte offset (optional) data (optional)	Provides raw access to the FRU. Information on the specified FRU.
`frudatar`	IPMB address FRU device ID File name	Reads the FRU data area of the specified FRU and stores the data in the specified file.
`frudataw`	IPMB address FRU device ID File name	Writes the FRU data in the specified file into the FRU data area of the specified FRU.
`fruinfo -v`	IPMB address FRU device ID	Provides user-friendly FRU Information output.
`getthreshold` \| `threshold`	IPMB address (optional) sensor name (optional) sensor number (optional)	Shows threshold information about a specific sensor.
`help`		Shows the list of supported commands.
`ipmc`	IPMB address (optional)	Shows information about one or all IPM controllers in the shelf.
`minfanlevel`	fan level (optional)	Shows or sets the minimum fan level.
`ps -ef \|grep hp`		Checks the `openhpi` status.
`sensor`	IPMB address (optional) sensor name (optional) sensor number (optional)	Shows information about one or a group of sensors; sensors are selected by IPM controller address, number or name.
`sensordata`	IPMB address (optional) sensor name (optional) sensor number (optional)	Shows value information for a specific sensor.
`sensorread`	IPMB address sensor number	Shows raw value information for a specific sensor (ignoring any Sensor Data Record describing the sensor).
`setfanlevel`	IPMB address FRU device ID level	Sets a new level for the fan controlled by the specified FRU. Use `clia setfanlevel 20 3 5` to get the fans to slow down.
`setfanpolicy`	IPMB address FRU device ID action to be taken: `ENABLE` or `DISABLE` timeout (optional) site type (optional) site number (optional)	Enables or disables fan trays for cooling management in addition to the Fan Geography record if this one is presented in the Shelf FRU.
`setthreshold`	IPMB address sensor name sensor number threshold type threshold value	Changes a specific threshold value (upper/lower, critical/non-critical/non-recoverable) for a specific sensor.
`setuserlabel`	shelf name slot number name	Configures user assigned names for the shelf and the blade servers. Blade server names are assigned to slot numbers.
`shelf`	subcommand, with its parameters	Shows general information about the shelf; several subcommands allow setting shelf attributes and getting additional information about specific areas.
`shelfaddress`	Shelf Address string (optional)	Gets or sets the Shelf Address field of the Address Table within Shelf FRU Information.
shelf address_table		Shows the address table record in the shelf FRU info with shelf address and list of address table entries. For each entry, shows hardware address, site type, and site number.
shelf cooling_state		Shows the current cooling state of the shelf with normal, minor, major, and critical alert information.
shelf fans_state		Shows the current state of the fan techometers in the shelf with normal, minor, major and critical alert information.
`shmstatus`		Shows the Shelf Manager Active/Backup status.
`showhost`	slot-number	Displays version information about the firmware on certain Netra CP3x60 node blade servers.
`showunhealthy`		Shows the unhealthy components of the shelf.
`switchover`		Initiates a switchover to the backup Shelf Manager.
`terminate`		Terminates the Shelf Manager without rebooting the shelf management card.
`version`		Shows the Shelf Manager version information.

TABLE C-1 Shelf Manager CLI Command Summary

Command

Parameters

Description

activate

IPMB address

FRU device ID

Activates the specified FRU.

alarm

alarm type

Activates or clears Telco alarms.

board -v

slot number (optional)

Shows information about blade servers.

boardreset

slot number

Resets the specified ATCA blade server.

console

slot number

Opens a console session on the node blade server in the specified slot.

deactivate

IPMB address

FRU device ID

Deactivates the specified FRU.

exit|quit

Exits from the interpreter in interactive mode.

fans

IPMB address (optional)

FRU device ID (optional)

Shows information about fans.

fru

IPMB address (optional)

FRU device ID (optional)

FRU type (optional)

Shows information about one or a group of FRUs in the shelf; FRUs are selected by type or by the parent IPM controller.

frudata

IPMB address (optional)

FRU device ID (optional)

block/byte offset (optional)

data (optional)

Provides raw access to the FRU. Information on the specified FRU.

frudatar

IPMB address

FRU device ID

File name

Reads the FRU data area of the specified FRU and stores the data in the specified file.

frudataw

IPMB address

FRU device ID

File name

Writes the FRU data in the specified file into the FRU data area of the specified FRU.

fruinfo -v

IPMB address

FRU device ID

Provides user-friendly FRU Information output.

getthreshold | threshold

IPMB address (optional)

sensor name (optional)

sensor number (optional)

Shows threshold information about a specific sensor.

help

Shows the list of supported commands.

ipmc

IPMB address (optional)

Shows information about one or all IPM controllers in the shelf.

minfanlevel

fan level (optional)

Shows or sets the minimum fan level.

ps -ef |grep hp

Checks the openhpi status.

sensor

IPMB address (optional)

sensor name (optional)

sensor number (optional)

Shows information about one or a group of sensors; sensors are selected by IPM controller address, number or name.

sensordata

IPMB address (optional)

sensor name (optional)

sensor number (optional)

Shows value information for a specific sensor.

sensorread

IPMB address

sensor number

Shows raw value information for a specific sensor (ignoring any Sensor Data Record describing the sensor).

setfanlevel

IPMB address

FRU device ID

level

Sets a new level for the fan controlled by the specified FRU.

Use clia setfanlevel 20 3 5 to get the fans to slow down.

setfanpolicy

IPMB address

FRU device ID

action to be taken: ENABLE or DISABLE

timeout (optional)

site type (optional)

site number (optional)

Enables or disables fan trays for cooling management in addition to the Fan Geography record if this one is presented in the Shelf FRU.

setthreshold

IPMB address

sensor name

sensor number

threshold type

threshold value

Changes a specific threshold value (upper/lower, critical/non-critical/non-recoverable) for a specific sensor.

setuserlabel

shelf name

slot number name

Configures user assigned names for the shelf and the blade servers. Blade server names are assigned to slot numbers.

shelf

subcommand, with its parameters

Shows general information about the shelf; several subcommands allow setting shelf attributes and getting additional information about specific areas.

shelfaddress

Shelf Address string (optional)

Gets or sets the Shelf Address field of the Address Table within Shelf FRU Information.

shelf address_table

Shows the address table record in the shelf FRU info with shelf address and list of address table entries. For each entry, shows hardware address, site type, and site number.

shelf cooling_state

Shows the current cooling state of the shelf with normal, minor, major, and critical alert information.

shelf fans_state

Shows the current state of the fan techometers in the shelf with normal, minor, major and critical alert information.

shmstatus

Shows the Shelf Manager Active/Backup status.

showhost

slot-number

Displays version information about the firmware on certain Netra CP3x60 node blade servers.

showunhealthy

Shows the unhealthy components of the shelf.

switchover

Initiates a switchover to the backup Shelf Manager.

terminate

Terminates the Shelf Manager without rebooting the shelf management card.

version

Shows the Shelf Manager version information.

Most informational commands support brief and verbose modes of execution, differing in the amount of information provided. Brief mode is the default (standard); verbose mode is selected by using the option -v in the command line, directly after the command and before the positional arguments. Commands that are executed on the backup Shelf Manager can only access objects (such as sensors, FRUs, IPM controllers) that are local to the backup Shelf Manager.

To help the user to determine whether a specific command is being executed on the active or on the backup Shelf Manager, the following message is issued when a CLI command is executed on the backup Shelf Manager: Running on the Backup Shelf Manager, with limited functionality.

C.1 Shelf Manager Command-Line Interface

To Start the Command-Line Interface

C.2 Shelf Manager CLI Commands