Candela Technologies
http://www.candelatech.com
sales@candelatech.com
+1 360 380 1618 [PST, GMT -8]

LANforge-GUI User Guide

Table of Contents

Overview

  1. Getting Started & Logging In
  2. LANforge Manager
  3. Netsmith:  Virtual Network Configurator
  4. Client Administration and Client Login
  5. Test Managers
  6. Layer-3 Cross-Connects (FIRE)
  7. Layer-3 Endpoints (FIRE)
  8. VoIP Call Generator (H.323, SIP, RTP, RTCP)
  9. VoIP Endpoints
  10. Audio/Visual Connections
  11. Audio/Visual Endpoints
  12. Armageddon (Accelerated UDP)
  13. WanLinks (ICE)
  14. Collision Domains (ICE)
  15. File Endpoints
  16. Layer 4-7 Endpoints (FTP, HTTP, etc.)
  17. Generic (User) Endpoints (ping, traceroute, etc.)
  18. Resources (Data Generator Machines)
  19. Serial Spans (PPP/T1, PPP/E1)
  20. Creating & Modifying PPP Interfaces (Serial, PPPoE)
  21. Ports (Interfaces)
  22. Command Output
  23. Pull-Down Options

 


Candela Technologies, Inc., 2026 Main Street, Suite A, P.O. Box 3285, Ferndale, WA 98248, USA
www.candelatech.com | sales@candelatech.com | +1 360 380 1618


Overview

The LANforge-GUI is a Graphical management interface to the LANforge system. The GUI connects to the LANforge manager process, which automatically discovers the LANforge Data Generators (also called 'Resources') on its management network. Because the connection to the server is a standard TCP/IP interface, the GUI can access the server remotely, even over a low bandwidth connection. The GUI has extensive 'tooltip' support, so if you are unsure of what a particular field or option box does, momentarily hold the mouse cursor over the field of interest and you should see a small description.

Clicking the 'HELP' button will pop up a window using your default browser displaying the specific section of the LANforge GUI User Guide relating to the selected tab on the GUI display. Note for Windows Vista users: Clicking 'HELP' will not direct the browser to the specific section of the User Guide, but will default to the Table of Contents.

