User Guide - Home | Pigeon Point · Pigeon Point OpenHPI User Guide Release 2.10.1.0 3 January 23,...

User Guide Release 2.10.1.0 January 23, 2008

Pigeon Poin t OpenHPI User Guide

Release 2.10.1.0 2 January 23, 2008

© 2002-2008 Pigeon Point Systems. All rights reserved. Pigeon PointTM Open Hardware Platform Interface. This document is furnished under license and may be used or copied only in accordance with the terms of such license. The content of this manual is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Pigeon Point Systems. Pigeon Point Systems assumes no responsibility or liability for any errors or inaccuracies that may appear in this book. Except as permitted by such license, no part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, manual, recording, or otherwise, without the prior written permission of Pigeon Point Systems. Pigeon Point and Monterey Linux are trademarks of Pigeon Point Systems. Linux is a registered trademark of Linus Torvalds.



Table of Contents 1 ABOUT THIS DOCUMENT ...................................................................................................10

1.1 Related Documentation for the Pigeon Point Shelf Manager .......................................10 1.2 Conventions Used in this Document .............................................................................10 1.3 Additional Information....................................................................................................11

2 INTRODUCTION TO PIGEON POINT OPENHPI .................................................................12

3 INSTALLATION AND CONFIGURATION ............................................................................18

4 STARTUP AND INITIALIZATION .........................................................................................25

4.1 Starting OpenHPI ..........................................................................................................25 4.2 Initializing OpenHPI .......................................................................................................26 4.3 Implications of Shelf Manager Redundancy .................................................................26

5 USING THE COMMAND SHELL ..........................................................................................28

5.1 addcfg ............................................................................................................................36 5.1.1 Syntax .......................................................................................................................36 5.1.2 Purpose .....................................................................................................................36 5.1.3 Example ....................................................................................................................36

5.2 ann.................................................................................................................................37 5.2.1 Syntax .......................................................................................................................37 5.2.2 Purpose .....................................................................................................................37 5.2.3 acknow ......................................................................................................................37 5.2.4 add ............................................................................................................................37 5.2.5 delete ........................................................................................................................38 5.2.6 list ..............................................................................................................................38 5.2.7 mget ..........................................................................................................................38 5.2.8 mset ..........................................................................................................................38 5.2.9 show ..........................................................................................................................39

5.3 clearevtlog .....................................................................................................................40 5.3.1 Syntax .......................................................................................................................40 5.3.2 Purpose .....................................................................................................................40 5.3.3 Example ....................................................................................................................40

5.4 ctrl ..................................................................................................................................41 5.4.1 Syntax .......................................................................................................................41 5.4.2 Purpose .....................................................................................................................41 5.4.3 Example ....................................................................................................................41 5.4.4 setstate......................................................................................................................42 5.4.5 show ..........................................................................................................................43 5.4.6 state ..........................................................................................................................44

5.5 dat..................................................................................................................................45 5.5.1 Syntax .......................................................................................................................45 5.5.2 Purpose .....................................................................................................................45 5.5.3 Example ....................................................................................................................45

5.6 debug ............................................................................................................................46 5.6.1 Syntax .......................................................................................................................46 5.6.2 Purpose .....................................................................................................................46 5.6.3 Example ....................................................................................................................46

5.7 dimi ................................................................................................................................47 5.7.1 Syntax .......................................................................................................................47 5.7.2 Purpose .....................................................................................................................47 5.7.3 Example ....................................................................................................................47 5.7.4 cancel ........................................................................................................................48



5.7.5 info ............................................................................................................................48 5.7.6 ready .........................................................................................................................48 5.7.7 results ........................................................................................................................49 5.7.8 start ...........................................................................................................................49 5.7.9 status .........................................................................................................................49 5.7.10 testinfo ..................................................................................................................50

5.8 domain ...........................................................................................................................51 5.8.1 Syntax .......................................................................................................................51 5.8.2 Purpose .....................................................................................................................51 5.8.3 Example ....................................................................................................................51

5.9 domaininfo .....................................................................................................................52 5.9.1 Syntax .......................................................................................................................52 5.9.2 Purpose .....................................................................................................................52 5.9.3 Example ....................................................................................................................52

5.10 dscv ...............................................................................................................................53 5.10.1 Syntax ...................................................................................................................53 5.10.2 Purpose ................................................................................................................53 5.10.3 Example ................................................................................................................53

5.11 echo ...............................................................................................................................54 5.11.1 Syntax ...................................................................................................................54 5.11.2 Purpose ................................................................................................................54 5.11.3 Example ................................................................................................................54

5.12 event ..............................................................................................................................55 5.12.1 Syntax ...................................................................................................................55 5.12.2 Purpose ................................................................................................................55 5.12.3 Example ................................................................................................................55

5.13 evtlogreset .....................................................................................................................58 5.13.1 Syntax ...................................................................................................................58 5.13.2 Purpose ................................................................................................................58 5.13.3 Example ................................................................................................................58

5.14 evtlogstate .....................................................................................................................59 5.14.1 Syntax ...................................................................................................................59 5.14.2 Purpose ................................................................................................................59 5.14.3 Example ................................................................................................................59

5.15 evtlogtime ......................................................................................................................60 5.15.1 Syntax ...................................................................................................................60 5.15.2 Purpose ................................................................................................................60 5.15.3 Example ................................................................................................................60

5.16 exec ...............................................................................................................................61 5.16.1 Syntax ...................................................................................................................61 5.16.2 Purpose ................................................................................................................61 5.16.3 Example ................................................................................................................61

5.17 fumi ................................................................................................................................62 5.17.1 Syntax ...................................................................................................................62 5.17.2 Purpose ................................................................................................................62 5.17.3 Example ................................................................................................................62 5.17.4 activate .................................................................................................................63 5.17.5 backup ..................................................................................................................63 5.17.6 bankcopy ..............................................................................................................63 5.17.7 cancel ...................................................................................................................63 5.17.8 getsource ..............................................................................................................64 5.17.9 install .....................................................................................................................64 5.17.10 rollback .................................................................................................................64 5.17.11 setbootorder..........................................................................................................64 5.17.12 setsource ..............................................................................................................65



5.17.13 status ....................................................................................................................66 5.17.14 targetinfo ...............................................................................................................66 5.17.15 validatesource ......................................................................................................66 5.17.16 verifytarget ............................................................................................................66

5.18 help ................................................................................................................................68 5.18.1 Syntax ...................................................................................................................68 5.18.2 Purpose ................................................................................................................68 5.18.3 Example ................................................................................................................68

5.19 history ............................................................................................................................69 5.19.1 Syntax ...................................................................................................................69 5.19.2 Purpose ................................................................................................................69 5.19.3 Example ................................................................................................................69

5.20 hs ...................................................................................................................................70 5.20.1 Syntax ...................................................................................................................70 5.20.2 Purpose ................................................................................................................70 5.20.3 Example ................................................................................................................70 5.20.4 action ....................................................................................................................70 5.20.5 active ....................................................................................................................70 5.20.6 gettimeout .............................................................................................................71 5.20.7 inactive ..................................................................................................................71 5.20.8 ind .........................................................................................................................72 5.20.9 policycancel ..........................................................................................................72 5.20.10 settimeout .............................................................................................................73 5.20.11 state ......................................................................................................................73

5.21 inv/showinv ....................................................................................................................74 5.21.1 Syntax ...................................................................................................................74 5.21.2 Purpose ................................................................................................................74 5.21.3 Example ................................................................................................................74 5.21.4 addarea .................................................................................................................75 5.21.5 addfield .................................................................................................................75 5.21.6 delarea ..................................................................................................................76 5.21.7 delfield ..................................................................................................................76 5.21.8 setfield ..................................................................................................................76 5.21.9 show .....................................................................................................................76

5.22 lsensor ...........................................................................................................................78 5.22.1 Syntax ...................................................................................................................78 5.22.2 Purpose ................................................................................................................78 5.22.3 Example ................................................................................................................78

5.23 lsres ...............................................................................................................................82 5.23.1 Syntax ...................................................................................................................82 5.23.2 Purpose ................................................................................................................82 5.23.3 Example ................................................................................................................82

5.24 more ..............................................................................................................................84 5.24.1 Syntax ...................................................................................................................84 5.24.2 Purpose ................................................................................................................84 5.24.3 Example ................................................................................................................84

5.25 parmctrl .........................................................................................................................86 5.25.1 Syntax ...................................................................................................................86 5.25.2 Purpose ................................................................................................................86

5.26 power .............................................................................................................................87 5.26.1 Syntax ...................................................................................................................87 5.26.2 Purpose ................................................................................................................87 5.26.3 Example ................................................................................................................87

5.27 quit .................................................................................................................................88 5.27.1 Syntax ...................................................................................................................88



5.27.2 Purpose ................................................................................................................88 5.27.3 Example ................................................................................................................88

5.28 rdr/showrdr ....................................................................................................................89 5.28.1 Syntax ...................................................................................................................89 5.28.2 Purpose ................................................................................................................89 5.28.3 Example ................................................................................................................89

5.29 reset ..............................................................................................................................92 5.29.1 Syntax ...................................................................................................................92 5.29.2 Purpose ................................................................................................................92 5.29.3 Example ................................................................................................................92

5.30 reopen ...........................................................................................................................94 5.30.1 Syntax ...................................................................................................................94 5.30.2 Purpose ................................................................................................................94 5.30.3 Example ................................................................................................................94

5.31 rpt/showrpt .....................................................................................................................95 5.31.1 Syntax ...................................................................................................................95 5.31.2 Purpose ................................................................................................................95 5.31.3 Example ................................................................................................................95

5.32 run .................................................................................................................................97 5.32.1 Syntax ...................................................................................................................97 5.32.2 Purpose ................................................................................................................97 5.32.3 Example ................................................................................................................97

5.33 sen .................................................................................................................................98 5.33.1 Syntax ...................................................................................................................98 5.33.2 Purpose ................................................................................................................98 5.33.3 Example ................................................................................................................98 5.33.4 disable ..................................................................................................................99 5.33.5 enable ...................................................................................................................99 5.33.6 evtdis ................................................................................................................. 100 5.33.7 evtenb ................................................................................................................ 100 5.33.8 maskadd ............................................................................................................ 100 5.33.9 maskrm .............................................................................................................. 100 5.33.10 setthres .............................................................................................................. 101 5.33.11 show .................................................................................................................. 102

5.34 setsever ...................................................................................................................... 103 5.34.1 Syntax ................................................................................................................ 103 5.34.2 Purpose ............................................................................................................. 103 5.34.3 Example ............................................................................................................. 103

5.35 settag .......................................................................................................................... 104 5.35.1 Syntax ................................................................................................................ 104 5.35.2 Purpose ............................................................................................................. 104 5.35.3 Example ............................................................................................................. 104

5.36 settimeevtlog .............................................................................................................. 105 5.36.1 Syntax ................................................................................................................ 105 5.36.2 Purpose ............................................................................................................. 105 5.36.3 Example ............................................................................................................. 105

5.37 showevtlog ................................................................................................................. 106 5.37.1 Syntax ................................................................................................................ 106 5.37.2 Purpose ............................................................................................................. 106 5.37.3 Example ............................................................................................................. 106

5.38 ver............................................................................................................................... 108 5.38.1 Syntax ................................................................................................................ 108 5.38.2 Purpose ............................................................................................................. 108 5.38.3 Example ............................................................................................................. 108

5.39 wtdget ......................................................................................................................... 109



5.39.1 Syntax ................................................................................................................ 109 5.39.2 Purpose ............................................................................................................. 109 5.39.3 Example ............................................................................................................. 109

5.40 wtdreset ...................................................................................................................... 110 5.40.1 Syntax ................................................................................................................ 110 5.40.2 Purpose ............................................................................................................. 110 5.40.3 Example ............................................................................................................. 110

5.41 wtdset ......................................................................................................................... 111 5.41.1 Syntax ................................................................................................................ 111 5.41.2 Purpose ............................................................................................................. 111 5.41.3 Example ............................................................................................................. 111

6 DEVELOPING HPI-BASED APPLICATIONS .................................................................... 112

6.1 Simple HPI Application Example ................................................................................ 113 6.2 Building and Running HPI Applications...................................................................... 114

7 SIMPLE NETWORK MANAGEMENT PROTOCOL (SNMP) ............................................ 116

7.1 Overall Approach ........................................................................................................ 116 7.2 Launching OpenHPI SNMP ....................................................................................... 118 7.3 SNMP Variables ......................................................................................................... 119 7.4 Accessing the OpenHPI Server via SNMP ................................................................ 120

7.4.1 SNMPv2c ............................................................................................................... 120 7.4.2 SNMPv3 ................................................................................................................. 121

8 TROUBLE-SHOOTING ...................................................................................................... 124

APPENDIX A: PIGEON POINT OPENHPI VERSION CONTROL ....................................... 125

APPENDIX B: PIGEON POINT IPMI EXTENSION DEPENDENCIES ................................ 126

APPENDIX C: DIMI SUPPORT IN PIGEON POINT OPENHPI ........................................... 127

APPENDIX D: FUMI SUPPORT IN PIGEON POINT OPENHPI .......................................... 128



Tables Table 1 Shelf Manager Documentation ........................................................................................... 10 Table 2 Conventions Used in this Document .................................................................................. 11 Table 3 Global Configuration Variables ........................................................................................... 18 Table 4 Plug-in Handler Configuration Variables ............................................................................ 20 Table 5 Domain Handler Configuration Variables ........................................................................... 22 Table 6 Resource Capabilities ........................................................................................................ 29 Table 7 HPI Shell Commands and Descriptions ............................................................................. 31 Table 8 FUMI Access Protocols ...................................................................................................... 65 Table 9 Key Groups of HPI Variables ........................................................................................... 119



Figures Figure 1 Built-in System Manager Interface Options for the Pigeon Point Shelf Manager .............. 12 Figure 2 Pigeon Point OpenHPI Architecture .................................................................................. 14 Figure 3 Pigeon Point OpenHPI Control Flow ................................................................................. 15 Figure 4 Pigeon Point OpenHPI Service Location Options ............................................................. 16 Figure 5 Pigeon Point OpenHPI SNMP Models ............................................................................ 117


Release 2.10.1.0 10 January 23, 2008

1 About This Document This document describes the Pigeon Point implementation of the Service Availability Forum’s (SAF’s) Hardware Platform Interface (HPI). The HPI specification defines a data model and programming interface to monitor and control generic hardware platforms. The main focus of Pigeon Point’s HPI implementation is to provide a portable interface to the Pigeon Point AdvancedTCA Shelf Manager and the wide variety of AdvancedTCA shelves in which that Shelf Manager is integrated. HPI can perform the following operations (along with many others) on behalf of a client application that is managing one or more hardware platforms:

• returning information about available resources; • reading and changing settings for controls and sensors; • retrieving inventory information; • accessing event logs.

The Pigeon Point implementation of HPI is based on OpenHPI (http://www.openhpi.org/), which is a freely distributed HPI library for Linux. This document describes the architecture, configuration and installation of Pigeon Point OpenHPI and the development of HPI-based applications.

1.1 Related Documentation for the Pigeon Point Shelf Manager

Users of Pigeon Point OpenHPI may be interested in understanding the Shelf Manager through which OpenHPI accesses the AdvancedTCA shelves it is managing. There are two user documents for the Pigeon Point Shelf Manager, both of which are available in PDF format (see Table 1). Table 1 Shelf Manager Documentation

DOCUMENT DESCRIPTION Pigeon Point Shelf Manager User Guide

This document describes the overall configuration and use of the Pigeon Point Shelf Manager.

Pigeon Point Shelf Manager External Interface Reference

This document describes how to use the Shelf Manager command line interface, the web interface, the Simple Network Management Protocol (SNMP) interface and the Remote Management Control Protocol (RMCP) interface.

1.2 Conventions Used in this Document This table describes the textual conventions used in this document.

http://www.openhpi.org/�


Release 2.10.1.0 11 January 23, 2008

Table 2 Conventions Used in this Document CONVENTION SAMPLE DESCRIPTION

lsres This 10 point bold Courier font is used for text entered at keyboard in example dialogues, which typically occur as one or more separate lines.

(001):Shelf Resource:{S|RDR|INV|CNT|RES}

This 10 point normal Courier font is used for HPI output in example dialogues.

Refresh This 12 point bold Courier font is used for special text within normal paragraphs. The types of such special text include command names, file names, configuration parameters and command parameters, plus other text that could be entered by or displayed to an HPI user. This font is also used for command syntax definitions.

1.3 Additional Information • Service Availability Forum (http://www.sa-forum.org/), especially for access to the following

materials: • Specifications (including Hardware Platform Interface (SAI-HPI.B.02.01.pdf) and HPI-to-

AdvancedTCA Mapping (SAIM-HPI-B.01.01-ATCA) • Educational material, including 7 lessons on HPI and the HPI-to-ATCA mapping

specification • OpenHPI (http://www.openhpi.org) for access to source code and documentation • Net-SNMP (http://net-snmp.sourceforge.net/) for access to source code and

documentation of the Simple Network Management Protocol (SNMP) implementation that is used with OpenHPI

• Intelligent Platform Management Interface (IPMI), including v1.5 IPMI specification (http://www.intel.com/design/servers/ipmi/)

• Pigeon Point Shelf Manager documentation (http://www.pigeonpoint.com/library/) • Overall information about other Pigeon Point products

(http://www.pigeonpoint.com/products.html)

http://www.sa-forum.org/�


http://net-snmp.sourceforge.net/�

http://www.intel.com/design/servers/ipmi/�

http://www.pigeonpoint.com/library/�

http://www.pigeonpoint.com/products.html�


Release 2.10.1.0 12 January 23, 2008

2 Introduction to Pigeon Point OpenHPI In the AdvancedTCA context, HPI provides a portable foundation layer for System Manager applications. The System Manager in AdvancedTCA is a logical concept referring to the combination of software and people that provides high level management for one or more AdvancedTCA shelves. The figure below shows the built-in System Manager interfaces supported by the Pigeon Point Shelf Manager and indicates the extent to which each interface is defined by public specifications. At the extremes, an interface can be entirely defined by a public specification (including both its framework and semantics) or entirely defined by Pigeon Point. Figure 1 Built-in System Manager Interface Options for the Pigeon Point Shelf Manager

For the SNMP interface, the protocol is defined by the Internet Engineering Task Force (IETF), but the Management Information Base (MIB) accessed via that protocol is Pigeon Point specific. Similarly for the HTTP interface, the protocol is defined by World Wide Web Consortium (W3C), but


Release 2.10.1.0 13 January 23, 2008

the web pages accessed by that protocol are Pigeon Point specific, as well. Finally, the command line interface is entirely Pigeon Point specific. As a result, System Manager applications that are based on any of these three interfaces are specific to the Pigeon Point Shelf Manager. The only one of these interfaces that allows for a portable System Manager is the Remote Management Control Protocol (RMCP) interface. Some System Manager implementers are successfully using RMCP as their interface to the Pigeon Point Shelf Manager (and other AdvancedTCA Shelf Managers as well), but other implementers prefer a more abstracted interface to the managed shelves. HPI provides such an abstracted interface. HPI enables monitoring and control of highly available systems through a consistent, platform-independent set of programmatic interfaces, which are defined in the Hardware Platform Interface specification (SAI-HPI-B.02.01). Especially when combined with the HPI-to-AdvancedTCA Mapping specification (SAIM-HPI-B.01.01-ATCA), HPI defines the framework and semantics for an interface to ATCA shelves that enables portable System Manager implementations. HPI was initially designed for use with IPMI-based management infrastructures and is most straightforwardly adapted to this type of platform. However, HPI is also adaptable to any other platform with sufficient underlying platform management technology. The HPI implementation described in this document has the following characteristics:

• It is based on OpenHPI (http://www.openhpi.org); • It has been adapted by Pigeon Point for AdvancedTCA shelves and specifically for

compliance with the SAF’s HPI-to-AdvancedTCA mapping specification; • It uses the Pigeon Point plug-in, which is based on OpenHPI IPMI Direct plug-in, heavily

modified for mapping specification compliance and tuned to work with the Pigeon Point Shelf Manager.

The architecture of Pigeon Point OpenHPI is illustrated in Figure 2.



Release 2.10.1.0 14 January 23, 2008

Figure 2 Pigeon Point OpenHPI Architecture

Here are the key elements of this architecture:

• OpenHPI Daemon: The OpenHPI daemon provides the main functionality of the HPI B.02.01 service, using a client/server model of interaction with HPI applications (as elaborated below).

• Pigeon Point Plug-in: The Pigeon Point plug-in provides the specific interface from the generic layer of OpenHPI to AdvancedTCA shelves, especially those managed by the Pigeon Point Shelf Manager. Features supported by the plug-in include sensors, FRU inventory data and hot swapping, plus system event log management. It is provided in binary format as a Linux library (libpigeonpoint.so)

• HPI Client Library: HPI Client Library is a portable, platform-independent and CPU-independent library. It provides the HPI B.02.01 API as well as an integrated implementation of the OpenHPI Remote Procedure Call (RPC) protocol for remote HPI Client-Server communication. The HCL is a dynamically linkable library. It can be linked at compile time or loaded during runtime with any generic HPI B.02.01 compliant application.


Release 2.10.1.0 15 January 23, 2008

It is provided in binary format as a set of Linux libraries for Linux–based applications. The source code of the library is also available.

• SNMP Agent and HPI MIB: The Management Information Base (MIB) is the part of the Simple Network Management Protocol (SNMP) architecture that provides the repository for management data. The HPI MIB is defined by the SAF and therefore is generic across HPI-managed platforms. This MIB is implemented in OpenHPI via an SNMP Agent (and especially its subagent where the MIB is actually implemented). The subagent is an HPI client application. Please see section 7 for more detailed coverage of the OpenHPI SNMP facility.

The control flow in the Pigeon Point OpenHPI implementation is illustrated in Figure 3. Figure 3 Pigeon Point OpenHPI Control Flow

The client application interfaces with the OpenHPI daemon through the OpenHPI client library, calling functions defined in the HPI specification. For each function call, the OpenHPI client library sends an RPC request packet to the OpenHPI daemon. The OpenHPI daemon passes the request to the currently selected plug-in, where one HPI call can potentially invoke several plug-in calls (two calls in the example of Figure 3). The Pigeon Point plug-in translates function calls into RMCP messages and sends them to the Shelf Manager synchronously. The RMCP responses are translated back into plug-in return values. The OpenHPI client library accepts the OpenHPI RPC response packet from the OpenHPI daemon and returns the function call result to the client. The


Release 2.10.1.0 16 January 23, 2008

client application is aware only of the top level function calls and returns; the other components and message flows in the figure are invisible to the client. Because the OpenHPI daemon interacts with the Shelf Manager via RMCP, the daemon can execute on any platform that has Ethernet connectivity with the Shelf Management Mezzanine (ShMM) where the Shelf Manager executes. In particular the daemon can reside either:

• directly on the ShMM, sharing compute resources with the Shelf Manager or • on some other platform that is linked to the ShMM via Ethernet.

In either case, communication with the Shelf Manager occurs via RMCP. The SNMP agent and subagent are assumed to reside with the OpenHPI daemon, either on-ShMM or off-ShMM. Figure 4 shows these options, without detailing the plug-in portion of the daemon, which doesn’t affect this discussion. The corresponding picture for the OpenHPI-based SNMP interface appears in section 7. Figure 4 Pigeon Point OpenHPI Service Location Options


Release 2.10.1.0 17 January 23, 2008

Locating the OpenHPI facility on-ShMM requires additional memory resources over those needed for executing just the Shelf Manager. Therefore, the on-ShMM model is supported only on ShMMs with 64 MB of Flash and 128 MB of RAM.


Release 2.10.1.0 18 January 23, 2008

3 Installation and Configuration If your organization has licensed Pigeon Point OpenHPI directly from Pigeon Point, you can download and install OpenHPI using release notes and scripts posted on a release page that Pigeon Point maintains for your organization. Alternatively, your AdvancedTCA platform supplier may have delivered your platform with OpenHPI already installed. The off-ShMM model for the OpenHPI service (see section 2) has been tested with the OpenHPI service running on the following x86 Linux platforms:

• Red Hat Enterprise Linux 3 and 4 • Debian 4.0 • Mandriva Linux 2007 Spring

Support for other x86 Linux platforms can be discussed with Pigeon Point on a case by case basis. This section assumes that Pigeon Point OpenHPI is already installed and focuses on configuring this installation. OpenHPI configuration is controlled by a configuration file that is typically located in the /etc directory. The location of the configuration file is communicated to the OpenHPI daemon by either: 1) setting the following environment variable: OPENHPI_CONF=/etc/openhpi.conf or 2) using the –c option when the OpenHPI daemon is invoked, for example: #openhpid -c /etc/openhpi/openhpi.conf Please see Section 4.1 for the details of invoking the OpenHPI daemon. The configuration file for the OpenHPI daemon must be located on the same system as the OpenHPI daemon. Each line in the file is either a comment line (starting with #) or a <name> = <value> pair, representing the assignment for the configuration variable. The name and the value are separated with the equal sign =. For string variables, <value> must be a quoted string (e.g., "This is a string."). For numeric variables, <value> is a number. One group of configuration variables applies to the operation of the overall OpenHPI daemon; these are listed in Table 3, along with the type of each variable. Table 3 Global Configuration Variables

GLOBAL CONFIGURATION VARIABLE

TYPE DESCRIPTION

OPENHPI_CONF String Defines the configuration file name.


Release 2.10.1.0 19 January 23, 2008

GLOBAL CONFIGURATION VARIABLE

TYPE DESCRIPTION

OPENHPI_DEBUG String Controls OpenHPI debug mode; when the value is YES, debug mode is on.

OPENHPI_LOG_ON_SEV String Defines the lowest severity level that an event must have to be logged in the domain event log. The possible values (in order of decreasing severity) are: CRITICAL, MAJOR, MINOR, INFORMATIONAL, OK, DEBUG.

OPENHPI_ON_EP String Defines the entity path on which the application is running. This path is returned by the SaHpiResourceIdGet()function call.

OPENHPI_EVT_QUEUE_LIMIT Number Specifies the number of events that are allowed in the session event queue. Default is 10000. A zero value means no limit is enforced.

OPENHPI_DEL_SIZE_LIMIT Number Defines the maximum size of the domain event log. Default is 10000. A zero value means no limit is enforced.

OPENHPI_DEL_SAVE String Specifies whether the domain event log is stored on disk or not.

OPENHPI_DAT_SIZE_LIMIT Number Specifies the maximum size of the domain alarm table. A zero value means no limit is enforced.

OPENHPI_DAT_USER_LIMIT Number Specifies the maximum number of alarm entries of type user allowed in the domain alarm table. A zero value means no limit is enforced.

OPENHPI_DAT_SAVE String Specifies whether the Domain Alarm Table is stored on disk or not.

OPENHPI_PATH String Provides a colon-delimited list of the directories that contain OpenHPI plug-in libraries. The default value is hard coded at build time.

OPENHPI_VARPATH String Specifies the directory used for OpenHPI data storage and in which the domain event log, the domain alarm table and the UID (Unique IDs used for resources) mappings are saved. The default value is hard coded at build time.

Here is an example set of global configuration variable settings for the OpenHPI daemon: OPENHPI_LOG_ON_SEV = "DEBUG" OPENHPI_ON_EP = "{SYSTEM_CHASSIS, 1}" OPENHPI_EVT_QUEUE_LIMIT = 100 OPENHPI_DEL_SIZE_LIMIT = 1000 OPENHPI_DEL_SAVE = "NO" OPENHPI_DAT_SIZE_LIMIT = 0 OPENHPI_DAT_USER_LIMIT = 0 OPENHPI_DAT_SAVE = "NO" OPENHPI_PATH = "/lib:/usr/lib"


Release 2.10.1.0 20 January 23, 2008

OPENHPI_VARPATH = "/var/log" The configuration file for the OpenHPI daemon (typically, /etc/openhpi.conf) also includes configuration information for the Pigeon Point plug-in, or more precisely the “handler” for that plug-in. It includes definitions of variables that are specific to the plug-in, such as how the plug-in should communicate with the Shelf Manager (always via the LAN interface, in this case) and what IP address, port number and authentication mechanism to use. Definitions of the plug-in specific variables follow the same syntax as the global variables (described above). All plug-in specific variables are of type String.

Table 4 Plug-in Handler Configuration Variables PLUG-IN HANDLER

CONFIGURATION VARIABLE TYPE DESCRIPTION

entity_root String Specifies where in the entity hierarchy the entities discovered by this handler should be placed.

name String Defines the access method used by the plug-in to interact with the managed platform(s) and must have the value lan for use with AdvancedTCA shelves managed by the Pigeon Point Shelf Manager.

addr String Defines the destination RMCP IP address. Default is 192.168.0.2.

port String Indicates the destination RMCP port. Default is 623.

auth_type String Indicates the Authentication Type for the RMCP session. It can be none, md5 or straight.

auth_level String Specifies the Privilege Level for the RMCP session. It can be operator or admin.

username String Provides the username for the RMCP session. The default is openhpi. When an RMCP session with the Shelf Manager is opened with this default username, the Shelf Manager disables automatic activation and deactivation of FRUs, deferring to the OpenHPI subsystem for that function. When the session is terminated, automatic activation/deativation of FRUs is restored.

password String Provides the password for the RMCP session. Default is openhpi.

logflags String Specifies the logging mode. If it is set to the empty string (""), logging is turned off. If it is set to file, logging is output to the file defined by the logfile variable. If it is set to stdout or stderr, logging is output to standard output or


Release 2.10.1.0 21 January 23, 2008

PLUG-IN HANDLER CONFIGURATION VARIABLE

TYPE DESCRIPTION

standard error output respectively. If it is set to file stdout or file stderr, logging is output both to the file and to either standard output or standard error output.

logfile String Specifies the prefix of the .log file where OpenHPI daemon actions and error conditions are logged. The default value is openhpi.

logfile_max String Specifies the maximum size of the logfile, in kilobytes. If this size is reached, the overflowing log is renamed to <logfile>.bak and a new empty logfile is created.

NoAutoInsertExtract String If this variable is set to yes, automatic activation / deactivation of resources is disabled.

dropped_max String Specifies the number of dropped packets due to invalid sequence numbers that are allowed before an RMCP session is re-initialized.

UseCachedSdrs String If this variable is set to yes, the Pigeon Point plug-in tries to get SDRs from the internal Pigeon Point Shelf Manager SDR Repository cache rather than from the owning IPMC (which would typically occur over IPMB-0). See Appendix C: for more details. The default value is no,

Here is an example plug-in handler section (referenced as a “stanza” in the OpenHPI context) for the Pigeon Point plug-in within the OpenHPI configuration file: The plugin stanza tells OpenHPI that there is a plug-in file of the name libpigeonpoint in the LTDL_LIBRARY_PATH that it should load on startup. This path defaults to /usr/lib:/usr/local/lib. The handler stanza creates an instance of an OpenHPI plug-in. A handler stanza must include an entity_root definition to instruct OpenHPI where in the entity hierarchy the entities discovered by the handler should go. There may be several handler stanzas with the same name; each of them creates a separate instance of the named plug-in. plugin libpigeonpoint handler libpigeonpoint { entity_root = "{SYSTEM_CHASSIS, 1}" name = "lan" addr = "192.168.1.168" #default RMCP IP address port = "623" #default RMCP port auth_type = "md5"


Release 2.10.1.0 22 January 23, 2008

# auth.type can be "none", "md5" or "straight" auth_level = "admin" # privilege level can be "operator" or "admin" username = "openhpi" # default OpenHPI username password = "openhpi" # default OpenHPI password logflags = "file" # "" means logging off; also use "file stdout" logfile = "openhpi" # log files are openhpi.log and openhpi.bak logfile_max = "1024" # log file openhpi.log will be renamed to openhpi.bak NoAutoInsertExtract = "no" # disable automatic activation and deactivation of resources UseCachedSdrs = "no" # set it to "yes" to use Cached Device SDR repository } The environment variable VALIDRMCPADDR overrides any setting of the addr plug-in handler configuration variable in a Pigeon Point plug-in stanza. It is designed for using OpenHPI in the on-ShMM model. In this model, when the OpenHPI daemon starts up, the RMCP channel may be not configured yet by Shelf Manager. The start up scripts delay starting the OpenHPI daemon until the RMCP channel is up and properly configured and the environment variable VALIDRMCPADDR is set for the OpenHPI daemon. This scheme is supported only for the on-ShMM model and a single handler instance. The OpenHPI daemon can manage several HPI domains. In this case, the configuration file for the OpenHPI daemon must include a separate domain description stanza and a plug-in handler stanza for each one. Each domain is identified by a number called the “domain identifier”. The default domain has the identifier 0 and is always considered to be present, even it there is no stanza describing it. Definitions of the domain handler variables follow the same syntax as the global variables (described above). In the OpenHPI 2.8.1 release and subsequent releases, events are processed in domains that match the event entity path. This is done by associating an entity path pattern to a domain declaration and matching this pattern with the event entity path. All events are still processed in the default domain, regardless of entity path. The absence of a default domain description stanza can cause problems with auto insertion timeouts. To avoid such problems in the OpenHPI 2.10.0 release and in subsequent releases, the configuration file must contain a domain description stanza for the default domain. Table 5 Domain Handler Configuration Variables

DOMAIN HANDLER CONFIGURATION

VARIABLE

TYPE DESCRIPTION

entity_pattern String Specifies which entities belong to the current domain by defining the first part of the entity path for entities in this


Release 2.10.1.0 23 January 23, 2008

DOMAIN HANDLER CONFIGURATION

VARIABLE

TYPE DESCRIPTION

domain. Either this variable or the peer_of variable must be specified.

child_of String Provides the domain identifier of the parent domain. This variable is optional.

peer_of String Provides the domain identifier of a peer domain. Either this variable or the entity_pattern variable must be specified.

tag String Specifies the domain tag, which provides an alternate way to reference the domain. This variable is optional.

ai_timeout Integer Specifies the value of the auto insertion timeout period (in seconds). This is the time for which the HPI Auto Insertion Timer runs following a resource entering Insertion Pending state. By default, the auto insertion timeout is 0 seconds.

ai_readonly Integer If this variable is set to 1, the value of the auto insertion timeout can be changed by the HPI user. If this variable is set to 0, the HPI user cannot change the auto insertion timeout. The default value is 0.

An example of a three-domain configuration is provided below. There are two explicitly defined domains in addition to the implicitly defined default domain. The domains with identifiers 1 and 2 manage different shelves. Consistent with the minimum definition for this configuration, there are two handler stanzas for the same plug-in. handler libpigeonpoint { entity_root = "{SYSTEM_CHASSIS,1}" name = "lan" # RMCP addr = "192.168.1.199" # Host name or IP address port = "623" # RMCP port auth_type = "md5" # none, md2, md5 or straight auth_level = "admin" # operator or admin username = "openhpi" # default oHPI username password = "openhpi" # default oHPI password logflags = "file" # "" means logging off; also use "file stdout" logfile = "openhpi" # log file name prefix; ${logfile}.log logfile_max = "1024" # maximum log file size in kilobytes } handler libpigeonpoint { entity_root = "{SYSTEM_CHASSIS,2}" name = "lan" # RMCP addr = "192.168.1.149" # Host name or IP address port = "623" # RMCP port auth_type = "md5" # none, md2, md5 or straight auth_level = "admin" # operator or admin username = "openhpi" # default oHPI username password = "openhpi" # default oHPI password


Release 2.10.1.0 24 January 23, 2008

logflags = "file" # "" means logging off; also use "file stdout" logfile = "openhpi" # log file name prefix; ${logfile}.log logfile_max = "1024" # maximum log file size in kilobytes } domain 0 { entity_pattern = "*" tag = "PPS Domain" ai_timeout = 0 # Insert timeout in seconds ai_readonly = 0 # HPI user can modify insert timeout } domain 1 { # entity pattern is required if peer_of is not used. entity_pattern = "{SYSTEM_CHASSIS,1}*" tag = "shelf 1" # Optional child_of = 0 } domain 2 { # Required if peer_of is not used. entity_pattern = "{SYSTEM_CHASSIS,2}*" tag = "shelf 2" # Optional child_of = 0 }


Release 2.10.1.0 25 January 23, 2008

4 Startup and Initialization

4.1 Starting OpenHPI During normal use of OpenHPI, startup scripts invoke the daemon automatically. Typical users never need to invoke it manually as described here. Nevertheless, for the unusual circumstances in which manual invocation may be necessary, the details are described here. To start OpenHPI, use the following command line: openhpid –c <conf_file> [-v] [-p <port>] [-f <pidfile>] The following options are recognized: -c -v -p -f <pidfile> -s <seconds> -t <threads> -n A detailed description of these options is given below. -c <conf_file> This option sets the pathname of the configuration file. It is required unless the global configuration variable OPENHPI_CONF has been set to a valid configuration file name. -v This option causes the daemon to display verbose messages. -p <port> This option overrides the default listening port (4743) of the daemon. -f <pidfile> This option overrides the default name/location for the daemon PID file that contains the PID of the currently running OpenHPI daemon instance. The default is <OPENHPI_VARPATH>/openhpid.pid. -s <seconds> This option overrides the default socket read timeout of 30 minutes. -t <threads> This option sets the maximum number of connection threads. The default is unlimited. -n


Release 2.10.1.0 26 January 23, 2008

This option forces the code to run as a foreground process (not as a daemon). For example, to run OpenHPI and specifically designate the configuration file it should use, type the following: >./openhpid –c /etc/openhpi/openhpi.conf If you installed the RPMs or compiled OpenHPI from source code, the configuration file /etc/openhpi.conf is installed automatically. To configure a plug-in for usage by OpenHPI, you must add at least two stanzas (a plugin stanza and a handler stanza) to the /etc/openhpi.conf file.

4.2 Initializing OpenHPI When the OpenHPI daemon starts (on the active ShMM, on the backup ShMM or on some off–ShMM platform, in that model), it does the following:

• Establishes a domain controller, an event management service and an alarm management service.

• Initializes the domain event log and the domain alarm table.

• Initializes the Resource Presence Table (RPT).

• Populates the RPT with resources and their associated Resource Data Repositories

(RDRs). Resources are created for each slot in the configured shelf or shelves, as well as for all installed FRUs. RDR entries that are created include physical and logical sensors, controls, watchdogs and Inventory Data Records (IDR).

• Starts the event thread to dynamically listen for events from the Shelf Manager (only from

the active one), as well as from HPI client applications.

• Starts the session management service. The OpenHPI server is initialized and ready to accept session open requests from external applications.

• The HPI server can now accept session open requests from external HPI applications. The

HPI server communicates with the Shelf Manager to ensure on-going consistency regarding the state of managed shelves as represented at both the HPI server level and the Shelf Manager level.

4.3 Implications of Shelf Manager Redundancy For the on-ShMM configuration, the OpenHPI daemon on an active ShMM is called the active HPI daemon (server), and the OpenHPI daemon on a standby ShMM is called the standby HPI daemon (server). Only the active HPI server can be accessed by external applications. The standby OpenHPI daemon can be accessed only via hpi_shell, executing on the standby ShMM. After


Release 2.10.1.0 27 January 23, 2008

a switchover, the connections for external applications to the active HPI server are closed, and these applications can access the previously standby (newly active) HPI daemon, but must establish new connections to do so. For the off-ShMM configuration, a Shelf Manager switchover is transparent for the HPI server; connections to that server from external applications are not affected.


Release 2.10.1.0 28 January 23, 2008

5 Using the Command Shell You can interact with OpenHPI and thereby with the Pigeon Point Shelf Manager through the hpi_shell utility. hpi_shell is a command shell for OpenHPI. It allows an HPI user to execute HPI commands from the command line. These commands are translated into HPI API calls. hpi_shell executes the calls and displays the results. To start hpi_shell, type: >hpi_shell [-c <conf_file>][-e][-f <file>][-n <hostname>] The following options are recognized: -c <conf_file> -e -f <file> -n <hostname> A detailed description of these options is given below. -c <conf_file> This option sets the pathname of the configuration file. It is required unless the global configuration variable OPENHPI_CONF has been set to a valid configuration file name. -e This option causes hpi_shell to enable event displays in short form at startup. (See the description of the event command in section 5.12.) -f <file> This option causes hpi_shell to run in batch mode and execute commands from the specified file. -n <hostname> This option sets the network address of the HPI server. If this option is ommitted, hpi_shell tries to get the HPI server address from the OPENHPI_DAEMON_HOST environment variable. If the OPENHPI_DAEMON_HOST environment variable is not set, hpi_shell tries to connect to the address 127.0.0.1 After its invocation, if hpi_shell is not in batch mode, you can issue any hpi_shell command. Some commands produce a list of resources (basically, the Resource Presence Table or RPT) for the current domain. In such resource lists, in addition to the resource ID and name, hpi_shell list the capabilities for each resource in braces. The capabilities are listed sequentially in a short name form, with each capability separated from its predecessor by a vertical bar. Table 6 shows the short names for capabilities that a resource can have.


Release 2.10.1.0 29 January 23, 2008

Table 6 Resource Capabilities SHORT CAPABILITY NAME DESCRIPTION AG Indicates that the resource supports an aggregate resource status. An

aggregate resource status provides a session owner the capability to quickly derive information about the functional, thermal, and power state of the single or primary entity associated with that resource.

AN Indicates that there is an annunciator in the resource. CF Indicates that the resource supports parameter control. CNT Indicates that there is a control in resource. DIMI Inicates that there is a DIMI in the resource. DS Indicates that all sensors on the resource have the property that their

assertion and deassertion event enable flags are the same. That is, for all event states whose assertion triggers an event, it is guaranteed that the deassertion of that event will also trigger an event. Thus, an HPI user can track the state of sensors on the resource by monitoring events rather than polling for state changes.

ELOG Indicates that that resource has an event log. FRU Indicates that the resource is a field-replaceable unit; i.e., it is capable

of being removed and replaced in a live system. If HS capability is also set, the resource supports the full hot swap model. If HS is not present, the resource supports the simplified hot swap model.

FUMI Inicates that there is a FUMI in the resource. HS Indicates that the resource supports the full hot swap model. INV Indicates that the resource has an inventory data repository. PWR Indicates that the power state can be set for the resource. RDR Indicates that a Resource Data Record (RDR) repository is supplied by

the resource. Since the existence of an RDR is mandatory for all management instruments, this capability must be asserted if the resource contains any sensors, controls, watchdog timers, or inventory data repositories.

RES Indicates that the corresponding RPT entry is a resource. This capability is always present.

RST Indicates that the resource has a reset capability. S Indicates that there is a sensor in the resource. WTD Indicates that there is a watchdog timer in the resource. Here is an example of a resource listing, in this case from the lsres command, showing how hpi_shell lists the capabilities of each resource: OpenHPI> lsres (001):Shelf Resource:{S|RDR|INV|CNT|RES} (084):OEM Slot 1:{S|RDR|CNT|RES} (002):ATCA Board Slot 1:{S|RDR|CNT|RES} (003):ATCA Board Slot 2:{S|RDR|CNT|RES} (004):ATCA Board Slot 3:{S|RDR|CNT|RES}


Release 2.10.1.0 30 January 23, 2008

(005):ATCA Board Slot 4:{S|RDR|CNT|RES} (006):ATCA Board Slot 5:{S|RDR|CNT|RES} (007):ATCA Board Slot 6:{S|RDR|CNT|RES} (008):ATCA Board Slot 7:{S|RDR|CNT|RES} (009):ATCA Board Slot 8:{S|RDR|CNT|RES} (010):ATCA Board Slot 9:{S|RDR|CNT|RES} (011):ATCA Board Slot 10:{S|RDR|CNT|RES} (012):ATCA Board Slot 11:{S|RDR|CNT|RES} (013):ATCA Board Slot 12:{S|RDR|CNT|RES} (014):ATCA Board Slot 13:{S|RDR|CNT|RES} (015):ATCA Board Slot 14:{S|RDR|CNT|RES} (016):ATCA Board Slot 15:{S|RDR|CNT|RES} (017):ATCA Board Slot 16:{S|RDR|CNT|RES} (085):Power Entry Module Slot 1:{S|RDR|CNT|RES} (086):Power Entry Module Slot 2:{S|RDR|CNT|RES} (025):Shelf FRU Information Slot 1:{S|RDR|CNT|RES} (026):Shelf FRU Information Slot 2:{S|RDR|CNT|RES} (027):Dedicated ShMc Slot 1:{S|RDR|CNT|RES} (028):Dedicated ShMc Slot 2:{S|RDR|CNT|RES} (029):Fan Tray Slot 1:{S|RDR|CNT|RES} (087):Fan Tray Slot 2:{S|RDR|CNT|RES} (018):PPS BMC:{S|RDR|ELOG|INV|PWR|FRU|CNT|WTD|RES|DIMI} (030):Shelf EEPROM 1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (031):Shelf EEPROM 2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (088):ADPEM1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (089):ADPEM2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (090):Fan Tray 2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (033):ShMM-500:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI} (091):ATCA Demo Board:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI} (092)::{S|RDR|WTD|RES} (093)::{S|RDR|WTD|RES} Table 7 shows the hpi_shell commands and their parameters. Some commands open a command block in which their subcommands can be issued. Those subcommands are indented in the table; their parameters appear, as well. Any main command can also be issued in a command block. The quit command closes the current command block or (if issued at the main command level) closes the session and exits hpi_shell. For commands that have alternate command names, both are listed in the left column, separate by a vertical bar. Also, the first several letters can be used instead of the full command name if those letters identify the command unambiguously. For example: de can be used instead of debug, lsr can be used instead of lsres. But se is an invalid abbreviation because it is ambiguous: it could refer to either the setsever or sen commands. Several of the commands or subcommands in hpi_shell are not supported in the current Pigeon Point plug-in; notes in Table 7 identify them in the following categories:

1. The ann command and all its subcommands are not supported; the Pigeon Point plug-in does not create resources with an annunciator (AN) capability, which means that an annunciator command block cannot be entered with any resource.


Release 2.10.1.0 31 January 23, 2008

2. The inv|showinv subcommands that modify inventory data are not supported; inventory areas are always read-only in the current Pigeon Point plug-in.

3. The parmctrl command is not supported; the Pigeon Point plug-in does not create resources with the parameter control (CF) capability, which means that there are no resources to which this command can be applied.

4. FUMI support is in development. FUMI commands are implemented in hpi_shell, but the Pigeon Point plug-in does not yet support them.

Table 7 HPI Shell Commands and Descriptions

COMMAND PARAMETERS DESCRIPTION addcfg Path to configuration file Dynamically configures the OpenHPI daemon ann [1] Resource ID (optional)

Annunciator instrument number (optional)

Opens annunciator command block for the specified annunciator.

acknow [1] Entry ID or all Severity level

Sets acknowledged flag in the specified announcement(s) for the current annunciator.

add [1] Announcement (condition) parameters

Adds an entry to the current annunciator.

delete [1] Entry ID or any Severity level

Deletes the specified announcement(s) in the current annunciator.

list [1] Shows a list of the announcements (conditions) in the current annunciator.

mget [1] Shows the mode of the current annunciator. mset [1] Mode Sets mode of the current annunciator. show [1] Number Shows the specified announcement

(condition) in the current annunciator. clearevtlog Resource ID (optional) Clears the HPI event log of the specified

resource(s). ctrl Resource ID (optional)

Control instrument number (optional)

Shows information about the specified control(s) and opens control command block.

setstate Mode Control-specific parameter(s) (optional)

Changes the state of the current control.

show Shows a description of the current control. state Line number of text control

(optional) Shows the state of the current control.

dat Shows the domain alarm table of the current domain.

debug Debug mode (optional) Sets the OpenHPI debug mode on or off. If a


Release 2.10.1.0 32 January 23, 2008

COMMAND PARAMETERS DESCRIPTION parameter is omitted, the current debug mode is reported.

dimi Resource ID (optional) DIMI instrument number (optional)

Opens DIMI command block for the specified DIMI.

cancel DIMI test number(optional) Cancels execution of the specified DIMI test in the current DIMI.

info Shows information about the current DIMI. ready DIMI test number(optional) Shows information about the readiness to run

specified DIMI test in the current DIMI. results DIMI test number(optional) Shows the results from the last run of the

specified DIMI test in the current DIMI. start DIMI test number(optional) Starts execution of the specified DIMI test in

the current DIMI. status DIMI test number(optional) Shows the status of the specified DIMI test in

the current DIMI. testinfo DIMI test number(optional) Shows information about the specified DIMI

test in the current DIMI. domain Domain ID (optional) Designates the current domain. domaininfo Shows domain info for the current domain. dscv Performs discovery of the current domain’s

resources. echo String Passes a string to standard output. event Control parameter (optional) Controls how events are displayed. evtlogreset Resource ID (optional) Resets the overflow flag in the specified

event log. evtlogstate Resource ID (optional)

Control parameter (optional) Shows and optionally enables or disables the event logging state of the specified resource.

evtlogtime Resource ID (optional) Shows current event log time for the specified resource.

exec Filename Parameter1 (optional) … ParameterN (optional)

Executes an external command as a separate process.

fumi [4] Resource ID (optional) FUMI instrument number (optional)

Opens FUMI command block for the specified FUMI.

activate [4] Starts execution of the active image on the specified FUMI.

backup [4] Initiates a backup of currently active FUMI bank.

bankcopy [4] Source bank number (optional)

Initiates a copy of the source contents of one bank to another bank on the current FUMI.


Release 2.10.1.0 33 January 23, 2008

COMMAND PARAMETERS DESCRIPTION Target bank number (optional)

cancel [4] Bank number (optional) Cancels any asynchronous upgrade operation that is in progress on the specified bank of the current FUMI.

getsource [4] Bank number (optional) Shows information about the source image assigned to the specified bank of the current FUMI.

install [4] Bank number (optional) Starts an installation process to load firmware to the specified bank of the current FUMI.

rollback [4] Initiates a rollback operation to restore the active bank of the current FUMI with a backup version.

setbootorder [4] Bank number (optional) Boot order (optional)

Sets the position of the specified FUMI bank in the boot order.

setsource [4] Bank number (optional) Source URI (optional)

Sets new source information for the specified bank of the current FUMI.

status [4] Bank number (optional) Shows the upgrade status on the specified bank of the current FUMI.

targetinfo [4] Bank number (optional) Shows information about the specified bank of the current FUMI.

validatesource [4] Bank number (optional) Initiates the validation of the integrity of the source image associated with the specified bank of the current FUMI.

verifytarget [4] Bank number (optional) Starts the verification process of the upgraded image on specified bank of the current FUMI.

help Shows help information for the specified hpi_shell commands.

history Shows history of command inputs. hs Resource ID Enters a hot swap command block for the

specified resource. action Action identifier Invokes an insert or extract action on the

current resource. active Sets the current resource to the active state. gettimeout Timeout identifier Shows the current auto insert or auto extract

timeout. inactive Sets the current resource to the inactive

state. ind Action identifier Shows or sets the hot swap indicator state for

the current resource. policycancel Cancels automatic resource activation or

deactivation. settimeout Timeout identifier

Timeout duration (in sec)Sets the auto insert or auto extract timeout.


Release 2.10.1.0 34 January 23, 2008

COMMAND PARAMETERS DESCRIPTION state Shows the hot swap state of the current

resource. inv|showinv Resource ID (optional)

Inventory instrument number(optional)

Enters inventory data command block for the specified resource.

addarea [2] Adds inventory area for the current resource. addfield [2] Adds inventory field for the current resource. delarea [2] Removes inventory area for the current

resource. delfield [2] Removes inventory field for the current

resource. setfield [2] Sets inventory field for the current resource. show Shows the inventory data for the current

resource lsensor Lists all sensors in current domain. lsres Lists all resources in current domain. more Action identifier (optional) Determines whether console output from a

single command is presented in groups of lines, one group at a time.

parmctrl [3] Resource ID (optional) Action identifier (optional)

Saves or restores parameters for a specified resource.

power Resource ID Action identifier (optional)

Sets the power state of the specified resource.

quit Closes session and exits hpi_shell, or in a command block, closes the command block.

rdr|showrdr Resource ID Type of RDR (optional) RDR instrument number (optional)

Shows information in the specified types of RDR repositories for the specified resource.

reset Resource ID Action identifier (optional)

Shows the current reset state or initiates a reset action for the specified resource.

reopen Flag (optional) Reopens the current session to the HPI server.

rpt|showrpt Resource ID Shows the Resource Presence Table (RPT) or information about a specified resource in the RPT.

run Filename Reads and executes hpi_shell commands from the specified file.

sen Resource ID (optional) Sensor instrument number (optional)

Displays information about the specified sensor and enters a sensor command block.

disable Disables sensor polling for the current sensor.


Release 2.10.1.0 35 January 23, 2008

COMMAND PARAMETERS DESCRIPTION enable Enables sensor polling for the current sensor. evtdis Disables sensor events for the current

sensor. evtenb Enables sensor events for the current sensor. maskadd Adds assertion or deassertion masks for the

current sensor. maskrm Removes assertion or deassertion masks for

the current sensor. setthres Changes thresholds for the current sensor. show Shows the state of the current sensor. setsever Resource ID

Severity type Sets minimum severity of events for the specified resource that are placed in its event log.

settag Resource ID Tag string

Sets the tag for the specified resource.

settimeevtlog Resource ID (optional) Date/Time string (optional)

Sets date and time for the current domain or for the specified resource.

showevtlog Resource ID (optional) Shows event log for the domain or the specified resource.

ver Show the HPI specification version and OpenHPI version that is supported by the current HPI service.

wtdget Resource ID Watchdog instrument number

Shows the state of the specified watchdog timer.

wtdreset Resource ID Watchdog instrument number

Starts or restarts the specified watchdog timer at the initial countdown level.

wtdset Resource ID Watchdog instrument number

Initializes and configures the specified watchdog timer; can also stop the timer.


Release 2.10.1.0 36 January 23, 2008

5.1 addcfg

5.1.1 Syntax addcfg <conf file>

5.1.2 Purpose This command dynamically configures the OpenHPI daemon. The <conf file> parameter is the name of the configuration file for the OpenHPI daemon. Note: This command can be used only in hpi_shell as compiled in daemon mode. The hpi_shell utility described in this document is compiled in the client mode.

5.1.3 Example OpenHPI> addcfg /etc/openhpi.conf OpenHPI>


Release 2.10.1.0 37 January 23, 2008

5.2 ann

5.2.1 Syntax ann [<resource id> [<annunciator instrument num>]]

5.2.2 Purpose This enters an annunciator command block. <annunciator instrument num> designates an annunciator RDR of the resource specified by <resource id>. If this parameter is omitted, the command shows all the annunciators of the specified resource. If no parameters are supplied, hpi_shell lists all the resources in the current domain and waits for the user to enter a <resource id>. Then, hpi_shell lists all the annunciator RDRs for that resource and waits for the user to enter an <annunciator instrument num>. Annunciator command blocks support the subcommands: acknow, add, delete, list, mget, mset and show; these subcommands are described in subsections below. Note: The Pigeon Point plug-in does not currently support annunciator functionality.

5.2.3 acknow

5.2.3.1 Syntax acknow <entry id> | [ all <severity>]

5.2.3.2 Purpose This subcommand sets the acknowledged flag in the announcement specified by the <entry id> parameter within the current annunciator. If the all parameter value is used, the acknowledged flag is set in all the entries with the <severity> severity level. The <severity> parameter value is one of the following (listed in order of decreasing severity): crit, maj, min, inf, ok.

5.2.4 add

5.2.4.1 Syntax add


Release 2.10.1.0 38 January 23, 2008

5.2.4.2 Purpose This subcommand adds an announcement in the current annunciator. The subcommand prompts the user for the announcement parameters: severity, condition type, domain ID, resource ID, and sensor number.

5.2.5 delete

5.2.5.1 Syntax delete <entry id> | [any <severity>]

5.2.5.2 Purpose This subcommand deletes the announcement specified by the <entry id> parameter. The any <severity> parameter causes the subcommand to delete all the entries with the indicated <severity>. The <severity> parameter value is one of the following (listed in order of decreasing severity): crit, maj, min, inf, ok, all.

5.2.6 list

5.2.6.1 Syntax list

5.2.6.2 Purpose This subcommand shows a list of the announcements in the current annunciator.

5.2.7 mget

5.2.7.1 Syntax mget

5.2.7.2 Purpose This subcommand shows the current mode of the current annunciator.

5.2.8 mset

5.2.8.1 Syntax mset auto|user|shared

5.2.8.2 Purpose This subcommand sets the mode the current annunciator.


Release 2.10.1.0 39 January 23, 2008

5.2.9 show

5.2.9.1 Syntax show <num>

5.2.9.2 Purpose This subcommand shows the announcement (condition) specified by the <num> within the current annunciator. It displays that announcement’s entry ID, acknowledged flag, severity, condition type, and other fields.


Release 2.10.1.0 40 January 23, 2008

5.3 clearevtlog

5.3.1 Syntax clearevtlog [<resource id>]

5.3.2 Purpose This command clears the HPI event log of the specified resource. <resource id> identifies a resource in the RPT. If this parameter is omitted, the command clears all HPI event logs in the current domain.

5.3.3 Example OpenHPI> clearevtlog 29 EventLog successfully cleared


Release 2.10.1.0 41 January 23, 2008

5.4 ctrl

5.4.1 Syntax ctrl [<resource id> [<control instrument num>]]

5.4.2 Purpose This command shows information about the specified control of the specified resource and enters a control command block. <control instrument num> designates a control RDR of the resource specified by <resource id>. If this parameter is omitted, the command shows all the controls of the specified resource. If no parameters are supplied, hpi_shell lists all the resources in the current domain and waits for the user to enter a <resource id>. Then, hpi_shell lists all the control RDRs for that resource and waits for the user to enter a <control instrument num>. Control command blocks support the subcommands: state, setstate, and show; these subcommands are described in subsections below.

5.4.3 Example OpenHPI> ctrl (001):Shelf Resource:{S|RDR|INV|CNT|RES} (084):OEM Slot 1:{S|RDR|CNT|RES} (002):ATCA Board Slot 1:{S|RDR|CNT|RES} (003):ATCA Board Slot 2:{S|RDR|CNT|RES} (004):ATCA Board Slot 3:{S|RDR|CNT|RES} (005):ATCA Board Slot 4:{S|RDR|CNT|RES} (006):ATCA Board Slot 5:{S|RDR|CNT|RES} (007):ATCA Board Slot 6:{S|RDR|CNT|RES} (008):ATCA Board Slot 7:{S|RDR|CNT|RES} (009):ATCA Board Slot 8:{S|RDR|CNT|RES} (010):ATCA Board Slot 9:{S|RDR|CNT|RES} (011):ATCA Board Slot 10:{S|RDR|CNT|RES} (012):ATCA Board Slot 11:{S|RDR|CNT|RES} (013):ATCA Board Slot 12:{S|RDR|CNT|RES} (014):ATCA Board Slot 13:{S|RDR|CNT|RES} (015):ATCA Board Slot 14:{S|RDR|CNT|RES} (016):ATCA Board Slot 15:{S|RDR|CNT|RES} (017):ATCA Board Slot 16:{S|RDR|CNT|RES} (085):Power Entry Module Slot 1:{S|RDR|CNT|RES} (086):Power Entry Module Slot 2:{S|RDR|CNT|RES} (025):Shelf FRU Information Slot 1:{S|RDR|CNT|RES} (026):Shelf FRU Information Slot 2:{S|RDR|CNT|RES} (027):Dedicated ShMc Slot 1:{S|RDR|CNT|RES} (028):Dedicated ShMc Slot 2:{S|RDR|CNT|RES} (029):Fan Tray Slot 1:{S|RDR|CNT|RES} (087):Fan Tray Slot 2:{S|RDR|CNT|RES} (018):PPS BMC:{S|RDR|ELOG|INV|PWR|FRU|CNT|WTD|RES|DIMI}


Release 2.10.1.0 42 January 23, 2008

(030):Shelf EEPROM 1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (031):Shelf EEPROM 2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (088):ADPEM1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (089):ADPEM2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (090):Fan Tray 2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (033):ShMM-500:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI} (091):ATCA Demo Board:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI} (092)::{S|RDR|WTD|RES} (093)::{S|RDR|WTD|RES} (094):Load Board:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} RPT ID ==> 1 (69632):CTRL_RDR INSTRUMENT NUM=4096 Tag=Shelf Address (69633):CTRL_RDR INSTRUMENT NUM=4097 Tag=Shelf Manager IP Address (69634):CTRL_RDR INSTRUMENT NUM=4098 Tag=Chassis Status (70400):CTRL_RDR INSTRUMENT NUM=4864 Tag=FRU Power On Sequence Commit (98304):CTRL_RDR INSTRUMENT NUM=32768 Tag=OpenHPI version (70401):CTRL_RDR INSTRUMENT NUM=4865 Tag=FRU Power On Sequence #0 (70402):CTRL_RDR INSTRUMENT NUM=4866 Tag=FRU Power On Sequence #1 (70403):CTRL_RDR INSTRUMENT NUM=4867 Tag=FRU Power On Sequence #2 (70404):CTRL_RDR INSTRUMENT NUM=4868 Tag=FRU Power On Sequence #3 (70405):CTRL_RDR INSTRUMENT NUM=4869 Tag=FRU Power On Sequence #4 (70406):CTRL_RDR INSTRUMENT NUM=4870 Tag=FRU Power On Sequence #5 (70407):CTRL_RDR INSTRUMENT NUM=4871 Tag=FRU Power On Sequence #6 (70408):CTRL_RDR INSTRUMENT NUM=4872 Tag=FRU Power On Sequence #7 (70409):CTRL_RDR INSTRUMENT NUM=4873 Tag=FRU Power On Sequence #8 (70410):CTRL_RDR INSTRUMENT NUM=4874 Tag=FRU Power On Sequence #9 (70411):CTRL_RDR INSTRUMENT NUM=4875 Tag=FRU Power On Sequence #10 (70412):CTRL_RDR INSTRUMENT NUM=4876 Tag=FRU Power On Sequence #11 (70413):CTRL_RDR INSTRUMENT NUM=4877 Tag=FRU Power On Sequence #12 (70414):CTRL_RDR INSTRUMENT NUM=4878 Tag=FRU Power On Sequence #13 (70415):CTRL_RDR INSTRUMENT NUM=4879 Tag=FRU Power On Sequence #14 (70416):CTRL_RDR INSTRUMENT NUM=4880 Tag=FRU Power On Sequence #15 (70417):CTRL_RDR INSTRUMENT NUM=4881 Tag=FRU Power On Sequence #16 (70418):CTRL_RDR INSTRUMENT NUM=4882 Tag=FRU Power On Sequence #17 (70419):CTRL_RDR INSTRUMENT NUM=4883 Tag=FRU Power On Sequence #18 RDR INSTRUMENT NUM ==> 32768 Control(1/32768) Type: TEXT Output: GENERIC Mode: AUTO (Read Only) Data: MaxChars = 50 MaxLines = 3 Language = ENGLISH DataType = TEXT Default: Line # = 1 Text = HPI spec version: B.01.01 control block ==>

5.4.4 setstate

5.4.4.1 Syntax setstate

5.4.4.2 Purpose This subcommand sets the state of the current control by prompting the user for values of the control data items.


Release 2.10.1.0 43 January 23, 2008

5.4.4.3 Example OpenHPI> ctrl 1 4096 Control(1/4096) Type: TEXT Output: GENERIC Mode: MANUAL (Read Only) Data: MaxChars = 25 MaxLines = 1 Language = ENGLISH DataType = TEXT Default: Line # = 1 Text = 12345678901234567890 control block ==> setstate Mode(auto|manual): manual Line #: 0 Text: DataType(text|bcd|ascii6|bin|unicode): text Text: TEST

5.4.5 show

5.4.5.1 Syntax show

5.4.5.2 Purpose This subcommand shows the following information for the current control:

• Resource number • Control number • Control type • Control mode • Control state (which depends on control type)

For text controls, Line 1 content is displayed as a part of the control state. Other text lines are not displayed.

5.4.5.3 Example control block ==> show Control(30/4144) Type: ANALOG Output: GENERIC Mode: AUTO (Read Only) Data: Default: 0 (min = 0 max = 400) control block ==> control block ==> show Control(1/32768) Type: TEXT Output: GENERIC Mode: AUTO (Read Only) Data: MaxChars = 50 MaxLines = 3 Language = ENGLISH DataType = TEXT Default: Line # = 1 Text = HPI spec version: B.01.01 control block ==>


Release 2.10.1.0 44 January 23, 2008

5.4.6 state

5.4.6.1 Syntax state [<line number>]

5.4.6.2 Purpose This subcommand shows the state of the current control. The output depends on the control type. For text controls, the content of Line <line number> is displayed. If the <line number> parameter is omitted, the command waits for the user to enter a <line number>. Given a <line number> of 0, the command displays the content of all lines. For non-text controls, the <line number> parameter is ignored.

5.4.6.3 Example control block ==> state 2 Control(1/32768) AUTO State: Line # = 2 Text = OpenHPI base version: 2.8.1 control block ==> state Line #(0 == all): 3 Control(1/32768) AUTO State: Line # = 3 Text = Pigeon Point enhancements version: 2.10.1.0 control block ==>


Release 2.10.1.0 45 January 23, 2008

5.5 dat

5.5.1 Syntax dat

5.5.2 Purpose This command shows the domain alarm table for the current domain.

5.5.3 Example OpenHPI> dat (1) 2007-03-12 17:29:22 MAJOR - SENSOR 42/5 0x2 (2) 2007-03-12 17:29:22 MAJOR - SENSOR 41/5 0x2 (3) 2007-03-12 17:30:27 MAJOR - SENSOR 41/5 0x2 (4) 2007-03-12 17:30:27 MAJOR - SENSOR 42/5 0x2


Release 2.10.1.0 46 January 23, 2008

5.6 debug

5.6.1 Syntax debug [ on | off ]

5.6.2 Purpose This command turns OpenHPI debug mode on or off, which is equivalent to setting the OPENHPI_DEBUG environment variable to YES or NO, respectively. If no parameter is supplied, this command shows the current debug mode.

5.6.3 Example To see the value of the OPENHPI_DEBUG environment variable, type debug. OpenHPI> debug on OpenHPI> de OPENHPI_DEBUG=YES OpenHPI> debug off OpenHPI> de OPENHPI_DEBUG=NO


Release 2.10.1.0 47 January 23, 2008

5.7 dimi

5.7.1 Syntax dimi [<resource id> [<dimi instrument num>]]

5.7.2 Purpose This command enters a DIMI command block for the specified DIMI. <dimi instrument num> designates a DIMI RDR of the resource specified by <resource id>. If this parameter is omitted, the command shows all DIMIs of the specified resource. If no parameters are supplied, hpi_shell lists all the resources in the current domain and waits for the user to enter a <resource id>. Then, hpi_shell lists all the DIMI RDRs for that resource and waits for the user to enter a <dimi instrument num>. DIMI command block supports the subcommands: cancel, info, ready, results, start, status and testinfo; these subcommands are described in subsections below.

5.7.3 Example OpenHPI> dimi (001):Shelf Resource:{S|RDR|INV|CNT|RES} (002):ATCA Board Slot 1:{S|RDR|CNT|RES} (003):ATCA Board Slot 2:{S|RDR|CNT|RES} (004):ATCA Board Slot 3:{S|RDR|CNT|RES} (005):ATCA Board Slot 4:{S|RDR|CNT|RES} (006):ATCA Board Slot 5:{S|RDR|CNT|RES} (007):ATCA Board Slot 6:{S|RDR|CNT|RES} (008):ATCA Board Slot 7:{S|RDR|CNT|RES} (009):ATCA Board Slot 8:{S|RDR|CNT|RES} (010):ATCA Board Slot 9:{S|RDR|CNT|RES} (011):ATCA Board Slot 10:{S|RDR|CNT|RES} (012):ATCA Board Slot 11:{S|RDR|CNT|RES} (013):ATCA Board Slot 12:{S|RDR|CNT|RES} (014):ATCA Board Slot 13:{S|RDR|CNT|RES} (015):ATCA Board Slot 14:{S|RDR|CNT|RES} (016):ATCA Board Slot 15:{S|RDR|CNT|RES} (017):ATCA Board Slot 16:{S|RDR|CNT|RES} (018):Dedicated ShMc Slot 1:{S|RDR|CNT|RES} (019):PPS BMC:{S|RDR|ELOG|INV|PWR|FRU|CNT|WTD|RES|DIMI} (020):Shelf EEPROM 1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (021):Fan Tray:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (022):ShMM-500:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES|DIMI} (023):BMR-H8S BTP:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI|FUMI} (024)::{S|RDR|FRU|RES} (025)::{S|RDR|FRU|RES} (026)::{S|RDR|FRU|HS|RES} (027):BMR-H8S Shelf FR:{S|RDR|INV|RST|PWR|FRU|CNT|RES} RPT ID ==> 23


Release 2.10.1.0 48 January 23, 2008

(393216):DIMI_RDR INSTRUMENT NUM=000 Tag=DIMI(IPMI Self Test) DIMI_RDR INSTRUMENT NUM ==> 0 DIMI block ==>

5.7.4 cancel

5.7.4.1 Syntax cancel [<test num>]

5.7.4.2 Purpose This subcommand cancels specified execution of the specified DIMI test. If the <test num> parameter is omitted, the command waits for the user to enter a <test num>.

5.7.4.3 Example DIMI block ==> cancel 0

5.7.5 info

5.7.5.1 Syntax info

5.7.5.2 Purpose This subcommand shows information about the current DIMI.

5.7.5.3 Example DIMI block ==> info DIMI number: 0 Number of tests: 2 Test number update counter: 0

5.7.6 ready

5.7.6.1 Syntax ready [<test num>]

5.7.6.2 Purpose This subcommand shows information about the readiness to run the specified DIMI test. If the <test num> parameter is omitted, the command waits for the user to enter a <test num>.

5.7.6.3 Example DIMI block ==> ready 0 DIMI is ready to run test 0


Release 2.10.1.0 49 January 23, 2008

5.7.7 results

5.7.7.1 Syntax results [<test num>]

5.7.7.2 Purpose This subcommand shows results from the last run of the specified DIMI test. If the <test num> parameter is omitted, the command waits for the user to enter a <test num>.

5.7.7.3 Example DIMI block ==> results 1 Test number: 1 Result timestamp: 2008-01-15 17:11:15 Run duration: 3012675000 nsec Last run status: FINISHED_NO_ERRORS Test error code: no Error was generated Test result string: "All Self Tests Passed"

5.7.8 start

5.7.8.1 Syntax start [<test num>]

5.7.8.2 Purpose This subcommand starts execution of the specified DIMI test. If the <test num> parameter is omitted, the command waits for the user to enter a <test num>.

5.7.8.3 Example DIMI block ==> start 0

5.7.9 status

5.7.9.1 Syntax status [<test num>]

5.7.9.2 Purpose This subcommand shows the status of the specified DIMI test. If the <test num> parameter is omitted, the command waits for the user to enter a <test num>.


Release 2.10.1.0 50 January 23, 2008

5.7.9.3 Example DIMI block ==> status 1 Test number: 1 Status: RUNNING

5.7.10 testinfo

5.7.10.1 Syntax testinfo [<test num>]

5.7.10.2 Purpose This subcommand shows information about the specified DIMI test. If the <test num> parameter is omitted, the command waits for the user to enter a <test num>.

5.7.10.3 Example DIMI block ==> testinfo 1 Test number: 1 Name: "IPMI Self Test" Service Impact: DEGRADING Affected Entities: Expected Run Duration: 10000000000 nsec Test capabilities: TEST_CANCEL Test parameters:


Release 2.10.1.0 51 January 23, 2008

5.8 domain

5.8.1 Syntax domain [<domain id>]

5.8.2 Purpose This command sets the current domain, based on the <domain id> parameter. If this parameter is omitted, the command shows a list of the current domains.

5.8.3 Example OpenHPI> domain Domain list: ID: 1 SessionId: 4 Tag: First Domain OpenHPI> domain 1 OpenHPI>


Release 2.10.1.0 52 January 23, 2008

5.9 domaininfo

5.9.1 Syntax domaininfo

5.9.2 Purpose This command displays information about the current domain.

5.9.3 Example OpenHPI> domaininfo Domain: 1 Capabil: 0x0 IsPeer: 0 Guid: Tag: First Domain DRT update count: 0 DRT Timestamp : SAHPI_TIME_UNSPECIFIED RPT update count: 147 RPT Timestamp : 2007-03-12 17:29:19 DAT update count: 155 DAT Timestamp : 2007-03-12 17:59:45 ActiveAlarms: 4 CriticalAlarms: 0 Major: 6 Minor: 0 Limit: 0 DatOverflow : 0


Release 2.10.1.0 53 January 23, 2008

5.10 dscv

5.10.1 Syntax dscv

5.10.2 Purpose This command performs a discovery of the resources in the current domain(s). The dscv command is issued automatically at hpi_shell startup. It can be issued by user at any time as well.

5.10.3 Example OpenHPI> dscv


Release 2.10.1.0 54 January 23, 2008

5.11 echo

5.11.1 Syntax echo <string>

5.11.2 Purpose This command passes the string parameter to standard output.

5.11.3 Example OpenHPI> echo hpi_shell hpi_shell


Release 2.10.1.0 55 January 23, 2008

5.12 event

5.12.1 Syntax event [enable|disable|short|full]

5.12.2 Purpose This command, with the enable or disable options, enables or disables, respectively, event displays. With the short option, event displays include only the type of event, the event timestamp and the event resource identifier. With the full and enable options, event displays include additional details. An invocation of this command without any parameters shows the current mode for event display.

5.12.3 Example OpenHPI> event Event display: Disable OpenHPI> hs 038 Hot swap block ==> event short Event short display enable successfully Hot swap block ==> action insert 2007-03-12 19:01:58 OEM 38 2007-03-12 19:01:58 HOTSWAP 38 INFORMATIONAL INACTIVE -> INSERTION_PENDING 2007-03-12 19:02:03 OEM 38 2007-03-12 19:02:03 HOTSWAP 38 INFORMATIONAL INSERTION_PENDING -> ACTIVE Hot swap block ==> event enable Event display enable successfully Hot swap block ==> action extract Hot swap block ==> Event Type: OEM Event Resource ID: 38 Event Timestamp: 2007-03-12 19:03:45 Event Severity: INFORMATIONAL OemEvent: ManufacturerId: Unknown Manufacturer OemEventData: Data Type: TEXT Language: ENGLISH Data Length: 3 Data: Data(Bin): 3 2 0 .. Event Type: HOTSWAP Event Resource ID: 38 Event Timestamp: 2007-03-12 19:03:45 Event Severity: INFORMATIONAL HotswapEvent: HotSwapState: EXTRACTION_PENDING PreviousHotSwapState: ACTIVE


Release 2.10.1.0 56 January 23, 2008

.. Event Type: OEM Event Resource ID: 38 Event Timestamp: 2007-03-12 19:04:00 Event Severity: INFORMATIONAL OemEvent: ManufacturerId: Unknown Manufacturer OemEventData: Data Type: TEXT Language: ENGLISH Data Length: 3 Data: Data(Bin): 0 3 0 .. Event Type: HOTSWAP Event Resource ID: 38 Event Timestamp: 2007-03-12 19:04:00 Event Severity: INFORMATIONAL HotswapEvent: HotSwapState: INACTIVE PreviousHotSwapState: EXTRACTION_PENDING Hot swap block ==> event full Event full display enable successfully Hot swap block ==> action extract Hot swap block ==> Event Type: OEM Event Resource ID: 38 Event Timestamp: 2007-03-22 17:34:05 Event Severity: INFORMATIONAL OemEvent: ManufacturerId: Unknown Manufacturer OemEventData: Data Type: TEXT Language: ENGLISH Data Length: 3 Data: Data(Bin): 3 2 0 .. Event Type: HOTSWAP Event Resource ID: 38 Event Timestamp: 2007-03-22 17:34:05 Event Severity: INFORMATIONAL HotswapEvent: HotSwapState: EXTRACTION_PENDING PreviousHotSwapState: ACTIVE .. Event Type: OEM Event Resource ID: 38 Event Timestamp: 2007-03-22 17:34:10 Event Severity: INFORMATIONAL OemEvent: ManufacturerId: Unknown Manufacturer OemEventData: Data Type: TEXT Language: ENGLISH Data Length: 3


Release 2.10.1.0 57 January 23, 2008

Data: Data(Bin): 0 3 0 .. Event Type: HOTSWAP Event Resource ID: 38 Event Timestamp: 2007-03-22 17:34:10 Event Severity: INFORMATIONAL HotswapEvent: HotSwapState: INACTIVE PreviousHotSwapState: EXTRACTION_PENDING .. OpenHPI> event disable Event display disable successfully


Release 2.10.1.0 58 January 23, 2008

5.13 evtlogreset

5.13.1 Syntax evtlogreset [<resource id>]

5.13.2 Purpose This command resets the overflow flag in the event log for the specified resource. If no <resource id> parameter is specified, the overflow flag parameter in the event log for the current resource is reset.

5.13.3 Example OpenHPI> evtlogreset


Release 2.10.1.0 59 January 23, 2008

5.14 evtlogstate

5.14.1 Syntax evtlogstate [<resource id> [enable|disable]]

5.14.2 Purpose This command shows the event logging state for the specified resource. If the option enable or disable is specified, this command sets the event logging state of the specified resource accordingly. If no parameters are provided, this command shows the current state of event logging for the current resource.

5.14.3 Example OpenHPI> evtlogstate Event Log State: Enable OpenHPI> evtlogstate 29 disable OpenHPI> evtlogstate 29 Event Log State: Disable OpenHPI> evtlogstate 29 enable Event Log State: Enable


Release 2.10.1.0 60 January 23, 2008

5.15 evtlogtime

5.15.1 Syntax evtlogtime [<resource id>]

5.15.2 Purpose This command shows the current event log date and time for the specified resource. If the <resource id> parameter is omitted, this command shows the current event log date and time for the domain event log.

5.15.3 Example OpenHPI> evtlogtime Current event log time: 2007-03-12 19:06:35


Release 2.10.1.0 61 January 23, 2008

5.16 exec

5.16.1 Syntax exec <filename> [<parameter1> … <parameterN>]

5.16.2 Purpose This command launches <filename> as a separate process. The <filename> option specifies an executable file. This file may be a binary file, a batch file, a shell command or even a separate invocation of hpi_shell, possibly with a command. <parameter>,…, <parameterN> are optional parameters that are needed for the execution of the file specified by the <filename> option in the command line.

5.16.3 Example The following exec command shows the contents of the file /tmp/x by invoking the Linux cat command as a separate process. Next, an additional exec command runs another instance of hpi_shell. OpenHPI> exec cat /tmp/x more OpenHPI> exec hpi_shell Discovery done Enter a command or "help" for list of commands Available commands are: addcfg ann clearevtlog ctrl dat debug domain domaininfo dscv echo event evtlogtime evtlogreset evtlogstate exec help history hs inv lsres lsensor more parmctrl power quit rdr reset rpt run sen settag setsever settimeevtlog showevtlog showinv showrdr showrpt wtdget wtdreset wtdset ? Domain list: ID: 0 SessionId: 7 Tag: DEFAULT OpenHPI> quit quit OpenHPI>


Release 2.10.1.0 62 January 23, 2008

5.17 fumi

5.17.1 Syntax fumi [<resource id> [<fumi instrument num>]]

5.17.2 Purpose This command enters a FUMI command block. <fumi instrument num> designates a FUMI RDR of the resource specified by <resource id>. If this parameter is omitted, the command shows all FUMIs of the specified resource. If no parameters are supplied, hpi_shell lists all the resources in the current domain and waits for the user to enter a <resource id>. Then, hpi_shell lists all the FUMI RDRs for that resource and waits for the user to enter an <fumi instrument num>. A FUMI command block supports the subcommands: activate, backup, bankcopy, cancel, getsource, install, rollback, setbootorder, setsource, status, targetinfo, validatesource and verifytarget; these subcommands are described in subsections below Note: The Pigeon Point plug-in does not currently support FUMI functionality.

5.17.3 Example OpenHPI> fumi (001):Shelf Resource:{S|RDR|INV|CNT|RES} (002):ATCA Board Slot 1:{S|RDR|CNT|RES} (003):ATCA Board Slot 2:{S|RDR|CNT|RES} (004):ATCA Board Slot 3:{S|RDR|CNT|RES} (005):ATCA Board Slot 4:{S|RDR|CNT|RES} (006):ATCA Board Slot 5:{S|RDR|CNT|RES} (007):ATCA Board Slot 6:{S|RDR|CNT|RES} (008):ATCA Board Slot 7:{S|RDR|CNT|RES} (009):ATCA Board Slot 8:{S|RDR|CNT|RES} (010):ATCA Board Slot 9:{S|RDR|CNT|RES} (011):ATCA Board Slot 10:{S|RDR|CNT|RES} (012):ATCA Board Slot 11:{S|RDR|CNT|RES} (013):ATCA Board Slot 12:{S|RDR|CNT|RES} (014):ATCA Board Slot 13:{S|RDR|CNT|RES} (015):ATCA Board Slot 14:{S|RDR|CNT|RES} (016):ATCA Board Slot 15:{S|RDR|CNT|RES} (017):ATCA Board Slot 16:{S|RDR|CNT|RES} (018):Dedicated ShMc Slot 1:{S|RDR|CNT|RES} (019):PPS BMC:{S|RDR|ELOG|INV|PWR|FRU|CNT|WTD|RES|DIMI} (020):Shelf EEPROM 1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (021):Fan Tray:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (022):ShMM-500:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES|DIMI} (023):BMR-H8S BTP:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI|FUMI}


