1JNETTOP(8) System Manager's Manual JNETTOP(8)
2
6 jnettop - View hosts/ports taking up the most network traffic
7
9 jnettop [options] [-i interface] [-d filename] [-f filename] [-x rule]
10
12 This manual page documents briefly the jnettop command. This manual
13 page is OBSOLETE. Please use jnettop -h as a main source of information
14 about usage.
15 jnettop captures traffic coming across the host it is running on and
17 displays streams sorted by bandwidth they use. Result is a nice listing
18 of communication on network by host and port, how many bytes went
19 through this transport and the bandwidth it is consuming.
20
22 These programs follow the usual GNU command line syntax, with long
23 options starting with two dashes (`-'). A summary of options is
24 included below.
25 -h, --help
27 Show summary of options.
28 -v, --version
30 Show version of program.
31 -b, --bit-units
33 show BPS In bits per second, not bytes per second
34 -c, --content-filter
36 disable content filtering
37 -d, --debug filename
39 write debug information into file
40 -f, --config-file filename
42 reads configuration from filename. defaults to ~/.jnettop. an
43 example can be found at /usr/share/doc/jnettop/dot.jnettop. or
44 in .jnettop file from original distribution package.
45 -i, --interface name
47 capture packets on specified interface
48 --local-aggr [none|host|port]
50 set local aggregation to specified value
51 -n, --no-resolver
53 disable resolving of ip addresses
54 -p, --promiscuous
56 enables promiscuous mode on the sniffed interface
57 --remote-aggr [none|host|port]
59 set remote aggregation to specified value
60 -s, --select-rule name
62 selects one of the rules defined in .jnettop configuration file
63 (by it's name)
64 -x, --filter rule
66 allows for specification of custom filtering rule. this allows
67 for tcpdump(1) style syntax. don't forget to enclolse the filter
68 into quotes when running from a shell.
69
71 Program looks for settings in the file specified by parameter -f, which
72 defaults to ~/.jnettop. Configuration file is an ordinary text file
73 with keywords and their arguments. You HAVE to enclose arguments into
74 double quotes. Available keywords are:
75 interface "<interface_name>"
77 The interface keyword specifies network interface on which to
78 start listening. Example:
79 interface "eth0"
81 local_aggregation [none|host|port]
83 The local_aggregation keyword specifies initial active local
84 aggregation. Valid values are none, host and port. Example:
85 local_aggregation host
87 promisc [on|off]
89 The promisc keyword specifies, whether jnettop captures packets
90 in promiscuous mode. Example:
91 promisc on
93 remote_aggregation [none|host|port]
95 The remote_aggregation keyword specifies initial active remote
96 aggregation. Valid values are none, host and port. Example:
97 remote_aggregation port
99 resolve [on|off]
101 The resolve keyword specifies, whether resolving is performed on
102 the IP addresses or not.
103 resolve off
105 resolve_rule "<network address>" "<network mask>" [normal|external]
107 (<arguments> ...)
108 The resolve_rule keyword adds one resolver into list of
109 resolvers for specified address. When resolving, jnettop exam‐
110 ines all the rules in the order how they were specified in con‐
111 figuration file. If the network address matches specified range,
112 declared resolver is used. Resolver can be normal, which means
113 the standard DNS lookup or external, which executes specified
114 external program to perform resolving. This can be used with
115 bundled jnettop-lookup-nmb script, which looks up IP addresses
116 using nmblookup(1) tool. If a tool returns empty string or DNS
117 is not found, next rule is examined. If jnettop runs out of
118 rules, than the standard DNS lookup is executed.
119 resolve_rule "192.168.0.0" "255.255.255.0" normal
121 resolve_rule "192.168.0.0" "255.255.255.0" external
122 "/usr/share/jnettop/jnettop-lookup-nbm"
123 rule "<rule_name>" "<rule_definition>"
125 The rule keyword defines a set of predefined tcpdump(1)-like
126 filters to apply. You can specify various filters as "show me
127 what 192.168.1.32" sends:
128 rule "show 192.168.1.32" "src 192.168.1.32"
130 select_rule "<rule_name>"
132 The select_rule keyword specifies initial active predefined
133 rule. The rule must be defined before this keyword is used.
134 Example:
135 select_rule "show 192.168.1.32"
137 variable "<variable_name>" "<variable_contents>"
139 The variable keyword introduces a string variable for use in
140 future rule definitions. It can be used to shorten rule defini‐
141 tions. Example:
142 variable "intranet" "net 192.168.0.0/16 or 10.0.0.0/8 or
144 172.16.0.0/12"
145 For more information, see README file or .jnettop example configuration
147 file included in distribution.
148
150 This manual page was originally written by Ari Pollak <ari@debian.org>,
151 for the Debian GNU/Linux system. Small changes were introduced by Jakub
152 Skopal <j@kubs.cz>
153 April 8, 2006 JNETTOP(8)