visibility

Display Network statistics

visibility Specification

   
Type Configuration Resource
Element Name visibility
Element URI /axapi/v3/visibility
Element Attributes visibility_attributes
Statistics Data URI /axapi/v3/visibility/stats
Schema visibility schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/visibility

visibility attributes

Get Object

GET

/axapi/v3/visibility

visibility attributes

Modify Object

POST

/axapi/v3/visibility

visibility attributes

Replace Object

PUT

/axapi/v3/visibility

visibility attributes

Delete Object

DELETE

/axapi/v3/visibility

visibility attributes

visibility attributes

anomaly-detection

Description: anomaly-detection is a JSON Block. Please see below for anomaly-detection

Type: Object

Refernce Object: /axapi/v3/visibility/anomaly-detection

debug-files

Description: debug-files is a JSON Block. Please see below for debug-files

Type: Object

Refernce Object: /axapi/v3/visibility/debug-files

file

Description: file is a JSON Block. Please see below for file

Type: Object

Refernce Object: /axapi/v3/visibility/file

flow-collector

Description: flow-collector is a JSON Block. Please see below for flow-collector

Type: Object

Refernce 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

Refernce 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

Refernce Object: /axapi/v3/visibility/mon-topk

monitor

Description: monitor is a JSON Block. Please see below for monitor

Type: Object

Refernce Object: /axapi/v3/visibility/monitor

monitored-entity

Description: monitored-entity is a JSON Block. Please see below for monitored-entity

Type: Object

Refernce Object: /axapi/v3/visibility/monitored-entity

reporting

Description: reporting is a JSON Block. Please see below for reporting

Type: Object

Refernce Object: /axapi/v3/visibility/reporting

resource-usage

Description: resource-usage is a JSON Block. Please see below for resource-usage

Type: Object

Refernce Object: /axapi/v3/visibility/resource-usage

sampling-enable

Type: List

source-entity-topk

Description Enable monitoring entity 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

Refernce Object: /axapi/v3/visibility/topn

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

flow-collector

Specification  
Type object

netflow

Description: netflow is a JSON Block. Please see below for flow-collector_netflow

Type: Object

Refernce Object: /axapi/v3/visibility/flow-collector/netflow

sflow

Description: sflow is a JSON Block. Please see below for flow-collector_sflow

Type: Object

Refernce Object: /axapi/v3/visibility/flow-collector/sflow

flow-collector_netflow

Specification  
Type object

sampling-enable

Type: List

template

Description: template is a JSON Block. Please see below for flow-collector_netflow_template

Type: Object

Refernce 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_sampling-enable

Specification  
Type list
Block object keys  

counters1

Description ‘all’: all; ‘pkts-rcvd’: Total nflow packets received; ‘v9-templates-created’: Total v9 templates created; ‘v9-templates-deleted’: Total v9 templates deleted; ‘v10-templates-created’: Total v10(IPFIX) templates created; ‘v10-templates-deleted’: Total v10(IPFIX) templates deleted; ‘template-drop-exceeded’: Total templates dropped because of maximum limit; ‘template-drop-out-of-memory’: Total templates dropped becuase of out of memory; ‘frag-dropped’: Total nflow fragment packets droppped; ‘agent-not-found’: nflow pkts from not configured agents; ‘version-not-supported’: nflow version not supported; ‘unknown-dir’: nflow sample direction is unknown;

Type: string

Supported Values: all, pkts-rcvd, v9-templates-created, v9-templates-deleted, v10-templates-created, v10-templates-deleted, template-drop-exceeded, template-drop-out-of-memory, frag-dropped, agent-not-found, version-not-supported, unknown-dir

flow-collector_netflow_template

Specification  
Type object

detail

Description: detail is a JSON Block. Please see below for flow-collector_netflow_template_detail

Type: Object

Refernce Object: /axapi/v3/visibility/flow-collector/netflow/template/detail

sampling-enable

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

flow-collector_netflow_template_sampling-enable

Specification  
Type list
Block object keys  

counters1

Description ‘all’: all; ‘templates-added-to-delq’: Netflow templates added to the delete queue; ‘templates-removed-from-delq’: Netflow templates removed from the delete queue;

Type: string