Release 2.10.1.0 63 January 23, 2008

(024)::{S|RDR|FRU|RES} (025)::{S|RDR|FRU|RES} (026)::{S|RDR|FRU|HS|RES} (027):BMR-H8S Shelf FR:{S|RDR|INV|RST|PWR|FRU|CNT|RES} RPT ID ==> 23 (458752):FUMI_RDR INSTRUMENT NUM=000 Tag=FUMI(HPM) FUMI_RDR INSTRUMENT NUM ==> 0 fumi block ==>

5.17.4 activate

5.17.4.1 Syntax activate

5.17.4.2 Purpose This subcommand starts execution of the active image on the current FUMI.

5.17.5 backup

5.17.5.1 Syntax backup

5.17.5.2 Purpose This subcommand initiates a backup of the currently active FUMI bank.

5.17.6 bankcopy

5.17.6.1 Syntax bankcopy [<source bank num> [<target bank num>]]

5.17.6.2 Purpose This subcommand initiates a copy of the contents of one bank to another bank on the current FUMI. If the <target bank num> parameter is omitted, the command waits for the user to enter a <target bank num>. If both the <target bank num> and the <target bank num> parameters are omitted, the command waits for the user to enter these parameters.

5.17.7 cancel

5.17.7.1 Syntax cancel [<bank num>]


