userapps/opensource/net-snmp/man/snmpset.1.def

   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 SNMPSET 1 "08 Feb 2002" VVERSIONINFO "Net-SNMP"
  23 .UC 4
  24 .SH NAME
  25 snmpset - communicates with a network entity using SNMP SET Requests.
  26 .SH SYNOPSIS
  27 .B snmpset
  28 [COMMON OPTIONS] OID TYPE VALUE [OID TYPE VALUE]...
  29 .SH DESCRIPTION
  30 .B snmpset
  31 is an SNMP application that uses the SNMP SET request to set
  32 information on a network entity.  One or more object identifiers
  33 (OIDs) must be given as arguments on the command line.  A type and a
  34 value to be set must accompany each object identifier.  Each variable
  35 name is given in the format specified in
  36 .IR variables(5) .
  37 .PP
  38 The
  39 .I TYPE
  40 is a single character, one of:
  41 .RS
  42 .PD 0
  43 .TP 3
  44 .B i
  45 INTEGER
  46 .TP 3
  47 .B u
  48 UNSIGNED
  49 .TP 3
  50 .B s
  51 STRING
  52 .TP 3
  53 .B x
  54 HEX STRING
  55 .TP 3
  56 .B d
  57 DECIMAL STRING
  58 .TP 3
  59 .B n
  60 NULLOBJ
  61 .TP 3
  62 .B o
  63 OBJID
  64 .TP 3
  65 .B t
  66 TIMETICKS
  67 .TP 3
  68 .B a
  69 IPADDRESS
  70 .TP 3
  71 .B b
  72 BITS
  73 .PD
  74 .RE
  75 If you have the proper MIB file loaded, you can, in most cases, replace the
  76 type with an '=' sign. For an object of type OCTET STRING this will assume
  77 a string like the 's' type notation. For other types it will do "The
  78 Right Thing".
  79 .PP
  80 For example:
  81 .PP
  82 snmpset -c private -v 1 test-hub system.sysContact.0 s dpz@noc.rutgers.edu ip.ipforwarding.0 = 2
  83 .PP
  84 will set the variables sysContact.0 and ipForwarding.0:
  85 .PP
  86 system.sysContact.0 = STRING: "dpz@noc.rutgers.edu"
  87 .br
  88 ip.ipForwarding.0 = INTEGER: not-forwarding(2)
  89 .PP
  90 If the network entity has an error processing the request packet, an
  91 error packet will be returned and a message will be shown, helping to
  92 pinpoint in what way the request was malformed.
  93 .SH OPTIONS
  94 .B snmpset
  95 takes the common options described in the
  96 .I snmpcmd(1)
  97 manual page.
  98 .SH "SEE ALSO"
  99 snmpcmd(1), variables(5).