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

SNMP编程

开发平台:

Unix_Linux

  1. ." /***********************************************************
  2. ."  Copyright 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 SNMPTRAPD 8 "15 Jan 2004" VVERSIONINFO "Net-SNMP"
  23. .UC 4
  24. .SH NAME
  25. snmptrapd - Receive and log SNMP trap messages.
  26. .SH SYNOPSIS
  27. .BR snmptrapd " [OPTIONS] [LISTENING ADDRESSES]"
  28. .SH DESCRIPTION
  29. .B snmptrapd
  30. is an SNMP application that receives and logs SNMP TRAP and INFORM
  31. messages.
  32. .PP
  33. Note: the default is to listen on UDP port 162 on all IPv4 interfaces.
  34. Since 162 is a privileged port,
  35. .B snmptrapd
  36. must be typically be run as root.
  37. .SH OPTIONS
  38. .TP 8
  39. .B -a
  40. Ignore authenticationFailure traps.
  41. .TP
  42. .BI "-c" " FILE"
  43. Read 
  44. .I FILE
  45. as a configuration file.
  46. .TP
  47. .B -C
  48. Do not read any configuration files except the one optionally specified by the 
  49. .B -c 
  50. option.
  51. .TP
  52. .B -d
  53. Dump (in hexadecimal) the sent and received SNMP packets.
  54. .TP
  55. .BI -D " TOKEN[,...]"
  56. Turn on debugging output for the given
  57. .IR "TOKEN" "(s)."
  58. Try
  59. .IR ALL
  60. for extremely verbose output.
  61. .TP
  62. .B -e
  63. Print event numbers (rising/falling alarm etc.).
  64. .TP
  65. .B -f
  66. Do not fork() from the calling shell.
  67. .TP
  68. .BI -F " FORMAT"
  69. When logging to standard output, use the format in the string
  70. .IR FORMAT .
  71. See the section
  72. .B FORMAT SPECIFICATIONS
  73. below for more details.
  74. .TP
  75. .B -h, --help
  76. Display a brief usage message and then exit.
  77. .TP
  78. .B -H
  79. Display a list of configuration file directives understood by the
  80. trap daemon and then exit.
  81. .TP
  82. .BR -l " d|0-7"
  83. Specifies the syslog facility to use when logging to syslog.  'd' means
  84. .B LOG_DAEMON
  85. and 0 through 7 mean 
  86. .BR LOG_LOCAL0 " through " LOG_LOCAL7 ".  " LOG_LOCAL0 " is the default."
  87. .br
  88. This option is being deprecated, and '-Ls FACILITY' should be used instead.
  89. .TP
  90. .B -L[efos]
  91. Specify where logging output should be directed (standard error or output,
  92. to a file or via syslog).  See LOGGING OPTIONS in snmpcmd(1) for details.
  93. .br
  94. This option deprecates the
  95. .B -l
  96. .B -o
  97. .B -P
  98. and
  99. .B -s
  100. options.
  101. .TP
  102. .BR -m " fIMIBLIST"
  103. Specifies a colon separated list of MIB modules to load for this
  104. application.  This overrides the environment variable MIBS.
  105. .TP
  106. .BR -M " fIDIRLIST"
  107. Specifies a colon separated list of directories to search for MIBs.
  108. This overrides the environment variable MIBDIRS.
  109. .TP
  110. .BR -n
  111. Do not attempt to translate source addresses of incoming packets into
  112. hostnames.
  113. .TP
  114. .BI -o " FILE"
  115. Log formatted incoming traps to 
  116. .IR FILE .
  117. Upon receipt of a SIGHUP, the daemon will close and re-open
  118. the log file.  This feature is useful when rotating the log file with
  119. other utilities such as logrotate.
  120. .br
  121. This option is being deprecated, and '-Lf FILE' should be used instead.
  122. .TP
  123. .BI -p " FILE"
  124. Save the process ID of the trap daemon in
  125. .IR FILE "."
  126. .br
  127. This option deprecates the
  128. .B -u
  129. option.
  130. .TP
  131. .B -P
  132. Print formatted incoming traps to stderr.
  133. .br
  134. This option is being deprecated, and '-Le' should be used instead.
  135. .TP
  136. .B -s
  137. Log formatted incoming traps to syslog.  These syslog messages are
  138. sent with a level of 
  139. .B LOG_WARNING
  140. and facility as determined by the
  141. .BR -l " flag (" LOG_LOCAL0 
  142. by default).  This is the default unless the
  143. .BR -o ", " -P " or " -L
  144. flag is used.
  145. .br
  146. This option is being deprecated, and '-Ls FACILITY' should be used instead.
  147. .TP
  148. .BR -S " d|0-7"
  149. Specifies the syslog facility to use when logging to syslog. See
  150. .BR -l
  151. for details.
  152. .br
  153. This option is being deprecated, and '-Ls FACILITY' should be used instead.
  154. .TP
  155. .BI -t
  156. Do not log traps to syslog.  This disables logging to syslog.  This is
  157. useful if you want the snmptrapd application to
  158. .B only
  159. run traphandle hooks and not to log any traps to any location.
  160. .TP
  161. .BI -u " FILE"
  162. Save the process ID of the trap daemon in
  163. .IR FILE "."
  164. .br
  165. This option is being deprecated, and '-p FILE' should be used instead.
  166. .TP
  167. .B -v, --version
  168. Print version information for the trap daemon and then exit.
  169. .TP
  170. .BI -- "name"="value"
  171. Allows to specify any token ("name") supported in the
  172. .I snmptrapd.conf
  173. file and sets its value to "value". Overrides the corresponding token in the
  174. .I snmptrapd.conf
  175. file. See
  176. .I snmptrapd.conf(5)
  177. for the full list of tokens.
  178. .PP
  179. In addition,
  180. .B snmptrapd
  181. takes the same output formatting 
  182. .BR "" ( -O ) 
  183. options as the other Net-SNMP commands.  See the section
  184. .B OUTPUT OPTIONS
  185. in the
  186. .I snmpcmd(1)
  187. manual page.
  188. .SH FORMAT SPECIFICATIONS
  189. .PP
  190. .B snmptrapd
  191. interprets format strings similarly to
  192. .IR printf(3) .
  193. It understands the following formatting sequences:
  194. .RS 4
  195. .TP 4
  196. .B %%
  197. a literal %
  198. .TP
  199. .B %t
  200. decimal number of seconds since the operating system's epoch (as
  201. returned by
  202. .IR time(2) )
  203. .TP
  204. .B %y
  205. current year on the local system
  206. .TP
  207. .B %m
  208. current (numeric) month on the local system
  209. .TP
  210. .B %l
  211. current day of month on the local system
  212. .TP
  213. .B %h
  214. current hour on the local system
  215. .TP
  216. .B %j
  217. current minute on the local system
  218. .TP
  219. .B %k
  220. current second on the local system
  221. .TP
  222. .B %T
  223. the value of the sysUpTime.0 varbind in seconds
  224. .TP
  225. .B %Y
  226. the year field from the sysUpTime.0 varbind
  227. .TP
  228. .B %M
  229. the numeric month field from the sysUpTime.0 varbind
  230. .TP
  231. .B %L
  232. the day of month field from the sysUpTime.0 varbind
  233. .TP
  234. .B %H
  235. the hour field from the sysUpTime.0 varbind
  236. .TP
  237. .B %J
  238. the minute field from the sysUpTime.0 varbind
  239. .TP
  240. .B %K
  241. the seconds field from the sysUpTime.0 varbind
  242. .TP
  243. .B %a
  244. the contents of the agent-addr field of the PDU (v1 TRAPs only)
  245. .TP
  246. .B %A
  247. the hostname corresponding to the contents of the agent-addr field of
  248. the PDU, if available, otherwise the contents of the agent-addr field
  249. of the PDU (v1 TRAPs only).
  250. .TP
  251. .B %b
  252. PDU source address (Note: this is not necessarily an IPv4
  253. address)
  254. .TP
  255. .B %B
  256. PDU source hostname if available, otherwise PDU source address (see
  257. note above) 
  258. .TP
  259. .B %N
  260. enterprise string
  261. .TP
  262. .B %w
  263. trap type (numeric, in decimal)
  264. .TP
  265. .B %W
  266. trap description
  267. .TP
  268. .B %q
  269. trap sub-type (numeric, in decimal)
  270. .TP
  271. .B %P
  272. security information from the PDU (community name for v1/v2c,
  273. user and context for v3)
  274. .TP
  275. .B %v
  276. list of trap's variable-bindings. These will be separated by a tab,
  277. or by a comma and a blank if the alternate form is requested
  278. See also %V
  279. .TP
  280. .B %V
  281. specifies the variable-bindings separator. This takes a sequence of
  282. characters, up to the next % (to embed a % in the string, use \%)
  283. .RE
  284. .PP
  285. In addition to these values, you may also specify an optional field
  286. width and precision, just as in 
  287. .IR printf(3) ,
  288. and a flag value. The following flags are legal:
  289. .RS 4 
  290. .TP 4
  291. .B -
  292. left justify
  293. .TP
  294. .B 0
  295. use leading zeros
  296. .TP
  297. .B #
  298. use alternate form
  299. .RE
  300. .PP
  301. The "use alternate form" flag changes the behavior of some format
  302. flags. Normally, the fields that display time information base it on
  303. the local timezone, but this flag tells them to use GMT instead.
  304. Also, the variable-binding list is normally a tab-separated list, but
  305. this flag changes it to a comma-separated one. The alternate form for
  306. the uptime is similar to "3 days, 0:14:34.65"
  307. .SS Examples:
  308. .PP
  309. To get a message like "14:03 TRAP3.1 from humpty.ucd.edu" you 
  310. could use something like this:
  311. .PP
  312. .RS
  313. .nf
  314. snmptrapd -P -F "%02.2h:%02.2j TRAP%w.%q from %Aen"
  315. .fi
  316. .RE
  317. .PP
  318. If you want the same thing but in GMT rather than local time, use
  319. .PP
  320. .RS
  321. .nf
  322. snmptrapd -P -F "%#02.2h:%#02.2j TRAP%w.%q from %Aen"
  323. .fi
  324. .RE
  325. .SH LISTENING ADDRESSES
  326. By default,
  327. .B snmptrapd
  328. listens for incoming SNMP TRAP and INFORM packets on UDP port 162 on
  329. all IPv4 interfaces.  However, it is possible to modify this behaviour
  330. by specifying one or more listening addresses as arguments to
  331. .BR snmptrapd .
  332. See the
  333. .I snmpd(8)
  334. manual page for more information about the format of listening
  335. addresses.
  336. .SH NOTIFICATION-LOG-MIB SUPPORT
  337. As of net-snmp 5.0, the snmptrapd application supports the
  338. NOTIFICATION-LOG-MIB.  It does this by opening an AgentX subagent
  339. connection to the master snmpd agent and registering the notification
  340. log tables.  As long as the snmpd application is started first, it
  341. will attach itself to it and thus you should be able to view the last
  342. recorded notifications via the nlmLogTable and nlmLogVariableTable.
  343. See the snmptrapd.conf file and the "dontRetainLogs" token for turning
  344. off this support.  See the NOTIFICATION-LOG-MIB for more details about
  345. the MIB itself.
  346. .SH EXTENSIBILITY AND CONFIGURATION
  347. See the
  348. .I snmptrapd.conf(5)
  349. manual page.
  350. .SH "SEE ALSO"
  351. snmpcmd(1), snmpd(8), printf(3), snmptrapd.conf(5), syslog(8), variables(5)