Generating iperf Traffic with Azimuth Director II

Transcription

1 Application Note Generating iperf Traffic with Azimuth Director II Azimuth Channel Emulator Table of Contents 1. Overview Introduction Generating iperf Traffic Using Director II Setting up the Director II Test-bed Setting up Test Builder Example Json Output Generating iperf Traffic Using the TCL API Optional Parameters Calling the iperf3 module using the TCL API Azimuth Relay Service Installation iperf Software and Documentation Documentation Software Summary... 15

2 1. Overview This application note talks about how to generate traffic using the latest iperf software within the Azimuth Systems context using two different approaches: Azimuth s Director II Test Executive and the TCL (Transmission Control Language) API. 2. Introduction iperf is a cross-platform network testing tool that generates data streams. When we say generating traffic using iperf, we mean using Azimuth s most recent iperf automation module *1 to create multiple, bidirectional Transmission Control Protocol (TCP) and User Datagram Protocol (UDP) data streams for controlled, standardized performance testing. iperf traffic is generated between two Ethernet-connected devices running the iperf3 software, such as two computers or a phone and a computer. Within the Azimuth context, iperf traffic can be generated in one of two ways: 1. Using the graphical user interface in the Director II application (Test Builder). This approach is the simplest and most direct. You select the iperf module through Test Builder from the Traffic section of the toolbox, just as you would any other test module. 2. Using the TCL API. This requires entering some simple code and parameters, the details of which are explained later in this document. Both methods require the Azimuth Relay Service; this is an extension of Director II and runs the iperf3 software, using iperf3 parameters from/returning results to Director II or TCL. Azimuth Relay Service is installed with Director II and can be installed standalone on another PC as outlined in the Azimuth Relay Service Installation section of this document. The general flow of the iperf request traffic is as follows: 1. The process starts with either Director II or the TCL API specifying the IP address of the user endpoint and the iperf Relay Endpoint (the IP address of the computer running the Azimuth Relay Service). The Azimuth Relay Service and the user endpoint must be on the same network for the iperf3 software to work. 2. The Azimuth Relay Service executes the iperf3 software, specifying the user endpoint IP address and the -c parameter, along with any other optional parameters specified. 3. The UE (running iperf3 software) processes the iperf traffic and responses back to the Azimuth Relay Service with the results. The results are then passed back to the calling process, either Director II or the TCL API. In the case of Director II, the results are in the iperf outputs. In the case of the TCL API, the results are in the dataarray parameter. Later sections of the document will cover both methods in more detail. *1: The version at the time of publication is

3 3. Generating iperf Traffic Using Director II The section describes how to configure iperf so you can use it from Director II s Test. 3.1 Setting up the Director II Test-bed 1. Open the Director-II application by clicking Start/Azimuth Director-II/Azimuth Director-II. 2. Create two new external devices by rightclicking on External Devices and selecting the desired device in the Testbed Manager window. For the purpose of this example we will choose endpoint devices, so select Add Endpoint Device. 3. After entering the information, click the OK button to add the device. The new devices can now be found by expanding External Devices/Endpoint Devices in the Testbed Manager window NOTE: Both the iperf Relay Endpoint (IP address of the computer running the Azimuth Relay Service) and the User Endpoint have to be on the same network. 3

4 3.2 Setting up Test Builder 1. Click on the Test Builder tab just below the Test Manager tab in the lower left-hand corner of the Director II window. 2. Under Device Selection, click on Test Builder and expand the Endpoints folder. (The Device Selection menu is located just to the right of the Test Builder window.) 3. Double-click on each of the endpoint devices you created in Step 2. This will add the two devices to the window just to the right of the Device Selection window. 4. Change the name of the Ethernet devices to something meaningful to you (for this exercise will use the same names as the devices name): a. Single-left-click Endpoint 1 to select it, then single-left-click to change the name. b. Repeat for Endpoint Click Next. 4

