.. _vpn_ipsec_sa_stats:

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

IPsec sa statistics


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

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

	 **Object Key(s)**                     *sampling-enable*

	 **Collection Name**                   :ref:`2657_ipsec-sa-stats_list`

	 **Collection URI**                    /axapi/v3/vpn/ipsec-sa-stats

	                                       

	 **Element Name**                      ipsec-sa-stats

	 **Element URI**                       /axapi/v3/vpn/ipsec-sa-stats/{sampling-enable}

	 **Element Attributes**                ipsec-sa-stats_attributes

	 **Statistics Data URI**               /axapi/v3/vpn/ipsec-sa-stats/{sampling-enable}/stats

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



.. raw:: html

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


:ref:`2657_ipsec-sa-stats_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-sa-stats



.. raw:: html

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


:ref:`2657_ipsec-sa-stats_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-stats/{sampling-enable}



.. raw:: html

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


:ref:`2657_ipsec-sa-stats_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-sa-stats



.. raw:: html

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


:ref:`2657_ipsec-sa-stats_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-sa-stats/{sampling-enable}



.. raw:: html

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


:ref:`2657_ipsec-sa-stats_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-stats/{sampling-enable}



.. raw:: html

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


:ref:`2657_ipsec-sa-stats_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2657_ipsec-sa-stats_list:

ipsec-sa-stats-list
-------------------


    ipsec-sa-stats-list is **JSON List** of :ref:`2657_ipsec-sa-stats_attributes` 

        ipsec-sa-stats-list : [

             { :ref:`2657_ipsec-sa-stats_attributes` },

             { :ref:`2657_ipsec-sa-stats_attributes` },

             ...

         ]

.. _2657_ipsec-sa-stats_attributes:

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

    **sampling-enable**

        **Type:** List

.. _2657_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'packets-encrypted': Encrypted Packets; 'packets-decrypted': Decrypted Packets; 'anti-replay-num': Anti-Replay Failure; 'rekey-num': Rekey Times; 'packets-err-inactive': Inactive Error; 'packets-err-encryption': Encryption Error; 'packets-err-pad-check': Pad Check Error; 'packets-err-pkt-sanity': Packets Sanity Error; 'packets-err-icv-check': ICV Check Error; 'packets-err-lifetime-lifebytes': Lifetime Lifebytes Error; 'bytes-encrypted': Encrypted Bytes; 'bytes-decrypted': Decrypted Bytes; 'prefrag-success': Pre-frag Success; 'prefrag-error': Pre-frag Error; 'cavium-bytes-encrypted': CAVIUM Encrypted Bytes; 'cavium-bytes-decrypted': CAVIUM Decrypted Bytes; 'cavium-packets-encrypted': CAVIUM Encrypted Packets; 'cavium-packets-decrypted': CAVIUM Decrypted Packets; 'qat-bytes-encrypted': QAT Encrypted Bytes; 'qat-bytes-decrypted': QAT Decrypted Bytes; 'qat-packets-encrypted': QAT Encrypted Packets; 'qat-packets-decrypted': QAT Decrypted Packets; 'tunnel-intf-down': Packet dropped: Tunnel Interface Down; 'pkt-fail-prep-to-send': Packet dropped: Failed in prepare to send; 'no-next-hop': Packet dropped: No next hop; 'invalid-tunnel-id': Packet dropped: Invalid tunnel ID; 'no-tunnel-found': Packet dropped: No tunnel found; 'pkt-fail-to-send': Packet dropped: Failed to send; 'frag-after-encap-frag-packets': Frag-after-encap Fragment Generated; 'frag-received': Fragment Received; 'sequence-num': Sequence Number; 'sequence-num-rollover': Sequence Number Rollover; 'packets-err-nh-check': Next Header Check Error; 

        **Type:** string

        **Supported Values:** all, packets-encrypted, packets-decrypted, anti-replay-num, rekey-num, packets-err-inactive, packets-err-encryption, packets-err-pad-check, packets-err-pkt-sanity, packets-err-icv-check, packets-err-lifetime-lifebytes, bytes-encrypted, bytes-decrypted, prefrag-success, prefrag-error, cavium-bytes-encrypted, cavium-bytes-decrypted, cavium-packets-encrypted, cavium-packets-decrypted, qat-bytes-encrypted, qat-bytes-decrypted, qat-packets-encrypted, qat-packets-decrypted, tunnel-intf-down, pkt-fail-prep-to-send, no-next-hop, invalid-tunnel-id, no-tunnel-found, pkt-fail-to-send, frag-after-encap-frag-packets, frag-received, sequence-num, sequence-num-rollover, packets-err-nh-check

.. _2657_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