.. _system_hardware_accelerate:

system hardware-accelerate
==========================

Enable hardware acceleration


hardware-accelerate Specification
---------------------------------

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

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

	 **Element Name**                      hardware-accelerate

	 **Element URI**                       /axapi/v3/system/hardware-accelerate

	 **Element Attributes**                hardware-accelerate_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/system/hardware-accelerate/stats

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



.. raw:: html

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


:ref:`3271_hardware-accelerate_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/system/hardware-accelerate



.. raw:: html

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


:ref:`3271_hardware-accelerate_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/hardware-accelerate



.. raw:: html

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


:ref:`3271_hardware-accelerate_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/hardware-accelerate



.. raw:: html

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


:ref:`3271_hardware-accelerate_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/hardware-accelerate



.. raw:: html

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


:ref:`3271_hardware-accelerate_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3271_hardware-accelerate_attributes:

hardware-accelerate attributes
------------------------------

    **sampling-enable**

        **Type:** List

    **session-forwarding**

        **Description** Configure session-forwarding in Hardware (default:off)

        **Type:** boolean

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

        **Default:** 0

    **slb**

        **Description:** slb is a **JSON Block**.  Please see below for :ref:`3271_slb` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/system/hardware-accelerate/slb <system_hardware_accelerate_slb>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3271_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'hit-counts': Total packets hit counts; 'hit-index': HW Fwd hit index; 'ipv4-forward-counts': Total IPv4 hardware forwarded packets; 'ipv6-forward-counts': Total IPv6 hardware forwarded packets; 'hw-fwd-module-status': Hardware forwarder status flags; 'hw-fwd-prog-reqs': Hardware forward programming requests; 'hw-fwd-prog-errors': Hardware forward programming Errors; 'hw-fwd-flow-singlebit-errors': Hardware forward singlebit Errors; 'hw-fwd-flow-tag-mismatch': Hardware forward tag mismatch errors; 'hw-fwd-flow-seq-mismatch': Hardware forward sequence mismatch errors; 'hw-fwd-ageout-drop-count': Hardware forward ageout drop count; 'hw-fwd-invalidation-drop': Hardware forward invalid drop count; 'hw-fwd-flow-hit-index': Hardware forward flow hit index; 'hw-fwd-flow-reason-flags': Hardware forward flow reason flags; 'hw-fwd-flow-drop-count': Hardware forward flow drop count; 'hw-fwd-flow-error-count': Hardware forward flow error count; 'hw-fwd-flow-unalign-count': Hardware forward flow unalign count; 'hw-fwd-flow-underflow-count': Hardware forward flow underflow count; 'hw-fwd-flow-tx-full-drop': Hardware forward flow tx full drop count; 'hw-fwd-flow-qdr-full-drop': Hardware forward flow qdr full drop count; 'hw-fwd-phyport-mismatch-drop': Hardware forward phyport mismatch count; 'hw-fwd-vlanid-mismatch-drop': Hardware forward vlanid mismatch count; 'hw-fwd-vmid-drop': Hardware forward vmid mismatch count; 'hw-fwd-protocol-mismatch-drop': Hardware forward protocol mismatch count; 'hw-fwd-avail-ipv4-entry': Hardware forward available ipv4 entries count; 'hw-fwd-avail-ipv6-entry': Hardware forward available ipv6 entries count; 'hw-fwd-rate-drop-count': Hardware forward rate drop count; 'hw-fwd-normal-ageout-rcvd': Hardware forward normal ageout received count; 'hw-fwd-tcp-fin-ageout-rcvd': Hardware forward tcp FIN ageout received count; 'hw-fwd-tcp-rst-ageout-rcvd': Hardware forward tcp RST ageout received count; 'hw-fwd-lookup-fail-rcvd': Hardware forward entry lookup fail count; 'hw-fwd-stats-update-rcvd': Hardware forward entry stats update count; 

        **Type:** string

        **Supported Values:** all, hit-counts, hit-index, ipv4-forward-counts, ipv6-forward-counts, hw-fwd-module-status, hw-fwd-prog-reqs, hw-fwd-prog-errors, hw-fwd-flow-singlebit-errors, hw-fwd-flow-tag-mismatch, hw-fwd-flow-seq-mismatch, hw-fwd-ageout-drop-count, hw-fwd-invalidation-drop, hw-fwd-flow-hit-index, hw-fwd-flow-reason-flags, hw-fwd-flow-drop-count, hw-fwd-flow-error-count, hw-fwd-flow-unalign-count, hw-fwd-flow-underflow-count, hw-fwd-flow-tx-full-drop, hw-fwd-flow-qdr-full-drop, hw-fwd-phyport-mismatch-drop, hw-fwd-vlanid-mismatch-drop, hw-fwd-vmid-drop, hw-fwd-protocol-mismatch-drop, hw-fwd-avail-ipv4-entry, hw-fwd-avail-ipv6-entry, hw-fwd-rate-drop-count, hw-fwd-normal-ageout-rcvd, hw-fwd-tcp-fin-ageout-rcvd, hw-fwd-tcp-rst-ageout-rcvd, hw-fwd-lookup-fail-rcvd, hw-fwd-stats-update-rcvd, hw-fwd-flow-sflow-count

.. _3271_slb:

slb
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3271_slb_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'entry-create': Hardware Entries Created; 'entry-create-failure': Hardware Entries Created; 'entry-create-fail-server-down': Hardware Entries Created; 'entry-create-fail-max-entry': Hardware Entries Created; 'entry-free': Hardware Entries Freed; 'entry-free-opp-entry': Hardware Entries Free due to opposite tuple entry ageout event; 'entry-free-no-hw-prog': Hardware Entry Free no hw prog; 'entry-free-no-conn': Hardware Entry Free no matched conn; 'entry-free-no-sw-entry': Hardware Entry Free no software entry; 'entry-counter': Hardware Entry Count; 'entry-age-out': Hardware Entries Aged Out; 'entry-age-out-idle': Hardware Entries Aged Out Idle; 'entry-age-out-tcp-fin': Hardware Entries Aged Out TCP FIN; 'entry-age-out-tcp-rst': Hardware Entries Aged Out TCP RST; 'entry-age-out-invalid-dst': Hardware Entries Aged Out invalid dst; 'entry-force-hw-invalidate': Hardware Entries Force HW Invalidate; 'entry-invalidate-server-down': Hardware Entries Invalidate due to server down; 'tcam-create': TCAM Entries Created; 'tcam-free': TCAM Entries Freed; 'tcam-counter': TCAM Entry Count; 

        **Type:** string

        **Supported Values:** all, entry-create, entry-create-failure, entry-create-fail-server-down, entry-create-fail-max-entry, entry-free, entry-free-opp-entry, entry-free-no-hw-prog, entry-free-no-conn, entry-free-no-sw-entry, entry-counter, entry-age-out, entry-age-out-idle, entry-age-out-tcp-fin, entry-age-out-tcp-rst, entry-age-out-invalid-dst, entry-force-hw-invalidate, entry-invalidate-server-down, tcam-create, tcam-free, tcam-counter