.. _system_pbslb:

system pbslb
============

Configure Policy Based Response-Rate-Limiting


pbslb Specification
-------------------

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

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

	 **Element Name**                      pbslb

	 **Element URI**                       /axapi/v3/system/pbslb

	 **Element Attributes**                pbslb_attributes

	 **Partition Visibility**              shared

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

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



.. raw:: html

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


:ref:`3345_pbslb_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/pbslb



.. raw:: html

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


:ref:`3345_pbslb_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/pbslb



.. raw:: html

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


:ref:`3345_pbslb_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/pbslb



.. raw:: html

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


:ref:`3345_pbslb_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/pbslb



.. raw:: html

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


:ref:`3345_pbslb_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3345_pbslb_attributes:

pbslb attributes
----------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3345_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'curr_entries': Current PBSLB Entry Count; 'total_v4_entries_created': Total V4 Entry Count Created; 'total_v4_entries_freed': Total V4 Entry Count Freed; 'total_v6_entries_created': Total V6 Entry Count Created; 'total_v6_entries_freed': Total V6 Entry Count Freed; 'total_domain_entries_created': Total Domain Entry Count Created; 'total_domain_entries_freed': Total Domain Entry Count Freed; 'total_direct_action_entries_created': Total Direct Action Entry Count Created; 'total_direct_action_entries_freed': Total Direct Action Entry Count Freed; 'curr_entries_target_global': Current Entry Target Global; 'curr_entries_target_vserver': Current Entry Target Vserver; 'curr_entries_target_vport': Current Entry Target Vport; 'curr_entries_target_LOC': Current Entry Target LOC; 'curr_entries_target_rserver': Current Entry Target Rserver; 'curr_entries_target_rport': Current Entry Target Rport; 'curr_entries_target_service': Current Entry Target Service; 'curr_entries_stats': Current Entry Stats Count; 

        **Type:** string

        **Supported Values:** all, curr_entries, total_v4_entries_created, total_v4_entries_freed, total_v6_entries_created, total_v6_entries_freed, total_domain_entries_created, total_domain_entries_freed, total_direct_action_entries_created, total_direct_action_entries_freed, curr_entries_target_global, curr_entries_target_vserver, curr_entries_target_vport, curr_entries_target_LOC, curr_entries_target_rserver, curr_entries_target_rport, curr_entries_target_service, curr_entries_stats