.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "ohhandler 1"
.TH ohhandler 1 2024-03-21 3.8.0 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
ohhandler \- An openhpi sample application that uses the openhpi additional interfaces to control openhpi configuration. That is plugins can be loaded, plugin instances (handlers) created, unloaded or their configuration displayed.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& ohhandler [\-D nn] [\-N host[:port]] [\-C <cfgfile>] [\-X] command <specific arguments>
\& ohhandler [\-\-domain nn] [\-\-host=host[:port]] [\-\-cfgfile=file] [\-\-debug] command <specific arguments>
\&
\& ohhandler [\-D nn] [\-X] list
\& ohhandler [\-D nn] [\-X] info    <handler\-id>
\& ohhandler [\-D nn] [\-X] destroy <handler\-id>
\& ohhandler [\-D nn] [\-X] getnext <handler\-id>
\& ohhandler [\-D nn] [\-X] find    <resource\-id>
\& ohhandler [\-D nn] [\-X] retry   <handler\-id>
\& ohhandler [\-D nn] [\-X] create  plugin <plugin\-name> <configuration\-parameters>
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
ohhandler list will display a list of all plugin instances (handlers) currently defined in the openhpi daemon for the specified domain. Part of the output is the handler-id that can be used in subsequent commands.
.PP
ohhandler info will display specific info for the handler with the specified id. This information includes all configuration parameters of the handler as specified in the openhpi.conf file or as dynamically defined during a "ohhandler create" call.
.PP
ohhandler destroy will unload the specified handler and delete all its configuration information.
.PP
ohhandler getnext will allows to walk through all hanlers currently defined in the openhpi daemon for the specified domain.
.PP
ohhandler find will find the handler that is managing the specified resource.
.PP
ohhandler retry allows to try again to load and initialize the specified handler.
.PP
ohhandler create allows to dynamically create a new handler with configuration parameters like they are specified in the openhpi.conf file. 
 \- The type of plugin is specified with the keyword plugin
 \- Configuration parameters should follow as name value pairs
 \- Complex strings like entity paths must be enclosed with ""
 Example:
 ohhandler create plugin libsimulator entity_root "{SYSTEM_CHASSIS,1}" name sim
.PP
If no domain or host is selected, ohhandler uses the default domain as specified in the openhpiclient.conf file.
.SH OPTIONS
.IX Header "OPTIONS"
.SS "Help Options:"
.IX Subsection "Help Options:"
.IP "\fB\-h\fR, \fB\-\-help\fR" 2
.IX Item "-h, --help"
Show help options
.SS "Application Options:"
.IX Subsection "Application Options:"
.IP "\fB\-D\fR \fInn\fR, \fB\-\-domain\fR=\fInn\fR" 2
.IX Item "-D nn, --domain=nn"
Select domain id \fInn\fR
.IP "\fB\-X\fR, \fB\-\-debug\fR" 2
.IX Item "-X, --debug"
Display debug messages
.IP "\fB\-N\fR \fI""host[:port]""\fR, \fB\-\-host\fR=\fI""host[:port]""\fR" 2
.IX Item "-N ""host[:port]"", --host=""host[:port]"""
Open session to the domain served by the daemon at the specified URL (host:port).
This option overrides the OPENHPI_DAEMON_HOST and OPENHPI_DAEMON_PORT environment variables.
If host contains ':' (for example IPv6 address) then enclose it in square brackets.
For example: \fI"[::1]"\fR or \fI"[::1]:4743"\fR.
.IP "\fB\-C\fR \fI""file""\fR, \fB\-\-cfgfile\fR=\fI""file""\fR" 2
.IX Item "-C ""file"", --cfgfile=""file"""
Use passed file as client configuration file.
This option overrides the OPENHPICLIENT_CONF environment variable.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 1
\&         hpi_shell
\&
\&         hpialarms      hpifan         hpipower       hpithres
\&         hpidomain      hpigensimdata  hpireset       hpitop
\&         hpiel          hpiiinv        hpisensor      hpitree
\&         hpievents      hpionIBMblade  hpisettime     hpiwdt
\&         hpixml
\&         ohdomainlist   ohparam
.Ve
.SH AUTHORS
.IX Header "AUTHORS"
Authors of this man page:
.PP
.Vb 2
\& Ulrich Kleber (ulikleber@users.sourceforge.net)
\& Anton Pak (avpak@users.sourceforge.net)
.Ve