For a some ideas on how to test specific architectures and protocols, see the:
LANforge Network Tester Overview and/or the cookbooks: LANforge-GUI FIRE Cookbook LANforge-GUI ICE Cookbook.


  1. Getting Started & Logging In

    After installing the LANforge-GUI, you are ready to begin. First, start up the LANforge-GUI. Two windows should pop up, one of which is a login window that looks something like this:

    LANforge-GUI Splash Screen

    Enter the name or IP address of the LANforge server that you wish to connect to. If you are running the GUI on the same machine as the LANforge server, then you can enter 'localhost' here. Note that the default server port is 4002, but this could be different depending on how the LANforge server was installed. You can also click the 'Discover' button to have the GUI discover other LANforge systems on the local subnet. Newly discovered systems are added to the drop-down menu and can then be selected. After entering the correct information or selecting the server from the drop-down menu, click the 'Connect' button, and the GUI will attempt to connect to the server. If the server is re-started, or if the connection from the GUI to the server is lost for any other reason, the GUI will attempt to reconnect to the server every 5 seconds.

    The last 20 servers that you logged into will be added to the drop-down menu for ease of use when re-connecting. If you ever want to re-initialize the list, remove the lfcnf.txt file that is in the LANforge-GUI installation directory and re-start the GUI. A new file will be created the next time you connect to the server.

    For Windows Vista users, note that the lfcnf.txt file will be in the following location:
    C:/Users/[username]/AppData/Local/VirtualStore/Program Files/LANforge-GUI

  2.  


    Candela Technologies, Inc., 2026 Main Street, Suite A, P.O. Box 3285, Ferndale, WA 98248, USA
    www.candelatech.com | sales@candelatech.com | +1 360 380 1618


  3. LANforge Manager

    After you have connected to the server, the splash screen will disappear and the LANforge Manager window will appear with the Status tab displayed:

    LANforge-GUI Status Pane

    The Status Tab contains the following management panels:

  4.  


    Candela Technologies, Inc., 2026 Main Street, Suite A, P.O. Box 3285, Ferndale, WA 98248, USA
    www.candelatech.com | sales@candelatech.com | +1 360 380 1618


  5. Netsmith: Virtual Network Configurator

    LANforge includes the Netsmith graphical configurator for virtual routers, LANforge-FIRE, and LANforge-ICE testing scenarios. Please be aware that the Virtual Router functionality only works when the LANforge resource servers are running on Linux. The updated iputils program and the Candela kernel (or a kernel with the Candela patch applied) is also required. If you purchase a LANforge system (as opposed to software-only), this will all come pre-installed. If you are installing the software on your own system, please read the install guide(s) carefully.

    Open Netsmith by clicking the 'Netsmith' button located below one of the the resources on the Virtual Shelf display. When the Netsmith tool is first opened, it will auto-create as much as possible based on the current system configuration and resources. The positioning of the objects will most likely need to be changed. For most objects, just click-and-drag them to the new location using the mouse. Some objects, such as FIRE cross-connect (CX) representations are not independently draggable, but you can drag the port endpoints to reposition the FIRE CXs.

    LANforge-GUI Netsmith

    You can left-click and drag to create a selection box, and then drag or modify all of the objects inside or intersecting the box at once.

    In general, you can click-and drag to move, double-click to modify, and right-click on objects to get a menu of specific tasks for each object or group of objects.

    Here is an example of how to create a simple routed network emulation using three physical ports and one virtual router. This will emulate a central location with a 10Mbps network connection, and 2 remote sites with 1.54Mbps T1 connections, all connected through a routed network.
    For more examples, please see the LANforge-GUI FIRE Cookbook and LANforge-GUI ICE Cookbook.



    Step Screenshot
    1. Open the Netsmith tool by clicking the 'Netsmith' button located on the bottom panel of the Status tab display.
    2. Three ethernet interfaces will be used in this example: eth0, eth1, and eth2. Ethernet interfaces can be clicked and dragged from their default location at the bottom-left corner of the display to the center for clarity. Clicking the 'Apply' button at the bottom-right of the Netsmith window will save their locations on the display. Double-click eth0 to display the Create/Modify Connection window and modify its connection.
    3. Deselect the 'Skip' checkbox to the right of 'WanLink:', 'Port 2-B:' and 'Port 2-A' to "un-skip" these connections in the Create/Modify Connection window. This will automatically create new entities as needed. Click 'OK' to save the changes.
    4. Double-click eth1 and eth2 and follow the same steps as above. When completed, right-click in a blank area within the window and select 'New Router.' This will display the Create/Modify Virtual Router window.
    5. A router name will be automatically assigned (e.g., R0) or a different name can be typed in the 'Name:' field if desired. Click 'OK' when complete.
    6. Drag the rddVRXX sides of the connections into the newly created virtual router. Click the 'Apply' button to create the new ports and WanLinks.
    7. You should see the newly created objects go from red squares to green and black boxes. The WanLinks (red rectangles) will turn green when started.
    8. Right-click on each rddVRXX interface in the virtual router and select 'Modify Port' to add the appropriate IP Address, IP MASK, and Gateway IP. The default gateway for each port will be the IP address of the corresponding rddVRXX port in the virtual router. Selecting the 'IPv4s' or 'IPv6s' checkboxes on the bottom panel will display IPv4 or IPv6 addresses, respectively, on the Netsmith display.
    9. If this is to be part of a larger routed network, then you can double-click the port(s) in the virtual router and set the 'Next-Hop' and up to eight subnets that will be using this next hop. Please note that 0.0.0.0/0 is a valid subnet, and simply means 'ANY.' This is one way to set the default gateway for all unknown traffic. Click 'OK' when done modifying the Virtual Router.
    10. When all of the ports in the Virtual Router have appropriate IPs, and the connection has the proper next-hops and subnets, click 'Apply' to flush the changes to the LANforge server and create the proper routing tables.
    11. Modify the WanLinks by right-clicking the green (running) or red (stopped) rectangles and selecting 'Modify WanLink.' Set the transfer rate to 10Mbps on one, and 1.54Mbps on the other two. Set latency and other changes as required and click 'OK.'
    12. Start each WanLink by right-clicking its colored rectangle and selecting 'Toggle WanLink.' After completing changes in Netsmith, click the 'Apply' button to flush the changes to the LANforge server.
    13. Connect your network equipment to ports eth0, eth1, and eth2. Your network equipment should now be able to ping through LANforge and you should see the latency that was configured in the WanLinks.

    Virtual Routers

    To create a new Virtual Router, right-click in a blank area within the Netsmith window and select 'New Router.' This will bring up the Create/Modify Virtual Router window:

    Virtual Router Configuration

    LANforge will generate a name automatically unless one is entered. The name, graphical size, notes field and other router configuration flags can all be modified when created or at a later time. The virtual router will use simple subnet routing rules unless otherwise directed. Xorp must be installed before using the OSPF, Multicast, or Xorp SHA routing features.

    Use OSPF
    Select this checkbox if the virtual router is to use Open Shortest Path First (OSPF) routing protocol.

    Multicast
    Select this checkbox if the virtual router is to route multicast traffic.

    Xorp SHA
    This function is specific to a particular OEM.

    IPv6 Router
    Select this checkbox if the virtual router is to route IPv6 traffic.

    IPv6 RADV
    IPv6 RADV protocol will automatically assign IPv6 addresses to other hosts on network interfaces in this virtual router.

    After creating a virtual router, existing interfaces can be dragged into it or new virtual devices can be created and associated to it. In order to be accessible to outside objects, however, the Virtual Router must either contain an interface (Port) that connects to the outside world or be connected to another Virtual Router that eventually connects to the outside world.

    Netsmith Connections

    Netsmith Connections are used to connect routers to each other and to connect routers to the outside world. To create a new Netsmith Connection, right-click in a blank area within the Netsmith window and select 'New Connection.' This will bring up the Create/Modify Connection window:

    Router Connection

    You can choose up to 4 ports and one WanLink to be part of this connection. The number and combination of ports/WanLink selected changes the behavior significantly. In the example below, it is assumed that Port-1 will be the 'outside' port, but Router Connections do not have an inherent direction...it all depends on how you configure it.

    Right-Click Menus

    Most objects have right-click menus associated with them to perform various actions. You cannot click on the connecting lines or the 'B' ports at this time.

    Visual Display

    The Netsmith window provides a real-time view of WanLinks and other LANforge entities. A legend for each type of entity is shown in the upper-left portion of the Netsmith window. Any objects drawn as a red square are not currently found in the LANforge system, even though the Netsmith has been configured such that they (should) exist. This can happen if interfaces or WanLinks were removed after Netsmith had discovered them, or if new WanLinks or connections have been created in Netsmith, but the changes have not been Applied yet. If these should really be deleted, just right-click and delete the offending objects and Apply the changes.

    Display Options

    The checkboxes at the bottom of the Netsmith window can be used to display or hide various details to suit the user's preference. Selecting or deselecting these flags will not affect the actual configuration of LANforge in any way.

    Netsmith Buttons

    There are several buttons at the bottom-right of the Netsmith window.

  6.  


    Candela Technologies, Inc., 2026 Main Street, Suite A, P.O. Box 3285, Ferndale, WA 98248, USA
    www.candelatech.com | sales@candelatech.com | +1 360 380 1618


  7. Client Administration and Client Login

    The LANforge security and administration framework has a concept of Users (clients), Test Managers, and Cross-Connects. Test Managers are a grouping of one or more clients and 0 or more Cross-Connects. Any user belonging to a Test Manager can manage any of the Cross-Connects belonging to that Test Manager. As a special case, WanPaths can also be assigned to a Test Manager.

    When you first log into the LANforge system through the GUI, you will be logged in as the user 'default'. The GUI will then try to log you in as user 'Admin'. If a password has been set for Admin and if the user 'default' does NOT have Administrator privileges, that login will fail and the login window will pop up to allow the user to change users and/or enter the correct password. If there will only be a few different testers using the LANforge system at any given time, you may never need to create a new user, and if you are not worried about who uses LANforge, there is no need to set an Admin password. However, it may be useful to do so if you have a larger group of users, or if communication between the users is not easy.

    To log in as a particular user, select 'Client Admin or Login' from the Control pull-down menu. You will get a screen that looks like this:

    LANforge-GUI Client Screen

    The existing clients are shown to the left, with the details of a particular client, including name, Admin status and some other flags. To select a client for modification, double-click it, make your changes and click 'Set'. To log in as a client, double-click it, enter a password if one is set, and click 'Login As'. To create a new account, enter the client name, set appropriate flags, enter password if desired, and click 'Set'. To delete an existing client, double-click it, and click 'Delete'.

    Flags

    Administrator
    If enabled, the user will not be restricted in what it can do.

    Send Endp Updates
    If enabled, endpoint updates will automatically be sent to this user. In most cases, this should be disabled since the GUI will request updates as appropriate.

    Send All Updates
    If enabled, endpoint, Port, and other updates will automatically be sent to this user. In most cases, this should be disabled since the GUI will request updates as appropriate.

    Brief CLI Output
    This has only minor affect on the output of the CLI text interface. It should usually be enabled, but does not make much difference either way.

    Creating a client for use by the CLI interface can be done through the GUI too. Unless you are using some sort of scripting program to control the CLI, it is advised that you turn off the Send Updates flags, or the CLI will be so noisy that you will not be able to see what you are doing!

    Securing LANforge

    By default, LANforge requires no password, and the GUI will log in as the super-user. The default user will also have super-user priviledges. To make LANforge more secure, remove the Administrator flag from the default user, and set a password on the Admin user. You cannot set a password on the default user, and a 'default_tm' Test Manager will always exist with the 'default' user associated. To restrict the default user's access, create a new Test Manager that does not include the default user, and add Cross-Connects to it.

    Passwords may be reset by any user with Admin status. Passwords are stored in a plain text file on the LANforge server at [LANforge-Home]/DB/passwd. If this file is deleted, all users will be able to log in without a password. This password protection will help keep user's from accidentally interfering with configurations that they should not have access to, but should NOT be considered a serious means of securing the LANforge machine.

  8.  


    Candela Technologies, Inc., 2026 Main Street, Suite A, P.O. Box 3285, Ferndale, WA 98248, USA
    www.candelatech.com | sales@candelatech.com | +1 360 380 1618


  9. Test Managers

    A Test Manager is a construct that represents a particular view into the LANforge system. In most cases, the default Test Manager can satisfy routine uses and the creation of addtional Test Managers is not required. Each Test Manager can have a selection of cross-connects and a list of users who are authorized to use the test manager. This allows one to set up multiple different tests on a LANforge system and quickly change between the test sets.

    To create a new Test Manager, select the Test Mgr tab and click 'Create.' This will bring up the Create/Modify Test Manager window:

    LANforge-GUI Test Manager

    1. Enter the name of the new test manager. Almost all names in the LANforge system are restricted to 15 characters and cannot contain spaces.
    2. If you are just starting, there will be no Cross-Connects to register or free, but after the system has been configured, you may adjust the Cross-Connects that belong to a given test manager by adjusting the top panel of the Create/Modify Test Manager window.
    3. You will need to register at least one client with the Test Manager if you want to do any useful work. Unless you have created your own client, you should add the 'default' and 'Admin' client at this time. Registering a client with a test manager means that client has permission to modify and use all resources associated with that test manager.
    4. Click the 'Apply' button to send the changes and keep the window open for other modifications, or click 'OK' to send the information and close the window.

    After creating the Test Manager, the Test Mgr tab will display a summary all existing Test Managers, including the one just created. To modify a test manager, select it and click the 'Modify' button. This will bring up the Create/Modify Test Manager window described above.

    LANforge-GUI Test Manager Panel
  10.  


    Candela Technologies, Inc., 2026 Main Street, Suite A, P.O. Box 3285, Ferndale, WA 98248, USA
    www.candelatech.com | sales@candelatech.com | +1 360 380 1618


  11. Layer-3 Cross-Connects (FIRE)

    Layer-3 Cross-Connects represent a stream of data flowing through the system under test. Each Cross-Connect (CX) is composed of two Endpoints, and each Endpoint is associated with a particular Port (physical or virtual interface). The Layer-3 tab displays all connections by default, but can display ranges of connections by selecting from the View field drop-down or typing a range in the View field and pressing the Tab or Enter keys. Connection numbering is 0-based where 0 represents the first connection name.

    LANforge-GUI Cross Connect Panel


    Creating & Modifying Cross-Connects

    When creating a Cross-Connect (CX), the details of each Endpoint including the Shelf, Resource, and Port that the Endpoint resides on need to be specifed. In this way, you determine which data-generating port (which is connected to some port on the system under test) the CX's traffic will flow over. In order to create a CX, click the 'Create' button on the Layer-3 tab which will bring up the Create/Modify Cross Connect window:

    LANforge-GUI Cross Connect Creation

    The top panel of the Create/Modify Cross Connect window contains information relating to the entire CX, including the name, CX Type, Report Timer, and the Test Manager. The CX name must be unique in the LANforge system and should have no spaces and be no more than 15 characters in length. The CX Type determines the protocol that the CX will use. The current supported types are:

    Ethernet
    Passes a custom protocol over raw ethernet. This type of traffic is constrained to a local LAN (it cannot be routed). This is a good way to test pure packet throughput at the Ethernet level, and will show many types of link layer faults, like corrupted packets, dropped packets, and so forth that the higher level protocols might not show.

    Custom Ethernet
    The exact bytes to transmit onto the ethernet wire, including the Ethernet header, can be specified using a Custom Ethernet connection. Additionally, the LANforge NetReplay feature can replay ethernet packets captured by LANforge-ICE or Wireshark. When replay is selected, LANforge NetReplay plays the packets exactly as they were captured, including the same ethernet headers, transmission rates, etc. To replay a capture file, select the appropriate filename for each endpoint. For more information on generating the capture files, please see the Dump Packets notes in the LANforge-ICE section. LANforge can also replay standard PCAP format packet dumps.

    This connection type also activates a GUI feature that allows you to build your own custom TCP/IP packets. Because LANforge has almost no control over what you send, it cannot detect received packets on the other end of the connection. You can use traffic sniffers or look at the port counters to get ideas of how many packets were actually received. See Configuring Payloads.

    UDP/IPv4
    UDP/IPv4 traffic is a non-stream oriented IPv4 protocol that is commonly used for streaming video, music, and other real-time (and possibly lossy) protocols. UDP/IPv4 can be routed, so it is not constrained to the local LAN like the Ethernet protocol is.

    UDP/IPv6
    UDP/IPv6 is similar to UDP/IPv4, but uses the IPv6 protocol which provides greater flexibility for routing streaming video, music, and other real-time (and possibly lossy) protocols. The IPv6 protocol is not supported by MS Windows at this time.

    Custom UDP/IP
    Custom UDP connections let you specify the exact bytes to transmit as the payload of a UDP datagram. This might be useful for simulating RTP, for instance. See Configuring Payloads.

    TCP/IPv4
    TCP/IPv4 is a stream based protocol that carries the vast bulk of the Internet's traffic. It is routable, and it will re-transmit packets that are dropped, so the only packets LANforge should show as dropped are those that are still in the kernel buffers, or those in transit when the CX is stopped.

    TCP/IPv6
    TCP/IPv6 is similar to TCP/IPv4, but uses the IPv6 protocol which provides greater flexibility for routing and network management. The IPv6 protocol is not supported by MS Windows at this time.

    Custom TCP/IP
    Custom TCP/IP connections let you specify the exact bytes to stream over a TCP/IP connection. LANforge has no way of knowing where one of your 'packets' starts or ends, so it cannot detect dropped or mangled bytes on the receive side. You can use the bytes sent and received counters to get a good idea though. See Configuring Payloads.

    The Report Timer specifies how often the LANforge data generators send updates to the LANforge server, and how often the LANforge server pushes endpoint information up to the clients (GUIs) that have requested the automatic updates. If you are running the GUI over a slow link, or have a slower machine, it is recommended to increase the report timer to 5000ms (5 seconds) or higher.

    The Test Manager specifies which test manager this CX should be added to.

    The lower two panels in the window are used to define endpoints A and B. Endpoints are generally symmetric for UDP and Ethernet. For TCP/IP, the TX endpoint acts as a client, and the RX endpoint acts as a server (it waits for connections). Selecting different options may enable/disable certain fields.

    Endp Name
    Endpoint names must be no more than 15 alpha-numeric characters and contain no spaces.

    Shelf
    Logical grouping for LANforge systems. In most configurations the only, and correct, choice is 1.

    Resource
    The machine on which this endpoint should reside.

    Port
    The physical or virtual interface with which this endpoint should be associated.

    Pld Pattern
    The payload pattern for the data generated by LANforge:
                    Increasing:   A pattern of bytes repeatedly incrementing from 0x00 to 0xFF.
                    Decreasing:   A pattern of bytes repeatedly decreasing from 0xFF to 0x00.
                    Random:       A pattern of random bytes from 0x00 to 0xFF.  This pattern
                                  is generated for every packet sent and hence is CPU intensive.
                    Random-Fixed: A pattern of random bytes from 0x00 to 0xFF is created for
                                  the first packet and then duplicated for subsequent packets.
                    Zeros (0x00): A payload of only zeros.
                    Ones (0xFF):  A payload of all 0xFF.
                    CUSTOM:       A user-specified payload pattern.
                    PRBS-4-0-3:   A payload pattern from a 4-bit linear shift register.
                    PRBS-7-0-6:   A payload pattern from a 7-bit linear shift register.
                    PRBS-11-8-10: A payload pattern from a 11-bit linear shift register.
                    PRBS-15-0-14: A payload pattern from a 15-bit linear shift register.
                 
    Src MAC
    This is only used when configuring un-managed endpoints. See below for more information on unmanaged endponts.

    IP Addr
    Used for un-managed UDP endpoints.

    IP Port
    If left 'AUTO', the LANforge system will select the IP ports. The user can also specify a particular IP port, but should be aware of potential port conflicts with other LANforge tests and third-party services running on the Linux machine. If configured to make many connections with the Cx-Duration option, set the Port to 0 (zero) on the 'A' endpoint. This means that the OS can choose any local IP port that it wishes when making the connections.

    Min Tx Rate
    The minimum transmit rate that LANforge will attempt to send, in bits per second. This value is not applicable for the replay function as the packets are replayed at the exact rates they were captured.

    Max Tx Rate
    The maximum transmit rate that LANforge will attempt to send, in bits per second. If this is greater than the min-tx-rate, then LANforge will vary the speed between the min and max creating a random stairstep pattern of data transmission over time that randomly returns to the min-tx-rate. That is the traffic distribution is a random rate and random duration burst with random intervals between bursts. The bursts are bounded by the Min and Max TX Rate. Traffic will initially be sent at the Tx Min rate. This value is not applicable for the replay function as the packets are replayed at the exact rates they were captured.

    Min Pkt Size
    The minimum packet size, in bytes. The packet size includes only the bytes for the selected protocol. For instance, if you select a 1472 byte packet for a UDP connection, the ethernet frame will actually be 1514 bytes in length because of the addition of the 14 bytes of ethernet header, the 20 bytes of IP header, and the 8 bytes of the UDP header. When configuring an Ethernet connection, you would select a length of 1514 to create a packet of 1514 bytes since there is no underlying data protocol.

    Max Pkt Size
    The maximum packet size, in bytes. If this is larger than the min-pkt-size, then each packet will be a random size between min and max.

    IP ToS
    For IP based protocols, you can specify the ToS (aka QoS) bits in the IP header. This can be useful for testing QoS settings in the device under test.

    NOTE:  When running LANforge in Windows, QoS must first be setup by following the instructions in the Microsoft Knowledge Base article 248611: http://support.microsoft.com/default.aspx?scid=kb;EN-US;q248611

    TTL
    This specifies the 'time-to-live' when configuring Multicast endpoints. It does not apply to other prototocols.

    Checksum
    Selecting the 'Checksum' checkbox will cause LANforge to perform a 32-bit CRC calculation for the payload. This gives a very high degree of packet corruption detection at each layer, but due to the extra work the CPU has to do, the maximum traffic rates may be smaller. Note that TCP/IP, and the ethernet protocol itself already has CRC checks, so you may not need to enable LANforge checksumming.

    Received bit-errors will be calculated in the LANforge payload portion starting 28 bytes into the UDP or TCP payload. In addition, the bit-errors are only checked when LANforge CRC is enabled and detected to be invalid. If the 28-byte header is corrupted, LANforge will not detect it, and may also give false positives for other packet errors. Bit-Errors are only calculated for certain payload patterns: Increasing, Decreasing, Zeros, Ones, and the PRBS patterns.

    Bit-error results will be displayed on the L3 Endps tab under the RX BER column for each endpoint.

    UnManaged
    Selecting the 'UnManaged' checkbox designates an endpoint as not controlled by LANforge. This can be used to fling UDP packets at some third-party application, for instance. It would be less useful for testing TCP in most cases.

    Rcv Mcast
    Selecting the 'Rcv Mcast' checkbox designates the endpoint as a multicast receiver as opposed to a sender.

    TCP Duration
    This specifies how long the TCP connection will run before it is torn down and reestablished. This option can be used to test how many TCP connections per second a firewall can handle, for instance. If you want a singe long running connection, just use 'Forever'. Otherwise, select the number of milliseconds the connection should run before it is reestablished. NOTE: You should set the IP Port to 0 (zero) on the endpoint A (this is the endpoint that originates the connection) when setting Cx-Duration to values other than 'Forever'.

    Pkts to Send
    Entering a number in this field will quiesce the endpoint after the specified number of packets have been sent.

    Filename
    This field is only available with a Custom Ethernet connection and the 'Replay Packet Stream' checkbox selected. Select the filename for replaying a previously captured stream of packets.

    Quiesce
    Instead of stopping the receiving and transmitting endpoints, Quiesce will stop the transmitting endpoint and wait a prescribed number of seconds before stopping the receiving endpoint so that all transactions may be completed.

    Replay Packet Stream
    Selecting the 'Replay Packet Stream' checkbox will replay the previously captured packet stream specified in the 'Filename' field. This function is only valid for Custom Ethernet connection types.

    Loop Replay
    Selecting the 'Loop Relay' checkbox will replay a previously captured packet stream in an endless loop. This function is only valid for Custom Ethernet connection types.


    Custom Payloads

    Clicking the 'Payload' button on either the TX or RX Endpoint panels allows for the configuration of custom payloads on custom endpoints. You can copy/paste the payload hex from a previous packet capture or build a payload by clicking the 'Defaults' button at the bottom of the window, selecting a protocol, then clicking 'Defaults' again. If you are configuring a Custom Ethernet Endpoint, the resulting screen will look something like this:

    LANforge Custom Ethernet Payload Configuration tool.

    As you fill in the lower protocol layers (for instance, the Ethernet header), other protocol builders will be added to the GUI display as selected. For example, if you choose the IP protocol in the Ethernet header, the IP builder will appear. It will parse the top HEX window if possible and initialize its fields appropriately. From the IP protocol builder, you can choose TCP as the next layer, and the TCP builder will appear...

    Protocol Builders

    LANforge supports three protocol builders at this time. More will be added as time permits, but please let us know if there are any in particular that you would like to see implemented first. If you wish to transmit protocols we do not have builders for, you can always paste a captured packet, or hand build one in HEX and transfer it to the text editor at the top of the Payload panel.

    You can also initialize most protocols to defaults, and the resulting values will correspond to live packets gathered from our network. The ethernet protocol is slightly different, see the notes below. Make sure you initialize from the lower layers up to the higher layers.

    Ethernet Header
    You can specify the Source, Destination and Protocol fields in the Ethernet Header. If you tell this protocol to initialize to defaults, it will grab the MAC addresses from the two ports it is connected to. This may or may not be what you want, so be ready to re-enter the fields accordingly.

    IP Header
    You can specify the various IP header fields. For details, look up the venerable RFC 791. If you change a field, you will probably want to re-checksum both the IP header and higher protocols too (in that order).

    TCP Header
    You can specify the various TCP header fields. For details, look up the venerable RFC 793. If you change a field, you will probably want to re-checksum the header with the checksum button.

    Advanced Configuration

    Clicking the 'Advanced' button on either the TX or RX Endpoint panels allows for the configuration of send and receive buffer sizes. For TCP connections, this correlates to sending and receiving window sizes. For layer-2 ethernet protocols one can also specify the number of frames to be generated with purposefully bad ethernet CRCs. This 'bad CRC' feature is only supported by certain ethernet adapters and drivers. Please contact Candela if you wish to use this feature.

    Advanced endpoint configuration

    You can use the 'Socket Priority' field to set a particular priority for the generated packets. When used in conjunction with the priority -> .1q priority mapping supported in the 802.1Q VLAN stack on Linux, you can have packets created with particular 802.1Q priorities. You can also use other Linux tools external to LANforge to modify behavior of the packets based on the priority.

    Selecting the 'TCP_NODELAY' checkbox will decrease latencies in many cases and aid generation of small TCP frames by disabling the connection's Nagle algorithm. Selecting 'TCP_NODELAY' may decrease total bandwidth.


    Cross Connect Display

    Individual Cross-Connects can be selected for display from the Layer-3 tab. Select a Cross-Connect and click the 'Display' button to bring up a summary window for that cross-connect.

    LANforge-GUI CX Display Frame

    The Cross Connect display is divided into three panels. The left and right panels describe information for endpoints A and B, respectively. The center panel describes the number of confirmed packets flowing and dropped from left-to-right and right-to-left, respectively.

    The busy graphs on the right of each panel display the latency distributions for each endpoint. LANforge detects latency with a timestamp in each LANforge protocol packet (LANforge-ETH, LANforge-UDP, and LANforge-TCP endpoint types ONLY). The precision is to 1 millisecond. If the two endpoints are using NTP protocol to keep themselves in sync, then they are usually within 0-3 milliseconds apart. Because of this, latencies may be negative at times. This just shows the difference in the clocks, and by looking at both sides of the connection, you can deduce the true latencies. For the best latency measurements, have both the sending and receiving port on the same machine. For even higher precision, consider an Armageddon endpoint, which has microsecond latency reporting.

    LANforge only counts the latencies when it receives the packet. This is not exactly the time that the packet was received by the LANforge hardware because the packet must flow through the protocol stacks up to the LANforge server. This is the primary cause of the range of latencies you will see reported even on a simple and fast LAN. The average is usually very close though: It is a running average of the last 100 packets received.

    The average is displayed on the top-right side of the individual latency display widgets. Min/max values are displayed below the average.

    There are two latency graphs for each endpoint. The top one is for the last 30 seconds, and the bottom is for the last 5 minutes.

    The numbers on the top-left of the widget are the counters for each latency 'bucket'. The vertical graphs correspond to those numbers.

    The units for the size of the buckets are milliseconds, and are exponential (2^X) in scale. The exponential values (1, 2, 4, 8, etc.) will be multiplied by the bucket 'width', which is always 1 currently, and added to the minimum latency. For instance, if the minimum latency is 0 millisecond, then the buckets will be:

              1
              2
              4
              8
              16
              ...
            

    If the bucket "1" has 2000 beside it, then that means that 2000 packets have been received in the last time-period that had less than 1 milliseconds in latency. If the bucket "2" has 30 beside it, then that means 30 packets had latency between 1 and 2 milliseconds.

    The minimum latency can change over time, which will cause the buckets to shift their values. Although this may be confusing at first, it allows LANforge to report high-precision data regardless of the latency of the system under test.

    When viewing the Spread-Sheet output, the lat_0, lat_1, etc columns show the number of packets received in the last 30 seconds that fall into the buckets.

  12.  


    Candela Technologies, Inc., 2026 Main Street, Suite A, P.O. Box 3285, Ferndale, WA 98248, USA
    www.candelatech.com | sales@candelatech.com | +1 360 380 1618


  13. Layer-3 Endpoints (FIRE)

    You will use the Cross Connect screen to stop/start/modify your (non-IGMP) CXs, but to see the fine details of each cross-connect, you will want to look at the endpoint screen. If you select a particular CX by single-clicking on its row, then you can move to the L3-Endps screen and see the Endpoints for that CX highlighted as well. The L3 Endps tab displays all endpoints by default, but can display ranges of endpoints by selecting from the View field drop-down or typing a range in the View field and pressing the Tab or Enter keys. Endpoint numbering is 0-based where 0 represents the first endpoint name.

    LANforge-GUI Endpoints

    From the L3-Endp Panel you can do bulk changes to packet sizes and packet rates. For example, if you want several of your Endpoints running at 56000bps then you can select them, and use the 'MIN Tx Rate' combo-box to set the desired value. For more specific modifications, select the endpoint in question and click the 'Modify' button. You can also modify Endpoints through their Cross-Connect on the Cross Connect Information panel at the top of the window.

    If you wish to see graphs for the received packets for a particular endpoint, you can select one or more endpoints and click on the 'Display' button. The display of a sample endpoint is shown here:

    LANforge-GUI Endpoint:  Display


    Creating & Modifying Multicast Endpoints

    LANforge supports the IGMP UDP Multicast protocol. Because there is a one to many relationship, these endpoints are not handled by the standard cross-connect paradigm. Instead, you can create multiple endpoints, specifying one generator and zero or more receivers for a particular IGMP address/port pair. To create an IGMP endpoint, click the 'Create' button on the L3 Endps tab. This will bring up the Create/Modify Endpoint window. To modify an existing IGMP endpoint, select it and click the 'Modify' button.

    LANforge-GUI Endpoint: Create/Modify

    Endp Type
    The Endpoint Type should be 'Multicast.' Custom Multicast is not supported at this time (please enquire if you are interested in this feature.)

    Report Timer
    The Report Timer is how often (in millisecond units) the endpoint reports to the GUI. 1000-5000 (1-5 seconds) is suggested for most cases.

    IGMP Address
    The IGMP Address is the 'IP' address of the multicast group. Multicast IP addresses must be in the range between 224.0.0.0 and 239.255.255.255, inclusive. The IGMP Address and Port specifies a particular multicast group.

    IGMP Dest Port
    The IGMP Destination Port is the UDP port that this endpoint will transmit to, assuming it is a transmitter. If it is a receive-only endpoint, then this field can be left blank ("IP Port" specifies the receiving port.)

    IP Port
    The IP Port is the port that the Endpoint listens to if it is a receiver. If it is a transmitter, then this field can be left at the default setting.

    TTL
    The Time-to-Live field determines how far the IGMP packet may travel. If it's 1, then it travels only to the local subnet. Larger numbers allow it to travel across routers. Be careful not to flood other networks by accident!

    Rcv Mcast
    If the 'Rcv Mcast' checkbox is selected, this endpoint will be a receiver. If not, then it will be an IGMP multicast generator. You should have one generator per unique multicast IP address and port, and zero or more receivers.
  14.  


    Candela Technologies, Inc., 2026 Main Street, Suite A, P.O. Box 3285, Ferndale, WA 98248, USA
    www.candelatech.com | sales@candelatech.com | +1 360 380 1618


  15. VoIP Call Generator (H.323, SIP, RTP, RTCP)

    After adding a Test Manager, you may create Voice over IP (VoIP) calls between LANforge interfaces. You may also set up third-party phones to call LANforge or be called by LANforge.

    VoIP consists of several protocols. LANforge currently supports H.323 and SIP (Session Initiated Protocol). The voice payload is transmitted with the Real Time Protocol (RTP) which runs over UDP. The Real Time Control Protocol (RTCP) is used for latency and other accounting, and runs over UDP with the same priority as the RTP traffic. The VoIP/RTP tab displays all connections by default, but can display ranges of connections by selecting from the View field drop-down or typing a range in the View field and pressing the Tab or Enter keys. Connection numbering is 0-based where 0 represents the first connection name.

    LANforge-GUI Cross Connect Panel


    Creating & Modifying VoIP Cross-Connects

    When creating a VoIP Cross-Connect (CX), you specify the details of each Endpoint, including the Shelf, Resource, and Port that the Endpoint resides on. In this way, you determine which data-generating port (which is connected to some port on the system under test) the call's traffic will flow over. In order to create a CX, click the 'Create' button on the VoIP/RTP tab. This will bring up the Create/Modify VoIP Cross Connect window:

    LANforge-GUI VoIP Cross Connect Creation

    The top panel of the Create/Modify Cross Connect window contains information relating to the entire CX, including the name, CX Type, report timer, and the test manager this CX should belong to. The name must be unique in the LANforge system.

    Report Timer
    The report timer specifies how often the LANforge data generators send updates to the LANforge server, and how often the LANforge server pushes endpoint information up to the clients (GUIs) that have requested the automatic updates. If you are running the GUI over a slow link, or have a slower machine, it is recommended to increase the report timer to 5000ms (5 seconds) or higher.

    Test Manager
    Specifies to which test manager this CX should be added.

    CX Type
    The CX Type determines the protocol that the CX will use. The current supported VoIP types are:

    Voice - SIP
    Makes a voice call using the SIP messaging protocol. If you are using 'Directed' mode, then the endpoints can call directly to each other without using a SIP proxy server. With the 'Use Gateway' option, a SIP server will be used to handle the call routing. LANforge has been tested with a wide variety of third-party SIP gateways, including Asterisk.

    Voice - H.323
    Makes a voice call using the H.323 messaging protocol. If you are using 'Directed' mode, then the endpoints can call directly to each other without using an H.323 gateway. With the 'Use Gateway' option, an H.323 server will be used to handle the call routing. LANforge has been tested with the gnugk H.323 gateway.

    Call Modes
    Two call modes are available: 'Continuous Call' makes a single call and plays the wave file in a loop until the call is stopped by the user. 'Multi-Call' mode allows you to select the number of times to loop the wave file, the number of calls to make, and the maximum time of the call. For PESQ, you should use the 'Multi-Call' option.

    Call Gateway Options
    Two Call Gateway options are available: 'Directed' means that the VoIP endpoints directly call themselves, without registering with or using a proxy or gateway. In this configuration most of the endpoint attributes can be 'AUTO' because LANforge can determine the settings automatically. In 'Use Gateway' mode the call endpoints will register with a gateway or proxy and make calls through it.

    Call Duration
    Min/Max Call Duration determine the length of the call. If 'File' is selected then the call will be as long as it takes to play the chosen wave file. If Min is not equal to Max, a random value between the min and max will be chosen for each call made. For PESQ, select 'File' for the call duration.

    Number of Calls
    Specifies the number of calls to make before the endpoint stops itself. Select 'INFINITE' if you want to run until the user stops the call manually.

    Max Ring Time
    Determines how long the calling endpoint will wait for the called party to pick up before deciding the call was a 'No Answer'.

    Inter-Call Gap
    Min/Max Inter Call Gap specifies how long to wait between calls. If min is not equal to max, a random value will be chosen between min and max for each call.

    Codec
    Determines the codec for the RTP voice payload. Currently G729, G711u, G726-16, G726-24, G726-32, G726-40 and Speex codecs are supported by SIP. H.323 only supports G.711u at present. By default, the phones will advertise all supported Codecs, with a preference on the one selected here. If you want to only advertise the single selected codec, then also enable the 'Single Codec' checkbox in the Endpoint configuration sections.

    Don't Send RTP
    By default, LANforge will generate the RTP payload for each call. This requires significant processing resources, so if you only care about the SIP messaging, you can select this checkbox to disable sending of RTP.

    Each Endpoint can be configured independently of the other. The default is to have the 'A' endpoint call the 'B' endpoint. The 'B' endpoint can be un-managed, which means LANforge assumes that it is a third-party endpoint, such as a Cisco or Grandstream SIP phone.

    Name, Shelf, Resource, Port
    The Endpoint name, shelf, resource, and port information determines the Port (interface) this endpoint will use.

    Phone Number
    The Phone Number is the SIP or H.323 identifier for the endpoint. If you are using a Gateway, then this number must be configured in the Gateway so that the endpoint can register. For directed calls, this can be 'AUTO' and LANforge will choose some random value and make it work. For SIP, if you put in a number, the SIP To/From headers will be number@IP:port. If you want LANforge to use a domain for the To/From headers, then you can enter something like: 1234@domain.com for the phone number. If you are using non-standard SIP ports, then you must specify the SIP port too: 1234@domain.com:50600

    Display Name
    Allows configuration of the SIP Display Name attribute for caller ID. The default is AUTO which will display the phone number.

    Flags & Options
    Several flags (checkboxes) are used to enable or disable certain features which affect the behavior of the selected endpoints.

    The 'UnManaged' flag tells LANforge that this particular Endpoint is not a LANforge endpoint. Use this when configuring LANforge to call third-party SIP phones, for example.

    Selecting 'Don't Answer' will make LANforge decline to 'pick up' the phone when called.

    If 'Rcv Call' is selected, then this endpoint will wait for calls to be made to it, but will not originate any calls.

    Selecting 'No Tunneling' or 'No Fast Start' checkboxes will prevent LANforge from using the tunneling or fast connect features of the H.323 protocol, respectively.

    If 'Single Codec' is selected, LANforge will only use the codec specified in the top panel of this window. With this function disabled, the specified codec will be preferred, but any supported codec will be accepted.

    Select 'Bind SIP' if the gateway is connected to the same (ethernet) interface as the VoIP endpoint. This is usually required for Directed calls. If you are using the management network for the gateway, then deselect this checkbox.

    If 'Record' is selected, LANforge will record the received audio stream to the specified wav file. This must be selected if you want to enable PESQ reporting.

    LANforge VoIP now supports PESQ automated voice quality reporting. You must purchase a separate PESQ license for your LANforge system in order to enable this feature. To configure the VoIP endpoint for PESQ, select the 'Enable PESQ' checkbox. You must also configure the PESQ server. The PESQ server is the LANforge machine on which you install the PESQ license. PESQ can run along side other LANforge processes, so everything can be installed on a single machine if desired. For optimal results, select the 'Multi-Call' call mode and 'File' for the call duration. You also have to enable the 'Record' feature so that the received audio is saved to the local file system for processing by PESQ.

    Selecting 'Play to speaker' will play received audio on the LANforge server's speaker, providing a sound system exists and is configured correctly. The default sound device for Linux is /dev/audio.

    SIP supports Voice Activity Detection (VAD). Selecting 'VAD' will suppress RTP packets if silence is detected more than the specified 'VAD Delay' in milliseconds.

    UDP Port
    UDP Port specifies the port that RTP traffic will use. RTCP will use one port higher than that, so if you choose to configure these manually, be sure to leave space. You can also use 'AUTO', in which case LANforge will allocate ports accordingly.

    SIP Port
    SIP Port specifies the UDP port for the SIP messaging protocol. When using H.323 protocol, this specifies the H.323 management port. The default SIP port is 5060, so if you are trying to configure an un-managed endpoint that corresponds to a third-party SIP phone, using 5060 is a good choice. The default H.323 port is 1720.

    IP ToS
    You can specify the ToS (aka QoS) bits in the IP header. This value will be set on RTP and SIP packets.

    Socket Priority
    If you are running VoIP over 802.1Q VLAN interfaces on the LANforge system, setting the socket priority can allow you to map the priority to the 802.1Q priority. Use the external 'vconfig' Linux tool to configure the mappings between a particular socket priority and the .1Q priority. (Not currently supported by H.323.)

    VAD Delay
    How much consecutive silence before VAD is enabled.

    VAD Force Send
    Force a send of an RTP packet at least every X milliseconds. Helps keep connections from being timed out with some phones.

    Jitter Buffer
    Jitter buffer is used to smooth out network jitter inherent in RTP traffic. Specify the buffer size (number of 20ms packets). Jitter buffer for the H.323 protocol is not supported in LANforge and will be ignored.

    Tx File
    The Tx File is the WAV file to play. Wave files must use single-channel 8-bit encoding. The Linux tool 'sox' can be used to convert various formats to the correct encoding. Assuming you have a sound/music file called muzak.ogg, the command syntax is:
    sox muzak.ogg -U -c 1 -b -v 1.1 -r 8000 /tmp/muzak.wav resample -q1
                   # muzak.ogg == input file, can be almost any type of sound file.
                   # -U      == ulaw encoding
                   # -c 1    == one channel
                   # -b      == 1-byte encoding (8-bit)
                   # -v 1.1  == increase volume by 1.1/1.0 percent, optional
                   # -r 8000 == 8000 samples per second.
                   # /tmp/muzak.wav  == output file, has to be a .wav extension.
                   # resample -q1    == makes it sound better, evidently, I can't tell.
             

    Destination
    If the destination number/URL to be called is different from the peer endpoint's phone number, you may specify it in this field.

    Speaker
    If you have a properly configured sound card, you can play the received call to the speaker real-time. Only a single call can play on a particular machine at the same time. Select the 'Play to Speaker' checkbox to enable this feature. This feature is only supported for SIP, and only on Linux.

    Call Gateway
    For 'Use Gateway' calls, you will need to specify the SIP Proxy or H.323 gateway. The proxy or gateway should usually be located in the system/network under test. This is a potentially complex matter, so please contact Candela Technologies or your supplier if you have any questions. For authenticated SIP registration, append the password to the front of the IP address: [password@]IP[:port]

    Record File
    If you want a copy of the received wav file, or if you are using PESQ, enter the filename to which to save the received audio stream. This should be unique for all endpoints so that you do not corrupt other calls' files.

    PESQ Server
    To enable PESQ automated reporting, you must have a PESQ license and/or access to a machine running a licensed PESQ server. Enter the IP address of that machine and the port (default port is 3998) in this field.

    Quiesce
    Instead of stopping VoIP endpoints, Quiesce will stop generating new traffic and wait a prescribed number of seconds before stopping the receiving endpoint so that all transactions may be completed.


    VoIP Call Display Panel

    Individual VoIP cross-connects can be selected for display from the VoIP/RTB tab. Select a cross-connect and click the 'Display' button to bring up a summary window for that cross-connect.

    LANforge-GUI CX Display Frame

    The VoIP Cross Connect display is divided into three panels. The left and right panels describe information for endpoints A and B, respectively. The center panel describes the number of confirmed packets flowing and dropped from left-to-right and right-to-left, respectively.

    The busy graphs on the right of each panel display the latency and jitter distribution for each endpoint. LANforge detects latency with the RTCP protocol. Jitter is determined from the timestamp on the received RTP packets. Note that the jitter calculation is made before the packet is processed by the RTP Jitter buffer.

    Average values are displayed on the top-right of the individual display widgets. Min/max values are displayed below the average.

    The top graph is for RTCP latency over the last 30 seconds, and the bottom graph is jitter derived from the RTP packets over the last 30 seconds.

    The numbers on the top-left of the widget are the counters for each latency 'bucket'. The vertical graphs correspond do those numbers.

    The units for the size of the buckets are milliseconds, and are logorithmic in scale. For instance, if the average latency is 101 milliseconds, then the buckets will be:

              102
              103
              105
              109
              117
              ...
            

    If the bucket "102" has 2000 beside it, then that means that 2000 packets have been received in the last time-period that have less than 102 milliseconds in latency. If the bucket "105" has 30 beside it, then that means 30 packets had latency between 103 and 105 milliseconds.

  16.  


    Candela Technologies, Inc., 2026 Main Street, Suite A, P.O. Box 3285, Ferndale, WA 98248, USA
    www.candelatech.com | sales@candelatech.com | +1 360 380 1618


  17. VoIP Endpoints

    You will use the RTP Cross Connect screen to stop/start/modify your RTP Call Cross-Connects, but to see the fine details of each endpoint, you may want to look at the endpoint screen. If you select a particular call by single-clicking on its row, then you can move to the RTP Endpoints screen and see the Endpoints for that call highlighted as well. The VoIP/RTP Endps tab displays all endpoints by default, but can display ranges of endpoints by selecting from the View field drop-down or typing a range in the View field and pressing the Tab or Enter keys. Endpoint numbering is 0-based where 0 represents the first endpoint name.

    LANforge-GUI Endpoints
  18.  


    Candela Technologies, Inc., 2026 Main Street, Suite A, P.O. Box 3285, Ferndale, WA 98248, USA
    www.candelatech.com | sales@candelatech.com | +1 360 380 1618


  19. Audio/Visual Connections

    VLC media player (formerly VideoLAN Client) is a highly portable multimedia player, encoder, and streamer supporting many audio and video formats (MPEG-1, MPEG-2, MPEG-4, DivX, mp3, ogg, etc.) as well as DVDs, VCDs, and various streaming protocols. VLC can also be used as a server to stream in unicast or multicast in IPv4 or IPv6 on a high-bandwidth network. VLC doesn't need any external codec or program to work. The Audio/Visual tab displays all connections by default, but can display ranges of connections by selecting from the View field drop-down or typing a range in the View field and pressing the Tab or Enter keys. Connection numbering is 0-based where 0 represents the first connection name.

    LANforge-GUI Endpoints

  20. Creating & Modifying VLC Cross-Connects

    When creating a VLC Cross-Connect (CX), you specify the details of the transmit Endpoint, including the Shelf, Resource, and Port that the Endpoint resides on. In this way, you determine which data-generating port (which is connected to some port on the system under test) the VLC traffic will flow over. In order to create a CX, click the 'Create' button on the Audio/Visual tab. This will bring up the Create/Modify VLC Cross Connect window:

    LANforge-GUI VoIP Cross Connect Creation

    The top panel of the Create/Modify Cross Connect window contains information relating to the entire CX, including the name, report timer, and the test manager this CX should belong to. The name must be unique in the LANforge system. CX Type is defaulted to 'Video - VLC'. The lower panel in the window is used to define Endpoint A.

    Endp Name, Shelf, Resource, Port
    The Endpoint name, shelf, resource, and port information determines the Port (interface) this endpoint will use.

    URL
    Allows a URL to be listed to view the VLC video stream.

    X Display
    Enter an X Server Display target. This will only function correctly if you are running an X server that will accept remote connenections on the target.

    Reg Expire
    Allows you to set the registration expire timer.

    Flags & Options
    Several flags (checkboxes) are used to enable or disable certain features which affect the behavior of the selected endpoint.

    The 'UnManaged' flag tells LANforge that this particular Endpoint is not a LANforge endpoint.

    If 'Record' is selected, LANforge will record the received audio/video stream to the specified wav file.

    Selecting 'Show Video' will display received video via the LANforge server providing a video player is installed and configured correctly.

    UDP Port
    UDP Port specifies the port that RTP traffic will use. RTCP will use one port higher than that, so if you choose to configure these manually, be sure to leave space. You can also use 'AUTO', in which case LANforge will allocate ports accordingly.

    SIP Port
    SIP Port specifies the UDP port for the SIP messaging protocol. When using H.323 protocol, this specifies the H.323 management port. The default SIP port is 5060, so if you are trying to configure an un-managed endpoint that corresponds to a third-party SIP phone, using 5060 is a good choice. The default H.323 port is 1720.

    IP ToS
    You can specify the ToS (aka QoS) bits in the IP header. This value will be set on RTP and SIP packets.

    Socket Priority
    If you are running VLC over 802.1Q VLAN interfaces on the LANforge system, setting the socket priority can allow you to map the priority to the 802.1Q priority. Use the external 'vconfig' Linux tool to configure the mappings between a particular socket priority and the .1Q priority. (Not currently supported by H.323.)

    Tx File
    Enter the path and filename for the file to be transmitted.

    Record File
    Enter the destination path and unique filename for the received audio/video RTP stream to be saved.

    Quiesce
    Instead of stopping VLC endpoints, Quiesce will stop generating new traffic and wait a prescribed number of seconds before stopping the receiving endpoint so that all transactions may be completed.

     


    Candela Technologies, Inc., 2026 Main Street, Suite A, P.O. Box 3285, Ferndale, WA 98248, USA
    www.candelatech.com | sales@candelatech.com | +1 360 380 1618


  21. Audio/Visual Endpoints

    You will use the VLC Cross Connect screen to stop/start/modify your VLC media player CXs, but to see the fine details of each cross-connect, you will want to look at the endpoint screen. If you select a particular CX by single-clicking on its row, then you can select the AV Endps tab to see the Endpoints for that CX highlighted as well. The AV Endps tab displays all endpoints by default, but can display ranges of endpoints by selecting from the View field drop-down or typing a range in the View field and pressing the Tab or Enter keys. Endpoint numbering is 0-based where 0 represents the first endpoint name.

    LANforge-GUI Endpoints
  22.  


    Candela Technologies, Inc., 2026 Main Street, Suite A, P.O. Box 3285, Ferndale, WA 98248, USA
    www.candelatech.com | sales@candelatech.com | +1 360 380 1618


  23. Armageddon (Accelerated UDP)

    Armageddon Cross-Connects require special Linux kernel features. If you purchased your machine from Candela, then these features will already be included. Otherwise, you should make sure you have installed the kernel patches from Candela.

    The Armageddon traffic generator can generate UDP packets with various IP and UDP header fields. More importantly, it can generate packets at line speed on 10/100/1000 Mbps and Multi-Gigabit Ethernet networks. Armageddon can also measure latency with 1 microsecond precision, and the sending and receiving ports can be on the same machine.

    NOTE: If you are running Armageddon on a flat (non-routed) network, then LANforge can figure out all the defaults for you. However, if you are running in a routed network, you will need to manually enter the MAC address of your router in the Destination MAC field of the Armageddon configuration panel.

    LANforge-GUI Armageddon Panel


    Creating & Modifying Armageddon Cross-Connects

    When creating an Armageddon CX, you specify the details of each Endpoint, including the Shelf, Resource, and Port that the Endpoint resides on. In this way, you determine which data-generating port (which is connected to some port on the system under test) the CX's traffic will flow over. In order to create an Armageddon CX, click the 'Create' button on the Armageddon tab. This will bring up the Create/Modify Armageddon Endpoint window:

    LANforge-GUI Cross Connect Creation

    The top panel of the Create/Modify Armageddon Endpoints window contains information relating to the entire CX, including the name, CX Type, report timer, and the test manager this CX should belong to. The name must be unique in the LANforge system. The CX Type determines the protocol that the CX will use. The current supported types are:

    Armageddon/UDP
    Generates and receives UDP packets. Protocol header fields will default to sane values based on the ports you select, but you can specify or randomize most fields to customize the packets that you send. For generating traffic for a routed network, you may have to override the default destination MAC address with the one from your router. Currently, the payload will just be random bytes, except for a small header at the beginning of the UDP payload that LANforge uses to detect dropped and reordered packets.

    The report timer specifies how often the LANforge data generators send updates to the LANforge server, and how often the LANforge server pushes endpoint information up to the clients (GUIs) that have requested the automatic updates. If you are running the GUI over a slow link, or have a slower machine, it is recommended to increase the report timer to 5000ms (5 seconds) or higher.

    The Test Manager specifies which test manager this CX should be added to.

    The endpoint values are defined below.

    Endp Name
    The unique name for this endpoint. LANforge generates a default value based on the CX Name entered in the top panel.

    Shelf
    The virtual 'shelf' for this endpoint. The default of 1 is the only correct answer in most configurations.

    Resource
    The LANforge machine that this endpoint should be associated with. Choose from the drop-down values.

    Port
    The real or virtual network interface this endpoint should be associated with. Choose from the drop-down values.

    Pld Pattern
    The payload pattern is random chunks of memory, and is not currently configurable.

    Src MAC
    The source MAC address in the generated packets. If DEFAULT is entered in this field, LANforge will use the MAC address of the configured port for this endpoint.

    Dst MAC
    The destination MAC address in the generated packets. If DEFAULT is entered in this field, LANforge will use the MAC address of the peer endpoint's configured port.

    Min Src IP
    The source IP address for the generated packets. If DEFAULT is entered in this field, LANforge will use the MAC address of the configured port for this endpoint.

    Max Src IP
    The source IP address for generated packets. If this value is larger than the Min Src IP, then the generated packets will cycle through the IP address range creating traffic from each IP address. If DEFAULT is entered in this field, LANforge will use the MAC address of the configured port for this endpoint.

    Min Dst IP
    The destination IP address for the generated packets. If DEFAULT is entered in this field, LANforge will use the MAC address of the peer endpoint's configured port.

    Max Dst IP
    The destination IP address for generated packets. If this value is larger than the Min Dst IP, then the generated packets will cycle through the IP address range creating traffic to each IP address. If DEFAULT is entered in this field, LANforge will use the MAC address of the peer endpoint's configured port.

    Min Src Port
    The source IP port for the generated packets.

    Max Src Port
    The source IP port for generated packets. If this value is larger than the Min Src Port, then the generated packets will cycle through the IP port range creating traffic from all IP ports.

    Min Dst Port
    The destination IP port for the generated packets.

    Max Dst Port
    The destination IP port for generated packets. If this value is larger than the Min Src Port, then the generated packets will cycle through the IP port range creating traffic to all IP ports.

    PPS Tx
    The desired packets-per-second to transmit. If the hardware/network cannot actually run at this speed, it will run as fast as it is able.

    Min Pkt Size
    The minimum packet size. This includes all ethernet headers, but does NOT include the 4 byte CRC at the end of the ethernet frame. The reported bits-per-second and bytes received WILL take the 4 byte CRC into account.

    Max Pkt Size
    The maximum packet size. This includes all ethernet headers, but does NOT include the 4 byte CRC at the end of the ethernet frame. If this value is larger than the Min Pkt Size, each new packet will have a random size between min and max, in a random distribution.

    Multi-Pkt
    This setting determines the number of times the exact same packet will be transmitted before a new one is created. Setting this value to greater than one can increase performance of the LANforge machine, but it will decrease the chance of detecting out-of-order packets. This is not usually a problem. When using Armageddon on virtual interfaces, such as MAC-VLANs and 802.1Q VLANs, this value must be 0 due to internal driver limitations.

    Pkts to Send
    This specifies the number of packets to send before stopping the test. Set this value to zero to have the test run until stopped by the user.

    Src MAC Cnt
    If greater than 1, the source MAC address will be incremented through the specified range. This allows the test to create packets from what appears to be many different ethernet NICs and can be good for stress-testing ethernet switches and other types of equipment that attempt to detect and optimize for network flows.

    Dst MAC Cnt
    If greater than 1, the destination MAC address will be incremented through the specified range. This allows the test to create packets to what appears to be many different ethernet NICs and can be good for stress-testing ethernet switches and other types of equipment that attempt to detect and optimize for network flows.

    Quiesce
    Instead of stopping the receiving and transmitting endpoints, Quiesce stops the transmitting endpoint and waits a prescribed number of seconds before stopping the receiving endpoint so all transactions can be completed.
  24.  


    Candela Technologies, Inc., 2026 Main Street, Suite A, P.O. Box 3285, Ferndale, WA 98248, USA
    www.candelatech.com | sales@candelatech.com | +1 360 380 1618


  25. WanLinks (ICE)

    WanLinks support the WAN/Network emulation feature (also called LANforge-ICE). In the default configuration, two interfaces will act like a transparent layer-2 ethernet bridge. As traffic flows through this bridge, the WAN emulation is applied. The WanLinks are able to add various characteristics to the traffic flowing through them, including maximum-bandwidth, latency, jitter, jitter-frequency, dropped-packets, duplicated-packets, reordered-packets, bit & byte errors, and more! Each WanLink is composed of two WanLink Endpoints that represent one of the sides of the WAN/Network emulation.

    If a network's values for probed latency, packet loss and others were captured using LANforge-ICEcap, the resulting XML file can be replayed using the LANforge-ICEcap Replay (WAN-Playback) feature. This will provide realistic WAN emulations based on real-world networks. LANforge-ICEcap has been benchmarked at 700Mbps bi-directional (1400 Mbps total) on high-end hardware using the kernel-mode capture support.


    Overview of WanLink Configuration

    A WanLink emulates a bridged Ethernet network with characteristics determined by the user. Packets are received in one Ethernet (or virtual) interface and are transmitted out the other interface. This means that when you add the LANforge machine to an existing network configuration, no routing changes are needed. When designing your network, you can think of a pair of WanLink ports as an ethernet switch or even just a pass-through cable! WanLinks can bridge 802.1Q VLAN interfaces as well.

    LANforge-ICE supports multiple virtual routers per system when LANforge is running on Linux. On Windows, only bridge-mode is supported. Use the Netsmith tool described here to configure LANforge-ICE in the routed mode.

    LANforge-ICE works best using a minimum of three ethernet ports: two for each WanLink and the third to access the LANforge machine remotely for management purposes. To ensure that there is no interaction with the LANforge machine's protocol stacks, the IP address for each WanLink port is removed.

    It is possible to run WanLinks on a machine with only two ports, but you will not have the option to manage LANforge remotely. In this case, your machine will need to be configured for a loopback device to manage LANforge. This configuration can be useful for an interface-limited platform such as a Laptop. Since both ports will be used for the WanLink with an IP address of 0.0.0.0, you will not have network connectivity to this machine when LANforge is running. See the LANforge Server Installation Documentation for how to configure a loopback device on your machine.

    NOTE: There are work-arounds for even this restriction if you use a more complex Netsmith setup with bridge devices. Contact support if you have such a need.

    LANforge-GUI WanLinks


    Creating & Modifying WanLinks

    When creating a WanLink, the details of each WanLink Endpoint must be specified, including the Port where the WanLink Endpoint resides. In this way the ethernet port which the WanLink is to accept traffic from (which is connected to some port on the system under test) is determined. In order to create a WanLink, click the 'Create' button on the WanLinks tab. WanLinks can be attached to physical ethernet interfaces and 802.1Q VLAN interfaces. WanLinks should NOT be attached to MAC-VLAN, 802.11a/b/g, or PPP interfaces at this time.

    LANforge-GUI WanLink Creation

    The top panel of the Create/Modify WanLink window contains information relating to the entire WanLink, including the name, shelf, resource, report timer, test manager, and presets. Enter a non-numeric name no more than 15 characters in length. Select the Shelf and Resource that the WanLink will reside on. For LANforge ICE systems with only one machine, you do not need to change these values from their default of one (1).

    Report Timer
    The report timer specifies how often the LANforge data generators send updates to the LANforge server, and how often the LANforge server pushes endpoint information up to the clients (GUIs) that have requested the automatic updates. If you are running the GUI over a slow link, or have a slower machine, it is recommended to increase the report timer to 5000ms (5 seconds) or higher.

    Test Manager
    The Test Manager specifies which test manager this CX should be added to.

    Presets
    The Presets function may be used to help configure common network transports (e.g., DSL, T1, DS3). Selecting a preset from the drop-down menu fills in some of the configuration fields in the lower two panels of the window. Configuration settings can then be modified to suit your particular needs (not all DSL networks run at the same speed, for instance). Clicking 'Apply' or 'OK' saves the WanLink configuration as entered in the panels (via preset selection or modified).

    Coupled-Mode
    Selecting the Coupled-Mode checkbox forces the emulation to be symmetric so you only need to configure Entry Point A. The values will be automatically set in Entry Point B when you click 'Apply' or 'OK.'

    Pass-Through
    Selecting the Pass-Through checkbox enables the packets to pass through the emulation without any impairment, regardless of the other configuration. The profile must be running for it to pass any traffic, even in Pass-Through mode.

    HW Pass-Through
    Selecting the HW Pass-Through checkbox causes the two physical ports to be connected by physical relays, effectively making them a single wire. This takes LANforge completely out of the loop and allows full wire-speed throughput with no impairments. This mode is only supported by special NIC hardware and drivers, which may not exist on your system.

    Kernel-Mode
    Selecting the Kernel-Mode checkbox allows for much higher emulation speeds and supports all features of the normal WAN emulation mode. Kernel-Mode is available for the WAN emulation if you are using a pre-compiled Linux kernel from the Candela downloads page.

    The WanLink Endpoints entries are described in detail below. The settings for each endpoint apply to packets entering the associated Port.

    Port
    The external ethernet interface this Entry Point resides on. Ports used in WanLinks should have their IP address, MASK, and Gateway set to 0.0.0.0 at least when the WanLink is running. LANforge will forcefully set the IP to 0.0.0.0 as soon as you start the WanLink.

    Jitter Frequency
    This determines how often we will randomly apply jitter to packets flowing through this WanLink. The units are X per million. So, if you wanted about 1 out of every 100 packets to have jitter applied to them, you would enter 10000 here. A percentage (0.07%, for example), can also be entered. Please see the Jitter section as well.

    Transfer Rate
    How much data will this Entry Point accept per second. Units are bits-per-second.

    Backlog Buffer
    Most equipment that you will find in any network will contain a certain amount of buffers to smooth bursty traffic so that packets are not needlessly dropped. The backlog buffer is your way of configuring this value. The units are in 1024 bytes (1KB). The size of the buffer depends on many things, and should generally be bigger for higher-speed simulations. Due to the bursty nature of Ethernet (and ethernet drivers in common systems), we suggest these buffer sizes when trying to simulate a relatively well architected WAN:

    WanLink Speed Backlog Buffer Size
    56Kbps - 256Kbps 2-8
    257Kbps - 1.54Mbps 8-32
    1.5Mbps - 45Mbps 32-256
    45Mbps - 155Mbps 256-1024
    155Mbps - 1Gbps 1024-8192

    Selecting AUTO will set the backlog such that it can hold 50 ms of data at the configured speed. For instance, if the rate is 10Mbps, AUTO mode will cause the backlog to be set to 62KB.

    Delay
    How much latency (in milliseconds) will be added to each packet as it enters this Entry Point.

    Jitter
    How much random jitter will be added to each packet as it enters this Entry Point. This will be a random value between 0 and the value entered here. It will not cause any packet re-ordering. If one packet is jittered a large amount, and there are packets immediately following it, they will also be delayed until the jittered packet is transmitted. For this reason, you should probably not set jitter-frequency above 20% if you are running packets through the LANforge at near its maximum emulation speed. If you are running packets at slower speeds, then it is not so important to worry about making the jitter frequency too high because it is less likely there will be a packet immediately following the jittered packet. Please see the Jitter-Frequency setting as well.

    Drop Frequency (Drop-Freq)
    How many packets out of every 1 million (1,000,000) will be purposefully dropped. This is used to simulate errors on the WAN.

    Reorder Frequency (Reorder-Freq)
    How many packets out of every 1 million (1,000,000) will be purposefully reordered. You can configure the min and max reorder offset in the 'Advanced' configuration screen. This is used to simulate behavior that you will see in multi-path networks and is good for testing RTP and other streaming protocols.

    Duplicate Frequency (Dup-Freq)
    How many packets out of every 1 million (1,000,000) will be purposefully duplicated. This will cause the other side of the simulated WAN to receive two identical packets. This is used to simulate errors on the WAN.

    Dump Packets
    If selected, then all packets received will be logged to the specified file. They can later be replayed with a LANforge-FIRE custom-ethernet connection. This allows the capture and replay of packet flows and protocols that exactly fit your environment.

    Replay
    Selecting the 'Replay' checkbox directs the LANforge-ICE entry point connection to modify its impairment values to match those captured in the specified LANforge-ICEcap XML file. The 'Loop Replay', 'Replay Latency', 'Replay Loss' and 'Replay Bandwidth' checkboxes are then enabled to tailor the behavior described by the XML file. Changes to the Replay settings on a running WanLink will not take effect until the WanLink is stopped and restarted. Please note that this does not directly relate to the 'Dump Packets' feature.

    Advanced Configuration
    You c