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