
Ethernet Packet Generator
TCL API GUIDE
APG-TCL-UG-V1-0 7 7 June 2017
7.1.5 apgLoadUnit [UNITID] RATES {DURATION} .........................................................26
7.2 Get Unit Data - apgGetUnit ........................................................................... 27
7.2.1 apgGetUnit [UNITID] INFO [VAR] .......................................................................27
7.2.2 apgGetUnit [UNITID] STATUS [VAR] ...................................................................28
8. PORT COMMANDS ......................................................................................... 29
8.1 Load Port Data - apgLoadPort....................................................................... 31
8.1.1 apgLoadPort [PORTID] INFO ..............................................................................31
8.1.2 apgLoadPort [PORTID] MODULE .........................................................................31
8.1.3 apgLoadPort [PORTID] CAPTURE [VAR] {NUMPKT} ...............................................31
8.1.4 apgLoadPort [PORTID] ANALYSIS {TSID}............................................................32
8.2 Get Port Data - apgGetPort ........................................................................... 32
8.2.1 apgGetPort [PORTID] INFO [VAR].......................................................................32
8.2.2 apgGetPort [PORTID] STATUS [VAR]...................................................................34
8.2.3 apgGetPort [PORTID] MODULE [VAR]..................................................................35
8.2.4 apgGetPort [PORTID] TXSTATS [VAR] .................................................................36
8.2.5 apgGetPort [PORTID] RXSTATS [VAR] .................................................................37
8.2.6 apgGetPort [PORTID] RATES [VAR].....................................................................38
8.2.7 apgGetPort [PORTID] CAPTURE CONFIG [VAR].....................................................39
8.2.8 apgGetPort [PORTID] CAPTURE PACKET TOTALPACKETS .......................................40
8.2.9 apgGetPort [PORTID] CAPTURE PACKET [VAR] [PKTNUM]......................................40
8.2.10 apgGetPort [PORTID] ANALYSIS [TYPE] [VAR] .....................................................41
8.3 Set Port Configuration - apgSetPort ............................................................. 42
8.3.1 apgSetPort [PORTID] [VAR] [VAL] ......................................................................42
8.4 Apply Port Configuration - apgApplyPort ...................................................... 43
8.4.1 apgApplyPort [PORTID] STATE ...........................................................................43
8.5 Control Commands - apgControlPort ............................................................ 44
8.5.1 apgControlPort [COMMAND] [PORTLIST] .............................................................45
8.5.2 apgControlPort [CAPTURE] [PORTLIST] ...............................................................45
8.5.3 apgControlPort CLEARANALYSIS [PORTLIST]........................................................46
9. STREAM COMMANDS ..................................................................................... 47
9.1 Load Stream Configuration - apgLoadStream ............................................... 48
9.1.1 apgLoadStream [STREAMID]..............................................................................48
9.2 Get Stream Configuration - apgGetStream.................................................... 48
9.2.1 apgGetStream [STREAMID] CONFIG [VAR] ..........................................................49
9.2.2 apgGetStream [STREAMID] HEADER HEADER_LIST ..............................................50
9.2.3 apgGetStream [STREAMID] HEADER [HDR] [FLD] ................................................50
9.2.4 apgGetStream [STREAMID] PAYLOAD [VAR] ........................................................51
9.3 Set Stream Configuration - apgSetStream .................................................... 52
9.3.1 apgSetStream [STREAMID] DEFAULT ..................................................................53
9.3.2 apgSetStream [STREAMID] CONFIG [VAR] [VAL] .................................................53
9.3.3 apgSetStream [STREAMID] HEADER HEADER_LIST [HDRLIST] ..............................54
9.3.4 apgSetStream [STREAMID] HEADER [HDR] [FLD] [VAL] ........................................54
9.3.5 apgSetStream [STREAMID] HEADER [HDR] [FLD] [VAL] [MODE] [STEP][MIN][MAX].56
9.3.6 apgSetStream [STREAMID] PAYLOAD [VAR] [VAL]................................................56
9.4 Apply Stream Configuration - apgApplyStream............................................. 56
9.4.1 apgApplyStream [STREAMID].............................................................................57
10. TOOLS........................................................................................................... 58
10.1 Command Tools ............................................................................................ 58
10.1.1 apgGetVariables [COMMAND] {FUNCTION} .........................................................58
10.2 Header Tools................................................................................................. 58
10.2.1 apgGetHeaderList [STREAMID]...........................................................................58
10.2.2 apgGetHeaderFieldList [HDR] .............................................................................59
10.2.3 apgGetHeaderFieldValue [HDR] [FLD] [VAR] ........................................................59