Application Note Generating Chariot Traffic with Azimuth Director II Azimuth Channel Emulator 1 Table of Contents 1. Overview... 2 2. Introduction... 2 3. Configuring Chariot... 3 4. Generating Chariot Traffic Using Test Builder... 5 4.1 Outputs... 7 5. Generating Chariot Traffic Using the TCL API... 8 5.1 Required Parameters... 9 5.2 Optional Parameters... 11 6. Calling the TCL API... 12 7. Installing the Azimuth Relay Service... 14 8. Chariot Software and Documentation... 16 8.1 Documentation... 16 8.2 Software... 16 9. Summary... 16 1
1. Overview This application note talks about how to generate traffic using the latest Ixia Chariot 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 Ixia s Chariot is a cross-platform network testing tool that generates data streams. When we say generating traffic using Chariot, we mean using Azimuth s most recent Chariot automation module to create multiple, bidirectional Transmission Control Protocol (TCP) and User Datagram Protocol (UDP) data streams for controlled, standardized performance testing. Chariot traffic is generated between two Ethernet-connected devices running the Chariot Endpoint software, such as two computers or a phone and a computer. Within the Azimuth context Chariot 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 Chariot 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 that will interface with a Chariot Server, manage a set of traffic pairs, and return results to Director II. The Relay Service is described below and is installed with Director II; it can also be installed standalone on another PC as outlined in the Relay Service Installation section of this document. The general flow of the Chariot request traffic is as follows: 1. The process starts with either Director II or the TCL API specifying the IP address of the relay service computer and the traffic pairs to be used in the test. 2. The Relay Service instructs the Chariot server to generate traffic for each pair specified. 3. The Chariot server collects information from all endpoints in the traffic pair, processes the results, and responds back to the relay service with the results. The results are passed back to the calling process, which is either Director II or the TCL API. In the case of Director II, the results are in the Chariot module 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. 2
3. Configuring Chariot The section describes how to configure Chariot so you can use it from Director II s Test Builder or TCL API. 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 3
NOTE: If you have management addresses for your devices, you must also create endpoint devices for these management addresses. EXAMPLE: NETWORK ONE Director II PC at 192.168.3.10 Chariot Relay Server at 192.168.3.12 TEST NETWORK Chariot Server at 10.1.1.30 Chariot Endpoint at 10.1.1.50 In this case you must create 3 devices: 1) Relay Server The IP Address should be accessible from DII, or be the same IP as the DII PC if Chariot is installed on the same PC. 2) Relay Server Management The IP Address should be accessible from the User Endpoint. 3) Device Endpoint IP The IP Address should be accessible from the Relay Server Management address. In the case of iphone and Android, this IP is visible in the Chariot app. NOTE: The screenshot at right is from the official Chariot app store page. 4
4. Generating Chariot Traffic Using 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. Expand the Endpoints folder and 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 Endpoints devices to something meaningful to you (for this exercise will use the same names as the names of the devices): a. Single-left-click Endpoint 1 to select it, then singleleft-click to change the name. b. Repeat for Endpoint 2. 5. Click Next. 5
6. In Toolbox, scroll down until you find the Chariot module in the Traffic section. Drag and drop the module to the Execution Path section of the screen. Notice that Chariot module in the execution path is red; this indicates that some required settings have not been entered. 7. Click on the red Chariot module in the Execution Path window, and then set the required settings. In this case, we will set the Chariot Relay Endpoint and User Endpoint using the two Endpoint devices we created in Step 2, and configured for our test-bed in Step 7. 8. lick Execute. When the Chariot traffic generation has completed, you will see a checkmark in a green circle next to Chariot. The results will appear in the file Chariot Outputs. 9. Click on the file Chariot Outputs. The new devices can now be found by expanding External Devices/Endpoint Devices in the Testbed Manager window. 6
4.1 Outputs Max Avg MaxForPair1 MinForPair2 AvgForPair2 MaxForPair3 Delay PacketLostAvg JitterForPair1 DelayForPair2 PacketLostAvgForPair2 JitterForPair3 Min MinForPair1 AvgForPair1 MaxForPair2 MinForPair3 AvgForPair3 Jitter DelayForPair1 PacketLostAvgForPair1 JitterForPair2 DelayForPair3 PacketLostAvgForPair3 7
5. Generating Chariot Traffic Using the TCL API As mentioned earlier, Chariot traffic is generated between two Ethernet-connected devices running the Chariot software. This might be two computers, a phone and a computer, or any other two other devices connected via Ethernet. To generate traffic with the TCL API method, you manually type the TCL commands that call out to 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 Relay Service. Before you can generate traffic using the TCL library, you must install the relay service and the Chariot software on the user endpoint. If you have not already done so, click on this link for instructions: Relay Service Installation. Details for acquiring the Chariot software can be found here, under Chariot Software and Documentation. Due to the enhancements in Chariot, Director II and the TCL API will always execute on the Relay Service using the -c parameter. When setting up the Chariot 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 Chariot 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 Relay Service Installation section of this document. Only two parameters are mandatory for Chariot traffic to be generated: (1) the Chariot Relay Endpoint and (2) the user endpoint. Both the Chariot Relay Endpoint and the UE are IP addresses. 8
5.1 Required Parameters Chariot Relay Collection of Traffic Pairs (must have at least one pair: see screenshot below) 9
1. Fill in Chariot Relay with the address of the Relay Server. 2. Open Collection of Traffic Pairs and click Add to add a pair. Source must be the Pair Traffic Source, and Destination must be the Pair Traffic Destination. If there is a Management address for the Source and Destination, they must be filled in as well; otherwise these can be the same as the source/destination.) The default uses the script High_Performance_Throughput.scr for TCP and Unlimited throughput. If this is a VOIP pair, change the VOIP to Yes and fill in the settings below. ry 13 of 19 10
5.2 Optional Parameters OPTION DESCRIPTION EXAMPLE / DEFAULT -array Array name to return results of Chariot run. Example: userdata -callback -duration Takes one of two possible values: 1 callback requested 0 wait for test to complete Specifies the duration of the Chariot. The durationunits specifies the duration unit. Default Value: 0 Default Value: 5 -durationunits Specifies the unit of duration in seconds or packets. Default Value: seconds -bidirection -relayip -pairlist -script -e1alt -e2alt Specifies traffic direction. Possible values: 1 traffic requested in both directions 0 traffic goes from Endpoint1 to Endpoint2 Specifies the IP address of remote. Chariot console specifies that there is no alternate address IP address in dotted decimal notation. Specifies the list of parameters for pairs of Endpoints. Mandatory parameters: paire1 paire2 Optional parameters: paire1alt paire2aot pairbidirection pairdatate pairqos pairscript Script name expected in scripts directory of Chariot Console Alternate address for Chariot console to know Endpoint1. Specifies that there is an alternate IP address in dotted decimal notation. Alternate address for Chariot console to know Endpoint2. Specifies that there is an alternate IP address in dotted decimal notation. Default Value: 0 Default Value: throughput.scr -protocol Specifies the protocol for Chariot traffic. Default Value: TCP -packetsize Specifies the packet size for Chariot traffic. Default Value: DEFAULT -samplesize Specifies the sample size. Default Value: 200000 -datarate Specifies the data rate. Default Value: UNLIMITED -outputfile -qos -stmlist Specifies the file name in which the Chariot test results will be saved in the Chariot console. Specifies the QoS type to be used in Chariot traffic. Specifies the list of STMs to be initialized (registry settings) for QoS traffic. 11
6. Calling 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 and press return. >cmd8 2. Right-click on cmd.exe and select Run as administrator. Answer Yes to the User Account Control query. START tclsh.exe8 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. This may bring up a Windows Security Alert. If so, click Allow Access. 12
5. Enter the following code by either typing each line or copying and pasting the entire body, beginning with the line #Get the required package(s). Copy only the words in red. Complete Code Example ################################### # Chariot traffic generation ################################### #Get the required package(s) package require Azimuth-Traffic #Create/Set the required parameters set param(sourceip) 127.0.0.1 set param(destip) 127.0.0.1 set param(servicehostendpoint) 127.0.0.1 array set dataarray {} set arglist {} traffic_send_chariot $param(sourceip) $param(destip) -duration 20 -array dataarray -relayip $param(servicehostendpoint)# Display everything in the results array parray dataarray 6. Click Exit 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 that found here. 13
7. Installing the Azimuth Relay Service This section will show you how to install the Azimuth Relay Service. 1. Create an account by selecting a Security Entity (the name might be different in your particular configuration), choosing Admin/Manage Accounts, and clicking Add. 2. 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.) Click Next to continue. 3. Click I Agree to the License Agreement query. 4. Answer Yes to the User Account Control query. 14
5. At Install Location, click Next. Note: The Relay Service and the UE must be on the same network for traffic to work. 6. Choose Chariot Relay and click Next. You should immediately see the Installing message and the progress bar. Installation may take several minutes to complete. Once the installation has completed, click Close. y 18 of 19 15
8. Chariot Software and Documentation Documentation and software downloads for Chariot can be found in the following locations. 8.1 Documentation You will find more documentation on Chariot at Ixia User Guides. 8.2 Software Installation Typically, when Chariot is installed and licensed on the computer, all users have access to the license. If Ixia s Chariot software was licensed for only one particular user, you must pick Custom User and provide the user name/password to the installer when prompted. The Azimuth Relay Server will be installed and run as the specific user in that case. Chariot Device Setup In addition to installing Ixia Chariot on the server, you may need to install and run endpoint software on your devices under test. Endpoints can be downloaded here: https://support.ixiacom.com/support-links/ixchariot/endpoint-library/platform-endpoints On some devices, like an Android phone or an iphone, you may have to open the app after installation and check Allow Running in Background. NOTE: Screenshot is from the official Ixia Chariot app store page. When using the Android or iphone/ipad Chariot 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 will be supposed from the options selected in either Director II or the TCL API. 9. Summary In this application note, you learned two ways to generate traffic using Chariot one using the TCL API, and another using Test Builder. 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: 1-800-267-4878 Phone: +1-972-644-1777 Fax: +1-972-671-1877 Canada Anritsu Electronics Ltd. 700 Silver Seven Road, Suite 120, Kanata, Ontario K2V 1C3, Canada Phone: +1-613-591-2003 Fax: +1-613-591-1006 Brazil Anritsu Eletronica Ltda. Praça Amadeu Amaral, 27-1 Andar 01327-010 - Bela Vista - Sao Paulo - SP Brazil Phone: +55-11-3283-2511 Fax: +55-11-3288-6940 Mexico Anritsu Company, S.A. de C.V. Av. Ejército Nacional No. 579 Piso 9, Col. Granada 11520 México, D.F., México Phone: +52-55-1101-2370 Fax: +52-55-5254-3147 United Kingdom Anritsu EMEA Ltd. 200 Capability Green, Luton, Bedfordshire, LU1 3LU, U.K. Phone: +44-1582-433200 Fax: +44-1582-731303 France Anritsu S.A. 12 avenue du Québec, Bâtiment Iris 1- Silic 612, 91140 VILLEBON SUR YVETTE, France Phone: +33-1-60-92-15-50 Fax: +33-1-64-46-10-65 Germany Anritsu GmbH Nemetschek Haus, Konrad-Zuse-Platz 1 81829 München, Germany Phone: +49-89-442308-0 Fax: +49-89-442308-55 Printed on Recycled Paper Italy Anritsu S.r.l. Via Elio Vittorini 129, 00144 Roma, Italy Phone: +39-6-509-9711 Fax: +39-6-502-2425 Sweden Anritsu AB Kistagången 20B, 164 40 KISTA, Sweden Phone: +46-8-534-707-00 Fax: +46-8-534-707-30 Finland Anritsu AB Teknobulevardi 3-5, FI-01530 VANTAA, Finland Phone: +358-20-741-8100 Fax: +358-20-741-8111 Denmark Anritsu A/S Torveporten 2, 2500 Valby, Denmark Phone: +45-7211-2200 Fax: +45-7211-2210 Russia Anritsu EMEA Ltd. Representation Office in Russia Tverskaya str. 16/2, bld. 1, 7th floor. Moscow, 125009, Russia Phone: +7-495-363-1694 Fax: +7-495-935-8962 Spain Anritsu EMEA Ltd. Representation Office in Spain Edificio Cuzco IV, Po. de la Castellana, 141, Pta. 5 28046, Madrid, Spain Phone: +34-915-726-761 Fax: +34-915-726-621 United Arab Emirates Anritsu EMEA Ltd. Dubai Liaison Office 902, Aurora Tower, P O Box: 500311- Dubai Internet City Dubai, United Arab Emirates Phone: +971-4-3758479 Fax: +971-4-4249036 India Anritsu India Private Limited 2nd & 3rd Floor, #837/1, Binnamangla 1st Stage, Indiranagar, 100ft Road, Bangalore - 560038, India Phone: +91-80-4058-1300 Fax: +91-80-4058-1301 Singapore Anritsu Pte. Ltd. 11 Chang Charn Road, #04-01, Shriro House Singapore 159640 Phone: +65-6282-2400 Fax: +65-6282-2533 P.R. China (Shanghai) Anritsu (China) Co., Ltd. Room 2701-2705, Tower A, New Caohejing International Business Center No. 391 Gui Ping Road Shanghai, 200233, P.R. China Phone: +86-21-6237-0898 Fax: +86-21-6237-0899 P.R. China (Hong Kong) Anritsu Company Ltd. Unit 1006-7, 10/F., Greenfield Tower, Concordia Plaza, No. 1 Science Museum Road, Tsim Sha Tsui East, Kowloon, Hong Kong, P.R. China Phone: +852-2301-4980 Fax: +852-2301-3545 Japan Anritsu Corporation 8-5, Tamura-cho, Atsugi-shi, Kanagawa, 243-0016 Japan Phone: +81-46-296-1208 Fax: +81-46-296-1248 Korea Anritsu Corporation, Ltd. 5FL, 235 Pangyoyeok-ro, Bundang-gu, Seongnam-si, Gyeonggi-do, 13494 Korea Phone: +82-31-696-7750 Fax: +82-31-696-7751 Australia Anritsu Pty. Ltd. Unit 20, 21-35 Ricketts Road, Mount Waverley, Victoria 3149, Australia Phone: +61-3-9558-8177 Fax: +61-3-9558-8255 Taiwan Anritsu Company Inc. 7F, No. 316, Sec. 1, NeiHu Rd., Taipei 114, Taiwan Phone: +886-2-8751-1816 Fax: +886-2-8751-1817 1706 Printed in Japan 2017-10 MG No. AZCHEM-E-F-2-(1.00)