.. _gslb_service_group:

gslb service-group
==================

Specify GSLB Service Group


service-group Specification
---------------------------

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

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

	 **Object Key(s)**                     *service-group-name*

	 **Collection Name**                   :ref:`1735_service-group_list`

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

	                                       

	 **Element Name**                      service-group

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

	 **Element Attributes**                service-group_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/gslb/service-group/{service-group-name}/oper

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



.. raw:: html

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


:ref:`1735_service-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_service_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/service-group



.. raw:: html

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


:ref:`1735_service-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/service-group/{service-group-name}



.. raw:: html

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


:ref:`1735_service-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_service_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/service-group



.. raw:: html

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


:ref:`1735_service-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/service-group/{service-group-name}



.. raw:: html

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


:ref:`1735_service-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/service-group/{service-group-name}



.. raw:: html

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


:ref:`1735_service-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_service_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/service-group



.. raw:: html

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


:ref:`1735_service-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/service-group/{service-group-name}



.. raw:: html

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


:ref:`1735_service-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_service_group_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1735_service-group_list:

service-group-list
------------------


    service-group-list is **JSON List** of :ref:`1735_service-group_attributes` 

        service-group-list : [

             { :ref:`1735_service-group_attributes` },

             { :ref:`1735_service-group_attributes` },

             ...

         ]

.. _1735_service-group_attributes:

service-group attributes
------------------------

    **dependency-site**

        **Description** Dependency on site

        **Type:** boolean

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

        **Default:** 0

    **disable**

        **Description** Disable all members

        **Type:** boolean

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

        **Default:** 0

    **disable-site-list**

        **Type:** List

    **member**

        **Type:** List

    **persistent-aging-time**

        **Description** Specify aging-time, unit: min, default is 5 (Aging time)

        **Type:** number

        **Range:** 1-65535

        **Default:** 5

    **persistent-ipv6-mask**

        **Description** Specify IPv6 mask length, default is 128

        **Type:** number

        **Range:** 1-128

        **Default:** 128

    **persistent-mask**

        **Description** Specify IP mask, default is /32

        **Type:** string

        **Format:** ipv4-netmask-brief

        **Default:** /32

    **persistent-site**

        **Description** Persistent based on site

        **Type:** boolean

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

        **Default:** 0

    **service-group-name**

        **Description** Specify Service Group 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

.. _1735_disable-site-list:

disable-site-list
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **disable-site**

        **Description** Site name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/gslb/site <gslb_site>`

.. _1735_member:

member
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **member-name**

        **Description** Service name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters