1 '\" te
2 .\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
3 .\" 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 .\" 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 .\" 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 .SH NAME
8 fmstat \- report fault management module statistics
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBfmstat\fR [\fB-astTz\fR] [\fB-d\fR u | d ] [\fB-m\fR \fImodule\fR] [\fIinterval\fR [\fIcount\fR]]
13 .fi
14
15 .SH DESCRIPTION
16 .sp
17 .LP
18 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
20 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
22 by the system software, diagnoses these problems, and initiates proactive
23 self-healing activities such as disabling faulty components.
24 .sp
25 .LP
26 You can use \fBfmstat\fR to view statistics for diagnosis engines and agents
27 that are currently participating in fault management. The documentation for
28 \fBfmd\fR(1M), \fBfmadm\fR(1M), and \fBfmdump\fR(1M) describes more about tools
29 to observe fault management activities.
30 .sp
31 .LP
32 If the \fB-m\fR option is present or the \fB-t\fR option is present,
33 \fBfmstat\fR reports any statistics kept by the specified fault management
34 module. The module list can be obtained using \fBfmadm config\fR.
35 .sp
36 .LP
37 If the \fB-m\fR option is not present, \fBfmstat\fR reports the following
38 statistics for each of its client modules:
39 .sp
40 .ne 2
41 .na
122 .sp
123 .ne 2
124 .na
125 \fB\fBmemsz\fR\fR
126 .ad
127 .RS 11n
128 The amount of dynamic memory currently allocated by this module.
129 .RE
130
131 .sp
132 .ne 2
133 .na
134 \fB\fBbufsz\fR\fR
135 .ad
136 .RS 11n
137 The amount of persistent buffer space currently allocated by this module.
138 .RE
139
140 .sp
141 .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.
145 .SH OPTIONS
146 .sp
147 .LP
148 The following options are supported:
149 .sp
150 .ne 2
151 .na
152 \fB\fB-a\fR\fR
153 .ad
154 .RS 13n
155 Print all statistics for a module, including those kept on its behalf by
156 \fBfmd\fR. If the \fB-a\fR option is not present, only those statistics kept by
157 the module are reported. If the \fB-a\fR option is used without the \fB-m\fR
158 \fImodule\fR, a set of global statistics associated with \fBfmd\fR are
159 displayed.
160 .RE
161
162 .sp
163 .ne 2
164 .na
165 \fB\fB-d\fR \fBu\fR | \fBd\fR\fR
166 .ad
167 .RS 13n
217 \fB\fB-T\fR\fR
218 .ad
219 .RS 13n
220 Print a table of the authority information associated with each fault
221 management event transport. If the \fB-m\fR option is present, only transports
222 associated with the specified module are displayed.
223 .RE
224
225 .sp
226 .ne 2
227 .na
228 \fB\fB-z\fR\fR
229 .ad
230 .RS 13n
231 Omit statistics with a zero value from the report associated with the specified
232 fault management module. The \fB-z\fR option can only be used in combination
233 with the \fB-m\fR option.
234 .RE
235
236 .SH OPERANDS
237 .sp
238 .LP
239 The following operands are supported:
240 .sp
241 .ne 2
242 .na
243 \fB\fIcount\fR\fR
244 .ad
245 .RS 12n
246 Print only count reports, and then exit.
247 .RE
248
249 .sp
250 .ne 2
251 .na
252 \fB\fIinterval\fR\fR
253 .ad
254 .RS 12n
255 Print a new report every \fIinterval\fR seconds.
256 .RE
257
258 .sp
259 .LP
260 If no \fIinterval\fR and no \fIcount\fR are specified, a single report is
261 printed and \fBfmstat\fR exits. If an \fIinterval\fR is specified but no
262 \fIcount\fR is specified, \fBfmstat\fR prints reports every \fIinterval\fR
263 seconds indefinitely until the command is interrupted.
264 .SH EXIT STATUS
265 .sp
266 .LP
267 The following exit values are returned:
268 .sp
269 .ne 2
270 .na
271 \fB\fB0\fR\fR
272 .ad
273 .RS 5n
274 Successful completion.
275 .RE
276
277 .sp
278 .ne 2
279 .na
280 \fB\fB1\fR\fR
281 .ad
282 .RS 5n
283 A fatal error occurred. A fatal error could be the failure to communicate with
284 \fBfmd\fR(1M). It could also be that insufficient privileges were available to
285 perform the requested operation.
286 .RE
287
288 .sp
289 .ne 2
290 .na
291 \fB\fB2\fR\fR
292 .ad
293 .RS 5n
294 Invalid command-line options were specified.
295 .RE
296
297 .SH ATTRIBUTES
298 .sp
299 .LP
300 See \fBattributes\fR(5) for descriptions of the following attributes:
301 .sp
302
303 .sp
304 .TS
305 box;
306 c | c
307 l | l .
308 ATTRIBUTE TYPE ATTRIBUTE VALUE
309 _
310 Interface Stability See below.
311 .TE
312
313 .sp
314 .LP
315 The command-line options are Evolving. The human-readable default report is
316 Unstable. The human-readable module report is Private.
317 .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
|
1 '\" te
2 .\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
3 .\" Copyright 2019 Peter Tribble
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.
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
6 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 .TH FMSTAT 1M "Aug 26, 2019"
8 .SH NAME
9 fmstat \- report fault management module statistics
10 .SH SYNOPSIS
11 .nf
12 \fBfmstat\fR [\fB-astTz\fR] [\fB-d\fR u | d ] [\fB-m\fR \fImodule\fR] [\fIinterval\fR [\fIcount\fR]]
13 .fi
14
15 .SH DESCRIPTION
16 The \fBfmstat\fR utility can be used by administrators and service personnel to
17 report statistics associated with the Fault Manager, \fBfmd\fR(1M) and
18 its associated set of modules. The Fault Manager runs in the background on each
19 system. It receives telemetry information relating to problems detected
20 by the system software, diagnoses these problems, and initiates proactive
21 self-healing activities such as disabling faulty components.
22 .sp
23 .LP
24 You can use \fBfmstat\fR to view statistics for diagnosis engines and agents
25 that are currently participating in fault management. The documentation for
26 \fBfmd\fR(1M), \fBfmadm\fR(1M), and \fBfmdump\fR(1M) describes more about tools
27 to observe fault management activities.
28 .sp
29 .LP
30 If the \fB-m\fR option is present or the \fB-t\fR option is present,
31 \fBfmstat\fR reports any statistics kept by the specified fault management
32 module. The module list can be obtained using \fBfmadm config\fR.
33 .sp
34 .LP
35 If the \fB-m\fR option is not present, \fBfmstat\fR reports the following
36 statistics for each of its client modules:
37 .sp
38 .ne 2
39 .na
120 .sp
121 .ne 2
122 .na
123 \fB\fBmemsz\fR\fR
124 .ad
125 .RS 11n
126 The amount of dynamic memory currently allocated by this module.
127 .RE
128
129 .sp
130 .ne 2
131 .na
132 \fB\fBbufsz\fR\fR
133 .ad
134 .RS 11n
135 The amount of persistent buffer space currently allocated by this module.
136 .RE
137
138 .sp
139 .LP
140 The \fBfmstat\fR utility requires the user to possess the \fBPRIV_SYS_ADMIN\fR
141 privilege. See \fBprivileges\fR(5).
142 .SH OPTIONS
143 The following options are supported:
144 .sp
145 .ne 2
146 .na
147 \fB\fB-a\fR\fR
148 .ad
149 .RS 13n
150 Print all statistics for a module, including those kept on its behalf by
151 \fBfmd\fR. If the \fB-a\fR option is not present, only those statistics kept by
152 the module are reported. If the \fB-a\fR option is used without the \fB-m\fR
153 \fImodule\fR, a set of global statistics associated with \fBfmd\fR are
154 displayed.
155 .RE
156
157 .sp
158 .ne 2
159 .na
160 \fB\fB-d\fR \fBu\fR | \fBd\fR\fR
161 .ad
162 .RS 13n
212 \fB\fB-T\fR\fR
213 .ad
214 .RS 13n
215 Print a table of the authority information associated with each fault
216 management event transport. If the \fB-m\fR option is present, only transports
217 associated with the specified module are displayed.
218 .RE
219
220 .sp
221 .ne 2
222 .na
223 \fB\fB-z\fR\fR
224 .ad
225 .RS 13n
226 Omit statistics with a zero value from the report associated with the specified
227 fault management module. The \fB-z\fR option can only be used in combination
228 with the \fB-m\fR option.
229 .RE
230
231 .SH OPERANDS
232 The following operands are supported:
233 .sp
234 .ne 2
235 .na
236 \fB\fIcount\fR\fR
237 .ad
238 .RS 12n
239 Print only count reports, and then exit.
240 .RE
241
242 .sp
243 .ne 2
244 .na
245 \fB\fIinterval\fR\fR
246 .ad
247 .RS 12n
248 Print a new report every \fIinterval\fR seconds.
249 .RE
250
251 .sp
252 .LP
253 If no \fIinterval\fR and no \fIcount\fR are specified, a single report is
254 printed and \fBfmstat\fR exits. If an \fIinterval\fR is specified but no
255 \fIcount\fR is specified, \fBfmstat\fR prints reports every \fIinterval\fR
256 seconds indefinitely until the command is interrupted.
257 .SH EXIT STATUS
258 The following exit values are returned:
259 .sp
260 .ne 2
261 .na
262 \fB\fB0\fR\fR
263 .ad
264 .RS 5n
265 Successful completion.
266 .RE
267
268 .sp
269 .ne 2
270 .na
271 \fB\fB1\fR\fR
272 .ad
273 .RS 5n
274 A fatal error occurred. A fatal error could be the failure to communicate with
275 \fBfmd\fR(1M). It could also be that insufficient privileges were available to
276 perform the requested operation.
277 .RE
278
279 .sp
280 .ne 2
281 .na
282 \fB\fB2\fR\fR
283 .ad
284 .RS 5n
285 Invalid command-line options were specified.
286 .RE
287
288 .SH ATTRIBUTES
289 See \fBattributes\fR(5) for descriptions of the following attributes:
290 .sp
291
292 .sp
293 .TS
294 box;
295 c | c
296 l | l .
297 ATTRIBUTE TYPE ATTRIBUTE VALUE
298 _
299 Interface Stability See below.
300 .TE
301
302 .sp
303 .LP
304 The command-line options are Evolving. The human-readable default report is
305 Unstable. The human-readable module report is Private.
306 .SH SEE ALSO
307 \fBfmadm\fR(1M), \fBfmd\fR(1M), \fBfmdump\fR(1M), \fBattributes\fR(5),
308 \fBprivileges\fR(5)
|