ADC Home > Reference Library > Reference > Mac OS X > Mac OS X Man Pages

 

This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).



SNMPTEST(1)                                       Net-SNMP                                       SNMPTEST(1)



NAME
       snmptest - communicates with a network entity using SNMP requests

SYNOPSIS
       snmptest [COMMON OPTIONS] AGENT

DESCRIPTION
       snmptest  is a flexible SNMP application that can monitor and manage information on a network entity.

       After invoking the program, a command line interpreter proceeds to accept commands.  This  intepreter
       enables the user to send different types of SNMP requests to target agents.

       AGENT  identifies  a  target  SNMP agent, which is instrumented to monitor the gievn objects.  At its
       simplest, the AGENT specification will consist of a hostname or an IPv4 address.  In this  situation,
       the command will attempt communication with the agent, using UDP/IPv4 to port 161 of the given target
       host. See snmpcmd(1) for a full list of the possible formats for AGENT.

       Once snmptest is invoked, the command line intepreter will prompt with:

       Variable:

       At this point you can enter one or more variable names, one per line.  A blank line ends the  parame-ter parameter
       ter  input  and  will  send the request (variables entered) in a single packet, to the remote entity.
       Each variable name is given in the format specified in variables(5).  For example:

       snmptest -c public -v 1 zeus
       Variable: system.sysDescr.0
       Variable:

       will return some information about the request and reply packets, as well as the information:

       requestid 0x5992478A errstat 0x0 errindex 0x0
       system.sysDescr.0 = STRING: "Unix 4.3BSD"

       The errstatus value shows the error status code for the call.  The possible values for errstat are in
       the  header file snmp.h.  The errindex value identifies the variable that has the given error.  Index
       values are assigned to all the variables entered at  the  "Variable":  prompt.  The  first  value  is
       assigned an index of 1.

       Upon  startup,  the  program  defaults  to  sending a GET request packet.  The type of request can be
       changed by typing one of the following commands at the "Variable:" prompt:

       $G - send a GET request
       $N - send a GETNEXT request
       $S - send a SET request
       $B - send a GETBULK request
            Note: GETBULK is not available in SNMPv1
       $I - send an Inform request
       $T - send an SNMPv2 Trap request

       Other values that can be entered at the "Variable:" prompt are:

       $D - toggle the dumping of each sent and received packet
       $QP - toggle a quicker, less verbose output form
       $Q - Quit the program

       Request Types:

       GET Request:

       When in "GET request" mode ($G or default), the user can enter an OID at the "Variable:" prompt.  The
       user can enter multiple OIDs, one per prompt. The user enters a blank line to send the GET request.

       GETNEXT Request:

       The "GETNEXT request" mode ($N) is simlar to the "Get request" mode, described above.

       SET Request:

       When  in  the "SET request" mode ($S), more information is requested by the prompt for each variable.
       The prompt:

       Type [i|s|x|d|n|o|t|a]:
       requests the type of the variable be entered.  Depending on the type of value you want  to  set,  you
       can type one of the following:

       i - integer
       u - unsigned integer
       s - octet string in ASCII
       x - octet string in hex bytes, separated by whitespace
       d - octet string as decimal bytes, separated by whitespace
       a - ip address in dotted IP notation
       o - object identifier
       n - null
       t - timeticks
       At this point a value will be prompted for:

       Value:

       If  this is an integer value, just type the integer (in decimal).  If it is a decimal string, type in
       white-space separated decimal numbers, one per byte of the string.  Again type a blank  line  at  the
       prompt for the variable name to send the packet.

       GETBULK Request:

       The  "GETBULK  request"  mode  ($B)  is  similar to the "Set request" mode.  GETBULK, however, is not
       available in SNMPv1.

       Inform Request:

       The "Inform request" mode ($I) is similar to the "Set request" mode.  This type of request,  however,
       is  not available in SNMPv1. Also, the _agent_ specified on the snmptest command should correspond to
       the target snmptrapd agent.

       SNMPv2 Trap Request:

       The "SNMPv2 Trap Request" mode ($T) is similar to the "Set request" mode.  This type of request, how-ever, however,
       ever,  is  not available in SNMPv1. Also, the _agent_ specified on the snmptest command should corre-spond correspond
       spond to the target snmptrapd agent.

