File: flow-stat.1

package info (click to toggle)
flow-tools 1%3A0.68-12.1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 5,136 kB
  • ctags: 5,259
  • sloc: ansic: 43,197; sh: 1,674; perl: 661; python: 629; yacc: 303; makefile: 208; lex: 49
file content (171 lines) | stat: -rw-r--r-- 4,864 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
...\" $Header: /usr/src/docbook-to-man/cmd/RCS/docbook-to-man.sh,v 1.3 1996/06/17 03:36:49 fld Exp $
...\"
...\"	transcript compatibility for postscript use.
...\"
...\"	synopsis:  .P! <file.ps>
...\"
.de P!
\\&.
.fl			\" force out current output buffer
\\!%PB
\\!/showpage{}def
...\" the following is from Ken Flowers -- it prevents dictionary overflows
\\!/tempdict 200 dict def tempdict begin
.fl			\" prolog
.sy cat \\$1\" bring in postscript file
...\" the following line matches the tempdict above
\\!end % tempdict %
\\!PE
\\!.
.sp \\$2u	\" move below the image
..
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "\fBflow-stat\fP" "1"
.SH "NAME"
\fBflow-stat\fP \(em Generate reports with flow data\&.
.SH "SYNOPSIS"
.PP
\fBflow-stat\fP [-hnpPw]  [-d\fI debug_level\fP]  [-f\fI format\fP]  [-S\fI sort_field\fP]  [-s\fI sort_field\fP]  [-t\fI tally_lines\fP]  [-T\fI title\fP] 
.SH "DESCRIPTION"
.PP
The \fBflow-stat\fP utility generates usage reports for flow
data sets by IP address, IP address pairs, ports, packets, bytes,
interfaces, next hops, autonomous systems, ToS bits, exporters, and tags\&.
.SH "OPTIONS"
.IP "-d\fI debug_level\fP" 10
Enable debugging\&.
.IP "-f\fI format\fP" 10
.PP
.nf
Report format\&.  Choose from the following:

    0  Overall Summary
    1  Average packet size distribution
    2  Packets per flow distribution
    3  Octets per flow distribution
    4  Bandwidth per flow distribution
    5  UDP/TCP destination port
    6  UDP/TCP source port
    7  UDP/TCP port
    8  Destination IP
    9  Source IP
    10 Source/Destination IP
    11 Source or Destination IP
    12 IP protocol
    13 octets for flow duration plot data
    14 packets for flow duration plot data
    15 short summary
    16 IP Next Hop
    17 Input interface
    18 Output interface
    19 Source AS
    20 Destination AS
    21 Source/Destination AS
    22 IP ToS
    23 Input/Output Interface
    24 Source Prefix
    25 Destination Prefix
    26 Source/Destination Prefix
    27 Exporter IP
    28 Engine Id
    29 Engine Type
    30 Source Tag
    31 Destination Tag
    32 Source/Destination Tag
.fi
.IP "-h" 10
Display help\&.
.IP "-n" 10
Use symbolic names where appropriate\&.
.IP "-p" 10
Display header information\&.
.IP "-P" 10
Report as percent total\&.
.IP "-s\fI sort_field\fP" 10
Sort ascending on field \fIsort_field\fP\&.
.IP "-S\fI sort_field\fP" 10
Sort descending on field \fIsort_field\fP\&.
.IP "-t\fI tally_lines\fP" 10
Tally totals every \fItally_lines\fPlines\&.
.IP "-T\fI title\fP" 10
Set report title to \fItitle\fP\&.
.IP "-w" 10
Wide output\&.
.SH "EXAMPLES"
.PP
Provide a report on top source/destination IP pairs sorted by octets, report
in percent total form for the flows in \fB/flows/krc4\fP\&.
Use the preload option to flow-cat to preserve meta information and 
display it with flow-stat\&.
.PP
  \fBflow-cat -p /flows/krc4 | flow-stat -f10 -P -p -S4\fP
.SH "EXAMPLES"
.PP
Many times a campus network will have a single border router which has
one interface pointing to the internal side and many interfaces pointing
to other providers\&.  These interfaces each have a unique numerical id
known in SNMP terms as an ifIndex\&.  The ifIndex to interface name mappings
can be determined by using a tool such as \fBsnmpwalk\fP or using show commands in recent versions of IOS with the
\&'show snmp mib ifmib ifindex\&' or JunOS \&'show interfaces\&'\&.  Once the ifIndex
for each interface is known flow-filter can be combined with flow-stat to
provide reports such as inbound vs outbound top src/destination IP
addresses\&.

Provide a top source IP address report by outbound traffic, ie the top
senders of traffic on the campus network\&.  Assume the ifIndex of the
campus interface is 5\&.
.PP
  flow-cat -p /flows/krc4 | flow-filter -i5 | flow-stat -f9 -P -p -S3 
.SH "EXAMPLES"
.PP
Provide a top destination IP address report by outbound traffic, ie the top
sinks of traffic on the campus network\&.  Assume the ifIndex of the
campus interface is 5\&.
.PP
  flow-cat -p /flows/krc4 | flow-filter -I5 | flow-stat -f8 -P -p -S3 
.SH "EXAMPLES"
.PP
Provide a top source/destination AS report\&.  Use symbolic names\&.
.PP
  flow-cat -p /flows/krc4 | flow-stat -f20 -n -P -p -S4 
.SH "BUGS"
.PP
None known\&.
.SH "AUTHOR"
.PP
Mark Fullmer maf@splintered\&.net
.SH "SEE ALSO"
.PP
\fBflow-tools\fP(1)
...\" created by instant / docbook-to-man, Sat 08 Jun 2002, 23:41