5 6. In Toolbox, scroll down until you find the iperf3 module in the Traffic section. Drag and drop the module to the Execution Path section of the screen. Notice that iperf3 module in the execution path is red; this indicates that some required settings have not been entered. 7. Click on the red iperf3 module in the Execution Path window, and then set the required settings. In this case, we will set the iperf Relay Endpoint and User Endpoint using the two Endpoint devices we created in Step 2, and configured for our test-bed in Step 7. 5

6 8. Click Execute. When the iperf traffic generation has completed, you will see a checkmark in a green circle next to iperf3. The results will appear in the file iperf3 Outputs. 9. Click on the file iperf3 Outputs. OUTPUT FILE NOTES iperf Response: Populated with the JSON output from iperf when your run duration is under 30 seconds. We limit JSON output for sessions of >30 to prevent memory issues that could be created by large amounts of text generated by the iperf3 software. Total MB: Refers to total megabytes sent/received, and is dependent on the iperf -R parameter or reverse mode. Total Mb: The overall throughput in megabits per second. Command Line Parameters Used: Represents the iperf3 command line parameters used during the run. 6

7 3.3 Example Json Output 7

8 4. Generating iperf Traffic Using the TCL API As mentioned earlier, iperf traffic is generated between two Ethernet-connected devices running the iperf3 software. This might be two computers, a phone and a computer, or any other two other devices connected via Ethernet capable of running the iperf3 software. To generate traffic with the TCL API method, you manually type the TCL commands that call out to Azimuth Relay Service to initiate the communication to the User Endpoint (UE). As was also mentioned earlier, both this method and the Director II Test Builder module method require that you install the Azimuth Relay Service. Before you can generate traffic using the TCL library, you must install the Azimuth Relay Service and the iperf3 software on the user endpoint. If you have not already done so, click on this link for instructions: Azimuth Relay Service Installation. Details for acquiring the iperf3 software can be found here, under iperf Software and Documentation. Due to the enhancements in iperf3, Director II and the TCL API will always execute on the Azimuth Relay Service using the -c parameter. When setting up the iperf3 software on the UE, the UE only needs to be set up to run with the -s parameter. Assumptions: If you are choosing this method rather than the Director II method, you must have an understanding of TCL. Requirements: Azimuth Relay Service a UE with the iperf3 software Director II Note: Installing Director II also installs the Azimuth Relay Service. This can also be installed standalone on another PC as outlined in the Azimuth Relay Service Installation section of this document Only two parameters are mandatory for iperf traffic to be generated: (1) the iperf Relay Endpoint (IP address of the computer running the Azimuth Relay Service) and (2) the user endpoint. Both the iperf Relay Endpoint and the UE are represented by IP addresses. 8

9 4.1 Optional Parameters The following is a list of the parameters. The dash surrounded by parentheses represents the iperf3 parameter name. Required: (-c) servicehostendpoint iperf Relay Endpoint that is hosting the iperf service (this will be running iperf with -c) Optional: (-b) Bandwidth Target bandwidth in bits/sec (0 for unlimited) Optional: (-t) Duration Time in seconds to transmit for (default 10 secs) Default Value: 10 Optional: (-l) LengthOfBuffer Length of buffer to read or write. Optional: (-k) NumberOfBlocks Number of blocks (packets) to transmit (instead of -t or -n) Optional: (-n) NumberOfBytesToTransmit Number of bytes to transmit (instead of -t) Optional: (-o) Omit Omit the first n seconds Optional: (-p) Parallel Number of parallel client streams to run Required: (-s) deviceendpoint User Endpoint that will send or receive traffic with iperf Relay Endpoint (this must be running iperf with -s) Optional: (-R) ReverseMode Downlink (iperf Relay Endpoint sends, User Endpoint receives) Uplink (iperf Relay Endpoint receives, User Endpoint sends) Values: Downlink/Uplink Default Value: Uplink Optional: (-M) TCP_SCTPMaximumSegmentSize Set TCP/SCTP maximum segment size (MTU 40 bytes) Optional: (-N) TCP_SCTPNoDelay Set TCP/SCTP no delay, disabling Nagle s Algorithm Values: true/false Default Value: false Optional: (-S) TypeOfService Set the IP type of service Optional: (-u) UseUDP - Communicate to the server via TCP or UDP Values: TCP/UDP Default Value: TCP Optional: (-w) WindowSize Set window size / socket buffer size Optional: (-4 or -6) IPVersion Communicate to the server via IPv4 or IPv6 Values: Auto, IPv6, IPv4 Default Value: Auto 9

