Ixia Software Release Notes
HLT API 4.30 GA Patch1
Build Number: 9.39.2310.7 (October 10, 2023)


About This Release 

HLTAPI 4.30 GA Patch1 is a patch to the "General Availability" release of HLTAPI
4.30. 

It is a full-featured, fully-supported HLTAPI release that may be used in 
a production environment when new features and/or hardware support are required.
Several new features have been added, please see the "What's New" section below 
for more information.


Upgrading from a release prior to IXOS 5.10 SP2

To ensure proper operation of an Ixia chassis with IxOS 5.10 EA SP3 or later 
releases of IxOS 5.10, prior to installing this release you must un-install all
previous versions of Ixia applications, Ixia StatEngine, Ixia StatEngine PCPU 
packages and IxOS. You should use the Add/Remove utility in the Windows Control
Pannel. After the un-installations are complete the chassis must be rebooted.

Ixia Software Compatibility 


        
            

                env(IXIA_VERSION)
                HLT
                IxOS
                IxRouter
                IxNetwork
               IxLoad
            

        
         
            

                HLTSET94
                4.30 GA Patch1
                6.10 GA
                N/A
                6.00 GA (P)
                5.30 EA SP1
            

            

                HLTSET95
                4.30 GA Patch1
                6.10 GA
                N/A
                6.00 GA (N)
                5.30 EA SP1
            

            

                HLTSET96
                4.30 GA Patch1
                6.10 GA
                N/A
                6.00 GA (NO)
                5.30 EA SP1
            

            

                HLTSET97
                4.30 GA Patch1
                6.10 GA
                N/A
                6.00 GA(P2NO)
                5.30 EA SP1
            

            

                HLTSET106
                4.30 GA Patch1
                6.20 EA
                N/A
                6.20 EA(P)
                5.40 EA
            

            

                HLTSET107
                4.30 GA Patch1
                6.20 EA
                N/A
                6.20 EA(N)
                5.40 EA
            

            

                HLTSET108
                4.30 GA Patch1
                6.20 EA
                N/A
                6.20 EA(NO)
                5.40 EA
            

            

                HLTSET109
                4.30 GA Patch1
                6.20 EA
                N/A
                6.20 EA(P2NO)
                5.40 EA
            

        
    



Note: Based on the HLTSET, HLT loads different sets of APIs as described below:

- *P-Loads:
   o IxOS (tclHal API)
   o IxTclProtocols
   
- *N-Loads: 
   o IxOS (tclHal API) 
   o IxTclNetwork 
   
- *NO-Loads: 
   o IxTclNetwork (only; without IxTclHal) 
   
- *P2NO-Loads: 
   o If -ixnetwork_tcl_server parameter is NOT provided in ::ixia::connect (same as *P) 
        + IxOS (tclHal API) 
        + IxTclProtocols 
   o If -ixnetwork_tcl_server parameter is provided in ::ixia::connect (same as *NO) 
        +IxTclNetwork (only; without IxTclHal)      

The default setting for env(IXIA_VERSION) is HLTSET109, if the value is not set.
If the value is set to an IxOS major.minor version, then the largest HLTSET list
that corresponds to that IxOS version is used.

For additional product compatibility information please refer to the following 
online utility. An Ixia website account is required before accessing.
  
     http://www.ixiacom.com/support/product_compatibility_matrix


IxNetwork API Notes

HLT will be supporting both of the Tcl APIs that can be run via IxNetwork. To 
determine which one you will use, the HLTSET values for IxNetwork have been 
enhanced. You will now see either a P (IxTclProtocol, old API path) or a 
N (IxTclNetwork, new API path) after the IxNetwork version in the HLTSET.


Previous Release Notes
 
Please visit the HLT API support web page for the Release Notes of previous HLTAPI versions.

Installation Notes 



Upgrading from a release prior to IXOS 5.10 SP2

To ensure proper operation of an Ixia chassis with IxOS 5.10 GA, prior to 
installing this release you must un-install all previous versions of Ixia applications,
Ixia StatEngine, Ixia StatEngine PCPU packages and IxOS. You should use the Add/Remove 
utility in  the Windows Control Pannel. After the un-installations are complete the 
chassis must be rebooted.
   

