home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Internet Tools 1993 July / Internet Tools.iso / RockRidge / ip / manage / snmp / cmu-snmp1.0 / man / snmpstatus.1 < prev    next >
Encoding:
Text File  |  1989-09-19  |  3.3 KB  |  100 lines
  1. .\* /***********************************************************
  2. .\"     Copyright 1988, 1989 by Carnegie Mellon University
  3. .\" 
  4. .\"                       All Rights Reserved
  5. .\" 
  6. .\" Permission to use, copy, modify, and distribute this software and its 
  7. .\" documentation for any purpose and without fee is hereby granted, 
  8. .\" provided that the above copyright notice appear in all copies and that
  9. .\" both that copyright notice and this permission notice appear in 
  10. .\" supporting documentation, and that the name of CMU not be
  11. .\" used in advertising or publicity pertaining to distribution of the
  12. .\" software without specific, written prior permission.  
  13. .\" 
  14. .\" CMU DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  15. .\" ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  16. .\" CMU BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  17. .\" ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  18. .\" WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  19. .\" ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  20. .\" SOFTWARE.
  21. .\" ******************************************************************/
  22. .TH SNMPSTATUS 1 "17 September 1989"
  23. .UC 4
  24. .SH NAME
  25. snmpstatus - Retrieves important information from a network entity.
  26. .SH SYNOPSIS
  27. snmpstatus host [community]
  28. .SH DESCRIPTION
  29. Snmpstatus is an SNMP application that retrieves several important
  30. statistics from a network entity.
  31. .PP
  32. The
  33. .I host
  34. specification may be either a host name or an internet address
  35. specified in "dot notation"
  36. .PP
  37. The
  38. .I community
  39. specifies the community name for the transaction with the remote system.
  40. If this argument is not given, the community name will default to
  41. .I "public".
  42. .PP
  43. The information returned is:
  44. .PP
  45. The IP address of the entity.
  46. .br
  47. A textual description of the entity
  48. .I (sysDescr.0)
  49. .br
  50. The uptime of the entity
  51. .I (sysUpTime.0)
  52. .br
  53. The sum of received packets on all interfaces
  54. .I (ifInUCastPkts.* + ifInNUCastPkts.*)
  55. .br
  56. The sum of transmitted packets on all interfaces
  57. .I (ifOutUCastPkts.* + ifOutNUCastPkts.*)
  58. .br
  59. The number of IP input packets
  60. .I (ipInReceives.0)
  61. .br
  62. The number of IP output packets
  63. .I (ipOutRequests.0)
  64. .PP
  65. For example
  66. .PP
  67. .I snmpstatus netdev-kbox.cc.cmu.edu public
  68. .PP
  69. will produce output similar to the following:
  70. .PP
  71. .I [128.2.56.220]=>[Kinetics FastPath2] Up: 1 day, 4:43:31
  72. .br
  73. .I IF recv/trans packets 262874/39867 |
  74. .I IP recv/trans packets 31603/15805
  75. .PP
  76. Snmpstatus also checks the operational status of all interfaces (ifOperStatus.*),
  77. and if it finds any that are not running, it will report in a manner similar to this:
  78. .PP
  79. .I 2 interfaces are down!
  80. The
  81. .I host
  82. specification may be either a host name or an internet address
  83. specified in "dot notation"
  84. .PP
  85. The
  86. .I community
  87. specifies the community name for the transaction with the remote system.  If none is
  88. given, the community name defaults to
  89. .I "public".
  90. .PP
  91. If the network entity has an error processing the request packet, an error
  92. packet will be returned and a message will be shown, helping to pinpoint in what way
  93. the request was malformed.  Snmpstatus will attempt to reform it's request to eliminate
  94. the malformed variable, but this variable will then be missing from the displayed data.
  95. .PP
  96. Adding a "-d" to the argument list will cause the application to dump input and output packets.
  97. .PP
  98. .SH "SEE ALSO"
  99. RFC 1065, RFC 1066, RFC 1067
  100.