1<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN">
2<refentry>
3
4<refmeta>
5<refentrytitle>
6<application>flow-gen</application>
7</refentrytitle>
8<manvolnum>1</manvolnum>
9</refmeta>
10
11<refnamediv>
12<refname>
13<application>flow-gen</application>
14</refname>
15<refpurpose>
16Generate test flows
17</refpurpose>
18</refnamediv>
19
20<refsynopsisdiv>
21<cmdsynopsis>
22<command>flow-gen</command>
23<arg>-h</arg>
24<arg>-b<replaceable> big</replaceable>|<replaceable>little</replaceable></arg>
25<arg>-d<replaceable> debug_level</replaceable></arg>
26<arg>-n<replaceable> count</replaceable></arg>
27<arg>-V<replaceable> version</replaceable></arg>
28<arg>-z<replaceable> z_level</replaceable></arg>
29</cmdsynopsis>
30</refsynopsisdiv>
31
32
33<refsect1>
34<title>DESCRIPTION</title>
35<para>
36The <command>flow-gen</command> utility generates a test pattern of
37flows in any of the currently supported export versions typically for
38debugging purposes.
39</para>
40</refsect1>
41
42<refsect1>
43<title>OPTIONS</title>
44<variablelist>
45
46<varlistentry>
47<term>-b<replaceable> big</replaceable>|<replaceable>little</replaceable</term>
48<listitem>
49<para>
50Byte order of output.
51</para>
52</listitem>
53</varlistentry>
54
55<varlistentry>
56<term>-d<replaceable> debug_level</replaceable></term>
57<listitem>
58<para>
59Enable debugging.
60</para>
61</listitem>
62</varlistentry>
63
64<varlistentry>
65<term>-h</term>
66<listitem>
67<para>
68Display help.
69</para>
70</listitem>
71</varlistentry>
72
73<varlistentry>
74<term>-n<replaceable> count</replaceable></term>
75<listitem>
76<para>
77Generate count flows.  Default 1000.
78</para>
79</listitem>
80</varlistentry>
81
82<varlistentry>
83<term>-V<replaceable> version</replaceable></term>
84<listitem>
85<para>
86Generate version type exports.  Supported versions are:
87<literallayout>
88    1    NetFlow version 1 (No sequence numbers, AS, or mask)
89    5    NetFlow version 5
90    6    NetFlow version 6 (5+ Encapsulation size)
91    7    NetFlow version 7 (Catalyst switches)
92    8.1  NetFlow AS Aggregation
93    8.2  NetFlow Proto Port Aggregation
94    8.3  NetFlow Source Prefix Aggregation
95    8.4  NetFlow Destination Prefix Aggregation
96    8.5  NetFlow Prefix Aggregation
97    8.6  NetFlow Destination (Catalyst switches)
98    8.7  NetFlow Source Destination (Catalyst switches)
99    8.8  NetFlow Full Flow (Catalyst switches)
100    8.9  NetFlow ToS AS Aggregation
101    8.10 NetFlow ToS Proto Port Aggregation
102    8.11 NetFlow ToS Source Prefix Aggregation
103    8.12 NetFlow ToS Destination Prefix Aggregation
104    8.13 NetFlow ToS Prefix Aggregation
105    8.14 NetFlow ToS Prefix Port Aggregation
106    1005 Flow-Tools tagged version 5
107</literallayout>
108</para>
109</listitem>
110</varlistentry>
111
112<varlistentry>
113<term>-z<replaceable> z_level</replaceable></term>
114<listitem>
115<para>
116Configure compression level to <replaceable> z_level</replaceable>.  0 is
117disabled (no compression), 9 is highest compression.
118</para>
119</listitem>
120</varlistentry>
121
122</variablelist>
123</refsect1>
124
125<refsect1>
126<title>EXAMPLES</title>
127<informalexample>
128<para>
129Generate a test pattern of 1000 version 5 flows and send them in
130the Cisco NetFlow packet format to 10.0.0.1 port 9500.
131</para>
132<para>
133  <command>flow-gen -V5 | flow-send 0/10.0.0.1/9500</command>
134</para>
135</informalexample>
136</refsect1>
137
138<refsect1>
139<title>BUGS</title>
140<para>
141The test pattern may change between releases.
142</para>
143</refsect1>
144
145<refsect1>
146<title>AUTHOR</title>
147<para>
148<author>
149<firstname>Mark</firstname>
150<surname>Fullmer</surname>
151</author>
152<email>maf@splintered.net</email>
153</para>
154</refsect1>
155
156<refsect1>
157<title>SEE ALSO</title>
158<para>
159<application>flow-tools</application>(1)
160</para>
161</refsect1>
162
163</refentry>
164