Release 2.10.1.0 64 January 23, 2008

5.17.7.2 Purpose This subcommand stops an asynchronous upgrade operation in progress on the specified FUMI bank. If the <bank num> parameter is omitted, the command waits for the user to enter a <bank num>.

5.17.8 getsource

5.17.8.1 Syntax getsource [<bank num>]

5.17.8.2 Purpose This subcommand shows information about the source image assigned to the specified FUMI bank. If the <bank num> parameter is omitted, the command waits for the user to enter a <bank num>.

5.17.9 install

5.17.9.1 Syntax install [<bank num>]

5.17.9.2 Purpose This subcommand starts an installation process of loading firmware to the specified FUMI bank. If the <bank num> parameter is omitted, the command waits for the user to enter a <bank num>.

5.17.10 rollback

5.17.10.1 Syntax rollback

5.17.10.2 Purpose This subcommand initiates a rollback operation to restore the currently active bank with a backup version.

5.17.11 setbootorder

5.17.11.1 Syntax setbootorder [<bank num> [<boot order>]]


Release 2.10.1.0 65 January 23, 2008

5.17.11.2 Purpose This subcommand sets the position of specified FUMI bank in the boot order. If the <boot order> parameter is omitted, the command waits for the user to enter a <boot order>. If both the <bank num> and the <boot order> parameters are omitted, the command waits for the user to enter these parameters.

5.17.12 setsource

5.17.12.1 Syntax setsource [<bank num> [<source URI>]]

5.17.12.2 Purpose This subcommand sets new source information for the specified FUMI bank. Source information is required by the FUMI to correctly address the image in the source repository. The user provides it in the form of a properly formatted Uniform Resource Identifier (URI, as defined by RFC 3986). The URI indicates the path to the source file and the access protocol in the following form: <access protocol>://<path to the source file> Protocols that the FUMI can support are reported by the FUMI’s RDR. The SAI-HPI-B.02.01 specification defined protocols are presented in table below. Table 8 FUMI Access Protocols

ACCESS PROTOCOL URI EXAMPLE Trivial File Transfer Protocol tftp://host.com/file.hpm File Transfer Protocol ftp://host.com/file.hpm HyperText Transfer Protocol http://host.com/file.hpm Lightweight Directory Access Protocol ldap://host.com/c=US?objectClass?one Local File System Access Protocol file:///var/tmp/file.hpm Network File System Access Protocol nfs://host/tmp/file.hpm

The user must ensure that the source URI corresponds to one of the supported protocols and that the source is accessible by the FUMI. If the <source URI> parameter is omitted, the command waits for the user to enter a <source URI>. If both the <bank num> and the <source URI > parameters are omitted, the command waits for the user to enter these parameters.

ftp://host.com/file.hpm�

http://host.com/file.hpm�


Release 2.10.1.0 66 January 23, 2008

5.17.13 status

5.17.13.1 Syntax status [<bank num>]

5.17.13.2 Purpose This subcommand shows the upgrade status on the specified FUMI bank. If the <bank num> parameter is omitted, the command waits for the user to enter a <bank num>.

5.17.14 targetinfo

5.17.14.1 Syntax targetinfo [<bank num>]

5.17.14.2 Purpose This subcommand shows information about the image on the target that is associated with the specified FUMI bank. If the <bank num> parameter is omitted, the command waits for the user to enter a <bank num>.

5.17.15 validatesource

5.17.15.1 Syntax validatesource [<bank num>]

5.17.15.2 Purpose This subcommand initiates the validation of the integrity of the source image associated with the specified FUMI bank. If the <bank num> parameter is omitted, the command waits for the user to enter a <bank num>.

5.17.16 verifytarget

5.17.16.1 Syntax verifytarget [<bank num>]

5.17.16.2 Purpose This subcommand starts the verification process of the upgraded image on the target in the specified FUMI bank.


Release 2.10.1.0 67 January 23, 2008

If the <bank num> parameter is omitted, the command waits for the user to enter a <bank num>.


Release 2.10.1.0 68 January 23, 2008

5.18 help

5.18.1 Syntax help <command> [<command>…<command>]

5.18.2 Purpose The help command displays help information for the specified hpi_shell commands. If no parameters are specified, the help command displays a list of the available hpi_shell commands.

5.18.3 Example OpenHPI> help sen ctrl sen: sensor command block Usage: sen [<sensorId>] sensorId:: <resourceId> <num> ctrl: control command block Usage: ctrl [<ctrlId>] ctrlId:: <resourceId> <num>


Release 2.10.1.0 69 January 23, 2008

5.19 history

5.19.1 Syntax history

5.19.2 Purpose This command displays the recent history of command inputs.

5.19.3 Example OpenHPI> history [ 0 ] dat [ 1 ] help hs [ 2 ] more on [ 3 ] lsres [ 4 ] history


Release 2.10.1.0 70 January 23, 2008

5.20 hs

5.20.1 Syntax hs <resource id>

5.20.2 Purpose The hs command enters a hot swap command block for the specified resource. If the <resource id> parameter is not specified hpi_shell lists all the resources in the current domain and waits for the user to enter a <resource id>. Hot swap command blocks support the subcommands: action, active, gettimeout, inactive, ind, policycancel, settimeout, and state; these subcommands are described in subsections below.

5.20.3 Example OpenHPI> hs 038 Hot swap block ==>

5.20.4 action

5.20.4.1 Syntax action insert|extract

5.20.4.2 Purpose This subcommand, with the specified option insert or extract, invokes an insertion or extraction action, respectively. An insertion action can be requested only when the resource in the inactive state. An extraction action can be requested only when the resource is in the active state.

5.20.4.3 Example Hot swap block ==> action extract 2007-03-12 19:20:28 OEM 38 2007-03-12 19:20:28 HOTSWAP 38 INFORMATIONAL ACTIVE -> EXTRACTION_PENDING 2007-03-12 19:20:44 OEM 38 2007-03-12 19:20:44 HOTSWAP 38 INFORMATIONAL EXTRACTION_PENDING -> INACTIVE

5.20.5 active

5.20.5.1 Syntax active


Release 2.10.1.0 71 January 23, 2008

5.20.5.2 Purpose This subcommand is used in the Insertion Pending and Extraction Pending states. This subcommand sets the active state for the current resource. In the active state, the resource is an active member of the domain and has completed the insertion process.

