A P P E N D I X A |
Shelf Manager CLI Commands |
This chapter describes each CLI command and provides the syntax and usage of each of the available commands. The CLI supports AdvancedTCA shelf contexts.
As a convenience, key types of shelf components can be referenced in the following way, as an alternative to a reference notation based on the IPMB address and numerical FRU identifier:
In redundant configurations, not all commands listed below are supported by the backup Shelf Manager. The backup Shelf Manager recognizes only the following commands:
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.
In the command syntax below, optional elements are enclosed in square brackets ([,]), and variable elements in the command line (for example, IPMB address and FRU device ID) are printed in italics. A vertical bar (|) separates parameter alternatives.
SNMP is supported for reading and setting TELCO alarms (minor, major and critical).
activate IPMB-address fru-id
activate board n
activate shm n
This command sends the IPMI command Set FRU Activation (Activate FRU) to the specified FRU. The FRU is specified using the IPMB address of the owning IPM controller and the FRU device ID. FRU device ID 0 designates the IPM controller proper in PICMG 3.0 contexts.
In the PICMG 3.0 context, this command is primarily useful for those FRUs that were not listed in the power management table in the Shelf FRU Information, or for which the Shelf Manager Controlled Activation attribute is set to 0 (DISABLED). These FRUs are not automatically activated by the Shelf Manager and stay in the state M2 (Activation Request). The Shelf Manager automatically activates other FRUs once they reach state M2. Attempting to activate a FRU that is not in state M2 does nothing.
Activate the IPM controller proper at address 9C.
# clia activate 9c 0 Pigeon Point Shelf Manager Command Line Interpreter Command issued via IPMB, status = 0 (0x0) Command executed successfully # |
alarm [clear|info|minor|major|critical]
This command provides access to the Telco alarm outputs. Parameters minor, major, and critical allow the user to set the corresponding alarm output. These actions are cumulative; that is, after the commands clia alarm minor and clia alarm major, both minor and major alarms will be set. The action clear clears the minor and major alarm outputs; critical alarm output cannot be cleared. The action info displays information about the last alarm that occurred in the shelf.
Command invocation without parameters will return the status of Telco alarm outputs.
airfilterreplaced [dd.mm.yyyy]
A fan tray air filter change date can be maintained in a Pigeon Point defined multirecord in the Shelf FRU Information. This multirecord contains the following information related to air filter changes:
After an operator has replaced the air filter, he or she should use the Shelf Manager CLI tool to change the dates above in the Shelf FRU Information.
The date dd.mm.yyyy specified as the command parameter indicates the filter expiration date (that is, when the Air Filter shall be replaced again). If the date is omitted, the default expiration time is 6 months from the current date.
After executing the command, the Shelf Manager updates the Shelf FRU Information as follows: the field Air Filter Replaced contains the current calendar date and the field Air Filter To Be Replaced contains the expiration date - either the date supplied with the command or the default date - 6 months in the future.
Set the date for the next air filter replcement in the Shelf FRU information.
# clia airfilterreplaced 25.10.2007 Pigeon Point Shelf Manager Command Line Interpreter Command executed successfully # |
amcportstate [-v] IPMB-address [fru-id | amc amc-number]
amcportstate [-v] board n [fru-id | amc amc-number]
amcportstate [-v] shm n [fru-id | amc amc-number]
This command shows AMC port state information for a specific AMC. If a fru-id or amc-number is omitted, the AMC port state information is reported for all active AMCs for the designated IPM controller.
board [-v] [physical-slot-address]
This command and the boardreset command are different from the rest of the command set in that they work with ATCA boards and take as arguments physical slot numbers, rather than IPM controller addresses and FRU device IDs.
The command board shows information about each IPM controller in the range of IPMB addresses allocated to ATCA slots, and about each additional FRU controlled by these controllers. The list of items to be shown is given in sections fru and ipmc. The range of IPMB addresses is 82h-A0h for PICMG 3.0 systems, where boards have IPM controllers on them.
The physical address should be specified as a decimal number. For PICMG 3.0 systems, the correspondence between physical addresses and IPMB addresses is specified in the Shelf FRU Information. If the Shelf FRU information does not contain an address table, the following mapping table (mapping of logical slot numbers) is used.
Get standard information about all boards in the system (where only the boards in physical slots 4, 5, and 8 are present).
Get verbose information about a board in physical slot 4.
boardreset physical-slot-address
This command resets the board in the specified physical slot, sending it the IPMI command FRU Control (Cold Reset).
The physical address should be specified as a decimal number. For PICMG 3.0 systems, correspondence between physical addresses and IPMB addresses is specified in the Shelf FRU Information. If the Shelf FRU information does not contain an address table, the following mapping table (mapping of logical slot numbers) is used. FRU device ID is 0.
Reset the board in physical slot 14 (IPMB address 9C, FRU 0).
# clia boardreset 14 Pigeon Point Shelf Manager Command Line Interpreter Board 14 reset, status returned 0 # |
The following subcommands are supported:
This command shows information about the current state of the Bused E-Keying-managed resources and allows changing that state.
All subcommands accept a resource ID as one of the parameters. The resource ID is either a 0-based resource number or a short resource name. The following resource names and numbers are defined
The following subsections describe the syntax of the busres command for several key uses.
This command displays information about the current state of the specified resource or all resources if the resource ID is not specified.
The parameter resource is the resource ID. The list of supported resource IDs is provided in busres.
Get information about the state of Metallic Test Bus pair 2
# clia busres info mtb2 Pigeon Point Shelf Manager Command Line Interpreter Metalic Test Bus pair 2 (ID 1): Owned by IPMC 0x82, Locked # |
busres release | force resource
This command sends the Bused Resource Control request to the current owner of the resource, instructing it to release the resource. If the command syntax is busres release resource, the Bused Resource Control (Release) command is sent. If the command syntax is busres force resource, the Bused Resource Control (Force) command is sent. Refer to section 3.7.3.4 of the PICMG 3.0 R1.0 specification for a detailed description of these ATCA commands.
The parameter resource is the resource ID. The list of supported resource IDs is provided in busres.
Force releasing Metallic Test Bus pair 2 by the current owner.
# clia busres force mtb2 Pigeon Point Shelf Manager Command Line Interpreter Force operation succeeded # |
This command locks (busres lock resource) or unlocks (busres unlock resource) the specified resource. If the resource is locked, when another IPM controller sends the Bused Resource Control (Request) command to the Shelf Manager, the Shelf Manager responds with the Deny status. If the resource is unlocked, when another IPM controller sends the Bused Resource Control (Request) command to the Shelf Manager, the Shelf Manager responds with Busy status and sends the Bused Resource Control (Release) to the current owner. If the current owner releases the resource, on the next request, this resource will be granted to the requestor.
Only the resources that are owned by an IPM controller can be locked. As soon as the current owner releases the resource, the lock is also removed from this resource.
The parameter resource is the resource ID. The list of supported resource IDs is provided in busres.
# clia busres lock clk3 Pigeon Point Shelf Manager Command Line Interpreter Lock operation succeeded # |
busres [-v] query resource [target [noupdate]]
This command sends the Bused Resource Control (Query) request to the specified IPM controller. If the IPM controller is not specified in the command line, the request is sent to the current owner of the resource. Upon receiving the response, appropriate changes are made in the resource table (for example, if the IPM controller that is believed to be the current owner responds with the No Control status, the table is modified to reflect that fact), unless the noupdate flag is provided. If this flag is passed in the command line, no changes to the resource table are made based on the received information.
The parameter resource is the resource ID. The list of supported resource IDs is provided in busres.
The parameter target specifies the IPMB address of the IPM controller to which the request will be sent.
The flag noupdate, if present, indicates that the information received in response to the Query request should not be used to update the resource table.
In the current revision of the Shelf Manager, no additional information is provided if -v flag is specified.
Send query for Metallic Test Bus pair 1 to the IPM controller with address 0x82. Do not update the resource table based on the response.
# clia busres query mtb1 0x82 noupdate Pigeon Point Shelf Manager Command Line Interpreter No Control: IPMC 0x82 is not the owner of resource 0 # |
busres setowner resource target
Caution - This command is for experienced users and should be used at one’s discretion. |
This command directly sets the owner of the specified resource in the resource table. It does not send any Bused Resource Control commands, even if the resource had a different owner before executing the command. This is a low-level command that should be used for testing and recovery purposes only.
The parameter resource is the resource ID. The list of supported resource IDs is provided in busres.
The parameter target specifies the IPMB address of the IPM controller that is set as the owner of the resource. Use 0 as the IPMB address to specify that the resource is not owned by any IPM controller.
Set board 1 as the new owner for Metallic Test Bus pair 1.
# clia busres setowner mtb1 board 1 Pigeon Point Shelf Manager Command Line Interpreter New owner is set successfully # |
busres sendbusfree resource target
Caution - This command is for experienced users and should be used at one’s discretion. |
This command sends the Bused Resource Control (Bus Free) request to the specified IPM controller. No operation is performed on the resource before sending the request even if a different IPM controller owns it. However, the resource table is updated based on the response to this request. That is, if the IPM controller accepts ownership of the resource, it is set as the new owner in that table. This is a low-level command that should be used for testing and recovery purposes only.
The parameter resource is the resource ID. The list of supported resource IDs is provided in busres.
The parameter target specifies the IPMB address of the IPM controller, to which the request is sent. Use 0 as the IPMB address to specify that the resource is not owned by any IPM controller.
Send Bus Free request for Metallic Test Bus pair 1 to the IPM controller with address 0x82.
# clia busres sendbusfree mtb1 0x82 Pigeon Point Shelf Manager Command Line Interpreter IPMC rejected ownership of the resource # |
This command establishes a console terminal session on the node board in the specified physical slot. The shelf manager allows one console session per node board. Valid slot numbers are from 1-6 and 9-14.
The -f option forces a new console session by terminating an existing console session before starting the new console session.
Note - The shelf management must be the active shelf management card to use the console feature. A switch card must also be installed in slot 7 of the server’s midplane. |
Once a console session with a node board is established, you can run system administration commands, such as passwd, read status and error messages, or halt the board in that particular slot.
To disconnect from the current console session, enter ~q or ~. (tilda dot).
Start a console session on the node board in physical slot 4.
deactivate IPMB-address fru-id
deactivate board n
deactivate shm n
This command sends the IPMI command Set FRU Activation (Deactivate FRU) to the specified FRU. The FRU is specified using the IPMB address of the owning IPM controller and the FRU device ID. FRU device ID 0 designates the IPM controller proper in PICMG 3.0 contexts.
Deactivate the IPM controller proper at address 9C.
# clia deactivate 9c 0 Pigeon Point Shelf Manager Command Line Interpreter Command issued via IPMB, status = 0 (0x0) Command executed successfully # |
This command shows the current debug level for the Shelf Manager, or sets it to a new value if a new value is specified.
The debug level is a hexadecimal number in the range 0x0000 to 0x00FF that is treated as a bit mask. Each bit in the mask, when set, enables debug output of a specific type:
Starting with Shelf Manager release 2.4.4, separate debug levels can be set for Shelf Manager output to the system log versus output to the console. This makes it possible, for example, to reserve the system console for only serious error messages, while preserving the normal verbosity of the Shelf Manager output to the system log.
This command, when issued without parameters, shows the current debug level values for both system log and console. If both levels have the same value, only a single line of output produced.
This command, when issued with a single parameter new-value, sets the specified debug level for output to both the system log and the console.
If this command is invoked with two parameters, the first parameter specifies the debug level for system log output and the second parameter specifies the debug level for console output.
The default debug level for the Shelf Manager is 0x0007 for both the system log and the console, but this value can be overridden in the Shelf Manager configuration file (separately for the system log and the console), or during Shelf Manager startup, using the -v option in the command line for both the system log and the console.
This command can also be issued on the backup Shelf Manager.
Get current debug levels, and then set both to 0x001F.
Set the system log debug level mask to 0x0007 (informational) and the console maskto 0x0003 (errors and warnings only).
The command exit or quit exits the CLI interactive mode (which is entered by issuing clia without parameters).
fans [-v] [IPMB-address [FRU-device-ID]]
fans fan_tray n
This command shows information about the specified fan FRUs. If FRU device ID is omitted, the command shows information about all fan FRUs controlled by the IPM controller at the specified address. If the IPMB address is also omitted, the command shows information about all fan FRUs known to the Shelf Manager. The following information is shown:
Get fan information about all fan FRUs at IPMB address 20.
flashupdate slot-number -s server-ip-address -f fw-image-pathname
This command is used to update the Sun Netra CP3x60 board system firmware with the firmware image from a location that you specify. This command is only valid for Sun Netra CP3x60 boards installed in the Sun Netra CT900 server. The Sun Netra CP3x60 board system firmware that is updated includes the ILOM, ALOM-CMT/ILOM, Hypervisor, OBP, POST, and VBSC firmware.
Note - You can find the links to the Sun Netra CP3x60 firmware download sites at: http://www.sun.com/downloads/ |
To use this command, you need to know the following:
The slot-number contains the slot number of a Sun Netra CP3x60 board, the -s server-ip-addresss argument specifies the IP address of the server to download the firmware image from and the -f fw-image-pathname specifies the full pathname where the firmware image is located.
Downloading and updating system firmware on a Sun Netra CP3x60 board. Note that this process can take several minutes before completion. Upon successful completion, reset the board using the boardreset command.
fru [-v] [addr [id=fru_id | type=site_type]] | [type=site_type [/site_number]]
fru board n
fru shm n
fru fan_tray n
This command shows information about a specific FRU. If the FRU device ID is omitted, the command shows information about all FRUs controlled by the IPM controller at the specified address. If the IPMB address is also omitted, the command shows information about all FRUs known to the Shelf Manager.
Additionally, the site type can select FRUs. Site type should be specified in command parameters in hexadecimal. Associations between FRUs and their site types are stored in the Shelf FRU information. Site types are defined in the PICMG 3.0 specification as follows:
The following information is shown for the FRU in standard mode:
The following information is shown for the FRU in verbose mode only:
Get standard information about all FRUs at address 9C.
Get verbose information about all FRUs at address 9C.
Get verbose information about FRU 1 at address 20.
frucontrol IPMB-address fru-id command options
frucontrol board n command options
frucontrol shm n command options
frucontrol fan_tray n command options
This command sends the FRU Control command to the specified FRU, performing the specified operation on the FRU payload. The FRU is specified using the IPMB address of the owning IPM controller and the FRU device ID. FRU device ID 0 designates the IPM controller proper in PICMG 3.0 contexts.
The command parameter specifies the FRU Control command to be used. It can be specified as one of the following symbolic values:
The options parameter is used to set the timer options for the graceful_reboot command. The options are specified in hex and must be in the order shown:
timer_use timer_action pre-time_out countdown_LSB countdown_MSB
Refer to the section 8.3.1.1 in the ATCA Payload Graceful Shutdown Design document for detailed information.
Note - The warm_reset, diagnostic_interrupt, and graceful_reboot are optional and blade specific. Also warm_reset and diagnostic_interrupt are not supported on the Sun Netra CP3xxx blades. |
Issue a cold reset command to the FRU 0 at IPMB address 9C.
# clia frucontrol 9c 0 cr Pigeon Point Shelf Manager Command Line Interpreter FRU Control: Controller 0x9c, FRU ID # 0, command 0x00, status 0(0x0) Command executed successfully # |
Issue a cold reset command to the board in slot 13.
# clia frucontrol board 13 cr Pigeon Point Shelf Manager Command Line Interpreter FRU Control: Controller 0x98, FRU ID # 0, command 0x00, status 0(0x0) Command executed successfully # |
Issue a graceful_reboot command to FRU 0 at IPMB address 92.
# clia frucontrol 92 0 gr 03 01 0 b0 04 Pigeon Point Shelf Manager Command Line Interpreter FRU control: Controller 0x92, FRU ID # 0, command 0x00, status 0(0x0) Command executed successfully # |
Issue a graceful_reboot command to board in slot 13.
# clia frucontrol board 13 gr 03 01 0 b0 04 Pigeon Point Shelf Manager Command Line Interpreter FRU control: Controller 0x98, FRU ID # 0, command 0x02, status 0(0x0) Command executed successfully # |
frudata [addr [fru_id [block_offset]]]
frudata addr fru_id byte_offset byte 1 [byte2 ... [byte 16] ...]
addr fru_id can be replaced with the following:
This command provides access to the FRU Information in raw form. Depending on the command format, it is used to read or write the FRU Information.
In the read format, the command takes an optional 32-byte block number.
In the write format it requires a byte offset parameter. The user can modify up to 65535 bytes of FRU Information.
frudataw and frudatar are variants of the frudata command. frudataw allows the user to write a files on the ShMM Flash file system into the FRU information storage on a specific FRU in the shelf (see frudatar). frudatar allows the user to transfer the contents of the FRU Information storage for a specific FRU into a file on the ShMM Flash file system (see frudatar).
Display standard FRU data for all FRUs.
This example shows how to display FRU data and ways to write data to a FRU.
frudatar addr fru_id file_name
frudatar addr fru_id byte_offset byte 1 [byte2 ... [byte 16] ...]
addr fru_id can be replaced with the following:
This command reads FRU Information from the specified FRU and stores it in a file on the ShMM Flash file system in a raw format (in other words, uploads FRU Information from the specified FRU to a Flash file). The parameter file name specifies the path to the destination file. The number of bytes read from the FRU and written to the destination file is equal to the number of bytes returned in the response to the IPMI command Get FRU Inventory Area Info for the specified FRU.
Read FRU data for a specific FRU and store the data in the named file.
frudataw addr fru_id file_name
frudataw addr fru_id byte_offset byte 1 [byte2 ... [byte 16] ...]
addr fru_id can be replaced with the following:
This command downloads FRU Information to the specified FRU from a file on the ShMM flash file system. The file contains the raw binary image of the FRU Information. The parameter file name specifies the path to the source file.
Write FRU data from a file to the named FRU.
addr fru_id can be replaced by the following:
This command shows FRU Information in a user-friendly format.
Display FRU information for a particular FRU.
getacousticlevel ETSI NEBS-A NEBS-U
This command shows the system acoustic level and fan speed. This command is available for use with the server chassis. It allows users to get the current system acoustic level. When you set an acoustic level, the variable will be changed and the default cooling algorithm will set the fan speeds accordingly. This change will take effect dynamically, is persistant, and no ShMM reboot is required. See also setacousticlevel.
Note - These commands are applicable only if you are using the SUNCT900 cooling algorithm. |
Get the system acoustic level and fan speed.
# clia getacousticlevel ETSI Pigeon Point Shelf Manager Command Line Interpreter System acoustic level - ETSI fan speed - 5# |
getbootdev IPMB-0-address [FRU-device-ID | IPMB-L-address]
This command shows the system boot parameters for a designated IPM controller. If AdvancedMC access is not targeted, the second parameter should be set to 0 or omitted. The IPMB-L address for an AMC address is used if the second parameter exceeds 70h. Otherwise, the second parameter is treated as a FRU ID and converted to an IPMB-L address via AMC address mapping.
Get the system boot options for IPM controller at IPMB address 82h.
Get the system boot options for an AMC, where the carrier has IPMB-0 address 90h and the MMC has address IPMB-L address 72h.
getfanlevel IPMB-address fru-id
getfanlevel fan_tray n
This command shows the current level of the fan controlled by the FRU specified in the command parameters.
Get fan level for the fan residing at FRU #2 at IPMB address 0x20.
# clia getfanlevel 20 2 Pigeon Point Shelf Manager Command Line Interpreter 20: FRU # 2 Override Fan Level: 1, Local Fan Level: 255 # |
getfanpolicy [fan-tray-addr [fan-tray-fru_id]] [-s addr|site_type [fru_id | site_number]]
This retrieves information about Fan Tray(s) control mode and/or FRUs coverage by the specified Fan Tray(s). Notice that this command returns two different pieces of data: whether or not the site(s) are enabled/disabled for autonomous control by the Shelf Manager (based on Set Fan Policy commands), and whether or not the FRU site(s) are covered by the fans (according to the Fan Geography record).
The parameters fan-tray-addr and fan-tray-fru_id specify a fan tray. The command may accept no parameters, in this case the information about all Fan Trays and FRUs will be received.
If a numeric argument is expected to be treated as a hexadecimal, the "0x" prefix should be used, otherwise the error will be returned.
The flag -s precedes the parameters that define a site covered by the fan tray.
The site_type parameter can accept one of the following values: Board, PEM, ShelfFRU, ShelfManager, FanTray, FanFilterTray, Alarm, Mezzanine, PMC, RTM.
Get fan policy for the fan tray at IPMB address 20h, FRU ID 3.
# clia getfanpolicy 0x20 3 Pigeon Point Shelf Manager Command Line Interpreter Fan Tray: 0x20, FRU Id # 3 Policy Type: Any Site Policy Timeout: 20 seconds Policy Applied: Tue Oct 17 02:32:06 2006 # |
Get fan policy for the fan tray at IPMB address 20h, FRU ID 3, applied to the site at IPMB address 20h, FRU ID 1.
getfruledstate [-v] [IPMB-addr state [fru_id [LED_ID | ALL]]]
This command shows the current FRU LED state on all levels of control that are enabled for the LEDs. In verbose mode, information about the colors supported by the LEDs is also shown.
Information can be shown about a specific LED or all LEDs for the given FRU. IPMB address and FRU ID of the target LED can also be omitted. If FRU ID is omitted, information is shown about all LEDs on all FRUs of the given IPM controller. If IPMB address is also omitted, information is shown about all known LEDs in the shelf.
Show LED state for all LEDs on the IPM controller at IPMB address FCh.
Show verbose information about LED state for all LEDs on the IPM controller at IPMB address FCh.
Show LED state for FRU #0 of the IPM controller at IPMB address 20h.
Show LED state for LED #1 from FRU #0 of the IPM controller at IPMB address 20h.
gethysteresis [IPMB-address [[lun: ]sensor id | sensor name]]
This command shows the current hysteresis values for the specified sensor(s). The sensors must be threshold based. Both raw and processed values are shown.
The command allows the user to qualify the sensor number with the Logical Unit Number (LUN) if the targets controller supports sensors on multiple LUNs. If the LUN is omitted, the current hysteresis values for all sensors with the specified sensor number are shown. lun can take the value 0, 1, or 3. (LUN 2 is reserved.) Sensor names are not qualified with LUN numbers, since it is assumed that sensor names will normally be unique within the controller. However, if there are several sensors with the same name within the controller, information is shown about all of them. If IPMB-address is omitted, the current hysteresis levels for all sensors for the specified IPMB address are shown.
Show the hysteresis values for sensor # 2 on the IPM controller at IPMB address FCh.
getipmbstate IPMB-address [link] (in radial IPMB-0 environment) getipmbstate IPMB-address (in bused IPMB-0 environment)
This command shows the current state of IPMB-0 on the target IPM Controller. The state is taken from the sensor data provided by the IPMB Link sensor on the target IPMC (sensor type F1). Information about both buses A and B is printed.
The command works differently in bused and radial environments. In a bused environment, or in a radial environment if the target IPMC is not an IPMB hub, the argument link is not used. Information about the state of IPMB-A and IPMB-B on the target IPM controller is shown.
In the radial environment, if the target IPM Controller is an IPMB hub, the command works as follows:
In both cases, information about the state of both IPMB-A and IPMB-B is shown.
Show the current state of IPMB-0 on the IPMC at IPMB address 92h.
Show the current state of link 8 for the Shelf Manager in the radial environment.
getlanconfig channel [parameter-name [additional-parameters]]
getlanconfig channel [parameter-number [additional-parameters]]
This command shows the value of the specified LAN configuration parameter on the specified channel. If no configuration parameter name or number is specified, all configuration parameters for the specified channel are shown.
TABLE A-1 lists names and numbers of LAN configuration parameters supported by the getlanconfig command:
The following subsections provide more detailed information about each of the supported parameters.
Get and show the LAN parameter table for channel 1.
getlanconfig channel auth_support
getlanconfig channel 1
This command shows the current value of the LAN parameter auth_support. This parameter specifies which authentication types are supported by the Shelf Manager, represented by a single byte, treated as a bit mask with the bits defined as follows:
Other bits are reserved and should be set to 0.
Besides the raw hexadecimal value, symbolic values for the bits that are set are also shown.
# clia getlanconfig 1 auth_support Pigeon Point Shelf Manager Command Line Interpreter Authentication Type Support: 0x15 ( None MD5 Straight Password/Key # |
getlanconfig channel auth_enables
getlanconfig channel 2
This command shows the current value of the LAN parameter auth_enables. This parameter specifies which authentication types are currently enabled by the Shelf Manager for each of five supported privilege levels (Callback, User, Administrator, Operator, and OEM), represented by a sequence of five bytes, each corresponding to the respective privilege level, treated as a bit mask with the bits defined as follows:
Other bits are reserved and should be set to 0.
Besides the raw hexadecimal values, symbolic values for the bits that are set are also shown.
getlanconfig channel ip
getlanconfig channel 3
This command shows the current IP address used by the channel, in dotted decimal notation.
# clia getlanconfig 1 ip Pigeon Point Shelf Manager Command Line Interpreter IP Address: 172.16.2.203 |
getlanconfig channel ip_source
getlanconfig channel 4
This command shows the current value of the LAN parameter ip_source. This parameter specifies the source of the IP Address used by the Shelf Manager, represented by a single byte, which can have one of the following values:
Besides the raw hexadecimal value, the symbolic value is also shown.
# clia getlanconfig 1 ip_source Pigeon Point Shelf Manager Command Line Interpreter IP Address Source: Static Address (Manually Configured) (0x01) # |
getlanconfig channel mac
getlanconfig channel 5
This command shows the current MAC address used by the channel, in the form of six hexadecimal bytes separated by colons.
# clia getlanconfig 1 mac Pigeon Point Shelf Manager Command Line Interpreter MAC Address: 90:91:91:91:91:91 # |
getlanconfig channel subnet_mask
getlanconfig channel 6
This command shows the current IP subnet mask used by the channel, in dotted decimal notation.
# clia getlanconfig 1 subnet_mask Pigeon Point Shelf Manager Command Line Interpreter Subnet Mask: 255.255.255.0 # |
getlanconfig channel ipv4_hdr_param
getlanconfig channel 7
This command shows the current IP 4 header parameters. They are represented as three single-byte values in hexadecimal notation, separated with colons. The content of the bytes conforms to section 19.2 of the IPMI 1.5 specification.
# clia getlanconfig 1 ipv4_hdr_param Pigeon Point Shelf Manager Command Line Interpreter IPv4 Header Parameters: 0x40:0x40:0x10 # |
getlanconfig channel pri_rmcp_port
getlanconfig channel 8
This command shows the current RMCP primary port used by the channel, in hexadecimal. This is the port used for regular interactions via RMCP.
# clia getlanconfig 1 pri_rmcp_port Pigeon Point Shelf Manager Command Line Interpreter Primary RMCP Port Number: 0x026f # |
getlanconfig channel sec_rmcp_port
getlanconfig channel 9
This command shows the current RMCP secondary port used by the channel, in hexadecimal. This is the port used for secure interactions via RMCP.
# clia getlanconfig 1 sec_rmcp_port Pigeon Point Shelf Manager Command Line Interpreter Primary RMCP Port Number: 0x0298 # |
getlanconfig channel arp_control
getlanconfig channel 10
This command shows the current value of the LAN parameter arp_control. This parameter specifies additional ARP support provided by the Shelf Manager, represented by a single byte, treated as a bit mask with the bits defined as follows:
Other bits are reserved and should be set to 0.
Besides the raw hexadecimal value, symbolic values for the bits that are set are also shown.
# clia getlanconfig 1 arp_control Pigeon Point Shelf Manager Command Line Interpreter BMC-generated ARP Control: 02 Enable BMC-generated Gratuitous Response # |
getlanconfig channel arp_interval
getlanconfig channel 11
This command shows the current ARP interval used by the channel. The value is shown as the number of seconds in fixed-point numeric format.
# clia getlanconfig 1 arp_interval Pigeon Point Shelf Manager Command Line Interpreter Gratuitous ARP Interval: 2.0 seconds # |
getlanconfig channel dft_gw_ip
getlanconfig channel 12
This command shows the IP address of the default gateway used by the channel, in dotted decimal notation.
# clia getlanconfig 1 dft_gw_ip Pigeon Point Shelf Manager Command Line Interpreter Default Gateway Address: 0.0.0.0 # |
getlanconfig channel dft_gw_mac
getlanconfig channel 13
This command shows the MAC address of the default gateway used by the channel, in the form of six hexadecimal bytes separated by colons.
# clia getlanconfig 1 dft_gw_mac Pigeon Point Shelf Manager Command Line Interpreter Default Gateway MAC Address: N/A # |
getlanconfig channel backup_gw_ip
getlanconfig channel 14
This command shows the IP address of the backup gateway used by the channel, in dotted decimal notation.
# clia getlanconfig 1 backup_gw_ip Pigeon Point Shelf Manager Command Line Interpreter Backup Gateway Address: 0.0.0.0 # |
getlanconfig channel backup_gw_mac
getlanconfig channel 15
This command shows the MAC address of the backup gateway used by the channel, in the form of six hexadecimal bytes separated by colons.
# clia getlanconfig 1 backup_gw_mac Pigeon Point Shelf Manager Command Line Interpreter Backup Gateway MAC Address: N/A # |
getlanconfig channel community
getlanconfig channel 16
This command shows the community string parameter used in PET traps.
# clia getlanconfig 1 community Pigeon Point Shelf Manager Command Line Interpreter Community String: "public" # |
getlanconfig channel destination_count
getlanconfig channel 17
This command shows the maximum number of alert destinations available for the channel. This is a configuration parameter for the Shelf Manager and can be changed only through the shelfman configuration file.
# clia getlanconfig 1 destination_count Pigeon Point Shelf Manager Command Line Interpreter Number of Destinations: 16 # |
getlanconfig channel destination_type [set-selector]
getlanconfig channel 18 [set-selector]
This command shows the element of the destination table with the index equal to set-selector. Indexes are 0-based. Selector 0 is used to address the volatile destination. The following information is shown about the destination:
If the set selector is omitted, all active destinations are shown, with their numbers.
getlanconfig channel destination_address [set-selector] getlanconfig channel 19 [set-selector]
This command shows the element of the destination address table with the index equal to set-selector. Indexes are 0-based. Selector 0 is used to address the volatile destination. The following information is shown about the destination:
If the set selector is omitted, all active destination addresses are shown, with their numbers.
getmgmtportroute [slot-number]
This command displays the management port routing configuration. This information is stored on the midplane as an OEM record.
Use the slot-number option to display the management port routing information for a specified slot. If slot number is omitted, information will be returned for all slots. This data will be from the midplane only.
The configuration is persistent and designated for each slot, regardless of blade presence.
Display the management port routing information for the specified slot.
This command displays the multiplexer (MUX) configuration information that is stored in the shelf’s midplane OEM multi record for a specified slot. If the slot-number is not specified, then routing information for all the slots displayed. If the blade doesn’t have a MUX controller, the IPMC will ignore the mux-routing information sent by ShMM. The MUX controller is used to route the NIU ports to Zone 2 (backplane) and/or Zone 3 (ARTM). Use the slot-number option to display the MUX configuration information for a specified slot.
The Shelf Manager provides the configuration information read from the storage (midplane FRU) to the IPMC and the IPMC has to program the MUX prior to blade activation. See setmuxconfig and muxstate commands for more information.
Display the port routing information for the MUX on the node board in physical slot 5.
getpefconfig
getpefconfig parameter-name [additional-parameters]
getpefconfig parameter-number [additional-parameters]
This command shows the value of the specified PEF configuration parameter. If neither the configuration parameter name nor the parameter-number is specified, all PEF configuration parameters are shown.
TABLE A-2 lists names and numbers of PEF configuration parameters:
Get and show the whole PEF parameter table.
The following subsections provide more detailed information about each of the supported parameters.
getpefconfig control
getpefconfig 1
This command shows the current value of the PEF parameter control. This parameter is a single byte, treated as a bit mask with the bits defined as follows:
Other bits are reserved and should be set to 0.
# clia getpefconfig control Pigeon Point Shelf Manager Command Line Interpreter PEF control: 0x07 Enable PEF Enable Event Message for PEF Actions Enable PEF Startup Delay # |
getpefconfig action_control
getpefconfig 2
This command shows the current value of the PEF parameter action_control. This parameter is a single byte, treated as a bit mask with the bits defined as follows:
Other bits are reserved and should be set to 0.
getpefconfig startup_delay
getpefconfig 3
This command shows the current value of the PEF parameter startup_delay. This parameter is a single byte, representing the number of seconds that the PEF facility delays at startup.
# clia getpefconfig startup_delay Pigeon Point Shelf Manager Command Line Interpreter PEF Startup Delay: 60 seconds # |
getpefconfig startup_delay
getpefconfig 4
This command shows the current value of the PEF parameter alert_startup_delay. This parameter is a single byte, representing the number of seconds that the alerting facility delays at startup.
# clia getpefconfig alert_startup_delay Pigeon Point Shelf Manager Command Line Interpreter PEF Alert Startup Delay: 60 seconds # |
getpefconfig event_filter_count
getpefconfig 5
This command shows the current value of the PEF parameter event_filter_count. This read-only value is the size of the event filter table. This value is a configuration parameter for the Shelf Manager and can be changed only through the shelfman configuration file.
# clia getpefconfig event_filter_count Pigeon Point Shelf Manager Command Line Interpreter PEF Number of Event Filters: 64 # |
getpefconfig event_filter [set-selector]
getpefconfig 6 [set-selector]
This command shows the element of the event filter table with index equal to set-selector. Indexes are 1-based. The following information is shown about each event filter:
If the set selector is omitted, all active event filter table entries are shown, with their numbers.
getpefconfig event_filter_data1 [set-selector]
getpefconfig 7 [set-selector]
This command shows the first byte of the element of the event filter table with the index equal to set-selector. Indexes are 1-based. This byte is shown in hexadecimal. Bits in this byte have the following meaning:
Other bits are reserved and should be 0.
If the set selector is omitted, first byte for each of the active event filter table entries is shown, with the corresponding filter numbers.
# clia getpefconfig event_filter_data1 2 Pigeon Point Shelf Manager Command Line Interpreter Active event filter data: 0x02: 0x80 Enabled 1, Configuration: 0 ("Software Configurable Filter") # |
getpefconfig alert_policy_count
getpefconfig 8
This command shows the current value of the PEF parameter alert_policy_count. This read-only value is the size of the alert policy table. This value is a configuration parameter for the Shelf Manager and can be changed only through the shelfman configuration file.
# clia getpefconfig alert_policy_count Pigeon Point Shelf Manager Command Line Interpreter Alert Policies Count: 64 # |
getpefconfig alert_policy [set-selector]
getpefconfig 9 [set-selector]
This command shows the element of the alert policy table with index equal to set-selector. Indexes are 1-based. The following information is shown about each alert policy:
If the set selector is omitted, all active alert policy table entries are shown, with their numbers.
# clia getpefconfig alert_policy 2 Pigeon Point Shelf Manager Command Line Interpreter Policy: 0x02: Policy# 5, Policy Type: 0, Channel: 1, DST: 1, Alert String Sel: 1 # |
getpefconfig system_guid
getpefconfig 10
This command shows the current value of the PEF parameter system_guid. This parameter represents the GUID that is sent in a PET Trap PDU to an alert destination. This GUID may be defined as a separate GUID or as being equal to the System GUID (which can be obtained via the Get System GUID IPMI command).
# clia getpefconfig system_guid Pigeon Point Shelf Manager Command Line Interpreter PEF GUID: 23662f7f-ba1b-4b65-8808-94ca09c9bbb0 # |
getpefconfig alert_string_count
getpefconfig 11
This command shows the current value of the PEF parameter alert_string_count. This read-only value is the size of the alert string table, which is the maximum number of alert strings in simultaneous use. This value is the configuration parameter for the Shelf Manager and can be changed only through the shelfman configuration file.
# clia getpefconfig alert_string_count Pigeon Point Shelf Manager Command Line Interpreter Alert Strings Count: 64 # |
getpefconfig alert_string_key [set-selector]
getpefconfig 12 [set-selector]
This command shows the element of the alert string key table with index equal to set-selector. Indexes are 1-based. Index 0 can be used to designate the volatile alert string. Each key associates an event filter with an alert string for alert generation purposes. The following information is shown about each alert string key:
If the set selector is omitted, all active alert string key table entries are shown with their numbers.
# clia getpefconfig alert_string_key 2 Pigeon Point Shelf Manager Command Line Interpreter Alert string key: set selector 2, event_filter 0x10, string_set 0x11 # |
getpefconfig alert_string [set-selector]
getpefconfig 13 [set-selector]
This command shows the element of the alert string table with index equal to set-selector. Indexes are 1-based. Index 0 can be used to designate the volatile alert string. This command shows the whole string at once.
If the set selector is omitted, all defined alert strings are shown with their numbers.
# clia getpefconfig alert_string 2 Pigeon Point Shelf Manager Command Line Interpreter Alert Strings: 0x02: "This is the alert string" # |
getpefconfig oem_filter_count
getpefconfig 96
This command shows the current value of the PEF parameter oem_filter_count. This read-only value is the size of the OEM filter table. This value is a configuration parameter for the Shelf Manager and can be changed only through the shelfman configuration file.
The OEM filter table is a Pigeon Point Systems-defined OEM extension of the IPMI specification. It allows PEF to be applied, in addition to platform events, to OEM-timestamped and non-timestamped SEL entries (record type range C0h-FFh).
# clia getpefconfig oem_filter_count Pigeon Point Shelf Manager Command Line Interpreter PEF Number of OEM Filters: 16 # |
getpefconfig oem_filter [set-selector]
getpefconfig 97 [set-selector]
The OEM filter table is a Pigeon Point Systems-defined OEM extension of the IPMI specification. It allows PEF to be applied, in addition to platform events, to OEM-timestamped and non-timestamped SEL entries (record type range C0h-FFh).
Each entry of the OEM filter table defines the range of record types (in the range of OEM record types), to which this OEM filter applies, and the alert policy number that is to be invoked when a record with the matching record type is placed in the SEL.
This command shows the element of the OEM filter table with index equal to set-selector. Indexes are 1-based. The following information is shown about each OEM filter:
If the set selector is omitted, all active OEM filter table entries are shown, with their numbers.
# clia getpefconfig oem_filter Pigeon Point Shelf Manager Command Line Interpreter Active OEM Filters: 0x01: OEM range boundary 0xff:0xff, alert policy # 1 # |
getsensoreventenable [IPMB-address [sensor-name |[lun:]sensor-number]
getsensoreventenable board n [sensor-name | [lun:]sensor-number]]
getsensoreventenable shm n [sensor-name | [lun:]sensor-number]]
This command shows the current event enable mask values of the specified sensors.
This command allows the user to qualify the sensor number with the Logical Unit Number (LUN) if the target controller supports sensors on multiple LUNs. If the LUN is omitted, information about sensors with the specified sensor number on all LUNs is shown. lun can take the value 0, 1, or 3. (LUN 2 is reserved.)
Sensor names are not qualified with LUN numbers, since it is assumed that sensor names will normally be unique within the controller. However, if there are several sensors with the same name within the controller, information is shown about all of them.
This command shows the current sensor event mask values for the supported events of the specified sensors. The following attributes for each sensor are also shown:
Get event enable values for a temperature sensor Local Temp on IPM controller FE.
Get event enable information for the same sensor but specify sensor LUN and number.
getthreshold [IPMB-address [sensor-name | [lun:]sensor-number]]
getthreshold board n [sensor-name | [lun:]sensor-number]]
getthreshold shm n [sensor-name | [lun:]sensor-number]]
The verb threshold can also be used instead of getthreshold.
This command shows the current threshold values for the supported thresholds of the specified sensors. The sensor must be a threshold-based sensor. Both raw and processed values are shown. The following attributes for each sensor are also shown:
This command allows the user to qualify the sensor number with the Logical Unit Number (LUN) if the target controller supports sensors on multiple LUNs. If the LUN is omitted, information about sensors with the specified sensor number on all LUNs is shown. lun can take the value 0, 1, or 3. (LUN 2 is reserved.)
Sensor names are not qualified with LUN numbers, since it is assumed that sensor names will normally be unique within the controller. However, if there are several sensors with the same name within the controller, information is shown about all of them.
Get threshold values for a temperature sensor Local Temp on IPM controller FE.
Get threshold information for the same sensor but specify sensor LUN and number.
This command shows help information for supported commands and their syntax.
Get a list of commands and their syntax.
Get help for a specific command.
# clia help shelf pwrreorder Pigeon Point Shelf Manager Command Line Interpreter Set the Power Order PwrReorder <addr1> <fru_id1> before/after <addr2> <fru_id2> # |
ipmc [-v] [IPMB-address]
ipmc board n
ipmc fan_tray n
This command shows information about the IPM controller at the specified address, or about all IPM controllers known to the Shelf Manager, if IPMB-address is omitted.
The following information is shown for the IPM controller in standard mode:
Current hot-swap state, previous hot-swap state, and cause of the last state change for FRU device 0 of the IPM controller (which represents the IPM controller itself). The hot-swap states M0-M7 are defined in the PICMG 3.0 specification as follows:
The following additional information is shown for the IPM controller in verbose mode:
Get information about the IPM controller at address 9C.
Get verbose information about the IPM controller at address 9C.
This command shows the IPMB address of the current Shelf Manager, based on its hardware address (as opposed to its generic BMC address 0x20). These addresses will be different between redundant Shelf Managers (while the BMC address is shared between them).
This command is useful for determining the current port configuration and determining if there is a need to change it. This command employs the IPMC OEM command get ethernet port access to query the IPMC for management port state or port routing configuration.
If you are using a third-party chassis instead of a Sun Netra CT900 server chassis, modify your system manager or Shelf manager software to send the set ethernet port access OEM command to IPMC before starting power budget negotiations and applying power. The command has to be sent after M2 but before M4 state.
Display the management port state for the slot.
This command shows or sets the minimum fan level. Under normal conditions, the cooling management algorithm gradually decreases the level for the fans in the system while thermal conditions stay normal. However the cooling management algorithm would not try to decrease the fan level below the minimum level specified by the configuration parameter MIN_FAN_LEVEL, or by this command.
The default value for the minimum fan level is 1. Setting the minimum fan level to a higher value does not prevent the fan level from being set below that value via the command clia setfanlevel or via the ATCA command SetFanLevel submitted over RMCP. The minimum fan level affects only the automatic management of the fan level by the cooling management facility.
This command without parameters shows the current minimum fan level.
This command with an integer parameter sets the minimum fan level to the value of the parameter.
# clia minfanlevel 3 Pigeon Point Shelf Manager Command Line Interpreter Minimal Fan Level is set to 3 # clia minfanlevel Pigeon Point Shelf Manager Command Line Interpreter Minimal Fan Level is 3 # |
This command queries the IPMC for the current multiplexer (MUX) state and port routing information for the blade in the specified slot. This command is only valid on a host that is runing the Oracle Solaris OS.
The Shelf Manager provides the slot’s MUX configuration information stored in the shelf’s midplane FRU to the IPMC so that the IPMC can program the host MUX configuration prior to blade activation.
Note - The ShMM MUX configuration must match the Oracle Solaris host’s NIU driver configuration or the configuration can fail. |
The setmuxconfig command is used to store the MUX configuration on the ShMM and the getmuxconfig command is used to show the stored Mux configuration. See getmuxconfig and setmuxconfig commands for more information.
Display the port routing information for the MUX on the node board in physical slot 4.
This command is carrier-specific and is not necessarily supported on all ShMM carriers.
This command shows or sets the Network Element Identifier if this parameter is supported by the current carrier. The superuser (UID 0) privilege is required for setting the Network Element Identifier.
The Network Element Identifier specified as the command line parameter id must be in the format defined by the specific carrier.
If no parameter is specified in the command line, the current Network Element Identifier is displayed.
This command initiates rediscovery of IPM controllers on IPMB-0 by sending the Get Device ID command to all IPMB addresses.
This command is mostly useful in PICMG 2.x shelves, where Hot Swap state machine support for IPM controllers is optional and a new IPM controller on IPMB may not be immediately recognized by the Shelf Manager. The command poll causes the Shelf Manager to recognize new IPM controllers.
In AdvancedTCA shelves, this command is not necessary, because a new IPM controller is recognized by the Shelf Manager automatically when it sends its first Hot-Swap event. Nevertheless, this command can be used in AdvancedTCA shelves if an IPMB-0 population rediscovery cycle is needed.
sel [-v] [IPMB-address [record-count [starting-entry]]]
sel clear [IPMB-address]
sel info [IPMB-address]
IPMB-address can be replaced by the board n or shm n abbreviations
This command shows the contents of the System Event Log (SEL) on the specified IPM controller (at IPMB address 20h by default). The optional parameter record-count can be specified that indicates how many records from the record number starting-entry in the SEL are shown. The optional parameter starting-entry is the entry number of the first SEL record to print, relative to the beginning of the SEL. Both record-count and starting-entry must be within the range from 1 to the total number of records in the SEL. The default value of the optional parameter starting-entry is 1. The starting-entry is independent of the RecordID field of the SEL record
For each SEL record, the following information fields are shown:
The command sel clear clears the SEL on the specified IPM controller (at IPMB address 20h by default).
The -v option makes the SEL entries output more user-friendly.
Read the SEL on the Shelf Manager.
Get five SEL entries from entry # 15 (0x0f).
sendamc addr amc-address netfn command-code [parameter1 ... parameterN]
This command allows the user to send an IPMI command to an Advanced Management Controller (AMC) that resides behind its correspondent IPM controller in a transparent way. All the parameters of this command are hexadecimal numbers in the range 00h - FFh. The prefix "0x" is not required. The target controller is specified by the AMC-address parameter. If it is greater then 70h, this is the actual AMC address on IPMB-L. If it is less then 70h, it is the FRU device ID that represents the corresponding AMC. The NetFn code of the command is specified by the netfn parameter. The code of the command is specified by the command-code parameter. The request data bytes of the command are represented by parameter1, parameter2, and so on.
The command reports the completion code of the IPMI command and the response data are displayed as hexadecimal bytes.
Send the Get Device ID command to the AMC (IPMB address 84h, FRU ID 1). The NetFn of the command is 06h, the code of the command is 01h. Since this command does not require request data, no parameter1, parameter2, ... are specified.
# clia sendamc 84 1 6 1 Pigeon Point Shelf Manager Command Line Interpreter Completion code: 0x0 (0) Response data: 34 80 01 20 51 29 0A 40 00 EF BE # |
Send the "Get Device ID command to the AMC (IPMB address 84h, AMC address 72h). The NetFn of the command is 06h, the code of the command is 01h. Since this command does not require request data, no parameter1, parameter2, ... are specified.
# clia sendamc 84 72 6 1 Pigeon Point Shelf Manager Command Line Interpreter Completion code: 0x0 (0) Response data: 34 80 01 20 51 29 0A 40 00 EF BE # |
sendcmd IPMB-address netfn command-code [parameter1 ... parameterN]
This command allows the user to send an IPMI command to an IPM controller in a transparent way. All the parameters of this command are hexadecimal numbers in the range 00h - FFh. The prefix "0x" is not required. The target controller is specified by the IPMB-address parameter. The NetFn code of the command is specified by the netfn parameter. The code of the command is specified by the command-code parameter. The request data bytes of the command are represented by parameter1, parameter2, and so on.
The command reports the completion code of the IPMI command and the response data are displayed as hexadecimal bytes.
Send the Get Device ID command to the Shelf Manager (IPMB address 20h). The NetFn of the command is 06h, the code of the command is 01h. Since this command does not require request data, no parameter1, parameter2, ... are specified.
# clia sendamc 84 1 6 1 Pigeon Point Shelf Manager Command Line Interpreter Completion code: 0x0 (0) Response data: 00 80 02 30 51 BF 0A 40 00 00 00 # |
sensor [-v] [IPMB-address [sensor-name | [lun:]sensor-number]]
sensor [-v] board n [sensor-name | [lun:]sensor-number]]
sensor [-v] shm n [sensor-name | [lun:]sensor-number]]
This command shows information about specific sensors. The target sensor is selected by its IPM controller’s IPMB address and by sensor number or by sensor name (device ID string from the sensor SDR, enclosed in double quotes). If neither sensor name nor sensor number is specified, information about all sensors on the specified IPM controller is shown. If no parameters are specified, information about all known sensors is shown.
This command allows the user to qualify the sensor number with the Logical Unit Number (LUN) if the target controller supports sensors on multiple LUNs. If the LUN is omitted, information about sensors with the specified sensor number on all LUNs is shown. lun can take the value 0, 1, or 3 (LUN 2 is reserved.)
Sensor names are not qualified with LUN numbers, since it is assumed that sensor names will normally be unique within the controller. However, if there are several sensors with the same name within the controller, information is shown about all of them.
The following information is shown for each sensor in standard mode:
The following information is shown for the sensor in verbose mode only (refer to the IPMI specification for information about these attributes):
The following information is shown in verbose mode for threshold-based sensors only:
Get standard information about sensor FAN TRAY 0 on IPM controller 20.
Get verbose information about sensor 5 on IPM controller 8a.
Same as above, but explicitly specifying the LUN for the sensor.
sensordata [IPMB-address [sensor-name | [lun:]sensor-number]]
sensordata [-v] board n [sensor-name | [lun:]sensor-number]]
sensordata [-v] shm n [sensor-name | [lun:]sensor-number]]
This command shows the actual value of the specified sensor (for a threshold-based sensor) or the currently asserted states (for a discrete sensor). The target sensor is selected by its IPM controller’s IPMB address and by sensor number or by sensor name (device ID string from the sensor SDR, enclosed in double quotes). If neither sensor name nor sensor number is specified, values of all sensors on the specified IPM controller are shown. If no parameters are specified, values of all known sensors are shown.
This command allows the user to qualify the sensor number with the Logical Unit Number (LUN) if the target controller supports sensors on multiple LUNs. If the LUN is omitted, information about sensors with the specified sensor number on all LUNs is shown. lun can take the value 0, 1, or 3 (LUN 2 is reserved.)
Sensor names are not qualified with LUN numbers, since it is assumed that sensor names will normally be unique within the controller. However, if there are several sensors with the same name within the controller, information is shown about all of them.
The following information is shown for each sensor:
The value/asserted states are shown both in raw and processed form. In processed form, the analog value are converted according to M, B, and R and shown together with the unit name (for example, 27 degrees). The discrete value is annotated according to the event/reading code type (for example, for the event/reading code 2, the asserted state 0 is shown as Transition to Idle).
Get sensor data values for a temperature sensor Local Temp on IPM controller FE.
Get sensor data values for a discrete (Hot Swap) sensor (#0) on IPM controller 9C.
Get sensor data values for the same sensor, but qualifying it explicitly with the LUN.
sensorread IPMB-address [lun:]sensor-number
This command shows the raw value of the specified sensor. The only difference between the commands sensorread and sensordata is that the command sensorread does not check the presence of the target IPM controller or the validity of the sensor number, but just sends the Get Sensor Reading request directly via IPMB. This command does not retrieve the SDR of the sensor and thus it can not process the obtained data.
This command allows the user to qualify the sensor number with the Logical Unit Number (LUN) if the target controller supports sensors on multiple LUNs. If the LUN is omitted, LUN 0 is used. lun can take values 0, 1, or 3. (LUN 2 is reserved.)
The following information is shown for each sensor:
Get sensor data values for sensor 4 on IPM controller FC. Notice that the sensorread command provides only unprocessed sensor values. Also notice the command example with an explicit LUN.
This command shows information about active RMCP sessions. The information includes the following items:
setacousticlevel ETSI NEBS-A NEBS-U
This command sets the system acoustic level. This command is available for use with the server chassis and is only applicable only if you are using the SUNCT900 cooling algorithm. This command allows users to set the default fan speed to various acoustic levels based on custom configuration requirements. When you set an acoustic level, the variable will be changed and the default cooling algorithm will set the fan speeds accordingly. This change will take effect dynamically, is persistant, and no ShMM reboot is required. See also getacousticlevel.
Set the system acoustic level and fan speed.
# clia setacousticlevel NEBS-A Pigeon Point Shelf Manager Command Line Interpreter Changed the system acoustic level to ’NEBS-A’ Fan speed changed to ’7’. |
getbootdev IPMB-0-address FRU-device-ID | IPMB-L-address boot-device
This command sets the system boot parameter for a designated IPM controller. The second parameter of the command should be set to 0 if the AdvancedMC access is not targeted. If the second parameter exceeds 70h it is treated as an IPMB-L address for an AMC address. Otherwise, the second parameter is treated as a FRU ID and converted to an IPMB-L address via AMC address mapping.
The boot-device parameter can be:
Get the system boot options for IPM controller at IPMB address 82h as pxe (Pre-Boot Execution Environment).
# clia setbootdev 82 0 1 Pigeon Point Shelf Manager Command Line Interpreter Set boot device option: status = 0x0 (0) Boot device set to 1 (Force PXE) Response data (raw): A2 # |
setextracted IPMB-address fru-id
This command notifies the Shelf Manager that the specified FRU has been physically extracted from the shelf. If the specified FRU is in state M7, the Shelf Manager places it in state M0 (FRU physically absent).
# clia setextracted 9c 0 Pigeon Point Shelf Manager Command Line Interpreter Set FRU extracted state successfully # |
setfanlevel IPMB-address fru-id level
setfanlevel fan_tray n level
setfanlevel all level
This command sets the new level for the fan controlled by the FRU specified in the command parameters. The minimum is 1 and maximum is 15.
The version of this command with an all qualifier attempts to set the same level for all known fans in the shelf.
Set fan level for the fan residing at FRU #2 at IPMB address 0x20 to 5.
# clia setfanlevel 20 2 5 Pigeon Point Shelf Manager Command Line Interpreter 20: FRU # 2 Set Fan Level to: 5 # |
Set fan level to 4 for all known fans in the shelf:
# clia setfanlevel all 4 Pigeon Point Shelf Manager Command Line Interpreter 72: FRU # 0 Set Fan Level to: 4 76: FRU # 0 Set Fan Level to: 4 # |
setfanpolicy fan-tray-addr fan-tray-fru_id ENABLE | DISABLE [timeout]
[-s addr|site_type [fru_id | site_number]
This command enables or disables fan trays for cooling management in addition to the Fan Geography record if this one is presented in the ShelfFRU.
The parameters fan-tray-addr and fan-tray-fru_id specify a fan tray. If the DISABLE policy for the fan tray is specified, the additional parameter timeout may be used to specify the duration of the policy. The timeout parameter is treated in seconds and later is rounded by 5 seconds units according to the PICMG 3.0 specification. The value of the timeout parameter may not be greater then 21 minutes (1260 seconds), the minimum value of timeout is 5 seconds. If the timeout variable is not specified then the DISABLE policy is assumed to be infinite.
The flag -s precedes the parameters that define a site covered by the fan tray.
The site_type parameter can accept one of the following values: Board, PEM, ShelfFRU, ShelfManager, FanTray, FanFilterTray, Alarm, Mezzanine, PMC, RTM.
If a numeric argument is expected to be treated as a hexadecimal, the "0x" prefix should be used, otherwise the error will be returned.
Disable fan policy for 60 seconds. The fan tray is at IPMB address 20h, FRU ID 3. The site covered by the fan tray is at IPMB address 12h, FRU ID 0.
# clia setfanpolicy 0x20 3 DISABLE 60 -s 0x12 0 Pigeon Point Shelf Manager Command Line Interpreter Fan policy updated successfully # |
Disable fan policy for infinite period of time. The fan tray is at IPMB address 20h, FRU ID 3. The site covered by the fan tray is defined by Site Type "PICMG Board" and Site Number 7.
# clia setfanpolicy 0x20 3 DISABLE -s board 7 Pigeon Point Shelf Manager Command Line Interpreter Fan policy updated successfully # |
Enable fan policy for the fan tray at IPMB address 20h, FRU ID 3, and for all sites covered by this fan.
# clia setfanpolicy 0x20 3 ENABLE Pigeon Point Shelf Manager Command Line Interpreter Fan policy updated successfully # |
setfruledstate IPMB-address fru-id LedId|ALL LedOp [LedColor]
LedOp = ON | OFF | LOCAL | BLINK <onTime> <offTime> | TEST <onTime>
LedColor = BLUE | RED | GREEN | AMBER | ORANGE | WHITE | NONE | number
This command allows the user to set the state of a specific LED or all LEDs for the given FRU.
The first argument IPMB-address is the IPMB-address of an IPM controller. The second argument fru-id is the FRU device ID. The third argument can be either an LED ID (a numerical value) or ALL. In the latter case, the specified operation applies to all LEDs.
The argument LedOp specifies the operation applied to the FRUs, based on the PICMG 3.0 specification. The operations are defined as follows:
For the TEST operation, onTime must be less then 12800 ms (12.8 sec); for the BLINK operation, both onTime and offTime values must be within 10-2500 ms range.
The optional parameter LedColor designates a color, either via a symbolic name or a decimal value. Symbolic names of colors correspond to decimal values in accordance with the PICMG 3.0 specification, as listed below. (If the parameter is not specified, the default LED color is used.)
Turn off LED #1 of FRU #0 of IPM controller at IPMB address 20h.
# clia setfruledstate 20 0 1 OFF Pigeon Point Shelf Manager Command Line Interpreter Setting FRU’s led state completed successfully, status = 0x0 # |
Enable local control for LED #1 of FRU #0 of IPM controller at IPMB address 20h.
# clia setfruledstate 20 0 1 LOCAL Pigeon Point Shelf Manager Command Line Interpreter Setting FRU’s led state completed successfully, status = 0x0 # |
Enable blinking on LED #1 of FRU #0 of IPM controller at IPMB address 20h. The blinking is in the default color. The on duration is 100 ms and the off duration is 200 ms.
# clia setfruledstate 20 0 0 BLINK 100 200 Pigeon Point Shelf Manager Command Line Interpreter Setting FRU’s led state completed successfully, status = 0x0 # |
sethysteresis IPMB-address [lun:] sensor_id | sensor_name pos | neg [-r] value
This command sets the value for the specified hysteresis for the specified sensor. The sensor must be a threshold-based sensor. It must support the designated threshold hysteresis and the hysteresis must be settable.
The command allows the user to qualify the sensor number with the Logical Unit Number (LUN) if the target controller supports sensors on multiple LUNs. The command sets the positive hysteresis if the pos argument is present and sets the negative hysteresis if the neg argument is present.
Set positive hysteresis for sensor #2 of the IPM controller at IPMB address 0xFC.
# clia sethysteresis FC 2 pos 10 Pigeon Point Shelf Manager Command Line Interpreter Positive hysteresis set successfully to 0xA, previous: 0x0 # |
setipmbstate IPMB-address A|B [link] 1|0 (in radial IPMB-0 environment)
setipmbstate IPMB-address A|B 1|0 (in bused IPMB-0 environment)
This command enables or disables an IPMB link on the target IPM controller. The second argument defines the bus (IPMB-A or IPMB-B) to be enabled or disabled. The last argument defines the operation to be performed: 1 - to enable link, 0 - to disable link.
The command works differently in bused and radial environments. In a bused environment, and in radial environment for target IPM controllers other than an IPMB Hub, argument link is not used. For an IPMB hub controller in a radial environment, the argument link is optional.
If link is present, the command enables or disables the specific radial IPMB link (1 to 95). If link is omitted, the command enables or disables all the links on the IPMB hub in the radial system.
Disable IPMB-A link on the IPM controller at IPMB address 92h.
# clia setipmbstate 92 A 0 Pigeon Point Shelf Manager Command Line Interpreter Command executed successfully |
Enable radial IPMB link 3, bus B on the Shelf Manager (which is the IPMB hub).
# clia setipmbstate 20 B 3 1 Pigeon Point Shelf Manager Command Line Interpreter Command executed successfully |
setlanconfig channel parameter-name additional-parameters
setlanconfig channel parameter-number additional-parameters
This command sets the value of the specified LAN configuration parameter on the specified channel. The channel number, the configuration parameter name or number, and the parameter value should be explicitly specified.
TABLE A-3 lists names and numbers of LAN configuration parameters supported by the setlanconfig command:
setlanconfig channel auth_enables value1 value2 value3 value4 value5
setlanconfig channel 2 value1 value2 value3 value4 value5
This command sets the current value of the LAN parameter auth_enables. This parameter specifies which authentication types are currently enabled by the Shelf Manager for each of five supported privilege levels (Callback, User, Administrator, Operator, and OEM) and is represented by a sequence of five bytes, each corresponding to the respective privilege level, treated as a bit mask with the bits defined as follows:
Parameters value1 to value5 should represent the values of these bytes, in hexadecimal. The Shelf Manager does not currently support callback and OEM privilege levels. Therefore, the value1 and value5 parameters corresponding to these privilege levels should be specified as 0.
# clia setlanconfig 1 auth_enables 0 1 1 1 0 Pigeon Point Shelf Manager Command Line Interpreter Authentication Type Enables set successfully # |
setlanconfig channel ip value
setlanconfig channel 3 value
This command sets the current IP address used by the channel. The value should represent an IP address in dotted decimal notation.
# clia setlanconfig 1 ip 172.16.2.203 Pigeon Point Shelf Manager Command Line Interpreter IP Address set successfully # |
setlanconfig channel subnet_mask value
setlanconfig channel 6 value
This command sets the current IP subnet mask used by the channel. The value should represent a subnet mask in dotted decimal notation.
# clia setlanconfig 1 subnet_mask 255.255.255.0 Pigeon Point Shelf Manager Command Line Interpreter Subnet Mask set successfully # |
setlanconfig channel ipv4_hdr_param value1 value2 value3
setlanconfig channel 7 value1 value2 value3
This command sets the IP 4 header parameters for the Shelf Manager. They are represented as three single-byte values in hexadecimal notation: value1, value2, and value3. The content of the bytes conforms to section 19.2 of the IPMI 1.5 specification and contains the following attributes:
# clia setlanconfig 1 ipv4_hdr_param 37 E0 11 Pigeon Point Shelf Manager Command Line Interpreter IPv4 Header Parameters set successfully # |
setlanconfig channel arp_control value
setlanconfig channel 10 value
This command sets the current value of the LAN parameter arp_control. This parameter specifies additional ARP support provided by the Shelf Manager, and is represented by a single byte, treated as a bit mask with the bits defined as follows:
Other bits are reserved and should be set to 0.
# clia setlanconfig 1 arp_control 3 Pigeon Point Shelf Manager Command Line Interpreter BMC-generated ARP control set successfully # |
setlanconfig channel arp_interval value
setlanconfig channel 11 value
This command sets the current ARP interval used by the channel. The value should represent the number of seconds/milliseconds in fixed-point numeric format (with a possible fractional part). Due to the definition of this parameter in IPMI, it is truncated to the largest time interval that is divisible by 500 milliseconds.
# clia setlanconfig 1 arp_interval 3.5 Pigeon Point Shelf Manager Command Line Interpreter Gratuitous ARP interval set successfully # |
setlanconfig channel dft_gw_ip value
setlanconfig channel 12 value
This command sets the IP address of the default gateway used by the channel. The value should represent an IP address in dotted decimal notation.
# clia setlanconfig 1 dft_gw_ip 172.16.2.100 Pigeon Point Shelf Manager Command Line Interpreter Default Gateway Address set successfully # |
setlanconfig channel backup_gw_ip value
setlanconfig channel 14 value
This command sets the IP address of the backup gateway used by the channel. The value should represent an IP address in dotted decimal notation.
# clia setlanconfig 1 backup_gw_ip 172.16.2.100 Pigeon Point Shelf Manager Command Line Interpreter Backup Gateway Address set successfully # |
setlanconfig channel community value
setlanconfig channel 16 value
This command sets the community string parameter used in PET traps. The value should be a string enclosed in double quotes.
# clia setlanconfig 1 community “Community” Pigeon Point Shelf Manager Command Line Interpreter Community string set successfully # |
setlanconfig channel destination_type set-selector value1 value2 value3
setlanconfig channel 18 set-selector value1 value2 value3
This command sets the element of the destination table with the index equal to set-selector. Indexes are 0-based. Selector 0 is used to address the volatile destination. Values value1, value2, and value3 supply information about the new destination according to section 19.2 of the IPMI specification. The following information is supplied:
# clia setlanconfig 1 destination_type 2 80 3 5 Pigeon Point Shelf Manager Command Line Interpreter Destination Type set successfully # |
setlanconfig channel destination_address set-selector gateway-sel IP-address MAC-address
setlanconfig channel 19 set-selector gateway-sel IP-address MAC-address
This command sets the element of the destination address table with the index equal to set-selector. Indexes are 0-based. Selector 0 is used to address the volatile destination. The command parameters supply the necessary information:
# clia setlanconfig 1 destination_address 2 0 172.16.2.100 90:93:93:93:93:93 Pigeon Point Shelf Manager Command Line Interpreter Destination Addresses set successfully # |
setlocked IPMB-address fru-id 0 | 1
setlocked board n 0 | 1
setlocked shm n 0 | 1
setlocked fan_tray n 0 | 1
This command sets the Locked bit for the specified FRU to the specified state (0 for unlock or 1 for lock). The FRU is specified using the IPMB address of the owning IPM controller and the FRU device ID. FRU device ID 0 designates the IPM controller proper in PICMG 3.0 contexts.
The Locked bit controls, according to the PICMG 3.0 specification, whether the FRU is allowed to autonomously progress from state M1 (Inactive) to state M2 (Activation Request). If the Locked bit is set, this transition is not allowed. When the Shelf Manager sends the Deactivate command to the FRU, the FRU transitions to state M1 and sets the Locked bit, preventing subsequent state transitions.
This command can be used to re-activate a previously manually deactivated FRU by clearing the Locked bit for it.
This command can also be issued on the backup Shelf Manager; in that case, the Locked bit can only be set to the specified state for FRUs that are local to the backup Shelf Manager.
Clear the Locked bit for the IPM controller proper at address 9C, thus allowing it to reactivate.
# clia setlocked 9c 0 0 Pigeon Point Shelf Manager Command Line Interpreter Lock set successfully to 0x0 # |
setmgmtportroute [slot-number] [1/0]
This command sets the management port route. This information is stored on the midplane as an OEM record.
The configuration is persistent and designated for each slot, regardless of blade presence.
Display the management port routing state for the slot.
setmuxconfig slot-number [port : zone] [port : zone]
This command updates the multiplexer (MUX) configuration (or port routing) information that is stored in the shelf’s midplane OEM multi record for a specified slot. This command is used to ensure that the MUX configuration is persistent after board swap.
The port parameter specifies the 10 GbE NIU port and zone parameter specifies where it is routed. The valid port values are: XAUI-1 and XAUI-2 (or x1 and x2 for short). The valid zone values are zone2 and zone3 (or z2 and z3 for short); zone2 is the back plane and zone3 is the advance rear transition module (ARTM).
The Shelf Manager provides the slot’s MUX configuration information stored in the shelf’s midplane FRU to the IPMC so that the IPMC can program the host MUX configuration prior to blade activation. See getmuxconfig and muxstate commands for more information.
Set the port routing information for the MUX on the node board in physical slot 5.
# clia setmuxconfig 5 x1:z3 xaui2:Zone2 Pigeon Point Shelf Manager Command Line Interpreter Slot 5 : Successfully modified the mux routing. |
setpefconfig parameter-name additional-parameters
setpefconfig parameter-number additional-parameters
This command sets a new value of the specified PEF configuration parameter. TABLE A-4 lists names and numbers of PEF configuration parameters that can be set via this command.
setpefconfig control value
setpefconfig 1 value
This command sets a new value of the PEF parameter control. This parameter is a single byte, treated as a bit mask with the bits defined as follows:
Other bits are reserved and should be set to 0. The value should be entered in hexadecimal.
# clia setpefconfig control 7 Pigeon Point Shelf Manager Command Line Interpreter PEF control set successfully # |
setpefconfig action_control value
setpefconfig 2 value
This command sets a new value of the PEF parameter action_control. This parameter is a single byte, treated as a bit mask with the bits defined as follows:
Other bits are reserved and should be set to 0. The value should be entered in hexadecimal
# clia setpefconfig action_control 3f Pigeon Point Shelf Manager Command Line Interpreter PEF action control set successfully # |
setpefconfig startup_delay value
setpefconfig 3 value
This command sets the new value of the PEF parameter startup_delay. This parameter is a single byte, representing the number of seconds that the PEF facility delays at startup. The value is specified as a decimal number of seconds.
# clia setpefconfig startup_delay 45 Pigeon Point Shelf Manager Command Line Interpreter PEF startup delay set successfully # |
setpefconfig startup_delay value
setpefconfig 4 value
This command sets the current value of the PEF parameter alert_startup_delay. This parameter is a single byte, representing the number of seconds that the alerting facility delays at startup. The value is specified as a decimal number of seconds.
# clia setpefconfig alert_startup_delay 45 Pigeon Point Shelf Manager Command Line Interpreter Alert startup delay set successfully # |
setpefconfig event_filter set-selector value1 ... value19
setpefconfig 6 set-selector value1 ... value19
This command sets the element of the event filter table with the index equal to set-selector. Indexes are 1-based. The contents of the new element are specified by 19 numeric values value1 to value19, in hexadecimal, encoded according to the definition in table 15-2 of the IPMI specification version 1.5:
Set event filter 2 to trigger an alert action when an IPM controller at address 9C, FRU 0, reaches state M0 (the alert will be sent according with the Alert Policy #1):
# clia setpefconfig event_filter 2 80 1 1 10 9C FF F0 FF FF FF FF 0F FF 0 0 0 0 FF FF 0 Pigeon Point Shelf Manager Command Line Interpreter Event filter set successfully # |
setpefconfig event_filter_data1 set-selector value
setpefconfig 7 set-selector value
This command sets the first byte of the element of the event filter table with the index equal to set-selector. Indexes are 1-based. This byte should be specified in hexadecimal. Bits in this byte have the following meaning:
Other bits are reserved and should be 0.
This command can be used to quickly toggle the enabled/disabled state of an event filter; that is, turn it on and off without rewriting the whole table entry.
# clia setpefconfig event_filter_data1 2 80 Pigeon Point Shelf Manager Command Line Interpreter Event filter data1 set successfully # |
# clia setpefconfig event_filter_data1 2 0 Pigeon Point Shelf Manager Command Line Interpreter Event filter data1 set successfully # |
setpefconfig alert_policy set-selector value1 value2 value3 value4 value5
setpefconfig 9 set-selector value1 value2 value3 value4 value5
This command sets an alert policy table entry identified by the specified set selector. The contents of the new element are specified by the following five numeric values value1 to value5, in hexadecimal, encoded according to the definition in Table 15-4 of IPMI 1.5:
The following example sets up the alert policy table entry 2 with the following attributes:
setpefconfig system_guid guid-value
setpefconfig 10 guid-value
setpefconfig system_guid none
setpefconfig 10 none
This command sets the current value of the PEF parameter system_guid. This parameter represents the GUID that is sent in a PET Trap PDU to an alert destination. This GUID may be defined as a separate GUID or as being equal to the System GUID.
The guid-value can be specified as an actual GUID, conforming to the standard GUID format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, or as a symbolic value none. In the first case, the PEF facility uses the specified GUID in PET Traps. In the second case, the PEF facility defaults to the System GUID (the result of the IPMI Get System GUID command) for PET Traps.
setpefconfig alert_string_key set-selector value1 value2
setpefconfig 12 set-selector value1 value2
This command sets the element of the alert string key table with the index equal to set-selector. Indexes are 1-based. Set-selector 0 can be used to designate the volatile alert string. Each key associates an event filter with an alert string for the alert generation purposes, and consists of the event filter number and the alert string number. Both values are 8-bit values and are specified by the parameters value1 and value2 respectively, in hexadecimal.
# clia setpefconfig alert_string_key 2 10 11 Pigeon Point Shelf Manager Command Line Interpreter Alert string keys set successfully # |
setpefconfig alert_string set-selector <string-value>
setpefconfig 13 set-selector <string-value>
This command sets the element of the alert string table with the index equal to set-selector. Indexes are 1-based. Index 0 can be used to designate the volatile alert string. The string value should be enclosed in double quotes (“) and may contain special characters and line feeds inside the quotes.
# clia setpefconfig alert_string 2 "This string has a line feed inside." Pigeon Point Shelf Manager Command Line Interpreter Alert string set successfully # |
setpefconfig oem_filter set-selector value1 value2 value3
setpefconfig 97 set-selector value1 value2 value3
The OEM filter table is a Pigeon Point Systems-defined OEM extension of the IPMI specification. It allows PEF to be applied, in addition to platform events, to OEM-timestamped and non-timestamped SEL entries (record type range C0h-FFh).
Each entry of the OEM filter table defines the range of record types (in the range of OEM record types), to which this OEM filter applies, and the alert policy number that is to be invoked when a record with the matching record type is placed in the SEL.
This command sets an OEM filter table entry, the number of which is identified by the specified set selector. The entry consists of the following three numeric values:
setpowerlevel IPMB-address fruid [pwr_lvl |OFF] [COPY]
Instead of the IPMB-address, the user may use:
This command allows controlling the power level of a FRU and results in the Shelf Manager issuing a Set Power Level command on IPMB-0 to the designated IPM controller. Since the Shelf Manager core is responsible for managing power levels and tracking the corresponding power budgets, this command must be used with extreme care, especially when specifying a non-zero power level. Users of this command must be thoroughly familiar with the AdvancedTCA power management architecture as defined in the AdvancedTCA specification.
The target FRU is specified by the IPMB address of its IPM controller, plus the FRU device ID (fruid). Alternatively, the board number or a dedicated Shelf Manager number can be used to designate the target FRU.
The third argument pwr_lvl is a power level. The power levels allowed are 0h to 14h, if available. A zero power level is equivalent to the keyword OFF; in that case, the command performs a power off of the designated FRU, if possible.
If no power level is specified, the command does not change the current power level of the FRU; this is equivalent to specifying 0xFF as the power level value. If specified, the power level is an index that selects one of the previously arranged power draw values for the designated FRU. Each power draw value corresponds to a maximum power draw (in Watts) that the FRU is authorized to use.
At any given time, an AdvancedTCA FRU that has been powered on has a set of up to 20 (14h) power draws that have been established between the FRU (actually, the IPM controller that represents the FRU) and the Shelf Manager. The pwr_lvl argument selects one of this set of power draws as the maximum power that the FRU is authorized to use.
Thereafter until another change is made, that FRU must not draw more than that authorized amount of power. The current and maximum power levels, plus the associated authorized power draw (in Watts) associated with the current power level, are available for any FRU via the clia fru -v command.
The optional parameter COPY specifies whether to copy the desired power levels to the present power levels (see the AdvancedTCA specification for background). If this parameter is not specified, the command does not copy the desired power levels to the present power levels.
# clia setpowerlevel 84 0 OFF Pigeon Point Shelf Manager Command Line Interpreter Operation completed with status = 0x0 # |
setsensordata <IPMB-address> <sensor-name> [reading [-r] <value>] [assertion_<mask>] [deassertion_<mask>] [ event_data <b1> <b2> <b3> | event_data_no_offset <b1> <b2> <b3>]
setsensordata <IPMB-address> [<lun>:]<sensor-number> [reading [-r] <value>] [assertion_<mask>] [deassertion_<mask>] [ event_data <b1> <b2> <b3> | event_data_no_offset <b1> <b2> <b3>]
Using the -d option shows only discrete sensors having a specific state set in the state mask.
This command changes the reading, assertion/deassertion mask or event data bytes for the specified sensor. The sensor must be defined as settable, as defined in Addendum E372 to the IPMI specification v 2.0 (that is, bit [7] must be set to 1 in the Sensor Initialization byte of the corresponding SDR).
The sensor is specified by the IPMB address of the owning IPM controller and the sensor name or number. Alternatively, the board number or the dedicated Shelf Manager number can be used to designate the target IPM controller.
This command allows the user to qualify the sensor number with the Logical Unit Number (LUN) if the target controller supports sensors on multiple LUNs. <lun> can take the value 0, 1, or 3. (LUN 2 is reserved.) If the LUN is omitted, the command is applied to the sensor with the specified sensor number on the lowest LUN. (For example, if the command specifies sensor 3 without explicit LUN qualification, and the target controller exposes sensor 3 on LUN 1 and another sensor 3 on LUN 3, the command is applied to the sensor 3 on LUN 1.)
The parameters of this command follow the conventions of the IPMI command Set Sensor Reading and Event Status, defined in the Addendum E372 to the IPMI specification v 2.0.
The clause reading [-r] <value> specifies the new reading for the sensor. If the option -r is supplied, the <value> is interpreted as a raw value. Otherwise it is interpreted as a processed value and translated to the raw value using the SDR data (linearization, M, B, etc).
The clauses assertion <mask> and deassertion <mask> specify the current assertion/deassertion condition masks for the sensor, as 16-bit values. Their meaning is defined as follows.
The clauses event_data <b1> <b2> <b3> and event_data_no_offset <b1> <b2> <b3> are used to specify the event data bytes that are sent in the IPMI Platform Event request when the sensor generates an event. If the variant event_data is used, the event offset (the lower nibble of the event data byte 1) is taken from <b1>; if the variant event_data_no_offset is used, the even offset is generated automatically when the event happens, and the lower nibble of the byte <b1> is ignored.
This command can also be issued on the backup Shelf Manager; in that case, the command can apply only to sensors that are local to the backup Shelf Manager.
In the following examples, the settable sensor Eth0 Front has the type Entity Presence and both monitors and controls the state of the Ethernet connection on the front panel of the carrier board. The command setsensordata is issued to change the sensor state from Entity Present to Entity Absent, which effectively turns off the Ethernet connection on the front panel.
Show Eth0 Front Entity Present
Change Event Present to Absent (Assertion Event)
# clia setsensordata 10 10 assertion 2 Pigeon Point Shelf Manager Command Line Interpreter Sensor data set successfully |
setsensoreventenable IPMB-address sensor-name global [assertion_events [deassertion_events]]
setsensoreventenable IPMB-address [lun:]sensor-number global [assertion_events [deassertion_events]]
Instead of the IPMB-address, the user may use:
This command changes the event enable mask for the specified sensor. The sensor is specified by the IPMB address of the owning IPM controller and the sensor name or number. Alternatively, the board number or dedicated Shelf Manager number can be used to designate the target IPM controller.
This command allows the user to qualify the sensor number with the Logical Unit Number (LUN) if the target controller supports sensors on multiple LUNs. lun can take value 0, 1, or 3. (LUN 2 is reserved.) If the LUN is omitted, the command is applied to the sensor with the specified sensor number on the lowest LUN. (For example, if the command specifies sensor 3 without explicit LUN qualification, and the target controller exposes sensor 3 on LUN 1 and another sensor 3 on LUN 3, the command is applied to the sensor 3 on LUN 1.)
Enable the Lower Non-Critical Going Low event on the temperature sensor Local Temp on the IPM controller FE
Perform the same operation on the same sensor, but specify the sensor using LUN and sensor number:
# clia setsensoreventenable fe 0:3 0x90 0x01 0x00 Pigeon Point Shelf Manager Command Line Interpreter Event enable mask set successfully # |
setthreshold IPMB-address sensor-name threshold-type [-r] value
setthreshold IPMB-address [lun:]sensor-number threshold-type [-r] value
Instead of IPMB-address, the user may use:
This command changes the current threshold value for the specified threshold of the specified sensor. The sensor is specified by the IPMB address of the owning IPM controller and the sensor name or number. The target sensor must be a threshold-based sensor. The parameter threshold-type can be specified as one of the following symbolic values:
By default, the target value is specified in processed form (that is, in Volts for voltage sensors or in Celsius for temperature sensors). Option -r means that a raw value is used instead (usually a byte-size quantity, converted according to sensor-specific rules).
This command allows the user to qualify the sensor number with the Logical Unit Number (LUN) if the target controller supports sensors on multiple LUNs. lun can take the value 0, 1, or 3. (LUN 2 is reserved.) If the LUN is omitted, the command is applied to the sensor with the specified sensor number on the lowest LUN. (For example, if the command specifies sensor 3 without explicit LUN qualification, and the target controller exposes sensor 3 on LUN 1 and another sensor 3 on LUN 3, the command is applied to the sensor 3 on LUN 1.)
Set the upper non-critical threshold value for the temperature sensor emulated temp on IPM controller 9C to 99 degrees Celsius.
setuserlabel shelf shelf-name
setuserlabel slot slot-number slot-name
This command configures the user assigned name for the Sun Netra CT900 server shelf and slots. Valid slot numbers are from 1-14. User assigned labels are displayed using the userlabel command.
User assigned shelf and slot names are text strings that can be used to uniquely identify the shelf and board during a console session. See Displaying Board’s User Label During Console Session for more information.
The following subcommands are supported.
The command shelf shows key Shelf FRU information, plus selected current operating data for the shelf, and allows modifying some fields in the Shelf FRU information. The type of the information this command shows or modifies is specified in the command parameter.
The following subsections describe the syntax of the shelf command for different applications of this command.
shelf [cooling_state | fans_state | address_table | power_distribution | power_management | pci_connectivity | ha_connectivity | h110_connectivity | point-to-point_connectivity]
This syntax of the command shelf shows key Shelf FRU information, plus selected current operating data for the shelf. The type of the information this command shows is specified in the command parameter. TABLE A-5 lists the parameters supported by the shelf command:
For the command parameters cooling_state and fans_state, the verbosity option -v is available. It should be entered before the command parameter: clia shelf -v cooling_state. If used, the command will display the list of sensors (temperature or fan tachometers) that contribute to the current state. Each sensor is shown as a tuple (IPMB-address, sensor_number).
# clia shelf cooling_state Pigeon Point Shelf Manager Command Line Interpreter Cooling state: "Normal" # |
Get shelf fan tachometer status (verbose).
Get power distribution information.
Get power management information
shelf maxcurrent [feed] current
This command sets the Maximum External Available Current for the specified feed number and updates all known instances of shelf FRU information in the shelf. If the feed parameter is omitted, the value is set for the first feed (feed 0) in the shelf FRU information.
The parameter feed is a 0-based feed number in the shelf FRU information based on the sequential order of the description of that feed.
The parameter current is the desired current value in Amps.
Change the Maximum Available External Current for Feed 0 from 50 Amps to 99 Amps.
shelf minvoltage [feed] voltage
This command sets the Minimum Expected Operating Voltage for the specified feed number and updates all known shelf FRU information instances in the shelf. If the feed parameter is omitted, the value is set for the first feed (feed 0) in the shelf FRU information.
The parameter feed is a 0-based feed number in the shelf FRU Information based on the sequential order of the description of that feed.
The parameter voltage is the desired value.
Change the Minimum Expected Operating Voltage for the Feed 0
shelf activation hardware-addr fru-id [1/0]
shelf activation board n [1/0]
shelf activation board all [1/0]
shelf activation fan_tray n [1/0]
This command displays or changes the Shelf Manager Controlled Activation field for the specified FRU of the specified IPM controller. The command modifies the Shelf Manager Controlled Activation flag only for already existing entries in the Shelf Activation and Power Management record. This command also updates the cached version of the Shelf FRU Information used by the Shelf Manager. Thus the new value of the Shelf Manager Controlled Activation field becomes effective immediately without the need to restart the Shelf Manager.
The parameter hardware-addr is the 7-bit hardware address in hexadecimal format.
The parameter fru-id is a FRU ID in hexadecimal format; 0xFE means ALL FRUs at that hardware address.
Enable Shelf Manager Controlled Activation on an IPM controller with hardware address 0x42 (IPMB address 0x84).
shelf deactivation hardware-addr fru-id [1|0]
shelf deactivation board n [1|0]
shelf deactivation board all [1|0]
shelf deactivation fan_tray n [1|0]
This command displays or changes the Shelf Manager Controlled Deactivation field for the specified FRU of the specified IPM controller. The command modifies the Shelf Manager Controlled Deactivation flag only for already existing entries in the Shelf Activation and Power Management record. This command also updates the cached version of the Shelf FRU Information used by the Shelf Manager. Thus the new value of the Shelf Manager Controlled Deactivation field becomes effective immediately without the need to restart the Shelf Manager.
The parameter hardware-addr is the 7-bit hardware address in hexadecimal format.
The parameter fru-id is a FRU ID in hexadecimal format; 0xFE means ALL FRUs at that hardware address.
A value of 0 enables the Shelf Manager Controlled Deactivation which gives the Shelf Manager the responsible for deactivating the board. A value of 1 disables the Shelf Manager Controlled Deactivation which prevents the Shelf Manager from automatically deactivating the board. When the Shelf Manager Controlled Deactivation is disabled, the system administrator is responsible for board deactivation.
Enabling Shelf Manager Controlled Deactivation on an IPM controller with hardware address 0x42 (IPMB address 0x84).
shelf pwrcapability hardware-addr fru-id value
shelf pwrcapability board n value
shelf pwrcapability fan_tray n value
This command changes the Maximum FRU Power Capability field for the specified FRU of the specified IPM controller.
Note - Never set the Maximum FRU Power Capability field to a larger value than is safe for your shelf environment. |
The command modifies this field only for already existing entries in the Shelf Activation and Power Management record. This command also updates the cached version of the Shelf FRU Information used by the Shelf Manager. Thus the new value of the Maximum FRU Power Capability field becomes effective immediately without the need to restart the Shelf Manager.
Set Maximum FRU Power Capability on an IPM controller with hardware address 0x42 (IPMB address 0x84) to 150 Watts.
shelf pwrdelay hardware-addr fru-id value
shelf pwrdelay board n value
shelf pwrdelay fan_tray n value
This command changes the Delay Before Next Power On field for the specified FRU of the specified IPM controller. The command modifies this field only for already existing entries in the Shelf Activation and Power Management record. This command also updates the cached version of the Shelf FRU Information used by the Shelf Manager. Thus the new value of the Delay Before Next Power On field becomes effective immediately without the need to restart the Shelf Manager.
Set Delay Before Next Power On for an IPM controller with hardware address 0x42 (IPMB address 0x84) to 5 seconds.
This command changes the Allowance for FRU Activation Readiness parameter.
The parameter value is the new value for the parameter in seconds. The range of the possible values is 0..255.
Set Allowance for FRU Activation Readiness to 5 seconds.
shelf pwrreorder hardware-addr-1 fru-id-1 before|after hardware-addr-2 fru-id-2
hardware-address fru-id can be replaced by the following:
This command changes the order of the FRU Activation and Power Descriptors in the Shelf FRU Information. The command can reorder only the already existing descriptors. The current implementation is also limited to reordering the descriptors only inside a single Shelf Activation and Power Management record. This command also updates the cached version of the Shelf FRU Information used by the Shelf Manager. Thus the new order of the descriptors becomes effective immediately without the need to restart the Shelf Manager.
Place the descriptor for an IPM controller with hardware address 0x42 (IPMB address 0x84) before the descriptor for an IPM controller with hardware address 0x41 (IPMB address 0x82).
This command causes the Shelf Manager to re-read the previously found sources of shelf FRU information in the shelf and reassess which of the sources contain valid shelf FRU information. Assuming that valid shelf FRU information is confirmed, all of the shelf FRU information storage devices and the cached master copy of the shelf FRU information are updated with the contents of the new shelf FRU information.
As specified by PICMG 3.0 (section 3.6.4), the Shelf Manager tries to find possible shelf FRU information storage devices during initialization. If the Shelf Manager finds at least two FRU Information devices that contain valid shelf FRU information, the Shelf Manager performs an election to determine which shelf FRU information sources to use. This election is based on validating the data the storage devices contain and comparing the contents. After a successful election, the Shelf Manager creates a cached master copy of the shelf FRU information (in volatile memory) which is used for any updating of shelf FRU information sources and is treated as the sole source of the shelf FRU information. Thus, all shelf FRU information-related operations work with the master copy and changes of the master copy are automatically propagated to all shelf FRU information source devices as incremental updates.
However, dynamic reconfiguration is not supported. If the new shelf FRU information is different from the previous shelf FRU information, the changes will become fully effective only after a reboot of the Shelf Manager.
Successful refresh: two matching sources of the Shelf FRU Info.
Unsuccessful refresh: both data sources contain non-matching or invalid data.
This command causes a check of the shelf FRU information source devices and copying the contents of the shelf FRU information master copy to all of them. This command is useful in the case of a conflict between the shelf FRU information master copy and the non-volatile source devices, where the conflict is not resolved automatically (for example both EEPROMs and the master copy are different from each other). In that case, the operator can forcibly synchronize the EEPROMs with the contents of the master copy, using this command. Also, this command clears the error condition that has occurred due to the original conflict; that is, after this command has been issued, subsequent updates to the shelf FRU information will resume being propagated to the SEEPROMs.
This command initiates an update of the shelf FRU information source devices in an asynchronous fashion.
# clia shelf info_force_update Pigeon Point Shelf Manager Command Line Interpreter Starting the Shelf FRU Info source device update # |
shelfaddress [up-to-20-characters-of-the-shelf-address]
shelfaddress -x byte1 ..... byteN
This command gets or sets the Shelf Address field of the Address Table within shelf FRU information.
Without the option -x, the new shelf address is specified by a double quoted string that can contain any ASCII characters and can be as long as 20 characters.
If the option -x is specified, the new shelf address is specified as a sequence of hexadecimal bytes separated with spaces. Up to 20 bytes can be specified, each byte is represented with two hexadecimal digits (the 0x prefix is optional).
The shelf address is stored with a type indicator that differentiates between text and binary data. If the shelf address is specified as text, it is stored as text. If the shelf address is specified in hexadecimal, it is stored as binary data.
When the shelf address is displayed using this command, it is printed as text or as a sequence of hexadecimal bytes, depending on the type indicator.
This command returns the Shelf Manager status in redundant configurations: Active or Backup. In verbose mode it reports a more detailed picture: status of the shelf FRU information, status of the RMCP interface, and state of the backup Shelf Manager (if the Shelf Manager being queried is the active one). The ready for operation flag is a parameter that shows as Yes:
# clia shmstatus -v Pigeon Point Shelf Manager Command Line Interpreter Shelf Manager status: "Active" Ready For Operation: Yes Detailed State Flags: "Shelf FRU Found" "RMCP Up" "Backup Healthy" # |
showhost slot-number [version]
This command is used to display the system firmware versions installed on Sun Netra node boards. This command is only valid for Sun Netra CP3x60 node boards installed in the Sun Netra CT900 server.
The parameter slot-number specifies the slot number of the Sun Netra CP3x60 board and the version option is used to display full version information.
Show the current firmware versions for the Sun Netra CP3060 board in slot 2.
This command shows the list of FRUs that appear to have a problem. In the PICMG 3.0 context, this list includes FRUs for which the cause of last hot swap state change is Communication Lost, Communication lost due to local failure, Unexpected deactivation.
For each FRU, the following information is shown: IPMB address and FRU device ID, current hot-swap state, previous hot -swap state, and cause of the last state change
Show the list of unhealthy components in the system.
# clia showunhealthy Pigeon Point Shelf Manager Command Line Interpreter There are no unhealthy components in the shelf. # |
This command initiates switchover of the redundant Shelf Manager instances. This command can be executed on either the active or the backup instance of the Shelf Manager.
Forced switchovers from the backup Shelf Manager to handle the case of a frozen active ShMM (CLI command switchover -force) are supported. No negotiations between the Shelf Managers happen in this case; the backup Shelf Manager immediately takes control of hardware.
Initiate the switchover from either the active or backup instance.
This command initiates terminates the Shelf Manager without rebooting the shelf management card. If the current ShMM is active, a switchover takes place.
Terminate a Shelf Manager from either the active or backup instance.
The following subcommands are supported:
The user command shows information about the RMCP user accounts on the Shelf Manager and provides a simple way to add, delete, and modify the user accounts.
The following subsections describe the syntax of the user command for different applications of this command.
This command shows information about users. When it is launched with a -v option, it also shows information about disabled users. (By default, only enabled users are listed.) If the optional User ID is specified, only information about the user with that ID is shown.
The following items of information are shown:
If the channel access information is the same for several channels, the output is coalesced and the range of channels is shown.
user add userid user-name channel-access-flags privilege-level password
This command adds a new user to the system. It sets the same maximum privilege level and channel access flags for all channels, as specified in the command. The command will return an error if the specified user does not exist. Command parameters have the following meaning:
Add user 9 with the name root, administrator privilege level, and password PICMG guru.
This command deletes the user specified by the userid.
Delete the user with user ID = 10.
This command enables or disables a user by userid. The last command parameter specifies the requested action, as follows:
Disable and enable user with userid 9.
This command is used to modify the user name for the specified user. (The user is specified by a user ID.) The command parameters have the following meanings:
Change the name of user 9 to newby.
This command is used to modify the password for the specified user. (The user is specified by the user ID.) The command parameters have the following meanings:
Change the password of userid 9 to RIP
user channel userid channel-number channel-access-flags privilege-level
Purpose: This command is used to modify the channel access setting for a specified channel and user. (The user is specified by the user ID.) The command parameters have the following meanings:
Change the maximum privilege level for user 9 on channel 5 to User:
userlabel shelf | slot [slot-number]
This command displays the user assigned name for the shelf and slots in the server. Valid slot numbers are from 1-14. User assigned labels are set using the setuserlabel command.
User assigned shelf and slot names are text strings that can be used to uniquely identify the shelf and board during a console session. See Displaying Board’s User Label During Console Session for more information.
This command shows the version information for the Shelf Manager software.
Copyright © 2011, Oracle and/or its affiliates. All rights reserved.