.. _tuple_filter:

tuple-filter
============

Specify a tuple filter


tuple-filter Specification
--------------------------

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

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

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

	 **Collection Name**                   :ref:`3521_tuple-filter_list`

	 **Collection URI**                    /axapi/v3/tuple-filter

	                                       

	 **Element Name**                      tuple-filter

	 **Element URI**                       /axapi/v3/tuple-filter/{name}

	 **Element Attributes**                tuple-filter_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`tuple-filter schema <tuple-filter/tuple-filter.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/tuple-filter



.. raw:: html

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


:ref:`3521_tuple-filter_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/tuple_filter_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/tuple-filter



.. raw:: html

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


:ref:`3521_tuple-filter_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/tuple-filter/{name}



.. raw:: html

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


:ref:`3521_tuple-filter_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/tuple_filter_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/tuple-filter



.. raw:: html

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


:ref:`3521_tuple-filter_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/tuple-filter/{name}



.. raw:: html

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


:ref:`3521_tuple-filter_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/tuple-filter/{name}



.. raw:: html

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


:ref:`3521_tuple-filter_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/tuple-filter



.. raw:: html

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


:ref:`3521_tuple-filter_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/tuple-filter/{name}



.. raw:: html

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


:ref:`3521_tuple-filter_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3521_tuple-filter_list:

tuple-filter-list
-----------------


    tuple-filter-list is **JSON List** of :ref:`3521_tuple-filter_attributes` 

        tuple-filter-list : [

             { :ref:`3521_tuple-filter_attributes` },

             { :ref:`3521_tuple-filter_attributes` },

             ...

         ]

.. _3521_tuple-filter_attributes:

tuple-filter attributes
-----------------------

    **filter-rule-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/tuple-filter/{name}/filter-rule/{id} <tuple_filter>`

    **filter-type**

        **Description** 'ipv4': IPv4 tuple filter; 'ipv6': IPv6 tuple filter; 

        **Type:** string

        **Supported Values:** ipv4, ipv6

    **name**

        **Description** Tuple filter name

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

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

.. _3521_filter-rule-list:

filter-rule-list
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **dst-addr**

        **Description** Destination IPv4 address with prefix

        **Type:** string

        **Format:** ipv4-cidr

    **dst-port**

        **Description** Destination port

        **Type:** number

        **Range:** 1-65535

    **dst-v6-addr**

        **Description** Destination IPv6 address with prefix

        **Type:** string

        **Format:** ipv6-address-plen

    **dst-v6-port**

        **Description** Destination port

        **Type:** number

        **Range:** 1-65535

    **id**

        **Description** filter rule id

        **Type:** number

        **Range:** 1-4

    **src-addr**

        **Description** Source IPv4 address with prefix

        **Type:** string

        **Format:** ipv4-cidr

    **src-port**

        **Description** Source port

        **Type:** number

        **Range:** 1-65535

    **src-v6-addr**

        **Description** Source IPv6 address with prefix

        **Type:** string

        **Format:** ipv6-address-plen

    **src-v6-port**

        **Description** Source port

        **Type:** number

        **Range:** 1-65535

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters