axdebug¶
Packet Trace Options
axdebug Specification¶
Type operational Element Name axdebug Element URI /axapi/v3/axdebug Element Attributes axdebug_attributes Schema axdebug schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
EXECUTE Object | POST | /axapi/v3/axdebug |
axdebug attributes¶
apply-config
Description Apply AXDebug config file
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
capture
Description: capture is a JSON Block. Please see below for capture
Type: Object
Refernce Object: /axapi/v3/axdebug/capture
count
Description Maximum packets to capture. Default is 3000. (Maximum packets to capture. For umlimited, specify 0)
Type: number
Range: 0-65535
Default: 3000
delete-file-list
Description: delete-file-list is a JSON Block. Please see below for delete-file-list
Type: Object
exit
Description Exit from axdebug mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
filter-config
Description: filter-config is a JSON Block. Please see below for filter-config
Type: Object
Refernce Object: /axapi/v3/axdebug/filter-config
incoming-list
Description: incoming-list is a JSON Block. Please see below for incoming-list
Type: Object
length
Description Packet length to capture, enable jumbo to capture more than 1518 bytes
Type: number
Range: 64-12000
Default: 1518
maxfile
Description Maximum number of debug packet files. Default is 100
Type: number
Range: 1-65535
Default: 100
outgoing-list
Description: outgoing-list is a JSON Block. Please see below for outgoing-list
Type: Object
save-config
Description Save AXDebug config file to target filename
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
sess-filter-dis
Description Disable session based filter
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
timeout
Description Maximum number of minutes for a capture. Default is 5 minutes. For unlimited, specify 0
Type: number
Range: 0-65535
Default: 5
capture¶
Specification Type object brief
Description Print basic packet information
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
current-slot
Description Only for current-slot of chassis
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
detail
Description Include packet payload
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
incoming
Description Incoming interface
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
max-packets
Description Maximum packets to capture for each data cpu.
Type: number
Range: 0-65535
non-display
Description Do not print to screen
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
outgoing
Description Outgoing interface
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
port-num
Description Port Numbers separated by commas(,) and hyphens(-) without spaces (ex: 4,5,10-30), or separated by spaces and double-quoted(“)
Type: string
Format: string-rlx
Maximum Length: 511 characters
Maximum Length: 1 characters
save
Description Save packets into file (Specify filename to save packets)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
outgoing-list¶
Specification Type object out-port-num
Description Port Numbers separated by commas(,) and hyphens(-) without spaces. ex: 4,5,10-30, or separated by spaces and double-quoted(“)
Type: string
Format: string-rlx
Maximum Length: 511 characters
Maximum Length: 1 characters
outgoing
Description Outgoing interface (For all ports, don’t specify port number.)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
delete-file-list¶
Specification Type object delete
Description Delete AXDebug capture / config file
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
delete-capture
Description Delete a capture file (Specify target filename to change)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
delete-config
Description Delete AXDebug config file (Specify target filename to change)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
filter-config¶
Specification Type object WORD
Description WORD to compare
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
WORD1
Description WORD min value
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
WORD2
Description WORD max value
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
arp
Description ARP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
comp-hex
Description value to compare
Type: string
Format: time
Maximum Length: 255 characters
Maximum Length: 1 characters
dst
Description Destination
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
exit
Description Exit from axdebug mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
hex
Description Define hex value
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
icmp
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
icmpv6
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
integer
Description Define decimal value
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
integer-comp
Description value to compare
Type: number
Range: 1-255
integer-max
Description max value
Type: number
Range: 1-255
integer-min
Description min value
Type: number
Range: 1-255
ip
Description IP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipv4-address
Description ip address
Type: string
Format: ipv4-address
ipv4-netmask
Description IP subnet mask
Type: string
Format: ipv4-netmask
ipv6
Description IPV6
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipv6-adddress
Description ipv6 address
Type: string
Format: ipv6-address
l3-proto
Description Layer 3 protocol
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
length
Description byte length
Type: number
Range: 1-65535
mac
Description mac address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
mac-addr
Description mac address
Type: string
Format: mac-address
max-hex
Description max value
Type: string
Format: time
Maximum Length: 255 characters
Maximum Length: 1 characters
min-hex
Description min value
Type: string
Format: time
Maximum Length: 255 characters
Maximum Length: 1 characters
neighbor
Description IPv6 Neighbor/Router
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
number
Description Specify filter id
Type: number
Range: 1-32
offset
Description byte offset
Type: number
Range: 1-65535
oper-range
Description ‘gt’: greater than; ‘gte’: greater than or equal to; ‘se’: smaller than or equal to; ‘st’: smaller than; ‘eq’: equal to;
Type: string
Supported Values: gt, gte, se, st, eq
port
Description port number
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
port-num
Description Port number
Type: number
Range: 1-65535
port-num-max
Description max port number
Type: number
Range: 1-65535
port-num-min
Description min port number
Type: number
Range: 1-65535
prot-num
Description protocol number
Type: number
Range: 1-255
proto
Description ip protocol number
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
range
Description select a range
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
src
Description Source
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tcp
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
udp
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
incoming-list¶
Specification Type object inc-port-num
Description Port Numbers separated by commas(,) and hyphens(-) without spaces. ex: 4,5,10-30, or separated by spaces and double-quoted(“)
Type: string
Format: string-rlx
Maximum Length: 511 characters
Maximum Length: 1 characters
incoming
Description Incoming interface. (For all ports, don’t specify port number.)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0