.. _vpn_ipsec_sa:

vpn ipsec-sa
============

Get IPsec SAs


ipsec-sa Specification
----------------------

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

	 **Element Name**                      ipsec-sa

	 **Element URI**                       /axapi/v3/vpn/ipsec-sa

	 **Element Attributes**                ipsec-sa_attributes

	 **Statistics Data URI**               /axapi/v3/vpn/ipsec-sa/stats

	 **Operational Data URI**              /axapi/v3/vpn/ipsec-sa/oper

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



.. raw:: html

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


:ref:`2658_ipsec-sa_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-sa



.. raw:: html

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


:ref:`2658_ipsec-sa_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/vpn/ipsec-sa



.. raw:: html

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


:ref:`2658_ipsec-sa_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-sa



.. raw:: html

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


:ref:`2658_ipsec-sa_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/vpn/ipsec-sa



.. raw:: html

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


:ref:`2658_ipsec-sa_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2658_ipsec-sa_attributes:

ipsec-sa attributes
-------------------

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2658_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - sequence-num-rollover
      - 8
      - Sequence Number Rollover

   *  - 
      - anti-replay-num
      - 8
      - Anti-Replay Failure

   *  - 
      - qat-packets-decrypted
      - 8
      - QAT Decrypted Packets

   *  - 
      - packets-decrypted
      - 8
      - Decrypted Packets

   *  - 
      - tunnel-intf-down
      - 8
      - Packet dropped: Tunnel Interface Down

   *  - 
      - pkt-fail-to-send
      - 8
      - Packet dropped: Failed to send

   *  - 
      - packets-encrypted
      - 8
      - Encrypted Packets

   *  - 
      - bytes-encrypted
      - 8
      - Encrypted Bytes

   *  - 
      - packets-err-nh-check
      - 4
      - Next Header Check Error

   *  - 
      - no-tunnel-found
      - 8
      - Packet dropped: No tunnel found

   *  - 
      - prefrag-success
      - 8
      - Pre-frag Success

   *  - 
      - qat-bytes-decrypted
      - 8
      - QAT Decrypted Bytes

   *  - 
      - prefrag-error
      - 8
      - Pre-frag Error

   *  - 
      - qat-packets-encrypted
      - 8
      - QAT Encrypted Packets

   *  - 
      - bytes-decrypted
      - 8
      - Decrypted Bytes

   *  - 
      - invalid-tunnel-id
      - 8
      - Packet dropped: Invalid tunnel ID

   *  - 
      - pkt-fail-prep-to-send
      - 8
      - Packet dropped: Failed in prepare to send

   *  - 
      - cavium-packets-encrypted
      - 8
      - CAVIUM Encrypted Packets

   *  - 
      - packets-err-icv-check
      - 4
      - ICV Check Error

   *  - 
      - packets-err-inactive
      - 4
      - Inactive Error

   *  - 
      - cavium-bytes-decrypted
      - 8
      - CAVIUM Decrypted Bytes

   *  - 
      - packets-err-pad-check
      - 4
      - Pad Check Error

   *  - 
      - packets-err-pkt-sanity
      - 4
      - Packets Sanity Error

   *  - 
      - cavium-bytes-encrypted
      - 8
      - CAVIUM Encrypted Bytes

   *  - 
      - sequence-num
      - 8
      - Sequence Number

   *  - 
      - packets-err-lifetime-lifebytes
      - 8
      - Lifetime Lifebytes Error

   *  - 
      - packets-err-encryption
      - 4
      - Encryption Error

   *  - 
      - rekey-num
      - 8
      - Rekey Times

   *  - 
      - cavium-packets-decrypted
      - 8
      - CAVIUM Decrypted Packets

   *  - 
      - frag-after-encap-frag-packets
      - 8
      - Frag-after-encap Fragment Generated

   *  - 
      - qat-bytes-encrypted
      - 8
      - QAT Encrypted Bytes

   *  - 
      - no-next-hop
      - 8
      - Packet dropped: No next hop

   *  - 
      - frag-received
      - 8
      - Fragment Received

.. _2658_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - ipsec-sa-list
      - 
      - ipsec-sa-list