{ "content": [ { "type": "text", "text": "# snmpwalk (man)\n\n## NAME\n\nsnmpwalk - retrieve a subtree of management values using SNMP GETNEXT requests\n\n## SYNOPSIS\n\nsnmpwalk [APPLICATION OPTIONS] [COMMON OPTIONS] AGENT [OID]\n\n## DESCRIPTION\n\nsnmpwalk is an SNMP application that uses SNMP GETNEXT requests to query a network entity for\na tree of information.\n\n## TLDR\n\n> SNMP query tool.\n\n- Query the system information of a remote host using SNMPv1 and a community string:\n `snmpwalk -v 1 -c {{community}} {{ip_address}}`\n- Query system information on a remote host by OID using SNMPv2 on a specified port:\n `snmpwalk -v 2c -c {{community}} {{ip_address}}:{{port}} {{oid}}`\n- Query system information on a remote host by OID using SNMPv3 and authentication without encryption:\n `snmpwalk -v 3 -l {{authNoPriv}} -u {{username}} -a {{MD5|SHA}} -A {{passphrase}} {{ip_address}} {{oid}}`\n- Query system information on a remote host by OID using SNMPv3, authentication, and encryption:\n `snmpwalk -v 3 -l {{authPriv}} -u {{username}} -a {{MD5|SHA}} -A {{auth_passphrase}} -x {{DES|AES}} -X {{enc_passphrase}} {{ip_address}} {{oid}}`\n- Query system information on a remote host by OID using SNMPv3 without authentication or encryption:\n `snmpwalk -v 3 -l {{noAuthNoPriv}} -u {{username}} {{ip_address}} {{oid}}`\n- Display help:\n `snmpwalk {{-h|--help}}`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (6 subsections)\n- **EXAMPLES**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "snmpwalk", "section": "", "mode": "man", "summary": "snmpwalk - retrieve a subtree of management values using SNMP GETNEXT requests", "synopsis": "snmpwalk [APPLICATION OPTIONS] [COMMON OPTIONS] AGENT [OID]", "tldr_summary": "SNMP query tool.", "tldr_examples": [ { "description": "Query the system information of a remote host using SNMPv1 and a community string", "command": "snmpwalk -v 1 -c {{community}} {{ip_address}}" }, { "description": "Query system information on a remote host by OID using SNMPv2 on a specified port", "command": "snmpwalk -v 2c -c {{community}} {{ip_address}}:{{port}} {{oid}}" }, { "description": "Query system information on a remote host by OID using SNMPv3 and authentication without encryption", "command": "snmpwalk -v 3 -l {{authNoPriv}} -u {{username}} -a {{MD5|SHA}} -A {{passphrase}} {{ip_address}} {{oid}}" }, { "description": "Query system information on a remote host by OID using SNMPv3, authentication, and encryption", "command": "snmpwalk -v 3 -l {{authPriv}} -u {{username}} -a {{MD5|SHA}} -A {{auth_passphrase}} -x {{DES|AES}} -X {{enc_passphrase}} {{ip_address}} {{oid}}" }, { "description": "Query system information on a remote host by OID using SNMPv3 without authentication or encryption", "command": "snmpwalk -v 3 -l {{noAuthNoPriv}} -u {{username}} {{ip_address}} {{oid}}" }, { "description": "Display help", "command": "snmpwalk {{-h|--help}}" } ], "tldr_source": "official", "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 snmpwalk to loop indefinitely. By default, snmpwalk tries to detect this behavior and warns you when it hits an agent acting illegally. Use -Cc to turn off this check." }, { "flag": "", "long": null, "arg": null, "description": "End the walk at the specified OID, rather than a simple subtree. This can be used to walk a partial subtree, selected columns of a table, or even two or more tables within a single command." }, { "flag": "", "long": null, "arg": null, "description": "starting with the OID you specified and returns all results in the MIB subtree rooted at 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 explicitly." }, { "flag": "", "long": null, "arg": null, "description": "turns no useable values. This allows a walk of a single instance to behave as gener‐ ally expected, and return the specified instance value. This option turns off this final GET request, so a walk of a single instance will return nothing." }, { "flag": "", "long": null, "arg": null, "description": "" }, { "flag": "", "long": null, "arg": null, "description": "data (in seconds). Note that the timer is started just before the beginning of the data request series and stopped just after it finishes. Most importantly, this means that it does not include snmp library initialization, shutdown, argument processing, and any other overhead. In addition to these options, snmpwalk takes the common options described in the snmpcmd(1) manual page." } ], "examples": [ "Note that snmpwalk REQUIRES an argument specifying the agent to query and at most one OID", "argument, as described there. The command:", "snmpwalk -Os -c public -v 1 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", "(plus the contents of the sysORTable).", "The command:", "snmpwalk -Os -c public -v 1 -CE sysORTable zeus system", "will retrieve the scalar values, but omit the sysORTable." ], "see_also": [ { "name": "snmpcmd", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/snmpcmd/1/json" }, { "name": "snmpbulkwalk", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/snmpbulkwalk/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": 17, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-Cc", "lines": 5 }, { "name": "-CE {OID}", "lines": 4 }, { "name": "-Ci", "lines": 5 }, { "name": "-CI", "lines": 4 }, { "name": "-Cp", "lines": 1 }, { "name": "-Ct", "lines": 8 } ] }, { "name": "EXAMPLES", "lines": 22, "subsections": [] }, { "name": "SEE ALSO", "lines": 3, "subsections": [] } ], "sections": { "NAME": { "content": "snmpwalk - retrieve a subtree of management values using SNMP GETNEXT requests\n", "subsections": [] }, "SYNOPSIS": { "content": "snmpwalk [APPLICATION OPTIONS] [COMMON OPTIONS] AGENT [OID]\n", "subsections": [] }, "DESCRIPTION": { "content": "snmpwalk is an SNMP application that uses SNMP GETNEXT requests to query a network entity for\na 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 GETNEXT 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).\n\nIf no OID argument is present, snmpwalk will search the subtree rooted at SNMPv2-SMI::mib-2\n(including any MIB object values from other MIB modules, that are defined as lying within\nthis subtree). If the network entity has an error processing the request packet, an error\npacket will be returned and a message will be shown, helping to pinpoint why the request was\nmalformed.\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 snmpwalk to loop indefinitely. By\ndefault, snmpwalk tries to detect this behavior and warns you when it hits an agent\nacting illegally. Use -Cc to turn off this check.\n" }, { "name": "-CE {OID}", "content": "End the walk at the specified OID, rather than a simple subtree. This can be used to\nwalk a partial subtree, selected columns of a table, or even two or more tables\nwithin a single command.\n" }, { "name": "-Ci", "content": "starting with the OID you specified and returns all results in the MIB subtree rooted\nat 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 explicitly.\n" }, { "name": "-CI", "content": "turns no useable values. This allows a walk of a single instance to behave as gener‐\nally expected, and return the specified instance value. This option turns off this\nfinal GET request, so a walk of a single instance will return nothing.\n" }, { "name": "-Cp", "content": "" }, { "name": "-Ct", "content": "data (in seconds). Note that the timer is started just before the beginning of the\ndata request series and stopped just after it finishes. Most importantly, this means\nthat it does not include snmp library initialization, shutdown, argument processing,\nand any other overhead.\n\nIn addition to these options, snmpwalk takes the common options described in the snmpcmd(1)\nmanual page.\n" } ] }, "EXAMPLES": { "content": "Note that snmpwalk REQUIRES an argument specifying the agent to query and at most one OID\nargument, as described there. The command:\n\nsnmpwalk -Os -c public -v 1 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(plus the contents of the sysORTable).\n\nThe command:\n\nsnmpwalk -Os -c public -v 1 -CE sysORTable zeus system\n\nwill retrieve the scalar values, but omit the sysORTable.\n", "subsections": [] }, "SEE ALSO": { "content": "snmpcmd(1), snmpbulkwalk(1), variables(5).\n\nV5.9.4.pre2 28 May 2007 SNMPWALK(1)", "subsections": [] } } } }