1openhpid(8) OpenHPI openhpid(8)
2
6 openhpid - HPI instance to which multiple clients can connect.
7
9 openhpid -c config_file [OPTION]
10
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 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 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 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 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
43 -c, --cfg=conf_file
44 Sets path/name of the configuration file. This option is required
45 unless the environment variable OPENHPI_CONF has been set to a
46 valid configuration file.
47 -v, --verbose
49 This option causes the daemon to display verbose messages. This
50 option is optional.
51 -b, --bind=bind_address
53 Bind address for the daemon socket. Also bind address can be
54 specified with OPENHPI_DAEMON_BIND_ADDRESS environment variable.
55 No bind address is used by default.
56 -p, --port=port
58 Overrides the default listening port (4743) of the daemon. The
59 option is optional.
60 -f, --pidfile=pidfile
62 Overrides the default path/name for the daemon pid file. The
63 option is optional.
64 -s, --timeout=seconds
66 Overrides the default socket read timeout of 30 minutes. The
67 option is optional.
68 -t, --threads=threads
70 Sets the maximum number of connection threads. The default is
71 umlimited. The option is optional.
72 -n, --nondaemon
74 Forces the code to run as a foreground process and NOT as a daemon.
75 The default is to run as a daemon. The option is optional.
76 -6, --ipv6
78 The daemon will try to bind IPv6 socket.
79 -4, --ipv4
81 The daemon will try to bind IPv4 socket (default). IPv6 option
82 takes precedence over IPv4 option.
83 -4 -6
85 The daemon will try to bind IPv4 or IPv6 socket.
86
88 All of these environment variables can instead be set in the
89 openhpi.conf configuration file, except for OPENHPI_DAEMON_PORT and
90 OPENHPI_CONF.
91 OPENHPI_DAEMON_PORT=PORT_NUMBER
93 The port number the host will listen on for clent connections.
94 Default port is 4743.
95 OPENHPI_LOG_ON_SEV
97 Valus can be one of: CRITICAL,MAJOR,MINOR,INFORMATIONAL,OK,DEBUG.
98 Events of this severity or higher will be logged to the domain
99 event log. The default is MINOR.
100 OPENHPI_EVT_QUEUE_LIMIT=NUMBER
102 Maximum number of events allowed in a subscribed session's queue.
103 Default is 10000.
104 OPENHPI_DEL_SIZE_LIMIT=NUMBER
106 Maximum number of events allowed in the domain event log. Default
107 is 10000
108 OPENHPI_DEL_SAVE
110 Set to YES to persist the domain event logs to disk. They will be
111 loaded in case the daemon restarts. Default is NO.
112 OPENHPI_DAT_SIZE_LIMIT=NUMBER
114 Maximum number of alarms allowed in the domain alarm table.
115 Default is unlimited.
116 OPENHPI_DAT_USER_LIMIT=NUMBER
118 Maximum number of user alarms allowed in the domain alarm table.
119 Default is unlimited.
120 OPENHPI_DAT_SAVE
122 Set to YES to persist the domain alarm tables to disk. They will be
123 loaded in case the daemon restarts. Default is NO.
124 OPENHPI_PATH="/path/to/plugins:/another/path/to/plugins"
126 This is a colon delimited list of directories used when searching
127 for an OpenHPI plugin to load. The default is $prefix/lib/openhpi.
128 OPENHPI_VARPATH="/path/to/dir"
130 This sets the directory used to store openhpi internal data. The
131 domain event logs and alarm tables are saved there (if configured
132 to) along with resource ID to entity path mappings. Default is
133 $prefix/var/lib/openhpi.
134 OPENHPI_CONF="/path/to/configurationg/file"
136 This is another way of telling the daemon where to find the
137 configuration file.
138
140 The following man pages may also be of interest
141 openhpi
143 General information about OpenHPI
144
146 Authors of this man page:
147 Renier Morales (renier@openhpi.org)
149 Anton Pak (avpak@users.sourceforge.net)
1503.8.0 2017-05-27 openhpid(8)