snmptest.1.def
上传用户:wxp200602
上传日期:2007-10-30
资源大小:4028k
文件大小:8k
源码类别:

SNMP编程

开发平台:

Unix_Linux

  1. ." Portions of this file are subject to the following copyright.  See
  2. ." the Net-SNMP's COPYING file for more details and other copyrights
  3. ." that may apply:
  4. ." /***********************************************************
  5. ."  Copyright 1988, 1989 by Carnegie Mellon University
  6. ." 
  7. ."                       All Rights Reserved
  8. ." 
  9. ." Permission to use, copy, modify, and distribute this software and its 
  10. ." documentation for any purpose and without fee is hereby granted, 
  11. ." provided that the above copyright notice appear in all copies and that
  12. ." both that copyright notice and this permission notice appear in 
  13. ." supporting documentation, and that the name of CMU not be
  14. ." used in advertising or publicity pertaining to distribution of the
  15. ." software without specific, written prior permission.  
  16. ." 
  17. ." CMU DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  18. ." ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  19. ." CMU BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  20. ." ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  21. ." WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  22. ." ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  23. ." SOFTWARE.
  24. ." ******************************************************************/
  25. ." Portions of this file are copyrighted by:
  26. ." Copyright Copyright 2003 Sun Microsystems, Inc. All rights reserved.
  27. ." Use is subject to license terms specified in the COPYING file
  28. ." distributed with the Net-SNMP package.
  29. ." ******************************************************************/
  30. .TH SNMPTEST 1 "25 Jul 2003" VVERSIONINFO "Net-SNMP"
  31. .UC 4
  32. .SH NAME
  33. snmptest - communicates with a network entity using SNMP requests
  34. .SH SYNOPSIS
  35. .B snmptest
  36. [COMMON OPTIONS] AGENT
  37. .SH DESCRIPTION
  38. .B snmptest
  39. is a flexible SNMP application that can monitor and manage information
  40. on a network entity.
  41. .PP
  42. After invoking the program, a command line interpreter proceeds to
  43. accept commands.  This intepreter enables the user to send different
  44. types of SNMP requests to target agents.
  45. .PP
  46. AGENT identifies a target SNMP agent, which is instrumented
  47. to monitor the gievn objects.  At its simplest, the AGENT
  48. specification will consist of a hostname or an IPv4
  49. address.  In this situation, the command will attempt
  50. communication with the agent, using UDP/IPv4 to port 161
  51. of the given target host. See snmpcmd(1) for a full list of
  52. the possible formats for AGENT.
  53. .PP
  54. Once snmptest is invoked, the command line intepreter will prompt with:
  55. .PP
  56. .B Variable:
  57. .PP
  58. At this point you can enter one or more variable names, one per line.
  59. A blank line ends the parameter input and will send the request
  60. (variables entered) in a single packet, to the remote entity.
  61. Each variable name is given
  62. in the format specified in 
  63. .IR variables(5) .
  64. For example:
  65. .PP
  66. snmptest -c public -v 1 zeus
  67. .br
  68. .BR Variable: " system.sysDescr.0"
  69. .br
  70. .BR Variable: 
  71. .PP
  72. will return some information about the request and reply packets, as
  73. well as the information:
  74. .PP
  75. requestid 0x5992478A errstat 0x0 errindex 0x0
  76. .br
  77. system.sysDescr.0 = STRING: "Unix 4.3BSD"
  78. .PP
  79. The errstatus value shows the error status code for the call.
  80. The possible values for errstat are in the header file snmp.h.
  81. The errindex value identifies the variable that has the given error.
  82. Index values are assigned to all the variables entered at the "Variable":
  83. prompt. The first value is assigned an index of 1.
  84. .PP
  85. Upon startup, the program defaults to sending a GET request packet.
  86. The type of request can be changed by typing one of the following
  87. commands at the "Variable:" prompt:
  88. .PP
  89. .nf
  90. $G - send a GET request
  91. $N - send a GETNEXT request
  92. $S - send a SET request
  93. $B - send a GETBULK request
  94.      Note: GETBULK is not available in SNMPv1
  95. $I - send an Inform request
  96. $T - send an SNMPv2 Trap request
  97. .fi
  98. .PP
  99. Other values that can be entered at the "Variable:" prompt are:
  100. .PP
  101. .nf
  102. $D - toggle the dumping of each sent and received packet
  103. $QP - toggle a quicker, less verbose output form
  104. $Q - Quit the program
  105. .fi
  106. .PP
  107. Request Types:
  108. .PP
  109. GET Request:
  110. .PP
  111. When in "GET request" mode ($G or default), the user can enter
  112. an OID at the "Variable:" prompt. The user can enter multiple
  113. OIDs, one per prompt. The user enters a blank line to send
  114. the GET request.
  115. .PP
  116. GETNEXT Request:
  117. .PP
  118. The "GETNEXT request" mode ($N) is simlar to the "Get request"
  119. mode, described above.
  120. .PP
  121. SET Request:
  122. .PP
  123. When in the "SET request" mode ($S), more information is requested by the
  124. prompt for each variable.  The prompt:
  125. .PP
  126. .nf
  127. Type [i|s|x|d|n|o|t|a]:
  128. .fi
  129. requests the type of the variable be entered.  Depending on the type
  130. of value you want to set, you can type one of the following:
  131. .PP
  132. .nf
  133. i - integer
  134. u - unsigned integer
  135. s - octet string in ASCII
  136. x - octet string in hex bytes, separated by whitespace
  137. d - octet string as decimal bytes, separated by whitespace
  138. a - ip address in dotted IP notation
  139. o - object identifier
  140. n - null
  141. t - timeticks
  142. .fi
  143. At this point a value will be prompted for:
  144. .PP
  145. Value:
  146. .PP
  147. If this is an integer value, just type the integer (in decimal).  If
  148. it is a decimal string, type in white-space separated decimal numbers,
  149. one per byte of the string.  Again type a blank line at the prompt for
  150. the variable name to send the packet.
  151. .PP
  152. GETBULK Request:
  153. .PP
  154. The "GETBULK request" mode ($B) is similar to the "Set request" mode.
  155. GETBULK, however, is not available in SNMPv1.
  156. .PP
  157. Inform Request:
  158. .PP
  159. The "Inform request" mode ($I) is similar to the "Set request" mode.
  160. This type of request, however, is not available in SNMPv1. Also,
  161. the _agent_ specified on the snmptest command should correspond
  162. to the target snmptrapd agent.
  163. .PP
  164. SNMPv2 Trap Request:
  165. .PP
  166. The "SNMPv2 Trap Request" mode ($T) is similar to the "Set request" mode.
  167. This type of request, however, is not available in SNMPv1. Also,
  168. the _agent_ specified on the snmptest command should correspond
  169. to the target snmptrapd agent.
  170. .SH OPTIONS
  171. .B snmptest
  172. takes the common options described in the 
  173. .I snmpcmd(1)
  174. manual page.
  175. .SH EXAMPLES
  176. .PP
  177. The following is an example of sending a GET request for two OIDs:
  178. .PP
  179. % snmptest -v 2c -c public testhost:9999
  180. .PP
  181. .nf
  182. Variable: system.sysDescr.0
  183. Variable: system.sysContact.0
  184. Variable:
  185. Received Get Response from 128.2.56.220
  186. requestid 0x7D9FCD63 errstat 0x0 errindex 0x0
  187. SNMPv2-MIB::sysDescr.0 = STRING: SunOS testhost 5.9 Generic_112233-02 sun4u
  188. SNMPv2-MIB::sysContact.0 = STRING: x1111
  189. .fi
  190. .PP
  191. The following is an example of sending a GETNEXT request:
  192. .PP
  193. .nf
  194. Variable: SNMPv2-MIB::sysORUpTime
  195. Variable:
  196. Received Get Response from 128.2.56.220
  197. requestid 0x7D9FCD64 errstat 0x0 errindex 0x0
  198. SNMPv2-MIB::sysORUpTime.1 = Timeticks: (6) 0:00:00.06
  199. Variable:
  200. .fi
  201. .PP
  202. The following is an example of sending a SET request:
  203. .PP
  204. .nf
  205. Variable: $S
  206. Request type is Set Request
  207. Variable: system.sysLocation.0
  208. Type [i|u|s|x|d|n|o|t|a]: s
  209. Value: building 17
  210. Variable:
  211. Received Get Response from 128.2.56.220
  212. requestid 0x7D9FCD65 errstat 0x0 errindex 0x0
  213. SNMPv2-MIB::sysLocation.0 = STRING: building A
  214. Variable:
  215. .fi
  216. .PP
  217. The following is an example of sending a GETBULK request:
  218. .PP
  219. .nf
  220. Variable: $B
  221. Request type is Bulk Request
  222. Enter a blank line to terminate the list of non-repeaters
  223. and to begin the repeating variables
  224. Variable:
  225. Now input the repeating variables
  226. Variable: system.sysContact.0
  227. Variable: system.sysLocation.0
  228. Variable:
  229. What repeat count? 2
  230. Received Get Response from 128.2.56.220
  231. requestid 0x2EA7942A errstat 0x0 errindex 0x0
  232. SNMPv2-MIB::sysName.0 = STRING: testhost
  233. SNMPv2-MIB::sysORLastChange.0 = Timeticks: (58) 0:00:00.58
  234. SNMPv2-MIB::sysLocation.0 = STRING: bldg A
  235. SNMPv2-MIB::sysORID.1 = OID: IF-MIB::ifMIB
  236. Variable:
  237. .fi
  238. .PP
  239. The following is an example of sending an Inform request:
  240. .PP
  241. .nf
  242. snmptest -v 2c -c public snmptrapd_host
  243. Variable: $I
  244. Request type is Inform Request
  245. (Are you sending to the right port?)
  246. Variable: system.sysContact.0
  247. Type [i|u|sIx|d|n|o|t|a]: s
  248. Value: x12345
  249. Variable:
  250. Inform Acknowledged
  251. Variable:
  252. .fi
  253. .PP
  254. The snmptrapd_host will show:
  255. .PP
  256. snmptrapd_host [<ip address>]: Trap SNMPv2-MIB::sysContact.0 = STRING:
  257. x12345
  258. .PP
  259. The following is an example of sending an SNMPv2 Trap request:
  260. .PP
  261. .nf
  262. snmptest -v 2c -c public snmptrapd_host
  263. Variable: $T
  264. Request type is SNMPv2 Trap Request
  265. (Are you sending to the right port?)
  266. Variable: system.sysLocation.0
  267. Type [i|u|s|x|d|n|o|t|a]: s
  268. Value: building a
  269. Variable:
  270. .fi
  271. .PP
  272. The snmptrapd_host will show:
  273. .PP
  274. .nf
  275. snmptrapd_host [<ip address>]: Trap SNMPv2-MIB::sys.0 = STRING:
  276. building a
  277. .fi
  278. .SH "SEE ALSO"
  279. snmpcmd(1), snmpget(1), snmpset(1), variables(5)