visibility packet-capture capture-config¶
Packet Capture-Configuration
capture-config Specification¶
Parameter Value Type Collection Object Key(s) name Collection Name capture-config-list Collection URI /axapi/v3/visibility/packet-capture/capture-config Element Name capture-config Element URI /axapi/v3/visibility/packet-capture/capture-config/{name} Element Attributes capture-config_attributes Partition Visibility shared Statistics Data URI /axapi/v3/visibility/packet-capture/capture-config/{name}/stats Schema capture-config schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/visibility/packet-capture/capture-config | ||
Create List | POST | /axapi/v3/visibility/packet-capture/capture-config | ||
Get Object | GET | /axapi/v3/visibility/packet-capture/capture-config/{name} | ||
Get List | GET | /axapi/v3/visibility/packet-capture/capture-config | ||
Modify Object | POST | /axapi/v3/visibility/packet-capture/capture-config/{name} | ||
Replace Object | PUT | /axapi/v3/visibility/packet-capture/capture-config/{name} | ||
Replace List | PUT | /axapi/v3/visibility/packet-capture/capture-config | ||
Delete Object | DELETE | /axapi/v3/visibility/packet-capture/capture-config/{name} |
capture-config-list¶
capture-config-list is JSON List of capture-config attributes
capture-config-list : [
]
capture-config attributes¶
concurrent-captures
Description Enable and specify maximum concurrent 3 tuple filter based captures in seperate pcaps.
Type: number
Range: 1-5000
Mutual Exclusion: concurrent-captures and concurrent-conn-tag are mutually exclusive
concurrent-captures-age
Description Specify the time in minutes upto which a 3 tuple filter based capture will be kept active(default 1)
Type: number
Range: 1-10
Default: 1
concurrent-conn-per-capture
Description Specify maximum number of concurrent connnections(5 tuple matches) to be captured within in a 3 tuple based capture. (default 1
Type: number
Range: 1-1000
Default: 100
concurrent-conn-tag
Description Enable and specify maximum concurrent connnections(only 5 tuple based) to be captured in common pcaps.
Type: number
Range: 1-1000
Mutual Exclusion: concurrent-conn-tag and concurrent-captures are mutually exclusive
create-pcap-files-now
Description Operational command to force create temporary pcapng files before completion (for global/non 3 tuple based captures)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
disable
Description Disable packet capture (default enabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
disable-auto-merge
Description Disable auto merging per CPU pcapng files(default enabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable-continuous-global-capture
Description Enable continuous capture of packets for the global capture(non 3 tuple based capture) overriding size limits
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
file-count
Description Specify the number of continuous pcapng files that can be created for capturing packets (default 10)
Type: number
Range: 1-50
Default: 10
file-size
Description Specify pcapng filesize in MB, Will be distributed per CPU (default 1)
Type: number
Range: 1-300
Default: 1
keep-pcap-files-after-merge
Description Keep original per CPU pcapng files after auto merging pcapng files(default disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
name
Description Specify the name of the capture-config
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
number-of-packets-per-capture
Description Specify Maximum number of packets per global or dynamic capture (default 0 unlimited)
Type: number
Range: 0-1000
Default: 0
number-of-packets-per-conn
Description Specify maximum number of packets to be captured in a 5 tuple based connection (default 0 unlimited).
Type: number
Range: 0-1000
Default: 0
number-of-packets-total
Description Specify Maximum number of packets for all captures (default 0 unlimited)
Type: number
Range: 0-15000
Default: 0
packet-length
Description Packet length in Bytes to capture (Default 128)
Type: number
Range: 64-1518
Default: 128
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters