.. _system_bandwidth:

system bandwidth
================

System bandwidth information


bandwidth Specification
-----------------------

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

	 **Element Name**                      bandwidth

	 **Element URI**                       /axapi/v3/system/bandwidth

	 **Element Attributes**                bandwidth_attributes

	 **Statistics Data URI**               /axapi/v3/system/bandwidth/stats

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



.. raw:: html

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


:ref:`1984_bandwidth_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/bandwidth



.. raw:: html

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


:ref:`1984_bandwidth_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/bandwidth



.. raw:: html

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


:ref:`1984_bandwidth_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/bandwidth



.. raw:: html

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


:ref:`1984_bandwidth_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/bandwidth



.. raw:: html

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


:ref:`1984_bandwidth_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1984_bandwidth_attributes:

bandwidth attributes
--------------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1984_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'input-bytes-per-sec': In Bytes per second; 'output-bytes-per-sec': Out Bytes per second; 

        **Type:** string

        **Supported Values:** all, input-bytes-per-sec, output-bytes-per-sec

.. _1984_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - input-bytes-per-sec
      - 8
      - In Bytes per second

   *  - 
      - output-bytes-per-sec
      - 8
      - Out Bytes per second