.. _template_gtp_apn_imsi_list:

template gtp apn-imsi-list
==========================

Configure GTP APN IMSI list


apn-imsi-list Specification
---------------------------

	===================================== ==========================================================================
	 **Parameter**                         **Value** 

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

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

	 **Collection Name**                   :ref:`3472_apn-imsi-list_list`

	 **Collection URI**                    /axapi/v3/template/gtp/apn-imsi-list

	                                       

	 **Element Name**                      apn-imsi-list

	 **Element URI**                       /axapi/v3/template/gtp/apn-imsi-list/{name}

	 **Element Attributes**                apn-imsi-list_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3472_apn-imsi-list_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/template_gtp_apn_imsi_list_POST.txt
   :literal:




.. raw:: html

   </div></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/apn-imsi-list



.. raw:: html

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


:ref:`3472_apn-imsi-list_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/apn-imsi-list/{name}



.. raw:: html

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


:ref:`3472_apn-imsi-list_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/template_gtp_apn_imsi_list_GET.txt
   :literal:




.. raw:: html

   </div></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/apn-imsi-list



.. raw:: html

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


:ref:`3472_apn-imsi-list_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/apn-imsi-list/{name}



.. raw:: html

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


:ref:`3472_apn-imsi-list_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/apn-imsi-list/{name}



.. raw:: html

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


:ref:`3472_apn-imsi-list_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/template_gtp_apn_imsi_list_PUT.txt
   :literal:




.. raw:: html

   </div></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/apn-imsi-list



.. raw:: html

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


:ref:`3472_apn-imsi-list_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/apn-imsi-list/{name}



.. raw:: html

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


:ref:`3472_apn-imsi-list_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/template_gtp_apn_imsi_list_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3472_apn-imsi-list_list:

apn-imsi-list-list
------------------


    apn-imsi-list-list is **JSON List** of :ref:`3472_apn-imsi-list_attributes` 

        apn-imsi-list-list : [

             { :ref:`3472_apn-imsi-list_attributes` },

             { :ref:`3472_apn-imsi-list_attributes` },

             ...

         ]

.. _3472_apn-imsi-list_attributes:

apn-imsi-list attributes
------------------------

    **action**

        **Description** 'permit': Create a whitelist to permit the packets that match APN IMSI filters; 'deny': Create a blacklist to deny the packets that match APN IMSI filters (default); 

        **Type:** string

        **Supported Values:** permit, deny

        **Default:** deny

    **name**

        **Description** Specify name of the GTP APN IMSI list

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **str-list**

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

.. _3472_str-list:

str-list
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **apn**

        **Description** Specify the APN filter

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 100 characters

        **Maximum Length:** 1 characters

    **imsi**

        **Description** Specify the IMSI filter

        **Type:** string

        **Maximum Length:** 15 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** imsi and selection-mode are mutually exclusive

    **imsi-selection**

        **Description** Specify the IMSI filter

        **Type:** string

        **Maximum Length:** 15 characters

        **Maximum Length:** 1 characters

    **selection-mode**

        **Description** 'mobilestation': MS provided APN, subscription not verified; 'network': Network provided APN, subscription not verified; 'verified': MS or Network provided APN, subscription verified; 

        **Type:** string

        **Supported Values:** mobilestation, network, verified

        **Mutual Exclusion:** selection-mode and imsi are mutually exclusive