first version

17 files changed, 1280 insertions, 0 deletions

diff --git a/scripts/automation/trex_control_plane/doc/Makefile b/scripts/automation/trex_control_plane/doc/Makefile
new file mode 100755
index 00000000..37a28d0f
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/Makefile
@@ -0,0 +1,192 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  applehelp  to make an Apple Help Book"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/T-RexProjectControlPlain.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/T-RexProjectControlPlain.qhc"
+
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/T-RexProjectControlPlain"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/T-RexProjectControlPlain"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/scripts/automation/trex_control_plane/doc/_static/no_scrollbars.css b/scripts/automation/trex_control_plane/doc/_static/no_scrollbars.css
new file mode 100755
index 00000000..f86e823a
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/_static/no_scrollbars.css
@@ -0,0 +1,10 @@
+/* override table width restrictions */
+.wy-table-responsive table td, .wy-table-responsive table th {
+    /* !important prevents the common CSS stylesheets from
+       overriding this as on RTD they are loaded after this stylesheet */
+    white-space: normal !important;
+}
+
+.wy-table-responsive {
+    overflow: visible !important;
+}
\ No newline at end of file
diff --git a/scripts/automation/trex_control_plane/doc/about_trex.rst b/scripts/automation/trex_control_plane/doc/about_trex.rst
new file mode 100755
index 00000000..97cad97d
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/about_trex.rst
@@ -0,0 +1,16 @@
+===================
+About T-Rex project
+===================
+
+Full project's official site
+----------------------------
+
+To learn all about T-Rex project, visit Cisco's internal `official site <http://csi-wiki-01:8080/display/bpsim/Home>`_
+
+Even more
+---------
+
+.. toctree::
+    :maxdepth: 2
+
+    authors
\ No newline at end of file
diff --git a/scripts/automation/trex_control_plane/doc/api/client_code.rst b/scripts/automation/trex_control_plane/doc/api/client_code.rst
new file mode 100755
index 00000000..0cda3451
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/api/client_code.rst
@@ -0,0 +1,17 @@
+

+trex_client Module documentation

+================================

+

+

+CTRexClient class

+-----------------

+

+.. autoclass:: trex_client.CTRexClient

+    :members:

+    :member-order: alphabetical

+

+CTRexResult class

+-----------------

+

+.. autoclass:: trex_client.CTRexResult

+    :members:

diff --git a/scripts/automation/trex_control_plane/doc/api/exceptions.rst b/scripts/automation/trex_control_plane/doc/api/exceptions.rst
new file mode 100755
index 00000000..d9df6484
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/api/exceptions.rst
@@ -0,0 +1,7 @@
+

+

+trex_exceptions Exceptions module

+=================================

+

+.. automodule:: trex_exceptions

+    :members:

diff --git a/scripts/automation/trex_control_plane/doc/api/index.rst b/scripts/automation/trex_control_plane/doc/api/index.rst
new file mode 100755
index 00000000..8233a634
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/api/index.rst
@@ -0,0 +1,19 @@
+
+API Reference
+=============
+The T-Rex API reference section is currently a work in progress.
+
+**T-Rex Modules**
+
+.. toctree::
+    :maxdepth: 4
+
+    client_code
+    exceptions
+
+**T-Rex JSON Template**
+
+.. toctree::
+    :maxdepth: 4
+
+    json_fields
diff --git a/scripts/automation/trex_control_plane/doc/api/json_fields.rst b/scripts/automation/trex_control_plane/doc/api/json_fields.rst
new file mode 100755
index 00000000..b1a2af7c
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/api/json_fields.rst
@@ -0,0 +1,233 @@
+

+T-Rex JSON Template

+===================

+

+Whenever T-Rex is publishing live data, it uses JSON notation to describe the data-object.

+

+Each client may parse it diffrently, however this page will describe the values meaning when published by T-Rex server.

+

+

+Main Fields

+-----------

+

+Each T-Rex server-published JSON object contains data divided to main fields under which the actual data lays.

+

+These main fields are:

+

++-----------------------------+----------------------------------------------------+---------------------------+

+| Main field                  | Contains                                           | Comments                  |

++=============================+====================================================+===========================+

+| :ref:`trex-global-field`    | Must-have data on T-Rex run,                       |                           |

+|                             | mainly regarding Tx/Rx and packet drops            |                           |

++-----------------------------+----------------------------------------------------+---------------------------+

+| :ref:`tx-gen-field`         | Data indicate the quality of the transmit process. |                           |

+|                             | In case histogram is zero it means that all packets|                           |

+|                             | were injected in the right time.                   |                           |

++-----------------------------+----------------------------------------------------+---------------------------+

+| :ref:`trex-latecny-field`   | Latency reports, containing latency data on        | - Generated when latency  |

+|                             | generated data and on response traffic             |   test is enabled (``l``  |

+|                             |                                                    |   param)                  |

+|                             |                                                    | - *typo* on field key:    |

++-----------------------------+----------------------------------------------------+   will be fixed on next   |   

+| :ref:`trex-latecny-v2-field`| Extended latency information                       |   release                 |

++-----------------------------+----------------------------------------------------+---------------------------+

+

+

+Each of these fields contains keys for field general data (such as its name) and its actual data, which is always stored under the **"data"** key.

+

+For example, in order to access some trex-global data, the access path would look like::

+

+   AllData -> trex-global -> data -> desired_info

+

+   

+

+

+Detailed explanation

+--------------------

+

+.. _trex-global-field:

+

+trex-global field

+~~~~~~~~~~~~~~~~~

+

+

++--------------------------------+-------+-----------------------------------------------------------+

+|      Sub-key                   | Type  |                          Meaning                          |

++================================+=======+===========================================================+

+| m_cpu_util                     | float | CPU utilization (0-100)                                   |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_platform_factor              | float | multiplier factor                                         |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_tx_bps                       | float | total tx bit per second                                   |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_rx_bps                       | float | total rx bit per second                                   |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_tx_pps                       | float | total tx packet per second                                |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_tx_cps                       | float | total tx connection per second                            |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_tx_expected_cps              | float | expected tx connection per second                         |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_tx_expected_pps              | float | expected tx packet per second                             |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_tx_expected_bps              | float | expected tx bit per second                                |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_rx_drop_bps                  | float | drop rate in bit per second                               |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_active_flows                 | float | active trex flows                                         |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_open_flows                   | float | open trex flows from startup (monotonically incrementing) |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_total_tx_pkts                |  int  | total tx in packets                                       |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_total_rx_pkts                |  int  | total rx in packets                                       |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_total_tx_bytes               |  int  | total tx in bytes                                         |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_total_rx_bytes               |  int  | total rx in bytes                                         |

++--------------------------------+-------+-----------------------------------------------------------+

+| opackets-#                     |  int  | output packets (per interface)                            |

++--------------------------------+-------+-----------------------------------------------------------+

+| obytes-#                       |  int  | output bytes (per interface)                              |

++--------------------------------+-------+-----------------------------------------------------------+

+| ipackets-#                     |  int  | input packet (per interface)                              |

++--------------------------------+-------+-----------------------------------------------------------+

+| ibytes-#                       |  int  | input bytes (per interface)                               |

++--------------------------------+-------+-----------------------------------------------------------+

+| ierrors-#                      |  int  | input errors (per interface)                              |

++--------------------------------+-------+-----------------------------------------------------------+

+| oerrors-#                      |  int  | input errors (per interface)                              |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_total_tx_bps-#               | float | total transmitted data in bit per second                  |

++--------------------------------+-------+-----------------------------------------------------------+

