.. _slb_template_server:

slb template server
===================

Server template


server Specification
--------------------

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

	===================================== ===================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`3045_server_list`

	 **Collection URI**                    /axapi/v3/slb/template/server

	                                       

	 **Element Name**                      server

	 **Element URI**                       /axapi/v3/slb/template/server/{name}

	 **Element Attributes**                server_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3045_server_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/slb_template_server_POST.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/slb/template/server



.. raw:: html

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


:ref:`3045_server_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/template/server/{name}



.. raw:: html

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


:ref:`3045_server_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/slb_template_server_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/slb/template/server



.. raw:: html

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


:ref:`3045_server_list`



.. 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/template/server/{name}



.. raw:: html

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


:ref:`3045_server_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/template/server/{name}



.. raw:: html

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


:ref:`3045_server_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/slb_template_server_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/slb/template/server



.. raw:: html

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


:ref:`3045_server_list`



.. 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/template/server/{name}



.. raw:: html

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


:ref:`3045_server_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/slb_template_server_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3045_server_list:

server-list
-----------


    server-list is **JSON List** of :ref:`3045_server_attributes` 

        server-list : [

             { :ref:`3045_server_attributes` },

             { :ref:`3045_server_attributes` },

             ...

         ]

.. _3045_server_attributes:

server attributes
-----------------

    **add**

        **Description** Slow start connection limit add by a number every interval (Add by this number every interval)

        **Type:** number

        **Range:** 1-4095

        **Mutual Exclusion:** add and times are mutually exclusive

    **bw-rate-limit**

        **Description** Configure bandwidth rate limit on real server (Bandwidth rate limit in Kbps)

        **Type:** number

        **Range:** 1-16777216

    **bw-rate-limit-acct**

        **Description** 'to-server-only': Only account for traffic sent to server; 'from-server-only': Only account for traffic received from server; 'all': Account for all traffic sent to and received from server; 

        **Type:** string

        **Supported Values:** to-server-only, from-server-only, all

        **Default:** all

    **bw-rate-limit-duration**

        **Description** Duration in seconds the observed rate needs to honor

        **Type:** number

        **Range:** 1-250

    **bw-rate-limit-no-logging**

        **Description** Do not log bandwidth rate limit related state transitions

        **Type:** boolean

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

        **Default:** 0

    **bw-rate-limit-resume**

        **Description** Resume server selection after bandwidth drops below this threshold (in Kbps) (Bandwidth rate limit resume threshold (in Kbps))

        **Type:** number

        **Range:** 1-16777216

    **conn-limit**

        **Description** Connection limit

        **Type:** number

        **Range:** 1-64000000

        **Default:** 64000000

    **conn-limit-no-logging**

        **Description** Do not log connection over limit event

        **Type:** boolean

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

        **Default:** 0

    **conn-rate-limit**

        **Description** Connection rate limit

        **Type:** number

        **Range:** 1-1048575

    **conn-rate-limit-no-logging**

        **Description** Do not log connection over limit event

        **Type:** boolean

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

        **Default:** 0

    **dns-fail-interval**

        **Description** The interval to retry when DNS failed to query (DNS failure interval (in second, default is 30))

        **Type:** number

        **Range:** 0-1800

        **Default:** 30

    **dns-query-interval**

        **Description** The interval to query DNS server for the hostname (DNS query interval (in minute, default is 10))

        **Type:** number

        **Range:** 1-1440

        **Default:** 10

    **dynamic-server-prefix**

        **Description** Prefix of dynamic server (Prefix of dynamic server (default is "DRS"))

        **Type:** string

        **Maximum Length:** 3 characters

        **Maximum Length:** 1 characters

        **Default:** DRS

    **every**

        **Description** Slow start connection limit increment interval (default 10)

        **Type:** number

        **Range:** 1-60

        **Default:** 10

    **extended-stats**

        **Description** Enable extended statistics on real server

        **Type:** boolean

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

        **Default:** 0

    **health-check**

        **Description** Health Check Monitor (Health monitor name)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** health-check and health-check-disable are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/health/monitor <health_monitor>`

    **health-check-disable**

        **Description** Disable configured health check configuration

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** health-check-disable and health-check are mutually exclusive

    **initial-slow-start**

        **Description** Initial slow start connection limit (default 128)

        **Type:** number

        **Range:** 1-4095

        **Default:** 128

    **log-selection-failure**

        **Description** Enable real-time logging for server selection failure event

        **Type:** boolean

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

        **Default:** 0

    **max-dynamic-server**

        **Description** Maximum dynamic server number (Maximum dynamic server number (default is 255))

        **Type:** number

        **Range:** 1-1023

        **Default:** 255

    **min-ttl-ratio**

        **Description** Minimum TTL to DNS query interval ratio (Minimum TTL ratio (default is 2))

        **Type:** number

        **Range:** 1-15

        **Default:** 2

    **name**

        **Description** Server template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Default:** default

    **rate-interval**

        **Description** '100ms': Use 100 ms as sampling interval; 'second': Use 1 second as sampling interval; 

        **Type:** string

        **Supported Values:** 100ms, second

        **Default:** second

    **resume**

        **Description** Resume accepting new connection after connection number drops below threshold (Connection resume threshold)

        **Type:** number

        **Range:** 1-1048575

    **slow-start**

        **Description** Slowly ramp up the connection number after server is up

        **Type:** boolean

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

        **Default:** 0

    **spoofing-cache**

        **Description** Servers under the template are spoofing cache

        **Type:** boolean

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

        **Default:** 0

    **stats-data-action**

        **Description** 'stats-data-enable': Enable statistical data collection for real server; 'stats-data-disable': Disable statistical data collection for real server; 

        **Type:** string

        **Supported Values:** stats-data-enable, stats-data-disable

        **Default:** stats-data-enable

    **till**

        **Description** Slow start ends when slow start connection limit reaches a number (default 4096) (Slow start ends when connection limit reaches this number)

        **Type:** number

        **Range:** 1-65535

        **Default:** 4096

    **times**

        **Description** Slow start connection limit multiply by a number every interval (default 2) (Multiply by this number every interval)

        **Type:** number

        **Range:** 2-10

        **Default:** 2

        **Mutual Exclusion:** times and add are mutually exclusive

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **weight**

        **Description** Weight for the Real Servers (Connection Weight (default is 1))

        **Type:** number

        **Range:** 1-1000

        **Default:** 1