.. _cgnv6_stateful_firewall_udp_idle_timeout:

cgnv6 stateful-firewall udp idle-timeout
========================================

Configure UDP session idle timeout for IPv4 and IPv6


idle-timeout Specification
--------------------------

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

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

	 **Object Key(s)**                     *port, port-end*

	 **Collection Name**                   :ref:`599_idle-timeout_list`

	 **Collection URI**                    /axapi/v3/cgnv6/stateful-firewall/udp/idle-timeout

	                                       

	 **Element Name**                      idle-timeout

	 **Element URI**                       /axapi/v3/cgnv6/stateful-firewall/udp/idle-timeout/{port}+{port-end}

	 **Element Attributes**                idle-timeout_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`idle-timeout schema <cgnv6-stateful-firewall-udp-idle-timeout/cgnv6-stateful-firewall-udp-idle-timeout.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/cgnv6/stateful-firewall/udp/idle-timeout



.. raw:: html

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


:ref:`599_idle-timeout_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/cgnv6_stateful_firewall_udp_idle_timeout_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/cgnv6/stateful-firewall/udp/idle-timeout



.. raw:: html

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


:ref:`599_idle-timeout_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/cgnv6/stateful-firewall/udp/idle-timeout/{port}+{port-end}



.. raw:: html

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


:ref:`599_idle-timeout_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/cgnv6_stateful_firewall_udp_idle_timeout_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/cgnv6/stateful-firewall/udp/idle-timeout



.. raw:: html

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


:ref:`599_idle-timeout_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/cgnv6/stateful-firewall/udp/idle-timeout/{port}+{port-end}



.. raw:: html

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


:ref:`599_idle-timeout_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/cgnv6/stateful-firewall/udp/idle-timeout/{port}+{port-end}



.. raw:: html

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


:ref:`599_idle-timeout_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/cgnv6_stateful_firewall_udp_idle_timeout_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/cgnv6/stateful-firewall/udp/idle-timeout



.. raw:: html

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


:ref:`599_idle-timeout_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/cgnv6/stateful-firewall/udp/idle-timeout/{port}+{port-end}



.. raw:: html

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


:ref:`599_idle-timeout_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/cgnv6_stateful_firewall_udp_idle_timeout_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _599_idle-timeout_list:

idle-timeout-list
-----------------


    idle-timeout-list is **JSON List** of :ref:`599_idle-timeout_attributes` 

        idle-timeout-list : [

             { :ref:`599_idle-timeout_attributes` },

             { :ref:`599_idle-timeout_attributes` },

             ...

         ]

.. _599_idle-timeout_attributes:

idle-timeout attributes
-----------------------

    **fast**

        **Description** Fast aging for idle sessions

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** fast and idle-timeout-val-port-range are mutually exclusive

    **idle-timeout-val-port-range**

        **Description** Idle timeout for IPv4 and IPv6 TCP established sessions (Idle timeout for IPv4 and IPv6 TCP established sessions (default: 300 seconds))

        **Type:** number

        **Range:** 60-15000

        **Default:** 300

        **Mutual Exclusion:** idle-timeout-val-port-range and fast are mutually exclusive

    **port**

        **Description** Single Destination Port or Port Range Start

        **Type:** number

        **Range:** 1-65535

    **port-end**

        **Description** Port Range End

        **Type:** number

        **Range:** 1-65535

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters