visibility packet-capture object-templates interface-ethernet-tmpl¶

Configure template for interface.ethernet

interface-ethernet-tmpl Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name interface-ethernet-tmpl-list

Collection URI /axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl

Element Name interface-ethernet-tmpl

Element URI /axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl/{name}

Element Attributes interface-ethernet-tmpl_attributes

Partition Visibility shared

Schema interface-ethernet-tmpl schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl	interface-ethernet-tmpl attributes
POST /axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl/ Payload: { "interface-ethernet-tmpl": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl	interface-ethernet-tmpl attributes
Get Object	GET	/axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl/{name}	interface-ethernet-tmpl attributes
GET /axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl/a Reponse: { "interface-ethernet-tmpl": { "name": "a", "uuid": "da992ff6-5197-11ee-b49a-0f7236d4afbc", "user-tag": "a", "trigger-stats-severity": { "error": 0, "error-alert": 0, "error-warning": 0, "error-critical": 0, "drop": 0, "drop-alert": 0, "drop-warning": 0, "drop-critical": 0, "uuid": "da994860-5197-11ee-b49a-0f7236d4afbc", "a10-url": "/axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl/a/trigger-stats-severity" }, "trigger-stats-inc": { "input_errors": 0, "crc": 0, "runts": 0, "giants": 0, "output_errors": 0, "collisions": 0, "giants_output": 0, "uuid": "da994978-5197-11ee-b49a-0f7236d4afbc", "a10-url": "/axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl/a/trigger-stats-inc" }, "a10-url": "/axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl/a" } }
Get List	GET	/axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl	interface-ethernet-tmpl-list
Modify Object	POST	/axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl/{name}	interface-ethernet-tmpl attributes
Replace Object	PUT	/axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl/{name}	interface-ethernet-tmpl attributes
Replace List	PUT	/axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl	interface-ethernet-tmpl-list
Delete Object	DELETE	/axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl/{name}	interface-ethernet-tmpl attributes

interface-ethernet-tmpl-list¶

interface-ethernet-tmpl-list is JSON List of interface-ethernet-tmpl attributes

interface-ethernet-tmpl-list : [

{ interface-ethernet-tmpl attributes },

{ interface-ethernet-tmpl attributes },

…

]

interface-ethernet-tmpl attributes¶

capture-config

Description Specify name of the capture-config to use with this template

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/visibility/packet-capture/capture-config

name

Description Packet Capture Template Name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

trigger-stats-inc

Description: trigger-stats-inc is a JSON Block. Please see below for trigger-stats-inc

Type: Object

Reference Object: /axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl/{name}/trigger-stats-inc

trigger-stats-rate

Description: trigger-stats-rate is a JSON Block. Please see below for trigger-stats-rate

Type: Object

Reference Object: /axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl/{name}/trigger-stats-rate

trigger-stats-severity

Description: trigger-stats-severity is a JSON Block. Please see below for trigger-stats-severity

Type: Object

Reference Object: /axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl/{name}/trigger-stats-severity

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

trigger-stats-severity¶

Specification Value

Type object

drop

Description Enable packet capture on all drop counters (Default disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

drop-alert

Description Enable packet capture on all alert drop counters (Default disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

drop-critical

Description Enable packet capture on all critical drop counters (Default disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

drop-warning

Description Enable packet capture on all warning drop counters (Default disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

error

Description Enable packet capture on all error counters (Default disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

error-alert

Description Enable packet capture on all alert error counters (Default disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

error-critical

Description Enable packet capture on all critical error counters (Default disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

error-warning

Description Enable packet capture on all warning error counters (Default disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

trigger-stats-inc¶

Specification Value

Type object

collisions

Description Enable automatic packet-capture for Collisions

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

crc

Description Enable automatic packet-capture for CRC

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

giants

Description Enable automatic packet-capture for Giants

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

giants_output

Description Enable automatic packet-capture for Output Giants

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

input_errors

Description Enable automatic packet-capture for Input errors

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

output_errors

Description Enable automatic packet-capture for Output errors

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

runts

Description Enable automatic packet-capture for Runts

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

trigger-stats-rate¶

Specification Value

Type object

collisions

Description Enable automatic packet-capture for Collisions

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

crc

Description Enable automatic packet-capture for CRC

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

duration

Description Time in seconds to look for the anomaly, default is 60

Type: number

Range: 1-250

Default: 60

giants

Description Enable automatic packet-capture for Giants

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

giants_output

Description Enable automatic packet-capture for Output Giants

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

input_errors

Description Enable automatic packet-capture for Input errors

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

output_errors

Description Enable automatic packet-capture for Output errors

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

runts

Description Enable automatic packet-capture for Runts

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

threshold-exceeded-by

Description Set the threshold to the number of times greater than the previous duration to start the capture, default is 5

Type: number

Range: 0-100

Default: 5

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters