.. _fw_alg_esp:

fw alg esp
==========

Change Firewall ESP ALG Settings


esp Specification
-----------------

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

	===================================== ===================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      esp

	 **Element URI**                       /axapi/v3/fw/alg/esp

	 **Element Attributes**                esp_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/fw/alg/esp/stats

	 **Schema**                             :download:`esp schema <fw-alg-esp/fw-alg-esp.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/fw/alg/esp



.. raw:: html

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


:ref:`1603_esp_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/fw_alg_esp_POST.txt
   :literal:




.. raw:: html

   </div></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/fw/alg/esp



.. raw:: html

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


:ref:`1603_esp_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/fw_alg_esp_GET.txt
   :literal:




.. raw:: html

   </div></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/fw/alg/esp



.. raw:: html

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


:ref:`1603_esp_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/fw/alg/esp



.. raw:: html

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


:ref:`1603_esp_attributes`



.. 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/fw/alg/esp



.. raw:: html

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


:ref:`1603_esp_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1603_esp_attributes:

esp attributes
--------------

    **default-port-disable**

        **Description** 'default-port-disable': Disable ESP ALG default port 500; 

        **Type:** string

        **Supported Values:** default-port-disable

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1603_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'session-created': ESP Sessions Created; 'helper-created': ESP Helper Sessions Created; 'helper-freed': ESP Helper Sessions Freed; 'helper-freed-used': ESP Helper Sessions freed used; 'helper-freed-unused': ESP Helper Sessions freed unused; 'helper-already-used': ESP Helper Session already used; 'helper-in-rml': ESP Helper Session in Remove List; 

        **Type:** string

        **Supported Values:** all, session-created, helper-created, helper-freed, helper-freed-used, helper-freed-unused, helper-already-used, helper-in-rml