Supported Values: all, templates-added-to-delq, templates-removed-from-delq

flow-collector_netflow_template_detail

Specification  
Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

flow-collector_sflow

Specification  
Type object

sampling-enable

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

flow-collector_sflow_sampling-enable

Specification  
Type list
Block object keys  

counters1

Description ‘all’: all; ‘pkts-received’: Total sflow pkts received; ‘frag-dropped’: Total sflow fragment packets droppped; ‘agent-not-found’: sflow pkts from not configured agents; ‘version-not-supported’: sflow version not supported; ‘unknown-dir’: sflow sample direction is unknown;

Type: string

Supported Values: all, pkts-received, frag-dropped, agent-not-found, version-not-supported, unknown-dir

resource-usage

Specification  
Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

reporting

Specification  
Type object

sampling-enable

Type: List

telemetry-export-interval

Description: telemetry-export-interval is a JSON Block. Please see below for reporting_telemetry-export-interval

Type: Object

Refernce Object: /axapi/v3/visibility/reporting/telemetry-export-interval

template

Description: template is a JSON Block. Please see below for reporting_template

Type: Object

Refernce Object: /axapi/v3/visibility/reporting/template

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

reporting_sampling-enable

Specification  
Type list
Block object keys  

counters1

Description ‘all’: all; ‘log-transmit-failure’: Total log transmit failures; ‘buffer-alloc-failure’: Total reporting buffer allocation failures; ‘notif-jobs-in-queue’: Total notification jobs in queue; ‘enqueue-fail’: Total enqueue jobs failed; ‘enqueue-pass’: Total enqueue jobs passed; ‘dequeued’: Total jobs dequeued;

Type: string

Supported Values: all, log-transmit-failure, buffer-alloc-failure, notif-jobs-in-queue, enqueue-fail, enqueue-pass, dequeued

reporting_template

Specification  
Type object

notification

Description: notification is a JSON Block. Please see below for reporting_template_notification

Type: Object

Refernce Object: /axapi/v3/visibility/reporting/template/notification

reporting_template_notification

Specification  
Type object

debug

Description: debug is a JSON Block. Please see below for reporting_template_notification_debug

Type: Object

Refernce Object: /axapi/v3/visibility/reporting/template/notification/debug

template-name-list

reporting_template_notification_debug

Specification  
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  
Type list
Block object keys  

action

Description ‘enable’: Enable; ‘disable’: Disable;

Type: string

Supported Values: enable, disable

Default: enable

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: /

sampling-enable

Type: List

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  
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_template_notification_template-name-list_sampling-enable

Specification  
Type list
Block object keys  

counters1

Description ‘all’: all; ‘sent_successful’: Sent successful; ‘send_fail’: Send failures; ‘response_fail’: Response failures;

Type: string

Supported Values: all, sent_successful, send_fail, response_fail

reporting_telemetry-export-interval

Specification  
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  
Type object

sampling-enable

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

mon-entity-telemetry-data_sampling-enable

Specification  
Type list
Block object keys  

counters1

Description ‘all’: all; ‘in_pkts’: Monitored Entity telemetry Metric IN pkts; ‘out_pkts’: Monitored Entity telemetry Metric OUT pkts; ‘in_bytes’: Monitored Entity telemetry Metric IN bytes; ‘out_bytes’: Monitored Entity telemetry Metric OUT bytes; ‘errors’: Monitored Entity telemetry Metric ERRORS; ‘in_small_pkt’: Monitored Entity telemetry Metric IN SMALL pkt; ‘in_frag’: Monitored Entity telemetry Metric IN frag; ‘out_small_pkt’: Monitored Entity telemetry Metric OUT SMALL pkt; ‘out_frag’: Monitored Entity telemetry Metric OUT frag; ‘new-conn’: Monitored Entity telemetry Metric New Sessions; ‘concurrent-conn’: concurrent-conn; ‘in_bytes_per_out_bytes’: Monitored Entity telemetry Metric IN bytes per OUT bytes; ‘drop_pkts_per_pkts’: Monitored Entity telemetry Metric Drop pkts per pkts; ‘tcp_in_syn’: Monitored Entity telemetry Metric TCP IN syn; ‘tcp_out_syn’: Monitored Entity telemetry Metric TCP OUT syn; ‘tcp_in_fin’: Monitored Entity telemetry Metric TCP IN fin; ‘tcp_out_fin’: Monitored Entity telemetry Metric TCP OUT fin; ‘tcp_in_payload’: Monitored Entity telemetry Metric TCP IN payload; ‘tcp_out_payload’: Monitored Entity telemetry Metric TCP OUT payload; ‘tcp_in_rexmit’: Monitored Entity telemetry Metric TCP IN rexmit; ‘tcp_out_rexmit’: Monitored Entity telemetry Metric TCP OUT rexmit; ‘tcp_in_rst’: Monitored Entity telemetry Metric TCP IN rst; ‘tcp_out_rst’: Monitored Entity telemetry Metric TCP OUT rst; ‘tcp_in_empty_ack’: Monitored Entity telemetry Metric TCP_IN EMPTY ack; ‘tcp_out_empty_ack’: Monitored Entity telemetry Metric TCP OUT EMPTY ack; ‘tcp_in_zero_wnd’: Monitored Entity telemetry Metric TCP IN ZERO wnd; ‘tcp_out_zero_wnd’: Monitored Entity telemetry Metric TCP OUT ZERO wnd; ‘tcp_fwd_syn_per_fin’: Monitored Entity telemetry Metric TCP FWD SYN per FIN;

Type: string

Supported Values: all, in_pkts, out_pkts, in_bytes, out_bytes, errors, in_small_pkt, in_frag, out_small_pkt, out_frag, new-conn, concurrent-conn, in_bytes_per_out_bytes, drop_pkts_per_pkts, tcp_in_syn, tcp_out_syn, tcp_in_fin, tcp_out_fin, tcp_in_payload, tcp_out_payload, tcp_in_rexmit, tcp_out_rexmit, tcp_in_rst, tcp_out_rst, tcp_in_empty_ack, tcp_out_empty_ack, tcp_in_zero_wnd, tcp_out_zero_wnd, tcp_fwd_syn_per_fin

mon-topk

Specification  
Type object

sources

Description: sources is a JSON Block. Please see below for mon-topk_sources

Type: Object

Refernce Object: /axapi/v3/visibility/mon-topk/sources

mon-topk_sources

Specification  
Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

monitored-entity

Specification  
Type object

detail

Description: detail is a JSON Block. Please see below for monitored-entity_detail

Type: Object

Refernce 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

Refernce Object: /axapi/v3/visibility/monitored-entity/mon-topk

secondary

Description: secondary is a JSON Block. Please see below for monitored-entity_secondary

Type: Object

Refernce Object: /axapi/v3/visibility/monitored-entity/secondary

sessions

Description: sessions is a JSON Block. Please see below for monitored-entity_sessions

Type: Object

Refernce 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  
Type object

sources

Description: sources is a JSON Block. Please see below for monitored-entity_mon-topk_sources

Type: Object

Refernce 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  
Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

monitored-entity_secondary

Specification  
Type object

mon-topk

Description: mon-topk is a JSON Block. Please see below for monitored-entity_secondary_mon-topk

Type: Object

Refernce Object: /axapi/v3/visibility/monitored-entity/secondary/mon-topk

monitored-entity_secondary_mon-topk

Specification  
Type object

sources

Description: sources is a JSON Block. Please see below for monitored-entity_secondary_mon-topk_sources

Type: Object

Refernce 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  
Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

monitored-entity_sessions

Specification  
Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

monitored-entity_detail

Specification  
Type object

debug

Description: debug is a JSON Block. Please see below for monitored-entity_detail_debug

Type: Object

Refernce 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  
Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

debug-files

Specification  
Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

topn

Specification  
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

Refernce Object: /axapi/v3/visibility/topn/cgnv6-nat-pool-topn-node

cgnv6-nat-pool-topn-tmpl-list

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

Refernce Object: /axapi/v3/visibility/topn/gtp-apn-prefix-topn-node

gtp-apn-prefix-topn-tmpl-list

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

Refernce Object: /axapi/v3/visibility/topn/gtp-network-element-topn-node

gtp-network-element-topn-tmpl-list

sampling-enable

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

topn_gtp-network-element-topn-tmpl-list

Specification  
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

Refernce 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  
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-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-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-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-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-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-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 Tunnel Create Request

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 Tunnel Create Request

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 Tunnel Create Request

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  
Type object

activate

Description Name of the templated to be activated

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Refernce 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  
Type object

activate

Description Name of the templated to be activated

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Refernce 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_sampling-enable

Specification  
Type list
Block object keys  

counters1

Description ‘all’: all; ‘heap-alloc-success’: Total heap node allocated; ‘heap-alloc-failed’: Total heap node alloc failed; ‘heap-alloc-oom’: Total heap node alloc failed Out of Memory; ‘obj-reg-success’: Total object node allocated; ‘obj-reg-failed’: Total object node alloc failed; ‘obj-reg-oom’: Total object node alloc failed Out of Memory; ‘heap-deleted’: Total Heap node deleted; ‘obj-deleted’: Total Object node deleted; ‘heap-metric-alloc-success’: Total heap metric node allocated; ‘heap-metric-alloc-oom’: Total heap metric node alloc failed Out of Memory; ‘heap-move-to-delq’: Total heap node moved to delq; ‘heap-metric-deleted’: Total Heap metric node deleted; ‘obj-metric-reg-success’: Total object Metric node allocated; ‘obj-metric-reg-oom’: Total object Metric node alloc failed Out of Memory; ‘obj-move-to-delq’: Total object node moved to delq; ‘obj-metric-deleted’: Total Object metric node deleted; ‘hc-obj-alloc-failed’: Send failed to HC, Out of Memory;

Type: string

Supported Values: all, heap-alloc-success, heap-alloc-failed, heap-alloc-oom, obj-reg-success, obj-reg-failed, obj-reg-oom, heap-deleted, obj-deleted, heap-metric-alloc-success, heap-metric-alloc-oom, heap-move-to-delq, heap-metric-deleted, obj-metric-reg-success, obj-metric-reg-oom, obj-move-to-delq, obj-metric-deleted, hc-obj-alloc-failed

topn_cgnv6-nat-pool-topn-tmpl-list

Specification  
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

Refernce 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  
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  
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

Refernce 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  
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-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-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-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-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-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-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 in GTP-C

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 Tunnel Create Request

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 Tunnel Create Request

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 Tunnel Create Request

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  
Type object

activate

Description Name of the templated to be activated

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Refernce 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

sampling-enable

Specification  
Type list
Block object keys  

counters1

Description ‘all’: all; ‘mon-entity-limit-exceed’: Total monitor entity limit exceed failures; ‘ha-entity-create-sent’: Total montior entity HA create messages sent; ‘ha-entity-delete-sent’: Total montior entity HA delete messages sent; ‘ha-entity-anomaly-on-sent’: Total anomaly on HA messages sent; ‘ha-entity-anomaly-off-sent’: Total anomaly off HA messages sent; ‘ha-entity-periodic-sync-sent’: Total monitor entity periodic sync messages sent; ‘out-of-memory-alloc-failures’: Out of memory allocation failures; ‘lw-mon-entity-created’: Total Light-weight entities created; ‘lw-mon-entity-deleted’: Total Light-weight entities deleted; ‘lw-mon-entity-limit-exceed’: Light weight limit exceeded errors; ‘lw-out-of-memory-alloc-failures’: Light Weight Out-of-memory allocation failures; ‘mon-entity-rrd-file-timestamp-err’: Total monitor entity rrd file timestamp errors; ‘mon-entity-rrd-update-err’: Total monitor entity rrd update error; ‘mon-entity-rrd-last-update-fetch-failed-err’: Total monitor entity rrd last update fetch failed error; ‘mon-entity-rrd-tune-err’: Total monitor entity rrd tune error; ‘mon-entity-rrd-out-of-memory-err’: Total monitor entity rrd load failed, out of memory error; ‘mon-entity-rrd-file-create-err’: Total monitor entity rrd file create error;

Type: string

Supported Values: all, mon-entity-limit-exceed, ha-entity-create-sent, ha-entity-delete-sent, ha-entity-anomaly-on-sent, ha-entity-anomaly-off-sent, ha-entity-periodic-sync-sent, out-of-memory-alloc-failures, lw-mon-entity-created, lw-mon-entity-deleted, lw-mon-entity-limit-exceed, lw-out-of-memory-alloc-failures, mon-entity-rrd-file-timestamp-err, mon-entity-rrd-update-err, mon-entity-rrd-last-update-fetch-failed-err, mon-entity-rrd-tune-err, mon-entity-rrd-out-of-memory-err, mon-entity-rrd-file-create-err

