.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "openhpi 7"
.TH openhpi 7 "2017-03-18" "3.6.1" "OpenHPI"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
openhpi \- an implementation of the SA Forum's Hardware Platform Interface
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
OpenHPI is an implementation of the \s-1SA\s0 Forum's Hardware Platform
Interface, which provides a standard C library interface to manage,
monitor, and control hardware (both local and remote).
.PP
Starting with release 2.14.0 OpenHPI implements the \s-1HPI B.03.02\s0 specification.
.PP
The OpenHPI client library (libopenhpi) provides all the connection
functionality needed by the client application to connect to the OpenHPI
daemon running on the local or remote server.
.PP
The OpenHPI daemon runs as a background process and executes the requests. 
It loads plugins to adapt to the different hardware types. The plugins can
be defined in the openhpi.conf file or can be loaded dynamically.
.SH "ENVIRONMENTAL VARIABLES"
.IX Header "ENVIRONMENTAL VARIABLES"
Some of OpenHPI's functioning can be changed by setting environment
variables.  This documents all client environmental settings.
Client environmental settings are evaluated in the openhpi library that is
linked to the client. There are other environmental settings for the
openhpi daemon.
.ie n .IP "\fB\s-1OPENHPICLIENT_CONF\s0\fR=""filename""" 2
.el .IP "\fB\s-1OPENHPICLIENT_CONF\s0\fR=``filename''" 2
.IX Item "OPENHPICLIENT_CONF=filename"
Location for the client's configuration file that specifies the \s-1HPI\s0 domains
and addresses of daemons serving the domains. If the variable is not set, 
OpenHPI will look for a file openhpiclient.conf in the directory specified 
during the build process (default /etc/openhpi).
.IP "\fB\s-1OPENHPI_DAEMON_HOST\s0\fR=URL" 2
.IX Item "OPENHPI_DAEMON_HOST=URL"
\&\s-1URL\s0 for the host running the daemon which the client wants to connect to. 
This can be an ip address or \*(L"localhost\*(R" (default) if the daemon is running 
on the same host as the client.
The variable is only used if no default domain is defined via the client conf 
file.
.IP "\fB\s-1OPENHPI_DAEMON_PORT\s0\fR=PORT_NUMBER" 2
.IX Item "OPENHPI_DAEMON_PORT=PORT_NUMBER"
The port number used by the daemon which the client wants to connect to.
Default port is 4743.
The variable is only used if no default domain is defined via the client conf 
file.
.SH "HARDWARE SUPPORT"
.IX Header "HARDWARE SUPPORT"
OpenHPI provides a number of plugins that talk to different hardware
types.  The following is a list of plugins provided by the OpenHPI project.
.IP "\fBipmidirect\fR" 4
.IX Item "ipmidirect"
An \s-1IPMI\s0 plugin designed specifically for \s-1ATCA\s0 chassis.  It implements
\&\s-1IPMI\s0 commands directly in the plugin.
.IP "\fBsnmp_bc\fR" 4
.IX Item "snmp_bc"
An \s-1SNMP\s0 based plugin that can communicate with \s-1IBM\s0 BladeCenter, as
well as \s-1IBM\s0 xSeries servers with \s-1RSA 1\s0 adapters.
.Sp
\&\s-1SNMP_BC\s0 plugin depends on net-snmp > 5.0.7.
.IP "\fBilo2_ribcl\fR" 4
.IX Item "ilo2_ribcl"
OpenHPI plugin supporting \s-1HP\s0 ProLiant Rack Mount Servers. This plug-in connects
to iLO2 on \s-1HP\s0 ProLiant Rack Mount Server using a \s-1SSL\s0 connection and exchanges
information via Remote Insight Board Command Language (\s-1RIBCL\s0).
.IP "\fBoa_soap\fR" 4
.IX Item "oa_soap"
OpenHPI plug-in supporting \s-1HP\s0 BladeSystems c\-Class. This plug-in connects
to the \s-1OA\s0 of a c\-Class chassis using an \s-1SSL\s0 connection and manages the system
using an XML-encoded \s-1SOAP\s0 interface.
.IP "\fBrtas\fR" 4
.IX Item "rtas"
Run-Time Abstraction Services (\s-1RTAS\s0) plug-in
.IP "\fBsysfs\fR" 4
.IX Item "sysfs"
OpenHPI plugin that reads system information from sysfs.
(\s-1LM\s0 sensors and I2C devices exported in sysfs requires kernel 2.6 or >= 2.5.72)
.IP "\fBwatchdog\fR" 4
.IX Item "watchdog"
Linux watchdog device interface
.PP
The following plugins are provided to ease testing or support complex 
hardware architectures:
.IP "\fBsimulator\fR" 4
.IX Item "simulator"
OpenHPI plugin that reports fakes hardware used for
testing the core library.
.IP "\fBdynamic_simulator\fR" 4
.IX Item "dynamic_simulator"
OpenHPI plugin that reports fakes hardware defined in the file
simulation.data used for testing the core library.
.IP "\fBslave\fR" 4
.IX Item "slave"
OpenHPI plug-in that allows to aggregate resources from different 
domains (slave domains) and to provide aggregated resources as part 
of the one domain (master domain).
.IP "\fBtest_agent\fR" 4
.IX Item "test_agent"
OpenHPI plug-in for advanced testing.
Provides console for runtime configuration.
.SH "OTHER DOCUMENTATION"
.IX Header "OTHER DOCUMENTATION"
The definitive guide to \s-1HPI\s0 is the \s-1SA\s0 Forum specification at
http://saforum.org.
.PP
More info on OpenHPI can be found at our webpage
(http://openhpi.org) and in inline documentation.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
The following man pages may also be of interest
.IP "\fBopenhpid\fR" 1
.IX Item "openhpid"
The openhpi daemon, providing OpenHPI data as a system service.
.IP "\fBOpenHPI client programs\fR" 1
.IX Item "OpenHPI client programs"
.Vb 6
\&         hpialarms      hpigensimdata  hpireset       hpitop
\&         hpidomain      hpiinv         hpisensor      hpitree
\&         hpiel          hpionIBMblade  hpisettime     hpiwdt
\&         hpievents      hpipower       hpithres       hpixml
\&         ohdomainlist   ohhandler      ohparam
\&         hpi_shell
.Ve
.SH "AUTHORS"
.IX Header "AUTHORS"
Authors of this man page:
.PP
.Vb 4
\& Sean Dague (http://dague.net/sean)
\& Renier Morales (renier@openhpi.org)
\& Ulrich Kleber (ulikleber@users.sourceforge.net)
\& Anton Pak (avpak@users.sourceforge.net)
.Ve