Print this page
11621 fmadm and fmstat document privileges incorrectly
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man1m/fmadm.1m.man.txt
+++ new/usr/src/man/man1m/fmadm.1m.man.txt
1 1 FMADM(1M) Maintenance Commands FMADM(1M)
2 2
3 3
4 4
5 5 NAME
6 6 fmadm - fault management configuration tool
7 7
8 8 SYNOPSIS
9 9 fmadm [-q] [subcommand [arguments]]
10 10
11 11
12 12 DESCRIPTION
13 13 The fmadm utility can be used by administrators and service personnel
14 14 to view and modify system configuration parameters maintained by the
15 15 Fault Manager, fmd(1M). fmd receives telemetry information relating to
16 16 problems detected by the system software, diagnoses these problems, and
17 17 initiates proactive self-healing activities such as disabling faulty
18 18 components.
19 19
20 20
21 21 fmadm can be used to:
22 22
23 23 o view the set of diagnosis engines and agents that are
24 24 currently participating in fault management,
25 25
26 26 o view the list of system components that have been diagnosed
27 27 as faulty, and
28 28
29 29 o perform administrative tasks related to these entities.
30 30
31 31
32 32 The Fault Manager attempts to automate as many activities as possible,
|
↓ open down ↓ |
32 lines elided |
↑ open up ↑ |
33 33 so use of fmadm is typically not required. When the Fault Manager needs
34 34 help from a human administrator, it produces a message indicating its
35 35 needs. It also refers you to a knowledge article on
36 36 http://illumos.org/msg/. This web site might ask you to use fmadm or
37 37 one of the other fault management utilities to gather more information
38 38 or perform additional tasks. The documentation for fmd(1M), fmdump(1M),
39 39 and fmstat(1M) describe more about tools to observe fault management
40 40 activities.
41 41
42 42
43 - The fmadm utility requires the user to possess the SYS_CONFIG
44 - privilege. Refer to the for more information about how to configure
45 - privileges. The fmadm load subcommand requires that the user possess
46 - all privileges.
43 + The fmadm utility requires the user to possess the PRIV_SYS_ADMIN
44 + privilege. See privileges(5). The fmadm load subcommand requires that
45 + the user possess all privileges.
47 46
48 47 SUBCOMMANDS
49 48 fmadm accepts the following subcommands. Some of the subcommands accept
50 49 or require additional options and operands:
51 50
52 51 fmadm acquit fmri | label [uuid]
53 52
54 53 Notify the Fault Manager that the specified resource is not to be
55 54 considered to be a suspect in the fault event identified by uuid,
56 55 or if no UUID is specified, then in any fault or faults that have
57 56 been detected. The fmadm acquit subcommand should be used only at
58 57 the direction of a documented repair procedure. Administrators
59 58 might need to apply additional commands to re-enable a previously
60 59 faulted resource.
61 60
62 61
63 62 fmadm acquit uuid
64 63
65 64 Notify the Fault Manager that the fault event identified by uuid
66 65 can be safely ignored. The fmadm acquit subcommand should be used
67 66 only at the direction of a documented repair procedure.
68 67 Administrators might need to apply additional commands to re-enable
69 68 any previously faulted resources.
70 69
71 70
72 71 fmadm config
73 72
74 73 Display the configuration of the Fault Manager itself, including
75 74 the module name, version, and description of each component module.
76 75 Fault Manager modules provide services such as automated diagnosis,
77 76 self-healing, and messaging for hardware and software present on
78 77 the system.
79 78
80 79
81 80 fmadm faulty [-afgiprsv] [-n max] [-u uid]
82 81
83 82 Display status information for resources that the Fault Manager
84 83 currently believes to be faulty.
85 84
86 85 The following options are supported:
87 86
88 87 -a
89 88 Display all faults. By default, the fmadm faulty command
90 89 only lists output for resources that are currently
91 90 present and faulty. If you specify the -a option, all
92 91 resource information cached by the Fault Manager is
93 92 listed, including faults which have been automatically
94 93 corrected or where no recovery action is needed. The
95 94 listing includes information for resources that might no
96 95 longer be present in the system.
97 96
98 97
99 98 -f
100 99 Display faulty fru's (Field replaceable units).
101 100
102 101
103 102 -g
104 103 Group together faults which have the same fru, class and
105 104 fault message.
106 105
107 106
108 107 -i
109 108 Display persistent cache identifier for each resource in
110 109 the Fault Manager.
111 110
112 111
113 112 -n max
114 113 If faults or resources are grouped together with the -a
115 114 or -g options, limit the output to max entries.
116 115
117 116
118 117 -p
119 118 Pipe output through pager with form feed between each
120 119 fault.
121 120
122 121
123 122 -r
124 123 Display Fault Management Resource with their Identifier
125 124 (FMRI) and their fault management state.
126 125
127 126
128 127 -s
129 128 Display 1 line fault summary for each fault event.
130 129
131 130
132 131 -u uid
133 132 Only display fault with given uid.
134 133
135 134
136 135 -v
137 136 Display full output.
138 137
139 138 The percentage certainty is displayed if a fault has multiple
140 139 suspects, either of different classes or on different fru's. If
141 140 more than one resource is on the same fru and it is not 100%
142 141 certain that the fault is associated with the fru, the maximum
143 142 percentage certainty of the possible suspects on the fru is
144 143 displayed.
145 144
146 145
147 146
148 147 The Fault Manager associates the following states with every resource
149 148 for which telemetry information has been received:
150 149
151 150 ok
152 151
153 152 The resource is present and in use and has no known problems so far
154 153 as the Fault Manager is concerned.
155 154
156 155
157 156 unknown
158 157
159 158 The resource is not present or not usable but has no known
160 159 problems. This might indicate the resource has been disabled or
161 160 deconfigured by an administrator. Consult appropriate management
162 161 tools for more information.
163 162
164 163
165 164 faulted
166 165
167 166 The resource is present but is not usable because one or more
168 167 problems have been diagnosed by the Fault Manager. The resource has
169 168 been disabled to prevent further damage to the system.
170 169
171 170
172 171 degraded
173 172
174 173 The resource is present and usable, but one or more problems have
175 174 been diagnosed in the resource by the Fault Manager.
176 175
177 176 If all affected resources are in the same state, this is reflected
178 177 in the message at the end of the list. Otherwise the state is given
179 178 after each affected resource.
180 179
181 180
182 181 fmadm flush fmri
183 182
184 183 Flush the information cached by the Fault Manager for the specified
185 184 resource, named by its FMRI. This subcommand should only be used
186 185 when indicated by a documented repair procedure. Typically, the use
187 186 of this command is not necessary as the Fault Manager keeps its
188 187 cache up-to-date automatically. If a faulty resource is flushed
189 188 from the cache, administrators might need to apply additional
190 189 commands to enable the specified resource.
191 190
192 191
193 192 fmadm load path
194 193
195 194 Load the specified Fault Manager module. path must be an absolute
196 195 path and must refer to a module present in one of the defined
197 196 directories for modules. Typically, the use of this command is not
198 197 necessary as the Fault Manager loads modules automatically when the
199 198 operating system initially boots or as needed.
200 199
201 200
202 201 fmadm unload module
203 202
204 203 Unload the specified Fault Manager module. Specify module using the
205 204 basename listed in the fmadm config output. Typically, the use of
206 205 this command is not necessary as the Fault Manager loads and
207 206 unloads modules automatically based on the system configuration
208 207
209 208
210 209 fmadm repaired fmri | label
211 210
212 211 Notify the Fault Manager that a repair procedure has been carried
213 212 out on the specified resource. The fmadm repaired subcommand should
214 213 be used only at the direction of a documented repair procedure.
215 214 Administrators might need to apply additional commands to re-enable
216 215 a previously faulted resource.
217 216
218 217
219 218 fmadm replaced fmri | label
220 219
221 220 Notify the Fault Manager that the specified resource has been
222 221 replaced. This command should be used in those cases where the
223 222 Fault Manager is unable to automatically detect the replacement.
224 223 The fmadm replaced subcommand should be used only at the direction
225 224 of a documented repair procedure. Administrators might need to
226 225 apply additional commands to re-enable a previously faulted
227 226 resource.
228 227
229 228
230 229 fmadm reset [-s serd] module
231 230
232 231 Reset the specified Fault Manager module or module subcomponent. If
233 232 the -s option is present, the specified Soft Error Rate
234 233 Discrimination (SERD) engine is reset within the module. If the -s
235 234 option is not present, the entire module is reset and all
236 235 persistent state associated with the module is deleted. The fmadm
237 236 reset subcommand should only be used at the direction of a
238 237 documented repair procedure. The use of this command is typically
239 238 not necessary as the Fault Manager manages its modules
240 239 automatically.
241 240
242 241
243 242 fmadm rotate errlog | fltlog
244 243
245 244 The rotate subcommand is a helper command for logadm(1M), so that
246 245 logadm can rotate live log files correctly. It is not intended to
247 246 be invoked directly. Use one of the following commands to cause the
248 247 appropriate logfile to be rotated, if the current one is not zero
249 248 in size:
250 249
251 250 # logadm -p now -s 1b /var/fm/fmd/errlog
252 251 # logadm -p now -s 1b /var/fm/fmd/fltlog
253 252
254 253
255 254
256 255
257 256 OPTIONS
258 257 The following options are supported:
259 258
260 259 -q
261 260 Set quiet mode. fmadm does not produce messages indicating the
262 261 result of successful operations to standard output.
263 262
264 263
265 264 OPERANDS
266 265 The following operands are supported:
267 266
268 267 cmd
269 268 The name of a subcommand listed in SUBCOMMANDS.
270 269
271 270
272 271 args
273 272 One or more options or arguments appropriate for the selected
274 273 subcommand, as described in SUBCOMMANDS.
275 274
276 275
277 276 EXIT STATUS
278 277 The following exit values are returned:
279 278
280 279 0
281 280 Successful completion.
282 281
283 282
284 283 1
285 284 An error occurred. Errors include a failure to communicate with
286 285 fmd or insufficient privileges to perform the requested operation.
287 286
288 287
289 288 2
290 289 Invalid command-line options were specified.
291 290
292 291
293 292 ATTRIBUTES
294 293 See attributes(5) for descriptions of the following attributes:
295 294
296 295
297 296
298 297
299 298 +--------------------+-----------------+
|
↓ open down ↓ |
243 lines elided |
↑ open up ↑ |
300 299 | ATTRIBUTE TYPE | ATTRIBUTE VALUE |
301 300 +--------------------+-----------------+
302 301 |Interface Stability | See below. |
303 302 +--------------------+-----------------+
304 303
305 304
306 305 The command-line options are Committed. The human-readable output is
307 306 not-an-interface.
308 307
309 308 SEE ALSO
310 - fmd(1M), fmdump(1M), fmstat(1M), logadm(1M), syslogd(1M), attributes(5)
309 + fmd(1M), fmdump(1M), fmstat(1M), logadm(1M), syslogd(1M),
310 + attributes(5), privileges(5)
311 311
312 312
313 -
314 -
315 313 http://illumos.org/msg/
316 314
317 315
318 316
319 - October 22, 2008 FMADM(1M)
317 + August 26, 2019 FMADM(1M)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX