1openhpi(7)                          OpenHPI                         openhpi(7)
2
3
4

NAME

6       openhpi - an implementation of the SA Forum's Hardware Platform Inter‐
7       face
8

DESCRIPTION

10       OpenHPI is an implementation of the SA Forum's Hardware Platform Inter‐
11       face, which provides a standard C library interface to manage, monitor,
12       and control hardware (both local and remote).
13
14       OpenHPI 1.x implements the HPI A.01.01 specification.  Both that spec
15       and OpenHPI 1.x are deprecated, and users should use HPI B.01.01 and
16       OpenHPI 2.x.
17
18       OpenHPI 2.x implements the HPI B.01.01 specification.
19

ENVIRONMENTAL VARIABLES

21       Some of OpenHPI's functioning can be changed by setting environment
22       variables.  This documents all known environmental settings and how
23       they affect OpenHPI.
24
25       OPENHPI_THREADED=YES
26           Turns on threading engine in OpenHPI, which spawns a thread to han‐
27           dle event harvesting and processing.  This is off by default, as it
28           isn't strictly needed for many uses of HPI.  However the BLOCK and
29           TIMED wait on the saHpiEventGet function can only be supported if
30           this is set.
31
32       OPENHPI_UID_MAP=FILENAME
33           The map file to use for persistant entitypath to resource id data‐
34           base.  By default /var/lib/openhpi/uid_map is used.  This allows
35           you to override that at run time.
36
37       OPENHPI_DEBUG=YES
38           Turns on debugging messages.  This will print additional text when
39           any error conditions arise.  If a problem is happening with
40           OpenHPI, it is good to turn on debugging to see if that shows more
41           information.
42
43       OPENHPI_CONF=FILENAME
44           Location of openhpi.conf file.  Default location is
45           /etc/openhpi/openhpi.conf.
46

HARDWARE SUPPORT

48       OpenHPI provides a number of plugins that talk to different hardware
49       types.  The following is a list of tested plugins in OpenHPI 2.x.
50
51       ipmi
52           An IPMI plugin that can talk locally (via smi interface and
53           OpenIPMI device driver) or remotely (via IPMI over LAN).  It sup‐
54           ports IPMI 1.5 for standard rackmount servers, and some of IPMI 2.0
55           for support of ATCA chassis.
56
57           IPMI plugin depends on libOpenIPMI version 1.4.x.
58
59       ipmidirect
60           An IPMI plugin designed specifically for ATCA chassis.  It imple‐
61           ments IPMI commands directly in the plugin.
62
63       snmp_bc
64           An SNMP based plugin that can communicate with IBM BladeCenter, as
65           well as IBM xSeries servers with RSA 1 adapters.
66
67           SNMP_BC plugin depends on net-snmp > 5.0.7.
68
69       sysfs
70           Current status??
71
72       watchdog
73           Current status??
74

OTHER DOCUMENTATION

76       The definitive guide to HPI is the SA Forum specification at
77       http://saforum.org.
78
79       More info on OpenHPI can be found at our webpage
80       (http://openhpi.sf.net) and our wiki (http://wiki.openhpi.org).
81

SEE ALSO

83       The following man pages may also be of interest
84
85       sahpi
86           Info on the SA HPI interface
87
88       openhpi.conf
89           Info on the openhpi.conf configuration file
90
91       openhpi-switcher
92           The command to set default openhpi library on a system.
93
94       openhpid
95           The openhpi daemon, providing OpenHPI data as a system service.
96

AUTHORS

98       Authors of this man page:
99
100        Sean Dague (http://dague.net/sean)
101
102
103
1042.8.1                             2007-01-29                        openhpi(7)