.. _scaleout_cluster_service_config_template:

scaleout cluster service-config template
========================================

Scaleout template


template Specification
----------------------

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

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

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

	 **Collection Name**                   :ref:`1840_template_list`

	 **Collection URI**                    /axapi/v3/scaleout/cluster/{cluster-id}/service-config/template

	                                       

	 **Element Name**                      template

	 **Element URI**                       /axapi/v3/scaleout/cluster/{cluster-id}/service-config/template/{name}

	 **Element Attributes**                template_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`template schema <scaleout-cluster-service-config-template/scaleout-cluster-service-config-template.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/scaleout/cluster/{cluster-id}/service-config/template



.. raw:: html

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


:ref:`1840_template_attributes`



.. raw:: html

   </td><td></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/scaleout/cluster/{cluster-id}/service-config/template



.. raw:: html

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


:ref:`1840_template_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/scaleout/cluster/{cluster-id}/service-config/template/{name}



.. raw:: html

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


:ref:`1840_template_attributes`



.. raw:: html

   </td><td></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/scaleout/cluster/{cluster-id}/service-config/template



.. raw:: html

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


:ref:`1840_template_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/scaleout/cluster/{cluster-id}/service-config/template/{name}



.. raw:: html

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


:ref:`1840_template_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/scaleout/cluster/{cluster-id}/service-config/template/{name}



.. raw:: html

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


:ref:`1840_template_attributes`



.. raw:: html

   </td><td></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/scaleout/cluster/{cluster-id}/service-config/template



.. raw:: html

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


:ref:`1840_template_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/scaleout/cluster/{cluster-id}/service-config/template/{name}



.. raw:: html

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


:ref:`1840_template_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1840_template_list:

template-list
-------------


    template-list is **JSON List** of :ref:`1840_template_attributes` 

        template-list : [

             { :ref:`1840_template_attributes` },

             { :ref:`1840_template_attributes` },

             ...

         ]

.. _1840_template_attributes:

template attributes
-------------------

    **bucket-count**

        **Description** Number of traffic buckets

        **Type:** number

        **Range:** 1-256

        **Default:** 256

    **device-group**

        **Description** Device group id

        **Type:** number

        **Range:** 1-16

    **name**

        **Description** Scaleout template Name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **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