Blame man/agentxtrap.1.def

Packit fcad23
.TH AGENTXTRAP 1 "20 Dec 2009" VVERSIONINFO "Net-SNMP"
Packit fcad23
.SH NAME
Packit fcad23
agentxtrap - send an AgentX NotifyPDU to an AgentX master agent
Packit fcad23
.SH SYNOPSIS
Packit fcad23
.B agentxtrap
Packit fcad23
.RI [ OPTIONS ] " trap-oid " [ "OID TYPE VALUE" ...]
Packit fcad23
.SH DESCRIPTION
Packit fcad23
.B agentxtrap
Packit fcad23
issues an AgentX NotifyPDU to a master agent. One or more object
Packit fcad23
identifiers (OIDs) can be given as arguments on the command line.
Packit fcad23
A type and a value must accompany each object identifier.
Packit fcad23
Each variable name is given in the format specified in
Packit fcad23
.IR variables(5) .
Packit fcad23
.PP
Packit fcad23
.SH OPTIONS
Packit fcad23
.PD 0
Packit fcad23
.TP 6
Packit fcad23
.BI \-c "\| contextName\^"
Packit fcad23
if the
Packit fcad23
.B \-c
Packit fcad23
option is present then the notification is sent in the nondefault name context.
Packit fcad23
.TP
Packit fcad23
.BI \-U "\| uptime\^"
Packit fcad23
if the
Packit fcad23
.B \-U
Packit fcad23
option is present then that value, parsed as centiseconds, is taken to be the
Packit fcad23
sysUpTime field of the application.
Packit fcad23
.TP
Packit fcad23
.BI \-x "\| ADDRESS\^"
Packit fcad23
if the
Packit fcad23
.B \-x
Packit fcad23
option is present then contact the AgentX master at ADDRESS and not the default
Packit fcad23
one.
Packit fcad23
.PD
Packit fcad23
.PP
Packit fcad23
Additionally all the options described in
Packit fcad23
.IR snmpcmd(1)
Packit fcad23
under the
Packit fcad23
.BR "MIB PARSING OPTIONS" ", " "LOGGING OPTIONS" " and " "INPUT OPTIONS"
Packit fcad23
headers as well as the
Packit fcad23
.BR -d ", " -D ", " -m " and " -M
Packit fcad23
options are supported.
Packit fcad23
.PP
Packit fcad23
In
Packit fcad23
.I OID TYPE VALUE
Packit fcad23
the parsing of the
Packit fcad23
.I VALUE
Packit fcad23
field is controlled by the
Packit fcad23
.I TYPE
Packit fcad23
field. The possible values for the
Packit fcad23
.I TYPE
Packit fcad23
field is one of the following characters:
Packit fcad23
.RS
Packit fcad23
.PD 0
Packit fcad23
.TP 3
Packit fcad23
.B =
Packit fcad23
Let
Packit fcad23
.I OID
Packit fcad23
decide how
Packit fcad23
.I VALUE
Packit fcad23
should be interpreted
Packit fcad23
.TP
Packit fcad23
.B i
Packit fcad23
INTEGER
Packit fcad23
.TP
Packit fcad23
.B u
Packit fcad23
Unsigned
Packit fcad23
.TP
Packit fcad23
.B c
Packit fcad23
Counter32
Packit fcad23
.TP
Packit fcad23
.B s
Packit fcad23
OCTET STRING of chaacters
Packit fcad23
.TP
Packit fcad23
.B x
Packit fcad23
OCTET STRING, entered as a sequence of optionally space separated hexadecimal
Packit fcad23
digit pairs
Packit fcad23
.TP
Packit fcad23
.B d
Packit fcad23
OCTET STRING, entered as a sequence of space separated decimal digits in the
Packit fcad23
range 0 - 255
Packit fcad23
.TP
Packit fcad23
.B n
Packit fcad23
NULL
Packit fcad23
.TP
Packit fcad23
.B o
Packit fcad23
OBJECT IDENTIFIER
Packit fcad23
.TP
Packit fcad23
.B t
Packit fcad23
TimeTicks
Packit fcad23
.TP
Packit fcad23
.B a
Packit fcad23
IpAddress
Packit fcad23
.TP
Packit fcad23
.B b
Packit fcad23
BITS
Packit fcad23
.PD
Packit fcad23
.RE
Packit fcad23
which are handled in the same way as the
Packit fcad23
.B snmpset
Packit fcad23
command.
Packit fcad23
.PP
Packit fcad23
.SH EXAMPLES
Packit fcad23
To send a generic linkUp trap to the manager for interface 1 the following
Packit fcad23
command can be used:
Packit fcad23
.PP
Packit fcad23
agentxtrap netSnmp.0.3 ifindex.1 i 1
Packit fcad23
.PP
Packit fcad23
.SH SEE ALSO
Packit fcad23
snmpcmd(1), snmpset(1), variables(5), RFC 2741