fmadm(1M)                                                 System Administration Commands                                                 fmadm(1M)

NAME

       fmadm - fault management configuration tool

SYNOPSIS

       fmadm [-q] [subcommand  [arguments]]

DESCRIPTION

       The  fmadm utility can be used by administrators and service personnel to view and modify system configuration parameters maintained by the
       Solaris 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:

         o  view the set of diagnosis engines and agents that are currently participating in fault management,

         o  view the list of system components that have been diagnosed as faulty, and

         o  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, service repair technician, or Sun, it produces a message indicating its needs. It also refers you to
       a  knowledge  article on Sun's web site, http://www.sun.com/msg/. The web site might ask you to use fmadm or one of the other fault manage-
       ment 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 System Administration Guide: Security Services for
       more information about how to configure Solaris privileges. The fmadm load subcommand requires  that the user possess all privileges.

   SUBCOMMANDS
       fmadm accepts the following subcommands. Some of the subcommands require additional options and operands:

       fmadm config

           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.

       fmadm faulty [-ai]

           Display the list of resources that the Fault Manager currently believes to be faulty. Faulty resources are determined  by  the  set  of
           modules  that are performing automated diagnosis activities.  The Fault Management Resource Identifier (FMRI), resource state, and Uni-
           versal Unique Identifier (UUID) of the diagnosis are listed for each resource. An FMRI is a string that acts as the formal name  for  a
           particular resource for which Solaris can perform automated fault management activities.

           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.

           unknown         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.

           degraded        The resource is present and usable, but one or more problems have been diagnosed in the resource by the Fault Manager.

           faulted         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  UUID  shown  in  the output for degraded and faulted resources uniquely identifies the Fault Manager diagnosis that discovered the
           problem. You can obtain additional details about the diagnosis using fmdump -v -u uuid. The fmdump output includes a message identifier
           that  can  be  used  to  learn  more  about the problem impact and resolution procedures on Sun's web site, http://www.sun.com/msg/. 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. The listing includes information for resources that might no longer be
           present in the system. If you specify the -i  option, the persistent cache identifier for each resource in the Fault Manager  is  shown
           instead of the most recent state and UUID.

       fmadm flush fmri

           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 Sun 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.

       fmadm load path

           Load the specified Fault Manager module. path must be an absolute path and must refer to a module present in one of the defined  direc-
           tories  for  modules. Typically, the use of this command is not necessary as the Fault Manager loads modules automatically when Solaris
           initially boots or as needed.

       fmadm unload module

           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

       fmadm repair fmri | uuid

           Update the Fault Manager's resource cache to indicate that no problems are present in one or more resources that have been diagnosed to
           be faulty.  If an fmri is specified, the state of the specified resource is updated. If a uuid is specified, the state of all resources
           associated  with the corresponding diagnosis are updated. If the resource is currently believed to be faulted, it is set to the unknown
           state. If the resource is currently believed to be degraded, it is set to the ok state. Administrators might need to  apply  additional
           commands  to  re-enable a previously faulted resource. The fmadm repair subcommand should only be used at the direction of a documented
           Sun repair procedure. The use of this command is typically not necessary as the Fault Manager updates its resource cache automatically.

       fmadm reset [-s serd] module

           Reset the specified Fault Manager module or module subcomponent. If the -s option is present, the specified Soft Error Rate Discrimina-
           tion  (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 Sun repair  pro-
           cedure. The use of this command is typically not necessary as the Fault Manager manages its modules automatically.

       fmadm rotate errlog | fltlog

           Schedule a rotation of the specified fault manager log file. The log files are automatically rotated by an entry in the logadm(1M) con-
           figuration file that uses this subcommand. See logadm(1M) for more information on how to change the default log rotation options.

OPTIONS

       The following options are supported:

       -q       Set quiet mode. fmadm does not produce messages indicating the result of successful operations to standard output.

OPERANDS

       The following operands are supported:

       cmd      The name of a subcommand listed in SUBCOMMANDS.

       args      One or more options or arguments appropriate for the selected subcommand, as described in SUBCOMMANDS.

EXIT STATUS

       The following exit values are returned:

       0        Successful completion.

       1        An error occurred. Errors include a failure to communicate with fmd or insufficient privileges to perform the requested operation.

       2        Invalid command-line options were specified.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE         |      ATTRIBUTE VALUE        |
       +-----------------------------+-----------------------------+
       |Availability                 |SUNWfmd                      |
       +-----------------------------+-----------------------------+
       |Interface Stability          |See below.                   |
       +-----------------------------+-----------------------------+

       The command-line options are Evolving. The human-readable output is Unstable.

SEE ALSO

       fmd(1M), fmdump(1M), fmstat(1M), logadm(1M), syslogd(1M), attributes(5)

       System Administration Guide: Security Services

       http://www.sun.com/msg/

SunOS 5.10                                                          17 Nov 2004                                                          fmadm(1M)