Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

snmpdf (1)

Name

snmpdf - display disk space usage on a network entity via SNMP

Synopsis

snmpdf [COMMON OPTIONS] [-Cu] [-Ch] AGENT

Description

SNMPDF(1)                          Net-SNMP                          SNMPDF(1)



NAME
       snmpdf - display disk space usage on a network entity via SNMP

SYNOPSIS
       snmpdf [COMMON OPTIONS] [-Cu] [-Ch] AGENT

DESCRIPTION
       snmpdf  is  simply  a  networked version of the typical df command.  It
       checks  the  disk  space  on  the  remote  machine  by  examining   the
       HOST-RESOURCES-MIB's hrStorageTable or the UCD-SNMP-MIB's dskTable.  By
       default, the hrStorageTable is preferred as it typically contains  more
       information.   However,  the  -Cu  argument  can be passed to snmpdf to
       force the usage of the dskTable.

       AGENT identifies a target SNMP agent, which is instrumented to  monitor
       the  given objects.  At its simplest, the AGENT specification will con-
       sist 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 the snmpcmd(1) manual  page  for  a  full
       list of the possible formats for AGENT.

       See  the snmpd.conf(5) manual page on setting up the dskTable using the
       disk directive in the snmpd.conf file.

OPTIONS
       COMMON OPTIONS
               Please see snmpcmd(1) for a list of possible values for  COMMON
               OPTIONS as well as their descriptions.

       -Cu     Forces  the command to use dskTable in mib UCD-SNMP-MIB instead
               of the default to determine the storage information. Generally,
               the  default use of hrStorageTable in mib HOST-RESOURCES-MIB is
               preferred because it typically contains more information.

       -Ch     Print sizes in human readable format (i.e. MiB, GiB, TiB)

       -CH     Print sizes in human readable SI format (i.e. MB, GB, TB)

EXAMPLES
       % snmpdf -v 2c -c public localhost

       Description       size (kB)         Used    Available Used%
       /                   7524587      2186910      5337677   29%
       /proc                     0            0            0    0%
       /etc/mnttab               0            0            0    0%
       /var/run            1223088           32      1223056    0%
       /tmp                1289904        66848      1223056    5%
       /cache               124330         2416       121914    1%
       /vol                      0            0            0    0%
       Real Memory          524288       447456        76832   85%
       Swap Space          1420296       195192      1225104   13%


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+---------------------------------+
       |ATTRIBUTE TYPE |        ATTRIBUTE VALUE          |
       +---------------+---------------------------------+
       |Availability   | system/management/snmp/net-snmp |
       +---------------+---------------------------------+
       |Stability      | Volatile                        |
       +---------------+---------------------------------+

SEE ALSO
       snmpd.conf(5), snmp.conf(5)



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source  was  downloaded   from    https://sourceforge.net/projects/net-
       snmp/files/net-snmp/5.8/net-snmp-5.8.tar.gz.

       Further information about this software can be found on the open source
       community website at http://www.net-snmp.org/.



V5.8                              28 Jan 2013                        SNMPDF(1)