share/man/man8/ndmpstat.8

   1 '\" te
   2 .\" Copyright (c) 2007, 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.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH NDMPSTAT 8 "Jun 21, 2007"
   7 .SH NAME
   8 ndmpstat \- show NDMP backup progress statistics
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBndmpstat\fR  [\fItapes\fR] [\fIinterval\fR [\fIcount\fR]]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBndmpstat\fR utility reports Network Data Management Protocol (NDMP)
  19 statistics, among which are  NDMP worker threads, disk IO, tape IO, files
  20 operation, performance, and backup activity.
  21 .sp
  22 .LP
  23 \fBndmpstat\fR reports the aggregate statistics for all tapes and disks. In
  24 order to obtain statistics for specific tape devices, the tape device name
  25 should be passed as argument to the utility.
  26 .sp
  27 .LP
  28 When invoked, \fBndmpstat\fR begins its display with a one-line summary of the
  29 NDMP daemon activity since the NDMP service was invoked.
  30 .SS "Display Fields"
  31 .sp
  32 .LP
  33 The fields in \fBndmpstat\fR output are described as follows:
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fBwthr\fR\fR
  38 .ad
  39 .sp .6
  40 .RS 4n
  41 Report the number of worker threads in each  of  the four following states:
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fBr\fR\fR
  46 .ad
  47 .sp .6
  48 .RS 4n
  49 the number of worker threads running
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBw\fR\fR
  56 .ad
  57 .sp .6
  58 .RS 4n
  59 the number of blocked worker threads that are waiting for resources such as I/O
  60 and paging
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBb\fR\fR
  67 .ad
  68 .sp .6
  69 .RS 4n
  70 the number of backup operations currently running
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBr\fR\fR
  77 .ad
  78 .sp .6
  79 .RS 4n
  80 the number of restore operations currently running
  81 .RE
  82
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBfile\fR\fR
  89 .ad
  90 .sp .6
  91 .RS 4n
  92 Report on usage of filesystem.
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBrd\fR\fR
  97 .ad
  98 .sp .6
  99 .RS 4n
 100 the number of files being read
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBwr\fR\fR
 107 .ad
 108 .sp .6
 109 .RS 4n
 110 the number of files being written
 111 .RE
 112
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBdisk\fR\fR
 119 .ad
 120 .sp .6
 121 .RS 4n
 122 Report the number of disk operations per interval.
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBrd\fR\fR
 127 .ad
 128 .sp .6
 129 .RS 4n
 130 the number of disk blocks being read
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fBwr\fR\fR
 137 .ad
 138 .sp .6
 139 .RS 4n
 140 the number of disk blocks being written
 141 .RE
 142
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fBtape\fR\fR
 149 .ad
 150 .sp .6
 151 .RS 4n
 152 Report the number of tape operations per interval. There are slots for up to
 153 four tapes, labeled with a single number. The number indicates the name of the
 154 device under \fB/dev/rmt\fR.
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fBrd\fR\fR
 159 .ad
 160 .sp .6
 161 .RS 4n
 162 the number of tape blocks being read
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fBwr\fR\fR
 169 .ad
 170 .sp .6
 171 .RS 4n
 172 the number of tape blocks being written
 173 .RE
 174
 175 .RE
 176
 177 .sp
 178 .ne 2
 179 .na
 180 \fB\fBbytes\fR\fR
 181 .ad
 182 .sp .6
 183 .RS 4n
 184 Report the number of bytes transferred. This is the aggregate value of both
 185 tape and disk devices. The number is in kilobytes.
 186 .sp
 187 .ne 2
 188 .na
 189 \fB\fBrd\fR\fR
 190 .ad
 191 .sp .6
 192 .RS 4n
 193 the number of kilobytes being read
 194 .RE
 195
 196 .sp
 197 .ne 2
 198 .na
 199 \fB\fBwr\fR\fR
 200 .ad
 201 .sp .6
 202 .RS 4n
 203 the number of kilobytes being written
 204 .RE
 205
 206 .RE
 207
 208 .sp
 209 .ne 2
 210 .na
 211 \fB\fBperf\fR\fR
 212 .ad
 213 .sp .6
 214 .RS 4n
 215 Displays a rough estimate of performance of the backup/restore operation in
 216 megabytes per second.
 217 .sp
 218 .ne 2
 219 .na
 220 \fB\fBbk\fR\fR
 221 .ad
 222 .sp .6
 223 .RS 4n
 224 backup performance
 225 .RE
 226
 227 .sp
 228 .ne 2
 229 .na
 230 \fB\fBrs\fR\fR
 231 .ad
 232 .sp .6
 233 .RS 4n
 234 restore performance
 235 .RE
 236
 237 .RE
 238
 239 .sp
 240 .ne 2
 241 .na
 242 \fB\fBprcnt\fR\fR
 243 .ad
 244 .sp .6
 245 .RS 4n
 246 Display the comparative usage of resources, in percent.
 247 .sp
 248 .ne 2
 249 .na
 250 \fB\fBdsk\fR\fR
 251 .ad
 252 .sp .6
 253 .RS 4n
 254 disk I/O time
 255 .RE
 256
 257 .sp
 258 .ne 2
 259 .na
 260 \fB\fBtpe\fR\fR
 261 .ad
 262 .sp .6
 263 .RS 4n
 264 tape I/O time
 265 .RE
 266
 267 .sp
 268 .ne 2
 269 .na
 270 \fB\fBotr\fR\fR
 271 .ad
 272 .sp .6
 273 .RS 4n
 274 other time (memory or idle)
 275 .RE
 276
 277 .RE
 278
 279 .sp
 280 .LP
 281 See \fBEXAMPLES\fR.
 282 .SH OPERANDS
 283 .sp
 284 .LP
 285 The following operands are supported:
 286 .sp
 287 .ne 2
 288 .na
 289 \fB\fIcount\fR\fR
 290 .ad
 291 .RS 12n
 292 Specifies the number of times that the statistics display is repeated.
 293 .RE
 294
 295 .sp
 296 .ne 2
 297 .na
 298 \fB\fItape\fR\fR
 299 .ad
 300 .RS 12n
 301 Specifies which tapes are to be given priority in the output. A command line is
 302 limited to a maximum of four tape devices. A common tape name is
 303 \fB/dev/rmt/\fR\fIn\fR, where \fIn\fR is an integer.
 304 .RE
 305
 306 .sp
 307 .ne 2
 308 .na
 309 \fB\fIinterval\fR\fR
 310 .ad
 311 .RS 12n
 312 Specifies the number of seconds over which \fBndmpstat\fR summarizes activity.
 313 The specified interval remains in effect till the command is terminated.
 314 .RE
 315
 316 .SH EXAMPLES
 317 .LP
 318 \fBExample 1 \fRUsing \fBndmpstat\fR
 319 .sp
 320 .LP
 321 The following command displays a summary of NDMP daemon activity at five-second
 322 intervals.
 323
 324 .sp
 325 .in +2
 326 .nf
 327 example% \fBndmpstat 5\fR
 328 wthr     file      disk      tape        bytes      perf       prcnt
 329 r w b r rd  wr    rd  wr   rd    wr     rd    wr   bk  rs  dsk  tpe  otr
 330 1 0 3 6 50   9   1250  0  32544 4455   42335 3234   5  4   20   40   40
 331 1 0 0 1  1   0    128  0    0   128     64    64    1  0    0   80   20
 332 1 0 0 1  2   0    128  0    0     0     64     0    1  0   80    0   20
 333 1 0 0 1  1   0    128  0    0     0     64     0    1  0   80    0   20
 334 1 0 0 1  3   0    128  0    0     0     64     0    0  0   80    0   20
 335 1 0 0 1  1   0    128  0    0   128     64    64    1  0    0   80   20
 336 ^C
 337 example%
 338 .fi
 339 .in -2
 340 .sp
 341
 342 .SH ATTRIBUTES
 343 .sp
 344 .LP
 345 See \fBattributes\fR(5) for descriptions of the following attributes:
 346 .sp
 347
 348 .sp
 349 .TS
 350 box;
 351 c | c
 352 l | l .
 353 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 354 _
 355 Interface Stability     See below
 356 .TE
 357
 358 .sp
 359 .LP
 360 Invocation is evolving. Human readable output is unstable.
 361 .SH SEE ALSO
 362 .sp
 363 .LP
 364 \fBiostat\fR(8), \fBmpstat\fR(8), \fBndmpd\fR(8), \fBndmpadm\fR(8),
 365 \fBattributes\fR(5)
 366 .SH NOTES
 367 .sp
 368 .LP
 369 Performance numbers are not accurate and are rounded up at the MB/sec.
 370 boundary.