.. _slb_hw_compress:

slb hw-compress
===============

Configure HW compression


hw-compress Specification
-------------------------

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

	 **Element Name**                      hw-compress

	 **Element URI**                       /axapi/v3/slb/hw-compress

	 **Element Attributes**                hw-compress_attributes

	 **Statistics Data URI**               /axapi/v3/slb/hw-compress/stats

	 **Operational Data URI**              /axapi/v3/slb/hw-compress/oper

	 **Schema**                             :download:`hw-compress schema <slb-hw-compress/slb-hw-compress.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/slb/hw-compress



.. raw:: html

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


:ref:`1674_hw-compress_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/slb/hw-compress



.. raw:: html

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


:ref:`1674_hw-compress_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/slb/hw-compress



.. raw:: html

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


:ref:`1674_hw-compress_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/slb/hw-compress



.. raw:: html

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


:ref:`1674_hw-compress_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/slb/hw-compress



.. raw:: html

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


:ref:`1674_hw-compress_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1674_hw-compress_attributes:

hw-compress attributes
----------------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1674_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'request_count': Total request count; 'submit_count': Total submit count; 'response_count': Total response count; 'failure_count': Total failure count; 'failure_code': Last failure code; 'ring_full_count': Compression queue full; 'max_outstanding_request_count': Max queued request count; 'max_outstanding_submit_count': Max queued submit count; 

        **Type:** string

        **Supported Values:** all, request_count, submit_count, response_count, failure_count, failure_code, ring_full_count, max_outstanding_request_count, max_outstanding_submit_count

.. _1674_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - max_outstanding_request_count
      - 2
      - Max queued request count

   *  - 
      - failure_count
      - 2
      - Total failure count

   *  - 
      - response_count
      - 2
      - Total response count

   *  - 
      - ring_full_count
      - 2
      - Compression queue full

   *  - 
      - submit_count
      - 2
      - Total submit count

   *  - 
      - request_count
      - 2
      - Total request count

   *  - 
      - max_outstanding_submit_count
      - 2
      - Max queued submit count

   *  - 
      - failure_code
      - 2
      - Last failure code

.. _1674_oper_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - l4-cpu-list
      - 
      - l4-cpu-list

   *  - 
      - cpu-count
      - number
      - cpu-count

   *  - 
      - hw-compress-disabled
      - number
      - hw-compress-disabled