Knowledge base : Download Area > ByteBlower > Previous Releases > ByteBlower Python / TCL API

ByteBlower API 2.21 Changelog

For users of the ByteBlower API, there have been several additions.

Enhancements

  • The IPv6 configuration object now has a new method "SelectSourceAddressFor” that performs source address selection for a given destination address.
  • ResultsRefreshAll() is now available on the ByteBlower MeetingPoint too.
  • The ByteBlower API for Python now supports Python 3.11
  • ResultsRefresh() now also works on results by the ByteBlower Endpoint

2.20.2   (2023-04-03)

Fixes

When the Scenario Heartbeat interval was set after Prepare() was executed on

an Endpoint, the new Scenario Heartbeat interval value was not propagated to the Endpoint.

The MeetingPoint could mark an Endpoint as "unavailable" when a test longer

than 1 minute was running.

This could lead to the ByteBlower GUI stopping a scenario while the test was

(rightfully) still running

2.20.0   (2023-02-27)

New features 

  • The server now provides latency histograms over time when using the latency distribution trigger. This allows to have latency histograms per configured measurement interval.   
    This feature is useful when measuring the QeD performance of a specific flow. 

Enhancements 

  • The TPID (EtherType) of a VLAN tag can now be configured through the API. 
  • Faster filtering for traffic containing multiple VLAN tags. 
  • The ByteBlower 2100 and ByteBlower 4100 server series did not support 4 stacked VLAN tags as the other series did.  Now all systems have the same limit. 
  • The MeetingPoint will now automatically query the ByteBlower Endpoint for the test results when the Endpoint returns after a test. 
  • The MeetingPoint needed up to 5 seconds for initial registration of an Endpoint.  The MeetingPoint now temporarily lowers the communication interval so this procedure finishes earlier. 
  • The MeetingPoint tagged unverified ByteBlower Endpoint platforms as “Unsupported”.  The tag is renamed to “Unverified”, which means Excentis did not have tested this platform. 

Bugs fixed 

  • The MeetingPoint stopped accepting API calls when an “Unavailable” ByteBlower Endpoint was addressed.  This did not only influence the calling test, but also effected other tests and users with “Available” Endpoints.  The only remedy for this was restarting the ByteBlower MeetingPoint service on the ByteBlower server. 

Changelog 2.10.0 (2019-04-24)

Download

You can download the latest version at https://setup.byteblower.com/software.html.

Enhancements

  • Added TCP-restart function for HTTP.Client.Mobile

