1openhpid(8)                         OpenHPI                        openhpid(8)
2
3
4

NAME

6       openhpid - HPI instance to which multiple clients can connect.
7

SYNOPSIS

9       openhpid -c config_file [OPTION]
10

DESCRIPTION

12       The OpenHPI daemon runs as a background process and accepts connections
13       from remote clients that invoke HPI function calls. The daemon wraps
14       the OpenHPI library with a sockets-based API that is archicture neutral
15       for all types of clients.
16
17       When you run the daemon, the standard method for locating the OpenHPI
18       configuration file is used. However, the daemon will accept a
19       configuration file as a command line option (-c) to override the
20       default file.
21
22       A command option (-p)  or environment variable determines the port
23       number the daemon will listen on for client connections. The default
24       port is 4743.
25
26       The daemon creates a PID file in the /var/run subdirectory. This
27       directory is only writable by the root user. Thus the daemon will fail
28       when run as a normal user if the PID file location is not overridden.
29       To override the PID file location you can use the -f command line
30       option.
31
32       The client and the daemon do not have to be on the same hardware
33       architecture.  The daemon could be running on a P-series processor and
34       the client running on an x86-series processor. The client library and
35       daemon use a marshaling technique to resolve architecture and structure
36       padding conflicts. The user does not need to concern themselves with
37       architectureal differences between the client and daemon. The one
38       exception to this rule is 64-bit architectures.  The client and daemon
39       currently cannot resolve differences between 32-bit and 64-bit
40       architectures.
41

OPTIONS

43       -f pidfile
44           This overrides the default location of the pidfile.
45
46       -n  This forces the daemon to run in the foreground.
47
48       -p port
49           This is used to override the port to listen on by the daemon.
50
51       -s seconds
52           Read timeout used by the daemon sockets. Default is unlimited.
53
54       -t threads
55           Sets the maximum number of connection threads. Default is
56           unlimited.
57
58       -v  Display verbose messages
59
60       -4  The daemon will try to bind IPv4 socket.
61
62       -6  The daemon will try to bind IPv6 socket.
63
64       -4 -6
65           The daemon will try to bind IPv4 or IPv6 socket.
66

ENVIRONMENTAL VARIABLES

68       All of these environment variables can instead be set in the
69       openhpi.conf configuration file, except for OPENHPI_DAEMON_PORT and
70       OPENHPI_CONF.
71
72       OPENHPI_DAEMON_PORT=PORT_NUMBER
73           The port number the host will listen on for clent connections.
74           Default port is 4743.
75
76       OPENHPI_LOG_ON_SEV
77           Valus can be one of: CRITICAL,MAJOR,MINOR,INFORMATIONAL,OK,DEBUG.
78           Events of this severity or higher will be logged to the domain
79           event log.  The default is MINOR.
80
81       OPENHPI_EVT_QUEUE_LIMIT=NUMBER
82           Maximum number of events allowed in a subscribed session's queue.
83           Default is 10000.
84
85       OPENHPI_DEL_SIZE_LIMIT=NUMBER
86           Maximum number of events allowed in the domain event log.  Default
87           is 10000
88
89       OPENHPI_DEL_SAVE
90           Set to YES to persist the domain event logs to disk. They will be
91           loaded in case the daemon restarts. Default is NO.
92
93       OPENHPI_DAT_SIZE_LIMIT=NUMBER
94           Maximum number of alarms allowed in the domain alarm table.
95           Default is unlimited.
96
97       OPENHPI_DAT_USER_LIMIT=NUMBER
98           Maximum number of user alarms allowed in the domain alarm table.
99           Default is unlimited.
100
101       OPENHPI_DAT_SAVE
102           Set to YES to persist the domain alarm tables to disk. They will be
103           loaded in case the daemon restarts. Default is NO.
104
105       OPENHPI_PATH="/path/to/plugins:/another/path/to/plugins"
106           This is a colon delimited list of directories used when searching
107           for an OpenHPI plugin to load. The default is $prefix/lib/openhpi.
108
109       OPENHPI_VARPATH="/path/to/dir"
110           This sets the directory used to store openhpi internal data. The
111           domain event logs and alarm tables are saved there (if configured
112           to) along with resource ID to entity path mappings.  Default is
113           $prefix/var/lib/openhpi.
114
115       OPENHPI_CONF="/path/to/configurationg/file"
116           This is another way of telling the daemon where to find the
117           configuration file.
118

SEE ALSO

120       The following man pages may also be of interest
121
122       openhpi
123           General information about OpenHPI
124

AUTHORS

126       Authors of this man page:
127
128        Renier Morales (renier@openhpi.org)
129        Anton Pak (avpak@users.sourceforge.net)
130
131
132
1333.4.0                             2011-11-01                       openhpid(8)