0
|
1 |
'\" t
|
|
2 |
.\"
|
|
3 |
.\" CDDL HEADER START
|
|
4 |
.\"
|
|
5 |
.\" The contents of this file are subject to the terms of the
|
|
6 |
.\" Common Development and Distribution License (the "License").
|
|
7 |
.\" You may not use this file except in compliance with the License.
|
|
8 |
.\"
|
|
9 |
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
|
|
10 |
.\" or http://www.opensolaris.org/os/licensing.
|
|
11 |
.\" See the License for the specific language governing permissions
|
|
12 |
.\" and limitations under the License.
|
|
13 |
.\"
|
|
14 |
.\" When distributing Covered Code, include this CDDL HEADER in each
|
|
15 |
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
|
|
16 |
.\" If applicable, add the following below this CDDL HEADER, with the
|
|
17 |
.\" fields enclosed by brackets "[]" replaced with your own identifying
|
|
18 |
.\" information: Portions Copyright [yyyy] [name of copyright owner]
|
|
19 |
.\"
|
|
20 |
.\" CDDL HEADER END
|
|
21 |
.\"
|
|
22 |
.\"
|
11
|
23 |
.\" ident "@(#)ipmievd.8.sunman 1.3 10/03/16 SMI"
|
|
24 |
.\" "Copyright 2010 Sun Microsystems, Inc. All rights reserved."
|
0
|
25 |
.\" "Use is subject to license terms."
|
|
26 |
.\"
|
|
27 |
.\" ipmievd man page
|
|
28 |
.\"
|
|
29 |
.TH "ipmievd" "8" "29 November 2006"
|
|
30 |
.SH "NAME"
|
|
31 |
ipmievd \- IPMI event daemon for sending events to syslog
|
|
32 |
.SH "SYNOPSIS"
|
|
33 |
.B ipmievd
|
|
34 |
[\-chvV] \-I lan \-H hostname [ \-p <port>] [\-U <username>] [ \-f <password_file>] [\-S <sdrcache>] sel [<option>]
|
|
35 |
|
|
36 |
.B ipmievd
|
|
37 |
[\-chvV] \-I lanplus \-H hostname [\-p <port>] [\-U <username>] [\-f <password_file>] [\-S <sdrcache>] sel [<option>]
|
|
38 |
|
|
39 |
.B ipmievd
|
|
40 |
[\-chvV] \-I bmc [\-S <sdrcache>] sel [<option>]
|
|
41 |
|
|
42 |
.SH "DESCRIPTION"
|
|
43 |
\fBipmievd\fP is a daemon that listens for events from the
|
|
44 |
Baseboard Management Controller (BMC) which are being sent to the
|
|
45 |
System Event Log (SEL), and logs those messages to
|
|
46 |
syslog. The daemon actively polls the contents of the SEL for
|
|
47 |
new events.
|
|
48 |
When an event is received, it is logged to
|
|
49 |
syslog using the
|
|
50 |
\fILOG_LOCAL4\fP facility. On Solaris, it has been made to use
|
|
51 |
\fILOG_DAEMON\fP instead, so that no changes to /etc/syslog.conf are necessary.
|
|
52 |
.LP
|
|
53 |
\fBipmievd\fP is based on the \fBipmitool\fR utility and it shares the same
|
|
54 |
Intelligent Platform Management Interface (IPMI)
|
|
55 |
support and session setup options. The
|
|
56 |
\fBipmitool\fR man page provides more information on supported IPMI
|
|
57 |
interfaces.
|
|
58 |
.SH "OPTIONS"
|
|
59 |
.TP
|
|
60 |
.B \-c
|
|
61 |
Present output in comma separated variable (CSV) format.
|
|
62 |
.TP
|
|
63 |
.BI \-f " password_file"
|
|
64 |
Specify a file containing the remote server password. If this
|
|
65 |
option is absent, or if password_file is empty, the password
|
|
66 |
will default to NULL.
|
|
67 |
.IP
|
|
68 |
If the
|
|
69 |
.B \-f
|
|
70 |
option is not present, ipmitool will prompt the
|
|
71 |
user for a password. If no password is entered at the prompt,
|
|
72 |
the remote server password will default to NULL.
|
|
73 |
.IP
|
|
74 |
For IPMI v1.5, the maximum password length is 16 characters.
|
|
75 |
Passwords longer than 16 characters will be truncated.
|
|
76 |
.IP
|
|
77 |
For IPMI v2.0, the maximum password length is 20 characters.
|
|
78 |
Passwords longer than 20 characters will be truncated.
|
|
79 |
The longer password length is supported by the
|
|
80 |
.B lanplus
|
|
81 |
interface.
|
|
82 |
.TP
|
|
83 |
.B \-h
|
|
84 |
Get basic usage help from the command line.
|
|
85 |
.TP
|
|
86 |
.BI \-H " hostname"
|
|
87 |
Remote server address, which can be an IP address or hostname. This
|
|
88 |
option is required for the LAN interface connection.
|
|
89 |
.TP
|
|
90 |
.BI \-I " interface"
|
|
91 |
Selects IPMI interface to use. Possible interfaces are:
|
|
92 |
|
|
93 |
.TS
|
|
94 |
tab(+);
|
|
95 |
l l .
|
|
96 |
bmc+IPMI v2.0 BMC interface [default]
|
|
97 |
lan+IPMI v1.5 LAN Interface
|
|
98 |
lanplus+IPMI v2.0 RMCP+ LAN Interface
|
|
99 |
.TE
|
|
100 |
.TP
|
|
101 |
.BI \-p " port"
|
|
102 |
Remote server UDP port to connect to (default is 623).
|
|
103 |
.TP
|
|
104 |
.BI \-S " sdrcache"
|
|
105 |
Use local file for remote Sensor Data Repository (SDR) cache.
|
|
106 |
Using a local SDR cache can drastically increase performance
|
|
107 |
for commands that require knowledge of the entire SDR to perform
|
|
108 |
their function.
|
|
109 |
.TP
|
|
110 |
\.BI \-U " username"
|
|
111 |
Remote server username; default is NULL user.
|
|
112 |
.TP
|
|
113 |
.B \-v
|
|
114 |
Increase verbose output level. This option can be specified
|
|
115 |
multiple times to increase the level of debug output. If given
|
|
116 |
three times, you will get hexdumps of all incoming and
|
|
117 |
outgoing packets.
|
|
118 |
.TP
|
|
119 |
.B \-V
|
|
120 |
Display version information.
|
|
121 |
.SH "COMMANDS"
|
|
122 |
.TP
|
|
123 |
\fIhelp\fP
|
|
124 |
This can be used to get command\-line help. It can also be
|
|
125 |
placed at the end of commands to get option usage help.
|
|
126 |
|
|
127 |
> ipmievd bmc help
|
|
128 |
.br
|
|
129 |
Commands:
|
|
130 |
sel Poll SEL for notification of events
|
|
131 |
.TP
|
|
132 |
\fIsel\fP
|
|
133 |
This command starts
|
|
134 |
.B ipmievd
|
|
135 |
with the SEL Polling event watching
|
|
136 |
mechanism. This will poll the SEL periodically to determine if
|
|
137 |
new events have been logged. This command should work with all
|
|
138 |
BMCs and is capable of using the LAN interface as well to monitor
|
|
139 |
a remote system and log its events to a local syslog.
|
|
140 |
.RS
|
|
141 |
.TP
|
|
142 |
\fBdaemon\fP
|
|
143 |
Launch process as a daemon and reparent to init process.
|
|
144 |
All messages will be sent to syslog. This is the default action.
|
|
145 |
.TP
|
|
146 |
\fBnodaemon\fP
|
|
147 |
Do \fInot\fP become a daemon; instead, log all messages to stderr.
|
|
148 |
.TP
|
|
149 |
\fBpidfile\fR=\fIfilename\fR
|
|
150 |
Save process ID to this file when in daemon mode. Defaults to
|
|
151 |
/var/run/ipmievd.pid.
|
|
152 |
.TP
|
|
153 |
\fBtimeout\fR=\fIseconds\fR
|
|
154 |
Time between checks for SEL polling method. Default is 10 seconds.
|
|
155 |
.SH "EXIT STATUS"
|
|
156 |
Upon successful completion,
|
|
157 |
.B ipmievd
|
|
158 |
returns 0. On failure, 1 is returned.
|
|
159 |
.SH "EXAMPLE"
|
|
160 |
Local non\-daemon process checking remote SEL every 30
|
|
161 |
seconds:
|
|
162 |
|
|
163 |
> ipmievd \-I lan \-H 1.2.3.4 \-f passfile sel nodaemon timeout=30
|
|
164 |
.br
|
|
165 |
Reading Sensors...
|
|
166 |
.br
|
|
167 |
Waiting for Events...
|
|
168 |
.SH "FILES"
|
|
169 |
\fB/platform/i86pc/kernel/drv/bmc\fR
|
|
170 |
.in +30n
|
|
171 |
.sp
|
|
172 |
32-bit \fBELF\fR kernel module for the bmc driver.
|
|
173 |
.sp
|
|
174 |
.in -30n
|
|
175 |
\fB/platform/i86pc/kernel/drv/amd64/bmc\fR
|
|
176 |
.in +30n
|
|
177 |
.sp
|
|
178 |
64-bit \fBELF\fR kernel module for the bmc driver.
|
|
179 |
.in -30n
|
|
180 |
\fB/dev/bmc\fR
|
|
181 |
.in +30n
|
|
182 |
.sp
|
|
183 |
Character device node used to communicate with the bmc driver.
|
|
184 |
.in -30n
|
|
185 |
.SH "ATTRIBUTES"
|
|
186 |
See attributes(5) for descriptions of the following attributes:
|
|
187 |
.sp
|
|
188 |
.TS
|
|
189 |
box;
|
|
190 |
cbp-1 | cbp-1
|
|
191 |
l | l .
|
|
192 |
ATTRIBUTE TYPE ATTRIBUTE VALUE
|
|
193 |
_
|
|
194 |
Architecture i386, amd64
|
|
195 |
_
|
11
|
196 |
Availability system/ipmi/ipmitool
|
0
|
197 |
_
|
|
198 |
Interface Stability Volatile
|
|
199 |
.TE
|
|
200 |
.SH "SEE ALSO"
|
|
201 |
attributes(5),
|
|
202 |
ipmitool(1M),
|
|
203 |
smf(5),
|
|
204 |
svcadm(1M),
|
|
205 |
svccfg(1M),
|
|
206 |
svcs(1)
|
|
207 |
.TP
|
|
208 |
IPMItool Homepage
|
|
209 |
http://ipmitool.sourceforge.net
|
|
210 |
.TP
|
|
211 |
Intelligent Platform Management Interface Specification
|
|
212 |
http://www.intel.com/design/servers/ipmi/spec.htm
|
|
213 |
.TP
|
|
214 |
OpenIPMI Homepage
|
|
215 |
http://openipmi.sourceforge.net
|
|
216 |
.SH "NOTES"
|
|
217 |
The
|
|
218 |
.B ipmievd
|
|
219 |
daemon is managed by the service management
|
|
220 |
facility, smf(5), under the service identifier:
|
|
221 |
svc:/network/ipmievd:default.
|
|
222 |
.LP
|
|
223 |
Administrative actions on this service, such as enabling
|
|
224 |
or disabling, can be performed using svcadm(1M). Use
|
|
225 |
svccfg(1M) to make configuration changes and
|
|
226 |
svcs(1) to view configuration information and service status.
|
|
227 |
.LP
|
|
228 |
Source for
|
|
229 |
.B ipmievd
|
|
230 |
is available on http://opensolaris.org.
|