byteblowerll 2.22.2

Python API for the ByteBlower Traffic Generator

==========================
|ByteBlower TM| Python API
==========================

.. |ByteBlower TM| unicode:: ByteBlower U+2122

This package provides access to a ByteBlower server through the ByteBlower API.

The ByteBlower Python Interface allows the user to have fine-grained control
over the traffic generation on the ByteBlower server.

Installation
============

You can install the Python API from https://pypi.org/project/byteblowerll using


.. code-block:: bash

$ pip install byteblowerll

When Python 2.7 on 32 bit platforms is desired, one can install this from
the ByteBlower simple PyPi repository.

.. code-block:: bash

$ pip install --extra-index-url https://setup.byteblower.com/python byteblowerll


Documentation
==============

The documentation is available either `online <https://api.byteblower.com/>`_ or in the API via


.. code-block:: python

help(any_ByteBlower_object)


For example:

.. code-block:: python

from byteblowerll.byteblower import ByteBlower, ByteBlowerPort
help(ByteBlower)
help(ByteBlowerPort)


.. code-block:: python

from byteblowerll.byteblower import ByteBlower
bb = ByteBlower.InstanceGet()
server = bb.ServerAdd('byteblower-39.lab.excentis.com.')
help(server)


Quick start
===========

To start working with the ByteBlower API, load the package and connect to your
server(s).

1. Import the API entrypoint

.. code-block:: python

from byteblowerll.byteblower import ByteBlower

2. Create the root ByteBlower instance


.. code-block:: python

bb = ByteBlower.InstanceGet()


3. Connect to a ByteBlower server

.. code-block:: python

server = bb.ServerAdd('byteblower-39.lab.excentis.com.')

4. Ready to start creating ports and sending traffic!

Let's see what we have available:

.. code-block:: python

print(server.DescriptionGet())


Examples
========

Please have a look at our `Python examples of the ByteBlower API_`.
They might be a great inspiration for your customized test implementations.

.. Python examples of the ByteBlower API_: https://github.com/excentis/ByteBlower_python_examples

Support
=======

.. See http://docutils.sourceforge.net/0.4/docs/ref/rst/directives.html#image

.. ByteBlower logo
.. image:: http://static.excentis.com/byteblower_blue_transparent_background.png
:width: 400
:scale: 60
:align: right
:alt: ByteBlower
:target: byteblower_

.. "A product by Excentis" logo
.. image:: http://static.excentis.com/Aproductby.png
:width: 320
:scale: 60
:align: right
:alt: A product by Excentis
:target: excentis_

.. _byteblower: https://byteblower.com
.. _excentis: https://www.excentis.com

If you have any questions or feature request you can contact the ByteBlower
support team using:

|globe|: `Excentis Support Portal`_

|e-mail|: [e-mail]

|telephone|: [phone]

.. _Excentis Support Portal: https://support.excentis.com

.. e-mail icon:
.. |e-mail| unicode:: U+1F582

.. globe icon:
.. |globe| unicode:: U+1F30D
.. .. |globe| unicode:: U+1F310

.. telephone icon:
.. |telephone| unicode:: U+1F57D