visibility¶
Display Network statistics
visibility Specification¶
Parameter Value Type Configuration Resource Element Name visibility Element URI /axapi/v3/visibility Element Attributes visibility_attributes Partition Visibility shared Statistics Data URI /axapi/v3/visibility/stats Schema visibility schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/visibility | ||
Get Object | GET | /axapi/v3/visibility | ||
Modify Object | POST | /axapi/v3/visibility | ||
Replace Object | PUT | /axapi/v3/visibility | ||
Delete Object | DELETE | /axapi/v3/visibility |
visibility attributes¶
anomaly-detection
Description: anomaly-detection is a JSON Block. Please see below for anomaly-detection
Type: Object
Reference Object: /axapi/v3/visibility/anomaly-detection
debug-files
Description: debug-files is a JSON Block. Please see below for debug-files
Type: Object
Reference Object: /axapi/v3/visibility/debug-files
file
Description: file is a JSON Block. Please see below for file
Type: Object
Reference Object: /axapi/v3/visibility/file
flow-collector
Description: flow-collector is a JSON Block. Please see below for flow-collector
Type: Object
Reference Object: /axapi/v3/visibility/flow-collector
granularity
Description Granularity for rate based calculations in seconds (default 5)
Type: number
Range: 1-300
Default: 5
initial-learning-interval
Description Initial learning interval (in hours) before processing
Type: number
Range: 1-168
mon-entity-telemetry-data
Description: mon-entity-telemetry-data is a JSON Block. Please see below for mon-entity-telemetry-data
Type: Object
Reference Object: /axapi/v3/visibility/mon-entity-telemetry-data
mon-topk
Description: mon-topk is a JSON Block. Please see below for mon-topk
Type: Object
Reference Object: /axapi/v3/visibility/mon-topk
monitor
Description: monitor is a JSON Block. Please see below for monitor
Type: Object
Reference Object: /axapi/v3/visibility/monitor
monitored-entity
Description: monitored-entity is a JSON Block. Please see below for monitored-entity
Type: Object
Reference Object: /axapi/v3/visibility/monitored-entity
reporting
Description: reporting is a JSON Block. Please see below for reporting
Type: Object
Reference Object: /axapi/v3/visibility/reporting
resource-usage
Description: resource-usage is a JSON Block. Please see below for resource-usage
Type: Object
Reference Object: /axapi/v3/visibility/resource-usage
source-entity-topk
Description Enable topk for sources
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
topn
Description: topn is a JSON Block. Please see below for topn
Type: Object
Reference Object: /axapi/v3/visibility/topn
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
zbar
Description: zbar is a JSON Block. Please see below for zbar
Type: Object
Reference Object: /axapi/v3/visibility/zbar
flow-collector¶
Specification Value Type object netflow
Description: netflow is a JSON Block. Please see below for flow-collector_netflow
Type: Object
Reference Object: /axapi/v3/visibility/flow-collector/netflow
sflow
Description: sflow is a JSON Block. Please see below for flow-collector_sflow
Type: Object
Reference Object: /axapi/v3/visibility/flow-collector/sflow
flow-collector_netflow¶
Specification Value Type object template
Description: template is a JSON Block. Please see below for flow-collector_netflow_template
Type: Object
Reference Object: /axapi/v3/visibility/flow-collector/netflow/template
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
flow-collector_netflow_template¶
Specification Value Type object detail
Description: detail is a JSON Block. Please see below for flow-collector_netflow_template_detail
Type: Object
Reference Object: /axapi/v3/visibility/flow-collector/netflow/template/detail
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
flow-collector_netflow_template_detail¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
flow-collector_sflow¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
resource-usage¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
reporting¶
Specification Value Type object grouping-export-interval
Description: grouping-export-interval is a JSON Block. Please see below for reporting_grouping-export-interval
Type: Object
Reference Object: /axapi/v3/visibility/reporting/grouping-export-interval
telemetry-export-interval
Description: telemetry-export-interval is a JSON Block. Please see below for reporting_telemetry-export-interval
Type: Object
Reference Object: /axapi/v3/visibility/reporting/telemetry-export-interval
template
Description: template is a JSON Block. Please see below for reporting_template
Type: Object
Reference Object: /axapi/v3/visibility/reporting/template
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
reporting_grouping-export-interval¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
value
Description The aggregation and exporting interval in seconds (Default 30 seconds)
Type: number
Range: 10-300
Default: 30
reporting_template¶
Specification Value Type object notification
Description: notification is a JSON Block. Please see below for reporting_template_notification
Type: Object
Reference Object: /axapi/v3/visibility/reporting/template/notification
reporting_template_notification¶
Specification Value Type object debug
Description: debug is a JSON Block. Please see below for reporting_template_notification_debug
Type: Object
Reference Object: /axapi/v3/visibility/reporting/template/notification/debug
template-name-list
Type: List
Reference Object: /axapi/v3/visibility/reporting/template/notification/template-name/{name}
reporting_template_notification_debug¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
reporting_template_notification_template-name-list¶
Specification Value Type list Block object keys action
Description ‘enable’: Enable; ‘disable’: Disable;
Type: string
Supported Values: enable, disable
Default: enable
authentication
Description: authentication is a JSON Block. Please see below for reporting_template_notification_template-name-list_authentication
Type: Object
Reference Object: /axapi/v3/visibility/reporting/template/notification/template-name/{name}/authentication
debug-mode
Description Enable debug mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
host-name
Description Configure the host name(e.g www.a10networks.com)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: host-name, ipv4-address, and ipv6-address are mutually exclusive
http-port
Description Configure the http port to use(default 80) (http port(default 80))
Type: number
Range: 1-65535
Default: 80
https-port
Description Configure the https port to use(default 443) (http port(default 443))
Type: number
Range: 1-65535
Default: 443
ipv4-address
Description Configure the host IPv4 address
Type: string
Format: ipv4-address
Mutual Exclusion: ipv4-address, ipv6-address, and host-name are mutually exclusive
ipv6-address
Description Configure the host IPv6 address
Type: string
Format: ipv6-address
Mutual Exclusion: ipv6-address, ipv4-address, and host-name are mutually exclusive
name
Description Notification template name
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
protocol
Description ‘http’: Use http protocol; ‘https’: Use https protocol(default); (http protocol)
Type: string
Supported Values: http, https
Default: https
relative-uri
Description Configure the relative uri(e.g /example , default /)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Default: /
test-connectivity
Description Test connectivity to notification receiver
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
use-mgmt-port
Description Use management port for notifications
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
reporting_template_notification_template-name-list_authentication¶
Specification Value Type object api-key
Description Configure api-key as a mode of authentication
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
api-key-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)api-key-string
Description Configure api-key as a mode of authentication
Type: string
Format: password
Maximum Length: 64 characters
Maximum Length: 1 characters
auth-password
Description Configure the authentication user password (Authentication password)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
auth-password-string
Description Configure the authentication user password (Authentication password)
Type: string
Format: password
Maximum Length: 63 characters
Maximum Length: 1 characters
auth-username
Description Configure the authentication user name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)relative-login-uri
Description Configure the authentication login uri
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
relative-logoff-uri
Description Configure the authentication logoff uri
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
reporting_telemetry-export-interval¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
value
Description Monitored entity telemetry data export interval in mins (Default 5 mins)
Type: number
Range: 1-5
Default: 5
mon-entity-telemetry-data¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
mon-topk¶
Specification Value Type object sources
Description: sources is a JSON Block. Please see below for mon-topk_sources
Type: Object
Reference Object: /axapi/v3/visibility/mon-topk/sources
mon-topk_sources¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
monitored-entity¶
Specification Value Type object detail
Description: detail is a JSON Block. Please see below for monitored-entity_detail
Type: Object
Reference Object: /axapi/v3/visibility/monitored-entity/detail
mon-topk
Description: mon-topk is a JSON Block. Please see below for monitored-entity_mon-topk
Type: Object
Reference Object: /axapi/v3/visibility/monitored-entity/mon-topk
secondary
Description: secondary is a JSON Block. Please see below for monitored-entity_secondary
Type: Object
Reference Object: /axapi/v3/visibility/monitored-entity/secondary
sessions
Description: sessions is a JSON Block. Please see below for monitored-entity_sessions
Type: Object
Reference Object: /axapi/v3/visibility/monitored-entity/sessions
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
monitored-entity_mon-topk¶
Specification Value Type object sources
Description: sources is a JSON Block. Please see below for monitored-entity_mon-topk_sources
Type: Object
Reference Object: /axapi/v3/visibility/monitored-entity/mon-topk/sources
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
monitored-entity_mon-topk_sources¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
monitored-entity_secondary¶
Specification Value Type object mon-topk
Description: mon-topk is a JSON Block. Please see below for monitored-entity_secondary_mon-topk
Type: Object
Reference Object: /axapi/v3/visibility/monitored-entity/secondary/mon-topk
monitored-entity_secondary_mon-topk¶
Specification Value Type object sources
Description: sources is a JSON Block. Please see below for monitored-entity_secondary_mon-topk_sources
Type: Object
Reference Object: /axapi/v3/visibility/monitored-entity/secondary/mon-topk/sources
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
monitored-entity_secondary_mon-topk_sources¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
monitored-entity_sessions¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
monitored-entity_detail¶
Specification Value Type object debug
Description: debug is a JSON Block. Please see below for monitored-entity_detail_debug
Type: Object
Reference Object: /axapi/v3/visibility/monitored-entity/detail/debug
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
monitored-entity_detail_debug¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
debug-files¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
topn¶
Specification Value Type object cgnv6-nat-pool-topn-node
Description: cgnv6-nat-pool-topn-node is a JSON Block. Please see below for topn_cgnv6-nat-pool-topn-node
Type: Object
Reference Object: /axapi/v3/visibility/topn/cgnv6-nat-pool-topn-node
cgnv6-nat-pool-topn-tmpl-list
Type: List
Reference Object: /axapi/v3/visibility/topn/cgnv6-nat-pool-topn-tmpl/{name}
gtp-apn-prefix-topn-node
Description: gtp-apn-prefix-topn-node is a JSON Block. Please see below for topn_gtp-apn-prefix-topn-node
Type: Object
Reference Object: /axapi/v3/visibility/topn/gtp-apn-prefix-topn-node
gtp-apn-prefix-topn-tmpl-list
Type: List
Reference Object: /axapi/v3/visibility/topn/gtp-apn-prefix-topn-tmpl/{name}
gtp-network-element-topn-node
Description: gtp-network-element-topn-node is a JSON Block. Please see below for topn_gtp-network-element-topn-node
Type: Object
Reference Object: /axapi/v3/visibility/topn/gtp-network-element-topn-node
gtp-network-element-topn-tmpl-list
Type: List
Reference Object: /axapi/v3/visibility/topn/gtp-network-element-topn-tmpl/{name}
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
topn_gtp-network-element-topn-tmpl-list¶
Specification Value Type list Block object keys interval
Description ‘5’: 5 minutes; ‘15’: 15 minutes; ‘30’: 30 minutes; ‘60’: 60 minutes; ‘all-time’: Since template is activated;
Type: string
Supported Values: 5, 15, 30, 60, all-time
metrics
Description: metrics is a JSON Block. Please see below for topn_gtp-network-element-topn-tmpl-list_metrics
Type: Object
Reference Object: /axapi/v3/visibility/topn/gtp-network-element-topn-tmpl/{name}/metrics
name
Description Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
topn-size
Description Congure value of N for topn
Type: number
Range: 10-200
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
topn_gtp-network-element-topn-tmpl-list_metrics¶
Specification Value Type object downlink-bytes
Description Track Top-N entities for Downlink Bytes
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
downlink-pkts
Description Track Top-N entities for Downlink Packets
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-flt-apn-filtering
Description Track Top-N entities for Filtering Drop: APN IMSI Filtering
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-flt-gtp-in-gtp
Description Track Top-N entities for Filtering Drop: GTP in GTP Tunnel Present
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-flt-message-filtering
Description Track Top-N entities for Filtering Drop: Message Type Not Permitted on Interface
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-flt-msisdn-filtering
Description Track Top-N entities for Filtering Drop: MSISDN Filtering
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-flt-rat-type-filtering
Description Track Top-N entities for Filtering Drop: RAT Type Filtering
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-u-downlink-byte
Description Track Top-N entities for Rate-limit Drop: GTP-U Downlink byte rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-u-downlink-packet
Description Track Top-N entities for Rate-limit Drop: GTP-U Downlink packet rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-u-max-concurrent-tunnels
Description Track Top-N entities for Rate-limit Drop: GTP-U Concurrent Tunnels
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-u-total-byte
Description Track Top-N entities for Rate-limit Drop: GTP-U Total byte rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-u-total-packet
Description Track Top-N entities for Rate-limit Drop: GTP-U Total packet rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-u-tunnel-create
Description Track Top-N entities for Rate-limit Drop: GTP-U Tunnel Creation rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-u-uplink-byte
Description Track Top-N entities for Rate-limit Drop: GTP-U Uplink byte rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-u-uplink-packet
Description Track Top-N entities for Rate-limit Drop: GTP-U Uplink packet rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-v0-c-agg
Description Track Top-N entities for Rate-limit Drop: Maximum GTPv0-C messages rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-v1-c-agg
Description Track Top-N entities for Rate-limit Drop: Maximum GTPv1-C messages rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-v1-c-create-pdp-request
Description Track Top-N entities for Rate-limit Drop: GTPv1-C Create PDP Req rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-v1-c-update-pdp-request
Description Track Top-N entities for Rate-limit Drop: GTPv1-C Update PDP Req rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-v2-c-agg
Description Track Top-N entities for Rate-limit Drop: Maximum GTPv2-C messages rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-v2-c-create-session-request
Description Track Top-N entities for Rate-limit Drop: GTPv2-C Create Session Req rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-v2-c-modify-bearer-request
Description Track Top-N entities for Rate-limit Drop: GTPv2-C Modify Bearer Req rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-country-code-mismatch
Description Track Top-N entities for Validation Drop: Country Code Mismatch in IMSI and MSISDN
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-cross-layer-correlation
Description Track Top-N entities for Validation Drop: Cross Layer IP Address Mismatch
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtp-c-handover-in-progress
Description Track Top-N entities for Validation Drop: GTP-C Drop Since Handover In Progress
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtp-invalid-apn-len-drop
Description Track Top-N entities for Validation Drop: GTP-C Invalid APN Length Drop
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtp-invalid-imsi-len-drop
Description Track Top-N entities for Validation Drop: GTP-C Invalid IMSI Length Drop
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtp-u-spoofed-source-address
Description Track Top-N entities for Validation Drop: GTP-U IP Address Spoofed
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtp-v2-wrong-lbi-create-bearer
Description Track Top-N entities for Validation Drop: GTPV2-C Wrong LBI in Create Bearer Request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtpv0-seqnum-buffer-full
Description Track Top-N entities for Validation Drop: GTPV0-C conn Sequence number Buffer Full
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtpv1-seqnum-buffer-full
Description Track Top-N entities for Validation Drop: GTPV1-C conn Sequence number Buffer Full
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtpv2-seqnum-buffer-full
Description Track Top-N entities for Validation Drop: GTPV2-C conn Sequence number Buffer Full
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-invalid-flow-label-v0
Description Track Top-N entities for Validation Drop: Invalid Flow Label in GTPv0-C Header
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-invalid-pkt-len-piggyback
Description Track Top-N entities for Validation Drop: Piggyback message invalid packet length
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-invalid-teid
Description Track Top-N entities for Validation Drop: Invalid TEID Value
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-mandatory-information-element
Description Track Top-N entities for Validation Drop: Mandatory IE Not Present
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-message-length
Description Track Top-N entities for Validation Drop: Message Length Exceeded
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-out-of-order-ie
Description Track Top-N entities for Validation Drop: GTPv1-C Message Out of Order IE
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-out-of-state
Description Track Top-N entities for Validation Drop: Out Of State GTP Message
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-out-of-state-ie
Description Track Top-N entities for Validation Drop: Unexpected IE Present in Message
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-protocol-flag-unset
Description Track Top-N entities for Validation Drop: Protocol flag in Header Field not Set
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-reserved-field-set
Description Track Top-N entities for Validation Drop: Reserved Header Field Set
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-reserved-information-element
Description Track Top-N entities for Validation Drop: Reserved IE Field Present
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-sanity-failed-piggyback
Description Track Top-N entities for Validation Drop: piggyback message anomaly failed
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-sequence-num-correlation
Description Track Top-N entities for Validation Drop: GTP-C Sequence number Mismatch
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-tunnel-id-flag
Description Track Top-N entities for Validation Drop: Tunnel Header Flag Not Set
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-unsupported-message-type
Description Track Top-N entities for Validation Drop: Message type not supported by GTP Version
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-version-not-supported
Description Track Top-N entities for Validation Drop: Invalid GTP version
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop_vld-gtp-bearer-count-exceed
Description Track Top-N entities for Validation Drop: GTP Bearer count exceeded max (11)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-path-management-message
Description Track Top-N entities for GTP Path Management Messages Received
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-u-tunnel-created
Description Track Top-N entities for GTP-U Tunnel Created
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-u-tunnel-deleted
Description Track Top-N entities for GTP-U Tunnel Deleted
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-create-pdp-resp-unsuccess
Description Track Top-N entities for GTPv0-C Create PDP Context Response Unsuccessful
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-half-open-tunnel-closed
Description Track Top-N entities for GTPv0-C Half open tunnel closed
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-reserved-message-allow
Description Track Top-N entities for GTPv0-C Reserved Message Allow
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-tunnel-closed
Description Track Top-N entities for GTPv0-C Tunnel Marked Deleted
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-tunnel-created
Description Track Top-N entities for GTPv0-C Tunnel Created
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-tunnel-deleted
Description Track Top-N entities for GTPv0-C Tunnel Deleted
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-tunnel-deleted-restart
Description Track Top-N entities for GTPv0-C Tunnel Deleted with Restart/failure
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-tunnel-half-closed
Description Track Top-N entities for GTPv0-C Tunnel Delete Request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-tunnel-half-open
Description Track Top-N entities for GTPv0-C Half open tunnel created
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-update-pdp-resp-unsuccess
Description Track Top-N entities for GTPv0-C Update PDP Context Response Unsuccessful
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-create-pdp-resp-unsuccess
Description Track Top-N entities for GTPv1-C Create PDP Context Response Unsuccessful
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-half-open-tunnel-closed
Description Track Top-N entities for GTPv1-C Half open tunnel closed
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-reserved-message-allow
Description Track Top-N entities for GTPv1-C Reserved Message Allow
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-tunnel-closed
Description Track Top-N entities for GTPv1-C Tunnel Marked Deleted
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-tunnel-created
Description Track Top-N entities for GTPv1-C Tunnel Created
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-tunnel-deleted
Description Track Top-N entities for GTPv1-C Tunnel Deleted
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-tunnel-deleted-restart
Description Track Top-N entities for GTPv1-C Tunnel Deleted with Restart/failure
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-tunnel-half-closed
Description Track Top-N entities for GTPv1-C Tunnel Delete Request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-tunnel-half-open
Description Track Top-N entities for GTPv1-C Half open tunnel created
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-update-pdp-resp-unsuccess
Description Track Top-N entities for GTPv1-C Update PDP Context Response Unsuccessful
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-create-sess-resp-unsuccess
Description Track Top-N entities for GTPv2-C Create Session Response Unsuccessful
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-half-open-tunnel-closed
Description Track Top-N entities for GTPv2-C Half open tunnel closed
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-mod_bearer-resp-unsuccess
Description Track Top-N entities for GTPv2-C Modify Bearer Response Unsuccessful
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-piggyback-message
Description Track Top-N entities for GTPv2-C Piggyback Messages
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-reserved-message-allow
Description Track Top-N entities for GTPv2-C Reserved Message Allow
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-tunnel-closed
Description Track Top-N entities for GTPv2-C Tunnel Marked Deleted
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-tunnel-created
Description Track Top-N entities for GTPv2-C Tunnel Created
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-tunnel-deleted
Description Track Top-N entities for GTPv2-C Tunnel Deleted
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-tunnel-deleted-restart
Description Track Top-N entities for GTPv2-C Tunnel Deleted with Restart/failure
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-tunnel-half-closed
Description Track Top-N entities for GTPv2-C Tunnel Delete Request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-tunnel-half-open
Description Track Top-N entities for GTPv2-C Half open tunnel created
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uplink-bytes
Description Track Top-N entities for Uplink Bytes
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uplink-pkts
Description Track Top-N entities for Uplink Packets
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
topn_gtp-network-element-topn-node¶
Specification Value Type object activate
Description Name of the templated to be activated
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/visibility/topn/gtp-network-element-topn-tmpl
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
topn_gtp-apn-prefix-topn-node¶
Specification Value Type object activate
Description Name of the templated to be activated
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/visibility/topn/gtp-apn-prefix-topn-tmpl
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
topn_cgnv6-nat-pool-topn-tmpl-list¶
Specification Value Type list Block object keys interval
Description ‘5’: 5 minutes; ‘15’: 15 minutes; ‘30’: 30 minutes; ‘60’: 60 minutes; ‘all-time’: Since template is activated;
Type: string
Supported Values: 5, 15, 30, 60, all-time
metrics
Description: metrics is a JSON Block. Please see below for topn_cgnv6-nat-pool-topn-tmpl-list_metrics
Type: Object
Reference Object: /axapi/v3/visibility/topn/cgnv6-nat-pool-topn-tmpl/{name}/metrics
name
Description Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
topn-size
Description Congure value of N for topn
Type: number
Range: 10-200
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
topn_cgnv6-nat-pool-topn-tmpl-list_metrics¶
Specification Value Type object tcp-total
Description Track Top-N entities for TCP total
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
udp-total
Description Track Top-N entities for UDP Total
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
topn_gtp-apn-prefix-topn-tmpl-list¶
Specification Value Type list Block object keys interval
Description ‘5’: 5 minutes; ‘15’: 15 minutes; ‘30’: 30 minutes; ‘60’: 60 minutes; ‘all-time’: Since template is activated;
Type: string
Supported Values: 5, 15, 30, 60, all-time
metrics
Description: metrics is a JSON Block. Please see below for topn_gtp-apn-prefix-topn-tmpl-list_metrics
Type: Object
Reference Object: /axapi/v3/visibility/topn/gtp-apn-prefix-topn-tmpl/{name}/metrics
name
Description Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
topn-size
Description Congure value of N for topn
Type: number
Range: 10-200
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
topn_gtp-apn-prefix-topn-tmpl-list_metrics¶
Specification Value Type object downlink-bytes
Description Track Top-N entities for Downlink Bytes
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
downlink-pkts
Description Track Top-N entities for Downlink Packets
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-flt-apn-filtering
Description Track Top-N entities for Filtering Drop: APN IMSI Filtering
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-flt-gtp-in-gtp
Description Track Top-N entities for Filtering Drop: GTP in GTP Tunnel Present
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-flt-message-filtering
Description Track Top-N entities for Filtering Drop: Message Type Not Permitted on Interface
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-flt-msisdn-filtering
Description Track Top-N entities for Filtering Drop: MSISDN Filtering
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-flt-rat-type-filtering
Description Track Top-N entities for Filtering Drop: RAT Type Filtering
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-u-downlink-byte
Description Track Top-N entities for Rate-limit Drop: GTP-U Downlink byte rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-u-downlink-packet
Description Track Top-N entities for Rate-limit Drop: GTP-U Downlink packet rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-u-max-concurrent-tunnels
Description Track Top-N entities for Rate-limit Drop: GTP-U Concurrent Tunnels
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-u-total-byte
Description Track Top-N entities for Rate-limit Drop: GTP-U Total byte rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-u-total-packet
Description Track Top-N entities for Rate-limit Drop: GTP-U Total packet rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-u-tunnel-create
Description Track Top-N entities for Rate-limit Drop: GTP-U Tunnel Creation rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-u-uplink-byte
Description Track Top-N entities for Rate-limit Drop: GTP-U Uplink byte rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-u-uplink-packet
Description Track Top-N entities for Rate-limit Drop: GTP-U Uplink packet rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-v0-c-agg
Description Track Top-N entities for Rate-limit Drop: Maximum GTPv0-C messages rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-v1-c-agg
Description Track Top-N entities for Rate-limit Drop: Maximum GTPv1-C messages rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-v1-c-create-pdp-request
Description Track Top-N entities for Rate-limit Drop: GTPv1-C Create PDP Req rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-v1-c-update-pdp-request
Description Track Top-N entities for Rate-limit Drop: GTPv1-C Update PDP Req rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-v2-c-agg
Description Track Top-N entities for Rate-limit Drop: Maximum GTPv2-C messages rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-v2-c-create-session-request
Description Track Top-N entities for Rate-limit Drop: GTPv2-C Create Session Req rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-rl-gtp-v2-c-modify-bearer-request
Description Track Top-N entities for Rate-limit Drop: GTPv2-C Modify Bearer Req rate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-country-code-mismatch
Description Track Top-N entities for Validation Drop: Country Code Mismatch in IMSI and MSISDN
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-cross-layer-correlation
Description Track Top-N entities for Validation Drop: Cross Layer IP Address Mismatch
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtp-bearer-count-exceed
Description Track Top-N entities for Validation Drop: GTP Bearer count exceeded max (11)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtp-c-handover-in-progress
Description Track Top-N entities for Validation Drop: GTP-C Drop Since Handover In Progress
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtp-invalid-apn-len-drop
Description Track Top-N entities for Validation Drop: GTP-C Invalid APN Length Drop
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtp-invalid-imsi-len-drop
Description Track Top-N entities for Validation Drop: GTP-C Invalid IMSI Length Drop
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtp-u-spoofed-source-address
Description Track Top-N entities for Validation Drop: GTP-U IP Address Spoofed
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtp-v2-wrong-lbi-create-bearer
Description Track Top-N entities for Validation Drop: GTPV2-C Wrong LBI in Create Bearer Request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtpv0-seqnum-buffer-full
Description Track Top-N entities for Validation Drop: GTPV0-C conn Sequence number Buffer Full
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtpv1-seqnum-buffer-full
Description Track Top-N entities for Validation Drop: GTPV1-C conn Sequence number Buffer Full
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-gtpv2-seqnum-buffer-full
Description Track Top-N entities for Validation Drop: GTPV2-C conn Sequence number Buffer Full
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-invalid-flow-label-v0
Description Track Top-N entities for Validation Drop: Invalid Flow Label in GTPv0-C Header
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-invalid-pkt-len-piggyback
Description Track Top-N entities for Validation Drop: Piggyback message invalid packet length
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-invalid-teid
Description Track Top-N entities for Validation Drop: Invalid TEID Value
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-mandatory-information-element
Description Track Top-N entities for Validation Drop: Mandatory IE Not Present
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-message-length
Description Track Top-N entities for Validation Drop: Message Length Exceeded
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-out-of-order-ie
Description Track Top-N entities for Validation Drop: GTPv1-C Message Out of Order IE
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-out-of-state
Description Track Top-N entities for Validation Drop: Out Of State GTP Message
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-out-of-state-ie
Description Track Top-N entities for Validation Drop: Unexpected IE Present in Message
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-protocol-flag-unset
Description Track Top-N entities for Validation Drop: Protocol flag in Header Field not Set
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-reserved-field-set
Description Track Top-N entities for Validation Drop: Reserved Header Field Set
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-reserved-information-element
Description Track Top-N entities for Validation Drop: Reserved IE Field Present
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-sanity-failed-piggyback
Description Track Top-N entities for Validation Drop: piggyback message anomaly failed
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-sequence-num-correlation
Description Track Top-N entities for Validation Drop: GTP-C Sequence number Mismatch
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-tunnel-id-flag
Description Track Top-N entities for Validation Drop: Tunnel Header Flag Not Set
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-unsupported-message-type
Description Track Top-N entities for Validation Drop: Message type not supported by GTP Version
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
drop-vld-version-not-supported
Description Track Top-N entities for Validation Drop: Invalid GTP version
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-path-management-message
Description Track Top-N entities for GTP Path Management Messages Received
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-u-tunnel-created
Description Track Top-N entities for GTP-U Tunnel Created
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-u-tunnel-deleted
Description Track Top-N entities for GTP-U Tunnel Deleted
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-create-pdp-resp-unsuccess
Description Track Top-N entities for GTPV0-C Create PDP Context Response Unsuccessful
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-half-open-tunnel-closed
Description Track Top-N entities for GTPv0-C Half open tunnel closed
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-tunnel-closed
Description Track Top-N entities for GTPv0-C Tunnel Marked Deleted
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-tunnel-created
Description Track Top-N entities for GTPv0-C Tunnel Created
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-tunnel-deleted
Description Track Top-N entities for GTPv0-C Tunnel Deleted
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-tunnel-deleted-restart
Description Track Top-N entities for GTPv0-C Tunnel Deleted with Restart/failure
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-tunnel-half-closed
Description Track Top-N entities for GTPv0-C Tunnel Delete Request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-tunnel-half-open
Description Track Top-N entities for GTPv0-C Half open tunnel created
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v0-c-update-pdp-resp-unsuccess
Description Track Top-N entities for GTPV0-C Update PDP Context Response Unsuccessful
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-create-pdp-resp-unsuccess
Description Track Top-N entities for GTPV1-C Create PDP Context Response Unsuccessful
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-half-open-tunnel-closed
Description Track Top-N entities for GTPv1-C Half open tunnel closed
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-tunnel-closed
Description Track Top-N entities for GTPv1-C Tunnel Marked Deleted
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-tunnel-created
Description Track Top-N entities for GTPv1-C Tunnel Created
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-tunnel-deleted
Description Track Top-N entities for GTPv1-C Tunnel Deleted
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-tunnel-deleted-restart
Description Track Top-N entities for GTPv1-C Tunnel Deleted with Restart/failure
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-tunnel-half-closed
Description Track Top-N entities for GTPv1-C Tunnel Delete Request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-tunnel-half-open
Description Track Top-N entities for GTPv1-C Half open tunnel created
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v1-c-update-pdp-resp-unsuccess
Description Track Top-N entities for GTPV1-C Update PDP Context response Unsuccessful
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-create-sess-resp-unsuccess
Description Track Top-N entities for GTPV2-C Create Session Response Unsuccessful
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-half-open-tunnel-closed
Description Track Top-N entities for GTPv2-C Half open tunnel closed
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-mod_bearer-resp-unsuccess
Description Track Top-N entities for GTPV2-C Modify Bearer Response Unsuccessful
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-piggyback-message
Description Track Top-N entities for GTPv2-C Piggyback Messages seen
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-tunnel-closed
Description Track Top-N entities for GTPv2-C Tunnel Marked Deleted
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-tunnel-created
Description Track Top-N entities for GTPv2-C Tunnel Created
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-tunnel-deleted
Description Track Top-N entities for GTPv2-C Tunnel Deleted
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-tunnel-deleted-restart
Description Track Top-N entities for GTPv2-C Tunnel Deleted with Restart/failure
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-tunnel-half-closed
Description Track Top-N entities for GTPv2-C Tunnel Delete Request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-v2-c-tunnel-half-open
Description Track Top-N entities for GTPv2-C Half open tunnel created
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uplink-bytes
Description Track Top-N entities for Uplink Bytes
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uplink-pkts
Description Track Top-N entities for Uplink Packets
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
topn_cgnv6-nat-pool-topn-node¶
Specification Value Type object activate
Description Name of the templated to be activated
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/visibility/topn/cgnv6-nat-pool-topn-tmpl
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
file¶
Specification Value Type object metrics
Description: metrics is a JSON Block. Please see below for file_metrics
Type: Object
Reference Object: /axapi/v3/visibility/file/metrics
file_metrics¶
Specification Value Type object action
Description ‘enable’: Enable persistent storage(default); ‘disable’: Disable persistent storage;
Type: string
Supported Values: enable, disable
Default: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
anomaly-detection¶
Specification Value Type object feature-status
Description ‘enable’: Enable anomaly-detection (Not valid for source-nat-ip and source monitor types); ‘disable’: Disable anomaly detection (default);
Type: string
Supported Values: enable, disable
Default: disable
logging
Description ‘per-entity’: Enable per entity logging; ‘per-metric’: Enable per metric logging with threshold details; ‘disable’: Disable anomaly notifications (Default);
Type: string
Supported Values: per-entity, per-metric, disable
Default: disable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
zbar¶
Specification Value Type object action
Description ‘enable’: Enable zbar infra; ‘disable’: Disable zbar infra(default);
Type: string
Supported Values: enable, disable
Default: disable
dest
Description: dest is a JSON Block. Please see below for zbar_dest
Type: Object
Reference Object: /axapi/v3/visibility/zbar/dest
truples
Description: truples is a JSON Block. Please see below for zbar_truples
Type: Object
Reference Object: /axapi/v3/visibility/zbar/truples
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
zbar_dest¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
zbar_truples¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
monitor¶
Specification Value Type object debug-list
Type: List
Reference Object: /axapi/v3/visibility/monitor/debug/{debug-ip-addr}+{debug-port}+{debug-protocol}
delete-debug-file
Description: delete-debug-file is a JSON Block. Please see below for monitor_delete-debug-file
Type: Object
Reference Object: /axapi/v3/visibility/monitor/delete-debug-file/{debug-ip-addr}
mon-entity-topk
Description Enable topk for primary entities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor-key
Description ‘dest’: Monitor traffic to any destination; ‘service’: Monitor traffic to any service;
Type: string
Supported Values: dest, service
netflow
Description: netflow is a JSON Block. Please see below for monitor_netflow
Type: Object
Reference Object: /axapi/v3/visibility/monitor/netflow
port-scan-filter-settings
Description: port-scan-filter-settings is a JSON Block. Please see below for monitor_port-scan-filter-settings
Type: Object
Reference Object: /axapi/v3/visibility/monitor/port-scan-filter-settings
primary-monitor
Description ‘xflow’: Monitor xflow samples;
Type: string
Supported Values: xflow
replay-debug-file
Description: replay-debug-file is a JSON Block. Please see below for monitor_replay-debug-file
Type: Object
Reference Object: /axapi/v3/visibility/monitor/replay-debug-file/{debug-ip-addr}
secondary-monitor
Description: secondary-monitor is a JSON Block. Please see below for monitor_secondary-monitor
Type: Object
Reference Object: /axapi/v3/visibility/monitor/secondary-monitor
sflow
Description: sflow is a JSON Block. Please see below for monitor_sflow
Type: Object
Reference Object: /axapi/v3/visibility/monitor/sflow
source-entity-topk
Description Enable topk for sources to primary-entities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
template
Description: template is a JSON Block. Please see below for monitor_template
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
v4-class-list
Description Class list of ipv4 addresses to be monitored
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
v4-grouping
Description Enable aggregate the log and notification per class-list
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
v6-class-list
Description Class list of ipv6 addresses to be monitored
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
v6-grouping
Description Enable aggregate the log and notification per class-list
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor_debug-list¶
Specification Value Type list Block object keys debug-ip-addr
Description Specify source/dest ip addr
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
debug-port
Description Specify port
Type: number
Range: 1-65535
debug-protocol
Description ‘TCP’: TCP; ‘UDP’: UDP; ‘ICMP’: ICMP;
Type: string
Supported Values: TCP, UDP, ICMP
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
monitor_sflow¶
Specification Value Type object listening-port
Description sFlow port to receive packets (sFlow port number(default 6343))
Type: number
Range: 1-65535
Default: 6343
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
monitor_delete-debug-file¶
Specification Value Type object debug-ip-addr
Description Specify source/dest ip addr
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
debug-port
Description Specify port
Type: number
Range: 1-65535
debug-protocol
Description ‘TCP’: TCP; ‘UDP’: UDP; ‘ICMP’: ICMP;
Type: string
Supported Values: TCP, UDP, ICMP
monitor_replay-debug-file¶
Specification Value Type object debug-ip-addr
Description Specify source/dest ip addr
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
debug-port
Description Specify port
Type: number
Range: 1-65535
debug-protocol
Description ‘TCP’: TCP; ‘UDP’: UDP; ‘ICMP’: ICMP;
Type: string
Supported Values: TCP, UDP, ICMP
monitor_port-scan-filter-settings¶
Specification Value Type object pkt-rate-threshold
Description packet rate threshold for the filter (default 10 pkts/sec, set to 0 pkts/sec to disable the feature)
Type: number
Range: 0-255
Default: 10
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
monitor_template¶
Specification Value Type object notification
Type: List
monitor_template_notification¶
Specification Value Type list Block object keys notif-template-name
Description
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/visibility/reporting/template/notification/template-name
monitor_netflow¶
Specification Value Type object listening-port
Description Netflow port to receive packets (Netflow port number(default 9996))
Type: number
Range: 1-65535
Default: 9996
template-active-timeout
Description Configure active timeout of the netflow templates received in mins (Template active timeout(mins)(default 30mins))
Type: number
Range: 2-300
Default: 30
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
monitor_secondary-monitor¶
Specification Value Type object debug-list
Type: List
Reference Object: /axapi/v3/visibility/monitor/secondary-monitor/debug/{debug-ip-addr}+{debug-port}+{debug-protocol}
delete-debug-file
Description: delete-debug-file is a JSON Block. Please see below for monitor_secondary-monitor_delete-debug-file
Type: Object
Reference Object: /axapi/v3/visibility/monitor/secondary-monitor/delete-debug-file/{debug-ip-addr}
mon-entity-topk
Description Enable topk for secondary entities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
replay-debug-file
Description: replay-debug-file is a JSON Block. Please see below for monitor_secondary-monitor_replay-debug-file
Type: Object
Reference Object: /axapi/v3/visibility/monitor/secondary-monitor/replay-debug-file/{debug-ip-addr}
secondary-monitoring-key
Description ‘service’: Monitor traffic to any service;
Type: string
Supported Values: service
source-entity-topk
Description Enable topk for sources to secondary-entities
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
monitor_secondary-monitor_debug-list¶
Specification Value Type list Block object keys debug-ip-addr
Description Specify source/dest ip addr
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
debug-port
Description Specify port
Type: number
Range: 1-65535
debug-protocol
Description ‘TCP’: TCP; ‘UDP’: UDP; ‘ICMP’: ICMP;
Type: string
Supported Values: TCP, UDP, ICMP
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
monitor_secondary-monitor_delete-debug-file¶
Specification Value Type object debug-ip-addr
Description Specify source/dest ip addr
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
debug-port
Description Specify port
Type: number
Range: 1-65535
debug-protocol
Description ‘TCP’: TCP; ‘UDP’: UDP; ‘ICMP’: ICMP;
Type: string
Supported Values: TCP, UDP, ICMP
monitor_secondary-monitor_replay-debug-file¶
Specification Value Type object debug-ip-addr
Description Specify source/dest ip addr
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
debug-port
Description Specify port
Type: number
Range: 1-65535
debug-protocol
Description ‘TCP’: TCP; ‘UDP’: UDP; ‘ICMP’: ICMP;
Type: string
Supported Values: TCP, UDP, ICMP