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

ENVIRONMENTAL VARIABLES

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

SEE ALSO

117       The following man pages may also be of interest
118
119       openhpi
120           General information about OpenHPI
121

AUTHORS

123       Authors of this man page:
124
125        Renier Morales (renier@openhpi.org)
126
127
128
1292.14.1                            2009-11-23                       openhpid(8)
Impressum