.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "XSTAT_FS_TEST 1" .TH XSTAT_FS_TEST 1 "2023-12-24" "OpenAFS" "AFS Command Reference" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" xstat_fs_test \- Displays data collections from the File Server process .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBxstat_fs_test\fR [\fIinitcmd\fR] \fB\-fsname\fR\ <\fIfile\ server\ name(s)\ to\ monitor\fR>+ \fB\-collID\fR\ <\fIcollection(s)\ to\ fetch\fR>+ [\fB\-onceonly\fR] [\fB\-frequency\fR\ <\fIpoll\ frequency,\ in\ seconds\fR>] [\fB\-period\fR\ <\fIdata\ collection\ time,\ in\ minutes\fR>] [\fB\-debug\fR] [\fB\-version\fR] [\fB\-help\fR] .PP \&\fBxstat_fs_test\fR [\fBinitcmd\fR] \fB\-fs\fR\ <\fIFile\ Server\ name(s)\ to\ monitor\fR>+ \fB\-c\fR\ <\fICollection(s)\ to\ fetch\fR>+ [\fB\-o\fR] [\fB\-fr\fR\ <\fIpoll\ frequency,\ in\ seconds\fR>] [\fB\-p\fR\ <\fIdata\ collection\ time,\ in\ minutes\fR>] [\fB\-d\fR] [\fB\-version\fR] [\fB\-h\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \fBxstat_fs_test\fR command tests the routines in the \fIlibxstat_fs.a\fR library and displays the data collections associated with the File Server (the \f(CW\*(C`fs\*(C'\fR process). The command executes in the foreground. .PP The command produces a large volume of output; to save it for later analysis, direct it to a file. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fIinitcmd\fR" 4 .IX Item "initcmd" Accommodates the command's use of the \s-1AFS\s0 command parser, and is optional. .IP "\fB\-fsname\fR <\fIfile server name to monitor\fR>+" 4 .IX Item "-fsname +" Specifies the fully qualified hostname of each file server machine for which to monitor the File Server process. .IP "\fB\-collID\fR <\fIcollection to fetch\fR>+" 4 .IX Item "-collID +" Specifies each data collection to return, which defines the type and amount of data the command interpreter gathers about the File Server. Data is returned in a predefined data structure. .Sp There are four acceptable values: .RS 4 .ie n .IP "0" 4 .el .IP "\f(CW0\fR" 4 .IX Item "0" Provides profiling information about the numbers of times different internal File Server routines were called since the File Server started. This value is not currently implemented; it returns no data. .ie n .IP "1" 4 .el .IP "\f(CW1\fR" 4 .IX Item "1" Reports various internal performance statistics related to the File Server (for example, vnode cache entries and Rx protocol activity). .ie n .IP "2" 4 .el .IP "\f(CW2\fR" 4 .IX Item "2" Reports all of the internal performance statistics provided by the \f(CW1\fR setting, plus some additional, detailed performance figures about the File Server (for example, minimum, maximum, and cumulative statistics regarding File Server RPCs, how long they take to complete, and how many succeed). .ie n .IP "3" 4 .el .IP "\f(CW3\fR" 4 .IX Item "3" Reports File Server callback processing statistics since the File Server started, including the number of call of callbacks added (AddCallBack), the number of callbacks broken (BreakCallBacks), and the number of callback space reclaims (GetSomeSpaces). .RE .RS 4 .RE .IP "\fB\-onceonly\fR" 4 .IX Item "-onceonly" Gathers statistics just one time. Omit this flag to have the command continue to probe the Cache Manager for statistics at the frequency specified by the \fB\-frequency\fR argument; in this case press Ctrl-C to stop the probes. .IP "\fB\-frequency\fR <\fIpoll frequency\fR>" 4 .IX Item "-frequency " Sets the frequency in seconds at which the program initiates probes to the Cache Manager. The default is 30 seconds. .IP "\fB\-period\fR <\fIdata collection time\fR>" 4 .IX Item "-period " Sets the number of minutes the program runs; at the end of this period of time, the program exits. The default is 10 minutes. .IP "\fB\-debug\fR" 4 .IX Item "-debug" Displays a trace on the standard output stream as the command runs. .IP "\fB\-help\fR" 4 .IX Item "-help" Prints the online help for this command. All other valid options are ignored. .IP "\fB\-version\fR" 4 .IX Item "-version" Prints the program version and then exits. All other valid options are ignored. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBxstat_cm_test\fR\|(1) .SH "COPYRIGHT" .IX Header "COPYRIGHT" \&\s-1IBM\s0 Corporation 2000. All Rights Reserved. .PP This documentation is covered by the \s-1IBM\s0 Public License Version 1.0. It was converted from \s-1HTML\s0 to \s-1POD\s0 by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.