{
    "content": [
        {
            "type": "text",
            "text": "# snmpbulkget (man)\n\n## NAME\n\nsnmpbulkget - communicates with a network entity using SNMP GETBULK requests.\n\n## SYNOPSIS\n\nsnmpbulkget [COMMON OPTIONS] [-Cn <num>] [-Cr <NUM>] AGENT OID [OID]...\n\n## DESCRIPTION\n\nsnmpbulkget  is an SNMP application that uses the SNMP GETBULK request to query a network en‐\ntity efficiently for information.  One or more object identifiers (OIDs) may be given as  ar‐\nguments  on  the  command line.  Each variable name is given in the format specified in vari‐\nables(5).\n\n## TLDR\n\n> Query the next value in the MIB tree and all of its adjacent values.\n\n- Request the next value from the SNMP agent:\n  `snmpbulkget -v {{version}} -c {{community}} {{ip_address}} {{oid}}`\n- Display the full Object Identifier (OID) path:\n  `snmpbulkget -v {{version}} -c {{community}} -O f {{ip_address}} {{oid}}`\n- Display help:\n  `snmpbulkget {{-h|--help}}`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (2 subsections)\n- **EXAMPLE**\n- **NOTE**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "snmpbulkget",
        "section": "",
        "mode": "man",
        "summary": "snmpbulkget - communicates with a network entity using SNMP GETBULK requests.",
        "synopsis": "snmpbulkget [COMMON OPTIONS] [-Cn <num>] [-Cr <NUM>] AGENT OID [OID]...",
        "tldr_summary": "Query the next value in the MIB tree and all of its adjacent values.",
        "tldr_examples": [
            {
                "description": "Request the next value from the SNMP agent",
                "command": "snmpbulkget -v {{version}} -c {{community}} {{ip_address}} {{oid}}"
            },
            {
                "description": "Display the full Object Identifier (OID) path",
                "command": "snmpbulkget -v {{version}} -c {{community}} -O f {{ip_address}} {{oid}}"
            },
            {
                "description": "Display help",
                "command": "snmpbulkget {{-h|--help}}"
            }
        ],
        "tldr_source": "official",
        "flags": [
            {
                "flag": "",
                "long": null,
                "arg": null,
                "description": "Set the non-repeaters field in the GETBULK PDU. This specifies the number of sup‐ plied variables that should not be iterated over. The default is 0."
            },
            {
                "flag": "",
                "long": null,
                "arg": null,
                "description": "Set the max-repetitions field in the GETBULK PDU. This specifies the maximum number of iterations over the repeating variables. The default is 10. In addition to these options, snmpbulkget takes the common options described in the snm‐ pcmd(1) manual page. Note that snmpbulkget REQUIRES an argument specifying the agent to query and at least one OID argument, as described there."
            }
        ],
        "examples": [
            "The command:",
            "snmpbulkget -v2c -Cn1 -Cr5 -Os -c public zeus system ifTable",
            "will retrieve the variable system.sysDescr.0 (which is the lexicographically next  object  to",
            "system) and the first 5 objects in the ifTable:",
            "sysDescr.0 = STRING: \"SunOS zeus.net.cmu.edu 4.1.3U1 1 sun4m\"",
            "ifIndex.1 = INTEGER: 1",
            "ifIndex.2 = INTEGER: 2",
            "ifDescr.1 = STRING: \"lo0\"",
            "et cetera."
        ],
        "see_also": [
            {
                "name": "snmpcmd",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/snmpcmd/1/json"
            },
            {
                "name": "variables",
                "section": "5",
                "url": "https://www.chedong.com/phpMan.php/man/variables/5/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 8,
                "subsections": []
            },
            {
                "name": "OPTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "-Cn_",
                        "lines": 3
                    },
                    {
                        "name": "-Cr_",
                        "lines": 7
                    }
                ]
            },
            {
                "name": "EXAMPLE",
                "lines": 13,
                "subsections": []
            },
            {
                "name": "NOTE",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 3,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "snmpbulkget - communicates with a network entity using SNMP GETBULK requests.\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "snmpbulkget [COMMON OPTIONS] [-Cn <num>] [-Cr <NUM>] AGENT OID [OID]...\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "snmpbulkget  is an SNMP application that uses the SNMP GETBULK request to query a network en‐\ntity efficiently for information.  One or more object identifiers (OIDs) may be given as  ar‐\nguments  on  the  command line.  Each variable name is given in the format specified in vari‐\nables(5).\n\nIf the network entity has an error processing the request packet, an error packet will be re‐\nturned and a message will be shown, helping to pinpoint why the request was malformed.\n",
                "subsections": []
            },
            "OPTIONS": {
                "content": "",
                "subsections": [
                    {
                        "name": "-Cn_",
                        "content": "Set the non-repeaters field in the GETBULK PDU.  This specifies the  number  of  sup‐\nplied variables that should not be iterated over.  The default is 0.\n"
                    },
                    {
                        "name": "-Cr_",
                        "content": "Set  the max-repetitions field in the GETBULK PDU.  This specifies the maximum number\nof iterations over the repeating variables.  The default is 10.\n\nIn addition to these options, snmpbulkget takes the common  options  described  in  the  snm‐\npcmd(1)  manual  page.   Note  that snmpbulkget REQUIRES  an argument specifying the agent to\nquery and at least one OID argument, as described there.\n"
                    }
                ]
            },
            "EXAMPLE": {
                "content": "The command:\n\nsnmpbulkget -v2c -Cn1 -Cr5 -Os -c public zeus system ifTable\n\nwill retrieve the variable system.sysDescr.0 (which is the lexicographically next  object  to\nsystem) and the first 5 objects in the ifTable:\n\nsysDescr.0 = STRING: \"SunOS zeus.net.cmu.edu 4.1.3U1 1 sun4m\"\nifIndex.1 = INTEGER: 1\nifIndex.2 = INTEGER: 2\nifDescr.1 = STRING: \"lo0\"\net cetera.\n",
                "subsections": []
            },
            "NOTE": {
                "content": "As the name implies, snmpbulkget utilizes the SNMP GETBULK message, which is not available in\nSNMPv1.\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "snmpcmd(1), variables(5), RFC 1905.\n\nV5.9.4.pre2                                  01 May 2002                              SNMPBULKGET(1)",
                "subsections": []
            }
        }
    }
}