File: SubNetIO.html

package info (click to toggle)
flowscan 1.006-13.2
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch, wheezy
  • size: 732 kB
  • ctags: 185
  • sloc: sh: 1,670; perl: 1,518; makefile: 148
file content (237 lines) | stat: -rw-r--r-- 4,725 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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
    <HTML> 
	<HEAD> 
	    <TITLE>SubNetIO - a FlowScan module for reporting on campus traffic I/O by subnet

</TITLE> 
	</HEAD>

	<BODY>

<!-- INDEX BEGIN -->

<UL>

	<LI><A HREF="#NAME">NAME</A>
	<LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
	<LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
	<LI><A HREF="#CONFIGURATION">CONFIGURATION</A>
	<LI><A HREF="#BUGS">BUGS</A>
	<LI><A HREF="#AUTHOR">AUTHOR</A>
	<LI><A HREF="#VERSION">VERSION</A>
</UL>
<!-- INDEX END -->

<HR>
<P>
<H1><A NAME="NAME">NAME

</A></H1>
SubNetIO - a FlowScan module for reporting on campus traffic I/O by subnet


<P>

<P>
<HR>
<H1><A NAME="SYNOPSIS">SYNOPSIS

</A></H1>
<PRE>   $ flowscan SubNetIO
</PRE>

<P>

or in <EM>flowscan.cf</EM>:


<P>

<PRE>   ReportClasses SubNetIO
</PRE>

<P>

<P>
<HR>
<H1><A NAME="DESCRIPTION">DESCRIPTION

</A></H1>
SubNetIO is a flowscan report for reporting on flows of traffic in and out
of specific subnets within a site or campus. It is implemented as a class
derived from CampusIO, so you run either CampusIO or SubNetIO, not both,
since SubNetIO inherits all the functionality of CampusIO. For instance, in
your <EM>flowscan.cf</EM>:


<P>

<PRE>   ReportClasses SubNetIO
</PRE>

<P>

<P>
<HR>
<H1><A NAME="CONFIGURATION">CONFIGURATION

</A></H1>
<CODE>SubNetIO</CODE>'s configuration file is <EM>SubNetIO.cf</EM>. This configuration file is located in the directory in which the <EM>flowscan</EM> script resides.


<P>

The SubNetIO configuration directives include:


<P>

<DL>
<DT><STRONG><A NAME="item_SubnetFiles">SubnetFiles

</A></STRONG><DD>
This directive is required. It is a a comma-seperated list of files
containing the definitions of the subnets on which you'd like to report.
E.g.:


<P>

<PRE>   # SubnetFiles our_subnets.boulder
   SubnetFiles bin/our_subnets.boulder
</PRE>

<P>

<DT><STRONG><A NAME="item_OutputDir">OutputDir

</A></STRONG><DD>
This directive is required. It is the directory in which RRD files will be
written. E.g.:


<P>

<PRE>   # OutputDir /var/local/flows/graphs
   OutputDir graphs
</PRE>

<P>

<DT><STRONG><A NAME="item_Verbose">Verbose

</A></STRONG><DD>
This directive is optional. If non-zero, it makes <CODE>flowscan</CODE> more verbose with respect to messages and warnings. Currently the values <CODE>1</CODE> and <CODE>2</CODE> are understood, the higher value causing more messages to be produced.
E.g.:


<P>

<PRE>   # Verbose (OPTIONAL, non-zero = true)
   Verbose 1
</PRE>

<P>

<DT><STRONG><A NAME="item_TopN">TopN

</A></STRONG><DD>
This directive is optional. It's use requires the <CODE>HTML::Table</CODE> perl module.  <A HREF="#item_TopN">TopN</A> is the number of entries to show in the tables that will be generated in
HTML top reports. E.g.:


<P>

<PRE>   # TopN (OPTIONAL)
   TopN 10
</PRE>

<P>

If you'd prefer to see hostnames rather than IP addresses in your top
reports, use the <EM>ip2hostname</EM> script. E.g.:


<P>

<PRE>   $ ip2hostname -I *.*.*.*_*.html
</PRE>

<P>

<DT><STRONG><A NAME="item_ReportPrefixFormat">ReportPrefixFormat

</A></STRONG><DD>
This directive is optional. It is used to specify the file name prefix for
the HTML ``Top Talkers'' reports. You should use <CODE>strftime(3)</CODE>
format specifiers in the value, and it may also specify sub-directories. If
not set, the prefix defaults to the null string, which means that, every
five minutes, subsequent reports will overwrite the previous. E.g.:


<P>

<PRE>   # Preserve one day of HTML reports using the time of day as the dir name:
   ReportPrefixFormat html/SubNetIO/%H:%M/
</PRE>

<P>

or:


<P>

<PRE>   # Preserve one month by using the day of month in the dir name (like sar(1)):
   ReportPrefixFormat html/SubNetIO/%d/%H:%M_
</PRE>

<P>

</DL>
<P>
<HR>
<H1><A NAME="BUGS">BUGS

</A></H1>
<P>
<HR>
<H1><A NAME="AUTHOR">AUTHOR

</A></H1>
Dave Plonka <A
HREF="MAILTO:<plonka@doit.wisc.edu>"><plonka@doit.wisc.edu></A>


<P>

Copyright (C) 1999-2001 Dave Plonka. This program is free software; you can
redistribute it and/or modify it under the terms of the GNU General Public
License as published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.


<P>

<P>
<HR>
<H1><A NAME="VERSION">VERSION

</A></H1>
The version number is the module file RCS revision number (<STRONG>$Revision: 1.27 $</STRONG>) with the minor number printed right justified with leading zeroes to 3
decimal places. For instance, RCS revision 1.1 would yield a package
version number of 1.001.


<P>

This is so that revision 1.10 (which is version 1.010), for example, will
test greater than revision 1.2 (which is version 1.002) when you want to
<STRONG>require</STRONG> a minimum version of this module.


<P>

</DL>
    </BODY>

    </HTML>