+| unknown                        |  int  |                                                           |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_total_nat_learn_error [#f1]_ |  int  |                                                           |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_total_nat_active [#f2]_      |  int  |                                                           |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_total_nat_no_fid [#f2]_      |  int  |                                                           |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_total_nat_time_out [#f2]_    |  int  |                                                           |

++--------------------------------+-------+-----------------------------------------------------------+

+| m_total_nat_open [#f2]_    	 |  int  |                                                           |

++--------------------------------+-------+-----------------------------------------------------------+

+

+

+.. _tx-gen-field:

+

+tx-gen field

+~~~~~~~~~~~~~~

+

++-------------------+-------+-----------------------------------------------------------+

+|      Sub-key      | Type  |                          Meaning                          |

++===================+=======+===========================================================+

+| realtime-hist     | dict  | histogram of transmission. See extended information about |

+|                   |       | histogram object under :ref:`histogram-object-fields`.    |

+|                   |       | The attribute analyzed is time packet has been sent       |

+|                   |       | before/after it was intended to be                        |

++-------------------+-------+-----------------------------------------------------------+

+| unknown           | int   |                                                           |

++-------------------+-------+-----------------------------------------------------------+

+

+.. _trex-latecny-field:

+

+trex-latecny field

+~~~~~~~~~~~~~~~~~~

+

++---------+-------+---------------------------------------------------------+

+| Sub-key | Type  |                         Meaning                         |

++=========+=======+=========================================================+

+| avg-#   | float | average latency in usec (per interface)                 |

++---------+-------+---------------------------------------------------------+

+| max-#   | float | max latency in usec from the test start (per interface) |

++---------+-------+---------------------------------------------------------+

+| c-max-# | float | max in the last 1 sec window (per interface)            |

++---------+-------+---------------------------------------------------------+

+| error-# | float | errors in latency packets (per interface)               |

++---------+-------+---------------------------------------------------------+

+| unknown |  int  |                                                         |

++---------+-------+---------------------------------------------------------+

+

+.. _trex-latecny-v2-field:

+

+trex-latecny-v2 field

+~~~~~~~~~~~~~~~~~~~~~

+

++--------------------------------------+-------+--------------------------------------+

+|               Sub-key                | Type  |               Meaning                |

++======================================+=======+======================================+

+| cpu_util                             | float | rx thread cpu % (this is not trex DP |

+|                                      |       | threads cpu%%)                       |

++--------------------------------------+-------+--------------------------------------+

+| port-#                               |       | Containing per interface             |

+|                                      | dict  | information. See extended            |

+|                                      |       | information under ``port-# ->        |

+|                                      |       | key_name -> sub_key``                |

++--------------------------------------+-------+--------------------------------------+

+| port-#->hist                         | dict  | histogram of latency. See extended   |

+|                                      |       | information about histogram object   |

+|                                      |       | under :ref:`histogram-object-fields`.|

++--------------------------------------+-------+--------------------------------------+

+| port-#->stats                        |       | Containing per interface             |

+|                                      | dict  | information. See extended            |

+|                                      |       | information under ``port-# ->        |

+|                                      |       | key_name -> sub_key``                |

++--------------------------------------+-------+--------------------------------------+

+| port-#->stats->m_tx_pkt_ok           | int   | total of try sent packets            |

++--------------------------------------+-------+--------------------------------------+

+| port-#->stats->m_pkt_ok              | int   | total of packets sent from hardware  |

++--------------------------------------+-------+--------------------------------------+

+| port-#->stats->m_no_magic            | int   | rx error with no magic               |

++--------------------------------------+-------+--------------------------------------+

+| port-#->stats->m_no_id               | int   | rx errors with no id                 |

++--------------------------------------+-------+--------------------------------------+

+| port-#->stats->m_seq_error           | int   | error in seq number                  |

++--------------------------------------+-------+--------------------------------------+

+| port-#->stats->m_length_error        | int   |                                      |

++--------------------------------------+-------+--------------------------------------+

+| port-#->stats->m_rx_check            | int   | packets tested in rx                 |

++--------------------------------------+-------+--------------------------------------+

+| unknown                              | int   |                                      |

++--------------------------------------+-------+--------------------------------------+

+

+

+

+.. _histogram-object-fields:

+

+Histogram object fields

+~~~~~~~~~~~~~~~~~~~~~~~

+

+The histogram object is being used in number of place throughout the JSON object.

+The following section describes its fields in detail.

+

+

++-----------+-------+-----------------------------------------------------------------------------------+

+|  Sub-key  | Type  |                                      Meaning                                      |

++===========+=======+===================================================================================+

+| min_usec  |  int  | min attribute value in usec. pkt with latency less than this value is not counted |

++-----------+-------+-----------------------------------------------------------------------------------+

+| max_usec  |  int  | max attribute value in usec                                                       |

++-----------+-------+-----------------------------------------------------------------------------------+

+| high_cnt  |  int  | how many packets on which its attribute > min_usec                                |

++-----------+-------+-----------------------------------------------------------------------------------+

+| cnt       |  int  | total packets from test startup                                                   |

++-----------+-------+-----------------------------------------------------------------------------------+

+| s_avg     | float | average value from test startup                                                   |

++-----------+-------+-----------------------------------------------------------------------------------+

+| histogram |       | histogram of relevant object by the following keys:                               |

+|           | array |  - key: value in usec                                                             |

+|           |       |  - val: number of packets                                                         |

++-----------+-------+-----------------------------------------------------------------------------------+

+

+

+Access Examples

+---------------

+

+

+

+.. rubric:: Footnotes

+

+.. [#f1] Available only in NAT and NAT learning operation (``learn`` and ``learn-verify`` flags)

+

+.. [#f2] Available only in NAT operation (``learn`` flag)
\ No newline at end of file
diff --git a/scripts/automation/trex_control_plane/doc/authors.rst b/scripts/automation/trex_control_plane/doc/authors.rst
new file mode 100755
index 00000000..3b85f020
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/authors.rst
@@ -0,0 +1,12 @@
+=======
+Authors
+=======
+
+T-Rex is developed in Cisco Systems Inc. as the next generation traffic generator.
+
+T-Rex core-team developers are:
+
+  - Hanoch Haim
+  - Dave Johnson
+  - Wenxian Li
+  - Dan Klein
\ No newline at end of file
diff --git a/scripts/automation/trex_control_plane/doc/client_utils.rst b/scripts/automation/trex_control_plane/doc/client_utils.rst
new file mode 100755
index 00000000..224dfe19
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/client_utils.rst
@@ -0,0 +1,14 @@
+

+Client Utilities

+================

+

+T-Rex YAML generator

+--------------------

+

+.. automodule:: trex_yaml_gen

+    :members:

+

+General Utilities

+-----------------

+.. automodule:: general_utils

+    :members:
\ No newline at end of file
diff --git a/scripts/automation/trex_control_plane/doc/conf.py b/scripts/automation/trex_control_plane/doc/conf.py
new file mode 100755
index 00000000..fb9ea83c
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/conf.py
@@ -0,0 +1,303 @@
+# -*- coding: utf-8 -*-
+#
+# T-Rex Control Plain documentation build configuration file, created by
+# sphinx-quickstart on Tue Jun  2 07:48:10 2015.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+import shlex
+
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('../client'))
+sys.path.insert(0, os.path.abspath('../client_utils'))
+sys.path.insert(0, os.path.abspath('../examples'))
+sys.path.insert(0, os.path.abspath('../common'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.todo',
+    'sphinx.ext.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'T-Rex Control Plain'
+copyright = u'2015, Cisco Systems Inc.'
+author = u'Dan Klein for Cisco Systems Inc.'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.7'
+# The full version, including alpha/beta/rc tags.
+release = '1.7.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinx_rtd_theme'
+html_theme_options = {
+#   "rightsidebar": "true"
+    }
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'T-RexControlPlaindoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+
+# Latex figure (float) alignment
+#'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  (master_doc, 'T-RexControlPlain.tex', u'T-Rex Control Plain Documentation',
+   u'Dan Klein for Cisco Systems Inc', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 't-rexcontrolplain', u'T-Rex Control Plain Documentation',
+     [author], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  (master_doc, 'T-RexControlPlain', u'T-Rex Control Plain Documentation',
+   author, 'T-RexControlPlain', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+
+# show documentation for both __init__ methods and class methods
+autoclass_content = "both"      
+
+# A workaround for the responsive tables always having annoying scrollbars.
+def setup(app):
+  app.add_stylesheet("no_scrollbars.css")
\ No newline at end of file
diff --git a/scripts/automation/trex_control_plane/doc/docs_utilities.py b/scripts/automation/trex_control_plane/doc/docs_utilities.py
new file mode 100755
index 00000000..e80d765f
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/docs_utilities.py
@@ -0,0 +1,37 @@
+#!/router/bin/python
+
+from texttable import Texttable
+import yaml
+
+
+def handle_data_items(field_yaml_dict):
+	data_items = field_yaml_dict['data']
+	return [ [json_key, meaning['type'], meaning['exp'] ] 
+			 for json_key,meaning in data_items.items() ]
+
+
+def json_dict_to_txt_table(dict_yaml_file):
+	
+	# table = Texttable(max_width=120)
+	with open(dict_yaml_file, 'r') as f:
+		yaml_stream = yaml.load(f)
+
+	for main_field, sub_key in yaml_stream.items():
+		print main_field + ' field' '\n' + '~'*len(main_field+' field') + '\n'
+
+		field_data_rows = handle_data_items(sub_key)
+		table = Texttable(max_width=120)
+		table.set_cols_align(["l", "c", "l"])
+		table.set_cols_valign(["t", "m", "m"])
+		# create table's header 
+		table.add_rows([["Sub-key", "Type", "Meaning"]])
+		table.add_rows(field_data_rows, header=False)
+
+
+		print table.draw() + "\n"
+
+	
+	
+
+
+json_dict_to_txt_table("json_dictionary.yaml")
\ No newline at end of file
diff --git a/scripts/automation/trex_control_plane/doc/index.rst b/scripts/automation/trex_control_plane/doc/index.rst
new file mode 100755
index 00000000..e7a619d8
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/index.rst
@@ -0,0 +1,57 @@
+.. T-Rex Control Plain documentation master file, created by
+   sphinx-quickstart on Tue Jun  2 07:48:10 2015.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to T-Rex Control Plain's documentation!
+===============================================
+
+T-Rex is a **realistic traffic generator** that enables you to do get learn more about your under developement devices.
+
+This site covers the Python API of T-Rex control plane, and explains how to utilize it to your needs.
+However, since the entire API is JSON-RPC [#f1]_ based, you may want to check out other implementations that could suit you.
+
+
+To understand the entirely how the API works and how to set up the server side, check out the `API documentation <http://csi-wiki-01:8080/display/bpsim/Documentation>`_ undee the documentation section of T-Rex website.
+   
+   
+**Use the table of contents below or the menu to your left to navigate through the site**
+
+
+Getting Started
+===============
+.. toctree::
+    :maxdepth: 2
+
+    installation
+    client_utils
+    usage_examples
+
+API Reference
+=============
+.. toctree::
+    :maxdepth: 2
+
+    api/index
+
+About T-Rex
+===========
+.. toctree::
+    :maxdepth: 2
+
+    All about T-Rex <about_trex>
+    license
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+
+.. rubric:: Footnotes
+
+.. [#f1] For more information on JSON-RPC, check out the `official site <http://www.jsonrpc.org/>`_
\ No newline at end of file
diff --git a/scripts/automation/trex_control_plane/doc/installation.rst b/scripts/automation/trex_control_plane/doc/installation.rst
new file mode 100755
index 00000000..dda32f56
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/installation.rst
@@ -0,0 +1,25 @@
+============

+Installation

+============

+

+Prerequisites 

+-------------

+The T-Rex control plane is based on client-server model that interacts using JSON-RPC.

+

+In order to use the client-side API documented a T-Rex server daemon must be up and listening on the same host and port that the client tries to connect with.

+

+Compatibility

+-------------

+Both client and server side were developed for Linux platform.

+The client-side module is also compatible with windows python.

+

+The client side can be used with both Python 2 and Python 3 versions.

+However, the server side was desined to and best fits with Python 2.7.6 and on (all 2.x series, assuming > 2.6.9).

+

+

+Installation manual

+-------------------

+

+T-Rex Control Plane is a cross-platform, cross-operatin system APi to control and run T-Rex.

+

+The full, most updated manual (which refers to all programming languages) can be found under the `Automation API documentation <http://csi-wiki-01:8080/display/bpsim/Documentation>`_ .
\ No newline at end of file
diff --git a/scripts/automation/trex_control_plane/doc/json_dictionary.yaml b/scripts/automation/trex_control_plane/doc/json_dictionary.yaml
new file mode 100755
index 00000000..853ded65
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/json_dictionary.yaml
@@ -0,0 +1,252 @@
+################################################################
+####           T-Rex JSON Dictionary definitions            ####
+################################################################
+
+
+trex-global :
+  name              : 
+    type : string
+    exp  : "this is a name representation of the main field"
+    val  : "trex-global"
+  type              : 
+    type : int
+    val  : 0
+  data              :
+    m_cpu_util : 
+      type : float
+      exp  : "CPU utilization (0-100)"
+      val  : 0.0
+    m_platform_factor : 
+      type : float
+      exp  : "multiplier factor"
+      val  : 1.0
+    m_tx_bps : 
+      type : float
+      exp  : "total tx bit per second"
+      val  : 0.0
+    m_rx_bps : 
+      type : float
+      exp  : "total rx bit per second"
+      val  : 0.0
+    m_tx_pps : 
+      type : float
+      exp  : "total tx packet per second"
+      val  : 0.0
+    m_tx_cps : 
+      type : float
+      exp  : "total tx connection per second"
+      val  : 0.0
+    m_tx_expected_cps : 
+      type : float
+      exp  : "expected tx connection per second"
+      val  : 0.0
+    m_tx_expected_pps : 
+      type : float
+      exp  : "expected tx packet per second"
+      val  : 0.0
+    m_tx_expected_bps : 
+      type : float
+      exp  : "expected tx bit per second"
+      val  : 0.0
+    m_rx_drop_bps : 
+      type : float
+      exp  : "drop rate in bit per second"
+      val  : 0.0
+    m_active_flows : 
+      type : float
+      exp  : "active trex flows"
+      val  : 0.0
+    m_open_flows : 
+      type : float
+      exp  : "open trex flows from startup (monotonically incrementing)"
+      val  : 0.0
+    m_total_tx_pkts : 
+      type : int
+      exp  : "total tx in packets"
+      val  : 0
+    m_total_rx_pkts : 
+      type : int
+      exp  : "total rx in packets"
+      val  : 0
+    m_total_tx_bytes : 
+      type : int
+      exp  : "total tx in bytes"
+      val  : 0
+    m_total_rx_bytes : 
+      type : int
+      exp  : "total rx in bytes"
+      val  : 0
+    opackets-# : 
+      type : int
+      exp  : "output packets (per interface)"
+      val  : 0
+    obytes-# : 
+      type : int
+      exp  : "output bytes (per interface)"
+      val  : 0
+    ipackets-# : 
+      type : int
+      exp  : "input packet (per interface)"
+      val  : 0
+    ibytes-# : 
+      type : int
+      exp  : "input bytes (per interface)"
+      val  : 0
+    ierrors-# : 
+      type : int
+      exp  : "input errors (per interface)"
+      val  : 0
+    oerrors-# : 
+      type : int
+      exp  : "input errors (per interface)"
+      val  : 0
+    m_total_tx_bps-# : 
+      type : float
+      exp  : "total transmitted data in bit per second"
+      val  : 0.0
+    unknown : 
+      type : int
+      exp  : ""
+      val  : 0
+
+tx-gen :
+  name              : 
+    type : string
+    exp  : "this is a name representation of the main field"
+    val  : "tx-gen"
+  type              : 
+    type : int
+    val  : 0
+  data              :
+    realtime-hist : 
+      type : dict
+      #exp  : "Containing TX history data, by the following keys:\n  - min_usec (max_usec): min (max) time packet sent before (after) it was intended to be sent\n  - cnt (high_cnt): how many packet were lower than min_usec (higher than max_usec) relative to the time these packets were intended to be injected"
+      exp  : "histogram of transmission. See extended information about histogram object under :ref:`histogram-object-fields`. The attribute analyzed is time packet has been sent before/after it was intended to be"
+      val  : '{ "min_usec":10, "max_usec":0, "high_cnt":0, "cnt":667866, "s_avg":0.0,  "histogram":[] }'
+    unknown : 
+      type : int
+      exp  : ""
+      val  : 0
+
+trex-latecny :
+  name              : 
+    type : string
+    exp  : "this is a name representation of the main field"
+    val  : "trex-latecny"
+  type              : 
+    type : int
+    val  : 0
+  data              :
+    avg-# : 
+      type : float
+      exp  : "average latency in usec (per interface)"
+      val  : 75.0
+    max-# : 
+      type : float
+      exp  : "max latency in usec from the test start (per interface)"
+      val  : 75.0
+    c-max-# : 
+      type : float
+      exp  : "max in the last 1 sec window (per interface)"
+      val  : 75.0
+    error-# : 
+      type : float
+      exp  : "errors in latency packets (per interface)"
+      val  : 75.0
+    unknown : 
+      type : int
+      exp  : ""
+      val  : 0
+
+
+trex-latecny-v2 :
+  name              : 
+    type : string
+    exp  : "this is a name representation of the main field"
+    val  : "trex-latecny-v2"
+  type              : 
+    type : int
+    val  : 0
+  data              :
+    cpu_util : 
+      type : float
+      exp  : "rx thread cpu % (this is not trex DP threads cpu%%)"
+      val  : 75.0
+    port-# : 
+      type : dict
+      exp  : "Containing per interface information. See extended information under ``port-# -> key_name -> sub_key``"
+      val  : ''
+    port-#->hist :
+      type : dict
+      exp  : "histogram of latency. See extended information about histogram object under :ref:`histogram-object-fields`"
+      val  : ''
+    port-#->stats :
+      type : dict
+      exp  : "Containing per interface information. See extended information under ``port-# -> key_name -> sub_key``"
+      val  : ''
+    port-#->stats->m_tx_pkt_ok :
+      type : int
+      exp  : "total of try sent packets"
+      val  : 60110
+    port-#->stats->m_pkt_ok :
+      type : int
+      exp  : "total of packets sent from hardware"
+      val  : 60065
+    port-#->stats->m_no_magic :
+      type : int
+      exp  : "rx error with no magic"
+      val  : 0
+    port-#->stats->m_no_id :
+      type : int
+      exp  : "rx errors with no id"
+      val  : 0
+    port-#->stats->m_seq_error :
+      type : int
+      exp  : "error in seq number"
+      val  : 18
+    port-#->stats->m_length_error :
+      type : int
+      exp  : ""
+      val  : 0
+    port-#->stats->m_rx_check :
+      type : int
+      exp  : "packets tested in rx"
+      val  : 407495
+    unknown : 
+      type : int
+      exp  : ""
+      val  : 0
+histogram-obj :
+  name              : 
+    type : string
+    exp  : "this is description of a histogram object being used in number of place throughout the JSON object"
+    val  : "histogram-obj"
+  data              :
+    min_usec :
+      type : int
+      exp  : "min attribute value in usec. pkt with latency less than this value is not counted"
+      val  : 10
+    max_usec :
+      type : int
+      exp  : "max attribute value in usec"
+      val  : 83819
+    high_cnt :
+      type : int
+      exp  : "how many packets on which its attribute > min_usec"
+      val  : 83819
+    cnt :
+      type : int
+      exp  : "total packets from test startup"
+      val  : 83819
+    s_avg :
+      type : float
+      exp  : "average value from test startup"
+      val  : 39.3
+    histogram :
+      type : array
+      exp  : "histogram of relevant object by the following keys:\n  - key: value in usec \n  - val: number of packets"
+      val  : '[{"key": 20, "val": 5048}, {"key": 30, "val": 6092}, {"key": 40, "val": 2092}]'
+
+
+
+
diff --git a/scripts/automation/trex_control_plane/doc/license.rst b/scripts/automation/trex_control_plane/doc/license.rst
new file mode 100755
index 00000000..b83dd4b3
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/license.rst
@@ -0,0 +1,18 @@
+=======
+License
+=======
+
+
+Copyright 2015 Cisco Systems Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/scripts/automation/trex_control_plane/doc/requirements.rst b/scripts/automation/trex_control_plane/doc/requirements.rst
new file mode 100755
index 00000000..e69de29b
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/requirements.rst
diff --git a/scripts/automation/trex_control_plane/doc/usage_examples.rst b/scripts/automation/trex_control_plane/doc/usage_examples.rst
new file mode 100755
index 00000000..7116f28c
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/usage_examples.rst
@@ -0,0 +1,68 @@
+

+Usage Examples

+==============

+

+

+Full-featured interactive shell

+-------------------------------

+

+The `client_interactive_example.py` extends and uses the `Cmd <https://docs.python.org/2/library/cmd.html>`_ built in python class to create a Full-featured shell using which one can interact with T-Rex server and get instant results.

+

+The help menu of this application is:

+

+.. code-block:: json

+

+        usage: client_interactive_example [options]

+

+        Run T-Rex client API demos and scenarios.

+

+        optional arguments:

+          -h, --help            show this help message and exit

+          -v, --version         show program's version number and exit

+          -t HOST, --trex-host HOST

+                                Specify the hostname or ip to connect with T-Rex

+                                server.

+          -p PORT, --trex-port PORT

+                                Select port on which the T-Rex server listens. Default

+                                port is 8090.

+          -m SIZE, --maxhist SIZE

+                                Specify maximum history size saved at client side.

+                                Default size is 100.

+          --verbose             Switch ON verbose option at T-Rex client. Default is:

+                                OFF.

+

+**Code Excerpt**

+

+.. literalinclude:: ../examples/client_interactive_example.py

+   :language: python

+   :emphasize-lines: 0

+   :linenos:

+

+

+End-to-End cycle

+----------------

+

+This example (``pkt_generation_for_trex.py``) demonstrates a full cycle of using the API.

+

+.. note:: this module uses the `Scapy <http://www.secdev.org/projects/scapy/doc/usage.html>`_ in order to generate packets to be used as a basis of the traffic injection. It is recommended to *install* this module to best experience the example.

+

+The demo takes the user a full circle: 

+    1. Generating packets (using Scapy)

+    2. exporting the generated packets into .pcap file named `dns_traffic.pcap`.

+    3. Use the :class:`trex_yaml_gen.CTRexYaml` generator to include that pcap file in the yaml object.

+    4. Export the YAML object onto a YAML file named `dns_traffic.yaml`

+    5. Push the generated files to T-Rex server.

+    6. Run T-Rex based on the generated (and pushed) files.

+

+**Code Excerpt** [#f1]_ 

+

+.. literalinclude:: ../examples/pkt_generation_for_trex.py

+   :language: python

+   :lines: 10-

+   :emphasize-lines: 32,36,42,46,51,60,63-69,76-80

+   :linenos:

+

+

+.. rubric:: Footnotes

+

+.. [#f1] The marked codelines corresponds with the steps mentioned above.
\ No newline at end of file