axdebug setting¶
AX Debug Commands
setting Specification¶
Type operational Element Name setting Element URI /axapi/v3/axdebug/setting Element Attributes setting_attributes Schema setting schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
EXECUTE Object | POST | /axapi/v3/axdebug/setting |
setting attributes¶
apply-config
Description Apply AXDebug config file
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
apply-config-file
Description Apply AXDebug config file
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
brief
Description Print basic packet information
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
capture-file
Description Delete a capture file (Specify target filename to change)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
config-file
Description Delete AXDebug config file (Specify target filename to change)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
count
Description Maximum packets to capture. Default is 3000
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
count-num
Description Specify maximum packet number. For umlimited, specify 0
Type: number
Range: 0-65535
delete
Description Delete AXDebug capture / config file
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
exit
Description Exit from axdebug mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
incoming
Description Incoming interface
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
length
Description Packet length to capture
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
length-packet
Description the packet length
Type: number
Range: 64-1518
max-packets
Description Maximum packets to capture for each data cpu.
Type: number
Range: 0-2147483647
maxfile
Description Maximum number of debug packet files. Default is 100
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
maxfile-count
Description Specify maximum amount
Type: number
Range: 1-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
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
Maximum Length: 63 characters
Maximum Length: 1 characters
save-config
Description Save AXDebug config file
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
save-config-name
Description Specify target filename to change
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 help Maximum number of minutes for a capture. Default is 5 minutes
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
timeout-num
Description Maximum number of minutes for a capture. For unlimited, specify 0
Type: number
Range: 0-65535
Default: 5