{
    "content": [
        {
            "type": "text",
            "text": "# snmpdf (man)\n\n## NAME\n\nsnmpdf - display disk space usage on a network entity via SNMP\n\n## SYNOPSIS\n\nsnmpdf [COMMON OPTIONS] [-Cu] [-Ch] AGENT\n\n## DESCRIPTION\n\nsnmpdf  is simply a networked version of the typical df command.  It checks the disk space on\nthe remote machine by examining the HOST-RESOURCES-MIB's hrStorageTable or the UCD-SNMP-MIB's\ndskTable.  By default, the hrStorageTable is preferred as it typically contains more informa‐\ntion.  However, the -Cu argument can be passed to snmpdf to force the usage of the dskTable.\n\n## TLDR\n\n> Fetch disk space usage information.\n\n- Fetch the disk space usage:\n  `snmpdf -v {{version}} -c {{community}} {{ip_address}}`\n- Display help:\n  `snmpdf {{-h|--help}}`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (3 subsections)\n- **EXAMPLES**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "snmpdf",
        "section": "",
        "mode": "man",
        "summary": "snmpdf - display disk space usage on a network entity via SNMP",
        "synopsis": "snmpdf [COMMON OPTIONS] [-Cu] [-Ch] AGENT",
        "tldr_summary": "Fetch disk space usage information.",
        "tldr_examples": [
            {
                "description": "Fetch the disk space usage",
                "command": "snmpdf -v {{version}} -c {{community}} {{ip_address}}"
            },
            {
                "description": "Display help",
                "command": "snmpdf {{-h|--help}}"
            }
        ],
        "tldr_source": "official",
        "flags": [
            {
                "flag": "",
                "long": null,
                "arg": null,
                "description": "termine the storage information. Generally, the default use of hrStorageTable in mib HOST-RESOURCES-MIB is preferred because it typically contains more information."
            },
            {
                "flag": "",
                "long": null,
                "arg": null,
                "description": ""
            },
            {
                "flag": "",
                "long": null,
                "arg": null,
                "description": ""
            }
        ],
        "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%"
        ],
        "see_also": [
            {
                "name": "snmpd.conf",
                "section": "5",
                "url": "https://www.chedong.com/phpMan.php/man/snmpd.conf/5/json"
            },
            {
                "name": "snmp.conf",
                "section": "5",
                "url": "https://www.chedong.com/phpMan.php/man/snmp.conf/5/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 14,
                "subsections": []
            },
            {
                "name": "OPTIONS",
                "lines": 4,
                "subsections": [
                    {
                        "name": "-Cu",
                        "lines": 3
                    },
                    {
                        "name": "-Ch",
                        "lines": 1
                    },
                    {
                        "name": "-CH",
                        "lines": 1
                    }
                ]
            },
            {
                "name": "EXAMPLES",
                "lines": 13,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 5,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "snmpdf - display disk space usage on a network entity via SNMP\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "snmpdf [COMMON OPTIONS] [-Cu] [-Ch] AGENT\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "snmpdf  is simply a networked version of the typical df command.  It checks the disk space on\nthe remote machine by examining the HOST-RESOURCES-MIB's hrStorageTable or the UCD-SNMP-MIB's\ndskTable.  By default, the hrStorageTable is preferred as it typically contains more informa‐\ntion.  However, the -Cu argument can be passed to snmpdf to force the usage of the dskTable.\n\nAGENT identifies a target SNMP agent, which is instrumented to monitor the given objects.  At\nits simplest, the AGENT specification will consist of a hostname or an IPv4 address.  In this\nsituation, the command will attempt communication with the agent, using UDP/IPv4 to port  161\nof the given target host. See the snmpcmd(1) manual page for a full list of the possible for‐\nmats for AGENT.\n\nSee the snmpd.conf(5) manual page on setting up the dskTable using the disk directive in  the\nsnmpd.conf file.\n",
                "subsections": []
            },
            "OPTIONS": {
                "content": "COMMON OPTIONS\nPlease  see  snmpcmd(1)  for  a list of possible values for COMMON OPTIONS as well as\ntheir descriptions.\n",
                "subsections": [
                    {
                        "name": "-Cu",
                        "content": "termine  the storage information. Generally, the default use of hrStorageTable in mib\nHOST-RESOURCES-MIB is preferred because it typically contains more information.\n"
                    },
                    {
                        "name": "-Ch",
                        "content": ""
                    },
                    {
                        "name": "-CH",
                        "content": ""
                    }
                ]
            },
            "EXAMPLES": {
                "content": "% snmpdf -v 2c -c public localhost\n\nDescription       size (kB)         Used    Available Used%\n/                   7524587      2186910      5337677   29%\n/proc                     0            0            0    0%\n/etc/mnttab               0            0            0    0%\n/var/run            1223088           32      1223056    0%\n/tmp                1289904        66848      1223056    5%\n/cache               124330         2416       121914    1%\n/vol                      0            0            0    0%\nReal Memory          524288       447456        76832   85%\nSwap Space          1420296       195192      1225104   13%\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "snmpd.conf(5), snmp.conf(5)\n\n\n\nV5.9.1                                       28 Jan 2013                                   SNMPDF(1)",
                "subsections": []
            }
        }
    }
}