usr.sbin/bsnmpd/tools/bsnmptools/bsnmpget.1

   1 .\"
   2 .\" Copyright (c) 2010 The FreeBSD Foundation
   3 .\" All rights reserved.
   4 .\"
   5 .\" Portions of this documentation were written by Shteryana Sotirova Shopova
   6 .\" under sponsorship from the FreeBSD Foundation.
   7 .\"
   8 .\" Copyright (c) 2005-2007 The FreeBSD Project.
   9 .\"     All rights reserved.
  10 .\"
  11 .\" Author: Shteryana Shopova <syrinx@FreeBSD.org>
  12 .\"
  13 .\" Redistribution and use in source and binary forms, with or without
  14 .\" modification, are permitted provided that the following conditions
  15 .\" are met:
  16 .\" 1. Redistributions of source code must retain the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer.
  18 .\" 2. Redistributions in binary form must reproduce the above copyright
  19 .\"    notice, this list of conditions and the following disclaimer in the
  20 .\"    documentation and/or other materials provided with the distribution.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\" $FreeBSD$
  35 .\"
  36 .Dd September 17, 2007
  37 .Dt BSNMPGET 1
  38 .Os
  39 .Sh NAME
  40 .Nm bsnmpget ,
  41 .Nm bsnmpwalk ,
  42 .Nm bsnmpset
  43 .Nd "simple tools for querying SNMP agents"
  44 .Sh SYNOPSIS
  45 .Nm
  46 .Op Fl aDdehnK
  47 .Op Fl A Ar options
  48 .Op Fl b Ar buffersize
  49 .Op Fl C Ar options
  50 .Op Fl I Ar options
  51 .Op Fl i Ar filelist
  52 .Op Fl l Ar filename
  53 .Op Fl M Ar max-repetitions
  54 .Op Fl N Ar non-repeaters
  55 .Op Fl o Ar output
  56 .Op Fl P Ar options
  57 .Op Fl p Ar pdu
  58 .Op Fl r Ar retries
  59 .Op Fl s Ar [trans::][community@][server][:port]
  60 .Op Fl t Ar timeout
  61 .Op Fl U Ar options
  62 .Op Fl v Ar version
  63 .Op Ar OID ...
  64 .Pp
  65 .Nm bsnmpwalk
  66 .Op Fl dhnK
  67 .Op Fl A Ar options
  68 .Op Fl b Ar buffersize
  69 .Op Fl C Ar options
  70 .Op Fl I Ar options
  71 .Op Fl i Ar filelist
  72 .Op Fl l Ar filename
  73 .Op Fl o Ar output
  74 .Op Fl P Ar options
  75 .Op Fl r Ar retries
  76 .Op Fl s Ar [trans::][community@][server][:port]
  77 .Op Fl t Ar timeout
  78 .Op Fl U Ar options
  79 .Op Fl v Ar version
  80 .Op Ar OID ...
  81 .Pp
  82 .Nm bsnmpset
  83 .Op Fl adehnK
  84 .Op Fl A Ar options
  85 .Op Fl b Ar buffersize
  86 .Op Fl C Ar options
  87 .Op Fl I Ar options
  88 .Op Fl i Ar filelist
  89 .Op Fl l Ar filename
  90 .Op Fl o Ar output
  91 .Op Fl P Ar options
  92 .Op Fl r Ar retries
  93 .Op Fl s Ar [trans::][community@][server][:port]
  94 .Op Fl t Ar timeout
  95 .Op Fl U Ar options
  96 .Op Fl v Ar version
  97 .Ar OID Ns = Ar syntax Ns : Ns Ar value
  98 .Op Ar OID Ns = Ar syntax Ns : Ns Ar value ...
  99 .Sh DESCRIPTION
 100 .Nm ,
 101 .Nm bsnmpwalk
 102 and
 103 .Nm bsnmpset
 104 are simple tools for retrieving management information from and setting
 105 management information to a Simple Network Managment Protocol (SNMP) agent.
 106 .Pp
 107 Depending on the options
 108 .Nm bsnmpget
 109 constructs either a SMNP GetRequest, GetNextRequest
 110 or a GetBulkRequest packet, fills in the object identifiers (OIDs) of the
 111 objects whose values will be retrived, waits for a response and prints it if
 112 received successfully.
 113 .Pp
 114 .Nm Bsnmpwalk
 115 queries an agent with SMNP GetNextRequest packets,
 116 asking for values of OID instances that are a part of the object subtree
 117 rooted at the provided OIDs.
 118 .Pp
 119 .Nm Bsnmpset
 120 constructs a SMNP SetRequest packet, fills in the OIDs (object identifiers),
 121 syntaxes and values of the objects whose values are to be set and waits for a
 122 responce from server.
 123 .Sh OPTIONS
 124 .Pp
 125 The options are as follows (not all apply to all three programs):
 126 .Bl -tag -width ".It Fl D Ar options"
 127 .It Fl A Ar options
 128 Authentication options to use with SNMPv3 PDUs
 129 .Bl -tag -width \&
 130 .It Cm proto=[md5|sha]
 131 The protocol to use when calculating the PDU message digest.
 132 .It Cm key=authkey
 133 A binary localized authentication key to use when calculating the PDU message
 134 digest.
 135 .El
 136 .Pp
 137 By default SNMPv3 PDUs are sent unauthenticated.
 138 .It Fl a
 139 Skip any sanity checks when adding OIDs to a Protocol Data Unit (PDU):
 140 ingore syntax/access type, allow adding of non-leaf objects for GetPdu and
 141 read-only objects to a SetPDU.
 142 .It Fl b Ar buffersize
 143 Tune the size of buffers used to send and receive packets.
 144 The default size is 10000 bytes which should be enough unless an agent sends
 145 a really large octetstring.
 146 The maximum allowed length is 65535 according to the Structure of Management
 147 Information (SMIv2).
 148 .It Fl C Ar options
 149 The context to query with SNMPv3 PDUs.
 150 .Bl -tag -width \&
 151 .It Cm context=name
 152 The context name. Default is "" (empty).
 153 .It Cm context-engine=engine-id
 154 The SNMP Engine ID of the context to query with SNMPv3 PDUs, represented as
 155 binary octet string. By default, this is set to the Engine ID of the SNMP agent.
 156 .El
 157 .It Fl D
 158 Perform SNMP USM Engine Discovery, rather than sending a request for the value
 159 of a specific object.
 160 .It Fl d
 161 Turn on debugging.
 162 This option will cause the packets sent and received to be dumped to the
 163 terminal.
 164 .It Fl e
 165 Retry on error.
 166 If an error is returned in the response PDU, resend the request removing the
 167 variable that caused the error until a valid response is received.
 168 This is only usefull for a GetRequest- and a GetNextRequest-PDU.
 169 .It Fl h
 170 Print a short help text with default values for various options.
 171 .It Fl I Ar options
 172 Load each MIB description file from the given list to translate symbolic
 173 object names to their numerical representation and vice versa.
 174 Use the other options to obtain a non-default behaviour:
 175 .Bl -tag -width \&
 176 .It Cm cut=OID
 177 Specifies the initial OID that was cut by
 178 .Xr gensnmpdef 1
 179 when producing the MIB description file.
 180 The default value is .iso(1).org(3).dod(6) which is what should have been
 181 used for all the files installed under /usr/share/snmp/defs.
 182 Use this only if you generated your own files, providing a
 183 .Fl c
 184 option to
 185 .Xr gensnmpdef 1 .
 186 .It Cm path=filedir
 187 The directory where files in the list will be searched.
 188 The default is
 189 .Pa /usr/share/snmp/defs Ns .
 190 .It Cm file=filelist
 191 A comma separated list of files to which the two options above will apply.
 192 .El
 193 .Pp
 194 The file suboption has to come after the other suboptions so that their
 195 non-default values will be applied to the list of files.
 196 The order of the other suboptions before each file suboption can be random.
 197 Suboptions may be separated either by commas or by spaces.
 198 If using spaces make sure the entire option string is one argument, for
 199 example using quotes.
 200 .It Fl i Ar filelist
 201 List of MIB description files produced by
 202 .Xr gensnmpdef 1 which
 203 .Nm bsnmpget ,
 204 .Nm bsnmpwalk
 205 or
 206 .Nm bsnmpset
 207 will search to translate numerical OIDs to their symbolic object names.
 208 Multiple files can be provided either giving this option multiple times
 209 or a comma separated list of file names.
 210 If a filename begins with a letter the default directory,
 211 /usr/share/snmp/defs,
 212 will be searched.
 213 .It Fl K
 214 Calculate and display the localized authentication and privacy keys
 215 corresponding to a plain text password. The password is obtain via the
 216 environment. Additionally, if one or more OIDs are specified, the calculated
 217 keys are used when processing the SNMPv3 requests.
 218 .It Fl l Ar filename
 219 The path of the posix local (unix domain) socket if local
 220 transport is used.
 221 .It Fl M Ar max-repetitions
 222 The value for the max-repetitions field in a GetBulk PDU.
 223 Default is 1.
 224 .It Fl N Ar non-repeaters
 225 The value for the non-repeaters field in a GetBulk PDU.
 226 Default is 0.
 227 .It Fl n
 228 Only use numerical representations for input and output OIDs and do not
 229 try to resolve symbolic object names.
 230 Note that
 231 .Nm bsnmpget ,
 232 .Nm bsnmpwalk
 233 and
 234 .Nm bsnmpset
 235 will print numerical OIDs anyway if the corresponding string representation
 236 is not found in the MIB description files.
 237 .It Fl o Ar [quiet|short|verbose]
 238 The format used to print the received response.
 239 Quiet only prints values, short (default) prints an abbreviated OID
 240 representation and the value.
 241 In addition to the short output verbose prints the type before the value.
 242 .It Fl P Ar options
 243 Privacy options to use with SNMPv3 PDUs
 244 .Bl -tag -width \&
 245 .It Cm proto=[aes|des]
 246 The protocol to use when encypting/decrypting SNMPv3 PDU data.
 247 .It Cm key=privkey
 248 A binary localized privacy key to use when encypting/decrypting SNMPv3 PDU data.
 249 .El
 250 .Pp
 251 By default plain text SNMPv3 PDUs are sent.
 252 .It Fl p Ar [get|getnext|getbulk]
 253 The PDU type to send by
 254 .Nm bsmpget .
 255 Default is get.
 256 .It Fl r Ar retries
 257 Number of resends of request packets before giving up if the agent does
 258 not respond after the first try.
 259 Default is 3.
 260 .It Fl s Ar [trans::] Ns Ar [community@] Ns Ar [server] Ns Ar [:port]
 261 Each of the server specification components is optional but at least one
 262 has to be provided if
 263 .Ar s
 264 option is used.
 265 The server specification is constructed in the following manner:
 266 .Bl -tag -width \&
 267 .It Cm trans::
 268 Transport type may be one of udp, stream or dgram.
 269 If this option is not provided an udp inet/inet6 socket will be used, which
 270 is the most common.
 271 Stream stands for a posix local stream socket and a posix local datagram
 272 socket will be used if dgram is specified.
 273 .It Cm community@
 274 Specify an SNMP community string to be used when sending packets.
 275 If the option is skipped the default "public" will be used for
 276 .Nm
 277 and
 278 .Nm bsnmpwalk
 279 and the default "private" community string will be used for
 280 .Nm bsnmpset .
 281 .It Cm server
 282 This might be either the IP address or the hostname where the agent is
 283 listening.
 284 The default is
 285 .Qq localhost .
 286 .It Cm port
 287 The destination port to send the requests to.
 288 This is useful if the SNMP agent listens on a non-default port.
 289 Default is given by the
 290 .Qq snmp
 291 entry in
 292 .Pa /etc/services ,
 293 port 161.
 294 .El
 295 .It Fl t Ar timeout
 296 Number of seconds before resending a request packet if the agent does
 297 not respond.
 298 The default value is 3 seconds.
 299 .It Fl U Ar options
 300 User credentials when sending SNMPv3 PDUs.
 301 .Bl -tag -width \&
 302 .It Cm engine=id
 303 The Engine ID of the SNMP agent represented as a binary octet string.
 304 .It Cm engine-boots=value
 305 The value of the snmpEngineBoots of the SNMP agent.
 306 .It Cm engine-time=value
 307 The value of the snmpEngineTime of the SNMP agent.
 308 .Pp
 309 If any of the above is not specified, SNMP USM Engine Discovery is attempted.
 310 This is also the default behavior.
 311 .It Cm name=username
 312 The USM user name to include in the SNMPv3 PDUs. By default, the user name is
 313 obtain via the environment
 314 .El
 315 .It Fl v Ar version
 316 The SNMP protocol version to use when sending requests. SNMP versions 1, 2 and
 317 3 are supported.
 318 If no version option is provided
 319 .Nm bsnmpget ,
 320 .Nm bsnmpwalk
 321 and
 322 .Nm bsnmpset
 323 will use version 2.
 324 Note that GetBulkRequest-PDUs were introduced in SNMPv2 thus setting the
 325 version to 1 is incompatiable with sending a GetBulk PDU.
 326 .It OID
 327 The object identifier whose value to retrive.
 328 At least one OID should be provided for
 329 .Nm bsnmpget
 330 to be able to send a request.
 331 .Pp
 332 For
 333 .Nm bsnmpwalk
 334 this is the root object identifier of the subtree whose values are to be
 335 retrived.
 336 If no OID is provided
 337 .Nm bsnmpwalk
 338 will walk the mib2 subtree rooted
 339 at .iso(1).org(3).dod(6).internet(1).mgmt(2).mib2(1) .
 340 .Pp
 341 Any of the formats used to print a single variable
 342 is valid as input OID:
 343 .Bl -tag -width \&
 344 .It 1.3.6.1.2.1.25.1.1.0
 345 .It sysDescr
 346 .It ifPhysAddress.1
 347 .It ifRcvAddressStatus.2.6.255.255.255.255.255.255
 348 .It ifRcvAddressType[2,ff:ff:ff:ff:ff:ff]
 349 .It ifRcvAddressStatus[Integer:1,OctetString:ff:ff:ff:ff:ff:ff]
 350 (requires
 351 .Fl o Ar verbose
 352 option)
 353 .El
 354 .Pp
 355 Square brackets are used to denote an entry's indexes.
 356 When used in an input OID, the square brackets may have to be
 357 escaped or the OID has to be quoted to protect it from the shell.
 358 Note there is no difference between ifName.1 and "ifName[1]".
 359 .It OID Ns = Ns Ar [syntax Ns :] Ns Ar value
 360 The object identifier with its syntax type and value that is to be set.
 361 At least one such string OID=[syntax:]value should be provided to
 362 .Nm bsnmpset
 363 to be able to send a request.
 364 .Bl -tag -width \&
 365 .It Cm OID
 366 OID may be input as a string, a string followed by a random number of integers
 367 (suboids) separated by dots, a sequence of integers separated by dots - that is
 368 if
 369 .Ar n
 370 options is used - and in such case a syntax is required for every value,
 371 or a string followed by square brackets (used to denote an entry's indexes) and
 372 corresponding indexes.
 373 Any of formats used to print a single variable by
 374 .Nm bsnmpset is
 375 valid for inpit OID as well:
 376 .Bl -tag -width \&
 377 .It 1.3.6.1.2.1.25.1.1.0=TimeTicks:537615486
 378 .It sysLocation=OctetString:"@ Home" (with Fl o Ar verbose No option)
 379 .It sysLocation.0="@ Home"
 380 .It 1.3.6.1.2.1.2.2.1.6.1=OctetString:ffffffffffff
 381 .It ifPhysAddress.1="00:02:b3:1d:1c:a3"
 382 .It ifRcvAddressStatus.1.6.255.255.255.255.255.255=1
 383 .It "ifRcvAddressStatus[Integer:1,OctetString:ff:ff:ff:ff:ff:ff]=Integer:1"
 384 (with
 385 .Fl o Ar verbose
 386 option)
 387 .El
 388 .It Cm syntax
 389 where syntax string is one of:
 390 Integer, OctetString, OID, IpAddress, Counter32, Gauge, TimeTicks, Counter64.
 391 .It Cm value
 392 The value to be set - IP address in form of u.u.u.u - for example
 393 1.3.1.6.1.2.0=IpAddress:192.168.0.1, strings require inverted-commas if they
 394 contain any special characters or spaces, all other numeric types don't.
 395 .El
 396 .El
 397 .Sh ENVIRONMENT
 398 .Nm ,
 399 .Nm bsnmpwalk
 400 and
 401 .Nm bsnmpset
 402 use the following environment variables:
 403 .Bl -tag -width SNMPAUTH
 404 .It Ev SNMPAUTH
 405 Specifies a default SNMP USM authentication protocol.
 406 .It Ev SNMPPRIV
 407 Specifies a default SNMP USM privacy protocol.
 408 .It Ev SNMPUSER
 409 Specifies a default SNMP USM user name.
 410 .It Ev SNMPPASSWD
 411 Specifies the SNMP USM plain text password to use when calculating localized
 412 authentication and privacy keys. If this variable exists in the environment,
 413 SMNPv3 is the default version to use for outgoing requests.
 414 .El
 415 .Sh SEE ALSO
 416 .Xr gensnmpdef 1
 417 .Sh AUTHORS
 418 .An Shteryana Shopova Aq syrinx@FreeBSD.org