Installing on HLT API Windows

HLT API now ships with a windows installation program. To install simply execute 
HLTAPI_4.30_GA_Patch1.exe.


Installing on HLT API Linux/Solaris

The package is in a ZIP file named: ixia_hlt_api_4.30_GA_Patch1.tar.gz
 
This compressed TAR file contains all the libraries and utilities to call the 
Ixia package.
 
Copy all directories and files from the zip or tar file into the /lib directory 
of Unix or Linux. Verify that the installed environment has a pointer to where
the package files live.  If you are installing this in the lib directory 
of an Ixia IxOS installation, this will already be set up if you're using 
the Ixia provided ixwish shell script to launch scripts.
 
The library procs may be accessed via the command "package require Ixia".


Tcl/Tk Support for Client Applications

Installation of Tcl Server is required to support execution of UNIX-based legacy 
Tcl scripts.  

For UNIX-based IxNetwork API (new) Tcl scripting, it utilizes an IxNetwork GUI 
client started in Tcl Server mode as well as the Tcl Server.  Please refer to 
the IxNetwork documentation for guidance on its usage.

How to Report Problems 




    

        
            
 USA, Canada and Latin America Customer Support

        		
        
            

            

              Hours:
              6:00am PST to 6:00pm PST
            

            

              Email:
              support@ixiacom.com
            

            

              Phone:
              1-818-595-2599

            

            

              e-Fax:
              1-818-449-0992 
            

            

        		
    
     
    

        
            
 Europe, Middle East, and Africa Customer Support

        		
        
            

            

              Hours:
              07:00 to 17:30 GMT
            

            

              Email:
              eurosupport@ixiacom.com
            

            

              Phone:
              +44-1628-405797
            

            

        		
    

    

        
            
 India Customer Support

        		
        
            

            

              Hours:
              09:00 to 17:30 local time
            

            

              Email:
              support-india@ixiacom.com
            

            

              Phone:
              +91-80-22161000
            

            

        		
    

    

        
            
Japan Customer Support

        		
        
            

            

              Hours:
              09:00 to 18:00 local time (Japan), Monday through Friday
            

            

              Email:
              support-japan@ixiacom.com
            

            

              Phone:
              +81-03-5326-1948
            

            

              Fax:
              +81-03-3348-7733
            

            

        		
    

    

        
            
 Asia Pacific Customer Support

        		
        
            

            

              Hours:
              09:00 to 17:30 local time (Singapore)
            

            

              Email:
              support-asiapac@ixiacom.com
            

            

              Phone:
              +65-6332-0126
            

            

              Fax:
              +65-6332-0127
            

            

        		
    

    

        
            
China Customer Support

        		
        
            

            

              Hours:
              09:00 - 18:00 local time (Beijing time), Monday through Friday
            

            

              Email:
              support-china@ixiacom.com 
            

            

              Phone:
              +400-610-6988 for Greater China region or +86-10-8454-9199 for Taiwan or Hong Kong
            

            

              Fax:
              +86-10-8454-9198

Additional Documentation 

Please refer to our website at http://www.ixiacom.com/library. PDF and HTML 
versions of all documentation are available there.

You will be required to provide a login and password to enter this section of 
the web site. If you do not have the username and password, please forward your 
request to mailto:support@ixiacom.com.

What's New in HLT API

4.30 GA Patch1 Features

HLT API-BGP
Added md5_enable and md5_key parameters in ::ixia:: emulation_bgp_config to set authentication to md5 using both IxTclNetwork and IxTclProtocols APIs.
Added end_of_rib parameter in ::ixia::emulation_bgp_route_config for configuring BGP End of RIB (EOR) marker using both IxTclNetwork and IxTclProtocols APIs
Added HLT API support for new BGP parameters: -ttl_value in ixia::emulation_bgp_config (applicable to neighbor range), -enable_as_path in ixia::emualtion_bgp_route_config (applicable to both route range and VPN range), -enable_local_pref in ixia::emulation_bgp_route_config (applicable to VPN range).

