userapps/opensource/net-snmp/man/snmp_trap_api.3.def

   1 .TH SNMP_TRAP_API 3 "7 Mar 2002" VVERSIONINFO "Net-SNMP"
   2 .UC 5
   3 .SH NAME
   4 send_easy_trap, send_trap_vars, send_v2trap - send TRAPs or INFORMs
   5 from a Net-SNMP MIB module
   6 .SH SYNOPSIS
   7 .B #include <net-snmp/agent/agent_trap.h>
   8 .PP
   9 .BI "void send_easy_trap(int " trap ", int " specific ");"
  10 .PP
  11 .BI "void send_trap_vars(int " trap ", int " specific ", struct variable_list *" vars ");"
  12 .PP
  13 .BI "void send_v2trap(struct variable_list *" vars ");"
  14 .SH DESCRIPTION
  15 These three routines may be used to send traps from a MIB module
  16 within the Net-SNMP agent (including an AgentX subagent).
  17 .PP
  18 .B send_easy_trap()
  19 sends an SNMPv1 trap (or the SNMPv2 equivalent) to the list of
  20 configured trap destinations (or "sinks"), using the provided values
  21 for the generic trap type, and specific trap value.
  22 .PP
  23 .B send_trap_vars()
  24 is similar, but appends the supplied list of variable bindings to the
  25 traps that are sent.
  26 .PP
  27 .B send_v2trap()
  28 uses the supplied list of variable bindings to form an SNMPv2 trap,
  29 which is sent to SNMPv2-capable sinks on the configured list.  An
  30 equivalent INFORM is sent to the configuredq list of inform sinks.
  31 Sinks that can only handle SNMPv1 traps are skipped.
  32 .SH WARNINGS
  33 These routines are used to send the traps immediately they are called.
  34 Invoking them at the appropriate time is left to the MIB module programmer.
  35 .SH "SEE ALSO"
  36 .BR snmpd.conf "(5), " snmptrapd "(8)"