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

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 SNMPCMD 1 "29 Jun 2005" VVERSIONINFO "Net-SNMP"
  31. .UC 4
  32. .SH NAME
  33. snmpcmd - options and behaviour common to most of the Net-SNMP command-line tools
  34. .SH SYNOPSIS
  35. .B snmpcmd
  36. [OPTIONS] AGENT [PARAMETERS]
  37. .SH DESCRIPTION
  38. This manual page describes the common options for the SNMP commands:
  39. .BR snmpbulkget ", " snmpbulkwalk ", "  snmpdelta ", " snmpget ", "
  40. .BR snmpgetnext ", " snmpnetstat ", " snmpset ", " snmpstatus ", "
  41. .BR snmptable ", " snmptest ", " snmptrap ", 
  42. .BR " snmpdf", " snmpusm ", " snmpwalk ".  "
  43. The command line applications use the SNMP protocol to communicate
  44. with an SNMP capable network entity, an agent.  Individual
  45. applications typically (but not necessarily) take additional
  46. parameters that are given after the agent specification.  These
  47. parameters are documented in the manual pages for each application.
  48. .SH OPTIONS
  49. .TP
  50. .BI "-3[MmKk]  0xHEXKEY"
  51. Sets the keys to be used for SNMPv3 transactions.  These options allow
  52. you to set the master authentication and encryption keys (-3m and -3M
  53. respectively) or set the localized authentication and encryption keys
  54. (-3k and -3K respectively).  SNMPv3 keys can be either passed in by
  55. hand using these flags, or by the use of keys generated from passwords
  56. using the -A and -X flags discussed below.  For further details on
  57. SNMPv3 and its usage of keying information, see the Net-SNMP tutorial
  58. web site ( http://www.Net-SNMP.org/tutorial-5/commands/ ). 
  59. Overrides the defAuthMasterKey (-3m), defPrivMasterKey (-3M), 
  60. defAuthLocalizedKey (-3k) or defPrivLocalizedKey (-3K) tokens, respectively, 
  61. in the
  62. .I snmp.conf
  63. file, see
  64. .I snmp.conf(5).
  65. .TP
  66. .BI -a " authProtocol"
  67. Set the authentication protocol (MD5 or SHA) used for authenticated SNMPv3
  68. messages. Overrides the defAuthType token in the
  69. .I snmp.conf
  70. file.
  71. .TP
  72. .BI -A " authPassword"
  73. Set the authentication pass phrase used for authenticated SNMPv3
  74. messages.  Overrides the defAuthPassphrase token in the
  75. .I snmp.conf
  76. file. It is insecure to specify pass phrases on the command line,
  77. see
  78. .I snmp.conf(5).
  79. .TP
  80. .BI -c " community"
  81. Set the community string for SNMPv1/v2c transactions.
  82. Overrides the defcommunity token in the
  83. .I snmp.conf
  84. file.
  85. .TP
  86. .B -d
  87. Dump (in hexadecimal) the sent and received SNMP packets.
  88. .TP
  89. .B -D fITOKEN[,...]
  90. Turn on debugging output for the given
  91. .IR "TOKEN" "(s)."
  92. Try
  93. .IR ALL
  94. for extremely verbose output.
  95. .TP
  96. .BI -e " engineID"
  97. Set the authoritative (security) engineID used for SNMPv3 REQUEST
  98. messages.  It is typically not necessary to specify this, as it will
  99. usually be discovered automatically.
  100. .TP
  101. .BI -E " engineID"
  102. Set the context engineID used for SNMPv3 REQUEST messages scopedPdu.
  103. If not specified, this will default to the authoritative engineID.
  104. .TP
  105. .B -h, --help
  106. Display a brief usage message and then exit.
  107. .TP
  108. .B -H
  109. Display a list of configuration file directives understood by the
  110. command and then exit.
  111. .TP
  112. .BI -I " [brRhu]"
  113. Specifies input parsing options. See 
  114. .B INPUT OPTIONS 
  115. below.
  116. .TP
  117. .BI -l " secLevel"
  118. Set the securityLevel used for SNMPv3 messages
  119. (noAuthNoPriv|authNoPriv|authPriv).  Appropriate pass phrase(s) must
  120. provided when using any level higher than noAuthNoPriv.
  121. Overrides the defSecurityLevel token in the
  122. .I snmp.conf
  123. file.
  124. .TP
  125. .BI -L " [eEfFoOsS]"
  126. Specifies output logging options. See 
  127. .B LOGGING OPTIONS 
  128. below.
  129. .TP
  130. .BI -m " MIBLIST"
  131. Specifies a colon separated list of MIB modules (not files) to load for
  132. this application.  This overrides the environment variable MIBS.
  133. .IP
  134. The special keyword
  135. .I ALL
  136. is used to specify all modules in all directories when searching for MIB
  137. files.  Every file whose name does not begin with "." will be parsed as
  138. if it were a MIB file.
  139. .IP
  140. If the
  141. .I MIBLIST
  142. has a leading '+', then the listed MIB modules are loaded in 
  143. addition to MIB modules specified in the environment variable MIBS.
  144. .IP
  145. If a
  146. .I mibfile
  147. token is specified in the
  148. .I snmp.conf
  149. file,
  150. the 
  151. .I -m MIB
  152. option overrides the 
  153. .I mibfile
  154. token.
  155. .TP
  156. .BI -M " DIRLIST"
  157. Specifies a colon separated list of directories to search for MIBs.
  158. This overrides the environment variable MIBDIRS.
  159. .IP
  160. If 
  161. .I DIRLIST
  162. has a leading '+', then the given directories are added to the list
  163. of MIB directories.  Without the leading '+', the
  164. given directory list overrides the list specified with the
  165. environment variable MIBDIRS. Note that the directories listed at the
  166. end of the list have precedence over directories at the beginning
  167. of the list. 
  168. .IP
  169. If no value is specified for the environment variable MIBDIRS,
  170. then the command will still search a default mib directory,
  171. after it searches the MIB directories specified on the -M
  172. option.  The default directory is DATADIR/snmp/mibs.
  173. To avoid having a default mib directory searched, set the
  174. MIBDIRS environment variable to "".  Even if the default
  175. MIB directory is searched, the directories specified in the
  176. -M option have precedence in the search order over the
  177. default directory.
  178. .IP
  179. If the -M option is specified and either a mibfile or mibdirs token
  180. is also specified in the
  181. .I snmp.conf
  182. file, the directories in the
  183. -M option have precedence in the MIB search order, over the
  184. directories set with both the mibdirs token and the mibfile token.
  185. .TP
  186. .BI -n " contextName"
  187. Set the destination contextName used for SNMPv3 messages.  The default
  188. contextName is the empty string "".  Overrides the defContext token
  189. in the
  190. .I snmp.conf
  191. file. 
  192. .TP
  193. .BI -O " [abeEfnqQsStTuUvxX]"
  194. Specifies output printing options. See 
  195. .B OUTPUT OPTIONS
  196. below.
  197. .TP
  198. .BI -P " [cdeRuwW]"
  199. Specifies MIB parsing options.  See
  200. .B MIB PARSING OPTIONS
  201. below.
  202. .TP
  203. .BI -r " retries"
  204. Specifies the number of retries to be used in the requests. The default
  205. is 5.
  206. .TP
  207. .BI -t " timeout"
  208. Specifies the timeout in seconds between retries. The default is 1.
  209. .TP
  210. .BI -u " secName"
  211. Set the securityName used for authenticated SNMPv3 messages.
  212. Overrides the defSecurityName token in the
  213. .I snmp.conf
  214. file.
  215. .TP
  216. .B -v fI1fR | fI2cfR | fI3
  217. Specifies the protocol version to use: 1 (RFCs 1155-1157), 2c (RFCs 1901-1908),
  218. or 3 (RFCs 2571-2574).  The default is typically version 3. This option
  219. overrides the defVersion token in the
  220. .I snmp.conf
  221. file.
  222. .TP
  223. .B -V, --version
  224. Display version information for the application and then exit.
  225. .TP
  226. .BI -x " privProtocol"
  227. Set the privacy protocol (DES) used for encrypted SNMPv3 messages.
  228. Overrides the defPrivType token in the
  229. .I snmp.conf
  230. file. Only valid if OpenSSL is available.
  231. .TP
  232. .BI -X " privPassword"
  233. Set the privacy pass phrase used for encrypted SNMPv3 messages.
  234. Overrides the defPrivPassphrase token in the
  235. .I snmp.conf
  236. file.
  237. It is insecure to specify pass phrases on the command line, see
  238. .I snmp.conf(5).
  239. .TP
  240. .BI -Z " boots,time"
  241. Set the engineBoots and engineTime used for authenticated SNMPv3
  242. messages.  This will initialize the local notion of the agents
  243. boots/time with an authenticated value stored in the LCD.
  244. It is typically not necessary to specify this option, as these values
  245. will usually be discovered automatically.
  246. .TP
  247. .BI -- "name"="value"
  248. Allows to specify any token ("name") supported in the
  249. .I snmp.conf
  250. file and sets its value to "value". Overrides the corresponding token in the
  251. .I snmp.conf
  252. file. See
  253. .I snmp.conf(5)
  254. for the full list of tokens.
  255. .SH AGENT SPECIFICATION
  256. .PP
  257. The string
  258. .I AGENT
  259. in the
  260. .B SYNOPSIS
  261. above specifies the remote SNMP entity with which to communicate.
  262. This specification takes the form:
  263. .IP
  264. [<transport-specifier>:]<transport-address>
  265. .PP
  266. At its simplest, the
  267. .I AGENT
  268. specification may consist of a hostname, or an IPv4 address in the
  269. standard "dotted quad" notation.  In this case, communication will be
  270. attempted using UDP/IPv4 to port 161 of the given host.  Otherwise,
  271. the <transport-address> part of the specification is parsed according
  272. to the following table:
  273. .RS 4
  274. .TP 28
  275. .BR "<transport-specifier>"
  276. .BR "<transport-address> format"
  277. .IP "udp" 28
  278. hostname[:port]
  279. .I or
  280. IPv4-address[:port]
  281. .IP "tcp" 28
  282. hostname[:port]
  283. .I or
  284. IPv4-address[:port]
  285. .IP "unix" 28
  286. pathname
  287. .IP "ipx" 28
  288. [network]:node[/port]
  289. .TP 28 
  290. .IR "" "aal5pvc " or " pvc"
  291. [interface.][VPI.]VCI
  292. .IP "udp6 or udpv6 or udpipv6" 28
  293. hostname[:port]
  294. .I or
  295. IPv6-address:port
  296. .I or
  297.  '['IPv6-address']'[:port]
  298. .IP "tcp6 or tcpv6 or tcpipv6"
  299. hostname[:port]
  300. .I or
  301. IPv6-address:port
  302. .I or
  303.  '['IPv6-address']'[:port]
  304. .RE
  305. .PP
  306. Note that <transport-specifier> strings are case-insensitive so that,
  307. for example, "tcp" and "TCP" are equivalent.  Here are some examples,
  308. along with their interpretation:
  309. .TP 24
  310. .IR "hostname:161"
  311. perform query using UDP/IPv4 datagrams to
  312. .I hostname
  313. on port
  314. .IR 161 .
  315. The ":161" is redundant here since that is the default SNMP port in
  316. any case.
  317. .TP 24
  318. .IR "udp:hostname"
  319. identical to the previous specification.  The "udp:" is redundant here
  320. since UDP/IPv4 is the default transport.
  321. .TP 24
  322. .IR "TCP:hostname:1161"
  323. connect to
  324. .I hostname
  325. on port
  326. .I 1161
  327. using TCP/IPv4 and perform query over that connection.
  328. .TP 24
  329. .IR "ipx::00D0B7AAE308"
  330. perform query using IPX datagrams to node number 
  331. .I 00D0B7AAE308
  332. on the default network, and using the default IPX port of 36879 (900F
  333. hexadecimal), as suggested in RFC 1906.
  334. .TP 24
  335. .IR "ipx:0AE43409:00D0B721C6C0/1161"
  336. perform query using IPX datagrams to port
  337. .I 1161
  338. on node number
  339. .I 00D0B721C6C0
  340. on network number
  341. .IR 0AE43409 .
  342. .TP 24
  343. .IR "unix:/tmp/local-agent"
  344. connect to the Unix domain socket 
  345. .IR /tmp/local-agent ,
  346. and perform the query over that connection.
  347. .TP 24
  348. .IR "/tmp/local-agent"
  349. identical to the previous specification, since the Unix domain is the
  350. default transport iff the first character of the <transport-address>
  351. is a '/'.
  352. .TP 24
  353. .IR "AAL5PVC:100"
  354. perform the query using AAL5 PDUs sent on the permanent virtual
  355. circuit with VPI=0 and VCI=100 (decimal) on the first ATM adapter in the
  356. machine.
  357. .TP 24
  358. .IR "PVC:1.10.32"
  359. perform the query using AAL5 PDUs sent on the permanent virtual
  360. circuit with VPI=10 (decimal) and VCI=32 (decimal) on the second ATM
  361. adapter in the machine.  Note that "PVC" is a synonym for "AAL5PVC".
  362. .TP 24
  363. .IR "udp6:hostname:10161"
  364. perform the query using UDP/IPv6 datagrams to port
  365. .I 10161
  366. on
  367. .I hostname
  368. (which will be looked up as an AAAA record).
  369. .TP 24
  370. .IR "UDP6:[fe80::2d0:b7ff:fe21:c6c0]"
  371. perform the query using UDP/IPv6 datagrams to port 161 at address
  372. .IR fe80::2d0:b7ff:fe21:c6c0 .
  373. .TP 24
  374. .IR "tcpipv6:[::1]:1611"
  375. connect to port 1611 on the local host
  376. .IR "" ( ::1 
  377. in IPv6 parlance) using TCP/IPv6 and perform query over that connection.
  378. .PP
  379. Note that not all the transport domains listed above will always be
  380. available; for instance, hosts with no IPv6 support will not be able
  381. to use udp6 transport addresses, and attempts to do so will result in
  382. the error "Unknown host".  Likewise, since AAL5 PVC support is only
  383. currently available on Linux, it will fail with the same error on
  384. other platforms.
  385. .SH "MIB PARSING OPTIONS"
  386. The Net-SNMP MIB parser mostly adheres to the Structure of Management
  387. Information (SMI).  As that specification has changed through time, and
  388. in recognition of the (ahem) diversity in compliance expressed in MIB
  389. files, additional options provide more flexibility in reading MIB files.
  390. .TP
  391. .B "-Pw"
  392. Show some warning messages in resolving the MIB files.
  393. Can be also set with the configuration token "mibWarningLevel".
  394. .TP
  395. .B "-PW"
  396. Show additional warning messages.
  397. Can be also set with the configuration token "mibWarningLevel".
  398. .TP
  399. .B "-Pe"
  400. Show MIB errors.
  401. Can be also set with the configuration token "showMibErrors".
  402. An example of an error that would be shown is if an imported
  403. module is not found during MIB parsing.
  404. .TP
  405. .B "-Pc"
  406. Allow ASN.1 comment to extend to the end of the MIB source line
  407. (i.e. disallow the use of "--" to terminate comments).
  408. This overcomes some problems with manually maintained MIB files.
  409. Can be also set with the configuration token "strictCommentTerm".
  410. .TP
  411. .B "-Pd"
  412. Toggles the default of whether or not to save the DESCRIPTIONs
  413. of the MIB objects when parsing.  Since the default is to save
  414. the DESCRIPTIONS, specifying -Pd will cause the DESCRIPTIONs not
  415. to be saved during MIB parsing.  For example:
  416. snmptranslate -Td -OS -IR system.sysDescr.0
  417. will show a description, while
  418. snmptranslate -Td -OS -IR -Pd system.sysDescr.0
  419. will not show a description.  Collecting the
  420. DESCRIPTION information into the parsed hierarchy
  421. increases the memory used by the size of each DESCRIPTION clause.
  422. .TP
  423. .B "-Pu"
  424. Allow underline characters in symbols.
  425. Can be also set with the configuration token "mibAllowUnderline".
  426. .TP
  427. .B "-PR"
  428. Replace MIB objects using the last read MIB file.
  429. The parser will replace MIB objects in its hierarchy whenever
  430. it sees a sub-identifier and name match.  
  431. .B WARNING:
  432. Setting this option may result in an incorrect hierarchy.
  433. Can be also set with the configuration token "mibReplaceWithLatest".
  434. .SH "OUTPUT OPTIONS"
  435. Output display can be controlled by passing various parameters to the
  436. .B -O
  437. flag.  The following examples should demonstrate this.
  438. .PP
  439. The default output looks as follows:
  440. .br
  441. snmpget -c public -v 1 localhost system.sysUpTime.0
  442. .br
  443. SNMPv2-MIB::sysUpTime.0 = Timeticks: (14096763) 1 day, 15:09:27.63        
  444. .TP
  445. .B -Oq
  446. Removes the equal sign and type information:
  447. .br
  448. system.sysUpTime.0 1:15:09:27.63
  449. .TP
  450. .B -OQ
  451. Removes the type information:
  452. .br
  453. system.sysUpTime.0 = 1:15:09:27.63
  454. .TP
  455. .B -Of
  456. Gives you the complete OID:
  457. .br
  458.  .iso.org.dod.internet.mgmt.mib-2.system.sysUpTime.0 = Timeticks: (14096763) 1 day, 15:09:27.63
  459. .TP
  460. .B -Os
  461. Deletes all but the last symbolic part of the OID:
  462. .br
  463. sysUpTime.0 = Timeticks: (14096763) 1 day, 15:09:27.63
  464. .TP
  465. .B -OS
  466. A variation on
  467. .B -Os
  468. that adds the name of the MIB that defined the object:
  469. .br
  470. SNMPv2-MIB::sysUpTime.0 = Timeticks: (14096763) 1 day, 15:09:27.63
  471. .br
  472. (from release 5.0, this is now the default output format)
  473. .TP
  474. .B -Ou
  475. Prints the OID in the UCD-style (inherited from the original CMU code),
  476. That means removing a series of "standard" prefixes, if relevant,
  477. and breaking down the OID into the displayable pieces.  For example,
  478. the OID vacmSecruityModel.0.3.119.101.115 is broken down by default
  479. and the string hidden in the OID is shown.  The result would
  480. look like: vacmSecurityModel.0."wes".  The -Ob option disables this
  481. feature.
  482. .br
  483. system.sysUpTime.0 = Timeticks: (14096763) 1 day, 15:09:27.63
  484. .TP
  485. .B -On
  486. Prints the OID numerically:
  487. .br
  488.  .1.3.6.1.2.1.1.3.0 = Timeticks: (14096763) 1 day, 15:09:27.63
  489. .TP
  490. .B -Oe
  491. Removes the symbolic labels from enumerations:
  492. .br
  493. snmpget -c public -v 1 localhost ip.ipForwarding.0
  494. .br
  495. ip.ipForwarding.0 = INTEGER: forwarding(1)
  496. .br
  497. snmpget -c public -v 1 -Oe localhost ip.ipForwarding.0
  498. .br
  499. ip.ipForwarding.0 = INTEGER: 1
  500. .TP
  501. .B -Ob
  502. When OIDs contain a index to a table,
  503. they are broken into the displayable pieces and shown to you.  For
  504. example the OID vacmSecurityModel.0.3.119.101.115 is nicely broken
  505. down by default and the string hidden in the OID is shown to you as
  506. vacmSecurityModel.0."wes".
  507. The
  508. .B -Ob
  509. option disables this feature and displays it as
  510. vacmSecurityModel.0.3.119.101.115 again.
  511. .TP
  512. .B -OE
  513. This modifies the index strings to include a \ to escape the quotes,
  514. to allow them to be reused in shell commands, such as
  515. vacmSecurityModel.0.\"wes\"
  516. .TP
  517. .B -OX
  518. This modifies the output of index OIDs, to look more "program like".
  519. Square brackets are placed around each index, and the DISPLAY-HINT
  520. information and string conversions are used to format each index.
  521. If you take an entry from the IPV6-MIB::ipv6RouteTable, it is indexed with
  522. an IPv6 address and two integers, and if you are used to IPv6 addresses
  523. you will know that decimal OIDs are not the preferred notation. Compare:
  524. .br
  525. snmpgetnext -OS host IPV6-MIB:ipv6RouteTable
  526. .br
  527. IPV6-MIB::ipv6RouteIfIndex.63.254.1.0.255.0.0.0.0.0.0.0.0.0.0.0.64.1 = INTEGER: 2
  528. .br
  529. snmpgetnext -OSX host IPV6-MIB:ipv6RouteTable
  530. .br
  531. IPV6-MIB::ipv6RouteIfIndex[3ffe:100:ff00:0:0:0:0:0][64][1] = INTEGER: 2
  532. .TP
  533. .B -Oa
  534. If a string-valued object definition does not include a Display Hint,
  535. then the library attempts to determine whether it is an ascii or
  536. binary string, and displays the value accordingly.
  537. This flag bypasses this check, and displays all strings as ASCII.
  538. Note that this does not affect objects that do have a Display Hint.
  539. .TP
  540. .B -Ox
  541. This works similarly to '-Oa', but displays strings as Hex.
  542. .TP
  543. .B -OT
  544. If hexadecimal code is printed, this will also print any printable
  545. characters after the hexadecimal codes.
  546. .TP
  547. .B -Ov
  548. Output only the variable value, not the OID:
  549. .br
  550. snmpget -c public -v 1 -Ov localhost ip.ipForwarding.0
  551. .br
  552. INTEGER: forwarding(1)
  553. .TP
  554. .B -OU
  555. Do not print the UNITS suffix at the end of the value.
  556. .TP
  557. .B -Ot
  558. Output timeticks values as raw numbers:
  559. .br
  560. system.sysUpTime.0 = 14096763
  561. .PP
  562. Note that most of these options can be turned on or off by default by
  563. tuning the
  564. .I snmp.conf
  565. file. See the
  566. .I snmp.conf(5)
  567. manual page for details.
  568. .SH "LOGGING OPTIONS"
  569. The mechanism and destination to use for logging of warning and error
  570. messages can be controlled by passing various parameters to the
  571. .B -L
  572. flag.
  573. .TP
  574. .B -Le
  575. Log messages to the standard error stream.
  576. .TP
  577. .B -Lf FILE
  578. Log messages to the specified file.
  579. .TP
  580. .B -Lo
  581. Log messages to the standard output stream.
  582. .TP
  583. .B -Ls FACILITY
  584. Log messages via syslog, using the specified facility
  585. ('d' for LOG_DAEMON, 'u' for LOG_USER,
  586. or '0'-'7' for LOG_LOCAL0 through LOG_LOCAL7).
  587. .PP
  588. There are also "upper case" versions of each of these options, which
  589. allow the corresponding logging mechanism to be restricted to certain
  590. priorities of message.  Using standard error logging as an example:
  591. .TP
  592. .B -LE pri
  593. will log messages of priority 'pri' and above to standard error.
  594. .TP
  595. .B -LE p1-p2
  596. will log messages with priority between 'p1' and 'p2' (inclusive) to
  597. standard error.
  598. .PP
  599. For
  600. .B -LF
  601. and
  602. .B -LS
  603. the priority specification comes before the file or facility token.
  604. The priorities recognised are:
  605. .IP
  606. .B 0
  607. or
  608. .B !
  609. for LOG_EMERG,
  610. .br
  611. .B 1
  612. or
  613. .B a
  614. for LOG_ALERT,
  615. .br
  616. .B 2
  617. or
  618. .B c
  619. for LOG_CRIT,
  620. .br
  621. .B 3
  622. or
  623. .B e
  624. for LOG_ERR,
  625. .br
  626. .B 4
  627. or
  628. .B w
  629. for LOG_WARNING,
  630. .br
  631. .B 5
  632. or
  633. .B n
  634. for LOG_NOTICE,
  635. .br
  636. .B 6
  637. or
  638. .B i
  639. for LOG_INFO, and
  640. .br
  641. .B 7
  642. or
  643. .B d
  644. for LOG_DEBUG.
  645. .PP
  646. Normal output is (or will be!) logged at a priority level of
  647. .B LOG_NOTICE
  648. .SH "INPUT OPTIONS"
  649. The
  650. .B -I
  651. flag specifies various options that control how your input to
  652. the program is parsed.  By default, all input parsing methods are
  653. used: First the OID is parsed regularly, then
  654. .B -IR
  655. is used, then
  656. .B -Ib
  657. is used, unless one of the following flags is specified which will
  658. force it to only use one method.
  659. .TP
  660. .B -IR
  661. The
  662. .B -IR
  663. flag specifies random access lookup, so that if the entire OID path is
  664. not specified, it will search for a node in the MIB tree with the given
  665. name.  Normally, you would have to specify the vacmSecurityModel OID above
  666. as .iso.org.dod.internet.snmpV2.snmpModules.snmpVacmMIB.vacmMIBObjects.vacmSecurityToGroupTable.vacmSecurityToGroupEntry.vacmSecurityModel.0."wes",
  667. but the use of the
  668. .B -IR
  669. flag allows you to shorten that to just vacmSecurityModel.0."wes".
  670. (Though this OID really needs to be quoted - 'vacmSecurityModel.0."wes"' - to
  671. prevent the shell from swallowing the double quotes).
  672. .IP
  673. Additionally, see the
  674. .B RANDOM ACCESS MIBS
  675. section below.
  676. .TP
  677. .B -Ib
  678. The
  679. .B -Ib
  680. flag indicates that the expression you gave it is actually a regular
  681. expression that should be used to search for the best match possible in
  682. the MIB tree.  This would allow you to specify the node
  683. vacmSecurityModel MIB node as something as generic as vacmsecuritymodel
  684. (since case insensitive searches are done) or vacm.*model.  Note that
  685. multiple matches are obviously possible (.* matches everything), and the
  686. best result is currently calculated as the one that matches the closest
  687. to the beginning of the node name and the highest in the tree.  A
  688. current side effect of this option is that you cannot specify indexes
  689. or multiple nodes, since the '.' is treated as part of the regular
  690. expression.  The result of that match will thus only
  691. match a single node.  Specifying MIB names, or trailing nodes/numbers
  692. will not succeed.  Thus, matching on SNMPv2-MIB::sys.*ontact will not
  693. match sysContact even though sys.*ontact would.  Similarly,
  694. sys.*ontact.0 will also not match sysContact.0 (though it could match
  695. sysContactX0 if such a node existed).
  696. .TP
  697. .B -Iu
  698. Use the traditional UCD-style input approach of assuming that OIDs
  699. are rooted at the 'mib-2' point in the tree (unless they start with
  700. an explicit '.')   If random access lookup is in effect (which is
  701. the default for most commands), then this will only affect OIDs
  702. specified with a leading numberic subidentifier (and no initial '.')
  703. Thus an input of "snmpcmd ... 1" would refer to 'iso' (from v5.0
  704. onwards) while "snmpcmd -Iu ... 1" would refer to 'system'.
  705. .TP
  706. .B -Ir
  707. By default, indices into tables and values to be assigned to objects
  708. are checked against range and type specified in the MIB.  The
  709. .B -Ir
  710. flag disables this check.  This flag is mostly useful when you are
  711. testing an agent.  For normal operation it is useful to get your
  712. requests checked before they are sent to the remote agent (the
  713. diagnostic that the library can provide is also much more precise).
  714. .TP
  715. .B -Ih
  716. By default, the library will use DISPLAY-HINT information when assigning values.
  717. This flag disables this behaviour. The result is that instead of
  718. .br
  719. snmpset localhost HOST-RESOURCES-MIB::hrSystemDate.0 = 2002-12-10,2:4:6.8
  720. .br
  721. you will have to write
  722. .br
  723. snmpset localhost HOST-RESOURCES-MIB::hrSystemData.0 x "07 D2 0C 0A 02 04 06 08"
  724. .TP
  725. .B -Is SUFFIX
  726. Add the specified suffix to each textual OID given on the command line.
  727. It is useful to specify a common index value when you want to retrieve
  728. multiple objects from the same row of a table.
  729. .TP
  730. .B -IS PREFIX
  731. Add the specified prefix to each textual OID given on the command line.
  732. Useful to specify an explicit MIB module name for all objects being retrieved
  733. (or for incurably lazy typists)
  734. .SH "RANDOM ACCESS MIBS"
  735. In previous releases of the UCD-SNMP package (and if using the
  736. .B -Iu
  737. option), an object identifier such as system.sysDescr.0 will be
  738. lookup in a single "well known" place, built into the SNMP library (or
  739. specified by the PREFIX environment variable).  The standard place
  740. is: .iso.org.dod.internet.mgmt.mib-2.  The identifier may alternatively be
  741. a complete object identifier, this is designated by a leading "dot"
  742. if using UCD-input style, and is the first thing tried otherwise.
  743. To simplify the specification of object identifiers the library
  744. supports random access to the identifiers in the MIBs. This is
  745. requested by the
  746. .B -IR
  747. option to the SNMP applications.  Additionally,
  748. .B -Os
  749. prints OIDs in this manner.  Using this, system.sysDescr.0 may
  750. also be entered as sysDescr.0.  To search only a single MIB for the
  751. identifier (if it appears in more than one), specify it as
  752. SNMPv2-MIB::sysDescr.0. (use
  753. .B -OS
  754. to print output OIDs in this manner, though this is the default as
  755. from v5.0). This notation will also ensure
  756. that the specified MIB is loaded, i.e. it need not be mentioned in the
  757. .B -m
  758. option (or MIBS environment variable).
  759. .SH "ENVIRONMENT VARIABLES"
  760. .IP PREFIX
  761. The standard prefix for object identifiers (if using UCD-style output).
  762. Defaults to .iso.org.dod.internet.mgmt.mib-2
  763. .IP MIBS
  764. The list of MIBs to load. Defaults to
  765. SNMPv2-TC:SNMPv2-MIB:IF-MIB:IP-MIB:TCP-MIB:UDP-MIB:SNMP-VACM-MIB.
  766. Overridden by the
  767. .B -m
  768. option.
  769. .IP MIBDIRS
  770. The list of directories to search for MIBs. Defaults to DATADIR/snmp/mibs.
  771. Overridden by the
  772. .B -M
  773. option.
  774. .SH FILES
  775. .IP SYSCONFDIR/snmp/snmpd.conf
  776. Agent configuration file. See
  777. .IR snmpd.conf(5) .
  778. .IP SYSCONFDIR/snmp/snmp.conf
  779. .IP ~/.snmp/snmp.conf
  780. Application configuration files. See 
  781. .IR snmp.conf(5) .
  782. .SH "SEE ALSO"
  783. snmpget(1), snmpgetnext(1), snmpset(1),
  784. snmpbulkget(1), snmpbulkwalk(1), snmpwalk(1),
  785. snmptable(1), snmpnetstat(1), snmpdelta(1), snmptrap(1), snmpinform(1),
  786. snmpusm(1), snmpstatus(1), snmptest(1),
  787. snmp.conf(5).