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

NAME

6       openhpi - an implementation of the SA Forum's Hardware Platform
7       Interface
8

DESCRIPTION

10       OpenHPI is an implementation of the SA Forum's Hardware Platform
11       Interface, which provides a standard C library interface to manage,
12       monitor, and control hardware (both local and remote).
13
14       Starting with release 2.14.0 OpenHPI implements the HPI B.03.02
15       specification.
16
17       The OpenHPI client library (libopenhpi) provides all the connection
18       functionality needed by the client application to connect to the
19       OpenHPI daemon running on the local or remote server.
20
21       The OpenHPI daemon runs as a background process and executes the
22       requests.  It loads plugins to adapt to the different hardware types.
23       The plugins can be defined in the openhpi.conf file or can be loaded
24       dynamically.
25

ENVIRONMENTAL VARIABLES

27       Some of OpenHPI's functioning can be changed by setting environment
28       variables.  This documents all client environmental settings.  Client
29       environmental settings are evaluated in the openhpi library that is
30       linked to the client. There are other environmental settings for the
31       openhpi daemon.
32
33       OPENHPICLIENT_CONF="filename"
34         Location for the client's configuration file that specifies the HPI
35         domains and addresses of daemons serving the domains. If the variable
36         is not set, OpenHPI will look for a file openhpiclient.conf in the
37         directory specified during the build process (default /etc/openhpi).
38
39       OPENHPI_DAEMON_HOST=URL
40         URL for the host running the daemon which the client wants to connect
41         to.  This can be an ip address or "localhost" (default) if the daemon
42         is running on the same host as the client.  The variable is only used
43         if no default domain is defined via the client conf file.
44
45       OPENHPI_DAEMON_PORT=PORT_NUMBER
46         The port number used by the daemon which the client wants to connect
47         to.  Default port is 4743.  The variable is only used if no default
48         domain is defined via the client conf file.
49

HARDWARE SUPPORT

51       OpenHPI provides a number of plugins that talk to different hardware
52       types.  The following is a list of plugins provided by the OpenHPI
53       project.
54
55       ipmidirect
56           An IPMI plugin designed specifically for ATCA chassis.  It
57           implements IPMI commands directly in the plugin.
58
59       snmp_bc
60           An SNMP based plugin that can communicate with IBM BladeCenter, as
61           well as IBM xSeries servers with RSA 1 adapters.
62
63           SNMP_BC plugin depends on net-snmp > 5.0.7.
64
65       ilo2_ribcl
66           OpenHPI plugin supporting HP ProLiant Rack Mount Servers. This
67           plug-in connects to iLO2 on HP ProLiant Rack Mount Server using a
68           SSL connection and exchanges information via Remote Insight Board
69           Command Language (RIBCL).
70
71       oa_soap
72           OpenHPI plug-in supporting HP BladeSystems c-Class. This plug-in
73           connects to the OA of a c-Class chassis using an SSL connection and
74           manages the system using an XML-encoded SOAP interface.
75
76       rtas
77           Run-Time Abstraction Services (RTAS) plug-in
78
79       sysfs
80           OpenHPI plugin that reads system information from sysfs.  (LM
81           sensors and I2C devices exported in sysfs requires kernel 2.6 or >=
82           2.5.72)
83
84       watchdog
85           Linux watchdog device interface
86
87       The following plugins are provided to ease testing or support complex
88       hardware architectures:
89
90       simulator
91           OpenHPI plugin that reports fakes hardware used for testing the
92           core library.
93
94       dynamic_simulator
95           OpenHPI plugin that reports fakes hardware defined in the file
96           simulation.data used for testing the core library.
97
98       slave
99           OpenHPI plug-in that allows to aggregate resources from different
100           domains (slave domains) and to provide aggregated resources as part
101           of the one domain (master domain).
102
103       test_agent
104           OpenHPI plug-in for advanced testing.  Provides console for runtime
105           configuration.
106

OTHER DOCUMENTATION

108       The definitive guide to HPI is the SA Forum specification at
109       http://saforum.org.
110
111       More info on OpenHPI can be found at our webpage (http://openhpi.org)
112       and in inline documentation.
113

SEE ALSO

115       The following man pages may also be of interest
116
117       openhpid
118        The openhpi daemon, providing OpenHPI data as a system service.
119
120       OpenHPI client programs
121                 hpialarms      hpigensimdata  hpireset       hpitop
122                 hpidomain      hpiinv         hpisensor      hpitree
123                 hpiel          hpionIBMblade  hpisettime     hpiwdt
124                 hpievents      hpipower       hpithres       hpixml
125                 ohdomainlist   ohhandler      ohparam
126                 hpi_shell
127

AUTHORS

129       Authors of this man page:
130
131        Sean Dague (http://dague.net/sean)
132        Renier Morales (renier@openhpi.org)
133        Ulrich Kleber (ulikleber@users.sourceforge.net)
134        Anton Pak (avpak@users.sourceforge.net)
135
136
137
1383.8.0                             2017-05-27                        openhpi(7)