1fmadm(1M)               System Administration Commands               fmadm(1M)
2
3
4

NAME

6       fmadm - fault management configuration tool
7

SYNOPSIS

9       fmadm [-q] [subcommand [arguments]]
10
11

DESCRIPTION

13       The  fmadm  utility can be used by administrators and service personnel
14       to view and modify system configuration parameters  maintained  by  the
15       Solaris  Fault  Manager,  fmd(1M).  fmd  receives telemetry information
16       relating to problems detected by the system software,  diagnoses  these
17       problems,  and initiates proactive self-healing activities such as dis‐
18       abling faulty components.
19
20
21       fmadm can be used to:
22
23           o      view the set of diagnosis engines and agents that  are  cur‐
24                  rently participating in fault management,
25
26           o      view  the list of system components that have been diagnosed
27                  as faulty, and
28
29           o      perform administrative tasks related to these entities.
30
31
32       The Fault Manager attempts to automate as many activities as  possible,
33       so use of fmadm is typically not required. When the Fault Manager needs
34       help from a human administrator, service repair technician, or Sun,  it
35       produces a message indicating its needs. It also refers you to a knowl‐
36       edge article on Sun's web site, http://www.sun.com/msg/. The  web  site
37       might  ask you to use fmadm or one of the other fault management utili‐
38       ties to gather more information or perform additional tasks. The  docu‐
39       mentation  for  fmd(1M), fmdump(1M), and fmstat(1M) describe more about
40       tools to observe fault management activities.
41
42
43       The fmadm utility requires the user to possess  the  SYS_CONFIG  privi‐
44       lege. Refer to the  for more information about how to configure Solaris
45       privileges. The fmadm load subcommand requires that  the  user  possess
46       all privileges.
47
48   SUBCOMMANDS
49       fmadm accepts the following subcommands. Some of the subcommands accept
50       or require additional options and operands:
51
52       fmadm acquit fmri | label [uuid]
53
54           Notify the Fault Manager that the specified resource is not  to  be
55           considered  to  be a suspect in the fault event identified by uuid,
56           or if no UUID is specified, then in any fault or faults  that  have
57           been  detected.  The fmadm acquit subcommand should be used only at
58           the direction of a documented Sun repair procedure.  Administrators
59           might  need  to apply additional commands to re-enable a previously
60           faulted resource.
61
62
63       fmadm acquit uuid
64
65           Notify the Fault Manager that the fault event  identified  by  uuid
66           can  be  safely ignored. The fmadm acquit subcommand should be used
67           only at the direction of a documented Sun repair procedure.  Admin‐
68           istrators  might need to apply additional commands to re-enable any
69           previously faulted resources.
70
71
72       fmadm config
73
74           Display the configuration of the Fault  Manager  itself,  including
75           the module name, version, and description of each component module.
76           Fault Manager modules provide services such as automated diagnosis,
77           self-healing,  and  messaging  for hardware and software present on
78           the system.
79
80
81       fmadm faulty [-afgiprsv] [-n max] [-u uid]
82
83           Display status information for resources  that  the  Fault  Manager
84           currently believes to be faulty.
85
86           The following options are supported:
87
88           -a        Display  all faults. By default, the fmadm faulty command
89                     only  lists  output  for  resources  that  are  currently
90                     present  and  faulty.  If  you specify the -a option, all
91                     resource information  cached  by  the  Fault  Manager  is
92                     listed,  including  faults  which have been automatically
93                     corrected or where no  recovery  action  is  needed.  The
94                     listing  includes information for resources that might no
95                     longer be present in the system.
96
97
98           -f        Display faulty fru's (Field replaceable units).
99
100
101           -g        Group together faults which have the same fru, class  and
102                     fault message.
103
104
105           -i        Display  persistent cache identifier for each resource in
106                     the Fault Manager.
107
108
109           -n max    If faults or resources are grouped together with  the  -a
110                     or -g options, limit the output to max entries.
111
112
113           -p        Pipe  output  through  pager  with form feed between each
114                     fault.
115
116
117           -r        Display Fault Management Resource with  their  Identifier
118                     (FMRI) and their fault management state.
119
120
121           -s        Display 1 line fault summary for each fault event.
122
123
124           -u uid    Only display fault with given uid.
125
126
127           -v        Display full output.
128
129           The  percentage certainty is displayed if a fault has multiple sus‐
130           pects, either of different classes or on different fru's.  If  more
131           than  one  resource  is  on the same fru and it is not 100% certain
132           that the fault is associated with the fru, the  maximum  percentage
133           certainty of the possible suspects on the fru is displayed.
134
135
136
137       The  Fault  Manager associates the following states with every resource
138       for which telemetry information has been received:
139
140       ok
141
142           The resource is present and in use and has no known problems so far
143           as the Fault Manager is concerned.
144
145
146       unknown
147
148           The  resource  is  not present or not usable but has no known prob‐
149           lems. This might indicate the resource has been disabled or  decon‐
150           figured  by  an administrator. Consult appropriate management tools
151           for more information.
152
153
154       faulted
155
156           The resource is present but is not usable because one or more prob‐
157           lems  have  been  diagnosed  by the Fault Manager. The resource has
158           been disabled to prevent further damage to the system.
159
160
161       degraded
162
163           The resource is present and usable, but one or more  problems  have
164           been diagnosed in the resource by the Fault Manager.
165
166           If  all affected resources are in the same state, this is reflected
167           in the message at the end of the list. Otherwise the state is given
168           after each affected resource.
169
170
171       fmadm flush fmri
172
173           Flush the information cached by the Fault Manager for the specified
174           resource, named by its FMRI. This subcommand should  only  be  used
175           when indicated by a documented Sun repair procedure. Typically, the
176           use of this command is not necessary as the Fault Manager keeps its
177           cache  up-to-date  automatically.  If  a faulty resource is flushed
178           from the cache, administrators might need to apply additional  com‐
179           mands to enable the specified resource.
180
181
182       fmadm load path
183
184           Load  the  specified Fault Manager module. path must be an absolute
185           path and must refer to a module  present  in  one  of  the  defined
186           directories  for modules. Typically, the use of this command is not
187           necessary as the Fault Manager  loads  modules  automatically  when
188           Solaris initially boots or as needed.
189
190
191       fmadm unload module
192
193           Unload the specified Fault Manager module. Specify module using the
194           basename listed in the fmadm config output. Typically, the  use  of
195           this  command  is  not  necessary  as  the  Fault Manager loads and
196           unloads modules automatically based on the system configuration
197
198
199       fmadm repaired fmri | label
200
201           Notify the Fault Manager that a repair procedure has  been  carried
202           out on the specified resource. The fmadm repaired subcommand should
203           be used only at the direction of a documented Sun repair procedure.
204           Administrators might need to apply additional commands to re-enable
205           a previously faulted resource.
206
207
208       fmadm replaced fmri | label
209
210           Notify the Fault Manager  that  the  specified  resource  has  been
211           replaced.  This  command  should  be  used in those cases where the
212           Fault Manager is unable to automatically  detect  the  replacement.
213           The  fmadm replaced subcommand should be used only at the direction
214           of a documented Sun repair procedure. Administrators might need  to
215           apply   additional  commands  to  re-enable  a  previously  faulted
216           resource.
217
218
219       fmadm reset [-s serd] module
220
221           Reset the specified Fault Manager module or module subcomponent. If
222           the -s option is present, the specified Soft Error Rate Discrimina‐
223           tion (SERD) engine is reset within the module. If the -s option  is
224           not  present,  the  entire module is reset and all persistent state
225           associated with the module is deleted. The fmadm  reset  subcommand
226           should  only  be  used  at the direction of a documented Sun repair
227           procedure. The use of this command is typically  not  necessary  as
228           the Fault Manager manages its modules automatically.
229
230
231       fmadm rotate errlog | fltlog
232
233           The  rotate  subcommand is a helper command for logadm(1M), so that
234           logadm can rotate live log files correctly. It is not  intended  to
235           be invoked directly. Use one of the following commands to cause the
236           appropriate logfile to be rotated, if the current one is  not  zero
237           in size:
238
239             # logadm -p now -s 1b /var/fm/fmd/errlog
240             # logadm -p now -s 1b /var/fm/fmd/fltlog
241
242
243
244

