开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > Internet/网络编程 > SNMP编程 > 查看源码
netsnmp_agent_trap.3
资源名称：net-snmp-5.2.2.rar　[点击查看]
上传用户：wxp200602
上传日期：2007-10-30
资源大小：4028k
文件大小：9k
源码类别：

SNMP编程

开发平台：

Unix_Linux

netsnmp_agent_trap.3：源码内容
  1. .TH "Trap generation routines for mib modules to use" 3 "28 Nov 2005" "Version 5.2.1.rc3" "net-snmp" " -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. Trap generation routines for mib modules to use - 
  6. .SS "Data Structures"
  8. .in +1c
  9. .ti -1c
  10. .RI "struct fBtrap_sinkfP"
  11. .br
  12. .in -1c
  13. .SS "Defines"
  15. .in +1c
  16. .ti -1c
  17. .RI "#define fBSNMPV2_TRAPS_PREFIXfP   SNMP_OID_SNMPMODULES,1,1,5"
  18. .br
  19. .ti -1c
  20. .RI "#define fBSNMPV2_TRAP_OBJS_PREFIXfP   SNMP_OID_SNMPMODULES,1,1,4"
  21. .br
  22. .ti -1c
  23. .RI "#define fBSNMPV2_COMM_OBJS_PREFIXfP   SNMP_OID_SNMPMODULES,18,1"
  24. .br
  25. .ti -1c
  26. .RI "#define fBSNMP_AUTHENTICATED_TRAPS_ENABLEDfP   1"
  27. .br
  28. .ti -1c
  29. .RI "#define fBSNMP_AUTHENTICATED_TRAPS_DISABLEDfP   2"
  30. .br
  31. .ti -1c
  32. .RI "#define fBMAX_ARGSfP   128"
  33. .br
  34. .in -1c
  35. .SS "Functions"
  37. .in +1c
  38. .ti -1c
  39. .RI "void fBinit_trapsfP (void)"
  40. .br
  41. .ti -1c
  42. .RI "int fBadd_trap_sessionfP (fBnetsnmp_sessionfP *ss, int pdutype, int confirm, int version)"
  43. .br
  44. .ti -1c
  45. .RI "int fBremove_trap_sessionfP (fBnetsnmp_sessionfP *ss)"
  46. .br
  47. .ti -1c
  48. .RI "int fBcreate_trap_sessionfP (char *sink, u_short sinkport, char *com, int version, int pdutype)"
  49. .br
  50. .ti -1c
  51. .RI "void fBsnmpd_free_trapsinksfP (void)"
  52. .br
  53. .RI "fIThis function allows you to make a distinction between generic traps from different classes of equipment. fP"
  54. .ti -1c
  55. .RI "fBnetsnmp_variable_listfP * fBfind_varbind_in_listfP (fBnetsnmp_variable_listfP *vblist, oid *name, size_t len)"
  56. .br
  57. .ti -1c
  58. .RI "fBnetsnmp_pdufP * fBconvert_v2pdu_to_v1fP (fBnetsnmp_pdufP *template_v2pdu)"
  59. .br
  60. .ti -1c
  61. .RI "fBnetsnmp_pdufP * fBconvert_v1pdu_to_v2fP (fBnetsnmp_pdufP *template_v1pdu)"
  62. .br
  63. .ti -1c
  64. .RI "int fBnetsnmp_send_trapsfP (int trap, int specific, oid *enterprise, int enterprise_length, fBnetsnmp_variable_listfP *vars, char *context, int flags)"
  65. .br
  66. .ti -1c
  67. .RI "void fBsend_enterprise_trap_varsfP (int trap, int specific, oid *enterprise, int enterprise_length, fBnetsnmp_variable_listfP *vars)"
  68. .br
  69. .ti -1c
  70. .RI "int fBhandle_inform_responsefP (int op, fBnetsnmp_sessionfP *session, int reqid, fBnetsnmp_pdufP *pdu, void *magic)"
  71. .br
  72. .RI "fICaptures responses or the lack there of from INFORMs that were sent 1) a response is received from an INFORM 2) one isn't received and the retries/timeouts have failed. fP"
  73. .ti -1c
  74. .RI "void fBsend_trap_to_sessfP (fBnetsnmp_sessionfP *sess, fBnetsnmp_pdufP *template_pdu)"
  75. .br
  76. .ti -1c
  77. .RI "void fBsend_trap_varsfP (int trap, int specific, fBnetsnmp_variable_listfP *vars)"
  78. .br
  79. .ti -1c
  80. .RI "void fBsend_easy_trapfP (int trap, int specific)"
  81. .br
  82. .RI "fISends an SNMPv1 trap (or the SNMPv2 equivalent) to the list of configured trap destinations (or 'sinks'), using the provided values for the generic trap type and specific trap value. fP"
  83. .ti -1c
  84. .RI "void fBsend_v2trapfP (fBnetsnmp_variable_listfP *vars)"
  85. .br
  86. .RI "fIUses the supplied list of variable bindings to form an SNMPv2 trap, which is sent to SNMPv2-capable sinks on the configured list. fP"
  87. .ti -1c
  88. .RI "void fBsend_trap_pdufP (fBnetsnmp_pdufP *pdu)"
  89. .br
  90. .ti -1c
  91. .RI "void fBsnmpd_parse_config_authtrapfP (const char *token, char *cptr)"
  92. .br
  93. .ti -1c
  94. .RI "void fBsnmpd_parse_config_trapsinkfP (const char *token, char *cptr)"
  95. .br
  96. .ti -1c
  97. .RI "void fBsnmpd_parse_config_trap2sinkfP (const char *word, char *cptr)"
  98. .br
  99. .ti -1c
  100. .RI "void fBsnmpd_parse_config_informsinkfP (const char *word, char *cptr)"
  101. .br
  102. .ti -1c
  103. .RI "void fBsnmpd_parse_config_trapsessfP (const char *word, char *cptr)"
  104. .br
  105. .ti -1c
  106. .RI "void fBsnmpd_parse_config_trapcommunityfP (const char *word, char *cptr)"
  107. .br
  108. .ti -1c
  109. .RI "void fBsnmpd_free_trapcommunityfP (void)"
  110. .br
  111. .in -1c
  112. .SS "Variables"
  114. .in +1c
  115. .ti -1c
  116. .RI "fBtrap_sinkfP * fBsinksfP = NULL"
  117. .br
  118. .ti -1c
  119. .RI "timeval fBstarttimefP"
  120. .br
  121. .ti -1c
  122. .RI "oid fBobjid_enterprisetrapfP [] = { NOTIFICATION_MIB }"
  123. .br
  124. .ti -1c
  125. .RI "oid fBtrap_version_idfP [] = { SYSTEM_MIB }"
  126. .br
  127. .ti -1c
  128. .RI "int fBenterprisetrap_lenfP"
  129. .br
  130. .ti -1c
  131. .RI "int fBtrap_version_id_lenfP"
  132. .br
  133. .ti -1c
  134. .RI "oid fBtrap_prefixfP [] = { SNMPV2_TRAPS_PREFIX }"
  135. .br
  136. .ti -1c
  137. .RI "oid fBcold_start_oidfP [] = { SNMPV2_TRAPS_PREFIX, 1 }"
  138. .br
  139. .ti -1c
  140. .RI "oid fBwarm_start_oidfP [] = { SNMPV2_TRAPS_PREFIX, 2 }"
  141. .br
  142. .ti -1c
  143. .RI "oid fBlink_down_oidfP [] = { SNMPV2_TRAPS_PREFIX, 3 }"
  144. .br
  145. .ti -1c
  146. .RI "oid fBlink_up_oidfP [] = { SNMPV2_TRAPS_PREFIX, 4 }"
  147. .br
  148. .ti -1c
  149. .RI "oid fBauth_fail_oidfP [] = { SNMPV2_TRAPS_PREFIX, 5 }"
  150. .br
  151. .ti -1c
  152. .RI "oid fBegp_xxx_oidfP [] = { SNMPV2_TRAPS_PREFIX, 99 }"
  153. .br
  154. .ti -1c
  155. .RI "oid fBsnmptrap_oidfP [] = { SNMPV2_TRAP_OBJS_PREFIX, 1, 0 }"
  156. .br
  157. .ti -1c
  158. .RI "oid fBsnmptrapenterprise_oidfP []"
  159. .br
  160. .ti -1c
  161. .RI "oid fBsysuptime_oidfP [] = { SNMP_OID_MIB2, 1, 3, 0 }"
  162. .br
  163. .ti -1c
  164. .RI "size_t fBsnmptrap_oid_lenfP"
  165. .br
  166. .ti -1c
  167. .RI "size_t fBsnmptrapenterprise_oid_lenfP"
  168. .br
  169. .ti -1c
  170. .RI "size_t fBsysuptime_oid_lenfP"
  171. .br
  172. .ti -1c
  173. .RI "oid fBagentaddr_oidfP [] = { SNMPV2_COMM_OBJS_PREFIX, 3, 0 }"
  174. .br
  175. .ti -1c
  176. .RI "size_t fBagentaddr_oid_lenfP"
  177. .br
  178. .ti -1c
  179. .RI "oid fBcommunity_oidfP [] = { SNMPV2_COMM_OBJS_PREFIX, 4, 0 }"
  180. .br
  181. .ti -1c
  182. .RI "size_t fBcommunity_oid_lenfP"
  183. .br
  184. .ti -1c
  185. .RI "char * fBsnmp_trapcommunityfP = NULL"
  186. .br
  187. .ti -1c
  188. .RI "int fBsnmp_enableauthentrapsfP = SNMP_AUTHENTICATED_TRAPS_DISABLED"
  189. .br
  190. .ti -1c
  191. .RI "int fBsnmp_enableauthentrapssetfP = 0"
  192. .br
  193. .in -1c
  194. .SH "Function Documentation"
  195. .PP 
  196. .SS "int handle_inform_response (int op, fBnetsnmp_sessionfP * session, int reqid, fBnetsnmp_pdufP * pdu, void * magic)"
  197. .PP
  198. Captures responses or the lack there of from INFORMs that were sent 1) a response is received from an INFORM 2) one isn't received and the retries/timeouts have failed. 
  199. .PP
  200. Definition at line 827 of file agent_trap.c.
  201. .PP
  202. References snmp_increment_statistic().
  203. .PP
  204. Referenced by send_trap_to_sess().
  205. .SS "void send_easy_trap (int trap, int specific)"
  206. .PP
  207. Sends an SNMPv1 trap (or the SNMPv2 equivalent) to the list of configured trap destinations (or 'sinks'), using the provided values for the generic trap type and specific trap value. 
  208. .PP
  209. This function eventually calls send_enterprise_trap_vars. If the trap type is not set to SNMP_TRAP_ENTERPRISESPECIFIC the enterprise and enterprise_length paramater is set to the pre defined SYSTEM_MIB oid and length respectively. If the trap type is set to SNMP_TRAP_ENTERPRISESPECIFIC the enterprise and enterprise_length parameters are set to the pre-defined NOTIFICATION_MIB oid and length respectively.
  210. .PP
  211. fBParameters:fP
  212. .RS 4
  213. fItrapfP is the generic trap type.
  214. .br
  215. fIspecificfP is the specific trap value.
  216. .RE
  217. .PP
  218. fBReturns:fP
  219. .RS 4
  220. void
  221. .RE
  222. .PP
  223. fBSee also:fP
  224. .RS 4
  225. fBsend_enterprise_trap_varsfP 
  226. .PP
  227. fBsend_v2trapfP
  228. .RE
  229. .PP
  231. .PP
  232. Definition at line 941 of file agent_trap.c.
  233. .PP
  234. References NULL, and send_trap_vars().
  235. .PP
  236. Referenced by handle_snmp_packet().
  237. .SS "void send_v2trap (fBnetsnmp_variable_listfP * vars)"
  238. .PP
  239. Uses the supplied list of variable bindings to form an SNMPv2 trap, which is sent to SNMPv2-capable sinks on the configured list. 
  240. .PP
  241. An equivalent INFORM is sent to the configured list of inform sinks. Sinks that can only handle SNMPv1 traps are skipped.
  242. .PP
  243. This function eventually calls send_enterprise_trap_vars. If the trap type is not set to SNMP_TRAP_ENTERPRISESPECIFIC the enterprise and enterprise_length paramater is set to the pre defined SYSTEM_MIB oid and length respectively. If the trap type is set to SNMP_TRAP_ENTERPRISESPECIFIC the enterprise and enterprise_length parameters are set to the pre-defined NOTIFICATION_MIB oid and length respectively.
  244. .PP
  245. fBParameters:fP
  246. .RS 4
  247. fIvarsfP is used to supply list of variable bindings to form an SNMPv2 trap.
  248. .RE
  249. .PP
  250. fBReturns:fP
  251. .RS 4
  252. void
  253. .RE
  254. .PP
  255. fBSee also:fP
  256. .RS 4
  257. fBsend_easy_trapfP 
  258. .PP
  259. fBsend_enterprise_trap_varsfP
  260. .RE
  261. .PP
  263. .PP
  264. fBExamples: fP
  265. .in +1c
  266. fBnotification.cfP.
  267. .PP
  268. Definition at line 970 of file agent_trap.c.
  269. .PP
  270. References send_trap_vars().
  271. .SS "void snmpd_free_trapsinks (void)"
  272. .PP
  273. This function allows you to make a distinction between generic traps from different classes of equipment. 
  274. .PP
  275. For example, you may want to handle a SNMP_TRAP_LINKDOWN trap for a particular device in a different manner to a generic system SNMP_TRAP_LINKDOWN trap.
  276. .PP
  277. fBParameters:fP
  278. .RS 4
  279. fItrapfP is the generic trap type. The trap types are:
  280. .IP "(bu" 2
  281. SNMP_TRAP_COLDSTART: cold start
  282. .IP "(bu" 2
  283. SNMP_TRAP_WARMSTART: warm start
  284. .IP "(bu" 2
  285. SNMP_TRAP_LINKDOWN: link down
  286. .IP "(bu" 2
  287. SNMP_TRAP_LINKUP: link up
  288. .IP "(bu" 2
  289. SNMP_TRAP_AUTHFAIL: authentication failure
  290. .IP "(bu" 2
  291. SNMP_TRAP_EGPNEIGHBORLOSS: egp neighbor loss
  292. .IP "(bu" 2
  293. SNMP_TRAP_ENTERPRISESPECIFIC: enterprise specific
  294. .PP
  295. .br
  296. fIspecificfP is the specific trap value.
  297. .br
  298. fIenterprisefP is an enterprise oid in which you want to send specifc traps from.
  299. .br
  300. fIenterprise_lengthfP is the length of the enterprise oid, use macro, OID_LENGTH, to compute length.
  301. .br
  302. fIvarsfP is used to supply list of variable bindings to form an SNMPv2 trap.
  303. .RE
  304. .PP
  305. fBReturns:fP
  306. .RS 4
  307. void
  308. .RE
  309. .PP
  310. fBSee also:fP
  311. .RS 4
  312. fBsend_easy_trapfP 
  313. .PP
  314. fBsend_v2trapfP
  315. .RE
  316. .PP
  318. .PP
  319. Definition at line 353 of file agent_trap.c.
  320. .PP
  321. References trap_sink::next.
  322. .SH "Variable Documentation"
  323. .PP 
  324. .SS "oid fBsnmptrapenterprise_oidfP[]"
  325. .PP
  326. fBInitial value:fP
  327. .PP
  328. .nf
  330.     { SNMPV2_TRAP_OBJS_PREFIX, 3, 0 }
  331. .fi
  332. .PP
  333. Definition at line 102 of file agent_trap.c.
  334. .PP
  335. Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), init_traps(), and netsnmp_send_traps().