utils/nfsstat/nfsstat.man

   1 .\"
   2 .\" nfsstat(8)
   3 .\"
   4 .\" Copyright (C) 1996-2005 Olaf Kirch <okir@suse.de>
   5 .TH nfsstat 8 "7 Aug 2007"
   6 .SH NAME
   7 nfsstat \- list NFS statistics
   8 .SH SYNOPSIS
   9 .B nfsstat
  10 [\fIOPTION\fR]...
  11 .SH DESCRIPTION
  12 The
  13 .B nfsstat
  14 displays statistics kept about NFS client and server activity.
  15 .SH OPTIONS
  16 .TP
  17 .B \-s, \-\-server
  18 Print only server-side statistics. The default is to print both server and
  19 client statistics.
  20 .TP
  21 .B \-c, \-\-client
  22 Print only client-side statistics.
  23 .TP
  24 .B \-n, \-\-nfs
  25 Print only NFS statistics. The default is to print both NFS and RPC
  26 information.
  27 .TP
  28 .B \-2
  29 Print only NFS v2 statistics. The default is to only print information
  30 about the versions of \fBNFS\fR that have non-zero counts.
  31 .TP
  32 .B \-3
  33 Print only NFS v3 statistics. The default is to only print information
  34 about the versions of \fBNFS\fR that have non-zero counts.
  35 .TP
  36 .B \-4
  37 Print only NFS v4 statistics. The default is to only print information
  38 about the versions of \fBNFS\fR that have non-zero counts.
  39 .TP
  40 .B \-m, \-\-mounts
  41 Print information about each of the mounted \fBNFS\fR file systems.
  42
  43 If this option is used, all other options are ignored.
  44 .TP
  45 .B \-r, \-\-rpc
  46 Print only RPC statistics.
  47 .TP
  48 .BI \-o " facility
  49 Display statistics for the specified facility, which must be one of:
  50 .RS
  51 .TP
  52 .B nfs
  53 NFS protocol information, split up by RPC call.
  54 .TP
  55 .B rpc
  56 General RPC information.
  57 .TP
  58 .B net
  59 Network layer statistics, such as the number of received packets, number
  60 of TCP connections, etc.
  61 .TP
  62 .B fh
  63 Usage information on the server's file handle cache, including the
  64 total number of lookups, and the number of hits and misses.
  65 .TP
  66 .B rc
  67 Usage information on the server's request reply cache, including the
  68 total number of lookups, and the number of hits and misses.
  69 .TP
  70 .B all
  71 Display all of the above facilities.
  72 .RE
  73 .TP
  74 .B \-v, \-\-verbose
  75 This is equivalent to \fB\-o all\fR.
  76 .TP
  77 .B \-l, \-\-list
  78 Print information in list form.
  79 .TP
  80 .BI "\-S, \-\-since " file
  81 Instead of printing current statistics,
  82 .B nfsstat
  83 imports statistics from
  84 .I file
  85 and displays the difference between those and the current statistics.
  86 Valid input
  87 .IR file "s may be in the form of "
  88 .B /proc/net/rpc/nfs
  89 (raw client stats),
  90 .B /proc/net/rpc/nfsd
  91 (raw server stats), or saved output from
  92 .B nfsstat
  93 itself (client and/or server stats).   Any statistics missing from a saved
  94 .B nfsstat
  95 output
  96 .I file
  97 are treated as zeroes.
  98 .TP
  99 .B \-Z[interval], \-\-sleep=[interval]
 100 Instead of printing current statistics and immediately exiting,
 101 .B nfsstat
 102 takes a snapshot of the current statistics and pauses until it receives
 103 .B SIGINT
 104 (typically from
 105 .BR Ctrl-C ),
 106 at which point it takes another snapshot and displays the difference
 107 between the two.
 108 If \fIinterval\fR is specified,
 109 .B nfsstat
 110 will print the number of \fBNFS\fR calls made since the previous report.
 111 Stats will be printed repeatedly every \fIinterval\fR seconds.
 112 .\" --------------------- EXAMPLES -------------------------------
 113 .SH EXAMPLES
 114 .TP
 115 .B nfsstat \-o all \-234
 116 Show all information about all versions of \fBNFS\fR.
 117 .TP
 118 .B nfsstat \-\-verbose \-234
 119 Same as above.
 120 .TP
 121 .B nfsstat \-o all
 122 Show all information about active versions of \fBNFS\fR.
 123 .TP
 124 .B nfsstat \-\-nfs \-\-server \-3
 125 Show statistics for \fBNFS\fR version 3 server.
 126 .TP
 127 .B nfsstat \-m
 128 Show information about mounted \fBNFS\fR filesystems.
 129 .\" --------------------- DISPLAY --------------------------------
 130 .SH DISPLAY
 131 The \fBFlags\fR output from the \fB\-m\fR option is the same as the
 132 flags give to the \fBmount\fR command.
 133 .\" --------------------- FILES ----------------------------------
 134 .SH FILES
 135 .TP
 136 .B /proc/net/rpc/nfsd
 137 .BR procfs -based
 138 interface to kernel NFS server statistics.
 139 .TP
 140 .B /proc/net/rpc/nfs
 141 .BR procfs -based
 142 interface to kernel NFS client statistics.
 143 .TP
 144 .B /proc/mounts
 145 .BR procfs -based
 146 interface to the mounted filesystems.
 147 .\" -------------------- SEE ALSO --------------------------------
 148 .SH SEE ALSO
 149 .BR rpc.nfsd (8).
 150 .BR nfs (5).
 151 .\" ---------------------- BUGS ----------------------------------
 152 .SH BUGS
 153 The default output has been changed.  To get the old default output you must run \fBnfsstat \-\-auto \-2\fR.
 154 .P
 155 The function of the \fB\-v\fR and \fB\-a\fR options have changed. The \fB\-a\fR option
 156 is now reserved for future use. The \fB\-v\fR does what the \fB\-a\fR option used to do,
 157 and the new \fB\-[234]\fR options replace the \fB\-v\fR option.
 158 .P
 159 The \fBDisplay\fR section should be more complete.
 160 .P
 161 Further bugs can be found or reported at
 162 .BR http://nfs.sf.net/ .
 163 .\" -------------------- AUTHOR ----------------------------------
 164 .SH AUTHOR
 165 Olaf Kirch, <okir@suse.de>