OPTIONS
       snmptest takes the common options described in the snmpcmd(1) manual page.

EXAMPLES
       The following is an example of sending a GET request for two OIDs:

       % snmptest -v 2c -c public testhost:9999

       Variable: system.sysDescr.0
       Variable: system.sysContact.0
       Variable:
       Received Get Response from 128.2.56.220
       requestid 0x7D9FCD63 errstat 0x0 errindex 0x0
       SNMPv2-MIB::sysDescr.0 = STRING: SunOS testhost 5.9 Generic_112233-02 sun4u
       SNMPv2-MIB::sysContact.0 = STRING: x1111

       The following is an example of sending a GETNEXT request:

       Variable: SNMPv2-MIB::sysORUpTime
       Variable:
       Received Get Response from 128.2.56.220
       requestid 0x7D9FCD64 errstat 0x0 errindex 0x0
       SNMPv2-MIB::sysORUpTime.1 = Timeticks: (6) 0:00:00.06
       Variable:

       The following is an example of sending a SET request:

       Variable: $S
       Request type is Set Request
       Variable: system.sysLocation.0
       Type [i|u|s|x|d|n|o|t|a]: s
       Value: building 17
       Variable:
       Received Get Response from 128.2.56.220
       requestid 0x7D9FCD65 errstat 0x0 errindex 0x0
       SNMPv2-MIB::sysLocation.0 = STRING: building A
       Variable:

       The following is an example of sending a GETBULK request:

       Variable: $B
       Request type is Bulk Request
       Enter a blank line to terminate the list of non-repeaters
       and to begin the repeating variables
       Variable:
       Now input the repeating variables
       Variable: system.sysContact.0
       Variable: system.sysLocation.0
       Variable:
       What repeat count? 2
       Received Get Response from 128.2.56.220
       requestid 0x2EA7942A errstat 0x0 errindex 0x0
       SNMPv2-MIB::sysName.0 = STRING: testhost
       SNMPv2-MIB::sysORLastChange.0 = Timeticks: (58) 0:00:00.58
       SNMPv2-MIB::sysLocation.0 = STRING: bldg A
       SNMPv2-MIB::sysORID.1 = OID: IF-MIB::ifMIB
       Variable:

       The following is an example of sending an Inform request:

       snmptest -v 2c -c public snmptrapd_host
       Variable: $I
       Request type is Inform Request
       (Are you sending to the right port?)
       Variable: system.sysContact.0
       Type [i|u|sIx|d|n|o|t|a]: s
       Value: x12345
       Variable:
       Inform Acknowledged
       Variable:

       The snmptrapd_host will show:

       snmptrapd_host [<ip address>]: Trap SNMPv2-MIB::sysContact.0 = STRING: x12345

       The following is an example of sending an SNMPv2 Trap request:

       snmptest -v 2c -c public snmptrapd_host
       Variable: $T
       Request type is SNMPv2 Trap Request
       (Are you sending to the right port?)
       Variable: system.sysLocation.0
       Type [i|u|s|x|d|n|o|t|a]: s
       Value: building a
       Variable:

       The snmptrapd_host will show:

       snmptrapd_host [<ip address>]: Trap SNMPv2-MIB::sys.0 = STRING:
       building a

SEE ALSO
       snmpcmd(1), snmpget(1), snmpset(1), variables(5)



4th Berkeley Distribution                        25 Jul 2003                                     SNMPTEST(1)

Did this document help you?
Yes: Tell us what works for you.
It’s good, but: Report typos, inaccuracies, and so forth.
It wasn’t helpful: Tell us what would have helped.