.. _session_filter:

session-filter
==============

Create a convenience Filter to display/clear sessions


session-filter Specification
----------------------------

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

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

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

	 **Collection Name**                   :ref:`1327_session-filter_list`

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

	                                       

	 **Element Name**                      session-filter

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

	 **Element Attributes**                session-filter_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1327_session-filter_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/session-filter



.. raw:: html

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


:ref:`1327_session-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/session-filter/{name}



.. raw:: html

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


:ref:`1327_session-filter_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/session-filter



.. raw:: html

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


:ref:`1327_session-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/session-filter/{name}



.. raw:: html

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


:ref:`1327_session-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/session-filter/{name}



.. raw:: html

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


:ref:`1327_session-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/session-filter



.. raw:: html

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


:ref:`1327_session-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/session-filter/{name}



.. raw:: html

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


:ref:`1327_session-filter_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1327_session-filter_list:

session-filter-list
-------------------


    session-filter-list is **JSON List** of :ref:`1327_session-filter_attributes` 

        session-filter-list : [

             { :ref:`1327_session-filter_attributes` },

             { :ref:`1327_session-filter_attributes` },

             ...

         ]

.. _1327_session-filter_attributes:

session-filter attributes
-------------------------

    **filter-cfg**

        **Description:** filter-cfg is a **JSON Block**.  Please see below for :ref:`1327_filter-cfg` 

        **Type:** Object

    **name**

        **Description** Session filter name

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **set**

        **Description** Set filter criteria

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1327_filter-cfg:

filter-cfg
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **dest-addr**

        **Description** Forward Destination IP (Destination IP address)

        **Type:** string

        **Format:** ipv4-address

    **dest-mask**

        **Description** Forward Destination IP Subnet (Destination Netmask)

        **Type:** string

        **Format:** ipv4-netmask

    **dport2**

        **Description** Forward Destination Port (Dest Port)

        **Type:** number

        **Range:** 1-65535

    **session-type**

        **Description** 'ipv6': Display ipv6 sessions only; 'sip': SIP sessions; 

        **Type:** string

        **Supported Values:** ipv6, sip

    **source-addr**

        **Description** Forward Source IP (Source IP address)

        **Type:** string

        **Format:** ipv4-address

    **source-mask**

        **Description** Forward Source IP Subnet (Source Netmask)

        **Type:** string

        **Format:** ipv4-netmask

    **source-port**

        **Description** Forward Source Port

        **Type:** number

        **Range:** 1-65535