user/net-snmp/man/snmpdf.1.def

   1 .\" Portions of this file are subject to the following copyright.  See
   2 .\" the Net-SNMP's COPYING file for more details and other copyrights
   3 .\" that may apply:
   4 .\" /***********************************************************
   5 .\" Portions of this file are copyrighted by:
   6 .\" Copyright Copyright 2003 Sun Microsystems, Inc. All rights reserved.
   7 .\" Use is subject to license terms specified in the COPYING file
   8 .\" distributed with the Net-SNMP package.
   9 .\" ******************************************************************/
  10 .TH SNMPDF 1 "25 Jul 2003" VVERSIONINFO "Net-SNMP"
  11 .UC 4
  12 .SH NAME
  13 snmpdf - display disk space usage on a network entity via SNMP
  14 .SH SYNOPSIS
  15 .B snmpdf
  16 [COMMON OPTIONS] [-Cu] AGENT
  17 .SH DESCRIPTION
  18 .B snmpdf
  19 is simply a networked verison of the typical df command.  It
  20 checks the disk space on the remote machine by examining the
  21 HOST-RESOURCES-MIB's hrStorageTable or the UCD-SNMP-MIB's dskTable.
  22 By default, the hrStorageTable is preferred as it typically contains
  23 more information.  However, the -Cu argument can be passed to snmpdf
  24 to force the usage of the dskTable.
  25 .PP
  26 AGENT identifies a target SNMP agent, which is instrumented
  27 to monitor the gievn objects.  At its simplest, the AGENT
  28 specification will consist of a hostname or an IPv4
  29 address.  In this situation, the command will attempt
  30 communication with the agent, using UDP/IPv4 to port 161
  31 of the given target host. See the
  32 .I snmpcmd(1)
  33 manual page for a full list of the possible formats for AGENT.
  34 .PP
  35 See the
  36 .I snmpd.conf(5)
  37 manual page on setting up the dskTable using the
  38 .I disk
  39 directive in the snmpd.conf file.
  40 .SH "OPTIONS"
  41 .TP 8
  42 .B COMMON OPTIONS
  43 Please see
  44 .I snmpcmd(1)
  45 for a list of possible values for COMMON OPTIONS
  46 as well as their descriptions.
  47 .TP
  48 .B -Cu
  49 Forces the command to use dskTable in mib
  50 UCD-SNMP-MIB instead of the default to determine
  51 the storage information. Generally, the default
  52 use of hrStorageTable in mib HOST-RESOURCES-MIB
  53 is preferred because it typically contains
  54 more information.
  55 .SH "EXAMPLES"
  56 .PP
  57 % snmpdf -v 2c -c public localhost
  58 .PP
  59 .nf
  60 Description       size (kB)         Used    Available Used%
  61 /                   7524587      2186910      5337677   29%
  62 /proc                     0            0            0    0%
  63 /etc/mnttab               0            0            0    0%
  64 /var/run            1223088           32      1223056    0%
  65 /tmp                1289904        66848      1223056    5%
  66 /cache               124330         2416       121914    1%
  67 /vol                      0            0            0    0%
  68 Real Memory          524288       447456        76832   85%
  69 Swap Space          1420296       195192      1225104   13%
  70 .fi
  71 .SH "SEE ALSO"
  72 snmpd.conf(5), snmp.conf(5)