Fixes

  • Updated documentation (https://api.byteblower.com)
  • Communication interruption between meetingpoint and API could cause the API to crash. This crash happens when you try to clean-up meetingpoint and releated objects. This has been fixed

Misc

  • ByteBlowerServerServiceInfo License.Get is now deprecated
  • MeetingpointServiceInfo License.Get is now deprecate

ByteBlower API 2.11.6 (2020-04-15)

Download

You can download the latest version at https://setup.byteblower.com/software.html.

Enhancements

  • Added support for python 3.7 and Windows 64 bits.

Fixes

  • The red 'evaluation license' message has been fixed. Due to a build error the (TCL) installers were created with an evaluation version of BitRock.

ByteBlower API 2.11.4

This API version was not released, this is a ByteBlower Server release only.

ByteBlower API 2.11.2 (2020-02-11)

Download

You can download the latest version at https://setup.byteblower.com/software.html.

Enhancements

  • Added the possibility to configure the BROADCAST/UNICAST DHCP flag.  The ByteBlower Port will use this in the DHCP Process
  • Added extra DHCP timing statistics (timestamps when the DHCP discover/offer/request/ack, DHCPv6 solicit, advertise, request, reply are sent or received)

Fixes

  • When Refresh was called on an OutOfSequence trigger, the result information was invalidated.  Accessing this information caused a crash of the API.
  • When the DHCPv6 Session Information was requested, the actual information was not requested on the server, thus needing an extra Refresh call.  This inconsistency with the other parts of the API is fixed.

ByteBlower API 2.11.0 (2019-12-04)

Download

You can download the latest version at https://setup.byteblower.com/software.html.

Enhancements

  • Added support for the Wireless Endpoint to collect network information over time.

Fixes

  • TCL: The signature for the deprecated method Pcap.Save on our Rx.Capture.Basic was wrong and resulted in an error.
  • TCL: The NetworkInfo object on a Wireless Endpoint can now be Refreshed.
  • Fixed an issue where it was impossible to fetch the Result History for a Frame configured on a Wireless Endpoint.

Misc

  • Our Python API (beta) is now available as a Python wheel instead of using a custom installer.  This gives us the possibility to release them later using PyPi

ByteBlower API 2.12.12 (2021-04-28)

Download

You can download the latest version at https://setup.byteblower.com/software.html.

Fixes

  • Fix crash of the ByteBlower client that could happen when calling API methods on a broken RPC connection.

ByteBlower API 2.12.6-2.12.10

This API version was not released, this is a ByteBlower Server release only.

ByteBlower API 2.12.4 (2021-01-07)

Fixes

  • Fix potential crash of the ByteBlower client that could happen when calling "Members.Clear" on a ScheduleGroup.

Misc

  • Our TCL installer and remote capture tool are now signed with a valid code signing certificate.
  • Our Python API is now available for python 2.7, 3.5, 3.6, 3.7 and 3.8 across all platforms.

ByteBlower API 2.12.2

This API version was not released, this is a ByteBlower Server release only.

ByteBlower API 2.12.0

This API version was not released, this is a ByteBlower Server release only.

Download

The downloads for windows/macOS/Linux are found at following location: https://setup.byteblower.com/software.html .

ByteBlower API 2.14.2 (2022-01-25)

Enhancements

  • Exposing the WiFi Receive rate on the NetworkInterface. When unavailable, -1 will be returned.

Changelog 2.19.0 (20/10/2022)

Download

You can download the latest version at https://setup.byteblower.com/software.html.

Enhancements

    • The API now allows the user to configure continuous communication between the ByteBlower Endpoint and ByteBlower MeetingPoint.  Therefore 2 new methods are added to the WirelessEndpoint object:
      • ScenarioHeartbeatIntervalGet() which allows to read the currently configured Scenario Heartbeat interval.
      • ScenarioHeartbeatIntervalSet(nanoseconds) which allows to set the interval on which the ByteBlower Endpoint should try to communicate with the ByteBlower MeetingPoint.
        A value of 0 disables continuous communication between the ByteBlower Endpoint and the ByteBlower MeetingPoint, which is the behaviour as per pre 2.19.0.
    • The API can now stop a running test on the ByteBlower Endpoint. 
      Therefore one new method is added to the WirelessEndpoint object:
      • Stop().
        In order for this feature to work, the ScenarioHeartbeatInterval parameter must be set to a value other than 0 (disabled) and the ByteBlower Endpoint and ByteBlower MeetingPoint must be running software version 2.19.0 or higher.

    Fixes

    • The ByteBlower TCL API did not have Scenario.Duration.Set method available on the WirelessEndpoint object.

    Downloads

    You can download this version of the TCL API from these locations:

    • [[SecureDownload:ByteBlower/API/Tcl/2.9.8/ByteBlower-API-Tcl-windows-x86-installer.exe:Windows TCL installer]]
    • [[SecureDownload:ByteBlower/API/Tcl/2.9.8/ByteBlower-API-Tcl-linux-x86-installer.run:Linux 32bit TCL installer]]
    • [[SecureDownload:ByteBlower/API/Tcl/2.9.8/ByteBlower-API-Tcl-linux-x86_64-installer.run:Linux 64bit TCL installer]]
    • [[SecureDownload:ByteBlower/API/Tcl/2.9.8/ByteBlower-API-Tcl-osx-installer.dmg:Mac OS X TCL installer]]
    • [[SecureDownload:ByteBlower/API/Tcl/2.9.8/ByteBlower-API-Tcl-universal.zip:Zip including packages for all platforms for Tcl.]]

    TCL examples can be found on our github

    You can download this version of the Python API from these locations:

    • [[SecureDownload:ByteBlower/API/Python/2.9.8/ByteBlower-API-Python-windows-x86-installer.exe:Windows Python installer]]
    • [[SecureDownload:ByteBlower/API/Python/2.9.8/ByteBlower-API-Python-linux-x86-installer.run:Linux 32bit Python installer]]
    • [[SecureDownload:ByteBlower/API/Python/2.9.8/ByteBlower-API-Python-linux-x86_64-installer.run:Linux 64bit Python installer]]
    • [[SecureDownload:ByteBlower/API/Python/2.9.8/ByteBlower-API-Python-osx-installer.dmg:Mac OS X Python installer]]
    Python examples can be found on our github

    Documentation

    The HTML reference documentation for both the Python and Tcl API

    • Online: http://api.byteblower.com
    • Offline: [[SecureDownload:ByteBlower/API/Tcl/2.9.8/documentation-html.zip:Reference documentation]]

    Changelog 2.9.0 (2018-07-03)

    Enhancements

    • Adding support for the PacketDump feature. PacketDump allows to capture bidirectional traffic on an interface.
    • Latency measurement tag_format: Microseconds_CRC is marked as obsolete and is not supported in ByteBlower server 2.9 anymore

    This API release includes the beta release of the Python code. You find an introduction to the Python API in this howto.

    The full change-log is found at the bottom of this article.

    Downloads

    You can download this version of the TCL API from these locations:

    • [[SecureDownload:ByteBlower/API/Tcl/2.7.0/ByteBlower-API-Tcl-windows-x86-installer.exe:Windows TCL installer]]
    • [[SecureDownload:ByteBlower/API/Tcl/2.7.0/ByteBlower-API-Tcl-linux-x86-installer.run:Linux 32bit TCL installer]]
    • [[SecureDownload:ByteBlower/API/Tcl/2.7.0/ByteBlower-API-Tcl-linux-x86_64-installer.run:Linux 64bit TCL installer]]
    • [[SecureDownload:ByteBlower/API/Tcl/2.7.0/ByteBlower-API-Tcl-osx-installer.dmg:Mac OS X TCL installer]]
    • [[SecureDownload:ByteBlower/API/Tcl/2.7.0/ByteBlower-API-Tcl-universal.zip:Zip including packages for all platforms for Tcl.]]

    You can download this version of the Python API from these locations:

    • [[SecureDownload:ByteBlower/API/Python/2.7.0/ByteBlower-API-Python-windows-x86-installer.exe:Windows Python installer]]
    • [[SecureDownload:ByteBlower/API/Python/2.7.0/ByteBlower-API-Python-linux-x86-installer.run:Linux 32bit Python installer]]
    • [[SecureDownload:ByteBlower/API/Python/2.7.0/ByteBlower-API-Python-linux-x86_64-installer.run:Linux 64bit Python installer]]
    • [[SecureDownload:ByteBlower/API/Python/2.7.0/ByteBlower-API-Python-osx-installer.dmg:Mac OS X Python installer]]

    Documentation

    The HTML reference documentation for both the Python and Tcl API

    • [[SecureDownload:ByteBlower/API/Tcl/2.7.0/documentation-html.zip:Reference documentation]]

    Changelog 2.7.0 (2017-08-29)

    Enhancements

    • Introduction of the Layer4.Tcp.Tunnel. [br] This feature allows one to tunnel TCP traffic through a ByteBlower port. It makes remote debugging much more easy.
      • ByteBlowerPort::Tunnel.Tcp.Add creates a Layer4.Tcp.Tunnel.
    • Made the Python API publicly available.
    • The new call ByteBlowerPort::Interface.Speed.Get returns the bitrate of the parent interface.
    • Minimized communication overhead when destroying Layer5.Http.Client

    This release of the Tcl API brings new features and bug fixes.

    Type of service support on protocol stack

    Some services suffer more from network delay than others. That's why both IPv4 and IPv6 are capable of defining the needed priorities in both delay and loss. For IPv4, the ToS field - renamed to DSCP field - is used for this, while IPv6 uses Class of Service.

    ToS/DSCP (IPv4) and TrafficClass (IPv6) support has been enabled on the protocol stack:

    • HTTP Client (IPv4 and IPv6): Layer5.Http.Client::TypeOfService.Set
    • ICMP (IPv4): Layer3.IcmpEchoSession::TypeOfService.Set
    • ICMPv6 (IPv6): Layer3.Icmpv6EchoSession::TrafficClass.Set

    This feature requires ByteBlower server >= 2.5.0

    PPPoE Client

    Now the ByteBlower server has support for PPPoE Client, we re-enabled the API in this release.

    The client includes support for IPv4 and IPv6 via the Network Control Protocols IPCP, resp. IPv6CP. PPP authentication is possible via PAP or CHAP.

    For more information, please check our documentation of the Layer2_5.Pppoe.Client.

    This feature requires ByteBlower server >= 2.5.0

    Backwards compatibility

    The changes between to API 1.x and 2.x are significant. We won't provide the details of every change here but focus on the major ideas and changes. More info can be found in the documentation of the API.

    The 2.x API supports ByteBlower server versions >= 2.1.0. Older versions of the server are no longer supported.

    We preserved backwards compatibility at API level as much as possible. Many users will be able to just run the existing code using the new API. If this is not the cases, minor changes might be needed. If you don't succeed doing so, please don't hesitate to contact us for support.

    Known issues

    • Unimplemented protocols
      • Real-time Transport Protocol (RTP)
      • Real-time Transport Control Protocol (RTCP)
      • Port Control Protocol (PCP)
    • Unavailable features
      • USB interfaces

    Changelog 2.5.2

    Enhancements

    • Improved Destructor speed.
    • Disabled some excessive logging
    • Exceptions during Refresh are now propagated to the user.

    Bug Fixes

    • Fixed issue with client-server communication in Schedule Groups.
    • Fixed issue in argument validation in HTTPClient::Local.Port.Set and HTTPClient::Remote.Port.Set.
    • HTTPClient::WaitUntilFinished: If we enter the error state after successful connection establishment then we assume a TCP RST (reset) was received.

    Changelog 2.5.0

    Enhancements

    • Added support for ToS/DSCP (IPv4) and TrafficClass (IPv6) on the protocol stack:
      • HTTP Client (IPv4 and IPv6)
      • ICMP (IPv4)
      • ICMPv6 (IPv6)
    • Re-enabled PPPoE Client support including IPCP/IPv6CP and PAP/CHAP
    • excentis_basic:
      • Add support for generating VLAN tag and PPPoE header
    • HL API:
      • Added method to auto-complete the Layer 2 and Layer 2.5 headers in a frame to match the transmitting ByteBlowerPort: ::excentis::ByteBlower::LinkLayer.AutoComplete
      • Added helper functions for PPPoE client setup.
    • examples:
      • Added example scripts for PPPoE client API

    Bug Fixes

    • Fixed issue where ByteBlower client sessions were not cleaned up properly: Enabled TCP keep-alive on management connection.

    Download

    The ByteBlower API 2.5 is not available anymore through the support portal. Of course you can still contact us at support@excentis.com.

    Documentation

    The HTML reference documentation for this API version

    • [[SecureDownload:ByteBlower/API/Tcl/2.5.2/documentation-html.zip:Reference documentation]]

    We are pleased to announce that the ByteBlower Tcl API reference documentation is now available as a downloadable package!

    This documentation provides:

    • General information about the structure and usage of the API software
    • Complete reference documentation for both the "higher-layer" and "lower-layer" APIs
    • List of known bugs and deprecated calls
    • Selection of both short and extended real-life examples

    Nearly all methods of the most important classes are documented. Their documentation includes:

    • Purpose and functionality of API methods
    • Method arguments and their argument types
    • Default server property values for getter and setter method
    • Return value and type
    • ...

    Over time the rest of the classes, modules and methods will be documented as well. In the meantime, simply open a support ticket whenever you feel that relevant information is missing. We will then gladly provide you with the necessary information and update the reference documentation!

    The download link will always contain the latest revision of the API documentation. You can check out the version history below to make sure your documentation remains up-to-date.

    We are also working on the integration of the reference documentation into this support portal. Once this is done, users will be able to access the latest documentation online as well!

    Changelog

    • 23/01/2017 : API 2.5.2
      • Add missing documentation for ByteBlowerServer::Interface.Names.Get.
    • 19/10/2016 : API 2.5.0
      • Fixed incorrect references to other documentation.
      • Added deprecated tags and extra version info.

    Download

    The documentation for ByteBlower API 2.5 is no longer available for download. Please contact our support desk if you think you need this specific version.

    We are pleased to announce that the ByteBlower Tcl API reference documentation is now available as a downloadable package!

    This documentation provides:

    • General information about the structure and usage of the API software
    • Complete reference documentation for both the "higher-layer" and "lower-layer" APIs
    • List of known bugs and deprecated calls
    • Selection of both short and extended real-life examples

    Nearly all methods of the most important classes are documented. Their documentation includes:

    • Purpose and functionality of API methods
    • Method arguments and their argument types
    • Default server property values for getter and setter method
    • Return value and type
    • ...

    Over time the rest of the classes, modules and methods will be documented as well. In the meantime, simply open a support ticket whenever you feel that relevant information is missing. We will then gladly provide you with the necessary information and update the reference documentation!

    The download link will always contain the latest revision of the API documentation. You can check out the version history below to make sure your documentation remains up-to-date.

    We are also working on the integration of the reference documentation into this support portal. Once this is done, users will be able to access the latest documentation online as well!

    Changelog

    • 31/05/2016 : API 2.4.0

    Download

    The documentation for ByteBlower API 2.4 is no longer available for download. Please contact our support desk if you think you need this specific version.

    This release of the Tcl API brings some bug fixes.

    Backwards compatibility

    The changes between to API 1.x and 2.x are significant. We won't provide the details of every change here but focus on the major ideas and changes. More info can be found in the documentation of the API.

    The 2.x API supports ByteBlower server versions >= 2.1.0. Older versions of the server are no longer supported.

    We preserved backwards compatibility at API level as much as possible. Many users will be able to just run the existing code using the new API. If this is not the cases, minor changes might be needed. If you don't succeed doing so, please don't hesitate to contact us for support.

    Known issues

    • Unimplemented protocols
      • Real-time Transport Protocol (RTP)
      • Real-time Transport Control Protocol (RTCP)
      • Port Control Protocol (PCP)
    • Unavailable features
      • USB interfaces

    Changelog 2.4.0

    Bug Fixes

    • Fix possible inconsistency in "interval" vs. "cumulative" history results.
    • Fixed assertion failure when an older (< 2.3.0) server is used.
    • Fixed some 64-bit calculations in examples when running on 32-bit Tcl.
    • Fixing some incorrect deprecated warning messages.
    • Fixed some error messages.

    Download

    ByteBlower API 2.4 is no longer available for download. Please contact our support desk if you think you need this specific version.

    This release of the Tcl API brings some exiting new features!

    The larger part of changes will speed up test initialization and reporting.

    Asynchronous protocol initialization

    ARP, DHCP and DHCPv6 can now be initiated asynchronously. This allows the user to send out the requests in parallel and process the results afterwards.

    This is especially good news for large scale tests!

    Result History and batch refresh

    The batch functionality supports simultaneous refresh of multiple result objects (History, snapshot of Rx.Trigger.Basic, Rx.Latency.Basic, Rx.OutOfSequence, etc.). This decreases the client-server network load, but even more it allows for shorter test scripts and much shorter test time!

    Please take a look at our new example script back2back/multi-refresh.

    Result History now has two additional methods on interval and cumulative results:

    1. GetByTime (Cumulative.GetByTime and Interval.GetByTime): Search the history results for a snapshot with the given timestamp.
    2. Latest.Get (Cumulative.Latest.Get and Interval.Latest.Get): Returns the latest closed snapshot. See documentation for more information.

    Both of these methods will avoid the need in tests scripts for error-prone loops looking for a specific snapshot.

    Added Rx.Capture.ResultSnapshot::Frames.GetByIndex <index>. This avoids the need to obtain the complete list of captures to get a single captured frame. This also improves test script speeds a lot when processing large captures.

    Telnet support

    This version of the ByteBlower API brings back the support for the Telnet client which was delayed from the 2.0 release.

    In conjunction with ByteBlower server version >= 2.2.0, you will now be able to telnet to your devices again!

    TCP Congestion Avoidance

    This version supports the new CUBIC congestion avoidance algorithm extension which is introduced in server version 2.2.0.

    Backwards compatibility

    The changes between to API 1.x and 2.x are significant. We won't provide the details of every change here but focus on the major ideas and changes. More info can be found in the documentation of the API.

    The 2.x API supports ByteBlower server versions >= 2.1.0. Older versions of the server are no longer supported.

    We preserved backwards compatibility at API level as much as possible. Many users will be able to just run the existing code using the new API. If this is not the cases, minor changes might be needed. If you don't succeed doing so, please don't hesitate to contact us for support.

    Known issues

    • Unimplemented protocols
      • Real-time Transport Protocol (RTP)
      • Real-time Transport Control Protocol (RTCP)
      • Port Control Protocol (PCP)
    • Unavailable features
      • USB interfaces

    Changelog 2.2.4

    • Add exceptions: BadIPv4Address and BadIPv6Address (used by Telnet).
    • Fixed some incorrect exceptions
    • Fixed inconsistencies in DHCP and DHCPv6 Protocol
      • Renamed Layer5.Dhcp::ReleaseEnable to Layer5.Dhcp::Release.Enable
      • Added missing Layer5.Dhcp::Release.IsEnabled and Layer5.Dhcpv6::Release.IsEnabled
      • Added missing Release and Release.Enable methods in Layer5.Dhcpv6 (requires server version >= 2.2.4)
    • Added missing calls Rx.Latency.Basic.ResultData::Timestamp.First.Get and Rx.Latency.Basic.ResultData::Timestamp.Last.Get
    • Fixed possible division by zero when calculating data rates

    Changelog 2.2.2

    • Added static call wrapper "ByteBlower Results.Refresh $args" (avoids the need for "[ ByteBlower Instance.Get ] Results.Refresh $args"
    • Result snapshot and result history objects now throw exceptions consistently
      when values would be returned which have no meaning (at the moment).
      E.g. "minimum/maximum frame size" have no meaning when packet count is zero.
    • Fixed compiler issues related exception handling on Mac OS X
    • Fixed several small issues with ByteBlowerPort history counters.

    Changelog 2.2.0

    • Re-enabled Telnet support (Requires ByteBlower server version >= 2.2.0).
    • ARP, DHCP and DHCPv6 can now be initiated in parallel.
    • Added batch support for result history.
    • Added GetByTime and Latest.Get methods on history cumulative and interval results.
    • Added Rx.Capture.ResultSnapshot::Frames.GetByIndex <index>.
    • Updated documentation related to the realtime results (i.e. history and snapshots) and TCP.
    • Fixed some issues in installer regarding existing installations.
    • Fixed issue when ByteBlowerPort results are unavailable.
    • Fixed incorrect Clear of ByteBlowerPort (history).
    • Fixed incorrect values in ByteBlowerPort (history) counters.
    • Destructing Rx.Capture now really destroys the capture at server side.
    • Fixed Refreshtimestamp.Get on result history object.
    • Fixed issue in ByteBlowerHL ExecuteScenario which stopped.
      the ports too late after waiting for incoming packets.
    • Fixed issue where Rx.Capture.RawPacket failed to retreive new frames.
    • Add new example scripts:
      • back2back/multi-refresh
    • Updated example script to the new architecture
      • random_traffic
      • back2back/icmp_frame_blasting
      • back2back/multi-port
      • back2back/multiserver
    • Update examples with new and more efficient method calls:
      • random_traffic
      • tcp-ack-suppression
      • back2back/icmp_frame_blasting
      • back2back/multi-port
      • back2back/multiserver
      • back2back/tcp
      • back2back/tcpv6
      • tcp/multisession
      • tcp/time-based
      • tcp/with-mtu
      • http/uri-capture
      • vlan/tcp
      • igmp/querier
      • mld/with-traffic

    Download

    ByteBlower API 2.2 is no longer available for download. Please contact our support desk of you think you need this specific version.

     

    We are pleased to announce that the ByteBlower Tcl API reference documentation is now available as a downloadable package!

    This documentation provides:

    • General information about the structure and usage of the API software
    • Complete reference documentation for both the "higher-layer" and "lower-layer" APIs
    • List of known bugs and deprecated calls
    • Selection of both short and extended real-life examples

    Nearly all methods of the most important classes are documented. Their documentation includes:

    • Purpose and functionality of API methods
    • Method arguments and their argument types
    • Default server property values for getter and setter method
    • Return value and type
    • ...

    Over time the rest of the classes, modules and methods will be documented as well. In the meantime, simply open a support ticket whenever you feel that relevant information is missing. We will then gladly provide you with the necessary information and update the reference documentation!

    The download link will always contain the latest revision of the API documentation. You can check out the version history below to make sure your documentation remains up-to-date.

    We are also working on the integration of the reference documentation into this support portal. Once this is done, users will be able to access the latest documentation online as well!

    Changelog

    • 23/11/2015 : API 2.2.4
    • 04/11/2015 : API 2.2.2
    • 19/10/2015 : API 2.2.0

    Download

    The documentation for ByteBlower API 2.2 is no longer available for download. Please contact our support desk of you think you need this specific version.

     

    We are pleased to announce that the ByteBlower Tcl API reference documentation is now available as a downloadable package!

    This documentation provides:

    • General information about the structure and usage of the API software
    • Complete reference documentation for both the "higher-layer" and "lower-layer" APIs
    • List of known bugs and deprecated calls
    • Selection of both short and extended real-life examples

    Nearly all methods of the most important classes are documented. Their documentation includes:

    • Purpose and functionality of API methods
    • Method arguments and their argument types
    • Default server property values for getter and setter method
    • Return value and type
    • ...

    Over time the rest of the classes, modules and methods will be documented as well. In the meantime, simply open a support ticket whenever you feel that relevant information is missing. We will then gladly provide you with the necessary information and update the reference documentation!

    The download link will always contain the latest revision of the API documentation. You can check out the version history below to make sure your documentation remains up-to-date.

    We are also working on the integration of the reference documentation into this support portal. Once this is done, users will be able to access the latest documentation online as well!

    Changelog

    • 08/03/2016 : API 2.3.0

    Download

    The documentation for ByteBlower API 2.3 is no longer available for download. Please contact our support desk of you think you need this specific version.

     

    This release of the Tcl API brings some exiting new features!

    Q-in-Q

    Multiple VLANs can be added to:

    • transmit and receive frames
    • and on our protocol stack.

    The implementation conforms 802.11ad specs.

    Please take a look at our update example script vlan/ipv4.

    Frame Field Modifiers

    When using ByteBlower Server version >= 2.3.0, you will be able to add conent modifiers on frame. The first content modifiers are the frame field modifiers. You can modify a certain field in the frame with either incrementing or random values.

    Please take a look at our new example script back2back/framefieldmodifier.

    Extended information can be found in our documentation.

    Configurable result history

    It is now possible to change the duration of the sampling interval and the sampling buffer length.

    This allows the user to either obtain very fine-grained history or a more "averaged" result of your traffic history.

    Please take a look at the methods on the ResultHistory objects:

    • Sampling.Interval.Duration.Set: Configures the duration of a sampling interval. All snapshots will be aligned to the new interval duration.
    • Sampling.BufferLength.Set: Configures the maximum number of snapshots maintained at the server.

    and the methods on the ResultData and ResultSnapshot objects:

    • Interval.Duration.Get: Returns the actual interval duration of a result snapshot.

    You can find the details on how the server and client manage the history buffer in our API documentation.

    Backwards compatibility

    The changes between to API 1.x and 2.x are significant. We won't provide the details of every change here but focus on the major ideas and changes. More info can be found in the documentation of the API.

    The 2.x API supports ByteBlower server versions >= 2.1.0. Older versions of the server are no longer supported.

    We preserved backwards compatibility at API level as much as possible. Many users will be able to just run the existing code using the new API. If this is not the cases, minor changes might be needed. If you don't succeed doing so, please don't hesitate to contact us for support.

    Known issues

    • Unimplemented protocols
      • Real-time Transport Protocol (RTP)
      • Real-time Transport Control Protocol (RTCP)
      • Port Control Protocol (PCP)
    • Unavailable features
      • USB interfaces

    Changelog 2.3.0

    New features

    • Add support for Q-inQ
      • Updated Tcl-HL example scripts
    • Add support for Frame Field Modifiers
      • Including new Tcl-HL example script
    • Allow the user to configure the result history metrics
    • x86 support has been dropped for Mac OS X

    Enhancements

    • ExecuteScenario frame specification now has extra options to enable auto-correction L3/L4 checksum and L3/L4 length.
    • ExecuteScenario frame specification now has the option to specify the size modifier (since the size modifier moved from stream to the frame since API/server version 2.1.0).
    • The tcp ack-suppression example now uses information from the protocol stack instead of TX capture (which was not possible on 2x00, 3100 and 4100 series servers).
    • Added call to get current server timestamp (ByteBlowerServer::TimestampGet).
    • Result history snapshots and history data objects now contain info about the actual interval duration.
      • Revised and cleaned up generation of flat-list of history snapshots.
    • Fixed some consistency in the API:
      • Added missing result objects for ICMP and ICMPv6 protocol (via Layer3.IcmpEchoSession::Result.Get, resp. Layer3.Icmpv6EchoSession::Result.Get).
      • Layer3.IcmpEchoSession::DestinationIp.Get and Layer3.IcmpEchoSession::DestinationIp.Set have been renamed to Layer3.IcmpEchoSession::Remote.Address.Get, resp. Layer3.IcmpEchoSession::Remote.Address.Set.
        • Idem for Layer3.Icmpv6EchoSession.
        • The old method names are kept for backward-compatibility.
    • Enhanced documentation on several places.

    BugFixes

    • Telnet client was not destructible.
    • Telnet client did not check for valid remote port range.
    • Fixes in documentation since move of size modifiers from stream to frame.
    • FrameSizeModifier.Result::Timestamp.Get always returned 0.
    • Fixed issues on 32-bit Tcl for back2back/multi-refresh example script.

    Download

    ByteBlower API 2.3 is no longer available for download. Please contact our support desk of you think you need this specific version.

    The changes between to API 1.x and 2.x are significant. We won't provide the details of every change here but focus on the major ideas and changes. More info can be found in the documentation of the API.

    Consistency

    During the development of the 2.1 API, we put a lot of effort in getting the naming of methods and classes more consistent. During the lifetime of the 1.x API methods were added but not always in a consistent way.

    Extended

    The API is now extended with calls to support the new features such as the real-time results.

    Backwards compatibility

    We preserved backwards compatibility as much as possible. Many users will be able to just run the existing code using the new API. If this is not the cases, minor changes might be needed. If you don't succeed doing so, please don't hesitate to contact us for support.

    Fast and clean

    Although backwards compatibility remained, the implementation is brand new! We removed all unnecessary code and have now a new platform for the future!

    Known issues

    • Unimplemented protocols
      • Telnet
      • Real-time Transport Protocol (RTP)
      • Real-time Transport Control Protocol (RTCP)
      • Port Control Protocol (PCP)
    • Unavailable features
      • USB interfaces

    Changelog 2.1.2

    • Correct calculation of the Rx.All port counters
    • Disable debug output
    • Update examples
      • random_traffic
      • back2back/icmp_frame_blasting
      • back2back/multi_port
      • tcp/with_mtu

    Download

    ByteBlower API 2.1.0 is no longer available for download. Please contact our support desk of you think you need this specific version.

    We are pleased to announce that the ByteBlower Tcl API reference documentation is now available as a downloadable package!

    This documentation provides:

    • General information about the structure and usage of the API software
    • Complete reference documentation for both the "higher-layer" and "lower-layer" APIs
    • List of known bugs and deprecated calls
    • Selection of both short and extended real-life examples

    Nearly all methods of the most important classes are documented. Their documentation includes:

    • Purpose and functionality of API methods
    • Method arguments and their argument types
    • Default server property values for getter and setter method
    • Return value and type
    • ...

    Over time the rest of the classes, modules and methods will be documented as well. In the meantime, simply open a support ticket whenever you feel that relevant information is missing. We will then gladly provide you with the necessary information and update the reference documentation!

    The download link will always contain the latest revision of the API documentation. You can check out the version history below to make sure your documentation remains up-to-date.

    We are also working on the integration of the reference documentation into this support portal. Once this is done, users will be able to access the latest documentation online as well!

    Changelog

    • 7/5/2015 : Preview release
    • 8/6/2015 : API 2.1.0 
    • 5/8/2015 : API 2.1.2 

    Download

    The documentation for ByteBlower API 2.1.0 is no longer available for download. Please contact our support desk of you think you need this specific version.

    We to help you!