.. _fw_gtp:

fw gtp
======

Configure GTP


gtp Specification
-----------------

	===================================== ===============================================
	===================================== ===============================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      gtp

	 **Element URI**                       /axapi/v3/fw/gtp

	 **Element Attributes**                gtp_attributes

	 **Statistics Data URI**               /axapi/v3/fw/gtp/stats

	 **Schema**                             :download:`gtp schema <fw-gtp/fw-gtp.txt>`
	===================================== ===============================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/fw/gtp



.. raw:: html

   </td><td valign = 'top'>


:ref:`902_gtp_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/fw/gtp



.. raw:: html

   </td><td valign = 'top'>


:ref:`902_gtp_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/fw/gtp



.. raw:: html

   </td><td valign = 'top'>


:ref:`902_gtp_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/fw/gtp



.. raw:: html

   </td><td valign = 'top'>


:ref:`902_gtp_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/fw/gtp



.. raw:: html

   </td><td valign = 'top'>


:ref:`902_gtp_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _902_gtp_attributes:

gtp attributes
--------------

    **apn-log-periodicity**

        **Description** Periodic Logging Frequency(In Minutes)

        **Type:** number

        **Range:** 1-30

    **apn-prefix**

        **Description:** apn-prefix is a **JSON Block**.  Please see below for :ref:`902_apn-prefix` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/fw/gtp/apn-prefix <fw_gtp_apn_prefix>`

    **apn-prefix-list**

        **Description** Class List (Class List Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **echo-timeout**

        **Description** echo message timeout (minutes) (echo-timeout (default 2))

        **Type:** number

        **Range:** 1-261

        **Default:** 2

    **gtp-value**

        **Description** 'enable': Enable GTP Inspection; 

        **Type:** string

        **Supported Values:** enable

    **insertion-mode**

        **Description** 'monitor': Enable inline view-only mode; 'skip-state-checks': Enable skip stateful checks mode; 

        **Type:** string

        **Supported Values:** monitor, skip-state-checks

    **ne-v4-log-periodicity**

        **Description** Periodic Logging Frequency(In Minutes)

        **Type:** number

        **Range:** 1-30

    **ne-v6-log-periodicity**

        **Description** Periodic Logging Frequency(In Minutes)

        **Type:** number

        **Range:** 1-30

    **network-element**

        **Description:** network-element is a **JSON Block**.  Please see below for :ref:`902_network-element` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/fw/gtp/network-element <fw_gtp_network_element>`

    **network-element-list-v4**

        **Description** Class List (Class List Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **network-element-list-v6**

        **Description** Class List (Class List Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **path-mgmt-logging**

        **Description** 'enable-log': Enable Log for Path Management; 

        **Type:** string

        **Supported Values:** enable-log

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _902_network-element:

network-element
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _902_apn-prefix:

apn-prefix
^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _902_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - gtp-v0-c-downlink-ingress-packets
      - 8
      - GTPv0-C Downlink Ingress Packets

   *  - 
      - gtp-del-bearer-request-retransmit
      - 8
      - GTP-C Retransmitted Delete Bearer Request

   *  - 
      - drop-vld-gtp-echo-out-of-state-
      - 8
      - GTP Echo Out of State Drop

   *  - 
      - gtp-add-bearer-response-retransmit
      - 8
      - GTP-C Retransmitted Add Bearer Response

   *  - 
      - gtp-path-message-length-mismatch
      - 8
      - GTP-Path Message Length Mismatch Across Layers

   *  - 
      - out-of-session-memory
      - 8
      - Out of Tunnel Memory

   *  - 
      - drop-vld-gtp-echo-ie-len-exceed-msg-len
      - 8
      - GTP Echo IE Length Exceeds Message Length

   *  - 
      - gtp-v2-c-bearer-not-found-in-delete-resp
      - 8
      - GTPv2-C Bearer Not Found in GTP Response

   *  - 
      - drop-gtp-bearer-not-found-in-resp
      - 8
      - GTP Bearer not found in response

   *  - 
      - gtp-v1-c-downlink-ingress-bytes
      - 8
      - GTPv1-C Downlink Ingress Bytes

   *  - 
      - gtp-node-restart-echo
      - 8
      - GTP Node Restoration due to Recovery IE in Echo

   *  - 
      - gtp-v0-c-uplink-egress-packets
      - 8
      - GTPv0-C Uplink Egress Packets

   *  - 
      - gtp-u-uplink-ingress-bytes
      - 8
      - GTP-U Uplink Ingress Bytes

   *  - 
      - gtp-rate-limit-t3-ctr-create-failure
      - 8
      - GTP Rate Limit Dynamic Counters Create Failure

   *  - 
      - gtp-v0-c-uplink-ingress-packets
      - 8
      - GTPv0-C Uplink Ingress Packets

   *  - 
      - gtp-v0-c-downlink-egress-bytes
      - 8
      - GTPv0-C Downlink Egress Bytes

   *  - 
      - gtp-rr-message-drop
      - 8
      - GTP Message Dropped in RR Mode

   *  - 
      - gtp-v0-c-downlink-egress-packets
      - 8
      - GTPv0-C Downlink Egress Packets

   *  - 
      - gtp-v1-c-uplink-ingress-bytes
      - 8
      - GTPv1-C Uplink Ingress Bytes

   *  - 
      - gtp-v1-c-uplink-egress-bytes
      - 8
      - GTPv1-C Uplink Egress Bytes

   *  - 
      - gtp-v0-c-downlink-ingress-bytes
      - 8
      - GTPv0-C Downlink Ingress Bytes

   *  - 
      - gtp-tunnel-rate-limit-entry-create-failure
      - 8
      - GTP Tunnel Level Rate Limit Entry Create Failure

   *  - 
      - gtp-v2-c-uplink-egress-packets
      - 8
      - GTPv2-C Uplink Egress Packets

   *  - 
      - gtp-v0-c-uplink-egress-bytes
      - 8
      - GTPv0-C Uplink Egress Bytes

   *  - 
      - no-fwd-route
      - 8
      - No Forward Route

   *  - 
      - gtp-v2-c-bearer-not-found-in-delete-req
      - 8
      - GTPv2-C Bearer Not Found in GTP Request

   *  - 
      - gtp-c-handover-request-out-of-state-drop
      - 8
      - GTP-C Handover Request Out of state Drop

   *  - 
      - gtp-u-uplink-egress-bytes
      - 8
      - GTP-U Uplink Egress Bytes

   *  - 
      - gtp-u-downlink-ingress-packets
      - 8
      - GTP-U Downlink Ingress Packets

   *  - 
      - gtp-c-echo-path-failure
      - 8
      - GTP-C Path Failure due to Echo

   *  - 
      - no-rev-route
      - 8
      - No Reverse Route

   *  - 
      - gtp-u-downlink-egress-bytes
      - 8
      - GTP-U Downlink Egress Bytes

   *  - 
      - gtp-rate-limit-smp-create-failure
      - 8
      - GTP Rate Limit SMP Create Failure

   *  - 
      - gtp-stateless-forward
      - 8
      - GTP Stateless Forward

   *  - 
      - gtp-monitor-forward
      - 8
      - GTP messages forwarded via monitor mode

   *  - 
      - gtp-v1-c-nsapi-not-found-in-delete-req
      - 8
      - GTPv1-C NSAPI Not Found in GTP Request

   *  - 
      - gtp-v2-c-downlink-ingress-packets
      - 8
      - GTPv2-C Downlink Ingress Packets

   *  - 
      - gtp-v2-c-downlink-egress-packets
      - 8
      - GTPv2-C Downlink Egress Packets

   *  - 
      - drop-gtp-frag-or-jumbo-pkt
      - 8
      - GTP Fragmented or JUMBO packet Drop

   *  - 
      - gtp-v0-c-uplink-ingress-bytes
      - 8
      - GTPv0-C Uplink Ingress Bytes

   *  - 
      - gtp-u-downlink-egress-packets
      - 8
      - GTP-U Downlink Egress Packets

   *  - 
      - gtp-v2-c-uplink-egress-bytes
      - 8
      - GTPv2-C Uplink Egress Bytes

   *  - 
      - drop-gtp-missing-cond-ie-bearer-ctx
      - 8
      - Missing conditional IE in bearer context Drop

   *  - 
      - gtp-u-out-of-state-drop
      - 8
      - GTP-U Out of state Drop

   *  - 
      - gtp-u-uplink-egress-packets
      - 8
      - GTP-U Uplink Egress Packets

   *  - 
      - gtp-u-downlink-ingress-bytes
      - 8
      - GTP-U Downlink Ingress Bytes

   *  - 
      - gtp-rate-limit-entry-create-failure
      - 8
      - GTP Rate Limit Entry Create Failure

   *  - 
      - gtp-u-uplink-ingress-packets
      - 8
      - GTP-U Uplink Ingress Packets

   *  - 
      - gtp-v1-c-downlink-ingress-packets
      - 8
      - GTPv1-C Downlink Ingress Packets

   *  - 
      - gtp-v1-c-downlink-egress-packets
      - 8
      - GTPv1-C Downlink Egress Packets

   *  - 
      - gtp-v1-c-uplink-ingress-packets
      - 8
      - GTPv1-C Uplink Ingress Packets

   *  - 
      - gtp-v1-c-uplink-egress-packets
      - 8
      - GTPv1-C Uplink Egress Packets

   *  - 
      - gtp-u-message-length-mismatch
      - 8
      - GTP-U Message Length Mismatch Across Layers

   *  - 
      - gtp-v2-c-uplink-ingress-packets
      - 8
      - GTPv2-C Uplink Ingress Packets

   *  - 
      - gtp-v1-c-downlink-egress-bytes
      - 8
      - GTPv1-C Downlink Egress Bytes

   *  - 
      - gtp-v2-c-downlink-ingress-bytes
      - 8
      - GTPv2-C Downlink Ingress Bytes

   *  - 
      - gtp-v2-c-downlink-egress-bytes
      - 8
      - GTPv2-C Downlink Egress Bytes

   *  - 
      - gtp-v2-c-uplink-ingress-bytes
      - 8
      - GTPv2-C Uplink Ingress Bytes