.. _visibility_topn_gtp_network_element_topn_tmpl: visibility topn gtp-network-element-topn-tmpl ============================================= Configure template for fw.gtp.network-element gtp-network-element-topn-tmpl Specification ------------------------------------------- ===================================== ============================================================================================= **Parameter** **Value** ===================================== ============================================================================================= **Type** *Collection* **Object Key(s)** *name* **Collection Name** :ref:`4039_gtp-network-element-topn-tmpl_list` **Collection URI** /axapi/v3/visibility/topn/gtp-network-element-topn-tmpl **Element Name** gtp-network-element-topn-tmpl **Element URI** /axapi/v3/visibility/topn/gtp-network-element-topn-tmpl/{name} **Element Attributes** gtp-network-element-topn-tmpl_attributes **Partition Visibility** shared **Schema** :download:`gtp-network-element-topn-tmpl schema ` ===================================== ============================================================================================= **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Create Object .. raw:: html POST .. raw:: html /axapi/v3/visibility/topn/gtp-network-element-topn-tmpl .. raw:: html :ref:`4039_gtp-network-element-topn-tmpl_attributes` .. raw:: html
Create List .. raw:: html POST .. raw:: html /axapi/v3/visibility/topn/gtp-network-element-topn-tmpl .. raw:: html :ref:`4039_gtp-network-element-topn-tmpl_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/visibility/topn/gtp-network-element-topn-tmpl/{name} .. raw:: html :ref:`4039_gtp-network-element-topn-tmpl_attributes` .. raw:: html
Get List .. raw:: html GET .. raw:: html /axapi/v3/visibility/topn/gtp-network-element-topn-tmpl .. raw:: html :ref:`4039_gtp-network-element-topn-tmpl_list` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/visibility/topn/gtp-network-element-topn-tmpl/{name} .. raw:: html :ref:`4039_gtp-network-element-topn-tmpl_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/visibility/topn/gtp-network-element-topn-tmpl/{name} .. raw:: html :ref:`4039_gtp-network-element-topn-tmpl_attributes` .. raw:: html
Replace List .. raw:: html PUT .. raw:: html /axapi/v3/visibility/topn/gtp-network-element-topn-tmpl .. raw:: html :ref:`4039_gtp-network-element-topn-tmpl_list` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/visibility/topn/gtp-network-element-topn-tmpl/{name} .. raw:: html :ref:`4039_gtp-network-element-topn-tmpl_attributes` .. raw:: html
.. _4039_gtp-network-element-topn-tmpl_list: gtp-network-element-topn-tmpl-list ---------------------------------- gtp-network-element-topn-tmpl-list is **JSON List** of :ref:`4039_gtp-network-element-topn-tmpl_attributes` gtp-network-element-topn-tmpl-list : [ { :ref:`4039_gtp-network-element-topn-tmpl_attributes` }, { :ref:`4039_gtp-network-element-topn-tmpl_attributes` }, ... ] .. _4039_gtp-network-element-topn-tmpl_attributes: gtp-network-element-topn-tmpl attributes ---------------------------------------- **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 :ref:`4039_metrics` **Type:** Object **Reference Object:** :doc:`/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 .. _4039_metrics: 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-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-c-handover-in-progress-with-conn** **Description** Track Top-N entities for GTP-C matching a conn with Handover In Progress **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