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 1M "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
15
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(1M). \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(1M), \fBfmdump\fR(1M), and \fBfmstat\fR(1M) 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
82
83 .sp
84 .ne 2
85 .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(1M), 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
384
385 .RE
386
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
400
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
413
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
423
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
436
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
446
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
455
456 .SH ATTRIBUTES
457 .sp
458 .LP
459 See \fBattributes\fR(5) for descriptions of the following attributes:
460 .sp
461
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
471
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(1M), \fBfmdump\fR(1M), \fBfmstat\fR(1M), \fBlogadm\fR(1M),
480 \fBsyslogd\fR(1M), \fBattributes\fR(5)
481 .sp
482 .LP
483 \fI\fR
484 .sp
485 .LP
486 http://illumos.org/msg/
|
1 '\" te
2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
3 .\" Copyright 2012 Joshua M. Clulow <josh@sysmgr.org>
4 .\" Copyright 2019 Peter Tribble
5 .\" 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.
6 .\" 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.
7 .\" 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]
8 .TH FMADM 1M "Aug 26, 2019"
9 .SH NAME
10 fmadm \- fault management configuration tool
11 .SH SYNOPSIS
12 .nf
13 \fBfmadm\fR [\fB-q\fR] [\fIsubcommand\fR [\fIarguments\fR]]
14 .fi
15
16 .SH DESCRIPTION
17 The \fBfmadm\fR utility can be used by administrators and service personnel to
18 view and modify system configuration parameters maintained by the Fault
19 Manager, \fBfmd\fR(1M). \fBfmd\fR receives telemetry information relating to
20 problems detected by the system software, diagnoses these problems, and
21 initiates proactive self-healing activities such as disabling faulty
22 components.
23 .sp
24 .LP
25 \fBfmadm\fR can be used to:
26 .RS +4
27 .TP
28 .ie t \(bu
29 .el o
30 view the set of diagnosis engines and agents that are currently participating
31 in fault management,
32 .RE
33 .RS +4
34 .TP
35 .ie t \(bu
36 .el o
37 view the list of system components that have been diagnosed as faulty, and
38 .RE
39 .RS +4
40 .TP
41 .ie t \(bu
42 .el o
43 perform administrative tasks related to these entities.
44 .RE
45 .sp
46 .LP
47 The Fault Manager attempts to automate as many activities as possible, so use
48 of \fBfmadm\fR is typically not required. When the Fault Manager needs help
49 from a human administrator, it produces a message indicating its needs. It also
50 refers you to a knowledge article on http://illumos.org/msg/. This web site
51 might ask you to use \fBfmadm\fR or one of the other fault management utilities
52 to gather more information or perform additional tasks. The documentation for
53 \fBfmd\fR(1M), \fBfmdump\fR(1M), and \fBfmstat\fR(1M) describe more about tools
54 to observe fault management activities.
55 .sp
56 .LP
57 The \fBfmadm\fR utility requires the user to possess the \fBPRIV_SYS_ADMIN\fR
58 privilege. See \fBprivileges\fR(5). The \fBfmadm\fR \fBload\fR subcommand
59 requires that the user possess all privileges.
60 .SS "SUBCOMMANDS"
61 \fBfmadm\fR accepts the following subcommands. Some of the subcommands accept
62 or require additional options and operands:
63 .sp
64 .ne 2
65 .na
66 \fB\fBfmadm acquit\fR \fIfmri\fR \fB|\fR \fIlabel\fR [\fIuuid\fR]\fR
67 .ad
68 .sp .6
69 .RS 4n
70 Notify the Fault Manager that the specified resource is not to be considered to
71 be a suspect in the fault event identified by \fIuuid\fR, or if no UUID is
72 specified, then in any fault or faults that have been detected. The \fBfmadm
73 acquit\fR subcommand should be used only at the direction of a documented
74 repair procedure. Administrators might need to apply additional commands to
75 re-enable a previously faulted resource.
76 .RE
77
78 .sp
79 .ne 2
80 .na
363 \fB\fBfmadm rotate\fR \fBerrlog | fltlog\fR\fR
364 .ad
365 .sp .6
366 .RS 4n
367 The \fBrotate\fR subcommand is a helper command for \fBlogadm\fR(1M), so that
368 \fBlogadm\fR can rotate live log files correctly. It is not intended to be
369 invoked directly. Use one of the following commands to cause the appropriate
370 logfile to be rotated, if the current one is not zero in size:
371 .sp
372 .in +2
373 .nf
374 # \fBlogadm -p now -s 1b /var/fm/fmd/errlog\fR
375 # \fBlogadm -p now -s 1b /var/fm/fmd/fltlog\fR
376 .fi
377 .in -2
378 .sp
379
380 .RE
381
382 .SH OPTIONS
383 The following options are supported:
384 .sp
385 .ne 2
386 .na
387 \fB\fB-q\fR\fR
388 .ad
389 .RS 6n
390 Set quiet mode. \fBfmadm\fR does not produce messages indicating the result of
391 successful operations to standard output.
392 .RE
393
394 .SH OPERANDS
395 The following operands are supported:
396 .sp
397 .ne 2
398 .na
399 \fB\fIcmd\fR\fR
400 .ad
401 .RS 8n
402 The name of a subcommand listed in \fBSUBCOMMANDS\fR.
403 .RE
404
405 .sp
406 .ne 2
407 .na
408 \fB\fIargs\fR\fR
409 .ad
410 .RS 8n
411 One or more options or arguments appropriate for the selected \fIsubcommand\fR,
412 as described in \fBSUBCOMMANDS\fR.
413 .RE
414
415 .SH EXIT STATUS
416 The following exit values are returned:
417 .sp
418 .ne 2
419 .na
420 \fB\fB0\fR\fR
421 .ad
422 .RS 5n
423 Successful completion.
424 .RE
425
426 .sp
427 .ne 2
428 .na
429 \fB\fB1\fR\fR
430 .ad
431 .RS 5n
432 An error occurred. Errors include a failure to communicate with \fBfmd\fR or
433 insufficient privileges to perform the requested operation.
434 .RE
435
436 .sp
437 .ne 2
438 .na
439 \fB\fB2\fR\fR
440 .ad
441 .RS 5n
442 Invalid command-line options were specified.
443 .RE
444
445 .SH ATTRIBUTES
446 See \fBattributes\fR(5) for descriptions of the following attributes:
447 .sp
448
449 .sp
450 .TS
451 box;
452 c | c
453 l | l .
454 ATTRIBUTE TYPE ATTRIBUTE VALUE
455 _
456 Interface Stability See below.
457 .TE
458
459 .sp
460 .LP
461 The command-line options are Committed. The human-readable output is
462 not-an-interface.
463 .SH SEE ALSO
464 \fBfmd\fR(1M), \fBfmdump\fR(1M), \fBfmstat\fR(1M), \fBlogadm\fR(1M),
465 \fBsyslogd\fR(1M), \fBattributes\fR(5), \fBprivileges\fR(5)
466 .sp
467 .LP
468 http://illumos.org/msg/
|