.. _system_ipsec:

system ipsec
============

Configure Crypto Cores for IPsec processing


ipsec Specification
-------------------

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

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

	 **Element Name**                      ipsec

	 **Element URI**                       /axapi/v3/system/ipsec

	 **Element Attributes**                ipsec_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3311_ipsec_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/system_ipsec_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/system/ipsec



.. raw:: html

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


:ref:`3311_ipsec_attributes`



.. 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/system/ipsec



.. raw:: html

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


:ref:`3311_ipsec_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/system/ipsec



.. raw:: html

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


:ref:`3311_ipsec_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/system/ipsec



.. raw:: html

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


:ref:`3311_ipsec_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3311_ipsec_attributes:

ipsec attributes
----------------

    **QAT**

        **Description** HW assisted QAT SSL module

        **Type:** boolean

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

        **Default:** 0

    **crypto-core**

        **Description** Crypto cores assigned for IPsec processing

        **Type:** number

        **Range:** 0-64

        **Default:** 0

    **crypto-mem**

        **Description** Crypto memory percentage assigned for IPsec processing (rounded to increments of 10)

        **Type:** number

        **Range:** 0-100

        **Default:** 0

    **fpga-decrypt**

        **Description:** fpga-decrypt is a **JSON Block**.  Please see below for :ref:`3311_fpga-decrypt` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/system/ipsec/fpga-decrypt <system_ipsec_fpga_decrypt>`

    **packet-round-robin**

        **Description** Enable packet round robin for IPsec packets

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

.. _3311_fpga-decrypt:

fpga-decrypt
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **action**

        **Description** 'enable': Enable FPGA decryption offload; 'disable': Disable FPGA decryption offload; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable