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 -d, --decrypt Config file encrypted with hpicrypt. Decrypt and read
44 -h, --help Show help options
45 -c, --cfg=conf_file
46 Sets path/name of the configuration file. This option is required
47 unless the environment variable OPENHPI_CONF has been set to a
48 valid configuration file.
49 -v, --verbose
51 This option causes the daemon to display verbose messages. This
52 option is optional.
53 -b, --bind=bind_address
55 Bind address for the daemon socket. Also bind address can be
56 specified with OPENHPI_DAEMON_BIND_ADDRESS environment variable.
57 No bind address is used by default.
58 -p, --port=port
60 Overrides the default listening port (4743) of the daemon. The
61 option is optional.
62 -f, --pidfile=pidfile
64 Overrides the default path/name for the daemon pid file. The
65 option is optional.
66 -s, --timeout=seconds
68 Overrides the default socket read timeout of 30 minutes. The
69 option is optional.
70 -t, --threads=threads
72 Sets the maximum number of connection threads. The default is
73 umlimited. The option is optional.
74 -n, --nondaemon
76 Forces the code to run as a foreground process and NOT as a daemon.
77 The default is to run as a daemon. The option is optional.
78 -6, --ipv6
80 The daemon will try to bind IPv6 socket.
81 -4, --ipv4
83 The daemon will try to bind IPv4 socket (default). IPv6 option
84 takes precedence over IPv4 option.
85 -4 -6
87 The daemon will try to bind IPv4 or IPv6 socket.
88
90 All of these environment variables can instead be set in the
91 openhpi.conf configuration file, except for OPENHPI_DAEMON_PORT and
92 OPENHPI_CONF.
93 OPENHPI_DAEMON_PORT=PORT_NUMBER
95 The port number the host will listen on for clent connections.
96 Default port is 4743.
97 OPENHPI_LOG_ON_SEV
99 Valus can be one of: CRITICAL,MAJOR,MINOR,INFORMATIONAL,OK,DEBUG.
100 Events of this severity or higher will be logged to the domain
101 event log. The default is MINOR.
102 OPENHPI_EVT_QUEUE_LIMIT=NUMBER
104 Maximum number of events allowed in a subscribed session's queue.
105 Default is 10000.
106 OPENHPI_DEL_SIZE_LIMIT=NUMBER
108 Maximum number of events allowed in the domain event log. Default
109 is 10000
110 OPENHPI_DEL_SAVE
112 Set to YES to persist the domain event logs to disk. They will be
113 loaded in case the daemon restarts. Default is NO.
114 OPENHPI_DAT_SIZE_LIMIT=NUMBER
116 Maximum number of alarms allowed in the domain alarm table.
117 Default is unlimited.
118 OPENHPI_DAT_USER_LIMIT=NUMBER
120 Maximum number of user alarms allowed in the domain alarm table.
121 Default is unlimited.
122 OPENHPI_DAT_SAVE
124 Set to YES to persist the domain alarm tables to disk. They will be
125 loaded in case the daemon restarts. Default is NO.
126 OPENHPI_PATH="/path/to/plugins:/another/path/to/plugins"
128 This is a colon delimited list of directories used when searching
129 for an OpenHPI plugin to load. The default is $prefix/lib/openhpi.
130 OPENHPI_VARPATH="/path/to/dir"
132 This sets the directory used to store openhpi internal data. The
133 domain event logs and alarm tables are saved there (if configured
134 to) along with resource ID to entity path mappings. Default is
135 $prefix/var/lib/openhpi.
136 OPENHPI_CONF="/path/to/configurationg/file"
138 This is another way of telling the daemon where to find the
139 configuration file.
140
142 The following man pages may also be of interest
143 openhpi
145 General information about OpenHPI
146
148 Authors of this man page:
149 Renier Morales (renier@openhpi.org)
151 Anton Pak (avpak@users.sourceforge.net)
1523.8.0 2017-05-27 openhpid(8)