summaryrefslogtreecommitdiffstats
path: root/scripts/automation/trex_control_plane/doc/packet_generator/stream_export.rst
blob: 8d5ad5bee2600b7aea3deb23b09a0fa1ec00e516 (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
Stream Export YAML syntax
=========================

In order to provide a fluent work-flow that utilize the best TRex user's time, an export-import mini language has been created.

This enables a work-flow that supports saving and sharing a built packets and its scenarios, so that other tools
(such as TRex Console) could use them.

The TRex Packet Builder module supports (using ___ method) the export of built stream according to the format described below.

Guidelines
----------

1. One
2. Two
3. Three

Export Format
-------------

.. literalinclude:: export_format.yaml

Example
-------

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