share/man/man1m/smbstat.1m

   1 .\"
   2 .\" This file and its contents are supplied under the terms of the
   3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
   4 .\" You may only use this file in accordance with the terms of version
   5 .\" 1.0 of the CDDL.
   6 .\"
   7 .\" A full copy of the text of the CDDL should have accompanied this
   8 .\" source.  A copy of the CDDL is also available via the Internet at
   9 .\" http://www.illumos.org/license/CDDL.
  10 .\"
  11 .\"
  12 .\" Copyright 2014 Nexenta Systems, Inc.
  13 .\"
  14 .Dd Nov 22, 2013
  15 .Dt SMBSTAT 1M
  16 .Os
  17 .Sh NAME
  18 .Nm smbstat
  19 .Nd report SMB server statistics
  20 .Sh SYNOPSIS
  21 .Nm smbstat
  22 .Op Fl ctu
  23 .Op Fl r Op Fl anz
  24 .Op Ar interval
  25 .Sh DESCRIPTION
  26 The
  27 .Nm
  28 command shows statistical information for the SMB server, including any or all
  29 of the following four categories:
  30 .Sy counters ,
  31 .Sy throughput ,
  32 .Sy utilization ,
  33 .Sy requests .
  34 By default,
  35 .Nm
  36 shows
  37 .Sy throughput
  38 and
  39 .Sy utilization .
  40 .Sh OPTIONS
  41 .Bl -tag -width Ds
  42 .It Fl c
  43 Display
  44 .Sy counters .
  45 The columns shown are:
  46 .Bl -tag -width "users" -compact
  47 .It Sy nbt
  48 NetBIOS connections
  49 .It Sy tcp
  50 TCP connections
  51 .It Sy users
  52 logged on users
  53 .It Sy trees
  54 share connections
  55 .It Sy files
  56 open files and directories
  57 .It Sy pipes
  58 open named pipes
  59 .El
  60 .It Fl r
  61 Display
  62 .Sy request
  63 data, one row for each SMB command.
  64 The columns shown are, for each request type:
  65 .Bl -tag -width "rt-stddev" -compact
  66 .It Pq name
  67 command name
  68 .It Sy code
  69 command code
  70 .It Sy %
  71 % of requests that fall in this row
  72 .It Sy rbytes/s
  73 received bytes per second
  74 .It Sy tbytes/s
  75 transmitted bytes per second
  76 .It Sy reqs/s
  77 requests per second
  78 .It Sy rt-mean
  79 response time average
  80 .It Sy rt-stddev
  81 response time standard deviation
  82 .El
  83 .It Fl t
  84 Display
  85 .Sy throughput .
  86 The columns shown are:
  87 .Bl -tag -width "rbytes/s" -compact
  88 .It Sy rbytes/s
  89 received bytes per second
  90 .It Sy tbytes/s
  91 transmitted bytes per second
  92 .It Sy reqs/s
  93 requests per second
  94 .It Sy reads/s
  95 number of read requests per second
  96 .It Sy writes/s
  97 number of write requests per second
  98 .El
  99 .It Fl u
 100 Display
 101 .Sy utilization .
 102 The columns shown are:
 103 .Bl -tag -width "wtime" -compact
 104 .It Sy wcnt
 105 average number of waiting requests
 106 .It Sy rcnt
 107 average number of running requests
 108 .It Sy wtime
 109 average wait time per request
 110 .It Sy rtime
 111 average run time per request
 112 .It Sy w%
 113 % of time there were waiting requests
 114 .It Sy r%
 115 % of time there were running requests
 116 .It Sy u%
 117 utilization, computed as
 118 .Sy rcnt Ns / Ns Sy max_workers
 119 .It Sy sat
 120 has the server been
 121 .Qq saturated
 122 .Pq u% at 100
 123 .It Sy usr%
 124 % of CPU time in user space
 125 .It Sy sys%
 126 % of CPU time in kernel
 127 .It Sy idle%
 128 % of CPU time spent idle
 129 .El
 130 .El
 131 .Pp
 132 The
 133 .Fl r
 134 option supports additional modifiers including:
 135 .Bl -tag -width Ds
 136 .It Fl a
 137 show
 138 .Qq all
 139 request types
 140 .Pq including unsupported ones
 141 .It Fl n
 142 .Qq name
 143 order
 144 .Pq sort by request name
 145 .It Fl z
 146 suppress
 147 .Qq zero
 148 count rows
 149 .Pq types for which none were received
 150 .El
 151 .Sh OPERANDS
 152 .Bl -tag -width Ds
 153 .It Ar interval
 154 When
 155 .Ar interval
 156 is specified,
 157 .Nm
 158 runs in a loop, printing the requested output every
 159 .Ar interval
 160 seconds.
 161 When no
 162 .Ar interval
 163 is specified, the statistics presented are based on running averages accumulated
 164 since the system started.
 165 The first output shows the same cumulative statistics one would see without the
 166 .Ar interval
 167 specified, and subsequent outputs represent the activity in the interval that
 168 just finished.
 169 .El
 170 .Sh INTERFACE STABILITY
 171 .Sy Uncommitted .
 172 Output format is
 173 .Sy Not-an-Interface.
 174 .Sh SEE ALSO
 175 .Xr sharectl 1M ,
 176 .Xr sharemgr 1M ,
 177 .Xr smbadm 1M ,
 178 .Xr smbd 1M