OPTIONS

246       The following options are supported:
247
248       -q    Set  quiet  mode.  fmadm does not produce messages indicating the
249             result of successful operations to standard output.
250
251

OPERANDS

253       The following operands are supported:
254
255       cmd     The name of a subcommand listed in SUBCOMMANDS.
256
257
258       args    One or more options or arguments appropriate for  the  selected
259               subcommand, as described in SUBCOMMANDS.
260
261

EXIT STATUS

263       The following exit values are returned:
264
265       0    Successful completion.
266
267
268       1    An  error  occurred.  Errors include a failure to communicate with
269            fmd or insufficient privileges to perform the requested operation.
270
271
272       2    Invalid command-line options were specified.
273
274

ATTRIBUTES

276       See attributes(5) for descriptions of the following attributes:
277
278
279
280
281       ┌─────────────────────────────┬─────────────────────────────┐
282       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
283       ├─────────────────────────────┼─────────────────────────────┤
284       │Availability                 │SUNWfmd                      │
285       ├─────────────────────────────┼─────────────────────────────┤
286       │Interface Stability          │See below.                   │
287       └─────────────────────────────┴─────────────────────────────┘
288
289
290       The command-line options are Committed. The  human-readable  output  is
291       not-an-interface.
292

SEE ALSO

294       fmd(1M), fmdump(1M), fmstat(1M), logadm(1M), syslogd(1M), attributes(5)
295
296
297
298
299
300       http://www.sun.com/msg/
301
302
303
304SunOS 5.11                        22 Oct 2008                        fmadm(1M)
Impressum