.. _system_hardware_forward:

system hardware-forward
=======================




hardware-forward Specification
------------------------------

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

	 **Element Name**                      hardware-forward

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

	 **Element Attributes**                hardware-forward_attributes

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

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



.. raw:: html

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


:ref:`2040_hardware-forward_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-forward



.. raw:: html

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


:ref:`2040_hardware-forward_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-forward



.. raw:: html

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


:ref:`2040_hardware-forward_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-forward



.. raw:: html

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


:ref:`2040_hardware-forward_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-forward



.. raw:: html

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


:ref:`2040_hardware-forward_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2040_hardware-forward_attributes:

hardware-forward attributes
---------------------------

    **sampling-enable**

        **Type:** List

    **slb**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/system/hardware-forward/slb <system_hardware_forward_slb>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2040_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'hit-counts': Total packts 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; 

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

.. _2040_slb:

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

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

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2040_slb_sampling-enable:

slb_sampling-enable
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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

.. _2040_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - hw-fwd-flow-unalign-count
      - 8
      - hardware forward flow unalign count

   *  - 
      - hw-fwd-flow-error-count
      - 8
      - hardware forward flow error count

   *  - 
      - hw-fwd-invalidation-drop
      - 8
      - hardware forward invalid drop count

   *  - 
      - hw-fwd-protocol-mismatch-drop
      - 8
      - hardware forward protocol mismatch count

   *  - 
      - hw-fwd-flow-seq-mismatch
      - 8
      - hardware forward sequence mismatch errors

   *  - 
      - hw-fwd-flow-drop-count
      - 8
      - hardware forward flow drop count

   *  - 
      - ipv4-forward-counts
      - 8
      - Total IPv4 hardware forwarded packets

   *  - 
      - hw-fwd-phyport-mismatch-drop
      - 8
      - hardware forward phyport mismatch count

   *  - 
      - hw-fwd-vmid-drop
      - 8
      - hardware forward vmid mismatch count

   *  - 
      - ipv6-forward-counts
      - 8
      - Total IPv6 hardware forwarded packets

   *  - 
      - hw-fwd-flow-hit-index
      - 8
      - hardware forward flow hit index

   *  - 
      - hw-fwd-flow-tag-mismatch
      - 8
      - hardware forward tag mismatch errors

   *  - 
      - hw-fwd-flow-qdr-full-drop
      - 8
      - hardware forward flow qdr full drop count

   *  - 
      - hw-fwd-flow-tx-full-drop
      - 8
      - hardware forward flow tx full drop count

   *  - 
      - hw-fwd-vlanid-mismatch-drop
      - 8
      - hardware forward vlanid mismatch count

   *  - 
      - hw-fwd-avail-ipv4-entry
      - 8
      - hardware forward available ipv4 entries count

   *  - 
      - hw-fwd-ageout-drop-count
      - 8
      - hardware forward ageout drop count

   *  - 
      - hw-fwd-flow-singlebit-errors
      - 8
      - hardware forward singlebit Errors

   *  - 
      - hw-fwd-prog-errors
      - 8
      - hardware forward programming Errors

   *  - 
      - hit-index
      - 8
      - HW Fwd hit index

   *  - 
      - hw-fwd-prog-reqs
      - 8
      - hardware forward programming requests

   *  - 
      - hw-fwd-avail-ipv6-entry
      - 8
      - hardware forward available ipv6 entries count

   *  - 
      - hw-fwd-flow-reason-flags
      - 8
      - hardware forward flow reason flags

   *  - 
      - hw-fwd-flow-underflow-count
      - 8
      - hardware forward flow underflow count

   *  - 
      - hw-fwd-module-status
      - 8
      - hardware forwarder status flags

   *  - 
      - hit-counts
      - 8
      - Total packts hit counts