| blob | 6c320a681dfb806ef7c4ec51aabc66382b6640af |
1 '\" te
2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
3 .\" Copyright 2012 Joshua M. Clulow <josh@sysmgr.org>
4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 .TH FMADM 8 "Oct 22, 2008"
8 .SH NAME
9 fmadm \- fault management configuration tool
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBfmadm\fR [\fB-q\fR] [\fIsubcommand\fR [\fIarguments\fR]]
14 .fi
16 .SH DESCRIPTION
17 .sp
18 .LP
19 The \fBfmadm\fR utility can be used by administrators and service personnel to
20 view and modify system configuration parameters maintained by the Fault
21 Manager, \fBfmd\fR(8). \fBfmd\fR receives telemetry information relating to
22 problems detected by the system software, diagnoses these problems, and
23 initiates proactive self-healing activities such as disabling faulty
24 components.
25 .sp
26 .LP
27 \fBfmadm\fR can be used to:
28 .RS +4
29 .TP
30 .ie t \(bu
31 .el o
32 view the set of diagnosis engines and agents that are currently participating
33 in fault management,
34 .RE
35 .RS +4
36 .TP
37 .ie t \(bu
38 .el o
39 view the list of system components that have been diagnosed as faulty, and
40 .RE
41 .RS +4
42 .TP
43 .ie t \(bu
44 .el o
45 perform administrative tasks related to these entities.
46 .RE
47 .sp
48 .LP
49 The Fault Manager attempts to automate as many activities as possible, so use
50 of \fBfmadm\fR is typically not required. When the Fault Manager needs help
51 from a human administrator, it produces a message indicating its needs. It also
52 refers you to a knowledge article on http://illumos.org/msg/. This web site
53 might ask you to use \fBfmadm\fR or one of the other fault management utilities
54 to gather more information or perform additional tasks. The documentation for
55 \fBfmd\fR(8), \fBfmdump\fR(8), and \fBfmstat\fR(8) describe more about tools
56 to observe fault management activities.
57 .sp
58 .LP
59 The \fBfmadm\fR utility requires the user to possess the \fBSYS_CONFIG\fR
60 privilege. Refer to the \fI\fR for more information about how to configure
61 privileges. The \fBfmadm\fR \fBload\fR subcommand requires that the
62 user possess all privileges.
63 .SS "SUBCOMMANDS"
64 .sp
65 .LP
66 \fBfmadm\fR accepts the following subcommands. Some of the subcommands accept
67 or require additional options and operands:
68 .sp
69 .ne 2
70 .na
71 \fB\fBfmadm acquit\fR \fIfmri\fR \fB|\fR \fIlabel\fR [\fIuuid\fR]\fR
72 .ad
73 .sp .6
74 .RS 4n
75 Notify the Fault Manager that the specified resource is not to be considered to
76 be a suspect in the fault event identified by \fIuuid\fR, or if no UUID is
77 specified, then in any fault or faults that have been detected. The \fBfmadm
78 acquit\fR subcommand should be used only at the direction of a documented
79 repair procedure. Administrators might need to apply additional commands to
80 re-enable a previously faulted resource.
81 .RE
83 .sp
84 .ne 2
85 .na
86 \fB\fBfmadm acquit\fR \fIuuid\fR\fR
87 .ad
88 .sp .6
89 .RS 4n
90 Notify the Fault Manager that the fault event identified by \fIuuid\fR can be
91 safely ignored. The \fBfmadm acquit\fR subcommand should be used only at the
92 direction of a documented repair procedure. Administrators might need to
93 apply additional commands to re-enable any previously faulted resources.
94 .RE
96 .sp
97 .ne 2
98 .na
99 \fB\fBfmadm config\fR\fR
100 .ad
101 .sp .6
102 .RS 4n
103 Display the configuration of the Fault Manager itself, including the module
104 name, version, and description of each component module. Fault Manager modules
105 provide services such as automated diagnosis, self-healing, and messaging for
106 hardware and software present on the system.
107 .RE
109 .sp
110 .ne 2
111 .na
112 \fB\fBfmadm faulty\fR [\fB-afgiprsv\fR] [\fB-n\fR \fImax\fR] [\fB-u\fR
113 \fIuid\fR]\fR
114 .ad
115 .sp .6
116 .RS 4n
117 Display status information for resources that the Fault Manager currently
118 believes to be faulty.
119 .sp
120 The following options are supported:
121 .sp
122 .ne 2
123 .na
124 \fB\fB-a\fR\fR
125 .ad
126 .RS 10n
127 Display all faults. By default, the \fBfmadm faulty\fR command only lists
128 output for resources that are currently present and faulty. If you specify the
129 \fB-a\fR option, all resource information cached by the Fault Manager is
130 listed, including faults which have been automatically corrected or where no
131 recovery action is needed. The listing includes information for resources that
132 might no longer be present in the system.
133 .RE
135 .sp
136 .ne 2
137 .na
138 \fB\fB-f\fR\fR
139 .ad
140 .RS 10n
141 Display faulty \fBfru's\fR (Field replaceable units).
142 .RE
144 .sp
145 .ne 2
146 .na
147 \fB\fB-g\fR\fR
148 .ad
149 .RS 10n
150 Group together faults which have the same fru, class and fault message.
151 .RE
153 .sp
154 .ne 2
155 .na
156 \fB\fB-i\fR\fR
157 .ad
158 .RS 10n
159 Display persistent cache identifier for each resource in the Fault Manager.
160 .RE
162 .sp
163 .ne 2
164 .na
165 \fB\fB-n\fR \fImax\fR\fR
166 .ad
167 .RS 10n
168 If faults or resources are grouped together with the \fB-a\fR or \fB-g\fR
169 options, limit the output to \fImax\fR entries.
170 .RE
172 .sp
173 .ne 2
174 .na
175 \fB\fB-p\fR\fR
176 .ad
177 .RS 10n
178 Pipe output through pager with form feed between each fault.
179 .RE
181 .sp
182 .ne 2
183 .na
184 \fB\fB-r\fR\fR
185 .ad
186 .RS 10n
187 Display Fault Management Resource with their Identifier (FMRI) and their fault
188 management state.
189 .RE
191 .sp
192 .ne 2
193 .na
194 \fB\fB-s\fR\fR
195 .ad
196 .RS 10n
197 Display 1 line fault summary for each fault event.
198 .RE
200 .sp
201 .ne 2
202 .na
203 \fB\fB-u\fR \fIuid\fR\fR
204 .ad
205 .RS 10n
206 Only display fault with given \fBuid\fR.
207 .RE
209 .sp
210 .ne 2
211 .na
212 \fB\fB-v\fR\fR
213 .ad
214 .RS 10n
215 Display full output.
216 .RE
218 The percentage certainty is displayed if a fault has multiple suspects, either
219 of different classes or on different \fBfru\fR's. If more than one resource is
220 on the same \fBfru\fR and it is not 100% certain that the fault is associated
221 with the \fBfru\fR, the maximum percentage certainty of the possible suspects
222 on the \fBfru\fR is displayed.
223 .RE
225 .sp
226 .LP
227 The Fault Manager associates the following states with every resource for which
228 telemetry information has been received:
229 .sp
230 .ne 2
231 .na
232 \fB\fBok\fR\fR
233 .ad
234 .sp .6
235 .RS 4n
236 The resource is present and in use and has no known problems so far as the
237 Fault Manager is concerned.
238 .RE
240 .sp
241 .ne 2
242 .na
243 \fB\fBunknown\fR\fR
244 .ad
245 .sp .6
246 .RS 4n
247 The resource is not present or not usable but has no known problems. This might
248 indicate the resource has been disabled or deconfigured by an administrator.
249 Consult appropriate management tools for more information.
250 .RE
252 .sp
253 .ne 2
254 .na
255 \fB\fBfaulted\fR\fR
256 .ad
257 .sp .6
258 .RS 4n
259 The resource is present but is not usable because one or more problems have
260 been diagnosed by the Fault Manager. The resource has been disabled to prevent
261 further damage to the system.
262 .RE
264 .sp
265 .ne 2
266 .na
267 \fB\fBdegraded\fR\fR
268 .ad
269 .sp .6
270 .RS 4n
271 The resource is present and usable, but one or more problems have been
272 diagnosed in the resource by the Fault Manager.
273 .sp
274 If all affected resources are in the same state, this is reflected in the
275 message at the end of the list. Otherwise the state is given after each
276 affected resource.
277 .RE
279 .sp
280 .ne 2
281 .na
282 \fB\fBfmadm flush\fR \fIfmri\fR\fR
283 .ad
284 .sp .6
285 .RS 4n
286 Flush the information cached by the Fault Manager for the specified resource,
287 named by its FMRI. This subcommand should only be used when indicated by a
288 documented repair procedure. Typically, the use of this command is not
289 necessary as the Fault Manager keeps its cache up-to-date automatically. If a
290 faulty resource is flushed from the cache, administrators might need to apply
291 additional commands to enable the specified resource.
292 .RE
294 .sp
295 .ne 2
296 .na
297 \fB\fBfmadm load\fR \fIpath\fR\fR
298 .ad
299 .sp .6
300 .RS 4n
301 Load the specified Fault Manager module. \fIpath\fR must be an absolute path
302 and must refer to a module present in one of the defined directories for
303 modules. Typically, the use of this command is not necessary as the Fault
304 Manager loads modules automatically when the operating system initially boots
305 or as needed.
306 .RE
308 .sp
309 .ne 2
310 .na
311 \fB\fBfmadm unload\fR \fImodule\fR\fR
312 .ad
313 .sp .6
314 .RS 4n
315 Unload the specified Fault Manager module. Specify \fImodule\fR using the
316 basename listed in the \fBfmadm config\fR output. Typically, the use of this
317 command is not necessary as the Fault Manager loads and unloads modules
318 automatically based on the system configuration
319 .RE
321 .sp
322 .ne 2
323 .na
324 \fB\fBfmadm repaired\fR \fIfmri\fR \fB|\fR \fIlabel\fR\fR
325 .ad
326 .sp .6
327 .RS 4n
328 Notify the Fault Manager that a repair procedure has been carried out on the
329 specified resource. The \fBfmadm repaired\fR subcommand should be used only at
330 the direction of a documented repair procedure. Administrators might need
331 to apply additional commands to re-enable a previously faulted resource.
332 .RE
334 .sp
335 .ne 2
336 .na
337 \fB\fBfmadm replaced\fR \fIfmri\fR \fB|\fR \fIlabel\fR\fR
338 .ad
339 .sp .6
340 .RS 4n
341 Notify the Fault Manager that the specified resource has been replaced. This
342 command should be used in those cases where the Fault Manager is unable to
343 automatically detect the replacement. The \fBfmadm replaced\fR subcommand
344 should be used only at the direction of a documented repair procedure.
345 Administrators might need to apply additional commands to re-enable a
346 previously faulted resource.
347 .RE
349 .sp
350 .ne 2
351 .na
352 \fB\fBfmadm reset\fR [\fB-s\fR \fIserd\fR\fB]\fR \fImodule\fR\fR
353 .ad
354 .sp .6
355 .RS 4n
356 Reset the specified Fault Manager module or module subcomponent. If the
357 \fB-s\fR option is present, the specified Soft Error Rate Discrimination (SERD)
358 engine is reset within the module. If the \fB-s\fR option is not present, the
359 entire module is reset and all persistent state associated with the module is
360 deleted. The \fBfmadm reset\fR subcommand should only be used at the direction
361 of a documented repair procedure. The use of this command is typically not
362 necessary as the Fault Manager manages its modules automatically.
363 .RE
365 .sp
366 .ne 2
367 .na
368 \fB\fBfmadm rotate\fR \fBerrlog | fltlog\fR\fR
369 .ad
370 .sp .6
371 .RS 4n
372 The \fBrotate\fR subcommand is a helper command for \fBlogadm\fR(8), so that
373 \fBlogadm\fR can rotate live log files correctly. It is not intended to be
374 invoked directly. Use one of the following commands to cause the appropriate
375 logfile to be rotated, if the current one is not zero in size:
376 .sp
377 .in +2
378 .nf
379 # \fBlogadm -p now -s 1b /var/fm/fmd/errlog\fR
380 # \fBlogadm -p now -s 1b /var/fm/fmd/fltlog\fR
381 .fi
382 .in -2
383 .sp
385 .RE
387 .SH OPTIONS
388 .sp
389 .LP
390 The following options are supported:
391 .sp
392 .ne 2
393 .na
394 \fB\fB-q\fR\fR
395 .ad
396 .RS 6n
397 Set quiet mode. \fBfmadm\fR does not produce messages indicating the result of
398 successful operations to standard output.
399 .RE
401 .SH OPERANDS
402 .sp
403 .LP
404 The following operands are supported:
405 .sp
406 .ne 2
407 .na
408 \fB\fIcmd\fR\fR
409 .ad
410 .RS 8n
411 The name of a subcommand listed in \fBSUBCOMMANDS\fR.
412 .RE
414 .sp
415 .ne 2
416 .na
417 \fB\fIargs\fR\fR
418 .ad
419 .RS 8n
420 One or more options or arguments appropriate for the selected \fIsubcommand\fR,
421 as described in \fBSUBCOMMANDS\fR.
422 .RE
424 .SH EXIT STATUS
425 .sp
426 .LP
427 The following exit values are returned:
428 .sp
429 .ne 2
430 .na
431 \fB\fB0\fR\fR
432 .ad
433 .RS 5n
434 Successful completion.
435 .RE
437 .sp
438 .ne 2
439 .na
440 \fB\fB1\fR\fR
441 .ad
442 .RS 5n
443 An error occurred. Errors include a failure to communicate with \fBfmd\fR or
444 insufficient privileges to perform the requested operation.
445 .RE
447 .sp
448 .ne 2
449 .na
450 \fB\fB2\fR\fR
451 .ad
452 .RS 5n
453 Invalid command-line options were specified.
454 .RE
456 .SH ATTRIBUTES
457 .sp
458 .LP
459 See \fBattributes\fR(5) for descriptions of the following attributes:
460 .sp
462 .sp
463 .TS
464 box;
465 c | c
466 l | l .
467 ATTRIBUTE TYPE ATTRIBUTE VALUE
468 _
469 Interface Stability See below.
470 .TE
472 .sp
473 .LP
474 The command-line options are Committed. The human-readable output is
475 not-an-interface.
476 .SH SEE ALSO
477 .sp
478 .LP
479 \fBfmd\fR(8), \fBfmdump\fR(8), \fBfmstat\fR(8), \fBlogadm\fR(8),
480 \fBsyslogd\fR(8), \fBattributes\fR(5)
481 .sp
482 .LP
483 \fI\fR
484 .sp
485 .LP
486 http://illumos.org/msg/