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