.. _template_gtp:

template gtp
============

Define a GTP template


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

	===================================== ============================================================
	===================================== ============================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`1714_gtp_list`

	 **Collection URI**                    /axapi/v3/template/gtp

	                                       

	 **Element Name**                      gtp

	 **Element URI**                       /axapi/v3/template/gtp/{name}

	 **Element Attributes**                gtp_attributes

	 **Schema**                             :download:`gtp schema <template-gtp/template-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/template/gtp



.. raw:: html

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


:ref:`1714_gtp_attributes`



.. raw:: html

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




.. raw:: html

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


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/template/gtp



.. raw:: html

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


:ref:`1714_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/template/gtp/{name}



.. raw:: html

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


:ref:`1714_gtp_attributes`



.. raw:: html

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




.. raw:: html

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


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/template/gtp



.. raw:: html

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


:ref:`1714_gtp_list`



.. 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/template/gtp/{name}



.. raw:: html

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


:ref:`1714_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/template/gtp/{name}



.. raw:: html

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


:ref:`1714_gtp_attributes`



.. raw:: html

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




.. raw:: html

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


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/template/gtp



.. raw:: html

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


:ref:`1714_gtp_list`



.. 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/template/gtp/{name}



.. raw:: html

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


:ref:`1714_gtp_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1714_gtp_list:

gtp-list
--------


    gtp-list is **JSON List** of :ref:`1714_gtp_attributes` 

        gtp-list : [

             { :ref:`1714_gtp_attributes` },

             { :ref:`1714_gtp_attributes` },

             ...

         ]

