.. _scaleout_user_group_assignment_template:

scaleout user-group-assignment-template
=======================================

Configure scaleout user group assignment templates


user-group-assignment-template Specification
--------------------------------------------

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

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

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

	 **Collection Name**                   :ref:`2785_user-group-assignment-template_list`

	 **Collection URI**                    /axapi/v3/scaleout/user-group-assignment-template

	                                       

	 **Element Name**                      user-group-assignment-template

	 **Element URI**                       /axapi/v3/scaleout/user-group-assignment-template/{name}

	 **Element Attributes**                user-group-assignment-template_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`user-group-assignment-template schema <scaleout-user-group-assignment-template/scaleout-user-group-assignment-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/user-group-assignment-template



.. raw:: html

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


:ref:`2785_user-group-assignment-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/user-group-assignment-template



.. raw:: html

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


:ref:`2785_user-group-assignment-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/user-group-assignment-template/{name}



.. raw:: html

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


:ref:`2785_user-group-assignment-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/user-group-assignment-template



.. raw:: html

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


:ref:`2785_user-group-assignment-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/user-group-assignment-template/{name}



.. raw:: html

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


:ref:`2785_user-group-assignment-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/user-group-assignment-template/{name}



.. raw:: html

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


:ref:`2785_user-group-assignment-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/user-group-assignment-template



.. raw:: html

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


:ref:`2785_user-group-assignment-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/user-group-assignment-template/{name}



.. raw:: html

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


:ref:`2785_user-group-assignment-template_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2785_user-group-assignment-template_list:

user-group-assignment-template-list
-----------------------------------


    user-group-assignment-template-list is **JSON List** of :ref:`2785_user-group-assignment-template_attributes` 

        user-group-assignment-template-list : [

             { :ref:`2785_user-group-assignment-template_attributes` },

             { :ref:`2785_user-group-assignment-template_attributes` },

             ...

         ]

.. _2785_user-group-assignment-template_attributes:

user-group-assignment-template attributes
-----------------------------------------

    **name**

        **Description** Scaleout User Group Assignment Template Name

        **Type:** string

        **Format:** string-rlx

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

    **v4-assignment-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/scaleout/user-group-assignment-template/{name}/v4-assignment/{ipv4-prefix} <scaleout_user_group_assignment_template>`

    **v6-assignment-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/scaleout/user-group-assignment-template/{name}/v6-assignment/{ipv6-prefix} <scaleout_user_group_assignment_template>`

.. _2785_v6-assignment-list:

v6-assignment-list
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **assignment-prefix-length**

        **Description** User group assignment prefix length, default is 128

        **Type:** number

        **Range:** 1-128

        **Default:** 128

    **ipv6-prefix**

        **Description** IPv6 prefix

        **Type:** string

        **Format:** ipv6-address-plen

    **service-config-template**

        **Description** Configure a scaleout service config template to use

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **user-group-range-end**

        **Description** User group range end

        **Type:** number

        **Range:** 0-255

    **user-group-range-start**

        **Description** User group range start

        **Type:** number

        **Range:** 0-255

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2785_v4-assignment-list:

v4-assignment-list
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **assignment-prefix-length**

        **Description** User group assignment prefix length, default is 32

        **Type:** number

        **Range:** 1-32

        **Default:** 32

    **ipv4-prefix**

        **Description** IPv4 prefix

        **Type:** string

        **Format:** ipv4-cidr

    **service-config-template**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **user-group-range-end**

        **Description** User group range end

        **Type:** number

        **Range:** 0-255

    **user-group-range-start**

        **Description** User group range start

        **Type:** number

        **Range:** 0-255

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters