Debian Codegraph @

flentrc.example

raw
1 ## Sample rcfile for flent. Allows options to be specified
2 ## on a global or per-test basis. The file is divided into sections with
3 ## section headers between square brackets.
4 ##
5 ## Options specified in the [global] section apply to everything, while
6 ## further sections specify options that are specific for the test name
7 ## corresponding to the section name.
8 ##
9 ## Comments start with # or ;, and option names are case insensitive.
10 ## The supported options are listed with commentary below. Options specified
11 ## on the command line override options set in the rcfile.
12 ##
13 ## To use: Copy to ~/.flentrc and edit, or specify location of
14 ## the file with --rcfile.
15
16 [global]
17
18 # Default test target host(s).
19 # Corresponding command line option: --host (or unqualified argument).
20 # Multiple values are separated by commas.
21 ;hosts = demo.tohojo.dk
22
23 # Data point step size and sampling interval (seconds).
24 # Corresponding command line option: --step-size
25 ;step_size = 0.2
26
27 # Test length (not including delay before starting test).
28 # Corresponding command line option: --length
29 ;length = 60
30
31 # Delay from start of test to the rest of the test starts (only some tests).
32 # Typically used to delay bandwidth loaders after starting latency measurements;
33 # the total runtime, for tests that use delay, typically becomes length+2*delay.
34 # Corresponding command line option: --delay
35 ;delay = 5
36
37 # Output file; defaults to standard output (or an interactive viewer for plots)
38 # if a graphical display is available. Note that for some output modes (e.g. plots),
39 # the output file name determines file format.
40 # Corresponding command line option: --output
41 ;output =
42
43 # Data file directory. Data files from test runs are stored in this directory.
44 # Defaults to the system tmpdir (e.g. /tmp)
45 # Corresponding command line option: --data-dir
46 ;data_dir = /tmp
47
48 # Output format.
49 # Corresponding command line option: --format
50 ;format =
51
52 # Title added to data file name, printed on plots etc.
53 # Probably not terribly useful to set in a config file...
54 # Corresponding command line option: --title-extra
55 ;title =
56
57 # Note added to the data file as metadata (key NOTE).
58 # Probably not terribly useful to set in a config file...
59 # Corresponding command line option: --note
60 ;note =
61
62 # Filename to output debug logging to.
63 # Debug logging is disabled if this is not set.
64 # Corresponding command line option: --log-file
65 ;log_file =
66
67 # IP version to use for connecting to the target host.
68 # Valid values: 4 or 6.
69 # Corresponding command line option: --ipv4 or --ipv6
70 ;ip_version = 4
71
72 # Socket timeout to pass to netperf for UDP tests (if the netperf) version
73 # supports it. Units of seconds.
74 # Corresponding command line option: --socket-timeout
75 ;socket_timeout = 2
76
77 # Whether to interpret multiple input files as being used to scale plots.
78 # If not set, multiple input files are interpreted to be plotted side-by-side.
79 #
80 # Note that boolean options, if changed from the default, current cannot be
81 # overridden from the command line.
82 # Corresponding command line option: --scale-mode
83 ;scale_mode = no
84
85 # Whether to plot each data series in a separate subplot when combining multiple
86 # data series into a single plot. Only supported for some plot types, and only
87 # works if scale_mode is not set.
88 #
89 # Note that boolean options, if changed from the default, current cannot be
90 # overridden from the command line.
91 # Corresponding command line option: --subplot-combine
92 ;subplot_combine = no
93
94 # Whether to print annotations (hostname etc) on plots.
95 #
96 # Note that boolean options, if changed from the default, current cannot be
97 # overridden from the command line.
98 # Corresponding command line option: --no-annotation
99 ;annotate = yes
100
101 # Whether to print the test title on plots.
102 #
103 # Note that boolean options, if changed from the default, current cannot be
104 # overridden from the command line.
105 # Corresponding command line option: --no-title
106 ;print_title = yes
107
108 # Whether to print plot legend.
109 #
110 # Note that boolean options, if changed from the default, current cannot be
111 # overridden from the command line.
112 # Corresponding command line option: --no-legend
113 ;print_legend = yes
114
115 # Whether to always start y-axis from 0 (rather than scaling to the smallest
116 # data point).
117 #
118 # Note that boolean options, if changed from the default, current cannot be
119 # overridden from the command line.
120 # Corresponding command line option: --zero-y
121 ;zero_y = no
122
123 # Whether to Invert the y-axis for latency data series (making plots show
124 # 'better values upwards').
125 #
126 # Note that boolean options, if changed from the default, current cannot be
127 # overridden from the command line.
128 # Corresponding command line option: --invert-latency-y
129 ;invert_y = no
130
131 # Whether to enable automatic log-scaling of plot axes.
132 # If not disabled here (or on the command line), log scales are enabled if
133 # the maximum data point is more than 20 times the value of the minimum.
134 #
135 # Note that boolean options, if changed from the default, current cannot be
136 # overridden from the command line.
137 # Corresponding command line option: --disable-log
138 ;log_scale = yes
139
140 # Whether to gather extended meta data and store it in the data file.
141 # This may include sensitive data from the machine running the test, that
142 # it may not be desireable to publish. See the man page for the list of
143 # data gathered.
144 #
145 # Note that boolean options, if changed from the default, current cannot be
146 # overridden from the command line.
147 # Corresponding command line option: --extended-metadata
148 ;extended_metadata = no
149
150 # Remote hosts to gather metadata from.
151 #
152 # Multiple hosts are separated with commas; setting this also turns on
153 # extended_metadata.
154 # Corresponding command line option: --remote-metadata
155 ;remote_metadata = hostname1, hostname2
156
157 # Host to connect to the D-ITG control server on (only used for D-ITG tests; see
158 # man page).
159 #
160 # If this is not set (here or on the command line), the test hostname is used.
161 ;ditg_control_host = control-server.example.com
162
163 # Port the D-ITG control server is listening on (only used for D-ITG tests; see
164 # man page). Default: 8000.
165 ;ditg_control_port = 8000
166
167 # Secret used for HMAC authentication to the D-ITG control server (only used for
168 # D-ITG tests; see man page). Default: '' (the empty string).
169 ;digt_control_secret =
170
171 # Whether to always start a new GUI instance rather than attempt to connect
172 # to an already running instance. Note that unlike on the when it is passed
173 # on the command line, setting this flag here does not imply --gui.
174 #
175 # Note that boolean options, if changed from the default, current cannot be
176 # overridden from the command line.
177 # Corresponding command line option: --new-gui-instance
178 ;new_gui_instance = no
179
180 # List of batch file names to load -- to actually do a batch run, the batch name
181 # has to be passed in on the command line. This allows for having a persistent
182 # batch file specified in the rc file, which is always available for loading.
183 #
184 # Like with hosts, batch files specified here are overridden by batch files
185 # specified on the command line, meaning that if one or more batch files are
186 # passed on the command line, the files specified here are NOT loaded.
187 #
188 # Multiple values are specified comma-separated.
189 ;batch_files = ~/example.batch
190
191 ## Sections can specify settings overriding the global settings for
192 ## specific tests. For instance, this sets plot output to be default
193 ## for the RRUL test:
194 ;[rrul]
195 ;format=plot