Print this page
11621 fmadm and fmstat document privileges incorrectly
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man1m/fmadm.1m
+++ new/usr/src/man/man1m/fmadm.1m
1 1 '\" te
2 2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
3 3 .\" Copyright 2012 Joshua M. Clulow <josh@sysmgr.org>
4 +.\" Copyright 2019 Peter Tribble
4 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.
5 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.
6 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]
7 -.TH FMADM 1M "Oct 22, 2008"
8 +.TH FMADM 1M "Aug 26, 2019"
8 9 .SH NAME
9 10 fmadm \- fault management configuration tool
10 11 .SH SYNOPSIS
11 -.LP
12 12 .nf
13 13 \fBfmadm\fR [\fB-q\fR] [\fIsubcommand\fR [\fIarguments\fR]]
14 14 .fi
15 15
16 16 .SH DESCRIPTION
17 -.sp
18 -.LP
19 17 The \fBfmadm\fR utility can be used by administrators and service personnel to
20 18 view and modify system configuration parameters maintained by the Fault
21 19 Manager, \fBfmd\fR(1M). \fBfmd\fR receives telemetry information relating to
22 20 problems detected by the system software, diagnoses these problems, and
23 21 initiates proactive self-healing activities such as disabling faulty
24 22 components.
25 23 .sp
26 24 .LP
27 25 \fBfmadm\fR can be used to:
28 26 .RS +4
29 27 .TP
30 28 .ie t \(bu
31 29 .el o
32 30 view the set of diagnosis engines and agents that are currently participating
33 31 in fault management,
34 32 .RE
35 33 .RS +4
36 34 .TP
37 35 .ie t \(bu
38 36 .el o
39 37 view the list of system components that have been diagnosed as faulty, and
40 38 .RE
41 39 .RS +4
42 40 .TP
43 41 .ie t \(bu
44 42 .el o
45 43 perform administrative tasks related to these entities.
46 44 .RE
47 45 .sp
48 46 .LP
|
↓ open down ↓ |
20 lines elided |
↑ open up ↑ |
49 47 The Fault Manager attempts to automate as many activities as possible, so use
50 48 of \fBfmadm\fR is typically not required. When the Fault Manager needs help
51 49 from a human administrator, it produces a message indicating its needs. It also
52 50 refers you to a knowledge article on http://illumos.org/msg/. This web site
53 51 might ask you to use \fBfmadm\fR or one of the other fault management utilities
54 52 to gather more information or perform additional tasks. The documentation for
55 53 \fBfmd\fR(1M), \fBfmdump\fR(1M), and \fBfmstat\fR(1M) describe more about tools
56 54 to observe fault management activities.
57 55 .sp
58 56 .LP
59 -The \fBfmadm\fR utility requires the user to possess the \fBSYS_CONFIG\fR
60 -privilege. Refer to the \fI\fR for more information about how to configure
61 -privileges. The \fBfmadm\fR \fBload\fR subcommand requires that the
62 -user possess all privileges.
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.
63 60 .SS "SUBCOMMANDS"
64 -.sp
65 -.LP
66 61 \fBfmadm\fR accepts the following subcommands. Some of the subcommands accept
67 62 or require additional options and operands:
68 63 .sp
69 64 .ne 2
70 65 .na
71 66 \fB\fBfmadm acquit\fR \fIfmri\fR \fB|\fR \fIlabel\fR [\fIuuid\fR]\fR
72 67 .ad
73 68 .sp .6
74 69 .RS 4n
75 70 Notify the Fault Manager that the specified resource is not to be considered to
76 71 be a suspect in the fault event identified by \fIuuid\fR, or if no UUID is
77 72 specified, then in any fault or faults that have been detected. The \fBfmadm
78 73 acquit\fR subcommand should be used only at the direction of a documented
79 74 repair procedure. Administrators might need to apply additional commands to
80 75 re-enable a previously faulted resource.
81 76 .RE
82 77
83 78 .sp
84 79 .ne 2
85 80 .na
86 81 \fB\fBfmadm acquit\fR \fIuuid\fR\fR
87 82 .ad
88 83 .sp .6
89 84 .RS 4n
90 85 Notify the Fault Manager that the fault event identified by \fIuuid\fR can be
91 86 safely ignored. The \fBfmadm acquit\fR subcommand should be used only at the
92 87 direction of a documented repair procedure. Administrators might need to
93 88 apply additional commands to re-enable any previously faulted resources.
94 89 .RE
95 90
96 91 .sp
97 92 .ne 2
98 93 .na
99 94 \fB\fBfmadm config\fR\fR
100 95 .ad
101 96 .sp .6
102 97 .RS 4n
103 98 Display the configuration of the Fault Manager itself, including the module
104 99 name, version, and description of each component module. Fault Manager modules
105 100 provide services such as automated diagnosis, self-healing, and messaging for
106 101 hardware and software present on the system.
107 102 .RE
108 103
109 104 .sp
110 105 .ne 2
111 106 .na
112 107 \fB\fBfmadm faulty\fR [\fB-afgiprsv\fR] [\fB-n\fR \fImax\fR] [\fB-u\fR
113 108 \fIuid\fR]\fR
114 109 .ad
115 110 .sp .6
116 111 .RS 4n
117 112 Display status information for resources that the Fault Manager currently
118 113 believes to be faulty.
119 114 .sp
120 115 The following options are supported:
121 116 .sp
122 117 .ne 2
123 118 .na
124 119 \fB\fB-a\fR\fR
125 120 .ad
126 121 .RS 10n
127 122 Display all faults. By default, the \fBfmadm faulty\fR command only lists
128 123 output for resources that are currently present and faulty. If you specify the
129 124 \fB-a\fR option, all resource information cached by the Fault Manager is
130 125 listed, including faults which have been automatically corrected or where no
131 126 recovery action is needed. The listing includes information for resources that
132 127 might no longer be present in the system.
133 128 .RE
134 129
135 130 .sp
136 131 .ne 2
137 132 .na
138 133 \fB\fB-f\fR\fR
139 134 .ad
140 135 .RS 10n
141 136 Display faulty \fBfru's\fR (Field replaceable units).
142 137 .RE
143 138
144 139 .sp
145 140 .ne 2
146 141 .na
147 142 \fB\fB-g\fR\fR
148 143 .ad
149 144 .RS 10n
150 145 Group together faults which have the same fru, class and fault message.
151 146 .RE
152 147
153 148 .sp
154 149 .ne 2
155 150 .na
156 151 \fB\fB-i\fR\fR
157 152 .ad
158 153 .RS 10n
159 154 Display persistent cache identifier for each resource in the Fault Manager.
160 155 .RE
161 156
162 157 .sp
163 158 .ne 2
164 159 .na
165 160 \fB\fB-n\fR \fImax\fR\fR
166 161 .ad
167 162 .RS 10n
168 163 If faults or resources are grouped together with the \fB-a\fR or \fB-g\fR
169 164 options, limit the output to \fImax\fR entries.
170 165 .RE
171 166
172 167 .sp
173 168 .ne 2
174 169 .na
175 170 \fB\fB-p\fR\fR
176 171 .ad
177 172 .RS 10n
178 173 Pipe output through pager with form feed between each fault.
179 174 .RE
180 175
181 176 .sp
182 177 .ne 2
183 178 .na
184 179 \fB\fB-r\fR\fR
185 180 .ad
186 181 .RS 10n
187 182 Display Fault Management Resource with their Identifier (FMRI) and their fault
188 183 management state.
189 184 .RE
190 185
191 186 .sp
192 187 .ne 2
193 188 .na
194 189 \fB\fB-s\fR\fR
195 190 .ad
196 191 .RS 10n
197 192 Display 1 line fault summary for each fault event.
198 193 .RE
199 194
200 195 .sp
201 196 .ne 2
202 197 .na
203 198 \fB\fB-u\fR \fIuid\fR\fR
204 199 .ad
205 200 .RS 10n
206 201 Only display fault with given \fBuid\fR.
207 202 .RE
208 203
209 204 .sp
210 205 .ne 2
211 206 .na
212 207 \fB\fB-v\fR\fR
213 208 .ad
214 209 .RS 10n
215 210 Display full output.
216 211 .RE
217 212
218 213 The percentage certainty is displayed if a fault has multiple suspects, either
219 214 of different classes or on different \fBfru\fR's. If more than one resource is
220 215 on the same \fBfru\fR and it is not 100% certain that the fault is associated
221 216 with the \fBfru\fR, the maximum percentage certainty of the possible suspects
222 217 on the \fBfru\fR is displayed.
223 218 .RE
224 219
225 220 .sp
226 221 .LP
227 222 The Fault Manager associates the following states with every resource for which
228 223 telemetry information has been received:
229 224 .sp
230 225 .ne 2
231 226 .na
232 227 \fB\fBok\fR\fR
233 228 .ad
234 229 .sp .6
235 230 .RS 4n
236 231 The resource is present and in use and has no known problems so far as the
237 232 Fault Manager is concerned.
238 233 .RE
239 234
240 235 .sp
241 236 .ne 2
242 237 .na
243 238 \fB\fBunknown\fR\fR
244 239 .ad
245 240 .sp .6
246 241 .RS 4n
247 242 The resource is not present or not usable but has no known problems. This might
248 243 indicate the resource has been disabled or deconfigured by an administrator.
249 244 Consult appropriate management tools for more information.
250 245 .RE
251 246
252 247 .sp
253 248 .ne 2
254 249 .na
255 250 \fB\fBfaulted\fR\fR
256 251 .ad
257 252 .sp .6
258 253 .RS 4n
259 254 The resource is present but is not usable because one or more problems have
260 255 been diagnosed by the Fault Manager. The resource has been disabled to prevent
261 256 further damage to the system.
262 257 .RE
263 258
264 259 .sp
265 260 .ne 2
266 261 .na
267 262 \fB\fBdegraded\fR\fR
268 263 .ad
269 264 .sp .6
270 265 .RS 4n
271 266 The resource is present and usable, but one or more problems have been
272 267 diagnosed in the resource by the Fault Manager.
273 268 .sp
274 269 If all affected resources are in the same state, this is reflected in the
275 270 message at the end of the list. Otherwise the state is given after each
276 271 affected resource.
277 272 .RE
278 273
279 274 .sp
280 275 .ne 2
281 276 .na
282 277 \fB\fBfmadm flush\fR \fIfmri\fR\fR
283 278 .ad
284 279 .sp .6
285 280 .RS 4n
286 281 Flush the information cached by the Fault Manager for the specified resource,
287 282 named by its FMRI. This subcommand should only be used when indicated by a
288 283 documented repair procedure. Typically, the use of this command is not
289 284 necessary as the Fault Manager keeps its cache up-to-date automatically. If a
290 285 faulty resource is flushed from the cache, administrators might need to apply
291 286 additional commands to enable the specified resource.
292 287 .RE
293 288
294 289 .sp
295 290 .ne 2
296 291 .na
297 292 \fB\fBfmadm load\fR \fIpath\fR\fR
298 293 .ad
299 294 .sp .6
300 295 .RS 4n
301 296 Load the specified Fault Manager module. \fIpath\fR must be an absolute path
302 297 and must refer to a module present in one of the defined directories for
303 298 modules. Typically, the use of this command is not necessary as the Fault
304 299 Manager loads modules automatically when the operating system initially boots
305 300 or as needed.
306 301 .RE
307 302
308 303 .sp
309 304 .ne 2
310 305 .na
311 306 \fB\fBfmadm unload\fR \fImodule\fR\fR
312 307 .ad
313 308 .sp .6
314 309 .RS 4n
315 310 Unload the specified Fault Manager module. Specify \fImodule\fR using the
316 311 basename listed in the \fBfmadm config\fR output. Typically, the use of this
317 312 command is not necessary as the Fault Manager loads and unloads modules
318 313 automatically based on the system configuration
319 314 .RE
320 315
321 316 .sp
322 317 .ne 2
323 318 .na
324 319 \fB\fBfmadm repaired\fR \fIfmri\fR \fB|\fR \fIlabel\fR\fR
325 320 .ad
326 321 .sp .6
327 322 .RS 4n
328 323 Notify the Fault Manager that a repair procedure has been carried out on the
329 324 specified resource. The \fBfmadm repaired\fR subcommand should be used only at
330 325 the direction of a documented repair procedure. Administrators might need
331 326 to apply additional commands to re-enable a previously faulted resource.
332 327 .RE
333 328
334 329 .sp
335 330 .ne 2
336 331 .na
337 332 \fB\fBfmadm replaced\fR \fIfmri\fR \fB|\fR \fIlabel\fR\fR
338 333 .ad
339 334 .sp .6
340 335 .RS 4n
341 336 Notify the Fault Manager that the specified resource has been replaced. This
342 337 command should be used in those cases where the Fault Manager is unable to
343 338 automatically detect the replacement. The \fBfmadm replaced\fR subcommand
344 339 should be used only at the direction of a documented repair procedure.
345 340 Administrators might need to apply additional commands to re-enable a
346 341 previously faulted resource.
347 342 .RE
348 343
349 344 .sp
350 345 .ne 2
351 346 .na
352 347 \fB\fBfmadm reset\fR [\fB-s\fR \fIserd\fR\fB]\fR \fImodule\fR\fR
353 348 .ad
354 349 .sp .6
355 350 .RS 4n
356 351 Reset the specified Fault Manager module or module subcomponent. If the
357 352 \fB-s\fR option is present, the specified Soft Error Rate Discrimination (SERD)
358 353 engine is reset within the module. If the \fB-s\fR option is not present, the
359 354 entire module is reset and all persistent state associated with the module is
360 355 deleted. The \fBfmadm reset\fR subcommand should only be used at the direction
361 356 of a documented repair procedure. The use of this command is typically not
362 357 necessary as the Fault Manager manages its modules automatically.
363 358 .RE
364 359
365 360 .sp
366 361 .ne 2
367 362 .na
368 363 \fB\fBfmadm rotate\fR \fBerrlog | fltlog\fR\fR
369 364 .ad
370 365 .sp .6
371 366 .RS 4n
372 367 The \fBrotate\fR subcommand is a helper command for \fBlogadm\fR(1M), so that
373 368 \fBlogadm\fR can rotate live log files correctly. It is not intended to be
374 369 invoked directly. Use one of the following commands to cause the appropriate
375 370 logfile to be rotated, if the current one is not zero in size:
376 371 .sp
377 372 .in +2
|
↓ open down ↓ |
302 lines elided |
↑ open up ↑ |
378 373 .nf
379 374 # \fBlogadm -p now -s 1b /var/fm/fmd/errlog\fR
380 375 # \fBlogadm -p now -s 1b /var/fm/fmd/fltlog\fR
381 376 .fi
382 377 .in -2
383 378 .sp
384 379
385 380 .RE
386 381
387 382 .SH OPTIONS
388 -.sp
389 -.LP
390 383 The following options are supported:
391 384 .sp
392 385 .ne 2
393 386 .na
394 387 \fB\fB-q\fR\fR
395 388 .ad
396 389 .RS 6n
397 390 Set quiet mode. \fBfmadm\fR does not produce messages indicating the result of
398 391 successful operations to standard output.
399 392 .RE
400 393
401 394 .SH OPERANDS
402 -.sp
403 -.LP
404 395 The following operands are supported:
405 396 .sp
406 397 .ne 2
407 398 .na
408 399 \fB\fIcmd\fR\fR
409 400 .ad
410 401 .RS 8n
411 402 The name of a subcommand listed in \fBSUBCOMMANDS\fR.
412 403 .RE
413 404
414 405 .sp
|
↓ open down ↓ |
1 lines elided |
↑ open up ↑ |
415 406 .ne 2
416 407 .na
417 408 \fB\fIargs\fR\fR
418 409 .ad
419 410 .RS 8n
420 411 One or more options or arguments appropriate for the selected \fIsubcommand\fR,
421 412 as described in \fBSUBCOMMANDS\fR.
422 413 .RE
423 414
424 415 .SH EXIT STATUS
425 -.sp
426 -.LP
427 416 The following exit values are returned:
428 417 .sp
429 418 .ne 2
430 419 .na
431 420 \fB\fB0\fR\fR
432 421 .ad
433 422 .RS 5n
434 423 Successful completion.
435 424 .RE
436 425
437 426 .sp
438 427 .ne 2
439 428 .na
440 429 \fB\fB1\fR\fR
441 430 .ad
442 431 .RS 5n
443 432 An error occurred. Errors include a failure to communicate with \fBfmd\fR or
444 433 insufficient privileges to perform the requested operation.
445 434 .RE
446 435
|
↓ open down ↓ |
10 lines elided |
↑ open up ↑ |
447 436 .sp
448 437 .ne 2
449 438 .na
450 439 \fB\fB2\fR\fR
451 440 .ad
452 441 .RS 5n
453 442 Invalid command-line options were specified.
454 443 .RE
455 444
456 445 .SH ATTRIBUTES
457 -.sp
458 -.LP
459 446 See \fBattributes\fR(5) for descriptions of the following attributes:
460 447 .sp
461 448
462 449 .sp
463 450 .TS
464 451 box;
465 452 c | c
466 453 l | l .
467 454 ATTRIBUTE TYPE ATTRIBUTE VALUE
468 455 _
469 456 Interface Stability See below.
470 457 .TE
471 458
472 459 .sp
473 460 .LP
474 461 The command-line options are Committed. The human-readable output is
475 462 not-an-interface.
476 463 .SH SEE ALSO
477 -.sp
478 -.LP
479 464 \fBfmd\fR(1M), \fBfmdump\fR(1M), \fBfmstat\fR(1M), \fBlogadm\fR(1M),
480 -\fBsyslogd\fR(1M), \fBattributes\fR(5)
465 +\fBsyslogd\fR(1M), \fBattributes\fR(5), \fBprivileges\fR(5)
481 466 .sp
482 467 .LP
483 -\fI\fR
484 -.sp
485 -.LP
486 468 http://illumos.org/msg/
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX