{ "content": [ { "type": "text", "text": "# SNMPBULKWALK (man)\n\n## NAME\n\nsnmpbulkwalk - retrieve a subtree of management values using SNMP GETBULK requests\n\n## SYNOPSIS\n\nsnmpbulkwalk [APPLICATION OPTIONS] [COMMON OPTIONS] AGENT [OID]\n\n## DESCRIPTION\n\nsnmpbulkwalk is an SNMP application that uses SNMP GETBULK requests to query a network entity\nefficiently for a tree of information.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (5 subsections)\n- **EXAMPLE**\n- **NOTE**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "SNMPBULKWALK", "section": "", "mode": "man", "summary": "snmpbulkwalk - retrieve a subtree of management values using SNMP GETBULK requests", "synopsis": "snmpbulkwalk [APPLICATION OPTIONS] [COMMON OPTIONS] AGENT [OID]", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "", "long": null, "arg": null, "description": "example) return OIDs out of order, but can complete the walk anyway. Other agents return OIDs that are out of order and can cause snmpbulkwalk to loop indefinitely. By default, snmpbulkwalk tries to detect this behavior and warns you when it hits an agent acting illegally. Use -Cc to turn off this behaviour." }, { "flag": "", "long": null, "arg": null, "description": "quests starting with the OID you specified and returns all results in the MIB tree after that OID. Sometimes, you may wish to include the OID specified on the command line in the printed results if it is a valid OID in the tree itself. This option lets you do this." }, { "flag": "", "long": null, "arg": null, "description": "Set the non-repeaters field in the GETBULK PDUs. This specifies the number of sup‐ plied variables that should not be iterated over. The default is 0." }, { "flag": "", "long": null, "arg": null, "description": "" }, { "flag": "", "long": null, "arg": null, "description": "Set the max-repetitions field in the GETBULK PDUs. This specifies the maximum number of iterations over the repeating variables. The default is 10. In addition to these options, snmpbulkwalk 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 most one OID argument, as described above." } ], "examples": [ "The command:", "snmpbulkwalk -v2c -Os -c public zeus system", "will retrieve all of the variables under system:", "sysDescr.0 = STRING: \"SunOS zeus.net.cmu.edu 4.1.3U1 1 sun4m\"", "sysObjectID.0 = OID: enterprises.hp.nm.hpsystem.10.1.1", "sysUpTime.0 = Timeticks: (155274552) 17 days, 23:19:05", "sysContact.0 = STRING: \"\"", "sysName.0 = STRING: \"zeus.net.cmu.edu\"", "sysLocation.0 = STRING: \"\"", "sysServices.0 = INTEGER: 72", "In contrast to snmpwalk, this information will typically be gathered in a single transaction", "with the agent, rather than one transaction per variable found. snmpbulkwalk is thus more", "efficient in terms of network utilisation, which may be especially important when retrieving", "large tables." ], "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": 15, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-Cc", "lines": 5 }, { "name": "-Ci", "lines": 5 }, { "name": "-Cn_", "lines": 3 }, { "name": "-Cp", "lines": 1 }, { "name": "-Cr_", "lines": 7 } ] }, { "name": "EXAMPLE", "lines": 19, "subsections": [] }, { "name": "NOTE", "lines": 3, "subsections": [] }, { "name": "SEE ALSO", "lines": 3, "subsections": [] } ], "sections": { "NAME": { "content": "snmpbulkwalk - retrieve a subtree of management values using SNMP GETBULK requests\n", "subsections": [] }, "SYNOPSIS": { "content": "snmpbulkwalk [APPLICATION OPTIONS] [COMMON OPTIONS] AGENT [OID]\n", "subsections": [] }, "DESCRIPTION": { "content": "snmpbulkwalk is an SNMP application that uses SNMP GETBULK requests to query a network entity\nefficiently for a tree of information.\n\nAn object identifier (OID) may be given on the command line. This OID specifies which por‐\ntion of the object identifier space will be searched using GETBULK requests. All variables\nin the subtree below the given OID are queried and their values presented to the user. Each\nvariable name is given in the format specified in variables(5). If no OID argument is\npresent, snmpbulkwalk will search MIB-2.\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\nIf the tree search causes attempts to search beyond the end of the MIB, the message \"End of\nMIB\" will be displayed.\n", "subsections": [] }, "OPTIONS": { "content": "", "subsections": [ { "name": "-Cc", "content": "example) return OIDs out of order, but can complete the walk anyway. Other agents\nreturn OIDs that are out of order and can cause snmpbulkwalk to loop indefinitely.\nBy default, snmpbulkwalk tries to detect this behavior and warns you when it hits an\nagent acting illegally. Use -Cc to turn off this behaviour.\n" }, { "name": "-Ci", "content": "quests starting with the OID you specified and returns all results in the MIB tree\nafter that OID. Sometimes, you may wish to include the OID specified on the command\nline in the printed results if it is a valid OID in the tree itself. This option\nlets you do this.\n" }, { "name": "-Cn_", "content": "Set the non-repeaters field in the GETBULK PDUs. This specifies the number of sup‐\nplied variables that should not be iterated over. The default is 0.\n" }, { "name": "-Cp", "content": "" }, { "name": "-Cr_", "content": "Set the max-repetitions field in the GETBULK PDUs. This specifies the maximum number\nof iterations over the repeating variables. The default is 10.\n\nIn addition to these options, snmpbulkwalk 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 most one OID argument, as described above.\n" } ] }, "EXAMPLE": { "content": "The command:\n\nsnmpbulkwalk -v2c -Os -c public zeus system\n\nwill retrieve all of the variables under system:\n\nsysDescr.0 = STRING: \"SunOS zeus.net.cmu.edu 4.1.3U1 1 sun4m\"\nsysObjectID.0 = OID: enterprises.hp.nm.hpsystem.10.1.1\nsysUpTime.0 = Timeticks: (155274552) 17 days, 23:19:05\nsysContact.0 = STRING: \"\"\nsysName.0 = STRING: \"zeus.net.cmu.edu\"\nsysLocation.0 = STRING: \"\"\nsysServices.0 = INTEGER: 72\n\nIn contrast to snmpwalk, this information will typically be gathered in a single transaction\nwith the agent, rather than one transaction per variable found. snmpbulkwalk is thus more\nefficient in terms of network utilisation, which may be especially important when retrieving\nlarge tables.\n", "subsections": [] }, "NOTE": { "content": "As the name implies, snmpbulkwalk utilizes the SNMP GETBULK message, which is not available\nin SNMP v1.\n", "subsections": [] }, "SEE ALSO": { "content": "snmpcmd(1), variables(5).\n\nV5.9.4.pre2 01 May 2002 SNMPBULKWALK(1)", "subsections": [] } } } }