.. _1714_gtp_attributes:

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

    **gtp-filter-list**

        **Description** Specify a GTP Filter-List (GTP Filter-List Value)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/template/gtp-filter-list <template_gtp_filter_list>`

    **log**

        **Description:** log is a **JSON Block**.  Please see below for :ref:`1714_log` 

        **Type:** Object

    **mandatory-ie-filtering**

        **Description** 'disable': Disable  Mandatory Information Element Filtering; 

        **Type:** string

        **Supported Values:** disable

    **maximum-message-length**

        **Description** Maximum message length for a GTP message

        **Type:** number

        **Range:** 64-1500

        **Default:** 1500

    **message-type**

        **Type:** List

    **name**

        **Description** GTP Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Default:** default

    **protocol-anomaly-filtering**

        **Description** 'disable': Disable Anomaly Filtering; 

        **Type:** string

        **Supported Values:** disable

    **tunnel-timeout**

        **Description** Idle Timeout in seconds (default: 5 mins)

        **Type:** number

        **Range:** 5-34952

        **Default:** 60

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

.. _1714_message-type:

message-type
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **drop-value**

        **Description** 'drop': Drop the Message Type; 

        **Type:** string

        **Supported Values:** drop

    **message-type-v0**

        **Description** 'create-pdp': Create PDP Context Request/Response; 'data-record': Data Record Request/Response; 'delete-pdp': Delete PDP Context Request/Response; 'echo': Echo Request/Response; 'error-indication': Error Indication; 'failure-report': Failure Report Request/Response; 'identification': Identification Request/Response; 'node-alive': Node Alive Request/Response; 'note-ms-present': Note MS GPRS present Request/Response; 'pdu-notification': PDU Notification Request/Response/Reject Request/Reject Response; 'redirection': Redirection Request/Response; 'send-route': Send Route Info Request/Response; 'sgsn-context': Sgsn Context Request/Response/Acknowledge; 'gtp-pdu': T-PDU; 'update-pdp': Update PDP Context Request/Response; 'create-aa-pdp': Create AA PDP Context Request/Response; 'delete-aa-pdp': Delete AA PDP Context Request/Response; 'version-not-supported': Version Not Supported; 

        **Type:** string

        **Supported Values:** create-pdp, data-record, delete-pdp, echo, error-indication, failure-report, identification, node-alive, note-ms-present, pdu-notification, redirection, send-route, sgsn-context, gtp-pdu, update-pdp, create-aa-pdp, delete-aa-pdp, version-not-supported

    **message-type-v1**

        **Description** 'create-pdp': Create PDP Context Request/Response; 'data-record': Data Record Request/Response; 'delete-pdp': Delete PDP Context Request/Response; 'echo': Echo Request/Response; 'error-indication': Error Indication; 'failure-report': Failure Report Request/Response; 'fwd-relocation': Forward Relocation Request/Response/Complete/Complete Acknowledge; 'fwd-srns-context': Forward Srns Context/Context Acknowlege; 'identification': Identification Request/Response; 'node-alive': Node Alive Request/Response; 'note-ms-present': Note MS GPRS present Request/Response; 'pdu-notification': PDU Notification Request/Response/Reject Request/Reject Response; 'ran-info': RAN Info Relay; 'redirection': Redirection Request/Response; 'relocation-cancel': Relocation Cancel Request/Response; 'send-route': Send Route Info Request/Response; 'sgsn-context': Sgsn Context Request/Response/Acknowledge; 'supported-extension': Supported Extension Headers Notification; 'gtp-pdu': G-PDU; 'update-pdp': Update PDP Context Request/Response; 'version-not-supported': Version Not Supported; 

        **Type:** string

        **Supported Values:** create-pdp, data-record, delete-pdp, echo, error-indication, failure-report, fwd-relocation, fwd-srns-context, identification, node-alive, note-ms-present, pdu-notification, ran-info, redirection, relocation-cancel, send-route, sgsn-context, supported-extension, gtp-pdu, update-pdp, version-not-supported

    **message-type-v2**

        **Description** 'bearer-resource': Bearer Resource Command/Failure; 'change-notification': Change Notification Request/Response; 'context': Context Request/Response/Ack; 'config-transfer': Configuration Transfer Tunnel; 'create-bearer': Create Bearer Request/Response; 'create-data-forwarding': Create Indirect Data Tunnel Request/Response; 'create-tunnel-forwarding': Create Forwarding Tunnel Request/Response; 'create-session': Create Session Request/Response; 'cs-paging': CS Paging Indication; 'delete-bearer': Delete Bearer Request/Response; 'delete-command': Delete Bearer Command/Failure; 'delete-data-forwarding': Delete Indirect Data Tunnel Request/Response; 'delete-pdn': Delete PDN Connection Request/Response; 'delete-session': Delete Session Request/Response; 'detach': Detach Notification/Ack; 'downlink-notification': Downlink Data Notification/Ack/Failure; 'echo': Echo Request/Response; 'fwd-access': Forward Access Context Notification/Ack; 'fwd-relocation': Forward Relocation Request/Response/Complete; 'identification': Identification Request/Response; 'mbms-session-start': MBMS Session Start Request/Response; 'mbms-session-stop': MBMS Session Stop Request/Response; 'mbms-session-update': MBMS Session Update Request/Response; 'modify-bearer': Modify Bearer Request/Response; 'modify-command': Modify Bearer Command/Failure; 'release-access': Release Access Bearer Request/Response; 'relocation-cancel': Relocation Cancel Request/Response; 'resume': Resume Notification/Ack; 'stop-paging': Stop Paging Indication; 'suspend': Suspend Notification/Ack; 'trace-session': Trace Session Activation/Deactivation; 'update-bearer': Update Bearer Request/Response; 'update-pdn': Update PDN Connection Request/Response; 'version-not-supported': Version Not Supported; 

        **Type:** string

        **Supported Values:** bearer-resource, change-notification, context, config-transfer, create-bearer, create-data-forwarding, create-tunnel-forwarding, create-session, cs-paging, delete-bearer, delete-command, delete-data-forwarding, delete-pdn, delete-session, detach, downlink-notification, echo, fwd-access, fwd-relocation, identification, mbms-session-start, mbms-session-stop, mbms-session-update, modify-bearer, modify-command, release-access, relocation-cancel, resume, stop-paging, suspend, trace-session, update-bearer, update-pdn, version-not-supported

.. _1714_log:

log
^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **information-filtering**

        **Description** Log Packet Drop due to Information Filtering

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **invalid-teid**

        **Description** Log Packet Drop due to Invalid Tunnel Endpoint Identifier

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **mandatory-ie-missing**

        **Description** Log Packet Drop due to Missing Mandatory Information Element

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **message-filtering**

        **Description** Log Packet Drop due to Message Filtering

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **reserved-ie-present**

        **Description** Log Packet Drop due to Presence of Reserved Information Element

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0