manual/ucd-snmp/original/man1/snmptrap.1

   1 .\" /***********************************************************
   2 .\"     Copyright 1988, 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 SNMPTRAP 1 "11 May 2000"
  23 .UC 4
  24 .SH NAME
  25 snmptrap, snmpinform - sends an SNMP trap to a manager
  26 .SH SYNOPSIS
  27 snmptrap -v 1 [-Ci] [common arguments] enterprise-oid agent generic-trap specific-trap uptime [objectID type value]...
  28 .PP
  29 snmptrap -v [2c|3] [-Ci] [common arguments] uptime trap-oid [objectID type value]...
  30 .PP
  31 snmpinform -v [2c|3] [common arguments] uptime trap-oid [objectID type value]...
  32 .SH DESCRIPTION
  33 Snmptrap is an SNMP application that uses the TRAP Request to send
  34 information to a network manager.  One or more fully qualified
  35 object identifiers can be given as arguments on the command line.  A type
  36 and a value must accompany each object
  37 identifier.  Each variable name is given in the format specified in
  38 .IR variables (5).
  39 .PP
  40 When invoked as
  41 .I snmpinform,
  42 or when -Ci is added to the command line flags of snmptrap, it sends
  43 an INFORM-PDU, expecting a response from the trap receiver,
  44 retransmitting if required.  Otherwise it sends an TRAP-PDU or
  45 TRAP2-PDU.
  46 .PP
  47 If any of the required version 1 parameters,
  48 .IR enterprise-oid ,
  49 .IR agent ,
  50 and
  51 .I uptime
  52 are specified as empty, it defaults to
  53 .IR "1.3.6.1.4.1.3.1.1 (enterprises.cmu.1.1)" ,
  54 .IR hostname ,
  55 and
  56 .I host-uptime
  57 respectively.
  58 .PP
  59 The
  60 .I type
  61 is a single character, one of:
  62 .RS
  63 .PD 0
  64 .TP 3
  65 .B i
  66 INTEGER
  67 .TP 3
  68 .B u
  69 UNSIGNED
  70 .TP 3
  71 .B c
  72 COUNTER32
  73 .TP 3
  74 .B s
  75 STRING
  76 .TP 3
  77 .B x
  78 HEX STRING
  79 .TP 3
  80 .B d
  81 DECIMAL STRING
  82 .TP 3
  83 .B n
  84 NULLOBJ
  85 .TP 3
  86 .B o
  87 OBJID
  88 .TP 3
  89 .B t
  90 TIMETICKS
  91 .TP 3
  92 .B a
  93 IPADDRESS
  94 .TP 3
  95 .B b
  96 BITS
  97 .PD
  98 .RE
  99 .PP
 100 For example
 101 .PP
 102 .I "snmptrap -v 1 manager public enterprises.spider test-hub 3 0 '' interfaces.iftable.ifentry.ifindex.1 i 1"
 103 .PP
 104 will send a generic link-up trap to manager, for interface 1.
 105 .PP
 106 If the network entity has an error processing the request packet, an error
 107 packet will be returned and a message will be shown, helping to pinpoint in what
 108 way the request was malformed.  If there were other variables in the request,
 109 the request will be resent without the bad variable.
 110 .PP
 111 .SH SEE ALSO
 112 snmpcmd(1), variables(5).