1 # Copyright 2015-2017 Intel Corporation.
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # ############################
16 # Traffic gen configuration
17 # ############################
19 # log file for all traffic generator related commands
20 LOG_FILE_TRAFFIC_GEN = 'traffic-gen.log'
22 # TRAFFIC dictionary defines traffic parameters used by all traffic generators.
23 # Detailed description of TRAFFIC dictionary items follows:
25 # 'traffic_type' - One of the supported traffic types.
26 # E.g. rfc2544_throughput, rfc2544_back2back
27 # or rfc2544_continuous
29 # Default value: "rfc2544_throughput".
30 # 'bidir' - Specifies if generated traffic will be full-duplex (True)
31 # or half-duplex (False)
33 # Supported values: "True", "False"
34 # Default value: "False".
35 # 'frame_rate' - Defines desired percentage of frame rate used during
36 # continuous stream tests.
39 # 'multistream' - Defines number of flows simulated by traffic generator.
40 # Value 0 disables multistream feature
42 # Supported values: 0-65536 for 'L4' stream type
43 # unlimited for 'L2' and 'L3' stream types
45 # 'stream_type' - Stream type is an extension of the "multistream" feature.
46 # If multistream is disabled, then stream type will be
47 # ignored. Stream type defines ISO OSI network layer used
48 # for simulation of multiple streams.
51 # "L2" - iteration of destination MAC address
52 # "L3" - iteration of destination IP address
53 # "L4" - iteration of destination port
54 # of selected transport protocol
55 # Default value: "L4".
56 # 'pre_installed_flows'
57 # - Pre-installed flows is an extension of the "multistream"
58 # feature. If enabled, it will implicitly insert a flow
59 # for each stream. If multistream is disabled, then
60 # pre-installed flows will be ignored.
61 # Note: It is supported only for p2p deployment scenario.
64 # "Yes" - flows will be inserted into OVS
65 # "No" - flows won't be inserted into OVS
66 # Default value: "No".
67 # 'flow_type' - Defines flows complexity.
70 # "port" - flow is defined by ingress ports
71 # "IP" - flow is defined by ingress ports
72 # and src and dst IP addresses
73 # Default value: "port"
74 # 'l2' - A dictionary with l2 network layer details. Supported
76 # 'srcmac' - Specifies source MAC address filled by traffic generator.
77 # NOTE: It can be modified by vsperf in some scenarios.
79 # Default value: "00:00:00:00:00:00".
80 # 'dstmac' - Specifies destination MAC address filled by traffic generator.
81 # NOTE: It can be modified by vsperf in some scenarios.
83 # Default value: "00:00:00:00:00:00".
84 # 'framesize' - Specifies default frame size. This value should not be
85 # changed directly. It will be overridden during testcase
86 # execution by values specified by list TRAFFICGEN_PKT_SIZES.
89 # 'l3' - A dictionary with l3 network layer details. Supported
91 # 'enabled' - Specifies if l3 layer should be enabled or disabled.
94 # NOTE: Supported only by IxNet trafficgen class
95 # 'srcip' - Specifies source MAC address filled by traffic generator.
96 # NOTE: It can be modified by vsperf in some scenarios.
98 # Default value: "1.1.1.1".
99 # 'dstip' - Specifies destination MAC address filled by traffic generator.
100 # NOTE: It can be modified by vsperf in some scenarios.
102 # Default value: "90.90.90.90".
103 # 'proto' - Specifies deflaut protocol type.
104 # Please check particular traffic generator implementation
105 # for supported protocol types.
107 # Default value: "udp".
108 # 'l4' - A dictionary with l4 network layer details. Supported
110 # 'enabled' - Specifies if l4 layer should be enabled or disabled.
112 # Default value: True
113 # NOTE: Supported only by IxNet trafficgen class
114 # 'srcport' - Specifies source port of selected transport protocol.
115 # NOTE: It can be modified by vsperf in some scenarios.
117 # Default value: 3000
118 # 'dstport' - Specifies destination port of selected transport protocol.
119 # NOTE: It can be modified by vsperf in some scenarios.
121 # Default value: 3001
122 # 'vlan' - A dictionary with vlan encapsulation details. Supported
124 # 'enabled' - Specifies if vlan encapsulation should be enabled or
127 # Default value: False
128 # 'id' - Specifies vlan id.
129 # Data type: int (NOTE: must fit to 12 bits)
131 # 'priority' - Specifies a vlan priority (PCP header field).
132 # Data type: int (NOTE: must fit to 3 bits)
134 # 'cfi' - Specifies if frames can or cannot be dropped during
135 # congestion (DEI header field).
136 # Data type: int (NOTE: must fit to 1 bit)
139 'traffic_type' : 'rfc2544_throughput',
141 'bidir' : 'True', # will be passed as string in title format to tgen
143 'stream_type' : 'L4',
144 'pre_installed_flows' : 'No', # used by vswitch implementation
145 'flow_type' : 'port', # used by vswitch implementation
149 'srcmac': '00:00:00:00:00:00',
150 'dstmac': '00:00:00:00:00:00',
156 'dstip': '90.90.90.90',
171 #path to traffic generators directory.
172 TRAFFICGEN_DIR = os.path.join(ROOT_DIR, 'tools/pkt_gen')
174 # traffic generator to use in tests
175 #TRAFFICGEN = 'TestCenter'
177 #TRAFFICGEN = 'IxNet'
180 #TRAFFICGEN = 'Moongen'
182 # List of packet sizes to send.
183 # Expand like this: (64, 128, 256, 512, 1024)
184 TRAFFICGEN_PKT_SIZES = (64,)
186 TRAFFICGEN_DURATION = 30
188 TRAFFICGEN_RFC2544_TESTS = 1
189 TRAFFICGEN_RFC2889_TRIALS = 1
190 TRAFFICGEN_LOSSRATE = 0.0
192 ##############################
193 # DUMMY Configuration -- BEGIN
195 # By default, dummy traffic generator asks for "measured" values.
196 # Following dictionary allows to preconfigure these values and
197 # to avoid user interaction. It can be useful for automated
199 # Example of values for continuous traffic type:
200 # TRAFFICGEN_DUMMY_RESULTS{'frames rx': 500000,
201 # 'frames tx': 500000,
207 # 'avg latency': 2.5,
210 TRAFFICGEN_DUMMY_RESULTS = {}
212 # DUMMY Configuration -- END
213 ############################
215 #############################
216 # IXIA Configuration -- BEGIN
218 # path to 'ixos' install path
219 TRAFFICGEN_IXIA_ROOT_DIR = '/opt/ixos'
221 # network address of IXIA chassis
222 TRAFFICGEN_IXIA_HOST = ''
224 TRAFFICGEN_IXIA_CARD = ''
226 TRAFFICGEN_IXIA_PORT1 = ''
228 TRAFFICGEN_IXIA_PORT2 = ''
230 TRAFFICGEN_IXNET_LIB_PATH = '/opt/ixnetwork/lib/IxTclNetwork'
232 # IxNetwork host IP address
233 TRAFFICGEN_IXNET_MACHINE = ''
234 TRAFFICGEN_IXNET_PORT = ''
235 TRAFFICGEN_IXNET_USER = ''
236 TRAFFICGEN_IXNET_CHASSIS = ''
238 # The result directory on $TRAFFICGEN_IXNET_MACHINE
239 TRAFFICGEN_IXNET_TESTER_RESULT_DIR = ''
241 # The result directory on DUT. This needs to map to the same directory
242 # as the previous one
243 TRAFFICGEN_IXNET_DUT_RESULT_DIR = ''
245 # directory with 3rd party scripts generated by IXIA tools
246 TRAFFICGEN_IXIA_3RD_PARTY = os.path.join(ROOT_DIR, '3rd_party/ixia')
248 # default TCL script, which will be used for IXNETWORK configuration
249 TRAFFICGEN_IXNET_TCL_SCRIPT = 'ixnetrfc2544.tcl'
251 # IXIA Configuration -- END
252 ###########################
255 ###########################################
256 # Spirent TestCenter Configuration -- BEGIN
258 # Path to Python 2 executable
259 TRAFFICGEN_STC_PYTHON2_PATH = "/bin/python2.7"
261 # Path to the location of the TestCenter files
262 TRAFFICGEN_STC_TESTCENTER_PATH = os.path.join(ROOT_DIR, 'tools/pkt_gen/testcenter')
264 # Name of the TestCenter RFC2544 Tput helper python script
265 TRAFFICGEN_STC_RFC2544_TPUT_TEST_FILE_NAME = "testcenter-rfc2544-throughput.py"
267 # Name of the Testcenter RFC2899 Tput Helper Python Scripts
268 TRAFFICGEN_STC_RFC2889_TEST_FILE_NAME = "testcenter-rfc2889-rest.py"
270 # 2889 Port Locations
271 TRAFFICGEN_STC_RFC2889_LOCATION = ""
273 # The address of the Spirent Lab Server to use
274 TRAFFICGEN_STC_LAB_SERVER_ADDR = ""
276 # The address of the Spirent License Server in your environment
277 TRAFFICGEN_STC_LICENSE_SERVER_ADDR = ""
279 # The address of the TestCenter chassis that holds the east port
280 TRAFFICGEN_STC_EAST_CHASSIS_ADDR = ""
282 # The slot number of the card that holds the east port
283 TRAFFICGEN_STC_EAST_SLOT_NUM = ""
285 # The port number on the card that holds the east port
286 TRAFFICGEN_STC_EAST_PORT_NUM = ""
288 # The address of the TestCenter chassis that holds the west port
289 TRAFFICGEN_STC_WEST_CHASSIS_ADDR = ""
291 # The slot number of the card that holds the west port
292 TRAFFICGEN_STC_WEST_SLOT_NUM = ""
294 # The port number on the card that holds the west port
295 TRAFFICGEN_STC_WEST_PORT_NUM = ""
297 # The friendly name to identify the Spirent Lab Server test session
298 TRAFFICGEN_STC_TEST_SESSION_NAME = "RFC2544 Tput"
299 # The directory to copy results to
301 TRAFFICGEN_STC_RESULTS_DIR = os.path.join(ROOT_DIR, "Results")
302 # The prefix for the CSV results file
304 TRAFFICGEN_STC_CSV_RESULTS_FILE_PREFIX = "RFC2544_tput"
305 # The number of trials to execute during the test
307 TRAFFICGEN_STC_NUMBER_OF_TRIALS = "1"
309 # The duration of each trial executed during the test, in seconds
310 TRAFFICGEN_STC_TRIAL_DURATION_SEC = "60"
312 # The traffic pattern between endpoints, BACKBONE, MESH or PAIR
313 TRAFFICGEN_STC_TRAFFIC_PATTERN = "PAIR"
315 # The search mode used to find the throughput rate, COMBO, STEP or BINARY
316 TRAFFICGEN_STC_SEARCH_MODE = "BINARY"
318 # The learning mode used during the test, AUTO, L2_LEARNING, L3_LERNING, or NONE
319 TRAFFICGEN_STC_LEARNING_MODE = "AUTO"
321 # The minimum percent line rate that will be used during the test
322 TRAFFICGEN_STC_RATE_LOWER_LIMIT_PCT = "1.0"
324 # The maximum percent line rate that will be used during the test
325 TRAFFICGEN_STC_RATE_UPPER_LIMIT_PCT = "99.0"
327 # If SearchMode is BINARY, the percent line rate that will be used at the start of the test
328 TRAFFICGEN_STC_RATE_INITIAL_PCT = "99.0"
330 # When SearchMode is STEP, the percent increase in load per step
331 TRAFFICGEN_STC_RATE_STEP_PCT = "10.0"
333 # The minimum percentage of load adjustment between iterations
334 TRAFFICGEN_STC_RESOLUTION_PCT = "1.0"
336 # The frame size, in bytes
337 TRAFFICGEN_STC_FRAME_SIZE = "256"
339 # The maximum acceptable frame loss percent in any iteration
340 TRAFFICGEN_STC_ACCEPTABLE_FRAME_LOSS_PCT = "0.0"
342 # The address to assign to the first emulated device interface on the first east port
343 TRAFFICGEN_STC_EAST_INTF_ADDR = ""
345 # The gateway address to assign to the first emulated device interface on the first east port
346 TRAFFICGEN_STC_EAST_INTF_GATEWAY_ADDR = ""
348 # The address to assign to the first emulated device interface on the first west port
349 TRAFFICGEN_STC_WEST_INTF_ADDR = ""
351 # The gateway address to assign to the first emulated device interface on the first west port
352 TRAFFICGEN_STC_WEST_INTF_GATEWAY_ADDR = ""
354 # Print additional information to the terminal during the test
355 TRAFFICGEN_STC_VERBOSE = "True"
357 # Spirent TestCenter Configuration -- END
358 #########################################
360 #############################
361 # Xena Configuration -- BEGIN
363 # Xena traffic generator connection info
364 TRAFFICGEN_XENA_IP = ''
365 TRAFFICGEN_XENA_PORT1 = ''
366 TRAFFICGEN_XENA_PORT2 = ''
367 TRAFFICGEN_XENA_USER = ''
368 TRAFFICGEN_XENA_PASSWORD = ''
369 TRAFFICGEN_XENA_MODULE1 = ''
370 TRAFFICGEN_XENA_MODULE2 = ''
373 TRAFFICGEN_XENA_PORT0_IP = '192.168.199.10'
374 TRAFFICGEN_XENA_PORT0_CIDR = 24
375 TRAFFICGEN_XENA_PORT0_GATEWAY = '192.168.199.1'
376 TRAFFICGEN_XENA_PORT1_IP = '192.168.199.11'
377 TRAFFICGEN_XENA_PORT1_CIDR = 24
378 TRAFFICGEN_XENA_PORT1_GATEWAY = '192.168.199.1'
380 # Xena RFC 2544 options
381 # Please reference xena documentation before making changes to these settings
382 TRAFFICGEN_XENA_2544_TPUT_INIT_VALUE = '10.0'
383 TRAFFICGEN_XENA_2544_TPUT_MIN_VALUE = '0.1'
384 TRAFFICGEN_XENA_2544_TPUT_MAX_VALUE = '100.0'
385 TRAFFICGEN_XENA_2544_TPUT_VALUE_RESOLUTION = '0.5'
386 TRAFFICGEN_XENA_2544_TPUT_USEPASS_THRESHHOLD = 'false'
387 TRAFFICGEN_XENA_2544_TPUT_PASS_THRESHHOLD = '0.0'
389 # Xena RFC 2544 final verification options
390 TRAFFICGEN_XENA_RFC2544_VERIFY = False
391 TRAFFICGEN_XENA_RFC2544_VERIFY_DURATION = 120 # in seconds
392 # Number of verify attempts before giving up...
393 TRAFFICGEN_XENA_RFC2544_MAXIMUM_VERIFY_ATTEMPTS = 10
394 # Logic for restarting binary search, see documentation for details
395 TRAFFICGEN_XENA_RFC2544_BINARY_RESTART_SMART_SEARCH = True
397 # Xena Continuous traffic options
398 # Please reference xena documentation before making changes to these settings
399 TRAFFICGEN_XENA_CONT_PORT_LEARNING_ENABLED = True
400 TRAFFICGEN_XENA_CONT_PORT_LEARNING_DURATION = 3
402 # Xena Configuration -- END
403 ###########################
405 ###################################################
406 # MoonGen Configuration and Connection Info-- BEGIN
408 # Ex: TRAFFICGEN_MOONGEN_HOST_IP_ADDR = "192.10.1.1"
409 TRAFFICGEN_MOONGEN_HOST_IP_ADDR = ''
410 TRAFFICGEN_MOONGEN_USER = ''
411 TRAFFICGEN_MOONGEN_BASE_DIR = ''
412 TRAFFICGEN_MOONGEN_PORTS = ''
413 # Ex. 10 Gbps: TRAFFICGEN_MOONGEN_LINE_SPEED_GBPS = '10'
414 # Today only 10 Gbps is supported
415 TRAFFICGEN_MOONGEN_LINE_SPEED_GBPS = ''
417 # MoonGen Configuration and Connection Info-- END
418 ###################################################