file

Specification  
Type object

metrics

Description: metrics is a JSON Block. Please see below for file_metrics

Type: Object

Refernce Object: /axapi/v3/visibility/file/metrics

file_metrics

Specification  
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  
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

monitor

Specification  
Type object

agent-list

debug-list

delete-debug-file

Description: delete-debug-file is a JSON Block. Please see below for monitor_delete-debug-file

Type: Object

Refernce Object: /axapi/v3/visibility/monitor/delete-debug-file/{debug-ip-addr}

index-sessions

Description Start indexing associated sessions

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

index-sessions-type

Description ‘per-cpu’: Use per cpu list;

Type: string

Supported Values: per-cpu

mon-entity-topk

Description Enable monitoring entity topk for primary entities

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

monitor-key

Description ‘source’: Monitor traffic from all sources; ‘dest’: Monitor traffic to any destination; ‘service’: Monitor traffic to any service; ‘source-nat-ip’: Monitor traffic to all source nat IPs;

Type: string

Supported Values: source, dest, service, source-nat-ip

netflow

Description: netflow is a JSON Block. Please see below for monitor_netflow

Type: Object

Refernce Object: /axapi/v3/visibility/monitor/netflow

primary-monitor

Description ‘traffic’: Mointor traffic;

Type: string

Supported Values: traffic

replay-debug-file

Description: replay-debug-file is a JSON Block. Please see below for monitor_replay-debug-file

Type: Object

Refernce 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

Refernce Object: /axapi/v3/visibility/monitor/secondary-monitor

sflow

Description: sflow is a JSON Block. Please see below for monitor_sflow

Type: Object

Refernce Object: /axapi/v3/visibility/monitor/sflow

source-entity-topk

Description Enable monitoring entity 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

monitor_debug-list

Specification  
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  
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  
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_template

Specification  
Type object

notification

Type: List

monitor_template_notification

Specification  
Type list
Block object keys  

notif-template-name

Description

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

Refernce Object: /axapi/v3/visibility/reporting/template/notification/template-name

monitor_replay-debug-file

Specification  
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_netflow

Specification  
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  
Type object

debug-list

delete-debug-file

Description: delete-debug-file is a JSON Block. Please see below for monitor_secondary-monitor_delete-debug-file

Type: Object

Refernce 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

Refernce 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  
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  
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  
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_agent-list

Specification  
Type list
Block object keys  

agent-name

Description Specify name for the agent

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

agent-v4-addr

Description Configure agent’s IPv4 address

Type: string

Format: ipv4-address

agent-v6-addr

Description Configure agent’s IPv6 address

Type: string

Format: ipv6-address

sampling-enable

Type: List

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

monitor_agent-list_sampling-enable

Specification  
Type list
Block object keys  

counters1

