~ubuntu-branches/ubuntu/dapper/flow-tools/dapper

« back to all changes in this revision

Viewing changes to docs/flow-xlate.1.in

  • Committer: Bazaar Package Importer
  • Author(s): Radu Spineanu
  • Date: 2005-06-02 20:12:57 UTC
  • mfrom: (1.1.1 upstream) (2.1.1 sarge)
  • Revision ID: james.westby@ubuntu.com-20050602201257-jv0qdk3hjhpdf04b
Tags: 1:0.68-2
Fixed a bashism in init script (closes: #311568)

Show diffs side-by-side

added added

removed removed

Lines of Context:
56
56
\fBflow-xlate\fP \(em Apply translations to selected fields of a flow\&.
57
57
.SH "SYNOPSIS"
58
58
.PP
59
 
\fBflow-xlate\fP [-hkn]  [-b\fI big\fP|\fIlittle\fP]  [-C\fI comment\fP]  [-d\fI debug_level\fP]  [-V\fI flow_version\fP]  [-x\fI xlate_fname\fP]  [-X\fI xlate_definition\fP]  [-z\fI z_level\fP] 
 
59
\fBflow-xlate\fP [-hkn]  [-b\fI big\fP|\fIlittle\fP]  [-C\fI comment\fP]  [-d\fI debug_level\fP]  [-v\fI variable binding\fP]  [-V\fI flow_version\fP]  [-x\fI xlate_fname\fP]  [-X\fI xlate_definition\fP]  [-z\fI z_level\fP] 
60
60
.SH "DESCRIPTION"
61
61
.PP
62
62
The \fBflow-xlate\fP utility is used to apply translations
63
 
to flows\&.  Translations are composed of actions and a definition to 
64
 
invoke action(s)\&.  The definitions are in the form of terms, each term
65
 
can have a filter and multiple actions\&.
 
63
to flows\&.  Translations are defined in a configuration file and are
 
64
composed of actions and a definition to invoke action(s)\&.  The definitions
 
65
are in the form of terms, each term can have a filter and multiple actions\&.
 
66
.PP
 
67
Words in the configuration file of the form @VAR or @{VAR:default} will be
 
68
expanded at run-time by setting variable names with the -v option\&.
66
69
.PP
67
70
Translation actions begin with the xlate-action keyword followed by
68
71
a symbolic name\&.  Each action has a type defined below\&.
73
76
a filter to conditionally invoke an action\&.
74
77
.PP
75
78
.nf
76
 
Action type                             Description/Example
 
79
Action type/sub-commands                Description/Example
77
80
------------------------------------------------------------------------
78
 
ip-source-address-to-network            Remove host bits based on mask\&.
79
 
 
80
 
ip-destination-address-to-network       Remove host bits based on mask\&.
81
 
 
82
 
ip-source-address-to-class-network      Remove host bits to match class\&.
83
 
 
84
 
ip-destination-address-to-class-network
85
 
                                        Remove host bits to match class\&.
 
81
ip-source-address-to-network            Zero host bits based on mask\&.
 
82
ip-destination-address-to-network       Zero host bits based on mask\&.
 
83
 
 
84
  (no sub-commands)
 
85
 
 
86
ip-source-address-to-class-network      Zero source host bits to
 
87
                                        match class\&.
 
88
ip-destination-address-to-class-network Zero dst host bits to
 
89
                                        match class\&.
 
90
                                      
 
91
  (no sub-commands)
 
92
 
 
93
ip-source-address-anonymize             Anonymize source address\&.
 
94
ip-destination-address-anonymize        Anonymize destination address\&.
 
95
ip-address-anonymize                    Anonymize src/dst address\&.
 
96
 
 
97
 
 
98
    algorithm                           Algorithm\&.  cryptopan-aes128 is
 
99
                                        currently supported\&.
 
100
                                         algorithm cryptopan-aes128
 
101
 
 
102
    key                                 Key\&.  Key is 128 bits in hex\&.
 
103
                                         key 0123456789ABCDEFG
 
104
 
 
105
    key-file                            File to load key from\&.  Key is
 
106
                                        128 bits in hex\&.
 
107
                                         key-file /mfstmp/secret-key
 
108
 
 
109
    key-file-refresh                    How often to check the key file\&.
 
110
                                        Interval is in minutes, the
 
111
                                        optional second argument is
 
112
                                        hour:min:sec to specify the
 
113
                                        first refresh\&.  This example
 
114
                                        will load a new key every day
 
115
                                        at 12:00:00\&.
 
116
                                         14400 12:00:00
 
117
 
86
118
 
87
119
ip-address-privacy-mask                 Apply a mask to the source and
88
120
                                        destination address to remove
89
121
                                        bits\&.
90
 
                                         mask 0xFFFFFF00 0xFFFFFF00
91
122
 
92
 
scale                                   Scale packets and bytes
93
 
                                        scale 100
 
123
ip-port-privacy-mask                    Apply a mask to the source and
 
124
                                        destination port to remove
 
125
                                        bits\&.
94
126
 
95
127
tag-mask                                Apply mask to the source and
96
128
                                        destination tag\&.
97
 
                                        mask 0xFFFFFF00 0xFFFFFFFF
 
129
 
 
130
    mask                                Source and Destination mask
 
131
                                        to apply\&.
 
132
                                         mask 0xFFFF 0xFFFF
 
133
 
 
134
scale                                   Scale packets and bytes\&.
 
135
 
 
136
  scale                                 Scale to apply\&.
 
137
                                         scale 100
98
138
 
99
139
replace-source-as0                      Replace source AS 0
100
 
                                        as 3112
101
 
 
102
140
replace-destination-as0                 Replace destination AS 0
103
 
                                        as 3112
 
141
 
 
142
  as                                    AS replacement value\&.
 
143
                                         as 3112
104
144
.fi
105
145
.SH "OPTIONS"
106
146
.IP "-b\fI big\fP|\fIlittle\fP" 10
115
155
Keep time from input\&.
116
156
.IP "-n" 10
117
157
Don\&'t load configuration file\&.  Useful only with -V
 
158
.IP "-v\fI variable binding\fP" 10
 
159
Set a variable FOO=bar\&.   
118
160
.IP "-V\fI pdu_version\fP" 10
119
161
Use \fIpdu_version\fP format output\&.
120
162
.PP
194
236
filter-primitive SKIP
195
237
  type ip-address-mask
196
238
  deny 192\&.88\&.99\&.0 255\&.255\&.255\&.0
 
239
  default permit
197
240
 
198
241
filter-definition mcast
199
242
  match ip-destination-address MCAST
205
248
.fi
206
249
 
207
250
\fBflow-cat \fBflows\fP | flow-xlate -xxlate\&.cfg -Xabilene_privacy | flow-print\fP
 
251
.SH "FILES"
 
252
.PP
 
253
  Configuration files:
 
254
    Symbols - \fB@localstatedir@/sym/*\fP\&.
 
255
    Filter - \fB@localstatedir@/cfg/filter\&.cfg\fP\&.
 
256
    Xlate - \fB@localstatedir@/cfg/xlate\&.cfg\fP\&.
208
257
.SH "BUGS"
209
258
.PP
210
259
The scale option can overflow the 32 bit flow counters\&.  This could be
217
266
.SH "SEE ALSO"
218
267
.PP
219
268
\fBflow-tools\fP(1)
220
 
...\" created by instant / docbook-to-man, Tue 25 Nov 2003, 00:18
 
269
...\" created by instant / docbook-to-man, Tue 10 May 2005, 11:19