.. _system_throughput:

system throughput
=================

System throughput


throughput Specification
------------------------

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

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

	 **Element Name**                      throughput

	 **Element URI**                       /axapi/v3/system/throughput

	 **Element Attributes**                throughput_attributes

	 **Partition Visibility**              shared

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

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



.. raw:: html

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


:ref:`3601_throughput_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0% 10% 0% 5%;' valign='top'><div id='post_div' style='display:none'>


.. include:: ..\D:\axAPI\VMShared\aXAPI_608\artifacts\system_throughput_POST.txt
   :literal:




.. raw:: html

   </div></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/throughput



.. raw:: html

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


:ref:`3601_throughput_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0% 10% 0% 5%;' valign='top'><div id='get_div' style='display:none'>


.. include:: ..\artifacts\system_throughput_GET.txt
   :literal:




.. raw:: html

   </div></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/throughput



.. raw:: html

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


:ref:`3601_throughput_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/throughput



.. raw:: html

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


:ref:`3601_throughput_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0% 10% 0% 5%;' valign='top'><div id='put_div' style='display:none'>


.. include:: ..\artifacts\system_throughput_PUT.txt
   :literal:




.. raw:: html

   </div></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/throughput



.. raw:: html

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


:ref:`3601_throughput_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0% 10% 0% 5%;' valign='top'><div id='delete_div' style='display:none'>


.. include:: ..\artifacts\system_throughput_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3601_throughput_attributes:

throughput attributes
---------------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3601_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'global-system-throughput-bits-per-sec': Global System egress throughput in bits/sec; 'global-system-ingress-throughput-bits-per-sec': Global System ingress throughput in bits/sec; 'per-part-throughput-bits-per-sec': Partition throughput in bits/sec; 'global-client-ssl-count': global ssl count; 'global-server-ssl-count': global server ssl count; 'global-client-ssl-connections-per-sec': global ssl conneciton per sec; 'global-server-ssl-connections-per-sec': global server ssl conneciton; 

        **Type:** string

        **Supported Values:** all, global-system-throughput-bits-per-sec, global-system-ingress-throughput-bits-per-sec, per-part-throughput-bits-per-sec, global-client-ssl-count, global-server-ssl-count, global-client-ssl-connections-per-sec, global-server-ssl-connections-per-sec