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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. 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
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH NFSSTAT 1M "Jun 16, 2009"
   7 .SH NAME
   8 nfsstat \- NFS statistics
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBnfsstat\fR [\fB-cnrsza\fR] [\fB-T\fR u | d ] [\fB-v\fR \fIversion\fR] [\fIinterval\fR [\fIcount\fR]]
  13 .fi
  14 
  15 .LP
  16 .nf
  17 \fBnfsstat\fR \fB-m\fR [\fIpathname\fR]...
  18 .fi
  19 
  20 .SH DESCRIPTION
  21 .LP
  22 \fBnfsstat\fR displays statistical information about the \fBNFS\fR and
  23 \fBRPC\fR (Remote Procedure Call), interfaces to the kernel. It can also be
  24 used to reinitialize this information. If no options are given the default is
  25 as follows:
  26 .sp
  27 .LP
  28 \fBnfsstat\fR \fB-csnra\fR
  29 .sp
  30 .LP
  31 The default displays everything, but reinitializes nothing.
  32 .SH OPTIONS
  33 .ne 2
  34 .na
  35 \fB\fB-a\fR\fR
  36 .ad
  37 .sp .6
  38 .RS 4n
  39 Display \fBNFS_ACL\fR information.
  40 .RE
  41 
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fB-c\fR\fR
  46 .ad
  47 .sp .6
  48 .RS 4n
  49 Display client information. Only the client side \fBNFS\fR, \fBRPC\fR, and
  50 \fBNFS_ACL\fR information is printed. Can be combined with the \fB-n\fR,
  51 \fB-r\fR, and \fB-a\fR options to print client side \fBNFS\fR, \fBRPC\fR, and
  52 \fBNFS_ACL\fR information only.
  53 .RE
  54 
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fB-m\fR [\fIpathname...\fR]\fR
  59 .ad
  60 .sp .6
  61 .RS 4n
  62 Display statistics for each \fBNFS\fR mounted file system. If \fIpathname\fR is
  63 not specified, displays statistics for all NFS mounted file systems. If
  64 \fIpathname\fR is specified, displays statistics for the NFS mounted file
  65 systems indicated by \fIpathname\fR.
  66 .sp
  67 This includes the server name and address, mount flags, current read and write
  68 sizes, the retransmission count, the attribute cache timeout values, failover
  69 information, and the timers used for dynamic retransmission. The dynamic
  70 retransmission timers are displayed only where dynamic retransmission is in
  71 use. By default, \fBNFS\fR mounts over the \fBTCP\fR protocols and \fBNFS\fR
  72 Version 3 mounts over either \fBTCP\fR or \fBUDP\fR do not use dynamic
  73 retransmission.
  74 .sp
  75 If you specify the \fB-m\fR option, this is the only option that \fBnfsstat\fR
  76 uses. If you specify other options with \fB-m\fR, you receive an error message
  77 alerting that the \fB-m\fR flag cannot be combined with other options.
  78 .RE
  79 
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fB-n\fR\fR
  84 .ad
  85 .sp .6
  86 .RS 4n
  87 Display \fBNFS\fR information. \fBNFS\fR information for both the client and
  88 server side are printed. Can be combined with the \fB-c\fR and \fB-s\fR options
  89 to print client or server \fBNFS\fR information only.
  90 .RE
  91 
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fB-r\fR\fR
  96 .ad
  97 .sp .6
  98 .RS 4n
  99 Display \fBRPC\fR information.
 100 .RE
 101 
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fB-s\fR\fR
 106 .ad
 107 .sp .6
 108 .RS 4n
 109 Display server information.
 110 .RE
 111 
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fB-T\fR \fBu\fR | \fBd\fR\fR
 116 .ad
 117 .sp .6
 118 .RS 4n
 119 Display a time stamp.
 120 .sp
 121 Specify \fBu\fR for a printed representation of the internal representation of
 122 time. See \fBtime\fR(2). Specify \fBd\fR for standard date format. See
 123 \fBdate\fR(1).
 124 .RE
 125 
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fB-v\fR \fIversion\fR\fR
 130 .ad
 131 .sp .6
 132 .RS 4n
 133 Specify which NFS version for which to print statistics. When followed by the
 134 optional \fIversion\fR argument, (\fB2\fR|\fB3\fR|\fB4\fR), specifies
 135 statistics for that version. By default, prints statistics for all versions.
 136 .RE
 137 
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fB-z\fR\fR
 142 .ad
 143 .sp .6
 144 .RS 4n
 145 Zero (reinitialize) statistics. This option is for use by the super user only,
 146 and can be combined with any of the above options to zero particular sets of
 147 statistics after printing them.
 148 .RE
 149 
 150 .SH OPERANDS
 151 .LP
 152 The following operands are supported:
 153 .sp
 154 .ne 2
 155 .na
 156 \fB\fIcount\fR\fR
 157 .ad
 158 .sp .6
 159 .RS 4n
 160 Display only count reports
 161 .RE
 162 
 163 .sp
 164 .ne 2
 165 .na
 166 \fB\fIinterval\fR\fR
 167 .ad
 168 .sp .6
 169 .RS 4n
 170 Report once each interval seconds.
 171 .RE
 172 
 173 .sp
 174 .ne 2
 175 .na
 176 \fB\fIpathname\fR\fR
 177 .ad
 178 .sp .6
 179 .RS 4n
 180 Specify the pathname of a file in an NFS mounted file system for which
 181 statistics are to be displayed.
 182 .RE
 183 
 184 .SH DISPLAYS
 185 .LP
 186 The server \fBRPC\fR display includes the following fields:
 187 .sp
 188 .ne 2
 189 .na
 190 \fB\fBbadcalls\fR\fR
 191 .ad
 192 .sp .6
 193 .RS 4n
 194 The total number of calls rejected by the \fBRPC\fR layer (the sum of
 195 \fBbadlen\fR and \fBxdrcall\fR as defined below).
 196 .RE
 197 
 198 .sp
 199 .ne 2
 200 .na
 201 \fB\fBbadlen\fR\fR
 202 .ad
 203 .sp .6
 204 .RS 4n
 205 The number of \fBRPC\fR calls with a length shorter than a minimum-sized
 206 \fBRPC\fR call.
 207 .RE
 208 
 209 .sp
 210 .ne 2
 211 .na
 212 \fB\fBcalls\fR\fR
 213 .ad
 214 .sp .6
 215 .RS 4n
 216 The total number of \fBRPC\fR calls received.
 217 .RE
 218 
 219 .sp
 220 .ne 2
 221 .na
 222 \fB\fBdupchecks\fR\fR
 223 .ad
 224 .sp .6
 225 .RS 4n
 226 The number of \fBRPC\fR calls that looked up in the duplicate request cache.
 227 .RE
 228 
 229 .sp
 230 .ne 2
 231 .na
 232 \fB\fBdupreqs\fR\fR
 233 .ad
 234 .sp .6
 235 .RS 4n
 236 The number of \fBRPC\fR calls that were found to be duplicates.
 237 .RE
 238 
 239 .sp
 240 .ne 2
 241 .na
 242 \fB\fBnullrecv\fR\fR
 243 .ad
 244 .sp .6
 245 .RS 4n
 246 The number of times an \fBRPC\fR call was not available when it was thought to
 247 be received.
 248 .RE
 249 
 250 .sp
 251 .ne 2
 252 .na
 253 \fB\fBxdrcall\fR\fR
 254 .ad
 255 .sp .6
 256 .RS 4n
 257 The number of \fBRPC\fR calls whose header could not be \fBXDR\fR decoded.
 258 .RE
 259 
 260 .sp
 261 .LP
 262 The server \fBNFS\fR display shows the number of \fBNFS\fR calls received
 263 (\fBcalls\fR) and rejected (\fBbadcalls\fR), and the counts and percentages for
 264 the various calls that were made.
 265 .sp
 266 .LP
 267 The server \fBNFS_ACL\fR display shows the counts and percentages for the
 268 various calls that were made.
 269 .sp
 270 .LP
 271 The client \fBRPC\fR display includes the following fields:
 272 .sp
 273 .ne 2
 274 .na
 275 \fB\fBcalls\fR\fR
 276 .ad
 277 .sp .6
 278 .RS 4n
 279 The total number of \fBRPC\fR calls made.
 280 .RE
 281 
 282 .sp
 283 .ne 2
 284 .na
 285 \fB\fBbadcalls\fR\fR
 286 .ad
 287 .sp .6
 288 .RS 4n
 289 The total number of calls rejected by the \fBRPC\fR layer.
 290 .RE
 291 
 292 .sp
 293 .ne 2
 294 .na
 295 \fB\fBbadverfs\fR\fR
 296 .ad
 297 .sp .6
 298 .RS 4n
 299 The number of times the call failed due to a bad verifier in the response.
 300 .RE
 301 
 302 .sp
 303 .ne 2
 304 .na
 305 \fB\fBbadxids\fR\fR
 306 .ad
 307 .sp .6
 308 .RS 4n
 309 The number of times a reply from a server was received which did not correspond
 310 to any outstanding call.
 311 .RE
 312 
 313 .sp
 314 .ne 2
 315 .na
 316 \fB\fBcantconn\fR\fR
 317 .ad
 318 .sp .6
 319 .RS 4n
 320 The number of times the call failed due to a failure to make a connection to
 321 the server.
 322 .RE
 323 
 324 .sp
 325 .ne 2
 326 .na
 327 \fB\fBcantsend\fR\fR
 328 .ad
 329 .sp .6
 330 .RS 4n
 331 The number of times a client was unable to send an \fBRPC\fR request over a
 332 connectionless transport when it tried to do so.
 333 .RE
 334 
 335 .sp
 336 .ne 2
 337 .na
 338 \fB\fBinterrupts\fR\fR
 339 .ad
 340 .sp .6
 341 .RS 4n
 342 The number of times the call was interrupted by a signal before completing.
 343 .RE
 344 
 345 .sp
 346 .ne 2
 347 .na
 348 \fB\fBnewcreds\fR\fR
 349 .ad
 350 .sp .6
 351 .RS 4n
 352 The number of times authentication information had to be refreshed.
 353 .RE
 354 
 355 .sp
 356 .ne 2
 357 .na
 358 \fB\fBnomem\fR\fR
 359 .ad
 360 .sp .6
 361 .RS 4n
 362 The number of times the call failed due to a failure to allocate memory.
 363 .RE
 364 
 365 .sp
 366 .ne 2
 367 .na
 368 \fB\fBretrans\fR\fR
 369 .ad
 370 .sp .6
 371 .RS 4n
 372 The number of times a call had to be retransmitted due to a timeout while
 373 waiting for a reply from the server. Applicable only to \fBRPC\fR over
 374 connection-less transports.
 375 .RE
 376 
 377 .sp
 378 .ne 2
 379 .na
 380 \fB\fBtimeouts\fR\fR
 381 .ad
 382 .sp .6
 383 .RS 4n
 384 The number of times a call timed out while waiting for a reply from the server.
 385 .RE
 386 
 387 .sp
 388 .ne 2
 389 .na
 390 \fB\fBtimers\fR\fR
 391 .ad
 392 .sp .6
 393 .RS 4n
 394 The number of times the calculated time-out value was greater than or equal to
 395 the minimum specified time-out value for a call.
 396 .RE
 397 
 398 .sp
 399 .LP
 400 The client \fBNFS\fR display shows the number of calls sent and rejected, as
 401 well as the number of times a \fBCLIENT\fR handle was received (\fBclgets\fR),
 402 the number of times the \fBCLIENT\fR handle cache had no unused entries
 403 (\fBcltoomany\fR), as well as a count of the various calls and their respective
 404 percentages.
 405 .sp
 406 .LP
 407 The client \fBNFS_ACL\fR display shows the counts and percentages for the
 408 various calls that were made.
 409 .sp
 410 .LP
 411 The \fB-m\fR option includes information about mount flags set by mount
 412 options, mount flags internal to the system, and other mount information. See
 413 \fBmount_nfs\fR(1M).
 414 .sp
 415 .LP
 416 The following mount flags are set by mount options:
 417 .sp
 418 .ne 2
 419 .na
 420 \fB\fBgrpid\fR\fR
 421 .ad
 422 .sp .6
 423 .RS 4n
 424 System V group id inheritance.
 425 .RE
 426 
 427 .sp
 428 .ne 2
 429 .na
 430 \fB\fBhard\fR\fR
 431 .ad
 432 .sp .6
 433 .RS 4n
 434 Hard mount.
 435 .RE
 436 
 437 .sp
 438 .ne 2
 439 .na
 440 \fB\fBintr\fR\fR
 441 .ad
 442 .sp .6
 443 .RS 4n
 444 Interrupts allowed on hard mount.
 445 .RE
 446 
 447 .sp
 448 .ne 2
 449 .na
 450 \fB\fBllock\fR\fR
 451 .ad
 452 .sp .6
 453 .RS 4n
 454 Local locking being used (no lock manager).
 455 .RE
 456 
 457 .sp
 458 .ne 2
 459 .na
 460 \fB\fBnoac\fR\fR
 461 .ad
 462 .sp .6
 463 .RS 4n
 464 Client is not caching attributes.
 465 .RE
 466 
 467 .sp
 468 .ne 2
 469 .na
 470 \fB\fBnointr\fR\fR
 471 .ad
 472 .sp .6
 473 .RS 4n
 474 No interrupts allowed on hard mount.
 475 .RE
 476 
 477 .sp
 478 .ne 2
 479 .na
 480 \fB\fBnocto\fR\fR
 481 .ad
 482 .sp .6
 483 .RS 4n
 484 No close-to-open consistency.
 485 .RE
 486 
 487 .sp
 488 .ne 2
 489 .na
 490 \fB\fBretrans\fR\fR
 491 .ad
 492 .sp .6
 493 .RS 4n
 494 \fBNFS\fR retransmissions.
 495 .RE
 496 
 497 .sp
 498 .ne 2
 499 .na
 500 \fB\fBrpctimesync\fR\fR
 501 .ad
 502 .sp .6
 503 .RS 4n
 504 \fBRPC\fR time sync.
 505 .RE
 506 
 507 .sp
 508 .ne 2
 509 .na
 510 \fB\fBrsize\fR\fR
 511 .ad
 512 .sp .6
 513 .RS 4n
 514 Read buffer size in bytes.
 515 .RE
 516 
 517 .sp
 518 .ne 2
 519 .na
 520 \fB\fBsec\fR\fR
 521 .ad
 522 .sp .6
 523 .RS 4n
 524 \fBsec\fR has one of the following values:
 525 .sp
 526 .ne 2
 527 .na
 528 \fB\fBdh\fR\fR
 529 .ad
 530 .sp .6
 531 .RS 4n
 532 \fBdes\fR-style authentication (encrypted timestamps).
 533 .RE
 534 
 535 .sp
 536 .ne 2
 537 .na
 538 \fB\fBkrb5\fR\fR
 539 .ad
 540 .sp .6
 541 .RS 4n
 542 \fBkerberos v5\fR-style authentication.
 543 .RE
 544 
 545 .sp
 546 .ne 2
 547 .na
 548 \fB\fBkrb5i\fR\fR
 549 .ad
 550 .sp .6
 551 .RS 4n
 552 \fBkerberos v5\fR-style authentication with integrity.
 553 .RE
 554 
 555 .sp
 556 .ne 2
 557 .na
 558 \fB\fBkrb5p\fR\fR
 559 .ad
 560 .sp .6
 561 .RS 4n
 562 \fBkerberos v5\fR-style authentication with privacy.
 563 .RE
 564 
 565 .sp
 566 .ne 2
 567 .na
 568 \fB\fBnone\fR\fR
 569 .ad
 570 .sp .6
 571 .RS 4n
 572 No authentication.
 573 .RE
 574 
 575 .sp
 576 .ne 2
 577 .na
 578 \fB\fBshort\fR\fR
 579 .ad
 580 .sp .6
 581 .RS 4n
 582 Short hand UNIX-style authentication.
 583 .RE
 584 
 585 .sp
 586 .ne 2
 587 .na
 588 \fB\fBsys\fR\fR
 589 .ad
 590 .sp .6
 591 .RS 4n
 592 UNIX-style authentication (UID, GID).
 593 .RE
 594 
 595 .RE
 596 
 597 .sp
 598 .ne 2
 599 .na
 600 \fB\fBsoft\fR\fR
 601 .ad
 602 .sp .6
 603 .RS 4n
 604 Soft mount.
 605 .RE
 606 
 607 .sp
 608 .ne 2
 609 .na
 610 \fB\fBtimeo\fR\fR
 611 .ad
 612 .sp .6
 613 .RS 4n
 614 Initial \fBNFS\fR timeout, in tenths of a second.
 615 .RE
 616 
 617 .sp
 618 .ne 2
 619 .na
 620 \fB\fBwsize\fR\fR
 621 .ad
 622 .sp .6
 623 .RS 4n
 624 Write buffer size in bytes.
 625 .RE
 626 
 627 .sp
 628 .LP
 629 The following mount flags are internal to the system:
 630 .sp
 631 .ne 2
 632 .na
 633 \fB\fBacl\fR\fR
 634 .ad
 635 .sp .6
 636 .RS 4n
 637 Server supports \fBNFS_ACL\fR.
 638 .RE
 639 
 640 .sp
 641 .ne 2
 642 .na
 643 \fB\fBdown\fR\fR
 644 .ad
 645 .sp .6
 646 .RS 4n
 647 Server is down.
 648 .RE
 649 
 650 .sp
 651 .ne 2
 652 .na
 653 \fB\fBdynamic\fR\fR
 654 .ad
 655 .sp .6
 656 .RS 4n
 657 Dynamic transfer size adjustment.
 658 .RE
 659 
 660 .sp
 661 .ne 2
 662 .na
 663 \fB\fBlink\fR\fR
 664 .ad
 665 .sp .6
 666 .RS 4n
 667 Server supports links.
 668 .RE
 669 
 670 .sp
 671 .ne 2
 672 .na
 673 \fB\fBmirrormount\fR\fR
 674 .ad
 675 .sp .6
 676 .RS 4n
 677 Mounted automatically by means of the \fBmirrormount\fR mechanism.
 678 .RE
 679 
 680 .sp
 681 .ne 2
 682 .na
 683 \fB\fBprinted\fR\fR
 684 .ad
 685 .sp .6
 686 .RS 4n
 687 "Not responding" message printed.
 688 .RE
 689 
 690 .sp
 691 .ne 2
 692 .na
 693 \fB\fBreaddir\fR\fR
 694 .ad
 695 .sp .6
 696 .RS 4n
 697 Use \fBreaddir\fR instead of \fBreaddirplus\fR.
 698 .RE
 699 
 700 .sp
 701 .ne 2
 702 .na
 703 \fB\fBsymlink\fR\fR
 704 .ad
 705 .sp .6
 706 .RS 4n
 707 Server supports symbolic links.
 708 .RE
 709 
 710 .sp
 711 .LP
 712 The following flags relate to additional mount information:
 713 .sp
 714 .ne 2
 715 .na
 716 \fB\fBproto\fR\fR
 717 .ad
 718 .sp .6
 719 .RS 4n
 720 Protocol.
 721 .RE
 722 
 723 .sp
 724 .ne 2
 725 .na
 726 \fB\fBvers\fR\fR
 727 .ad
 728 .sp .6
 729 .RS 4n
 730 \fBNFS\fR version.
 731 .RE
 732 
 733 .sp
 734 .LP
 735 The \fB-m\fR option also provides attribute cache timeout values. The following
 736 fields in \fB-m\fR output provide timeout values for attribute cache:
 737 .sp
 738 .ne 2
 739 .na
 740 \fB\fBacdirmax\fR\fR
 741 .ad
 742 .sp .6
 743 .RS 4n
 744 Maximum seconds to hold cached directory attributes.
 745 .RE
 746 
 747 .sp
 748 .ne 2
 749 .na
 750 \fB\fBacdirmin\fR\fR
 751 .ad
 752 .sp .6
 753 .RS 4n
 754 Minimum seconds to hold cached directory attributes.
 755 .RE
 756 
 757 .sp
 758 .ne 2
 759 .na
 760 \fB\fBacregmax\fR\fR
 761 .ad
 762 .sp .6
 763 .RS 4n
 764 Maximum seconds to hold cached file attributes.
 765 .RE
 766 
 767 .sp
 768 .ne 2
 769 .na
 770 \fB\fBacregmin\fR\fR
 771 .ad
 772 .sp .6
 773 .RS 4n
 774 Minimum seconds to hold cached file attributes.
 775 .RE
 776 
 777 .sp
 778 .LP
 779 The following fields in \fB-m\fR output provide failover information:
 780 .sp
 781 .ne 2
 782 .na
 783 \fB\fBcurrserver\fR\fR
 784 .ad
 785 .sp .6
 786 .RS 4n
 787 Which server is currently providing \fBNFS\fR service. See the \fI\fR for
 788 additional details.
 789 .RE
 790 
 791 .sp
 792 .ne 2
 793 .na
 794 \fB\fBfailover\fR\fR
 795 .ad
 796 .sp .6
 797 .RS 4n
 798 How many times a new server has been selected.
 799 .RE
 800 
 801 .sp
 802 .ne 2
 803 .na
 804 \fB\fBnoresponse\fR\fR
 805 .ad
 806 .sp .6
 807 .RS 4n
 808 How many times servers have failed to respond.
 809 .RE
 810 
 811 .sp
 812 .ne 2
 813 .na
 814 \fB\fBremap\fR\fR
 815 .ad
 816 .sp .6
 817 .RS 4n
 818 How many times files have been re-evaluated to the new server.
 819 .RE
 820 
 821 .sp
 822 .LP
 823 The fields in \fB-m\fR output shown below provide information on dynamic
 824 retransmissions. These items are displayed only where dynamic retransmission is
 825 in use.
 826 .sp
 827 .ne 2
 828 .na
 829 \fB\fBcur\fR\fR
 830 .ad
 831 .sp .6
 832 .RS 4n
 833 Current backed-off retransmission value, in milliseconds.
 834 .RE
 835 
 836 .sp
 837 .ne 2
 838 .na
 839 \fB\fBdev\fR\fR
 840 .ad
 841 .sp .6
 842 .RS 4n
 843 Estimated deviation, in milliseconds.
 844 .RE
 845 
 846 .sp
 847 .ne 2
 848 .na
 849 \fB\fBsrtt\fR\fR
 850 .ad
 851 .sp .6
 852 .RS 4n
 853 The value for the smoothed round-trip time, in milliseconds.
 854 .RE
 855 
 856 .SH EXIT STATUS
 857 .LP
 858 The following exit values are returned:
 859 .sp
 860 .ne 2
 861 .na
 862 \fB\fB0\fR\fR
 863 .ad
 864 .sp .6
 865 .RS 4n
 866 Successful completion.
 867 .RE
 868 
 869 .sp
 870 .ne 2
 871 .na
 872 \fB\fB>0\fR\fR
 873 .ad
 874 .sp .6
 875 .RS 4n
 876 An error occurred.
 877 .RE
 878 
 879 .SH SEE ALSO
 880 .LP
 881 \fBmount_nfs\fR(1M), \fBattributes\fR(5)
 882 .sp
 883 .LP
 884 \fI\fR
 885 .sp
 886 .LP
 887 \fI\fR