.. _gslb_group:

gslb group
==========

GSLB Group


group Specification
-------------------

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

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

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

	 **Collection Name**                   :ref:`1714_group_list`

	 **Collection URI**                    /axapi/v3/gslb/group

	                                       

	 **Element Name**                      group

	 **Element URI**                       /axapi/v3/gslb/group/{name}

	 **Element Attributes**                group_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1714_group_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/gslb_group_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/gslb/group



.. raw:: html

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


:ref:`1714_group_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/gslb/group/{name}



.. raw:: html

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


:ref:`1714_group_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/gslb_group_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/gslb/group



.. raw:: html

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


:ref:`1714_group_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/gslb/group/{name}



.. raw:: html

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


:ref:`1714_group_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/gslb/group/{name}



.. raw:: html

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


:ref:`1714_group_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/gslb_group_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/gslb/group



.. raw:: html

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


:ref:`1714_group_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/gslb/group/{name}



.. raw:: html

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


:ref:`1714_group_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/gslb_group_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1714_group_list:

group-list
----------


    group-list is **JSON List** of :ref:`1714_group_attributes` 

        group-list : [

             { :ref:`1714_group_attributes` },

             { :ref:`1714_group_attributes` },

             ...

         ]

.. _1714_group_attributes:

group attributes
----------------

    **auto-map-learn**

        **Description** IP Address learned from other controller

        **Type:** boolean

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

        **Default:** 1

    **auto-map-primary**

        **Description** Primary Controller's IP address

        **Type:** boolean

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

        **Default:** 1

    **auto-map-smart**

        **Description** Choose Best IP address

        **Type:** boolean

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

        **Default:** 1

    **config-anywhere**

        **Description** Every member can do config

        **Type:** boolean

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

        **Default:** 0

    **config-merge**

        **Description** Merge old master's config when new one take over

        **Type:** boolean

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

        **Default:** 0

    **config-save**

        **Description** Accept config-save message from master

        **Type:** boolean

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

        **Default:** 1

    **data-interface**

        **Description** Data Interface IP Address

        **Type:** boolean

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

        **Default:** 1

    **dns-discover**

        **Description** Discover member via DNS Protocol

        **Type:** boolean

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

        **Default:** 1

    **enable**

        **Description** Join GSLB Group

        **Type:** boolean

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

        **Default:** 0

    **learn**

        **Description** Learn neighbour information from other controllers

        **Type:** boolean

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

        **Default:** 1

    **mgmt-interface**

        **Description** Management Interface IP Address

        **Type:** boolean

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

        **Default:** 1

    **name**

        **Description** Specify Group domain name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Default:** default

    **primary-ipv6-list**

        **Type:** List

    **primary-list**

        **Type:** List

    **priority**

        **Description** Specify Local Priority, default is 100

        **Type:** number

        **Range:** 1-255

        **Default:** 100

    **resolve-as**

        **Description** 'resolve-to-ipv4': Use A Query only to resolve FQDN (Default Query type); 'resolve-to-ipv6': Use AAAA Query only to resolve FQDN; 'resolve-to-ipv4-and-ipv6': Use A as well as AAAA Query to resolve FQDN; 

        **Type:** string

        **Supported Values:** resolve-to-ipv4, resolve-to-ipv6, resolve-to-ipv4-and-ipv6

        **Default:** resolve-to-ipv4

    **standalone**

        **Description** Run GSLB Group in standalone mode

        **Type:** boolean

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

        **Default:** 0

    **suffix**

        **Description** Set DNS Suffix (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

.. _1714_primary-ipv6-list:

primary-ipv6-list
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **primary-ipv6**

        **Description** Specify Primary controller's IP address

        **Type:** string

        **Format:** ipv6-address

.. _1714_primary-list:

primary-list
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **primary**

        **Description** Specify Primary controller's IP address

        **Type:** string

        **Format:** ipv4-address