5.20.5.3 Example Hot swap block ==> state Hot Swap State: Inactive Hot swap block ==> action insert Hot swap block ==> policycancel Hot swap block ==> active Hot swap block ==> state Hot Swap State: Active

5.20.6 gettimeout

5.20.6.1 Syntax gettimeout insert|extract

5.20.6.2 Purpose This subcommand, with the insert or extract option, shows the auto insertion or auto extraction timeout (in milliseconds). If neither of the options is specified, the subcommand prompts for a choice between them.

5.20.6.3 Example Hot swap block ==> gettimeout insert Auto-insert timeout(msec): 50000 Hot swap block ==> gettimeout extract Auto-insert timeout(msec): 50000

5.20.7 inactive

5.20.7.1 Syntax inactive

5.20.7.2 Purpose This subcommand is used in the Insertion Pending and Extraction Pending states. This subcommand sets the state of the current resource to inactive. In the inactive state, the resource is not active in the current domain and has completed the extraction process.

5.20.7.3 Example Hot swap block ==> state Hot Swap State: Ext. Pending Hot swap block ==> policycancel


Release 2.10.1.0 72 January 23, 2008

Hot swap block ==> inactive Hot swap block ==> state Hot Swap State: Inactive

5.20.8 ind

5.20.8.1 Syntax ind get|on|off

5.20.8.2 Purpose This subcommand, with the get option, shows the state of the hot swap indicator for the current resource. This subcommand, with the on or off option, sets the state of the hot swap indicator accordingly, regardless of the hot swap state of the current resource. If neither of the options is specified, the subcommand prompts for a choice between them.

5.20.8.3 Example Hot swap block ==> ind get Hot Swap Indicator: ON Hot swap block ==> ind off Hot swap block ==> ind get Hot Swap Indicator: OFF

5.20.9 policycancel

5.20.9.1 Syntax policycancel

5.20.9.2 Purpose This subcommand is used when the current resource is in either the Insertion Pending or Extraction Pending states. The policycancel subcommand cancels the automatic board activation or deactivation that would normally occur after the relevant timeout expires following an action insert or action extract subcommand. Such a cancelation leaves the resource in the Insertion Pending or Extraction Pending state.

5.20.9.3 Example Hot swap block ==> gettimeout Timeout type(insert|extract): extract Auto-extract timeout(msec): 60000 Hot swap block ==> action extract Hot swap block ==> state Hot Swap State: Ext. Pending Hot swap block ==> policycancel Hot swap block ==> state Hot Swap State: Ext. Pending


Release 2.10.1.0 73 January 23, 2008

Hot swap block ==> inactive

5.20.10 settimeout

5.20.10.1 Syntax settimeout insert|extract <value>

5.20.10.2 Purpose This subcommand, with the insert or extract option, sets the auto insertion or auto extraction timeout (in milliseconds) for the current resource. If neither of the options is specified, the subcommand prompts for a choice between them. The <value> parameter is the timeout period in milliseconds. Note: OpenHPI 2.8.1 currently sets the auto extraction timeout at the resource level, but sets the auto insertion timeout as a global value for all resources within a domain.

5.20.10.3 Example Hot swap block ==> settimeout insert 60000 Hot swap block ==> gettimeout insert Auto-insert timeout(msec): 60000

5.20.11 state

5.20.11.1 Syntax state

5.20.11.2 Purpose This subcommand shows the hot swap state of the current resource.

5.20.11.3 Example Hot swap block ==> state Hot Swap State: Inactive


Release 2.10.1.0 74 January 23, 2008

5.21 inv/showinv

5.21.1 Syntax inv [<resource id>][<inventory instrument num>] The verb showinv can also be used instead of inv.

5.21.2 Purpose This command shows the inventory data for the specified resource and RDR and enters an inventory command block for this resource. If the <inventory instrument num> parameter is omitted, hpi_shell shows all inventory data RDRs for the specified resource and waits for the user to enter an <inventory instrument num>. If there are no parameters in the command line, hpi_shell shows all resources in the current domain and waits for the user to enter a <resource id>; then, hpi_shell shows all inventory data RDRs for that resource and waits for the user to enter an <inventory instrument num>. Inventory command blocks support the subcommands: addarea, addfield, delarea, delfield, setfield and show. However, of these subcommands, only the last one is currently functional in Pigeon Point OpenHPI because the other subcommands attempt to modify inventory data, which is read-only in the current implementation.

5.21.3 Example OpenHPI> inv 94 0 Inventory: 0 Update count: 1 Read only: 1 Areas: 3 Area: 1 Type: OEM Read Only: 1 Fields: 2 Field: 65534 Type: CUSTOM Read Only: 1 (BIN: 480E00005553455220494E464F204152454120000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 (len=250)) Field: 65535 Type: CUSTOM Read Only: 1 (BIN: C002 (len=2)) Area: 2 Type: PRODUCT_INFO Read Only: 1 Fields: 8 Field: 1 Type: MANUFACTURER Read Only: 1 (TEXT: ENGLISH: Comtel Electronics GmbH (len=24)) Field: 2 Type: PRODUCT_NAME Read Only: 1 (TEXT: ENGLISH: ATCA Load Board with Sensors (len=30)) Field: 3 Type: PART_NUMBER Read Only: 1 (TEXT: ENGLISH: 36003114 (len=8))


Release 2.10.1.0 75 January 23, 2008

Field: 4 Type: PRODUCT_VERSION Read Only: 1 (TEXT: ENGLISH: 000: (len=4)) Field: 5 Type: SERIAL_NUMBER Read Only: 1 (TEXT: ENGLISH: 0445624176000025 (len=16)) Field: 6 Type: ASSET_TAG Read Only: 1 () Field: 7 Type: FILE_ID Read Only: 1 (TEXT: ENGLISH: LOAD0001 (len=8)) Field: 8 Type: CUSTOM Read Only: 1 (BIN: 480E000154656C (len=7)) Area: 3 Type: BOARD_INFO Read Only: 1 Fields: 6 Field: 1 Type: MFG_DATETIME Read Only: 1 (TEXT: ENGLISH: 2006.07.04 06:08:00 (len=20)) Field: 2 Type: MANUFACTURER Read Only: 1 (TEXT: ENGLISH: Comtel Electronics GmbH (len=24)) Field: 3 Type: PRODUCT_NAME Read Only: 1 (TEXT: ENGLISH: ATCA Load Board with Sensors (len=30)) Field: 4 Type: SERIAL_NUMBER Read Only: 1 (TEXT: ENGLISH: 0445624176000025 (len=16)) Field: 5 Type: PART_NUMBER Read Only: 1 (TEXT: ENGLISH: 36003114 (len=8)) Field: 6 Type: FILE_ID Read Only: 1 (TEXT: ENGLISH: LOAD0001 (len=8)) inventory block ==>

5.21.4 addarea

5.21.4.1 Syntax addarea <area type>

5.21.4.2 Purpose This subcommand adds an area of the specified type to the inventory data for the current resource. The <area type> is one of following: inter (Internal Use Area), chass (Chassis Info Area), board (Board Info Area), prod (Product Info Area), oem (Multirecord Area). Note: The Pigeon Point plug-in does not currently support inventory modification, so this subcommand is not functional.

5.21.5 addfield

5.21.5.1 Syntax addfield <area id>

5.21.5.2 Purpose This subcommand adds a field to the specified inventory area of the current resource. The command prompts the HPI user for field type, datatype and value. Note: The Pigeon Point plug-in does not currently support inventory modification, so this subcommand is not functional.


Release 2.10.1.0 76 January 23, 2008

5.21.6 delarea

5.21.6.1 Syntax delarea

5.21.6.2 Purpose This subcommand removes an area specified by the <area id> parameter from the inventory of the current resource. Note: The Pigeon Point plug-in does not currently support inventory modification, so this subcommand is not functional.

5.21.7 delfield

5.21.7.1 Syntax delfield <area id> <field id>

5.21.7.2 Purpose This subcommand removes a field specified by the <field id> parameter from the specified inventory area of the current resource. Note: The Pigeon Point plug-in does not currently support inventory modification, so this subcommand is not functional.

5.21.8 setfield

5.21.8.1 Syntax setfield <area id> <field id>

5.21.8.2 Purpose This subcommand sets the specified field data of the specified inventory area of the current resource. The command prompts the user for field type, datatype and value. Note: The Pigeon Point plug-in does not currently support inventory modification, so this subcommand is not functional.

5.21.9 show

5.21.9.1 Syntax show

5.21.9.2 Purpose This subcommand shows inventory data for the current resource.


Release 2.10.1.0 77 January 23, 2008

5.21.9.3 Example inventory block ==> show Inventory: 0 Update count: 1 Read only: 1 Areas: 3 Area: 1 Type: OEM Read Only: 1 Fields: 2 Field: 65534 Type: CUSTOM Read Only: 1 (BIN: 480E00005553455220494E464F204152454120000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 (len=250)) Field: 65535 Type: CUSTOM Read Only: 1 (BIN: C002 (len=2)) Area: 2 Type: PRODUCT_INFO Read Only: 1 Fields: 8 Field: 1 Type: MANUFACTURER Read Only: 1 (TEXT: ENGLISH: Comtel Electronics GmbH (len=24)) Field: 2 Type: PRODUCT_NAME Read Only: 1 (TEXT: ENGLISH: ATCA Load Board with Sensors (len=30)) Field: 3 Type: PART_NUMBER Read Only: 1 (TEXT: ENGLISH: 36003114 (len=8)) Field: 4 Type: PRODUCT_VERSION Read Only: 1 (TEXT: ENGLISH: 000: (len=4)) Field: 5 Type: SERIAL_NUMBER Read Only: 1 (TEXT: ENGLISH: 0445624176000025 (len=16)) Field: 6 Type: ASSET_TAG Read Only: 1 () Field: 7 Type: FILE_ID Read Only: 1 (TEXT: ENGLISH: LOAD0001 (len=8)) Field: 8 Type: CUSTOM Read Only: 1 (BIN: 480E000154656C (len=7)) Area: 3 Type: BOARD_INFO Read Only: 1 Fields: 6 Field: 1 Type: MFG_DATETIME Read Only: 1 (TEXT: ENGLISH: 2006.07.04 06:08:00 (len=20)) Field: 2 Type: MANUFACTURER Read Only: 1 (TEXT: ENGLISH: Comtel Electronics GmbH (len=24)) Field: 3 Type: PRODUCT_NAME Read Only: 1 (TEXT: ENGLISH: ATCA Load Board with Sensors (len=30)) Field: 4 Type: SERIAL_NUMBER Read Only: 1 (TEXT: ENGLISH: 0445624176000025 (len=16)) Field: 5 Type: PART_NUMBER Read Only: 1 (TEXT: ENGLISH: 36003114 (len=8)) Field: 6 Type: FILE_ID Read Only: 1 (TEXT: ENGLISH: LOAD0001 (len=8)) inventory block ==>


Release 2.10.1.0 78 January 23, 2008

5.22 lsensor

5.22.1 Syntax lsensor

5.22.2 Purpose This command shows information about all the sensors in the current domain.

5.22.3 Example OpenHPI> lsensor Resource Id: 1, Sensor Num: 4096 Tag: Shelf FRU Information Valid Resource Id: 1, Sensor Num: 4864 Tag: FRU Power On Sequence Commit Status Resource Id: 2, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 2, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 2, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 3, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 3, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 3, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 4, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 4, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 4, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 5, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 5, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 5, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 6, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 6, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 6, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 7, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 7, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 7, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 8, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 8, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 8, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 9, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 9, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 9, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 10, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 10, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 10, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 11, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 11, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 11, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 12, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 12, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 12, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 13, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 13, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 13, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 14, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 14, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 14, Sensor Num: 4113 Tag: Assigned Power Sensor


Release 2.10.1.0 79 January 23, 2008

Resource Id: 15, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 15, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 15, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 16, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 16, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 16, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 17, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 17, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 17, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 18, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 18, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 18, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 19, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 19, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 19, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 20, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 20, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 20, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 21, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 21, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 21, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 22, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 22, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 22, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 23, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 23, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 23, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 24, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 24, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 24, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 25, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 25, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 25, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 26, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 26, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 26, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 27, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 27, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 27, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 28, Sensor Num: 4112 Tag: Slot State Sensor Resource Id: 28, Sensor Num: 4114 Tag: Maximum Power Capability Sensor Resource Id: 28, Sensor Num: 4113 Tag: Assigned Power Sensor Resource Id: 29, Sensor Num: 4097 Tag: Shelf Manager Redundancy Sensor Resource Id: 29, Sensor Num: 4098 Tag: Active Shelf Manager Sensor Resource Id: 29, Sensor Num: 4099 Tag: Standby Shelf Manager Sensor Resource Id: 29, Sensor Num: 0 Tag: FRU 0 HOT_SWAP Resource Id: 29, Sensor Num: 4352 Tag: IPMB LINK Resource Id: 29, Sensor Num: 120 Tag: Center Exhaust Resource Id: 29, Sensor Num: 121 Tag: Left Exhaust Resource Id: 29, Sensor Num: 122 Tag: Right Exhaust Resource Id: 29, Sensor Num: 131 Tag: TELCO Alarms Resource Id: 29, Sensor Num: 132 Tag: BMC Watchdog Resource Id: 29, Sensor Num: 133 Tag: SYSTEM EVENT Resource Id: 29, Sensor Num: 150 Tag: Air Filter Resource Id: 30, Sensor Num: 2 Tag: FRU 1 HOT_SWAP Resource Id: 30, Sensor Num: 194 Tag: Shelf EEPROM 1


Release 2.10.1.0 80 January 23, 2008

Resource Id: 31, Sensor Num: 3 Tag: FRU 2 HOT_SWAP Resource Id: 31, Sensor Num: 195 Tag: Shelf EEPROM 2 Resource Id: 32, Sensor Num: 4 Tag: FRU 8 HOT_SWAP Resource Id: 32, Sensor Num: 123 Tag: SAP Temp Resource Id: 32, Sensor Num: 152 Tag: SAP Resource Id: 33, Sensor Num: 5 Tag: FRU 3 HOT_SWAP Resource Id: 33, Sensor Num: 12 Tag: Fan Tray 0 Resource Id: 33, Sensor Num: 124 Tag: Temp_In Left Resource Id: 33, Sensor Num: 208 Tag: 24V FT 0 Resource Id: 33, Sensor Num: 209 Tag: -48A bus FT 0 Resource Id: 33, Sensor Num: 210 Tag: -48A FT 0 Resource Id: 33, Sensor Num: 211 Tag: -48B bus FT 0 Resource Id: 33, Sensor Num: 212 Tag: -48B FT 0 Resource Id: 33, Sensor Num: 213 Tag: -48A FT 0 Fuse Resource Id: 33, Sensor Num: 214 Tag: -48B FT 0 Fuse Resource Id: 34, Sensor Num: 6 Tag: FRU 4 HOT_SWAP Resource Id: 34, Sensor Num: 13 Tag: Fan Tray 1 Resource Id: 34, Sensor Num: 125 Tag: Temp_In Center Resource Id: 34, Sensor Num: 215 Tag: 24V FT 1 Resource Id: 34, Sensor Num: 216 Tag: -48A bus FT 1 Resource Id: 34, Sensor Num: 217 Tag: -48A FT 1 Resource Id: 34, Sensor Num: 218 Tag: -48B bus FT 1 Resource Id: 34, Sensor Num: 219 Tag: -48B FT 1 Resource Id: 34, Sensor Num: 220 Tag: -48A FT 1 Fuse Resource Id: 34, Sensor Num: 221 Tag: -48B FT 1 Fuse Resource Id: 35, Sensor Num: 7 Tag: FRU 5 HOT_SWAP Resource Id: 35, Sensor Num: 14 Tag: Fan Tray 2 Resource Id: 35, Sensor Num: 126 Tag: Temp_In Right Resource Id: 35, Sensor Num: 222 Tag: 24V FT 2 Resource Id: 35, Sensor Num: 223 Tag: -48A bus FT 2 Resource Id: 35, Sensor Num: 224 Tag: -48A FT 2 Resource Id: 35, Sensor Num: 225 Tag: -48B bus FT 2 Resource Id: 35, Sensor Num: 226 Tag: -48B FT 2 Resource Id: 35, Sensor Num: 227 Tag: -48A FT 2 Fuse Resource Id: 35, Sensor Num: 228 Tag: -48B FT 2 Fuse Resource Id: 36, Sensor Num: 8 Tag: FRU 6 HOT_SWAP Resource Id: 36, Sensor Num: 162 Tag: PEM A In 2 Resource Id: 36, Sensor Num: 163 Tag: PEM A In 2 Fused Resource Id: 36, Sensor Num: 164 Tag: PEM A In 1 Resource Id: 36, Sensor Num: 165 Tag: PEM A In 1 Fused Resource Id: 36, Sensor Num: 166 Tag: PEM A In 4 Resource Id: 36, Sensor Num: 167 Tag: PEM A In 4 Fused Resource Id: 36, Sensor Num: 168 Tag: PEM A In 3 Resource Id: 36, Sensor Num: 169 Tag: PEM A In 3 Fused Resource Id: 36, Sensor Num: 192 Tag: PEM A Resource Id: 37, Sensor Num: 9 Tag: FRU 7 HOT_SWAP Resource Id: 37, Sensor Num: 174 Tag: PEM B In 2 Resource Id: 37, Sensor Num: 175 Tag: PEM B In 2 Fused Resource Id: 37, Sensor Num: 176 Tag: PEM B In 1 Resource Id: 37, Sensor Num: 177 Tag: PEM B In 1 Fused Resource Id: 37, Sensor Num: 178 Tag: PEM B In 4 Resource Id: 37, Sensor Num: 179 Tag: PEM B In 4 Fused Resource Id: 37, Sensor Num: 180 Tag: PEM B In 3 Resource Id: 37, Sensor Num: 181 Tag: PEM B In 3 Fused Resource Id: 37, Sensor Num: 193 Tag: PEM B Resource Id: 38, Sensor Num: 0 Tag: Hot Swap


Release 2.10.1.0 81 January 23, 2008

Resource Id: 38, Sensor Num: 4352 Tag: IPMB Physical Resource Id: 38, Sensor Num: 1024 Tag: E-Keying Link State: 0 Intrface, Link Type 1, Link Type Ext 0 Channel 1 Resource Id: 38, Sensor Num: 1025 Tag: E-Keying Link State: 0 Intrface, Link Type 1, Link Type Ext 0 Channel 2 Resource Id: 38, Sensor Num: 1026 Tag: E-Keying Link State: 1 Intrface, Link Type 2, Link Type Ext 0 Channel 1 Resource Id: 38, Sensor Num: 1027 Tag: E-Keying Link State: 1 Intrface, Link Type 2, Link Type Ext 0 Channel 2 Resource Id: 38, Sensor Num: 1028 Tag: E-Keying Link State: 2 Intrface, Link Type 240, Link Type Ext 0 Channel 1 Resource Id: 39, Sensor Num: 2 Tag: BMC Watchdog Resource Id: 39, Sensor Num: 3 Tag: DS75 Temp Resource Id: 40, Sensor Num: 4 Tag: +3.3V Resource Id: 40, Sensor Num: 5 Tag: +2.5V Resource Id: 40, Sensor Num: 6 Tag: +1.8V Resource Id: 40, Sensor Num: 7 Tag: +1.5V Resource Id: 40, Sensor Num: 8 Tag: +5.0V Resource Id: 40, Sensor Num: 9 Tag: LM60 Temp Resource Id: 41, Sensor Num: 0 Tag: FRU 0 HOT_SWAP Resource Id: 41, Sensor Num: 4352 Tag: IPMB LINK Resource Id: 41, Sensor Num: 2 Tag: Local Temp Resource Id: 41, Sensor Num: 3 Tag: 3V3_local Resource Id: 41, Sensor Num: 4 Tag: I2C_PWR_A Resource Id: 41, Sensor Num: 5 Tag: I2C_PWR_B Resource Id: 41, Sensor Num: 6 Tag: VBAT Resource Id: 41, Sensor Num: 7 Tag: Fan Tach. 0 Resource Id: 41, Sensor Num: 8 Tag: Fan Tach. 1 Resource Id: 41, Sensor Num: 10 Tag: Fan Tach. 2 Resource Id: 41, Sensor Num: 11 Tag: Fan Tach. 3 Resource Id: 41, Sensor Num: 13 Tag: Fan Tach. 4 Resource Id: 41, Sensor Num: 14 Tag: Fan Tach. 5 Resource Id: 41, Sensor Num: 15 Tag: -48A Bus voltage Resource Id: 41, Sensor Num: 16 Tag: -48B Bus voltage Resource Id: 41, Sensor Num: 17 Tag: -48A ACB voltage Resource Id: 41, Sensor Num: 18 Tag: -48B ACB voltage Resource Id: 41, Sensor Num: 19 Tag: -48A ACB Fuse Resource Id: 41, Sensor Num: 20 Tag: -48B ACB Fuse Resource Id: 41, Sensor Num: 128 Tag: CPLD State Resource Id: 41, Sensor Num: 1024 Tag: E-Keying Link State: 0 Intrface, Link Type 1, Link Type Ext 0 Channel 1 Resource Id: 41, Sensor Num: 1025 Tag: E-Keying Link State: 0 Intrface, Link Type 1, Link Type Ext 0 Channel 2 OpenHPI>


Release 2.10.1.0 82 January 23, 2008

5.23 lsres

5.23.1 Syntax lsres [stat] [path]

5.23.2 Purpose This command lists all the resources in the current domain. With the stat option, lsres also shows the hot swap states of the hot swappable resources. If a hot swappable resource supports a Hot Swap indicator (usually an LED), an IND item is included in the capability list for that resource. If the extract timeout value for the hot swappable resource is read-only, an RO item is included in the capability list. With the path option, lsres also shows the resources’ entity paths.

