{ "mode": "man", "parameter": "snmpnetstat", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/snmpnetstat/1/json", "generated": "2026-06-10T16:22:20Z", "synopsis": "snmpnetstat [COMMON OPTIONS] [-Ca] [-Cn] [-Cv] [-Cf addressfamily] AGENT\nsnmpnetstat [COMMON OPTIONS] [-Cr] [-Cn] [-Cv] [-Cf addressfamily] AGENT\nsnmpnetstat [COMMON OPTIONS] [-Ci] [-C o | b | d] [-Cn] [-Cv] [-CI interface] [-Cw interval]\nAGENT\nsnmpnetstat [COMMON OPTIONS] [-Cs[s]] [-Cp protocol] AGENT", "sections": { "NAME": { "content": "snmpnetstat - display networking status and configuration information from a network entity\nvia SNMP\n", "subsections": [] }, "SYNOPSIS": { "content": "snmpnetstat [COMMON OPTIONS] [-Ca] [-Cn] [-Cv] [-Cf addressfamily] AGENT\nsnmpnetstat [COMMON OPTIONS] [-Cr] [-Cn] [-Cv] [-Cf addressfamily] AGENT\nsnmpnetstat [COMMON OPTIONS] [-Ci] [-C o | b | d] [-Cn] [-Cv] [-CI interface] [-Cw interval]\nAGENT\nsnmpnetstat [COMMON OPTIONS] [-Cs[s]] [-Cp protocol] AGENT\n", "subsections": [] }, "DESCRIPTION": { "content": "The snmpnetstat command symbolically displays the values of various network-related informa‐\ntion retrieved from a remote system using the SNMP protocol. There are a number of output\nformats, depending on the options for the information presented. The first form of the com‐\nmand displays a list of active sockets. The second form presents the values of other net‐\nwork-related information according to the option selected. Using the third form, with an in‐\nterval specified, snmpnetstat will continuously display the information regarding packet\ntraffic on the configured network interfaces. The fourth form displays statistics about the\nnamed protocol.\n\nsnmpnetstat will issue GETBULK requests to query for information if at least protocol version\nv2 is used.\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 snmpcmd(1) for a full list of the possible formats for AGENT.\n", "subsections": [] }, "OPTIONS": { "content": "The options have the following meaning:\n\nCOMMON OPTIONS\nPlease see snmpcmd(1) for a list of possible values for common options as well as their de‐\nscriptions.\n", "subsections": [ { "name": "-CL", "content": "will automatically fall back to the legacy tables if the modern ones are not available.\n" }, { "name": "-Ca", "content": "processes are not shown.\n" }, { "name": "-Cf", "content": "" }, { "name": "-Ci", "content": "of cumulative statistics regarding packets transferred, errors, and collisions. The network\naddresses of the interface and the maximum transmission unit (``mtu'') are also displayed.\n" }, { "name": "-Cd", "content": "" }, { "name": "-Cb", "content": "" }, { "name": "-Co", "content": "when enquiring virtual interfaces (such as Frame-Relay circuits) on a router.\n" }, { "name": "-CI", "content": "below.\n" }, { "name": "-Cn", "content": "to display them symbolically). This option may be used with any of the display formats.\n" }, { "name": "-Cv", "content": "with any of the display formats.\n" }, { "name": "-Cp", "content": "or an alias for it. Some protocol names and aliases are listed in the file /etc/protocols.\nA null response typically means that there are no interesting numbers to report. The program\nwill complain if protocol is unknown or if there is no statistics routine for it.\n" }, { "name": "-Cs", "content": "zero will be suppressed.\n" }, { "name": "-Cr", "content": "" }, { "name": "-CR", "content": "When snmpnetstat is invoked with an interval argument, it displays a running count of statis‐\ntics related to network interfaces. interval is the number of seconds between reporting of\nstatistics.\n\nThe Active Sockets Display (default)\n\nThe default display, for active sockets, shows the local and remote addresses, protocol, and\nthe internal state of the protocol. Address formats are of the form ``host.port'' or ``net‐\nwork.port'' if a socket's address specifies a network but no specific host address. When\nknown, the host and network addresses are displayed symbolically according to the databases\n/etc/hosts and /etc/networks, respectively. If a symbolic name for an address is unknown, or\nif the -Cn option is specified, the address is printed numerically, according to the address\nfamily. For more information regarding the Internet ``dot format,'' refer to inet(3N). Un‐\nspecified, or ``wildcard'', addresses and ports appear as ``*''.\n\nThe Interface Display\n\nThe interface display provides a table of cumulative statistics regarding packets trans‐\nferred, errors, and col- lisions. The network addresses of the interface and the maximum\ntransmission unit (``mtu'') are also displayed.\n\nThe Routing Table Display\n\nThe routing table display indicates the available routes and their status. Each route con‐\nsists of a destination host or network and a gateway to use in forwarding pack- ets. The\nflags field shows the state of the route (``U'' if ``up''), whether the route is to a gateway\n(``G''), whether the route was created dynamically by a redirect (``D''), and whether the\nroute has been modified by a redirect (``M''). Direct routes are created for each interface\nattached to the local host; the gateway field for such entries shows the address of the out‐\ngoing inter- face. The interface entry indicates the network interface utilized for the\nroute.\n\nThe Interface Display with an Interval\n\nWhen snmpnetstat is invoked with an interval argument, it displays a running count of statis‐\ntics related to network interfaces. This display consists of a column for the primary inter‐\nface and a column summarizing information for all interfaces. The primary interface may be\nreplaced with another interface with the -CI option. The first line of each screen of infor‐\nmation contains a summary since the system was last rebooted. Subsequent lines of output\nshow values accumulated over the preceding interval.\n\nThe Active Sockets Display for a Single Protocol\n\nWhen a protocol is specified with the -Cp option, the information displayed is similar to\nthat in the default display for active sockets, except the display is limited to the given\nprotocol.\n" } ] }, "EXAMPLES": { "content": "Example of using snmpnetstat to display active sockets (default):\n\n% snmpnetstat -v 2c -c public -Ca testhost\n\nActive Internet (tcp) Connections (including servers)\nProto Local Address Foreign Address (state)\ntcp *.echo *.* LISTEN\ntcp *.discard *.* LISTEN\ntcp *.daytime *.* LISTEN\ntcp *.chargen *.* LISTEN\ntcp *.ftp *.* LISTEN\ntcp *.telnet *.* LISTEN\ntcp *.smtp *.* LISTEN\n...\n\nActive Internet (udp) Connections\nProto Local Address\nudp *.echo\nudp *.discard\nudp *.daytime\nudp *.chargen\nudp *.time\n...\n\n% snmpnetstat -v 2c -c public -Ci testhost\n\nName Mtu Network Address Ipkts Ierrs Opkts Oerrs Queue\neri0 1500 10.6.9/24 testhost 170548881 245601 687976 0 0\nlo0 8232 127 localhost 7530982 0 7530982 0 0\n\nExample of using snmpnetstat to show statistics about a specific protocol:\n\n% snmpnetstat -v 2c -c public -Cp tcp testhost\n\nActive Internet (tcp) Connections\nProto Local Address Foreign Address (state)\ntcp *.echo *.* LISTEN\ntcp *.discard *.* LISTEN\ntcp *.daytime *.* LISTEN\ntcp *.chargen *.* LISTEN\ntcp *.ftp *.* LISTEN\ntcp *.telnet *.* LISTEN\ntcp *.smtp *.* LISTEN\n...\n", "subsections": [] }, "SEE ALSO": { "content": "snmpcmd(1), iostat(1), vmstat(1), hosts(5), networks(5), protocols(5), services(5).\n", "subsections": [] }, "BUGS": { "content": "The notion of errors is ill-defined.\n\n\n\nV5.9.1 04 Nov 2013 SNMPNETSTAT(1)", "subsections": [] } }, "summary": "snmpnetstat - display networking status and configuration information from a network entity via SNMP", "flags": [ { "flag": "", "long": null, "arg": null, "description": "will automatically fall back to the legacy tables if the modern ones are not available." }, { "flag": "", "long": null, "arg": null, "description": "processes are not shown." }, { "flag": "", "long": null, "arg": null, "description": "" }, { "flag": "", "long": null, "arg": null, "description": "of cumulative statistics regarding packets transferred, errors, and collisions. The network addresses of the interface and the maximum transmission unit (``mtu'') are also displayed." }, { "flag": "", "long": null, "arg": null, "description": "" }, { "flag": "", "long": null, "arg": null, "description": "" }, { "flag": "", "long": null, "arg": null, "description": "when enquiring virtual interfaces (such as Frame-Relay circuits) on a router." }, { "flag": "", "long": null, "arg": null, "description": "below." }, { "flag": "", "long": null, "arg": null, "description": "to display them symbolically). This option may be used with any of the display formats." }, { "flag": "", "long": null, "arg": null, "description": "with any of the display formats." }, { "flag": "", "long": null, "arg": null, "description": "or an alias for it. Some protocol names and aliases are listed in the file /etc/protocols. A null response typically means that there are no interesting numbers to report. The program will complain if protocol is unknown or if there is no statistics routine for it." }, { "flag": "", "long": null, "arg": null, "description": "zero will be suppressed." }, { "flag": "", "long": null, "arg": null, "description": "" }, { "flag": "", "long": null, "arg": null, "description": "When snmpnetstat is invoked with an interval argument, it displays a running count of statis‐ tics related to network interfaces. interval is the number of seconds between reporting of statistics. The Active Sockets Display (default) The default display, for active sockets, shows the local and remote addresses, protocol, and the internal state of the protocol. Address formats are of the form ``host.port'' or ``net‐ work.port'' if a socket's address specifies a network but no specific host address. When known, the host and network addresses are displayed symbolically according to the databases /etc/hosts and /etc/networks, respectively. If a symbolic name for an address is unknown, or if the -Cn option is specified, the address is printed numerically, according to the address family. For more information regarding the Internet ``dot format,'' refer to inet(3N). Un‐ specified, or ``wildcard'', addresses and ports appear as ``*''. The Interface Display The interface display provides a table of cumulative statistics regarding packets trans‐ ferred, errors, and col- lisions. The network addresses of the interface and the maximum transmission unit (``mtu'') are also displayed. The Routing Table Display The routing table display indicates the available routes and their status. Each route con‐ sists of a destination host or network and a gateway to use in forwarding pack- ets. The flags field shows the state of the route (``U'' if ``up''), whether the route is to a gateway (``G''), whether the route was created dynamically by a redirect (``D''), and whether the route has been modified by a redirect (``M''). Direct routes are created for each interface attached to the local host; the gateway field for such entries shows the address of the out‐ going inter- face. The interface entry indicates the network interface utilized for the route. The Interface Display with an Interval When snmpnetstat is invoked with an interval argument, it displays a running count of statis‐ tics related to network interfaces. This display consists of a column for the primary inter‐ face and a column summarizing information for all interfaces. The primary interface may be replaced with another interface with the -CI option. The first line of each screen of infor‐ mation contains a summary since the system was last rebooted. Subsequent lines of output show values accumulated over the preceding interval. The Active Sockets Display for a Single Protocol When a protocol is specified with the -Cp option, the information displayed is similar to that in the default display for active sockets, except the display is limited to the given protocol." } ], "examples": [ "Example of using snmpnetstat to display active sockets (default):", "% snmpnetstat -v 2c -c public -Ca testhost", "Active Internet (tcp) Connections (including servers)", "Proto Local Address Foreign Address (state)", "tcp *.echo *.* LISTEN", "tcp *.discard *.* LISTEN", "tcp *.daytime *.* LISTEN", "tcp *.chargen *.* LISTEN", "tcp *.ftp *.* LISTEN", "tcp *.telnet *.* LISTEN", "tcp *.smtp *.* LISTEN", "...", "Active Internet (udp) Connections", "Proto Local Address", "udp *.echo", "udp *.discard", "udp *.daytime", "udp *.chargen", "udp *.time", "...", "% snmpnetstat -v 2c -c public -Ci testhost", "Name Mtu Network Address Ipkts Ierrs Opkts Oerrs Queue", "eri0 1500 10.6.9/24 testhost 170548881 245601 687976 0 0", "lo0 8232 127 localhost 7530982 0 7530982 0 0", "Example of using snmpnetstat to show statistics about a specific protocol:", "% snmpnetstat -v 2c -c public -Cp tcp testhost", "Active Internet (tcp) Connections", "Proto Local Address Foreign Address (state)", "tcp *.echo *.* LISTEN", "tcp *.discard *.* LISTEN", "tcp *.daytime *.* LISTEN", "tcp *.chargen *.* LISTEN", "tcp *.ftp *.* LISTEN", "tcp *.telnet *.* LISTEN", "tcp *.smtp *.* LISTEN", "..." ], "see_also": [ { "name": "snmpcmd", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/snmpcmd/1/json" }, { "name": "iostat", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/iostat/1/json" }, { "name": "vmstat", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/vmstat/1/json" }, { "name": "hosts", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/hosts/5/json" }, { "name": "networks", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/networks/5/json" }, { "name": "protocols", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/protocols/5/json" }, { "name": "services", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/services/5/json" } ], "tldr": { "source": "official", "description": "Fetch networking status using SNMP.", "examples": [ { "description": "Fetch the networking status", "command": "snmpnetstat -v {{version}} -c {{community}} {{ip_address}}" }, { "description": "Display help", "command": "snmpnetstat {{-h|--help}}" } ] } }