usr/src/man/man1m/fmd.1m

   1 '\" te
   2 .\" Copyright (c) 2004, 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 FMD 1M "Nov 17, 2004"
   8 .SH NAME
   9 fmd \- fault manager daemon
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/usr/lib/fm/fmd/fmd\fR [\fB-V\fR] [\fB-f\fR \fIfile\fR] [\fB-o\fR \fIopt\fR=\fIval\fR] [\fB-R\fR \fIdir\fR]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 \fBfmd\fR is a daemon that runs in the background on each system.
  20 \fBfmd\fR receives telemetry information relating to problems detected by the
  21 system software, diagnoses these problems, and initiates proactive self-healing
  22 activities such as disabling faulty components. When appropriate, the fault
  23 manager also sends a message to the \fBsyslogd\fR(1M) service to notify an
  24 administrator that a problem has been detected. The message directs
  25 administrators to a knowledge article on http://illumos.org/msg/, which
  26 explains more about the problem impact and appropriate responses.
  27 .sp
  28 .LP
  29 Each problem diagnosed by the fault manager is assigned a Universal Unique
  30 Identifier (\fBUUID\fR). The \fBUUID\fR uniquely identifes this particular
  31 problem across any set of systems. The \fBfmdump\fR(1M) utility can be used to
  32 view the list of problems diagnosed by the fault manager, along with their
  33 \fBUUID\fRs and knowledge article message identifiers. The \fBfmadm\fR(1M)
  34 utility can be used to view the resources on the system believed to be faulty.
  35 The \fBfmstat\fR(1M) utility can be used to report statistics kept by the fault
  36 manager. The fault manager is started automatically when the operating system
  37 boots, so it is not necessary to use the \fBfmd\fR command directly.
  38 .SH OPTIONS
  39 .sp
  40 .LP
  41 The following options are supported
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fB-f\fR \fIfile\fR\fR
  46 .ad
  47 .RS 16n
  48 Read the specified configuration \fIfile\fR prior to searching for any of the
  49 default fault manager configuration files.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fB-o\fR \fIopt\fR\fB=\fR\fIvalue\fR\fR
  56 .ad
  57 .RS 16n
  58 Set the specified fault manager option to the specified value. Fault manager
  59 options are currently a Private interface; see \fBattributes\fR(5) for
  60 information about Private interfaces.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fB-R\fR \fIdir\fR\fR
  67 .ad
  68 .RS 16n
  69 Use the specified root directory for all pathnames evaluated by the fault
  70 manager, instead of the default root (\fB/\fR).
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fB-V\fR\fR
  77 .ad
  78 .RS 16n
  79 Print the fault manager's version to stdout and exit.
  80 .RE
  81
  82 .SH EXIT STATUS
  83 .sp
  84 .LP
  85 The following exit values are returned:
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB0\fR \fR
  90 .ad
  91 .RS 6n
  92 Successful completion
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fB1\fR\fR
  99 .ad
 100 .RS 6n
 101 An error occurred which prevented the fault manager from initializing, such as
 102 failure to open the telemetry transport.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fB2\fR\fR
 109 .ad
 110 .RS 6n
 111 Invalid command-line options were specified.
 112 .RE
 113
 114 .SH FILES
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fB/etc/fm/fmd\fR \fR
 119 .ad
 120 .RS 20n
 121 Fault manager configuration directory
 122 .RE
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fB/usr/lib/fm/fmd\fR \fR
 128 .ad
 129 .RS 20n
 130 Fault manager library directory
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fB/var/fm/fmd\fR\fR
 137 .ad
 138 .RS 20n
 139 Fault manager log directory
 140 .RE
 141
 142 .SH ATTRIBUTES
 143 .sp
 144 .LP
 145 See \fBattributes\fR(5) for descriptions of the following attributes:
 146 .sp
 147
 148 .sp
 149 .TS
 150 box;
 151 c | c
 152 l | l .
 153 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 154 _
 155 Interface Stability     Evolving
 156 .TE
 157
 158 .SH SEE ALSO
 159 .sp
 160 .LP
 161 \fBsvcs\fR(1), \fBfmadm\fR(1M), \fBfmdump\fR(1M), \fBfmstat\fR(1M),
 162 \fBsyslogd\fR(1M), \fBattributes\fR(5), \fBsmf\fR(5)
 163 .sp
 164 .LP
 165 http://illumos.org/msg/
 166 .SH NOTES
 167 .sp
 168 .LP
 169 The Fault Manager is managed by the service management facility, \fBsmf\fR(5),
 170 under the service identifier:
 171 .sp
 172 .in +2
 173 .nf
 174  svc:/system/fmd:default
 175 .fi
 176 .in -2
 177 .sp
 178
 179 .sp
 180 .LP
 181 The service's status can be queried using the \fBsvcs\fR(1) command.
 182 Administrators should not disable the Fault Manager service.