visibility packet-capture object-templates pop3-vport-tmpl¶

Configure template for counter.pop3_vport

pop3-vport-tmpl Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name pop3-vport-tmpl-list

Collection URI /axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl

Element Name pop3-vport-tmpl

Element URI /axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl/{name}

Element Attributes pop3-vport-tmpl_attributes

Partition Visibility shared

Schema pop3-vport-tmpl schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl	pop3-vport-tmpl attributes
POST /axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl/ Payload: { "pop3-vport-tmpl": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl	pop3-vport-tmpl attributes
Get Object	GET	/axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl/{name}	pop3-vport-tmpl attributes
GET /axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl/a Reponse: { "pop3-vport-tmpl": { "name": "a", "uuid": "29419d4a-5199-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": "2941b53c-5199-11ee-b49a-0f7236d4afbc", "a10-url": "/axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl/a/trigger-stats-severity" }, "trigger-stats-inc": { "svrsel_fail": 0, "no_route": 0, "snat_fail": 0, "line_too_long": 0, "invalid_start_line": 0, "unsupported_command": 0, "bad_sequence": 0, "rsv_persist_conn_fail": 0, "smp_v6_fail": 0, "smp_v4_fail": 0, "insert_tuple_fail": 0, "cl_est_err": 0, "ser_connecting_err": 0, "server_response_err": 0, "uuid": "2941b65e-5199-11ee-b49a-0f7236d4afbc", "a10-url": "/axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl/a/trigger-stats-inc" }, "a10-url": "/axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl/a" } }
Get List	GET	/axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl	pop3-vport-tmpl-list
Modify Object	POST	/axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl/{name}	pop3-vport-tmpl attributes
Replace Object	PUT	/axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl/{name}	pop3-vport-tmpl attributes
PUT /axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl/a Payload: { "pop3-vport-tmpl": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl	pop3-vport-tmpl-list
Delete Object	DELETE	/axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl/{name}	pop3-vport-tmpl attributes
DELETE /axapi/v3/visibility/packet-capture/object-templates/pop3-vport-tmpl/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

pop3-vport-tmpl-list¶

pop3-vport-tmpl-list is JSON List of pop3-vport-tmpl attributes

pop3-vport-tmpl-list : [

{ pop3-vport-tmpl attributes },

{ pop3-vport-tmpl attributes },

…

]

pop3-vport-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/pop3-vport-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/pop3-vport-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/pop3-vport-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

bad_sequence

Description Enable automatic packet-capture for Bad Sequence

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cl_est_err

Description Enable automatic packet-capture for Client EST state erro

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

insert_tuple_fail

Description Enable automatic packet-capture for Serv Sel insert tuple fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

invalid_start_line

Description Enable automatic packet-capture for invalid start line

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

line_too_long

Description Enable automatic packet-capture for line too long

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

no_route

Description Enable automatic packet-capture for no route failure

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rsv_persist_conn_fail

Description Enable automatic packet-capture for Serv Sel Persist fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ser_connecting_err

Description Enable automatic packet-capture for Serv CTNG state error

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server_response_err

Description Enable automatic packet-capture for Serv RESP state error

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

smp_v4_fail

Description Enable automatic packet-capture for Serv Sel SMPv4 fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

smp_v6_fail

Description Enable automatic packet-capture for Serv Sel SMPv6 fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

snat_fail

Description Enable automatic packet-capture for source nat failure

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

svrsel_fail

Description Enable automatic packet-capture for Server selection failure

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

unsupported_command

Description Enable automatic packet-capture for Unsupported cmd

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

bad_sequence

Description Enable automatic packet-capture for Bad Sequence

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cl_est_err

Description Enable automatic packet-capture for Client EST state erro

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

insert_tuple_fail

Description Enable automatic packet-capture for Serv Sel insert tuple fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

invalid_start_line

Description Enable automatic packet-capture for invalid start line

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

line_too_long

Description Enable automatic packet-capture for line too long

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

no_route

Description Enable automatic packet-capture for no route failure

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rsv_persist_conn_fail

Description Enable automatic packet-capture for Serv Sel Persist fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ser_connecting_err

Description Enable automatic packet-capture for Serv CTNG state error

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server_response_err

Description Enable automatic packet-capture for Serv RESP state error

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

smp_v4_fail

Description Enable automatic packet-capture for Serv Sel SMPv4 fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

smp_v6_fail

Description Enable automatic packet-capture for Serv Sel SMPv6 fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

snat_fail

Description Enable automatic packet-capture for source nat failure

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

svrsel_fail

Description Enable automatic packet-capture for Server selection failure

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

unsupported_command

Description Enable automatic packet-capture for Unsupported cmd

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