5.23.3 Example OpenHPI> lsres (001):Shelf Resource:{S|RDR|INV|CNT|RES} (084):OEM Slot 1:{S|RDR|CNT|RES} (002):ATCA Board Slot 1:{S|RDR|CNT|RES} (003):ATCA Board Slot 2:{S|RDR|CNT|RES} (004):ATCA Board Slot 3:{S|RDR|CNT|RES} (005):ATCA Board Slot 4:{S|RDR|CNT|RES} (006):ATCA Board Slot 5:{S|RDR|CNT|RES} (007):ATCA Board Slot 6:{S|RDR|CNT|RES} (008):ATCA Board Slot 7:{S|RDR|CNT|RES} (009):ATCA Board Slot 8:{S|RDR|CNT|RES} (010):ATCA Board Slot 9:{S|RDR|CNT|RES} (011):ATCA Board Slot 10:{S|RDR|CNT|RES} (012):ATCA Board Slot 11:{S|RDR|CNT|RES} (013):ATCA Board Slot 12:{S|RDR|CNT|RES} (014):ATCA Board Slot 13:{S|RDR|CNT|RES} (015):ATCA Board Slot 14:{S|RDR|CNT|RES} (016):ATCA Board Slot 15:{S|RDR|CNT|RES} (017):ATCA Board Slot 16:{S|RDR|CNT|RES} (085):Power Entry Module Slot 1:{S|RDR|CNT|RES} (086):Power Entry Module Slot 2:{S|RDR|CNT|RES} (025):Shelf FRU Information Slot 1:{S|RDR|CNT|RES} (026):Shelf FRU Information Slot 2:{S|RDR|CNT|RES} (027):Dedicated ShMc Slot 1:{S|RDR|CNT|RES} (028):Dedicated ShMc Slot 2:{S|RDR|CNT|RES} (029):Fan Tray Slot 1:{S|RDR|CNT|RES} (087):Fan Tray Slot 2:{S|RDR|CNT|RES} (018):PPS BMC:{S|RDR|ELOG|INV|PWR|FRU|CNT|WTD|RES|DIMI} (030):Shelf EEPROM 1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (031):Shelf EEPROM 2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (088):ADPEM1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (089):ADPEM2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (090):Fan Tray 2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (033):ShMM-500:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI}


Release 2.10.1.0 83 January 23, 2008

(091):ATCA Demo Board:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI} (092)::{S|RDR|WTD|RES} (093)::{S|RDR|WTD|RES} OpenHPI> lsres stat (001):Shelf Resource:{S|RDR|INV|CNT|RES} (084):OEM Slot 1:{S|RDR|CNT|RES} (002):ATCA Board Slot 1:{S|RDR|CNT|RES} (003):ATCA Board Slot 2:{S|RDR|CNT|RES} (004):ATCA Board Slot 3:{S|RDR|CNT|RES} (005):ATCA Board Slot 4:{S|RDR|CNT|RES} (006):ATCA Board Slot 5:{S|RDR|CNT|RES} (007):ATCA Board Slot 6:{S|RDR|CNT|RES} (008):ATCA Board Slot 7:{S|RDR|CNT|RES} (009):ATCA Board Slot 8:{S|RDR|CNT|RES} (010):ATCA Board Slot 9:{S|RDR|CNT|RES} (011):ATCA Board Slot 10:{S|RDR|CNT|RES} (012):ATCA Board Slot 11:{S|RDR|CNT|RES} (013):ATCA Board Slot 12:{S|RDR|CNT|RES} (014):ATCA Board Slot 13:{S|RDR|CNT|RES} (015):ATCA Board Slot 14:{S|RDR|CNT|RES} (016):ATCA Board Slot 15:{S|RDR|CNT|RES} (017):ATCA Board Slot 16:{S|RDR|CNT|RES} (085):Power Entry Module Slot 1:{S|RDR|CNT|RES} (086):Power Entry Module Slot 2:{S|RDR|CNT|RES} (025):Shelf FRU Information Slot 1:{S|RDR|CNT|RES} (026):Shelf FRU Information Slot 2:{S|RDR|CNT|RES} (027):Dedicated ShMc Slot 1:{S|RDR|CNT|RES} (028):Dedicated ShMc Slot 2:{S|RDR|CNT|RES} (029):Fan Tray Slot 1:{S|RDR|CNT|RES} (087):Fan Tray Slot 2:{S|RDR|CNT|RES} (018):PPS BMC:{S|RDR|ELOG|INV|PWR|FRU|CNT|WTD|RES|DIMI} (030):Shelf EEPROM 1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} HS={ACTIVE IND} (031):Shelf EEPROM 2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} HS={ACTIVE IND} (088):ADPEM1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} HS={ACTIVE IND} (089):ADPEM2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} HS={ACTIVE IND} (090):Fan Tray 2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} HS={ACTIVE IND} (033):ShMM-500:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI} HS={ACTIVE IND} (091):ATCA Demo Board:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI} HS={ACTIVE IND} (092)::{S|RDR|WTD|RES} (093)::{S|RDR|WTD|RES}


Release 2.10.1.0 84 January 23, 2008

5.24 more

5.24.1 Syntax more [ on | off ]

5.24.2 Purpose This command, with the on or off option, determines whether console output from a single command is “paged” in groups of lines. The on or off options select or unselect paged output. With paged output, after outputting a page of lines, hpi_shell issues a – more – prompt and waits for the user to enter a character. If the character is q, hpi_shell terminates that listing; if the character is anything else, hpi_shell shows the next page of lines.

5.24.3 Example OpenHPI> more on OpenHPI> lsres (001):Shelf Resource:{S|RDR|INV|CNT|RES} (002):OEM Slot 1:{S|RDR|CNT|RES} (003):ATCA Board Slot 1:{S|RDR|CNT|RES} (004):ATCA Board Slot 2:{S|RDR|CNT|RES} (005):ATCA Board Slot 3:{S|RDR|CNT|RES} (006):ATCA Board Slot 4:{S|RDR|CNT|RES} (007):ATCA Board Slot 5:{S|RDR|CNT|RES} (008):ATCA Board Slot 6:{S|RDR|CNT|RES} (009):ATCA Board Slot 7:{S|RDR|CNT|RES} (010):ATCA Board Slot 8:{S|RDR|CNT|RES} (011):ATCA Board Slot 9:{S|RDR|CNT|RES} (012):ATCA Board Slot 10:{S|RDR|CNT|RES} (013):ATCA Board Slot 11:{S|RDR|CNT|RES} (014):ATCA Board Slot 12:{S|RDR|CNT|RES} (015):ATCA Board Slot 13:{S|RDR|CNT|RES} (016):ATCA Board Slot 14:{S|RDR|CNT|RES} (017):ATCA Board Slot 15:{S|RDR|CNT|RES} (018):ATCA Board Slot 16:{S|RDR|CNT|RES} (019):Power Entry Module Slot 1:{S|RDR|CNT|RES} (020):Power Entry Module Slot 2:{S|RDR|CNT|RES} (021):Shelf FRU Information Slot 1:{S|RDR|CNT|RES} (022):Shelf FRU Information Slot 2:{S|RDR|CNT|RES} (023):Dedicated ShMc Slot 1:{S|RDR|CNT|RES} - more – (024):Dedicated ShMc Slot 2:{S|RDR|CNT|RES} (025):Fan Tray Slot 1:{S|RDR|CNT|RES} (026):Fan Tray Slot 2:{S|RDR|CNT|RES} (027):Fan Tray Slot 3:{S|RDR|CNT|RES} (028):Alarm Slot 1:{S|RDR|CNT|RES} (029):PPS BMC:{S|RDR|ELOG|INV|PWR|FRU|CNT|RES|DIMI} (030):Shelf EEPROM 1:{S|RDR|INV|PWR|FRU|CNT|HS|RES} (031):Shelf EEPROM 2:{S|RDR|INV|PWR|FRU|CNT|HS|RES} (032):SAP Board:{S|RDR|INV|PWR|FRU|CNT|HS|RES|DIMI} (033):Fan Tray 0:{S|RDR|INV|PWR|FRU|CNT|HS|RES} (034):Fan Tray 1:{S|RDR|INV|PWR|FRU|CNT|HS|RES}


Release 2.10.1.0 85 January 23, 2008

(035):Fan Tray 2:{S|RDR|INV|PWR|FRU|CNT|HS|RES} (036):PEM A:{S|RDR|PWR|FRU|CNT|HS|RES} (037):PEM B:{S|RDR|PWR|FRU|CNT|HS|RES} (038):ATCA Demo Board:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES|DIMI} (039)::{S|RDR|RES} (040)::{S|RDR|RES} (041):ShMM-500:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES|DIMI} OpenHPI>


Release 2.10.1.0 86 January 23, 2008

5.25 parmctrl

5.25.1 Syntax parmctrl <resource id> [default|save|restore]

5.25.2 Purpose This command saves or restores configuration settings for the specified resource. Note: The Pigeon Point plug-in does not currently support the saving or restoring of resource settings, so this command is not functional.


Release 2.10.1.0 87 January 23, 2008

5.26 power

5.26.1 Syntax power <resource id> [on|off|cycle]

5.26.2 Purpose This command sets the power state of the specified resource, regardless of the current hot swap state of that resource. The options on,off,cycle turn the power on, turn the power off or turn the power off then on, respectively. If no option is specified, the current power state of the designated resource is shown.

5.26.3 Example OpenHPI> power 38 Resource 38 is power on now. OpenHPI> power 38 off OpenHPI> 2007-03-12 20:10:31 OEM 38 2007-03-12 20:10:31 HOTSWAP 38 INFORMATIONAL ACTIVE -> EXTRACTION_PENDING 2007-03-12 20:10:41 OEM 38 2007-03-12 20:10:41 HOTSWAP 38 INFORMATIONAL EXTRACTION_PENDING -> INACTIVE OpenHPI> power 38 on OpenHPI> 2007-03-12 20:10:51 OEM 38 2007-03-12 20:10:51 HOTSWAP 38 INFORMATIONAL INACTIVE -> INSERTION_PENDING 2007-03-12 20:10:51 OEM 38 2007-03-12 20:10:51 HOTSWAP 38 INFORMATIONAL INSERTION_PENDING -> ACTIVE OpenHPI> power 38 cycle 2007-03-12 20:11:07 OEM 38 2007-03-12 20:11:07 HOTSWAP 38 INFORMATIONAL ACTIVE -> EXTRACTION_PENDING 2007-03-12 20:11:17 OEM 38 2007-03-12 20:11:17 HOTSWAP 38 INFORMATIONAL EXTRACTION_PENDING -> INACTIVE 2007-03-12 20:11:17 OEM 38 2007-03-12 20:11:17 HOTSWAP 38 INFORMATIONAL INACTIVE -> INSERTION_PENDING 2007-03-12 20:11:17 OEM 38 2007-03-12 20:11:17 HOTSWAP 38 INFORMATIONAL INSERTION_PENDING -> ACTIVE


Release 2.10.1.0 88 January 23, 2008

5.27 quit

5.27.1 Syntax quit

5.27.2 Purpose This command closes the current session and exits hpi_shell. This command, when issued in a command block, closes that command block.

5.27.3 Example OpenHPI> quit quit Killed


Release 2.10.1.0 89 January 23, 2008

5.28 rdr/showrdr

5.28.1 Syntax rdr [<resource id> [<type> [<rdr instrument num>]]] The verb showrdr can also be used instead of rdr.

5.28.2 Purpose This command shows the specified RDR associated with the specified resource. The <rdr instrument num> designates an RDR for the specified resource. If the <rdr instrument num> is omitted, the command lists the RDRs of the specified type and waits for the user to enter an <rdr instrument num>. <type> is one of the following: a – annunciator RDR, w – watchdog timer RDR, c – control RDR, s – sensor RDR, i – inventory RDR; If this parameter is passed in the command line, the command lists the resources with the RPT identifier specified as the <resource id> parameter in the command line. When this command is invoked without any parameters, it lists all the resources in the current domain and waits for the user to enter a <resource id> or all and then a <type> or all for the RDR type. Note: Designating an instrument number allows a unique RDR designation only among RDRs of the same type. For example, there can be control and sensor RDRs with the same instrument number. When a user enters all for <type> and an <rdr instrument num>, that request can be ambiguous.

5.28.3 Example OpenHPI> rdr (001):Shelf Resource:{S|RDR|INV|CNT|RES} (084):OEM Slot 1:{S|RDR|CNT|RES} (002):ATCA Board Slot 1:{S|RDR|CNT|RES} (003):ATCA Board Slot 2:{S|RDR|CNT|RES} (004):ATCA Board Slot 3:{S|RDR|CNT|RES} (005):ATCA Board Slot 4:{S|RDR|CNT|RES} (006):ATCA Board Slot 5:{S|RDR|CNT|RES} (007):ATCA Board Slot 6:{S|RDR|CNT|RES} (008):ATCA Board Slot 7:{S|RDR|CNT|RES} (009):ATCA Board Slot 8:{S|RDR|CNT|RES}


Release 2.10.1.0 90 January 23, 2008

(010):ATCA Board Slot 9:{S|RDR|CNT|RES} (011):ATCA Board Slot 10:{S|RDR|CNT|RES} (012):ATCA Board Slot 11:{S|RDR|CNT|RES} (013):ATCA Board Slot 12:{S|RDR|CNT|RES} (014):ATCA Board Slot 13:{S|RDR|CNT|RES} (015):ATCA Board Slot 14:{S|RDR|CNT|RES} (016):ATCA Board Slot 15:{S|RDR|CNT|RES} (017):ATCA Board Slot 16:{S|RDR|CNT|RES} (085):Power Entry Module Slot 1:{S|RDR|CNT|RES} (086):Power Entry Module Slot 2:{S|RDR|CNT|RES} (025):Shelf FRU Information Slot 1:{S|RDR|CNT|RES} (026):Shelf FRU Information Slot 2:{S|RDR|CNT|RES} (027):Dedicated ShMc Slot 1:{S|RDR|CNT|RES} (028):Dedicated ShMc Slot 2:{S|RDR|CNT|RES} (029):Fan Tray Slot 1:{S|RDR|CNT|RES} (087):Fan Tray Slot 2:{S|RDR|CNT|RES} (018):PPS BMC:{S|RDR|ELOG|INV|PWR|FRU|CNT|WTD|RES|DIMI} (030):Shelf EEPROM 1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (031):Shelf EEPROM 2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (088):ADPEM1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (089):ADPEM2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (090):Fan Tray 2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (033):ShMM-500:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI} (091):ATCA Demo Board:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI} (092)::{S|RDR|WTD|RES} (093)::{S|RDR|WTD|RES} RPT (ID | all) ==> 1 RDR Type (s|a|c|w|i|all) ==> c (69632):CTRL_RDR INSTRUMENT NUM=4096 Tag=Shelf Address (69633):CTRL_RDR INSTRUMENT NUM=4097 Tag=Shelf Manager IP Address (69634):CTRL_RDR INSTRUMENT NUM=4098 Tag=Chassis Status (70400):CTRL_RDR INSTRUMENT NUM=4864 Tag=FRU Power On Sequence Commit (70401):CTRL_RDR INSTRUMENT NUM=4865 Tag=FRU Power On Sequence #0 (70402):CTRL_RDR INSTRUMENT NUM=4866 Tag=FRU Power On Sequence #1 (70403):CTRL_RDR INSTRUMENT NUM=4867 Tag=FRU Power On Sequence #2 (70404):CTRL_RDR INSTRUMENT NUM=4868 Tag=FRU Power On Sequence #3 (70405):CTRL_RDR INSTRUMENT NUM=4869 Tag=FRU Power On Sequence #4 (70406):CTRL_RDR INSTRUMENT NUM=4870 Tag=FRU Power On Sequence #5 (70407):CTRL_RDR INSTRUMENT NUM=4871 Tag=FRU Power On Sequence #6 (70408):CTRL_RDR INSTRUMENT NUM=4872 Tag=FRU Power On Sequence #7 (70409):CTRL_RDR INSTRUMENT NUM=4873 Tag=FRU Power On Sequence #8 (70410):CTRL_RDR INSTRUMENT NUM=4874 Tag=FRU Power On Sequence #9 (70411):CTRL_RDR INSTRUMENT NUM=4875 Tag=FRU Power On Sequence #10 (70412):CTRL_RDR INSTRUMENT NUM=4876 Tag=FRU Power On Sequence #11 (70413):CTRL_RDR INSTRUMENT NUM=4877 Tag=FRU Power On Sequence #12 (70414):CTRL_RDR INSTRUMENT NUM=4878 Tag=FRU Power On Sequence #13 (70415):CTRL_RDR INSTRUMENT NUM=4879 Tag=FRU Power On Sequence #14 (70416):CTRL_RDR INSTRUMENT NUM=4880 Tag=FRU Power On Sequence #15 (70417):CTRL_RDR INSTRUMENT NUM=4881 Tag=FRU Power On Sequence #16 (70418):CTRL_RDR INSTRUMENT NUM=4882 Tag=FRU Power On Sequence #17 (70419):CTRL_RDR INSTRUMENT NUM=4883 Tag=FRU Power On Sequence #18 CONTROL_RDR INSTRUMENT NUM ==> 4096 RecordId: 69632 RdrType: CTRL_RDR EntityPath: {SYSTEM_CHASSIS,1} IsFru: FALSE


Release 2.10.1.0 91 January 23, 2008

Control: Num: 4096 Type: TEXT OutputType: GENERIC Text: MaxChars: 25 MaxLines: 1 Language: ENGLISH DataType: TEXT Default: DefaultMode: Mode: MANUAL ReadOnly: TRUE WriteOnly: FALSE Oem: 0 IdString: TEXT: ENGLISH: Shelf Address (len=13) OpenHPI>


Release 2.10.1.0 92 January 23, 2008

5.29 reset

5.29.1 Syntax reset <resource id> [cold|warm|assert|deassert]

5.29.2 Purpose This command performs a cold, warm, assert, or deassert reset action on the specified resource. If no option is specified, this command shows the reset state of the specified resource. If there are no parameters in the command line, hpi_shell lists all resources in the current domain and waits for the user to enter a <resource id>. A warm reset preserves the resource state, while a cold reset does not. Both of these types of reset are pulsed (that is, asserted and then deasserted) by the HPI implementation. The assert and deassert options are not currently supported.

5.29.3 Example OpenHPI> reset (001):Shelf Resource:{S|RDR|INV|CNT|RES} (002):ATCA Board Slot 1:{S|RDR|CNT|RES} (003):ATCA Board Slot 2:{S|RDR|CNT|RES} (004):ATCA Board Slot 3:{S|RDR|CNT|RES} (005):ATCA Board Slot 4:{S|RDR|CNT|RES} (006):ATCA Board Slot 5:{S|RDR|CNT|RES} (007):ATCA Board Slot 6:{S|RDR|CNT|RES} (008):ATCA Board Slot 7:{S|RDR|CNT|RES} (009):ATCA Board Slot 8:{S|RDR|CNT|RES} (010):ATCA Board Slot 9:{S|RDR|CNT|RES} (011):ATCA Board Slot 10:{S|RDR|CNT|RES} (012):ATCA Board Slot 11:{S|RDR|CNT|RES} (013):ATCA Board Slot 12:{S|RDR|CNT|RES} (014):ATCA Board Slot 13:{S|RDR|CNT|RES} (015):ATCA Board Slot 14:{S|RDR|CNT|RES} (016):Shelf FRU Information Slot 1:{S|RDR|CNT|RES} (017):Shelf FRU Information Slot 2:{S|RDR|CNT|RES} (018):Dedicated ShMc Slot 1:{S|RDR|CNT|RES} (019):Dedicated ShMc Slot 2:{S|RDR|CNT|RES} (020):Fan Tray Slot 1:{S|RDR|CNT|RES} (021):PPS BMC:{S|RDR|ELOG|INV|PWR|FRU|CNT|RES|DIMI} (022):Shelf EEPROM 1:{S|RDR|INV|PWR|FRU|CNT|HS|RES} (023):Shelf EEPROM 2:{S|RDR|INV|PWR|FRU|CNT|HS|RES} (024):Fan Tray:{S|RDR|INV|PWR|FRU|CNT|HS|RES} (025):AMC Carrier:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (026):AMC Slot 1:{S|RDR|FRU|CNT|RES} (027):AMC Slot 2:{S|RDR|FRU|CNT|RES} (028):ShMM-500:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES|DIMI}


Release 2.10.1.0 93 January 23, 2008

(029):AMC Module 1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (030):AMC Module 2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} RPT ID ==> 29 Entity's reset of 29 is not asserted now. OpenHPI> reset 29 cold Entity's reset of 29 is not asserted now. OpenHPI> reset 29 warm Entity's reset of 29 is not asserted now. OpenHPI>


Release 2.10.1.0 94 January 23, 2008

5.30 reopen

5.30.1 Syntax reopen [quick]

5.30.2 Purpose This command forces the connection to the HPI server to be closed and opened again. This command is useful when the session to the HPI server dies. If the quick flag is specified, hpi_shell tries to close old session only once and ignores the result of the session closing function. If the quick flag is not specified, hpi_shell continues trying to close the old session until the HPI server reports that the old session is closed or invalid.

5.30.3 Example OpenHPI> Connection has been aborted OpenHPI> reopen quick saHpiSessionClose error INVALID_SESSION Discovery done Enter a command or "help" for list of commands OpenHPI>


Release 2.10.1.0 95 January 23, 2008

5.31 rpt/showrpt

5.31.1 Syntax rpt [<resource id>] The verb showrpt can also be used instead of rpt.

5.31.2 Purpose This command provides information about the specified resource (as designated by the <resource id> parameter) from the RPT. If this parameter is omitted, the rpt command lists all the resources in the current domain and waits for the user to enter a <resource id>.

5.31.3 Example OpenHPI> rpt (001):Shelf Resource:{S|RDR|INV|CNT|RES} (002):OEM Slot 1:{S|RDR|CNT|RES} (003):ATCA Board Slot 1:{S|RDR|CNT|RES} (004):ATCA Board Slot 2:{S|RDR|CNT|RES} (005):ATCA Board Slot 3:{S|RDR|CNT|RES} (006):ATCA Board Slot 4:{S|RDR|CNT|RES} (007):ATCA Board Slot 5:{S|RDR|CNT|RES} (008):ATCA Board Slot 6:{S|RDR|CNT|RES} (009):ATCA Board Slot 7:{S|RDR|CNT|RES} (010):ATCA Board Slot 8:{S|RDR|CNT|RES} (011):ATCA Board Slot 9:{S|RDR|CNT|RES} (012):ATCA Board Slot 10:{S|RDR|CNT|RES} (013):ATCA Board Slot 11:{S|RDR|CNT|RES} (014):ATCA Board Slot 12:{S|RDR|CNT|RES} (015):ATCA Board Slot 13:{S|RDR|CNT|RES} (016):ATCA Board Slot 14:{S|RDR|CNT|RES} (017):ATCA Board Slot 15:{S|RDR|CNT|RES} (018):ATCA Board Slot 16:{S|RDR|CNT|RES} (019):Power Entry Module Slot 1:{S|RDR|CNT|RES} (020):Power Entry Module Slot 2:{S|RDR|CNT|RES} (021):Shelf FRU Information Slot 1:{S|RDR|CNT|RES} (022):Shelf FRU Information Slot 2:{S|RDR|CNT|RES} (023):Dedicated ShMc Slot 1:{S|RDR|CNT|RES} (024):Dedicated ShMc Slot 2:{S|RDR|CNT|RES} (025):Fan Tray Slot 1:{S|RDR|CNT|RES} (026):Fan Tray Slot 2:{S|RDR|CNT|RES} (027):Fan Tray Slot 3:{S|RDR|CNT|RES} (028):Alarm Slot 1:{S|RDR|CNT|RES} (029):PPS BMC:{S|RDR|ELOG|INV|PWR|FRU|CNT|WTD|RES|DIMI} (030):Shelf EEPROM 1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (031):Shelf EEPROM 2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (032):SAP Board:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES|DIMI} (033):Fan Tray 0:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (034):Fan Tray 1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (035):Fan Tray 2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (036):PEM A:{S|RDR|RST|PWR|FRU|CNT|HS|RES} (037):PEM B:{S|RDR|RST|PWR|FRU|CNT|HS|RES}


Release 2.10.1.0 96 January 23, 2008

(038):ATCA Demo Board:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI} (039)::{S|RDR|WTD|RES} (040)::{S|RDR|WTD|RES} (041):ShMM-500:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI} (042):ShMM-500:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI} RPT ID ==> 33 EntryId: 33 ResourceId: 33 ResourceInfo: ResourceRev: 0 SpecificVer: 0 DeviceSupport: 0 ManufacturerId: 0 ProductId: 0 FirmwareMajorRev: 0 FirmwareMinorRev: 0 AuxFirmwareRev: 0 Guid: ResourceEntity: {SYSTEM_CHASSIS,1}{FAN_TRAY_SLOT,1}{COOLING_UNIT,1} Capabilities: CONTROL | FRU | INVENTORY_DATA | MANAGED_HOTSWAP | POWER | RDR | RESET | RESOURCE | SENSOR HotSwapCapabilities: INDICATOR_SUPPORTED ResourceSeverity: OK ResourceFailed: FALSE Tag: TEXT: ENGLISH: Fan Tray 0 (len=10)


Release 2.10.1.0 97 January 23, 2008

5.32 run

5.32.1 Syntax run <file name>

5.32.2 Purpose This command opens the specified file, reads hpi_shell commands from it, line by line, and executes them in the current instance of hpi_shell.

5.32.3 Example OpenHPI> exec cat /tmp/x more OpenHPI> run /tmp/x more = NO


Release 2.10.1.0 98 January 23, 2008

5.33 sen

5.33.1 Syntax sen [<resource id>[<sensor instrument num>]]

5.33.2 Purpose This command provides information about a specific sensor of a specified resource. <sensor instrument num> is the number of a sensor instrument associated with the specified resource. If the < sensor instrument num> parameter is omitted, the command lists the resources with the specified <resource id>. When this command is invoked without any parameters, it lists all the resources in the current domain and waits for the user to enter a <resource id> and then a <sensor instrument num> for that resource. The sen command enters a sensor command block for the specified resource. Sensor command blocks support the following subcommands: disable, evtdis, enable, evtenb, maskadd, maskrm, show; these subcommands are described in subsections below.

5.33.3 Example OpenHPI> sen (001):Shelf Resource:{S|RDR|INV|CNT|RES} (084):OEM Slot 1:{S|RDR|CNT|RES} (002):ATCA Board Slot 1:{S|RDR|CNT|RES} (003):ATCA Board Slot 2:{S|RDR|CNT|RES} (004):ATCA Board Slot 3:{S|RDR|CNT|RES} (005):ATCA Board Slot 4:{S|RDR|CNT|RES} (006):ATCA Board Slot 5:{S|RDR|CNT|RES} (007):ATCA Board Slot 6:{S|RDR|CNT|RES} (008):ATCA Board Slot 7:{S|RDR|CNT|RES} (009):ATCA Board Slot 8:{S|RDR|CNT|RES} (010):ATCA Board Slot 9:{S|RDR|CNT|RES} (011):ATCA Board Slot 10:{S|RDR|CNT|RES} (012):ATCA Board Slot 11:{S|RDR|CNT|RES} (013):ATCA Board Slot 12:{S|RDR|CNT|RES} (014):ATCA Board Slot 13:{S|RDR|CNT|RES} (015):ATCA Board Slot 14:{S|RDR|CNT|RES} (016):ATCA Board Slot 15:{S|RDR|CNT|RES} (017):ATCA Board Slot 16:{S|RDR|CNT|RES} (085):Power Entry Module Slot 1:{S|RDR|CNT|RES} (086):Power Entry Module Slot 2:{S|RDR|CNT|RES} (025):Shelf FRU Information Slot 1:{S|RDR|CNT|RES} (026):Shelf FRU Information Slot 2:{S|RDR|CNT|RES} (027):Dedicated ShMc Slot 1:{S|RDR|CNT|RES} (028):Dedicated ShMc Slot 2:{S|RDR|CNT|RES} (029):Fan Tray Slot 1:{S|RDR|CNT|RES} (087):Fan Tray Slot 2:{S|RDR|CNT|RES}


Release 2.10.1.0 99 January 23, 2008

(018):PPS BMC:{S|RDR|ELOG|INV|PWR|FRU|CNT|WTD|RES|DIMI} (030):Shelf EEPROM 1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (031):Shelf EEPROM 2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (088):ADPEM1:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (089):ADPEM2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (090):Fan Tray 2:{S|RDR|INV|RST|PWR|FRU|CNT|HS|RES} (033):ShMM-500:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI} (091):ATCA Demo Board:{S|RDR|INV|RST|PWR|FRU|CNT|WTD|HS|RES|DIMI} (092)::{S|RDR|WTD|RES} (093)::{S|RDR|WTD|RES} RPT ID ==> 1 (135168):SENSOR_RDR INSTRUMENT NUM=4096 Ctrl=0 EvtCtrl=RO Tag=Shelf FRU Information Valid (135936):SENSOR_RDR INSTRUMENT NUM=4864 Ctrl=1 EvtCtrl=WR Tag=FRU Power On Sequence Commit Status SENSOR_RDR INSTRUMENT NUM ==> 4096 Sensor(1/4096) OPERATIONAL Shelf FRU Information Valid Enable event : Disable supported: 0x0003 masks: assert = 0x0000 deassert = 0x0000 Event states = 0x2 Reading not supported sensor block ==>

5.33.4 disable

5.33.4.1 Syntax disable

5.33.4.2 Purpose The disable subcommand disables sensor polling for the current sensor.

5.33.4.3 Example sensor block ==> disable Sensor:(38/2) Disable

5.33.5 enable

5.33.5.1 Syntax enable

5.33.5.2 Purpose The enable subcommand enables sensor polling for the current sensor.

5.33.5.3 Example sensor block ==> enable Sensor:(38/2) Enable


Release 2.10.1.0 100 January 23, 2008

5.33.6 evtdis

5.33.6.1 Syntax evtdis

5.33.6.2 Purpose The evtdis subcommand disables sensor events for the current sensor.

5.33.6.3 Example sensor block ==> evtdis Sensor:(38/2) event Disable

5.33.7 evtenb

5.33.7.1 Syntax evtenb

5.33.7.2 Purpose The evtenb subcommand enables sensor events for the current sensor.

5.33.7.3 Example sensor block ==> evtenb Sensor:(38/2) event Enable

5.33.8 maskadd

5.33.8.1 Syntax maskadd

5.33.8.2 Purpose The maskadd subcommand adds assertion or/and deassertion masks for the current sensor.

5.33.8.3 Example sensor block ==> maskadd Assert mask = 0x0003 Deassert mask = 0x0000 Sensor:(2/4112) add masks: assert = 0x0003 deassert = 0x0000 (yes/no)?yes

5.33.9 maskrm

5.33.9.1 Syntax maskrm


Release 2.10.1.0 101 January 23, 2008

5.33.9.2 Purpose The subcommand maskrm removes assertion or/and deassertion masks for the current sensor.

5.33.9.3 Example sensor block ==> maskrm Assert mask = 0x0003 Deassert mask = 0x0000 Sensor:(2/4112) remove masks: assert = 0x0003 deassert = 0x0000 (yes/no)?yes sensor block ==> show Sensor(38/2) TEMPERATURE emulated temp Enable event : Enable supported: 0x003f masks: assert = 0x003f deassert = 0x003f Event states = 0x0 Reading Value = 50.000 Lower Minor Threshold(RW) 3.000 Lower Major Threshold(RW) 0.000 Lower Critical Threshold(RW) -5.000 Upper Minor Threshold(RW) 70.000 Upper Major Threshold(RW) 80.000 Upper Critical Threshold(RW) 90.000 Positive Threshold Hysteresis 1.000 Negative Threshold Hysteresis 1.000 sensor block ==>

5.33.10 setthres

5.33.10.1 Syntax setthres

5.33.10.2 Purpose The setthres subcommand prompts for changes in the thresholds of the current sensor.

5.33.10.3 Example sensor block ==> setthres Range ( -128.000: 127.000) Lower Minor:( 3.000) ==> Lower Major:( 0.000) ==> Lower Critical:( -5.000) ==> Upper Minor:( 70.000) ==> 75 Upper Major:( 80.000) ==> Upper Critical:( 90.000) ==> Positive Hysteresis:( 1.000) ==> Negative Hysteresis:( 1.000) ==> Lower Critical: -5.000 Lower Major: 0.000 Lower Minor: 3.000 Upper Critical: 90.000 Upper Major: 80.000 Upper Minor: 75.000 Positive Hysteresis: 1.000


Release 2.10.1.0 102 January 23, 2008

Negative Hysteresis: 1.000 Set new threshold (yes|no) : yes Sensor Threshold Value Set Succeed.

5.33.11 show

5.33.11.1 Syntax show

5.33.11.2 Purpose This subcommand shows the state of the current sensor.

5.33.11.3 Example sensor block ==> show Sensor(2/4112) ENTITY_PRESENCE Slot State Sensor Enable event : Disable supported: 0x0003 masks: assert = 0x0000 deassert = 0x0000 Event states = 0x2 Reading Value = 29


Release 2.10.1.0 103 January 23, 2008

5.34 setsever

5.34.1 Syntax setsever [<resource id> [severity type]]

5.34.2 Purpose This command sets the minimum severity of events for the specified resource that are placed in the event log. The new severity level is one of the following (listed in order of decreasing severity): crit, maj, min, inf, ok, debug, all.

5.34.3 Example OpenHPI> setsever 038 maj EntryId: 38 ResourceId: 38 ResourceInfo: ResourceRev: 0 SpecificVer: 0 DeviceSupport: 41 ManufacturerId: 16394 ProductId: 48830 FirmwareMajorRev: 1 FirmwareMinorRev: 41 AuxFirmwareRev: 0 Guid: ResourceEntity: {SYSTEM_CHASSIS,1}{PHYSICAL_SLOT,15}{PICMG_FRONT_BLADE,15} Capabilities: CONTROL | FRU | INVENTORY_DATA | MANAGED_HOTSWAP | POWER | RDR | RESET | RESOURCE | SENSOR HotSwapCapabilities: INDICATOR_SUPPORTED ResourceSeverity: MAJOR ResourceFailed: FALSE Tag: TEXT: ENGLISH: ATCA Demo Board (len=15)


Release 2.10.1.0 104 January 23, 2008

5.35 settag

5.35.1 Syntax settag <resource id> [<tag string>]

5.35.2 Purpose The settag command sets the tag for the specified resource. If the <tag string> parameter is omitted, the command prompts for it.

5.35.3 Example OpenHPI> settag 38 New tag: test EntryId: 38 ResourceId: 38 ResourceInfo: ResourceRev: 0 SpecificVer: 0 DeviceSupport: 41 ManufacturerId: 16394 ProductId: 48830 FirmwareMajorRev: 1 FirmwareMinorRev: 41 AuxFirmwareRev: 0 Guid: ResourceEntity: {SYSTEM_CHASSIS,1}{PHYSICAL_SLOT,15}{PICMG_FRONT_BLADE,15} Capabilities: CONTROL | FRU | INVENTORY_DATA | MANAGED_HOTSWAP | POWER | RDR | RESET | RESOURCE | SENSOR HotSwapCapabilities: INDICATOR_SUPPORTED ResourceSeverity: OK ResourceFailed: FALSE Tag: test OpenHPI>


Release 2.10.1.0 105 January 23, 2008

5.36 settimeevtlog

5.36.1 Syntax settimeevtlog [<resource id>]

5.36.2 Purpose This command sets date and time for the event log of the specified resource. If the <resource id> is omitted, this command sets the date and time for the current domain event log.

5.36.3 Example OpenHPI> settimeevtlog 38 Set date and time for Resource 38! format: MM:DD:YYYY:hh:mm:ss ==> 01:01:2007:00:00:00 OpenHPI> evtlogtime Current event log time: 2007-01-01 00:00:03


Release 2.10.1.0 106 January 23, 2008

5.37 showevtlog

5.37.1 Syntax showevtlog [<resource id>]

5.37.2 Purpose The showevtlog command shows event log for the specified resource. If the <resource id> is omitted, the command shows the event log of the current domain.

5.37.3 Example OpenHPI> showevtlog EventLog: entries = 4, size = 10000, enabled = 1 UpdateTime = 2007-01-22 19:27:30 CurrentTime = 2007-01-22 19:27:33 Overflow = 0 EntryId: 1 Timestamp: 2007-01-22 19:27:25 Event Type: OEM From Resource: {SYSTEM_CHASSIS,1}{PHYSICAL_SLOT,10}{PICMG_FRONT_BLADE,10} Event Resource ID: 38 Event Timestamp: 2007-01-22 19:27:25 Event Severity: INFORMATIONAL OemEvent: ManufacturerId: Unknown Manufacturer OemEventData: Data Type: TEXT Language: ENGLISH Data Length: 3 Data: Data(Bin): 0 3 0 .. ..EntryId: 2 Timestamp: 2007-01-22 19:27:25 Event Type: HOTSWAP From Resource: {SYSTEM_CHASSIS,1}{PHYSICAL_SLOT,10}{PICMG_FRONT_BLADE,10} Event Resource ID: 38 Event Timestamp: 2007-01-22 19:27:25 Event Severity: INFORMATIONAL HotswapEvent: HotSwapState: INSERTION_PENDING PreviousHotSwapState: INACTIVE .. ..EntryId: 3 Timestamp: 2007-01-22 19:27:30 Event Type: OEM From Resource: {SYSTEM_CHASSIS,1}{PHYSICAL_SLOT,10}{PICMG_FRONT_BLADE,10} Event Resource ID: 38 Event Timestamp: 2007-01-22 19:27:30 Event Severity: INFORMATIONAL


Release 2.10.1.0 107 January 23, 2008

OemEvent: ManufacturerId: Unknown Manufacturer OemEventData: Data Type: TEXT Language: ENGLISH Data Length: 3 Data: Data(Bin): 1 0 1 .. ..EntryId: 4 .. Timestamp: 2007-01-22 19:27:30 Event Type: HOTSWAP From Resource: {SYSTEM_CHASSIS,1}{PHYSICAL_SLOT,10}{PICMG_FRONT_BLADE,10} Event Resource ID: 38 Event Timestamp: 2007-01-22 19:27:30 Event Severity: INFORMATIONAL HotswapEvent: HotSwapState: ACTIVE PreviousHotSwapState: INSERTION_PENDING


Release 2.10.1.0 108 January 23, 2008

5.38 ver

5.38.1 Syntax ver

5.38.2 Purpose This command displays the hpi_shell version and the HPI specification version that is implemented by the HPI service that is serving this hpi_shell.

5.38.3 Example OpenHPI> ver Package version: 2.10.1 HPI specification version: SAI_HPI-B.02.01


Release 2.10.1.0 109 January 23, 2008

5.39 wtdget

5.39.1 Syntax wtdget [<resource id> [<watchdog instrument num>]]

5.39.2 Purpose This command shows the watchdog timer state for the specified resource. If the <resource id> parameter is omitted, the command prompts for it. If the <watchdog instrument num> is omitted, the command prompts for it.

5.39.3 Example OpenHPI> wtdget 29 (262144):WATCHDOG_RDR INSTRUMENT NUM=000 Tag=Watchdog WATCHDOG_RDR INSTRUMENT NUM ==> 0 Watchdogtimer (29/0): Log=TRUE Stopped Timer Use: NONE Action: NO_ACTION Interrupt: NONE TimeOut: 0 Flags: (null) InitialCount = 0 PresentCount = 0 OpenHPI> wtdget 29 0 Watchdogtimer (29/0): Log=TRUE Stopped Timer Use: NONE Action: NO_ACTION Interrupt: NONE TimeOut: 0 Flags: (null) InitialCount = 0 PresentCount = 0


Release 2.10.1.0 110 January 23, 2008

5.40 wtdreset

5.40.1 Syntax wtdget [<resource id> [<watchdog instrument num>]]

5.40.2 Purpose This command starts or restarts the watchdog timer at the initial countdown level. If the <resource id> parameter is omitted, the command prompts for it. If the <watchdog instrument num> is omitted, the command prompts for it.

5.40.3 Example OpenHPI> wtdreset 29 0 OpenHPI>


Release 2.10.1.0 111 January 23, 2008

5.41 wtdset

5.41.1 Syntax wtdset [<resource id> [<watchdog instrument num>]]

5.41.2 Purpose This command initializes and configures the watchdog timer for the specified resource. The command can also stop the timer. If the <resource id> parameter is omitted, the command prompts for it. If the <watchdog instrument num> is omitted, the command prompts for it. The command prompts the user for the watchdog timer state fields: watchdog timer action, watchdog timer use and expiration flags, watchdog timer event logging, pre-timeout interrupt, and initial countdown value. The fields are described in detail in Chapter 21 “BMC Watchdog Timer Commands” of the IPMI specification, v1.5.

5.41.3 Example OpenHPI> wtdset 29 0 Log(0 | 1): 1 Running(0 | 1): 0 TimerUse(none|bios_frb2|bios_post|os_load|sms_os|oem): sms_os TimerAction(no|reset|pwr_down|pwr_cycle|int): no PretimerInterrupt(no|smi|nmi|mess|oem): no TimeOut: 0 Flags("bios_frb2|bios_post|os_load|sms_os|oem"): sms_os InitialCount: 400


Release 2.10.1.0 112 January 23, 2008

6 Developing HPI-based applications This chapter describes how to build and run an HPI application using Pigeon Point OpenHPI. It includes a simple sample application. The following items are required to compile and build an HPI B.02.01 application. SaHpi.h This is the official HPI B02.01 header file, which is required to create any HPI B.02.01 application. You can find it on the SAF web site (http://www.saforum.org). SaHpiAtca.h This is an ATCA-specific header file that provides definitions and symbols for all Standard Resources and Management Instruments modeling different aspects and entities of an ATCA platform. An ATCA-specific HPI applications can use the symbols defined in SaHpiAtca.h to directly call out ATCA specific Resources, Sensors and Controls. This file is also available on the SAF web site. libopenhpi.so This is the OpenHPI client library for Linux; applications need to link with it to connect with the HPI server. To run any HPI client application that links with the OpenHPI Client Library, libopenhpi.so, do the following:

• Build and install the HPI client library, libopenhpi.so, and set the LD_LIBRARY_PATH environment variable to the location of the installed library. Convert the IPv4 address to a binary format (DomainID is defined as a 32-bit unsigned integer and would not be able to accept an ASCII-formatted IPv4 address).

• Ensure that an OpenHPI server is installed, configured and accessible, using either the on-

ShMM or off-ShMM models (see sections 2, 3 and 4).

• To open sessions to a remote HPI server it is necessary to create an environment variable OPENHPI_DAEMON_HOST and set it to the IP address of the HPI server. For the on-ShMM configuration, this IP address must be the RMCP IP address of the active Shelf Manager. For example, the following Linux shell command creates and exports the environment variable OPENHPI_DAEMON_HOST to the Shelf Manager IP address XX.XX.XX.XX:

> export OPENHPI_DAEMON_HOST=XX.XX.XX.XX The HPI client library searches for this environment variable when a request to open a session is received. If this variable is not set, the function SaHpiOpenSession will return the error code SA_ERR_HPI_INVALID_DOMAIN

http://www.saforum.org/�


Release 2.10.1.0 113 January 23, 2008

6.1 Simple HPI Application Example A simple example HPI application appears below. The application opens an HPI session using SaHpiSessionOpen and retrieves the interface version identifier using SaHpiVersionGet. Then, the application retrieves all the RPT entries for the session using SaHpiRptEntryGet, outputs information about them and closes the session. //hpitest.cpp #include <stdio.h> #include <stdlib.h> #include <string.h> extern "C" { #include "SaHpi.h" } int main() { SaErrorT error; SaHpiSessionIdT session_id; SaHpiVersionT ver; SaHpiEntryIdT rpt_entry_id, rpt_next_entry_id; SaHpiRptEntryT rpt_entry; error = saHpiSessionOpen( SAHPI_UNSPECIFIED_DOMAIN_ID, &session_id, 0 ); if ( error != SA_OK ) { fprintf( stderr, "#Error: %d:saHpiSessionOpen() failed\n", error ); return 1; } /* Retrieve and print the interface version identifier */ ver = saHpiVersionGet(); fprintf( stdout, "\nThe interface version identifier is %02d.%02d.%02d\n\n", ( ver & 0x00ff0000 ) >> 16, ( ver & 0x0000ff00 ) >> 8, ( ver & 0x000000ff ) ); fprintf( stdout, "Resource ID : Resource Tag\n"); rpt_entry_id = SAHPI_FIRST_ENTRY; do { /* Get RPT entry */ error = saHpiRptEntryGet( session_id, rpt_entry_id, &rpt_next_entry_id, &rpt_entry ); if ( error != SA_OK ) {


Release 2.10.1.0 114 January 23, 2008

fprintf( stderr, "#Error: %d:saHpiRptEntryGet() failed\n", error ); saHpiSessionClose( session_id ); return 1; } /* Display RPT */ fprintf( stdout, " (%03d) : %s\n", rpt_entry.ResourceId, rpt_entry.ResourceTag.Data ); rpt_entry_id = rpt_next_entry_id; } while( rpt_next_entry_id != SAHPI_LAST_ENTRY ); /* Close session and exit */ saHpiSessionClose( session_id ); return 0; }

