blob: 13252dd8a9640c6b420335d2eb9835b4d3a10bec [file] [log] [blame]
.\* /***********************************************************
.\" Copyright 1988, 1989 by Carnegie Mellon University
.\"
.\" All Rights Reserved
.\"
.\" Permission to use, copy, modify, and distribute this software and its
.\" documentation for any purpose and without fee is hereby granted,
.\" provided that the above copyright notice appear in all copies and that
.\" both that copyright notice and this permission notice appear in
.\" supporting documentation, and that the name of CMU not be
.\" used in advertising or publicity pertaining to distribution of the
.\" software without specific, written prior permission.
.\"
.\" CMU DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
.\" ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
.\" CMU BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
.\" ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
.\" WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
.\" ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
.\" SOFTWARE.
.\" ******************************************************************/
.TH SNMPTRAP 1 "13 July 1994"
.UC 4
.SH NAME
snmptrap - sends an SNMP trap to a manager
.SH SYNOPSIS
snmptrap -v 1 [common arguments] enterprise-oid agent generic-trap specific-trap uptime [objectID type value]...
.PP
snmptrap -v [2c|2p] [common arguments] uptime trap-oid [objectID type value]...
.SH DESCRIPTION
Snmptrap is an SNMP application that uses the TRAP Request to send
information to a network manager. One or more fully qualified
object identifiers can be given as arguments on the command line. A type
and a value must accompany each object
identifier. Each variable name is given in the format specified in
.IR variables (5).
.PP
If any of the required version 1 parameters,
.IR enterprise-oid ,
.IR agent ,
and
.I uptime
are specified as empty, it defaults to
.IR "1.3.6.1.4.1.3.1.1 (enterprises.cmu.1.1)" ,
.IR hostname ,
and
.I host-uptime
respectively.
.PP
The
.I type
is a single character, one of:
.RS
.PD 0
.TP 3
.B i
INTEGER
.TP 3
.B s
STRING
.TP 3
.B x
HEX STRING
.TP 3
.B d
DECIMAL STRING
.TP 3
.B n
NULLOBJ
.TP 3
.B o
OBJID
.TP 3
.B t
TIMETICKS
.TP 3
.B a
IPADDRESS
.PD
.RE
.PP
For example
.PP
.I "snmptrap -v 1 manager public enterprises.spider test-hub 3 0 '' interfaces.iftable.ifentry.ifindex.1 i 1"
.PP
will send a generic link-up trap to manager, for interface 1.
.PP
If the network entity has an error processing the request packet, an error
packet will be returned and a message will be shown, helping to pinpoint in what
way the request was malformed. If there were other variables in the request,
the request will be resent without the bad variable.
.PP
snmpcmd(1), variables(5).