visibility packet-capture object-templates rule-set-tmpl¶
Configure template for rule-set
rule-set-tmpl Specification¶
Type Collection Object Key(s) name Collection Name rule-set-tmpl-list Collection URI /axapi/v3/visibility/packet-capture/object-templates/rule-set-tmpl Element Name rule-set-tmpl Element URI /axapi/v3/visibility/packet-capture/object-templates/rule-set-tmpl/{name} Element Attributes rule-set-tmpl_attributes Schema rule-set-tmpl schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/visibility/packet-capture/object-templates/rule-set-tmpl | ||
Create List | POST | /axapi/v3/visibility/packet-capture/object-templates/rule-set-tmpl | ||
Get Object | GET | /axapi/v3/visibility/packet-capture/object-templates/rule-set-tmpl/{name} | ||
Get List | GET | /axapi/v3/visibility/packet-capture/object-templates/rule-set-tmpl | ||
Modify Object | POST | /axapi/v3/visibility/packet-capture/object-templates/rule-set-tmpl/{name} | ||
Replace Object | PUT | /axapi/v3/visibility/packet-capture/object-templates/rule-set-tmpl/{name} | ||
Replace List | PUT | /axapi/v3/visibility/packet-capture/object-templates/rule-set-tmpl | ||
Delete Object | DELETE | /axapi/v3/visibility/packet-capture/object-templates/rule-set-tmpl/{name} |
rule-set-tmpl-list¶
rule-set-tmpl-list is JSON List of rule-set-tmpl attributes
rule-set-tmpl-list : [
]
rule-set-tmpl attributes¶
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
Refernce Object: /axapi/v3/visibility/packet-capture/object-templates/rule-set-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
Refernce Object: /axapi/v3/visibility/packet-capture/object-templates/rule-set-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
Refernce Object: /axapi/v3/visibility/packet-capture/object-templates/rule-set-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 Type object drop-counter
Description Enable packet capture on all drop counters (Default disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-counter-alert
Description Enable packet capture on all alert drop counters (Default disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-counter-critical
Description Enable packet capture on all critical drop counters (Default disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-counter-out-of-res
Description Enable packet capture on all out of resource drop counters (Default disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-counter-policy
Description Enable packet capture on all policy drop counters (Default disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-counter-warning
Description Enable packet capture on all warning drop counters (Default disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
error-counter
Description Enable packet capture on all error counters (Default disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
error-counter-alert
Description Enable packet capture on all alert error counters (Default disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
error-counter-critical
Description Enable packet capture on all critical error counters (Default disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
error-counter-out-of-res
Description Enable packet capture on all out of resource error counters (Default disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
error-counter-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 Type object deny
Description Enable automatic packet-capture for Denied counter
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
unmatched-drops
Description Enable automatic packet-capture for Unmatched drops counter
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 Type object deny
Description Enable automatic packet-capture for Denied counter
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
threshold-exceeded-by
Description The threshold percentage over which to caputre the packets for this counter, default is 5
Type: number
Range: 0-100
Default: 5
unmatched-drops
Description Enable automatic packet-capture for Unmatched drops counter
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