blob: ebcd5dcf1f35ff3b69856c92693bbc2f1729965b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
.. TRex 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 TRex Control Plain's documentation!
==============================================
TRex is a **realistic traffic generator** that enables you to do get learn more about your under development devices.
This site covers the Python API of TRex 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 `trex-core Wiki <https://github.com/cisco-system-traffic-generator/trex-core/wiki>`_ under the documentation section of TRex website.
**Use the table of contents below or the menu to your left to navigate through the site**
Getting Started
===============
.. toctree::
:maxdepth: 2
installation
API Reference
=============
.. toctree::
:maxdepth: 2
api/index
Client Utilities
================
.. toctree::
:maxdepth: 2
client_utils
Usage Examples
==============
.. toctree::
:maxdepth: 2
usage_examples
About TRex
==========
.. 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/>`_
|
