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/capture-config

Element Name capture-config

Element URI /axapi/v3/capture-config/{name}

Element Attributes capture-config_attributes

Partition Visibility shared

Operational Data URI /axapi/v3/capture-config/{name}/oper

Schema capture-config schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/capture-config	capture-config attributes
Create List	POST	/axapi/v3/capture-config	capture-config attributes
Get Object	GET	/axapi/v3/capture-config/{name}	capture-config attributes
Get List	GET	/axapi/v3/capture-config	capture-config-list
Modify Object	POST	/axapi/v3/capture-config/{name}	capture-config attributes
Replace Object	PUT	/axapi/v3/capture-config/{name}	capture-config attributes
Replace List	PUT	/axapi/v3/capture-config	capture-config-list
Delete Object	DELETE	/axapi/v3/capture-config/{name}	capture-config attributes

capture-config-list¶

capture-config-list is JSON List of capture-config attributes

capture-config-list : [

{ capture-config attributes },

{ capture-config attributes },

…

]

capture-config attributes¶

count

Description Specify maximum packet number. (default 0 for unlimited)

Type: number

Range: 0-65535

Default: 0

Mutual Exclusion: count and file-history-size are mutually exclusive

enable

Description Enable capture-config

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

file-history-size

Description (Default) Specify pcapng file history size in MB (default 10)

Type: number

Range: 1-6144

Mutual Exclusion: file-history-size, file-size, and count are mutually exclusive

file-size

Description Specify pcapng filesize in MB (default 10)

Type: number

Range: 1-6144

Mutual Exclusion: file-size and file-history-size are mutually exclusive

filter

Description Filter packets to save using Berkeley Packet Filter syntax

Type: string

Format: string-rlx

Maximum Length: 1024 characters

Maximum Length: 1 characters

length

Description Packet length Bytes to capture (Default 128)

Type: number

Range: 64-1518

name

Description capture-config name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

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