Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
Copyright 2012 Joshua M. Clulow <josh@sysmgr.org>
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.
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.
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]
fmadm [-q] [subcommand [arguments]]
The fmadm utility can be used by administrators and service personnel to view and modify system configuration parameters maintained by the Fault Manager, fmd(1M). fmd receives telemetry information relating to problems detected by the system software, diagnoses these problems, and initiates proactive self-healing activities such as disabling faulty components.
fmadm can be used to:
view the set of diagnosis engines and agents that are currently participating in fault management,
view the list of system components that have been diagnosed as faulty, and
perform administrative tasks related to these entities.
The Fault Manager attempts to automate as many activities as possible, so use of fmadm is typically not required. When the Fault Manager needs help from a human administrator, it produces a message indicating its needs. It also refers you to a knowledge article on http://illumos.org/msg/. This web site might ask you to use fmadm or one of the other fault management utilities to gather more information or perform additional tasks. The documentation for fmd(1M), fmdump(1M), and fmstat(1M) describe more about tools to observe fault management activities.
The fmadm utility requires the user to possess the SYS_CONFIG privilege. Refer to the for more information about how to configure privileges. The fmadm load subcommand requires that the user possess all privileges.
fmadm accepts the following subcommands. Some of the subcommands accept or require additional options and operands: fmadm acquit fmri | label [uuid]
Notify the Fault Manager that the specified resource is not to be considered to be a suspect in the fault event identified by uuid, or if no UUID is specified, then in any fault or faults that have been detected. The fmadm acquit subcommand should be used only at the direction of a documented repair procedure. Administrators might need to apply additional commands to re-enable a previously faulted resource.
Notify the Fault Manager that the fault event identified by uuid can be safely ignored. The fmadm acquit subcommand should be used only at the direction of a documented repair procedure. Administrators might need to apply additional commands to re-enable any previously faulted resources.
Display the configuration of the Fault Manager itself, including the module name, version, and description of each component module. Fault Manager modules provide services such as automated diagnosis, self-healing, and messaging for hardware and software present on the system.
Display status information for resources that the Fault Manager currently believes to be faulty. The following options are supported: -a
Display all faults. By default, the fmadm faulty command only lists output for resources that are currently present and faulty. If you specify the -a option, all resource information cached by the Fault Manager is listed, including faults which have been automatically corrected or where no recovery action is needed. The listing includes information for resources that might no longer be present in the system.
Display faulty fru's (Field replaceable units).
Group together faults which have the same fru, class and fault message.
Display persistent cache identifier for each resource in the Fault Manager.
If faults or resources are grouped together with the -a or -g options, limit the output to max entries.
Pipe output through pager with form feed between each fault.
Display Fault Management Resource with their Identifier (FMRI) and their fault management state.
Display 1 line fault summary for each fault event.
Only display fault with given uid.
Display full output.
The Fault Manager associates the following states with every resource for which telemetry information has been received: ok
The resource is present and in use and has no known problems so far as the Fault Manager is concerned.
The resource is not present or not usable but has no known problems. This might indicate the resource has been disabled or deconfigured by an administrator. Consult appropriate management tools for more information.
The resource is present but is not usable because one or more problems have been diagnosed by the Fault Manager. The resource has been disabled to prevent further damage to the system.
The resource is present and usable, but one or more problems have been diagnosed in the resource by the Fault Manager. If all affected resources are in the same state, this is reflected in the message at the end of the list. Otherwise the state is given after each affected resource.
Flush the information cached by the Fault Manager for the specified resource, named by its FMRI. This subcommand should only be used when indicated by a documented repair procedure. Typically, the use of this command is not necessary as the Fault Manager keeps its cache up-to-date automatically. If a faulty resource is flushed from the cache, administrators might need to apply additional commands to enable the specified resource.
Load the specified Fault Manager module. path must be an absolute path and must refer to a module present in one of the defined directories for modules. Typically, the use of this command is not necessary as the Fault Manager loads modules automatically when the operating system initially boots or as needed.
Unload the specified Fault Manager module. Specify module using the basename listed in the fmadm config output. Typically, the use of this command is not necessary as the Fault Manager loads and unloads modules automatically based on the system configuration
Notify the Fault Manager that a repair procedure has been carried out on the specified resource. The fmadm repaired subcommand should be used only at the direction of a documented repair procedure. Administrators might need to apply additional commands to re-enable a previously faulted resource.
Notify the Fault Manager that the specified resource has been replaced. This command should be used in those cases where the Fault Manager is unable to automatically detect the replacement. The fmadm replaced subcommand should be used only at the direction of a documented repair procedure. Administrators might need to apply additional commands to re-enable a previously faulted resource.
Reset the specified Fault Manager module or module subcomponent. If the -s option is present, the specified Soft Error Rate Discrimination (SERD) engine is reset within the module. If the -s option is not present, the entire module is reset and all persistent state associated with the module is deleted. The fmadm reset subcommand should only be used at the direction of a documented repair procedure. The use of this command is typically not necessary as the Fault Manager manages its modules automatically.
The rotate subcommand is a helper command for logadm(1M), so that logadm can rotate live log files correctly. It is not intended to be invoked directly. Use one of the following commands to cause the appropriate logfile to be rotated, if the current one is not zero in size:
# logadm -p now -s 1b /var/fm/fmd/errlog # logadm -p now -s 1b /var/fm/fmd/fltlog
The following options are supported: -q
Set quiet mode. fmadm does not produce messages indicating the result of successful operations to standard output.
The following operands are supported: cmd
The name of a subcommand listed in SUBCOMMANDS.
One or more options or arguments appropriate for the selected subcommand, as described in SUBCOMMANDS.
The following exit values are returned: 0
Successful completion.
An error occurred. Errors include a failure to communicate with fmd or insufficient privileges to perform the requested operation.
Invalid command-line options were specified.
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability See below. |
The command-line options are Committed. The human-readable output is not-an-interface.
fmd(1M), fmdump(1M), fmstat(1M), logadm(1M), syslogd(1M), attributes(5)
http://illumos.org/msg/