6.2 Building and Running HPI Applications The makefile for the test program specifies the -pipe flag and the include directory for compilation (-I.). The OpenHPI library is linked to the application (as specified by the –lopenhpi option). You may also specify the OPENHPI_DAEMON_HOST configuration variable in this makefile. #Makefile CPP = g++ TARGET = hpitest CFLAGS = -Wall -pipe -I. # assume SaHpi.h is in the local directory LDFLAGS = -L. -lopenhpi # assume libopenhpi.so is in the local directory OPENHPI_DAEMON_HOST=192.168.1.149 # set to OpeHPI daemon IP address all: $(TARGET) OPENHPI_DAEMON_HOST=$(OPENHPI_DAEMON_HOST) $(TARGET) $(TARGET): $(TARGET).o $(CPP) -o $(TARGET) $(TARGET).o $(LDFLAGS) %.o: %.cpp $(CPP) $(CFLAGS) -c $< -o $@ clean: rm -f *.o core clobber: clean rm -f $(TARGET) To build the application hpitest, type: # make hpitest g++ -Wall -pipe -I. -c hpitest.cpp -o hpitest.o g++ -o hpitest hpitest.o -L. -lopenhpi


Release 2.10.1.0 115 January 23, 2008

To run the application, type: # OPENHPI_DAEMON_HOST=<IP address> ./hpitest To build and run this application, type: # make all g++ -Wall -pipe -I. -c hpitest.cpp -o hpitest.o g++ -o hpitest hpitest.o -L. -lopenhpi OPENHPI_DAEMON_HOST=192.168.1.149 hpitest ... This program executes and sends its results (RPT information, including the resource ID and resource tag for each resource) to standard output, as shown below. The interface version identifier is 02.01.01 Resource ID : Resource Tag (001) : Shelf Resource (084) : OEM Slot 1 (002) : ATCA Board Slot 1 (003) : ATCA Board Slot 2 (004) : ATCA Board Slot 3 (005) : ATCA Board Slot 4 (006) : ATCA Board Slot 5 (007) : ATCA Board Slot 6 (008) : ATCA Board Slot 7 (009) : ATCA Board Slot 8 (010) : ATCA Board Slot 9 (011) : ATCA Board Slot 10 (012) : ATCA Board Slot 11 (013) : ATCA Board Slot 12 (014) : ATCA Board Slot 13 (015) : ATCA Board Slot 14 (016) : ATCA Board Slot 15 (017) : ATCA Board Slot 16 (085) : Power Entry Module Slot 1 (086) : Power Entry Module Slot 2 (025) : Shelf FRU Information Slot 1 (026) : Shelf FRU Information Slot 2 (027) : Dedicated ShMc Slot 1 (028) : Dedicated ShMc Slot 2 (029) : Fan Tray Slot 1 (087) : Fan Tray Slot 2 (018) : PPS BMC (030) : Shelf EEPROM 1 (031) : Shelf EEPROM 2 (088) : ADPEM1 (089) : ADPEM2 (090) : Fan Tray 2 (033) : ShMM-500 (091) : ATCA Demo Board (092) : (093) :


Release 2.10.1.0 116 January 23, 2008

7 Simple Network Management Protocol (SNMP) Pigeon Point OpenHPI includes support a Simple Network Management Protocol (SNMP) interface to the HPI server using a platform-independent Management Information Base (MIB) defined by the SAF.

7.1 Overall Approach Figure 5 shows the Pigeon Point OpenHPI SNMP architecture, including both the off-ShMM and on-ShMM models.


Release 2.10.1.0 117 January 23, 2008

Figure 5 Pigeon Point OpenHPI SNMP Models


Release 2.10.1.0 118 January 23, 2008

An SNMP client requests an HPI variable according to the MIB. This request is passed to SNMP daemon (snmpd) which passes the request to the OpenHPI subagent (hpiSubagent). The HPI subagent implements the HPI-B0101-MIB tree. (There is no updated MIB for the B.02.01 specification available on the SA Forum website.) This MIB provides the conversion between the object identifiers (OIDs) and human-readable names of SNMP variables (see section 7.3). If the HPI-B0101-MIB is available to the SNMP client (in the binary form produced by a MIB compiler), the SNMP clent can use human-readable names of SNMP variables in snmpget / snmpset / snmpwalk commands (see section 7.4). snmpd is an extensible agent based on the Net-SNMP implementation (http://net-snmp.sourceforge.net/) that responds to SNMP compliant requests for management information. This agent includes built-in support for a range of MIB modules and can be extended using dynamically loaded modules, external scripts and commands. In the off-ShMM case, snmpd can be a straight build of a compatible version of Net-SNMP. In the on-ShMM case, snmpd is already present on the ShMM to serve the Pigeon Point Shelf Manager’s proprietary SNMP MIB. The OpenHPI subagent executes as an independent process and uses the AgentX protocol to interact with the SNMP agent. The subagent implements the SAF-defined SNMP MIB by making HPI API calls. The subagent connects with the OpenHPI daemon just like any other OpenHPI-based application would. Also as usual in servicing those calls, the OpenHPI daemon interacts with the Pigeon Point Shelf Manager through through the Pigeon Point plug-in as described in section 2.

7.2 Launching OpenHPI SNMP The OpenHPI daemon must be operating before HPI subagent can be launched. Also, the SNMP daemon must be launched before the subagent. The HPI subagent may execute on a management system where neither the HPI server nor the SNMP daemon runs. To enable AgentX functionality in an SNMP daemon, a master agentx line must be added in the SNMP daemon configuration file (see 7.4.2). The configuration variable agentXSocket in an SNMP configuration file defines the communication transport between a SNMP daemon and a HPI subagent. If this variable is not set, an SNMP daemon creates a UNIX domain socket /var/agentx/master for communication with a HPI subagent. For further details, please see the Net-SNMP documentation for the snmpd.conf configuration file. The HPI daemon IP address is obtained by the HPI subagent from the environment variable OPEHNHPI_DAEMON_HOST. If this variable is not set, the HPI subagent connects to the localhost. Here is an example of launching both the SNMP agent and the OpenHPI subagent on the ShMM: # daemon -f snmpd -c /etc/snmpd.conf # daemon -f hpiSubagent




Release 2.10.1.0 119 January 23, 2008

If the SNMP agent (snmpd) is already operational (say, as a consequence of automatic configuration steps for the ShMM), the first line above is not necessary and should be omitted. The HPI server in this example configuration may be operating either on-ShMM or off-ShMM, depending on the OPEHNHPI_DAEMON_HOST variable mentioned above.

7.3 SNMP Variables Consistent with the SNMP architecture, the variables defined by the HPI MIB are represented by a hierarchical data model, with each variable associated with an object identifier (OID). These object identifiers have a common root OID, as follows: iso(1).org(3).dod(6).internet(1).private(4).enterprises(1).saforum(18568).draft(2).hpiD(1).hpiB0101(1) 18568 is the enterprise number assigned to the Service Availability Forum. In the remainder of this section, the root OID is denoted as <ROOT_OID>. The structure of the branches of the SNMP variables tree for HPI is described in the SAF MIB. The key groups of variables in that MIB are listed in Table 9, along with their OIDs and a brief description of each group. Table 9 Key Groups of HPI Variables

NAME OF VARIABLE GROUP OID DESCRIPTION saHpiDomainInfoTable <ROOT_OID>.2.2 This table represents the management

attributes for all the domains within the managed platform.

saHpiDomainAlarmTable <ROOT_OID>.2.6 This table represents the contents of the Alarm Table for all domains.

saHpiResourceTable <ROOT_OID>.2.8 This table provides access to the Resource Presence Table for all the resource capabilities of all domains.

hpiHotSwap <ROOT_OID>.2.11 This branch represents hot swap attributes of all known resources including current state, indicator LED state, insert/extract timeouts and processing requests.

hpiEvents <ROOT_OID>.3 This branch represents contents of the event log table with all event attributes.

saHpiRdrTable <ROOT_OID>.4.2 This table represents all Resource Data Records in the system repository.

hpiControl <ROOT_OID>.4.7 This branch represents all the controls in the system with their attributes.


Release 2.10.1.0 120 January 23, 2008

NAME OF VARIABLE GROUP OID DESCRIPTION hpiInventory <ROOT_OID>.4.8 This branch represents static data

associated with Inventory Repository Data .

hpiSensor <ROOT_OID>.4.9 This branch represents all the sensors in the system with their attributes.

hpiWatchdogTable <ROOT_OID>.4.4 This branch represents static and dynamic watchdog information, including watchdog RDR data

For more information regarding SNMP variables for HPI, please see the MIB, itself (HPI-B0101-MIB).

7.4 Accessing the OpenHPI Server via SNMP Any SNMP client implementation can access the OpenHPI-defined variables. One specific choice that we have used successfully is the net-snmp-5.3.xx package (http://net-snmp.sourceforge.net/). This package is installed on the management computer (running Linux kernel 2.4.2 and higher). It provides some basic management tools. The snmpget and snmpwalk commands provide access to the OpenHPI SNMP infrastructure. First, you need to install the HPI MIB file on your management system, following the instructions supplied with the Net-SNMP package. After that, use the snmpget and snmpwalk commands to access variables of interest. Human-readable names of variables are available. If the HPI-B0101-MIB is not installed on your management system, then snmpget, snmpset and snmpwalk commands can access SNMP variables by specifying their OIDs, but human-readable names of variables will not be available. Net-SNMP supports both version 2c and version 3 of the SNMP protocol. The following sections cover specific usage aspects for these two protocol versions. In either case, you need an IP address of the SNMP daemon that is representing the OpenHPI subagent. In the example of section 7.2, the IP address of the SNMP daemon is the same as the RMCP IP address of the Shelf manager.

7.4.1 SNMPv2c For version 2c protocol access, use the –v 2c option when invoking a Net-SNMP command. For example, to retrieve HPI domain tag, use the following command: # snmpget -v 2c <IP address> -c public .1.3.6.1.4.1.18568.2.1.1.2.2.1.6.1 or # snmpget -v 2c <IP address> -c public HPI-B0101-MIB::saHpiDomainTag Either command results in output similar to the following:



Release 2.10.1.0 121 January 23, 2008

HPI-B0101-MIB::saHpiDomainTag.1 = STRING: “First Domain” To retrieve the entire HPI variables subtree, use the following command: # snmpwalk -v 2c <IP address> -c public .1.3.6.1.4.1.18568.2.1.1 or # snmpwalk -v 2c <IP address> -c public HPI-B0101-MIB::hpiB0101 The resulting output likely comprises several thousand lines. To use SNMP v1 instead of v2c, use a -v 1 option in the above command lines.

7.4.2 SNMPv3 In order to provide SNMPv3 functionality, the SNMP agent must be properly configured. An example snmpd.conf file is provided below. It should be reside in the /etc directory. This example shows how to configure user name overlord (with password possessor), which has read-write rights and SNMPv3 access to the SNMP agent. In order to access the SNMP agent in SNMPv3 mode, use commands like the following, including a –v 3 option. For example, to retrieve HPI domain tag, use the following command: # snmpget -v 3 -u overlord -l authNoPriv -a MD5 -A possessor <IP address> .1.3.6.1.4.1.18568.2.1.1.2.2.1.6.1 or # snmpget -v 3 -u overlord -l authNoPriv -a MD5 -A possessor <IP address> HPI-B0101-MIB::saHpiDomainTag Either command results in output similar to the following: HPI-B0101-MIB::saHpiDomainTag.1 = STRING: “First Domain” To retrieve the entire HPI variables subtree, use the following command: # snmpwalk -v 3 -u overlord -l authNoPriv -a MD5 -A possessor <IP address> HPI-B0101-MIB::hpiB0101 The resulting output likely comprises several thousand lines. Here is an example configuration file for the net-snmp agent: ############################################################################### #


Release 2.10.1.0 122 January 23, 2008

# snmpd.conf: configuration file for the Net-SNMP agent. # ############################################################################### # # All lines beginning with a '#' are comments and are intended for you to read. # All other lines are configuration commands for the agent. # See snmpd.conf(5) manual page for further details. # ############################################################################### # Access Control ############################################################################### # # By default, the agent responds to the "public" community for read-only access # if run out of the box without any configuration file in place. The following # user configuration is needed for SNMP v3 access. Also AgentX support in SNMP # master agent is enabled in this section. # rwuser overlord createUser overlord MD5 possessor DES engineID "PPS_ShMM_NetSNMPd" master agentx # The following lines change the access permissions of the agent so that the # COMMUNITY string provides read-only access to your entire NETWORK (default), # and read/write access only to localhost (127.0.0.1, not its real ipaddress). # Note that it is needed for SNMP versions 1 and 2. #### # First, map "public" community name (COMMUNITY) into a security name # (local and mynetwork, depending on where the request is coming from): # # sec.name source community com2sec local localhost public com2sec mynetwork default public #### # Second, map the security names into group names: # # sec.model sec.name group MyRWGroup v1 local group MyRWGroup v2c local group MyRWGroup usm local group MyRWGroup v1 mynetwork group MyRWGroup v2c mynetwork group MyRWGroup usm mynetwork


Release 2.10.1.0 123 January 23, 2008

#### # Third, create a view for us to let the groups have rights to: # # incl/excl subtree mask view all included .1 80 #### # Finally, grant the 2 groups access to the 1 view with different write # permissions: # # context sec.model sec.level match read write notif access MyROGroup "" any noauth exact all none none access MyRWGroup "" any noauth exact all all none ############################################################################### # System contact information ############################################################################### # # It is possible to set the sysContact and sysLocation system variables through # the snmpd.conf file: # syslocation PPS Shelf Manager Mezzanine Module syscontact PPS <[email protected]>


Release 2.10.1.0 124 January 23, 2008

8 Trouble-shooting If the <logfile> variable of the Pigeon Point plug-in is set to a valid file name prefix, OpenHPI daemon actions and error conditions are logged into the file designated by that prefix, with .log appended to it. In the examples of this document, the OpenHPI log file is named openhpi.log (see the <logfile> option in section 3) and typically resides either in the directory where OpenHPI has been started or in the root directory for automatic startup. If you have problems with the OpenHPI daemon, you should look for information in the log file that sheds light on the problems. The following example of an OpenHPI log shows that the OpenHPI daemon has failed to connect to the Shelf Manager. Possibly the Shelf Manager RMCP IP address is different from the one specified in /etc/openhpi.conf file via the <addr> option. To retrieve the Shelf Manager RMCP IP address, use the clia getlanconfig 1 ip command. 2007.01.22 15:38:15.433 AllocConnection: IPMITimeout 5000 ms. 2007.01.22 15:38:15.435 AllocConnection: AtcaTimeout 1000 ms. 2007.01.22 15:38:15.435 AllocConnection: Enable SEL only on BMC. 2007.01.22 15:38:15.436 AllocConnection: Max Outstanding IPMI messages 0. 2007.01.22 15:38:15.436 AllocConnection: Don't poll alive MCs. 2007.01.22 15:38:15.436 IpmiAllocConnection: connection name = 'lan'. 2007.01.22 15:38:15.437 AllocConnection: addr = '192.168.0.2'. 2007.01.22 15:38:15.439 Using host at 192.168.0.2. 2007.01.22 15:38:15.440 AllocConnection: port = 623. 2007.01.22 15:38:15.440 AllocConnection: authority: md5(2). 2007.01.22 15:38:15.441 AllocConnection: priviledge = admin(4). 2007.01.22 15:38:15.442 AllocConnection: user = openhpi. 2007.01.22 15:38:15.445 using port 7001. 2007.01.22 15:38:15.446 >cmd 0x00 0c 0f 00 GetChannelAuthCapabilities (02) 0e 04 2007.01.22 15:38:20.452 resending RMCP msg. 2007.01.22 15:38:20.452 >cmd 0x01 0c 0f 00 GetChannelAuthCapabilities (02) 0e 04 2007.01.22 15:38:25.462 resending RMCP msg. 2007.01.22 15:38:25.462 >cmd 0x02 0c 0f 00 GetChannelAuthCapabilities (02) 0e 04 2007.01.22 15:38:30.472 resending RMCP msg. 2007.01.22 15:38:30.472 IPMI open connection fails ! 2007.01.22 15:38:30.582 #Info: Clear start: m_num=0 m_array=0 m_size=0 2007.01.22 15:38:30.583 #Info: Clear end: m_num=0 m_array=0 m_size=0


Release 2.10.1.0 125 January 23, 2008

Appendix A: Pigeon Point OpenHPI Version Control

The Pigeon Point plug-in implements a version control that provides version information regarding the OpenHPI service that implements this control. It is a read-only text control with the control number 32768 that belongs to Shelf Resource (Resource ID = 1). It has 3 text lines. Line 1 indicates the version of the HPI specification that the OpenHPI service implements. Line 2 identifies the the SourceForge-posted version of OpenHPI that is the basis for the OpenHPI service. Line 3 indicates the version of the Pigeon Point enhancements (including the Pigeon Point plug-in) that are included in the OpenHPI service. Here is an example of using this control: OpenHPI> ctrl 1 32768 Control(1/32768) Type: TEXT Output: GENERIC Mode: AUTO (Read Only) Data: MaxChars = 50 MaxLines = 3 Language = ENGLISH DataType = TEXT Default: Line # = 1 Text = HPI Version: B.02.01 control block ==> state 1 Control(1/32768) AUTO State: Line # = 1 Text = HPI spec version: B.02.01 control block ==> state 2 Control(1/32768) AUTO State: Line # = 2 Text = OpenHPI base version: 2.10.1 control block ==> state 3 Control(1/32768) AUTO State: Line # = 3 Text = Pigeon Point enhancements version: 2.10.1.0 control block ==> state 0 Control(1/32768) AUTO State: Line # = 0 Text = HPI spec version: B.02.01 OpenHPI base version: 2.10.1 Pigeon Point enhancements version: 2.10.1.0


Release 2.10.1.0 126 January 23, 2008

Appendix B: Pigeon Point IPMI Extension Dependencies

Pigeon Point OpenHPI (specifically the Pigeon Point plug-in) is designed to operate with the Pigeon Point Shelf Manager and depends on certain Pigeon Point extensions in the RMCP interface to the Shelf Manager. Specifically, full functionality of this release of the Pigeon Point plug-in requires support in the Shelf Manager for the following commands, which are all implemented in release 2.4.0 and later:

• “Notify Shelf Manager about an Extracted FRU” (NetFn 2Eh, Command Code 2h). If this command is not supported in the Shelf Manager, the Failed Resource Extract control does not work.

• “Initiate Shelf Manager Switchover” (NetFn 2Eh, Command Code 3h). If this command is not supported in the Shelf Manager, the Shelf Manager Failover control does not work.

• “Subscribe for Event Notifications” (NetFn 2Eh, Command Code 4h). If this command is not supported in the Shelf Manager, the plug-in polls the Shelf Manager’s System Event Log, which is less efficient, but still functional.

In addition, the following commands are available in the Shelf Manager starting with release 2.5.2 and their use can reduce the time it takes for the OpenHPI service to “discover” a shelf (that is, collect the necessary data from all the management controllers in the shelf):

• “Get Cached Device SDR Repository Info” (NetFn 2Eh, Command Code 6h) • “Get Cached Device SDR” (NetFn 2Eh, Command Code 7h) • “Reserve Cached Device SDR Repository” (NetFn 2Eh, Command Code 8h)

These commands allow the plug-in to access the SDRs of management controllers in the shelf from the cache maintained by the Shelf Manager, instead of from the controllers themselves over IPMB-0. This can save substantial time during startup of the OpenHPI service, especially if the Shelf Manager is already operational when the OpenHPI service starts. This facility is enabled by the plug-in handler configuration variable UseCachedSdrs. If the facility is enabled, the Pigeon Point plug-in attempts to use the above commands to optimize SDR fetching. However, if the plug-in discovers that the Shelf Manager does not support these commands, it resumes the default behavior in this area: fetching SDRs directly from the management controllers, themselves. Detailed descriptions of the commands listed in this section can be found in the Pigeon Point Shelf Manager External Interface Reference document.


Release 2.10.1.0 127 January 23, 2008

Appendix C: DIMI Support in Pigeon Point OpenHPI

Pigeon Point OpenHPI includes a basic implementation of the DIMI facility. However, users of this facility should keep in mind that the SA Forum has not specified any mapping in this area for ATCA shelves or any other domain. If and when such a mapping is specified by the SA Forum, Pigeon Point intends to support that mapping and won’t necessarily continue to support the preliminary mapping that is implemented now. In this release, hpi_shell supports a DIMI command block with set of DIMI subcommands that are detailed in section 5.7. The current DIMI facility is implemented on base of the IPMI Self Test facility. If an IPM controller supports the “Get Self Test Results” IPMI command, the HPI resource that represents this IPM controller is configured with a DIMI RDR. The “Get Self Test Results” command simply returns the results of self tests. The IPMI specification states that self tests are run on IPM controller power up as well as after a “Cold Reset”. The current DIMI support in the Pigeon Point plug-in creates a DIMI with two tests on each HPI resource that represents an IPM controller and successfully responds to the “Get Self Test Results” IPMI command:

• A safe DIMI test that is implemented by sending the “Get Self Test Results” command to the IPM controller

• A second DIMI test that is implemented by sending the “Cold Reset” and “Get Self Test Results” commands to the IPM controller.

A redundant Shelf Manager that receives a “Cold Reset” command performs a switchover to the backup. To avoid such a drastic effect, only the safe DIMI test is implemented for the logical active Shelf Manager HPI resource.


Release 2.10.1.0 128 January 23, 2008

Appendix D: FUMI Support in Pigeon Point OpenHPI

FUMI support in Pigeon Point OpenHPI is under development. Currently, hpi_shell supports a FUMI command block with a set of FUMI subcommands that are detailed in section 5.17. A mapping of the HPI FUMI facility to PICMG’s HPM.1 IPM Controller Firmware Upgrade architecture is under development for the Pigeon Point plug-in.

User Guide - Home | Pigeon Point · Pigeon Point OpenHPI User Guide Release 2.10.1.0 3 January 23,...

Documents

Transcript of User Guide - Home | Pigeon Point · Pigeon Point OpenHPI User Guide Release 2.10.1.0 3 January 23,...