HLT API-DHCP Server
In ixia::emulation_dhcp_server_control when invalid dhcp_handle is user the error message will be the following: "DHCP handle(s) provided to -dhcp_handle option are not valid DHCP Server handles. Parameter -dhcp_handle must be provided with a DHCP Server handle returned by emulation_dhcp_server_config in the key handle.dhcp_handle"

HLT API-HLT
Display message "Ixia cleanup session completed." when the ixia::cleanup_session returns. This will provide to the user the information that the clean up session action was completed.
For cards that support aggregate mode, HLT API added new parameters in ixia::connect to support aggregated mode at card level and/or at port resource level: -aggregation_mode -aggregation_resource_mode.

HLT API-Load Modules
Added HLT API support for LSM1000CMVDC-NG family cards.
Added HLT API support for the Lava AP 40/100GE 2P [2RP/2P-NG] cards (Protocols support, No Stack Manager support.)

HLT API-OSPF
Added support for OSPFv3 graceful restart using both IxTclNetwork and IxTclProtocols APIs

HLT API-PIM
Added support for configuring Candidate Rendez-Vous Point and Learned information for CRP-BSR, for PIM-SM protocol, using both IxTclNetwork and IxTclProtocol APIs.

HLT API-Performance
Improved performance when doing ixia::traffic_config with 32k list element for -udp_dst_port option when running from Linux client.

HLT API-Statistics
HLTAPI support for traffic_stats to return tx.elapsed_time key if IxNetwork path is used.
In ::ixia::traffic_stats added parameter -csv_path (UNIX only), in order to select the path where the CSV files are saved on UNIX client (this is useful when the user doesn't have write access in the folder where the tclsh is started). For Windows TCL client that is not on the same machine as IxNetwork TCL Server, the CSV path will be the folder where the wish console is started.

HLT API-Traffic Configuration
The supported range for parameter -tcp_ack_num in ::ixia::traffic_config has changed from 0-65535 to 0-4294967295.

Resolved Defects List

HLT API-Interface Configuration

Bug Number Notes
652644 Cannot de-select auto_detect_instrumentation in Rx mode on newer cards like 10GE LSM XM3
657427 ::ixia::interface_config call does not set the Clock Deviation in the card properties for 10GE LSM XM (NGY) card

HLT API-OSPF

Bug Number Notes
661305 ::ixia::emulation_ospf_config -mode delete does not work for IxNetwork path

HLT API-PPP

Bug Number Notes
663550 Sometimes, when issuing ::ixia::pppox_stats immediately after ::ixia::pppox_control -mode connect, the command fails with the following error: "Unable to get 'SessionView-f37e5770-431b-4be7-b339-f70333f977e9' stat view."

HLT API-Performance

Bug Number Notes
662141 Each ::ixia::emulation_igmp_control -mode "start" call takes 11 seconds (too slow).

HLT API-Statistics

Bug Number Notes
653847 ::ixia::traffic_stats returns "syntax error in expression "N/A + 254399.999" when the Rx Frames count is greater than RX Expected count.
659232 ixia::cleanup_session -clear_csv 1 does not remove the csv file on the client machine.
664334 The "Rx Expected Frames" count is missing in flow and traffic item stats when configuring traffic and retrieving statistics using an HLT script
669655 Can't find the file path in HLTAPI when getting IxNetwork statistics. This was happening only when TCL client machine was Windows and the IxNetwork TCL Server machine was different than TCL client machine. In this case the CSV file will be copied from the IxNetwork TCL Server machine to the folder where the wish console is started on the TCL client machine.

HLT API-Traffic Configuration

Bug Number Notes
653251 When modifying an IPv6 stream (with HLT API using IxTclHal), after the modification, the UDP protocol gets enabled also.
659230 ::ixia::traffic_control -action poll return key:stopped shows 1 even though GUI is transmitting.
669324 The default transmit mode for Ethernet ports is set to packet streams mode, instead of advanced scheduler mode.

Known Issues 

Please visit the HTL API support web page for more information on known issues related to this release.
An Ixia website account is required before accessing.