.. _system_cpu_load_sharing:

system cpu-load-sharing
=======================

Redistribute packets uniformly to all CPUs during overload situations


cpu-load-sharing Specification
------------------------------

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

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

	 **Element Name**                      cpu-load-sharing

	 **Element URI**                       /axapi/v3/system/cpu-load-sharing

	 **Element Attributes**                cpu-load-sharing_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3216_cpu-load-sharing_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         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/system_cpu_load_sharing_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/cpu-load-sharing



.. raw:: html

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


:ref:`3216_cpu-load-sharing_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         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/system_cpu_load_sharing_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/cpu-load-sharing



.. raw:: html

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


:ref:`3216_cpu-load-sharing_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/cpu-load-sharing



.. raw:: html

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


:ref:`3216_cpu-load-sharing_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         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/system_cpu_load_sharing_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/cpu-load-sharing



.. raw:: html

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


:ref:`3216_cpu-load-sharing_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         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/system_cpu_load_sharing_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3216_cpu-load-sharing_attributes:

cpu-load-sharing attributes
---------------------------

    **cpu-usage**

        **Description:** cpu-usage is a **JSON Block**.  Please see below for :ref:`3216_cpu-usage` 

        **Type:** Object

    **disable**

        **Description** Disable CPU load sharing in overload situations

        **Type:** boolean

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

        **Default:** 0

    **others**

        **Description** Disallow redistribution of new non TCP/UDP IP sessions

        **Type:** boolean

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

        **Default:** 0

    **packets-per-second**

        **Description:** packets-per-second is a **JSON Block**.  Please see below for :ref:`3216_packets-per-second` 

        **Type:** Object

    **tcp**

        **Description** Disallow redistribution of new TCP sessions

        **Type:** boolean

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

        **Default:** 0

    **udp**

        **Description** Disallow redistribution of new UDP sessions

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3216_cpu-usage:

cpu-usage
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **high**

        **Description** CPU usage threshold (percentage) that will trigger the redistribution (default: 75)

        **Type:** number

        **Range:** 0-100

        **Default:** 75

    **low**

        **Description** CPU usage threshold (percentage) that will restore the normal packet distribution (default: 60)

        **Type:** number

        **Range:** 0-100

        **Default:** 60

.. _3216_packets-per-second:

packets-per-second
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **min**

        **Description** Minimum packets-per-second threshold (per CPU) before redistribution will take effect (Minimum packets-per-second threshold (per CPU) before redistribution will take effect (default: 100000))

        **Type:** number

        **Range:** 0-30000000

        **Default:** 100000