10 4.2 Calling the iperf3 module using the TCL API The following steps will guide you through calling the iperf3 module using the TCL API. 1. To open a command prompt with elevated access to execute the tclch.exe program, left-click on the Windows Start icon. At the prompt, type cmd. >cmd 2. Right-click on cmd.exe and select Run as administrator. Answer Yes to the User Account Control query. 3. Change to the Director II folder. CD C: Program Files (x86) Azimuth Director-II bin 4. Start a TCL window to begin entering the example code. START tclsh.exe8 This may bring up a Windows Security Alert. If so, click Allow Access. 10

11 5. Enter the following code either by typing each line or by copying and pasting the entire body, beginning with the line #Get the required package(s). (Do not copy the words in blue.) Complete Code Example ################################### # iperf traffic generation ################################### #Get the required package(s) package require Azimuth-Traffic #Create/Set the required parameters set param(destip) set param(servicehostendpoint) array set dataarray {} set arglist {} # Generate traffic traffic_send_iperf3 $param(servicehostendpoint) $param(destip) $arglist dataarray # Display everything in the results array parray dataarray # Display each output individually #If Duration <30 seconds JSON output from iperf puts $dataarray(rawoutput) #Total MB sent/recieved puts $dataarray(total_m B) #Total Mb per second puts $dataarray(total_mb_overall_throughput) #Parameters sent to the UE puts $dataarray(commandlineparametersused) 11

