diff options
| author |   Dan Klein <danklei@cisco.com> | 2015-10-04 17:22:46 +0300 |
|---|---|---|
| committer | Dan Klein <danklei@cisco.com> | 2015-10-04 17:22:46 +0300 |
| commit | 16e3b19016a0d6e63d9162040811de4386142af0 (patch) | |
| tree | a6cfd43d40b9368a4c96cf07550b566201d2c5a6 /scripts/automation/trex_control_plane/doc/packet_generator/stream_export.rst | |
| parent | 7e1bf3602241fb881531965813c0b6ad09790bee (diff) | |
Updated and added documentation files for packet builder module
Diffstat (limited to 'scripts/automation/trex_control_plane/doc/packet_generator/stream_export.rst')
| -rwxr-xr-x | scripts/automation/trex_control_plane/doc/packet_generator/stream_export.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/scripts/automation/trex_control_plane/doc/packet_generator/stream_export.rst b/scripts/automation/trex_control_plane/doc/packet_generator/stream_export.rst new file mode 100755 index 00000000..8d5ad5be --- /dev/null +++ b/scripts/automation/trex_control_plane/doc/packet_generator/stream_export.rst @@ -0,0 +1,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.
|