visibility packet-capture object-templates aam-aaa-policy-tmpl¶

Configure template for aam.aaa-policy

aam-aaa-policy-tmpl Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name aam-aaa-policy-tmpl-list

Collection URI /axapi/v3/visibility/packet-capture/object-templates/aam-aaa-policy-tmpl

Element Name aam-aaa-policy-tmpl

Element URI /axapi/v3/visibility/packet-capture/object-templates/aam-aaa-policy-tmpl/{name}

Element Attributes aam-aaa-policy-tmpl_attributes

Partition Visibility shared

Schema aam-aaa-policy-tmpl schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/visibility/packet-capture/object-templates/aam-aaa-policy-tmpl	aam-aaa-policy-tmpl attributes
POST /axapi/v3/visibility/packet-capture/object-templates/aam-aaa-policy-tmpl/ Payload: { "aam-aaa-policy-tmpl": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/visibility/packet-capture/object-templates/aam-aaa-policy-tmpl	aam-aaa-policy-tmpl attributes
Get Object	GET	/axapi/v3/visibility/packet-capture/object-templates/aam-aaa-policy-tmpl/{name}	aam-aaa-policy-tmpl attributes
GET /axapi/v3/visibility/packet-capture/object-templates/aam-aaa-policy-tmpl/a Reponse: { "aam-aaa-policy-tmpl": { "name": "a", "uuid": "d0417db2-5186-11ee-99f1-db2b8dabed7a", "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": "d041874e-5186-11ee-99f1-db2b8dabed7a", "a10-url": "/axapi/v3/visibility/packet-capture/object-templates/aam-aaa-policy-tmpl/a/trigger-stats-severity" }, "trigger-stats-inc": { "error": 0, "uuid": "d041885c-5186-11ee-99f1-db2b8dabed7a", "a10-url": "/axapi/v3/visibility/packet-capture/object-templates/aam-aaa-policy-tmpl/a/trigger-stats-inc" }, "a10-url": "/axapi/v3/visibility/packet-capture/object-templates/aam-aaa-policy-tmpl/a" } }
Get List	GET	/axapi/v3/visibility/packet-capture/object-templates/aam-aaa-policy-tmpl	aam-aaa-policy-tmpl-list
Modify Object	POST	/axapi/v3/visibility/packet-capture/object-templates/aam-aaa-policy-tmpl/{name}	aam-aaa-policy-tmpl attributes
Replace Object	PUT	/axapi/v3/visibility/packet-capture/object-templates/aam-aaa-policy-tmpl/{name}	aam-aaa-policy-tmpl attributes
Replace List	PUT	/axapi/v3/visibility/packet-capture/object-templates/aam-aaa-policy-tmpl	aam-aaa-policy-tmpl-list
Delete Object	DELETE	/axapi/v3/visibility/packet-capture/object-templates/aam-aaa-policy-tmpl/{name}	aam-aaa-policy-tmpl attributes

aam-aaa-policy-tmpl-list¶

aam-aaa-policy-tmpl-list is JSON List of aam-aaa-policy-tmpl attributes

aam-aaa-policy-tmpl-list : [

{ aam-aaa-policy-tmpl attributes },

{ aam-aaa-policy-tmpl attributes },

…

]

aam-aaa-policy-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/aam-aaa-policy-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/aam-aaa-policy-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/aam-aaa-policy-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

error

Description Enable automatic packet-capture for Error

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

duration

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

Type: number

Range: 1-250

Default: 60

error

Description Enable automatic packet-capture for Error

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