Description ‘all’: all; ‘sflow-packets-received’: sFlow Packets Received; ‘sflow-samples-received’: sFlow Samples Received; ‘sflow-samples-bad-len’: sFlow Samples Bad Length; ‘sflow-samples-non-std’: sFlow Samples Non-standard; ‘sflow-samples-skipped’: sFlow Samples Skipped; ‘sflow-sample-record-bad-len’: sFlow Sample Records Bad Length; ‘sflow-samples-sent-for-detection’: sFlow Samples Processed For Detection; ‘sflow-sample-record-invalid-layer2’: sFlow Sample Records Unknown Layer-2; ‘sflow-sample-ipv6-hdr-parse-fail’: sFlow Sample IPv6 Record Header Parse Failures; ‘sflow-disabled’: sFlow Packet Samples Processing Disabled; ‘netflow-disabled’: Netflow Flow Samples Processing Disabled; ‘netflow-v5-packets-received’: Netflow v5 Packets Received; ‘netflow-v5-samples-received’: Netflow v5 Samples Received; ‘netflow-v5-samples-sent-for-detection’: Netflow v5 Samples Processed For Detection; ‘netflow-v5-sample-records-bad-len’: Netflow v5 Sample Records Bad Length; ‘netflow-v5-max-records-exceed’: Netflow v5 Sample Max Records Error; ‘netflow-v9-packets-received’: Netflow v9 Packets Received; ‘netflow-v9-samples-received’: Netflow v9 Samples Received; ‘netflow-v9-samples-sent-for-detection’: Netflow v9 Samples Processed For Detection; ‘netflow-v9-sample-records-bad-len’: Netflow v9 Sample Records Bad Length; ‘netflow-v9-max-records-exceed’: Netflow v9 Sample Max Records Error; ‘netflow-v10-packets-received’: Netflow v10 Packets Received; ‘netflow-v10-samples-received’: Netflow v10 Samples Received; ‘netflow-v10-samples-sent-for-detection’: Netflow v10 Samples Procssed For Detection; ‘netflow-v10-sample-records-bad-len’: Netflow v10 Sample Records Bad Length; ‘netflow-v10-max-records-exceed’: Netflow v10 Sample Max records Error; ‘netflow-tcp-sample-received’: Netflow TCP Samples Received; ‘netflow-udp-sample-received’: Netflow UDP Samples received; ‘netflow-icmp-sample-received’: Netflow ICMP Samples Received; ‘netflow-other-sample-received’: Netflow OTHER Samples Received; ‘netflow-record-copy-oom-error’: Netflow Data Record Copy Fail OOM; ‘netflow-record-rse-invalid’: Netflow Data Record Reduced Size Invalid; ‘netflow-sample-flow-dur-error’: Netflow Sample Flow Duration Error;

Type: string

Supported Values: all, sflow-packets-received, sflow-samples-received, sflow-samples-bad-len, sflow-samples-non-std, sflow-samples-skipped, sflow-sample-record-bad-len, sflow-samples-sent-for-detection, sflow-sample-record-invalid-layer2, sflow-sample-ipv6-hdr-parse-fail, sflow-disabled, netflow-disabled, netflow-v5-packets-received, netflow-v5-samples-received, netflow-v5-samples-sent-for-detection, netflow-v5-sample-records-bad-len, netflow-v5-max-records-exceed, netflow-v9-packets-received, netflow-v9-samples-received, netflow-v9-samples-sent-for-detection, netflow-v9-sample-records-bad-len, netflow-v9-max-records-exceed, netflow-v10-packets-received, netflow-v10-samples-received, netflow-v10-samples-sent-for-detection, netflow-v10-sample-records-bad-len, netflow-v10-max-records-exceed, netflow-tcp-sample-received, netflow-udp-sample-received, netflow-icmp-sample-received, netflow-other-sample-received, netflow-record-copy-oom-error, netflow-record-rse-invalid, netflow-sample-flow-dur-error

stats data

  Counter Size Description
       
  ha-entity-delete-sent 8 Total montior entity HA delete messages sent
  out-of-memory-alloc-failures 8 Out of memory allocation failures
  mon-entity-rrd-tune-err 8 Total monitor entity rrd tune error
  mon-entity-rrd-file-timestamp-err 8 Total monitor entity rrd file timestamp errors
  lw-mon-entity-limit-exceed 8 Light weight limit exceeded errors
  ha-entity-periodic-sync-sent 8 Total monitor entity periodic sync messages sent
  mon-entity-rrd-last-update-fetch-failed-err 8 Total monitor entity rrd last update fetch failed error
  ha-entity-create-sent 8 Total montior entity HA create messages sent
  lw-mon-entity-created 8 Total Light-weight entities created
  mon-entity-rrd-update-err 8 Total monitor entity rrd update error
  mon-entity-rrd-out-of-memory-err 8 Total monitor entity rrd load failed, out of memory error
  ha-entity-anomaly-off-sent 8 Total anomaly off HA messages sent
  mon-entity-rrd-file-create-err 8 Total monitor entity rrd file create error
  mon-entity-limit-exceed 8 Total monitor entity limit exceed failures
  lw-mon-entity-deleted 8 Total Light-weight entities deleted
  lw-out-of-memory-alloc-failures 8 Light Weight Out-of-memory allocation failures
  ha-entity-anomaly-on-sent 8 Total anomaly on HA messages sent