manual/ucd-snmp/original/man1/snmpget.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 SNMPGET 1 "17 Jun 1998"
  23 .UC 4
  24 .SH NAME
  25 snmpget - communicates with a network entity using SNMP GET Requests.
  26 .SH SYNOPSIS
  27 snmpget [-Cf] [ common arguments ] objectID [objectID]...
  28 .SH DESCRIPTION
  29 Snmpget is an SNMP application that uses the GET Request to query for
  30 information on a network entity.  One or more fully qualified object
  31 identifiers may be given as arguments on the command line.
  32 Each variable name is given in the format specified in
  33 .IR variables (5).
  34 .PP
  35 For example
  36 .PP
  37 .I snmpget zeus public system.sysDescr.0
  38 .PP
  39 will retrieve the variable system.sysDescr.0:
  40 .PP
  41 .I system.sysDescr.0 =
  42 "SunOS zeus.net.cmu.edu 4.1.3_U1 1 sun4m"
  43 .PP
  44 If the network entity has an error processing the request packet, an error
  45 packet will be returned and a message will be shown, helping to pinpoint in what
  46 way the request was malformed.  If there were other variables in the request,
  47 the request will be resent without the bad variable.
  48 .PP
  49 .SH "OPTIONS"
  50 .IP -Cf
  51 If -Cf is not specified, some applications (E.G., snmpget,
  52 snmpgetnext, snmpwalk, etc) will try to fix errors returned by the
  53 agent that you were talking to and resend the request.  The only time
  54 this is really useful is if you specified a OID that didn't exist in
  55 your request and you're using SNMPv1 which requires "all or nothing"
  56 kinds of requests. Example (system.sysUptime is an incomplete OID
  57 request for agents as it needs the .0 index appended to it):
  58 .nf
  59 snmpget -v 1 -Cf localhost public system.sysUpTime system.sysContact.0
  60 Error in packet
  61 Reason: (noSuchName) There is no such variable name in this MIB.
  62 This name doesn't exist: system.sysUpTime
  63
  64 snmpget -v 1 localhost public system.sysUpTime system.sysContact.0
  65 Error in packet
  66 Reason: (noSuchName) There is no such variable name in this MIB.
  67 This name doesn't exist: system.sysUpTime
  68
  69 system.sysContact.0 = root@localhost
  70 .fi
  71 .IP
  72 With the -Cf specified the application will not try to fix the PDU for
  73 you.
  74 .SH "SEE ALSO"
  75 snmpcmd(1), variables(5).