.. _vpn_ipsec_oper:

vpn ipsec oper
==============

Operational Status for the object ipsec


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

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

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

	 **Collection Name**                   :ref:`4077_ipsec_list`

	 **Collection URI**                    /axapi/v3/vpn/ipsec/{name}

	                                       

	 **Element Name**                      ipsec

	 **Element URI**                       /axapi/v3/vpn/ipsec/{name}/oper

	 **Element Attributes**                ipsec_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`ipsec schema <vpn-ipsec-oper/vpn-ipsec-oper.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/vpn/ipsec/{name}



.. raw:: html

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


:ref:`4077_ipsec_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/vpn/ipsec/{name}



.. raw:: html

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


:ref:`4077_ipsec_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/vpn/ipsec/{name}/oper



.. raw:: html

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


:ref:`4077_ipsec_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/vpn/ipsec/{name}



.. raw:: html

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


:ref:`4077_ipsec_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/vpn/ipsec/{name}/oper



.. raw:: html

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


:ref:`4077_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/vpn/ipsec/{name}/oper



.. raw:: html

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


:ref:`4077_ipsec_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/vpn/ipsec/{name}



.. raw:: html

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


:ref:`4077_ipsec_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/vpn/ipsec/{name}/oper



.. raw:: html

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


:ref:`4077_ipsec_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _4077_ipsec_list:

ipsec-list
----------


    ipsec-list is **JSON List** of :ref:`4077_ipsec_attributes` 

        ipsec-list : [

             { :ref:`4077_ipsec_attributes` },

             { :ref:`4077_ipsec_attributes` },

             ...

         ]

.. _4077_ipsec_attributes:

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

    **name**

        **Description** IPsec name

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`4077_oper` 

        **Type:** Object

.. _4077_oper:

oper
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **SA-List**

        **Type:** List

    **in-spi-filter**

        **Description** 

        **Type:** string

    **out-spi-filter**

        **Description** 

        **Type:** string

    **remote-ts-filter**

        **Description** 

        **Type:** string

    **remote-ts-v6-filter**

        **Description** 

        **Type:** string

.. _4077_oper_SA-List:

oper_SA-List
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **Anti-Replay**

        **Description** 

        **Type:** string

    **DH-Group**

        **Description** 

        **Type:** number

    **Encryption-Algorithm**

        **Description** 

        **Type:** string

    **Hash-Algorithm**

        **Description** 

        **Type:** string

    **Lifebytes**

        **Description** 

        **Type:** string

    **Lifetime**

        **Description** 

        **Type:** number

    **Local-IP**

        **Description** 

        **Type:** string

    **Local-Port**

        **Description** 

        **Type:** number

    **Local-SPI**

        **Description** 

        **Type:** string

    **Mode**

        **Description** 

        **Type:** string

    **NAT-Traversal**

        **Description** 

        **Type:** number

    **Peer-IP**

        **Description** 

        **Type:** string

    **Peer-Port**

        **Description** 

        **Type:** number

    **Protocol**

        **Description** 

        **Type:** string

    **Remote-SPI**

        **Description** 

        **Type:** string

    **SA-Index**

        **Description** 

        **Type:** number

    **Status**

        **Description** 

        **Type:** string

    **TS-Proto**

        **Description** 

        **Type:** number

    **anti-replay-num**

        **Description** 

        **Type:** number

    **bytes-decrypted**

        **Description** 

        **Type:** number

    **bytes-encrypted**

        **Description** 

        **Type:** number

    **cavium-bytes-decrypted**

        **Description** 

        **Type:** number

    **cavium-bytes-encrypted**

        **Description** 

        **Type:** number

    **cavium-packets-decrypted**

        **Description** 

        **Type:** number

    **cavium-packets-encrypted**

        **Description** 

        **Type:** number

    **enforce-ts-decap-drop**

        **Description** 

        **Type:** number

    **enforce-ts-encap-drop**

        **Description** 

        **Type:** number

    **frag-after-encap-frag-packets**

        **Description** 

        **Type:** number

    **frag-received**

        **Description** 

        **Type:** number

    **invalid-tunnel-id**

        **Description** 

        **Type:** number

    **no-next-hop**

        **Description** 

        **Type:** number

    **no-tunnel-found**

        **Description** 

        **Type:** number

    **packets-decrypted**

        **Description** 

        **Type:** number

    **packets-encrypted**

        **Description** 

        **Type:** number

    **packets-err-encryption**

        **Description** 

        **Type:** number

    **packets-err-icv-check**

        **Description** 

        **Type:** number

    **packets-err-inactive**

        **Description** 

        **Type:** number

    **packets-err-lifetime-lifebytes**

        **Description** 

    **packets-err-nh-check**

        **Description** 

        **Type:** number

    **packets-err-pad-check**

        **Description** 

        **Type:** number

    **packets-err-pkt-sanity**

        **Description** 

        **Type:** number

    **pkt-fail-prep-to-send**

        **Description** 

        **Type:** number

    **pkt-fail-to-send**

        **Description** 

        **Type:** number

    **prefrag-error**

        **Description** 

        **Type:** number

    **prefrag-success**

        **Description** 

        **Type:** number

    **qat-bytes-decrypted**

        **Description** 

        **Type:** number

    **qat-bytes-encrypted**

        **Description** 

        **Type:** number

    **qat-packets-decrypted**

        **Description** 

        **Type:** number

    **qat-packets-encrypted**

        **Description** 

        **Type:** number

    **rekey-num**

        **Description** 

        **Type:** number

    **sequence-num**

        **Description** 

        **Type:** number

    **sequence-num-rollover**

        **Description** 

        **Type:** number

    **tunnel-intf-down**

        **Description** 

        **Type:** number