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
  81 \fB\fBfmadm acquit\fR \fIuuid\fR\fR
  82 .ad
  83 .sp .6
  84 .RS 4n
  85 Notify the Fault Manager that the fault event identified by \fIuuid\fR can be
  86 safely ignored. The \fBfmadm acquit\fR subcommand should be used only at the
  87 direction of a documented repair procedure. Administrators might need to
  88 apply additional commands to re-enable any previously faulted resources.
  89 .RE
  90 
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBfmadm config\fR\fR
  95 .ad
  96 .sp .6
  97 .RS 4n
  98 Display the configuration of the Fault Manager itself, including the module
  99 name, version, and description of each component module. Fault Manager modules
 100 provide services such as automated diagnosis, self-healing, and messaging for
 101 hardware and software present on the system.
 102 .RE
 103 
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBfmadm faulty\fR [\fB-afgiprsv\fR] [\fB-n\fR \fImax\fR] [\fB-u\fR
 108 \fIuid\fR]\fR
 109 .ad
 110 .sp .6
 111 .RS 4n
 112 Display status information for resources that the Fault Manager currently
 113 believes to be faulty.
 114 .sp
 115 The following options are supported:
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fB-a\fR\fR
 120 .ad
 121 .RS 10n
 122 Display all faults. By default, the \fBfmadm faulty\fR command only lists
 123 output for resources that are currently present and faulty. If you specify the
 124 \fB-a\fR option, all resource information cached by the Fault Manager is
 125 listed, including faults which have been automatically corrected or where no
 126 recovery action is needed. The listing includes information for resources that
 127 might no longer be present in the system.
 128 .RE
 129 
 130 .sp
 131 .ne 2
 132 .na
 133 \fB\fB-f\fR\fR
 134 .ad
 135 .RS 10n
 136 Display faulty \fBfru's\fR (Field replaceable units).
 137 .RE
 138 
 139 .sp
 140 .ne 2
 141 .na
 142 \fB\fB-g\fR\fR
 143 .ad
 144 .RS 10n
 145 Group together faults which have the same fru, class and fault message.
 146 .RE
 147 
 148 .sp
 149 .ne 2
 150 .na
 151 \fB\fB-i\fR\fR
 152 .ad
 153 .RS 10n
 154 Display persistent cache identifier for each resource in the Fault Manager.
 155 .RE
 156 
 157 .sp
 158 .ne 2
 159 .na
 160 \fB\fB-n\fR \fImax\fR\fR
 161 .ad
 162 .RS 10n
 163 If faults or resources are grouped together with the \fB-a\fR or \fB-g\fR
 164 options, limit the output to \fImax\fR entries.
 165 .RE
 166 
 167 .sp
 168 .ne 2
 169 .na
 170 \fB\fB-p\fR\fR
 171 .ad
 172 .RS 10n
 173 Pipe output through pager with form feed between each fault.
 174 .RE
 175 
 176 .sp
 177 .ne 2
 178 .na
 179 \fB\fB-r\fR\fR
 180 .ad
 181 .RS 10n
 182 Display Fault Management Resource with their Identifier (FMRI) and their fault
 183 management state.
 184 .RE
 185 
 186 .sp
 187 .ne 2
 188 .na
 189 \fB\fB-s\fR\fR
 190 .ad
 191 .RS 10n
 192 Display 1 line fault summary for each fault event.
 193 .RE
 194 
 195 .sp
 196 .ne 2
 197 .na
 198 \fB\fB-u\fR \fIuid\fR\fR
 199 .ad
 200 .RS 10n
 201 Only display fault with given \fBuid\fR.
 202 .RE
 203 
 204 .sp
 205 .ne 2
 206 .na
 207 \fB\fB-v\fR\fR
 208 .ad
 209 .RS 10n
 210 Display full output.
 211 .RE
 212 
 213 The percentage certainty is displayed if a fault has multiple suspects, either
 214 of different classes or on different \fBfru\fR's. If more than one resource is
 215 on the same \fBfru\fR and it is not 100% certain that the fault is associated
 216 with the \fBfru\fR, the maximum percentage certainty of the possible suspects
 217 on the \fBfru\fR is displayed.
 218 .RE
 219 
 220 .sp
 221 .LP
 222 The Fault Manager associates the following states with every resource for which
 223 telemetry information has been received:
 224 .sp
 225 .ne 2
 226 .na
 227 \fB\fBok\fR\fR
 228 .ad
 229 .sp .6
 230 .RS 4n
 231 The resource is present and in use and has no known problems so far as the
 232 Fault Manager is concerned.
 233 .RE
 234 
 235 .sp
 236 .ne 2
 237 .na
 238 \fB\fBunknown\fR\fR
 239 .ad
 240 .sp .6
 241 .RS 4n
 242 The resource is not present or not usable but has no known problems. This might
 243 indicate the resource has been disabled or deconfigured by an administrator.
 244 Consult appropriate management tools for more information.
 245 .RE
 246 
 247 .sp
 248 .ne 2
 249 .na
 250 \fB\fBfaulted\fR\fR
 251 .ad
 252 .sp .6
 253 .RS 4n
 254 The resource is present but is not usable because one or more problems have
 255 been diagnosed by the Fault Manager. The resource has been disabled to prevent
 256 further damage to the system.
 257 .RE
 258 
 259 .sp
 260 .ne 2
 261 .na
 262 \fB\fBdegraded\fR\fR
 263 .ad
 264 .sp .6
 265 .RS 4n
 266 The resource is present and usable, but one or more problems have been
 267 diagnosed in the resource by the Fault Manager.
 268 .sp
 269 If all affected resources are in the same state, this is reflected in the
 270 message at the end of the list. Otherwise the state is given after each
 271 affected resource.
 272 .RE
 273 
 274 .sp
 275 .ne 2
 276 .na
 277 \fB\fBfmadm flush\fR \fIfmri\fR\fR
 278 .ad
 279 .sp .6
 280 .RS 4n
 281 Flush the information cached by the Fault Manager for the specified resource,
 282 named by its FMRI. This subcommand should only be used when indicated by a
 283 documented repair procedure. Typically, the use of this command is not
 284 necessary as the Fault Manager keeps its cache up-to-date automatically. If a
 285 faulty resource is flushed from the cache, administrators might need to apply
 286 additional commands to enable the specified resource.
 287 .RE
 288 
 289 .sp
 290 .ne 2
 291 .na
 292 \fB\fBfmadm load\fR \fIpath\fR\fR
 293 .ad
 294 .sp .6
 295 .RS 4n
 296 Load the specified Fault Manager module. \fIpath\fR must be an absolute path
 297 and must refer to a module present in one of the defined directories for
 298 modules. Typically, the use of this command is not necessary as the Fault
 299 Manager loads modules automatically when the operating system initially boots
 300 or as needed.
 301 .RE
 302 
 303 .sp
 304 .ne 2
 305 .na
 306 \fB\fBfmadm unload\fR \fImodule\fR\fR
 307 .ad
 308 .sp .6
 309 .RS 4n
 310 Unload the specified Fault Manager module. Specify \fImodule\fR using the
 311 basename listed in the \fBfmadm config\fR output. Typically, the use of this
 312 command is not necessary as the Fault Manager loads and unloads modules
 313 automatically based on the system configuration
 314 .RE
 315 
 316 .sp
 317 .ne 2
 318 .na
 319 \fB\fBfmadm repaired\fR \fIfmri\fR \fB|\fR \fIlabel\fR\fR
 320 .ad
 321 .sp .6
 322 .RS 4n
 323 Notify the Fault Manager that a repair procedure has been carried out on the
 324 specified resource. The \fBfmadm repaired\fR subcommand should be used only at
 325 the direction of a documented repair procedure. Administrators might need
 326 to apply additional commands to re-enable a previously faulted resource.
 327 .RE
 328 
 329 .sp
 330 .ne 2
 331 .na
 332 \fB\fBfmadm replaced\fR \fIfmri\fR \fB|\fR \fIlabel\fR\fR
 333 .ad
 334 .sp .6
 335 .RS 4n
 336 Notify the Fault Manager that the specified resource has been replaced. This
 337 command should be used in those cases where the Fault Manager is unable to
 338 automatically detect the replacement. The \fBfmadm replaced\fR subcommand
 339 should be used only at the direction of a documented repair procedure.
 340 Administrators might need to apply additional commands to re-enable a
 341 previously faulted resource.
 342 .RE
 343 
 344 .sp
 345 .ne 2
 346 .na
 347 \fB\fBfmadm reset\fR [\fB-s\fR \fIserd\fR\fB]\fR \fImodule\fR\fR
 348 .ad
 349 .sp .6
 350 .RS 4n
 351 Reset the specified Fault Manager module or module subcomponent. If the
 352 \fB-s\fR option is present, the specified Soft Error Rate Discrimination (SERD)
 353 engine is reset within the module. If the \fB-s\fR option is not present, the
 354 entire module is reset and all persistent state associated with the module is
 355 deleted. The \fBfmadm reset\fR subcommand should only be used at the direction
 356 of a documented repair procedure. The use of this command is typically not
 357 necessary as the Fault Manager manages its modules automatically.
 358 .RE
 359 
 360 .sp
 361 .ne 2
 362 .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/