12 We limit JSON output for sessions of under 30 seconds to prevent memory issues that might be created by large amounts of text generated by the iperf software. 6. Type Exit 8 and press enter in the TCL window to exit and close the window. (If you chose not to START tclsh.exe and simply executed tclsh.exe from the command prompt, then Exit will close the TCL window If you wish to send all of the Optional information, you can do so using code similar to the following substituting VALUE for your desired value: set arglist "" append arglist " -Bandwidth VALUE" append arglist " -Duration VALUE " append arglist " -IPVersion VALUE " append arglist " -LengthOfBuffer VALUE " append arglist " -NumberOfBlocks VALUE " append arglist " -NumberOfBytesToTransmit VALUE " append arglist " -Omit VALUE " append arglist " -Parallel VALUE " append arglist " -ReverseMode VALUE " append arglist " -TCP_SCTPMaximumSegmentSize VALUE " append arglist " -TCP_SCTPNoDelay VALUE " append arglist " -TypeOfService VALUE " append arglist " -UseUDP VALUE" append arglist " -WindowSize VALUE " 12

13 5. Azimuth Relay Service Installation This section will show you how to install the Azimuth Relay Service. 1. Locate and double-click on Relay-Setup.exe to bring up the Relay Setup Wizard (It will be in the same directory as Director II setup program). Answer Yes to the User Account Control query and Click Next to continue. 2. Click I Agree to the License Agreement query. 3. At Install Location, click Next. 13

14 Note: The Relay Service and the UE must be on the same network for traffic to work. 4. Choose iperf Relay and click Next. You should immediately see the Installing message and the progress bar. Installation may take several minutes to complete. 5. Once the installation has completed, click Close. 14

15 6. iperf Software and Documentation Documentation and software downloads for iperf3 can be found in the following locations. 6.1 Documentation You will find more documentation on iperf at Software Full Listing iphone/ipad Android Windows 64 Windows 32 Mac OS When using the Android or iphone/ipad iperf3 software all that is necessary is to tap the input box supplied and enter -s and select Go. All other parameters such as Reverse Mode are supplied from the options selected in either Director-II or the TCL API. 7. Summary In this application note, you learned two ways to generate traffic using iperf one using the TCL API, and another using Test Builder. 15

16 Specifications are subject to change without notice. United States Anritsu Company 1155 East Collins Blvd., Suite 100, Richardson, TX 75081, U.S.A. Toll Free: Phone: Fax: Canada Anritsu Electronics Ltd. 700 Silver Seven Road, Suite 120, Kanata, Ontario K2V 1C3, Canada Phone: Fax: Brazil Anritsu Eletronica Ltda. Praça Amadeu Amaral, 27-1 Andar Bela Vista - Sao Paulo - SP Brazil Phone: Fax: Mexico Anritsu Company, S.A. de C.V. Av. Ejército Nacional No. 579 Piso 9, Col. Granada México, D.F., México Phone: Fax: United Kingdom Anritsu EMEA Ltd. 200 Capability Green, Luton, Bedfordshire, LU1 3LU, U.K. Phone: Fax: France Anritsu S.A. 12 avenue du Québec, Bâtiment Iris 1- Silic 612, VILLEBON SUR YVETTE, France Phone: Fax: Germany Anritsu GmbH Nemetschek Haus, Konrad-Zuse-Platz München, Germany Phone: Fax: Printed on Recycled Paper Italy Anritsu S.r.l. Via Elio Vittorini 129, Roma, Italy Phone: Fax: Sweden Anritsu AB Kistagången 20B, KISTA, Sweden Phone: Fax: Finland Anritsu AB Teknobulevardi 3-5, FI VANTAA, Finland Phone: Fax: Denmark Anritsu A/S Torveporten 2, 2500 Valby, Denmark Phone: Fax: Russia Anritsu EMEA Ltd. Representation Office in Russia Tverskaya str. 16/2, bld. 1, 7th floor. Moscow, , Russia Phone: Fax: Spain Anritsu EMEA Ltd. Representation Office in Spain Edificio Cuzco IV, Po. de la Castellana, 141, Pta , Madrid, Spain Phone: Fax: United Arab Emirates Anritsu EMEA Ltd. Dubai Liaison Office 902, Aurora Tower, P O Box: Dubai Internet City Dubai, United Arab Emirates Phone: Fax: India Anritsu India Private Limited 2nd & 3rd Floor, #837/1, Binnamangla 1st Stage, Indiranagar, 100ft Road, Bangalore , India Phone: Fax: Singapore Anritsu Pte. Ltd. 11 Chang Charn Road, #04-01, Shriro House Singapore Phone: Fax: P.R. China (Shanghai) Anritsu (China) Co., Ltd. Room , Tower A, New Caohejing International Business Center No. 391 Gui Ping Road Shanghai, , P.R. China Phone: Fax: P.R. China (Hong Kong) Anritsu Company Ltd. Unit , 10/F., Greenfield Tower, Concordia Plaza, No. 1 Science Museum Road, Tsim Sha Tsui East, Kowloon, Hong Kong, P.R. China Phone: Fax: Japan Anritsu Corporation 8-5, Tamura-cho, Atsugi-shi, Kanagawa, Japan Phone: Fax: Korea Anritsu Corporation, Ltd. 5FL, 235 Pangyoyeok-ro, Bundang-gu, Seongnam-si, Gyeonggi-do, Korea Phone: Fax: Australia Anritsu Pty. Ltd. Unit 20, Ricketts Road, Mount Waverley, Victoria 3149, Australia Phone: Fax: Taiwan Anritsu Company Inc. 7F, No. 316, Sec. 1, NeiHu Rd., Taipei 114, Taiwan Phone: Fax: Printed in Japan MG No. AZCHEM-E-F-3-(1.00)