From bd640666c052a1c770c9c1758c809f68d99af010 Mon Sep 17 00:00:00 2001
From: Dan Klein <danklei@cisco.com>
Date: Mon, 12 Oct 2015 09:11:44 +0300
Subject: solving conflicts

---
 .../doc/packet_generator/examples.rst              |  5 +++
 .../doc/packet_generator/export_format.yaml        | 47 ++++++++++++++++++++++
 2 files changed, 52 insertions(+)
 create mode 100755 scripts/automation/trex_control_plane/doc/packet_generator/examples.rst
 create mode 100755 scripts/automation/trex_control_plane/doc/packet_generator/export_format.yaml

(limited to 'scripts/automation/trex_control_plane/doc/packet_generator')

diff --git a/scripts/automation/trex_control_plane/doc/packet_generator/examples.rst b/scripts/automation/trex_control_plane/doc/packet_generator/examples.rst
new file mode 100755
index 00000000..bff1ef7f
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/packet_generator/examples.rst
@@ -0,0 +1,5 @@
+
+Packet Builder Usage Examples
+=============================
+
+Here I'll add usage examples, very similar to those I added to RPC document
\ No newline at end of file
diff --git a/scripts/automation/trex_control_plane/doc/packet_generator/export_format.yaml b/scripts/automation/trex_control_plane/doc/packet_generator/export_format.yaml
new file mode 100755
index 00000000..9f8c8f7b
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/packet_generator/export_format.yaml
@@ -0,0 +1,47 @@
+####################################################
+####         TRex packet export format          ####
+####################################################
+
+# PACKET REP - OPTION #1
+packet:
+  is_pcap         : YES/NO                  # <1>
+  binary          : []                      # <2>
+  pcap            : path/to/pcap/file.pcap  # <3>
+  meta            : any metadata wished to  # <4>
+
+# PACKET REP - OPTION #2
+packet:
+  data            : [] / path/to/pcap/file.pcap # <5>
+  meta            : any metadata wished to  # <4>
+
+vm:                                         # <6>
+  - vm instruction #1
+  - vm instruction #2
+  ...
+  - vm instruction #N
+
+
+###################################
+####         Comments          ####
+###################################
+#
+# <1>: is_pcap is a boolean field that indicates if packet is transferred by pcap referencs
+#      ('YES') or binary representation ('NO').
+#
+# <2>: binary field encodes the packet in binary representation. in a sequence (array) data.
+#      Each array item is an integer ranging 0-255.
+#      **LEAVE BLANK IF USING PCAP REFERENCE**
+#
+# <3>: path to the linked pcap file. Make sure to provide path with reading credentials.
+#      **LEAVE BLANK IF USING BINARY REP FOR THE PACKET**
+#
+# <4>: meta data is any JSON formatted data ment to be passed on.
+#
+# <5>: data field can be both binary representation or pcap file refernce,
+#      without the need for user's explicit typing.
+#      The application logic differs between the cases by the object type
+#      (array/string ending in '.pcap')
+#      Less configuration, little more confusing, LESS similar to RPC spec
+#
+# <6>: vm instructions passed in array representation (sequence).
+#      Each instruction is deifned according to the structures of the supported VM instructions.
\ No newline at end of file
-- 
cgit