.. _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:`668_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:`668_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:`668_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:`668_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:`668_gtp_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _668_gtp_attributes:

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

    **gtp-value**

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

        **Type:** string

        **Supported Values:** enable

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _668_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'create-session-request': Create Session Request; 'create-session-response': Create Session Response; 'path-management-message': Path Management Message; 'delete-session-request': Delete Session Request; 'delete-session-response': Delete Session Response; 'reserved-field-set-drop': Reserved field set drop; 'tunnel-id-flag-drop': Tunnel ID Flag Incorrect; 'message-filtering-drop': Message Filtering Drop; 'reserved-information-element-drop': Resevered Information Element Field Drop; 'mandatory-information-element-drop': Mandatory Information Element Field Drop; 'filter-list-drop': APN IMSI Information Filtering Drop; 'invalid-teid-drop': Invalid TEID Drop; 'out-of-state-drop': Out Of State Drop; 'message-length-drop': Message Length Exceeded; 'unsupported-message-type-v2': GTP v2 message type is not supported; 'fast-conn-setup': Fast Conn Setup Attempt; 'out-of-session-memory': Out of Session Memory; 'no-fwd-route': No Forward Route; 'no-rev-route': NO Reverse Route; 'invalid-key': Invalid TEID Field; 'create-session-request-retransmit': Retransmitted Create Session Request; 'delete-session-request-retransmit': Retransmitted Delete Session Request; 'response-cause-not-accepted-drop': Response Cause indicates Request not Accepted; 'invalid-imsi-len-drop': Invalid IMSI Length Drop; 'invalid-apn-len-drop': Invalid APN Length Drop; 'create-pdp-context-request-v1': GTP v1 Create PDP Context Request; 'create-pdp-context-response-v1': GTP v1 Create PDP Context Response; 'path-management-message-v1': GTP v1 Path Management Message; 'reserved-field-set-drop-v1': GTP v1 Reserved field set drop; 'message-filtering-drop-v1': GTP v1 Message Filtering Drop; 'reserved-information-element-drop-v1': GTP v1 Reserved Information Element Field Drop; 'mandatory-information-element-drop-v1': GTP v1 Mandatory Information Element Field Drop; 'filter-list-drop-v1': GTP v1 APN IMSI Information Filtering Drop; 'invalid-teid-drop-v1': GTP v1 Invalid TEID Drop; 'message-length-drop-v1': GTP v1 Message Length Exceeded; 'version-not-supported': GTP version is not supported; 'unsupported-message-type-v1': GTP v1 message type is not supported; 'delete-pdp-context-request-v1': GTP v1 Delete Context PDP Request; 'delete-pdp-context-response-v1': GTP v1 Delete Context PDP Response; 'create-pdp-context-request-v0': GTP v0 Create PDP Context Request; 'create-pdp-context-response-v0': GTP v0 Create PDP Context Response; 'delete-pdp-context-request-v0': GTP v0 Delete Context PDP Request; 'delete-pdp-context-response-v0': GTP v0 Delete Context PDP Response; 'path-management-message-v0': GTP v0 Path Management Message; 'message-filtering-drop-v0': GTP v0 Message Filtering Drop; 'unsupported-message-type-v0': GTP v0 message type is not supported; 'invalid-flow-label-drop-v0': GTP v0 Invalid flow label drop; 'invalid-tid-drop-v0': GTP v0 Invalid tid drop; 'message-length-drop-v0': GTP v0 Message Length Exceeded; 'mandatory-information-element-drop-v0': GTP v0 Mandatory Information Element Field Drop; 'filter-list-drop-v0': GTP v0 APN IMSI Information Filtering Drop; 'gtp-in-gtp-drop': GTP in GTP Filtering Drop; 

        **Type:** string

        **Supported Values:** all, create-session-request, create-session-response, path-management-message, delete-session-request, delete-session-response, reserved-field-set-drop, tunnel-id-flag-drop, message-filtering-drop, reserved-information-element-drop, mandatory-information-element-drop, filter-list-drop, invalid-teid-drop, out-of-state-drop, message-length-drop, unsupported-message-type-v2, fast-conn-setup, out-of-session-memory, no-fwd-route, no-rev-route, invalid-key, create-session-request-retransmit, delete-session-request-retransmit, response-cause-not-accepted, invalid-imsi-len-drop, invalid-apn-len-drop, create-pdp-context-request-v1, create-pdp-context-response-v1, path-management-message-v1, reserved-field-set-drop-v1, message-filtering-drop-v1, reserved-information-element-drop-v1, mandatory-information-element-drop-v1, filter-list-drop-v1, invalid-teid-drop-v1, message-length-drop-v1, version-not-supported, unsupported-message-type-v1, delete-pdp-context-request-v1, delete-pdp-context-response-v1, create-pdp-context-request-v0, create-pdp-context-response-v0, delete-pdp-context-request-v0, delete-pdp-context-response-v0, path-management-message-v0, message-filtering-drop-v0, unsupported-message-type-v0, invalid-flow-label-drop-v0, invalid-tid-drop-v0, message-length-drop-v0, mandatory-information-element-drop-v0, filter-list-drop-v0, gtp-in-gtp-drop

.. _668_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - invalid-apn-len-drop
      - 8
      - Invalid APN Length Drop

   *  - 
      - reserved-field-set-drop
      - 8
      - Reserved field set drop

   *  - 
      - message-length-drop
      - 8
      - Message Length Exceeded

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

   *  - 
      - reserved-information-element-drop
      - 8
      - Resevered Information Element Field Drop

   *  - 
      - delete-pdp-context-response-v0
      - 8
      - GTP v0 Delete Context PDP Response

   *  - 
      - out-of-state-drop
      - 8
      - Out Of State Drop

   *  - 
      - message-filtering-drop-v0
      - 8
      - GTP v0 Message Filtering Drop

   *  - 
      - delete-session-response
      - 8
      - Delete Session Response

   *  - 
      - invalid-flow-label-drop-v0
      - 8
      - GTP v0 Invalid flow label drop

   *  - 
      - invalid-imsi-len-drop
      - 8
      - Invalid IMSI Length Drop

   *  - 
      - filter-list-drop
      - 8
      - APN IMSI Information Filtering Drop

   *  - 
      - unsupported-message-type-v0
      - 8
      - GTP v0 message type is not supported

   *  - 
      - unsupported-message-type-v1
      - 8
      - GTP v1 message type is not supported

   *  - 
      - unsupported-message-type-v2
      - 8
      - GTP v2 message type is not supported

   *  - 
      - invalid-teid-drop
      - 8
      - Invalid TEID Drop

   *  - 
      - message-filtering-drop
      - 8
      - Message Filtering Drop

   *  - 
      - filter-list-drop-v0
      - 8
      - GTP v0 APN IMSI Information Filtering Drop

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

   *  - 
      - delete-pdp-context-response-v1
      - 8
      - GTP v1 Delete Context PDP Response

   *  - 
      - fast-conn-setup
      - 8
      - Fast Conn Setup Attempt

   *  - 
      - path-management-message-v1
      - 8
      - GTP v1 Path Management Message

   *  - 
      - mandatory-information-element-drop-v1
      - 8
      - GTP v1 Mandatory Information Element Field Drop

   *  - 
      - create-session-request-retransmit
      - 8
      - Retransmitted Create Session Request

   *  - 
      - create-session-request
      - 8
      - Create Session Request

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

   *  - 
      - gtp-in-gtp-drop
      - 8
      - GTP in GTP Filtering Drop

   *  - 
      - version-not-supported
      - 8
      - GTP version is not supported

   *  - 
      - create-session-response
      - 8
      - Create Session Response

   *  - 
      - mandatory-information-element-drop-v0
      - 8
      - GTP v0 Mandatory Information Element Field Drop

   *  - 
      - message-length-drop-v1
      - 8
      - GTP v1 Message Length Exceeded

   *  - 
      - delete-session-request
      - 8
      - Delete Session Request

   *  - 
      - message-filtering-drop-v1
      - 8
      - GTP v1 Message Filtering Drop

   *  - 
      - reserved-information-element-drop-v1
      - 8
      - GTP v1 Reserved Information Element Field Drop

   *  - 
      - invalid-teid-drop-v1
      - 8
      - GTP v1 Invalid TEID Drop

   *  - 
      - filter-list-drop-v1
      - 8
      - GTP v1 APN IMSI Information Filtering Drop

   *  - 
      - path-management-message-v0
      - 8
      - GTP v0 Path Management Message

   *  - 
      - reserved-field-set-drop-v1
      - 8
      - GTP v1 Reserved field set drop

   *  - 
      - tunnel-id-flag-drop
      - 8
      - Tunnel ID Flag Incorrect

   *  - 
      - invalid-key
      - 8
      - Invalid TEID Field

   *  - 
      - message-length-drop-v0
      - 8
      - GTP v0 Message Length Exceeded

   *  - 
      - delete-pdp-context-request-v0
      - 8
      - GTP v0 Delete Context PDP Request

   *  - 
      - delete-pdp-context-request-v1
      - 8
      - GTP v1 Delete Context PDP Request

   *  - 
      - create-pdp-context-response-v1
      - 8
      - GTP v1 Create PDP Context Response

   *  - 
      - mandatory-information-element-drop
      - 8
      - Mandatory Information Element Field Drop

   *  - 
      - path-management-message
      - 8
      - Path Management Message

   *  - 
      - create-pdp-context-request-v1
      - 8
      - GTP v1 Create PDP Context Request

   *  - 
      - create-pdp-context-request-v0
      - 8
      - GTP v0 Create PDP Context Request

   *  - 
      - response-cause-not-accepted
      - 8
      - Response Cause indicates Request not Accepted

   *  - 
      - invalid-tid-drop-v0
      - 8
      - GTP v0 Invalid tid drop

   *  - 
      - create-pdp-context-response-v0
      - 8
      - GTP v0 Create PDP Context Response

   *  - 
      - delete-session-request-retransmit
      - 8
      - Retransmitted Delete Session Request