export_format.yaml revision bd640666
1####################################################
2####         TRex packet export format          ####
3####################################################
4
5# PACKET REP - OPTION #1
6packet:
7  is_pcap         : YES/NO                  # <1>
8  binary          : []                      # <2>
9  pcap            : path/to/pcap/file.pcap  # <3>
10  meta            : any metadata wished to  # <4>
11
12# PACKET REP - OPTION #2
13packet:
14  data            : [] / path/to/pcap/file.pcap # <5>
15  meta            : any metadata wished to  # <4>
16
17vm:                                         # <6>
18  - vm instruction #1
19  - vm instruction #2
20  ...
21  - vm instruction #N
22
23
24###################################
25####         Comments          ####
26###################################
27#
28# <1>: is_pcap is a boolean field that indicates if packet is transferred by pcap referencs
29#      ('YES') or binary representation ('NO').
30#
31# <2>: binary field encodes the packet in binary representation. in a sequence (array) data.
32#      Each array item is an integer ranging 0-255.
33#      **LEAVE BLANK IF USING PCAP REFERENCE**
34#
35# <3>: path to the linked pcap file. Make sure to provide path with reading credentials.
36#      **LEAVE BLANK IF USING BINARY REP FOR THE PACKET**
37#
38# <4>: meta data is any JSON formatted data ment to be passed on.
39#
40# <5>: data field can be both binary representation or pcap file refernce,
41#      without the need for user's explicit typing.
42#      The application logic differs between the cases by the object type
43#      (array/string ending in '.pcap')
44#      Less configuration, little more confusing, LESS similar to RPC spec
45#
46# <6>: vm instructions passed in array representation (sequence).
47#      Each instruction is deifned according to the structures of the supported VM instructions.