Print this page
11621 fmadm and fmstat document privileges incorrectly
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man1m/fmstat.1m
+++ new/usr/src/man/man1m/fmstat.1m
1 1 '\" te
2 2 .\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
3 +.\" Copyright 2019 Peter Tribble
3 4 .\" 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.
4 5 .\" 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
5 6 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 -.TH FMSTAT 1M "Jun 16, 2009"
7 +.TH FMSTAT 1M "Aug 26, 2019"
7 8 .SH NAME
8 9 fmstat \- report fault management module statistics
9 10 .SH SYNOPSIS
10 -.LP
11 11 .nf
12 12 \fBfmstat\fR [\fB-astTz\fR] [\fB-d\fR u | d ] [\fB-m\fR \fImodule\fR] [\fIinterval\fR [\fIcount\fR]]
13 13 .fi
14 14
15 15 .SH DESCRIPTION
16 -.sp
17 -.LP
18 16 The \fBfmstat\fR utility can be used by administrators and service personnel to
19 -report statistics associated with the Solaris Fault Manager, \fBfmd\fR(1M) and
17 +report statistics associated with the Fault Manager, \fBfmd\fR(1M) and
20 18 its associated set of modules. The Fault Manager runs in the background on each
21 -Solaris system. It receives telemetry information relating to problems detected
19 +system. It receives telemetry information relating to problems detected
22 20 by the system software, diagnoses these problems, and initiates proactive
23 21 self-healing activities such as disabling faulty components.
24 22 .sp
25 23 .LP
26 24 You can use \fBfmstat\fR to view statistics for diagnosis engines and agents
27 25 that are currently participating in fault management. The documentation for
28 26 \fBfmd\fR(1M), \fBfmadm\fR(1M), and \fBfmdump\fR(1M) describes more about tools
29 27 to observe fault management activities.
30 28 .sp
31 29 .LP
32 30 If the \fB-m\fR option is present or the \fB-t\fR option is present,
33 31 \fBfmstat\fR reports any statistics kept by the specified fault management
34 32 module. The module list can be obtained using \fBfmadm config\fR.
35 33 .sp
36 34 .LP
37 35 If the \fB-m\fR option is not present, \fBfmstat\fR reports the following
38 36 statistics for each of its client modules:
39 37 .sp
40 38 .ne 2
41 39 .na
42 40 \fB\fBmodule\fR\fR
43 41 .ad
44 42 .RS 11n
45 43 The name of the fault management module, as reported by \fBfmadm config\fR.
46 44 .RE
47 45
48 46 .sp
49 47 .ne 2
50 48 .na
51 49 \fB\fBev_recv\fR\fR
52 50 .ad
53 51 .RS 11n
54 52 The number of telemetry events received by the module.
55 53 .RE
56 54
57 55 .sp
58 56 .ne 2
59 57 .na
60 58 \fB\fBev_acpt\fR\fR
61 59 .ad
62 60 .RS 11n
63 61 The number of events accepted by the module as relevant to a diagnosis.
64 62 .RE
65 63
66 64 .sp
67 65 .ne 2
68 66 .na
69 67 \fB\fBwait\fR\fR
70 68 .ad
71 69 .RS 11n
72 70 The average number of telemetry events waiting to be examined by the module.
73 71 .RE
74 72
75 73 .sp
76 74 .ne 2
77 75 .na
78 76 \fB\fBsvc_t\fR\fR
79 77 .ad
80 78 .RS 11n
81 79 The average service time for telemetry events received by the module, in
82 80 milliseconds.
83 81 .RE
84 82
85 83 .sp
86 84 .ne 2
87 85 .na
88 86 \fB\fB%w\fR\fR
89 87 .ad
90 88 .RS 11n
91 89 The percentage of time that there were telemetry events waiting to be examined
92 90 by the module.
93 91 .RE
94 92
95 93 .sp
96 94 .ne 2
97 95 .na
98 96 \fB\fB%b\fR\fR
99 97 .ad
100 98 .RS 11n
101 99 The percentage of time that the module was busy processing telemetry events.
102 100 .RE
103 101
104 102 .sp
105 103 .ne 2
106 104 .na
107 105 \fB\fBopen\fR\fR
108 106 .ad
109 107 .RS 11n
110 108 The number of active cases (open problem investigations) owned by the module.
111 109 .RE
112 110
113 111 .sp
114 112 .ne 2
115 113 .na
116 114 \fB\fBsolve\fR\fR
117 115 .ad
118 116 .RS 11n
119 117 The total number of cases solved by this module since it was loaded.
120 118 .RE
121 119
122 120 .sp
123 121 .ne 2
124 122 .na
125 123 \fB\fBmemsz\fR\fR
126 124 .ad
127 125 .RS 11n
128 126 The amount of dynamic memory currently allocated by this module.
129 127 .RE
130 128
131 129 .sp
|
↓ open down ↓ |
100 lines elided |
↑ open up ↑ |
132 130 .ne 2
133 131 .na
134 132 \fB\fBbufsz\fR\fR
135 133 .ad
136 134 .RS 11n
137 135 The amount of persistent buffer space currently allocated by this module.
138 136 .RE
139 137
140 138 .sp
141 139 .LP
142 -The \fBfmstat\fR utility requires the user to posses the \fBSYS_CONFIG\fR
143 -privilege. Refer to the \fI\fR for more information about how to configure
144 -Solaris privileges.
140 +The \fBfmstat\fR utility requires the user to possess the \fBPRIV_SYS_ADMIN\fR
141 +privilege. See \fBprivileges\fR(5).
145 142 .SH OPTIONS
146 -.sp
147 -.LP
148 143 The following options are supported:
149 144 .sp
150 145 .ne 2
151 146 .na
152 147 \fB\fB-a\fR\fR
153 148 .ad
154 149 .RS 13n
155 150 Print all statistics for a module, including those kept on its behalf by
156 151 \fBfmd\fR. If the \fB-a\fR option is not present, only those statistics kept by
157 152 the module are reported. If the \fB-a\fR option is used without the \fB-m\fR
158 153 \fImodule\fR, a set of global statistics associated with \fBfmd\fR are
159 154 displayed.
160 155 .RE
161 156
162 157 .sp
163 158 .ne 2
164 159 .na
165 160 \fB\fB-d\fR \fBu\fR | \fBd\fR\fR
166 161 .ad
167 162 .RS 13n
168 163 Display a time stamp.
169 164 .sp
170 165 Specify \fBu\fR for a printed representation of the internal representation of
171 166 time. See \fBtime\fR(2). Specify \fBd\fR for standard date format. See
172 167 \fBdate\fR(1).
173 168 .RE
174 169
175 170 .sp
176 171 .ne 2
177 172 .na
178 173 \fB\fB-m\fR \fImodule\fR\fR
179 174 .ad
180 175 .RS 13n
181 176 Print a report on the statistics associated with the specified fault management
182 177 module, instead of the default statistics report. Modules can publish an
183 178 arbitrary set of statistics to help Sun service the fault management software
184 179 itself. The module statistics constitute a Private interface. See
185 180 \fBattributes\fR(5) for information on Sun's rules for Private interfaces.
186 181 Scripts should not be written that depend upon the values of fault management
187 182 module statistics as they can change without notice.
188 183 .RE
189 184
190 185 .sp
191 186 .ne 2
192 187 .na
193 188 \fB\fB-s\fR\fR
194 189 .ad
195 190 .RS 13n
196 191 Print a report on Soft Error Rate Discrimination (SERD) engines associated with
197 192 the module instead of the default module statistics report. A SERD engine is a
198 193 construct used by fault management software to determine if a statistical
199 194 threshold measured as \fIN\fR events in some time \fIT\fR has been exceeded.
200 195 The \fB-s\fR option can only be used in combination with the \fB-m\fR option.
201 196 .RE
202 197
203 198 .sp
204 199 .ne 2
205 200 .na
206 201 \fB\fB-t\fR\fR
207 202 .ad
208 203 .RS 13n
209 204 Print a report on the statistics associated with each fault management event
210 205 transport. Each fault management module can provide the implementation of one
211 206 or more event transports.
212 207 .RE
213 208
214 209 .sp
215 210 .ne 2
216 211 .na
217 212 \fB\fB-T\fR\fR
218 213 .ad
219 214 .RS 13n
220 215 Print a table of the authority information associated with each fault
221 216 management event transport. If the \fB-m\fR option is present, only transports
222 217 associated with the specified module are displayed.
223 218 .RE
224 219
225 220 .sp
226 221 .ne 2
|
↓ open down ↓ |
69 lines elided |
↑ open up ↑ |
227 222 .na
228 223 \fB\fB-z\fR\fR
229 224 .ad
230 225 .RS 13n
231 226 Omit statistics with a zero value from the report associated with the specified
232 227 fault management module. The \fB-z\fR option can only be used in combination
233 228 with the \fB-m\fR option.
234 229 .RE
235 230
236 231 .SH OPERANDS
237 -.sp
238 -.LP
239 232 The following operands are supported:
240 233 .sp
241 234 .ne 2
242 235 .na
243 236 \fB\fIcount\fR\fR
244 237 .ad
245 238 .RS 12n
246 239 Print only count reports, and then exit.
247 240 .RE
248 241
249 242 .sp
250 243 .ne 2
251 244 .na
252 245 \fB\fIinterval\fR\fR
253 246 .ad
254 247 .RS 12n
|
↓ open down ↓ |
6 lines elided |
↑ open up ↑ |
255 248 Print a new report every \fIinterval\fR seconds.
256 249 .RE
257 250
258 251 .sp
259 252 .LP
260 253 If no \fIinterval\fR and no \fIcount\fR are specified, a single report is
261 254 printed and \fBfmstat\fR exits. If an \fIinterval\fR is specified but no
262 255 \fIcount\fR is specified, \fBfmstat\fR prints reports every \fIinterval\fR
263 256 seconds indefinitely until the command is interrupted.
264 257 .SH EXIT STATUS
265 -.sp
266 -.LP
267 258 The following exit values are returned:
268 259 .sp
269 260 .ne 2
270 261 .na
271 262 \fB\fB0\fR\fR
272 263 .ad
273 264 .RS 5n
274 265 Successful completion.
275 266 .RE
276 267
277 268 .sp
278 269 .ne 2
279 270 .na
280 271 \fB\fB1\fR\fR
281 272 .ad
282 273 .RS 5n
283 274 A fatal error occurred. A fatal error could be the failure to communicate with
284 275 \fBfmd\fR(1M). It could also be that insufficient privileges were available to
285 276 perform the requested operation.
286 277 .RE
287 278
|
↓ open down ↓ |
11 lines elided |
↑ open up ↑ |
288 279 .sp
289 280 .ne 2
290 281 .na
291 282 \fB\fB2\fR\fR
292 283 .ad
293 284 .RS 5n
294 285 Invalid command-line options were specified.
295 286 .RE
296 287
297 288 .SH ATTRIBUTES
298 -.sp
299 -.LP
300 289 See \fBattributes\fR(5) for descriptions of the following attributes:
301 290 .sp
302 291
303 292 .sp
304 293 .TS
305 294 box;
306 295 c | c
307 296 l | l .
308 297 ATTRIBUTE TYPE ATTRIBUTE VALUE
309 298 _
310 299 Interface Stability See below.
311 300 .TE
312 301
313 302 .sp
314 303 .LP
315 304 The command-line options are Evolving. The human-readable default report is
316 305 Unstable. The human-readable module report is Private.
317 306 .SH SEE ALSO
318 -.sp
319 -.LP
320 -\fBfmadm\fR(1M), \fBfmd\fR(1M), \fBfmdump\fR(1M), \fBattributes\fR(5)
321 -.sp
322 -.LP
323 -\fI\fR
307 +\fBfmadm\fR(1M), \fBfmd\fR(1M), \fBfmdump\fR(1M), \fBattributes\fR(5),
308 +\fBprivileges\fR(5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX