.. _gslb_site:

gslb site
=========

Specify a GSLB site


site Specification
------------------

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

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

	 **Object Key(s)**                     *site-name*

	 **Collection Name**                   :ref:`1763_site_list`

	 **Collection URI**                    /axapi/v3/gslb/site

	                                       

	 **Element Name**                      site

	 **Element URI**                       /axapi/v3/gslb/site/{site-name}

	 **Element Attributes**                site_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/gslb/site/{site-name}/stats

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

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



.. raw:: html

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


:ref:`1763_site_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_site_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/site



.. raw:: html

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


:ref:`1763_site_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/site/{site-name}



.. raw:: html

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


:ref:`1763_site_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_site_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/site



.. raw:: html

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


:ref:`1763_site_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/site/{site-name}



.. raw:: html

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


:ref:`1763_site_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/site/{site-name}



.. raw:: html

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


:ref:`1763_site_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_site_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/site



.. raw:: html

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


:ref:`1763_site_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/site/{site-name}



.. raw:: html

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


:ref:`1763_site_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_site_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1763_site_list:

site-list
---------


    site-list is **JSON List** of :ref:`1763_site_attributes` 

        site-list : [

             { :ref:`1763_site_attributes` },

             { :ref:`1763_site_attributes` },

             ...

         ]

.. _1763_site_attributes:

site attributes
---------------

    **active-rdt**

        **Description:** active-rdt is a **JSON Block**.  Please see below for :ref:`1763_active-rdt` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name}/active-rdt <gslb_site>`

    **auto-map**

        **Description** Enable DNS Auto Mapping

        **Type:** boolean

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

        **Default:** 1

    **bw-cost**

        **Description** Specify cost of band-width

        **Type:** boolean

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

        **Default:** 0

    **controller**

        **Description** Specify the local controller for the GSLB site (Specify the hostname of the local controller)

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **disable**

        **Description** Disable all servers in the GSLB site

        **Type:** boolean

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

        **Default:** 0

    **easy-rdt**

        **Description:** easy-rdt is a **JSON Block**.  Please see below for :ref:`1763_easy-rdt` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name}/easy-rdt <gslb_site>`

    **ip-server-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name}/ip-server/{ip-server-name} <gslb_site>`

    **limit**

        **Description** Specify the limit for bandwidth, default is unlimited

        **Type:** number

        **Range:** 0-2147483647

    **multiple-geo-locations**

        **Type:** List

    **proto-aging-fast**

        **Description** Fast GSLB Protocol aging

        **Type:** boolean

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

        **Default:** 0

    **proto-aging-time**

        **Description** Specify GSLB Protocol aging time

        **Type:** number

        **Range:** 0-65535

        **Default:** 0

    **site-name**

        **Description** Specify GSLB site name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **slb-dev-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name}/slb-dev/{device-name} <gslb_site>`

    **template**

        **Description** Specify template to collect site information (Specify GSLB SNMP template name)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/gslb/template/snmp <gslb_template_snmp>`

    **threshold**

        **Description** Specify the threshold for limit

        **Type:** number

        **Range:** 0-100

        **Default:** 0

    **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** Specify a weight for the GSLB site (Weight, default is 1)

        **Type:** number

        **Range:** 1-100

        **Default:** 1

.. _1763_ip-server-list:

ip-server-list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ip-server-name**

        **Description** Specify the real server name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/gslb/service-ip <gslb_service_ip>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1763_slb-dev-list:

slb-dev-list
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **admin-preference**

        **Description** Specify administrative preference (Specify admin-preference value,default is 100)

        **Type:** number

        **Range:** 0-255

        **Default:** 100

    **auto-detect**

        **Description** 'ip': Service IP only; 'port': Service Port only; 'ip-and-port': Both service IP and service port; 'disabled': disable auto-detect; 

        **Type:** string

        **Supported Values:** ip, port, ip-and-port, disabled

        **Default:** ip-and-port

    **auto-map**

        **Description** Enable DNS Auto Mapping

        **Type:** boolean

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

        **Default:** 1

    **client-ip**

        **Description** Specify client IP address

        **Type:** string

        **Format:** ipv4-address

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

    **device-name**

        **Description** Specify SLB device name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **domain**

        **Description** Device hostname

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** domain, ip-address, and ipv6-address are mutually exclusive

    **gateway-ip-addr**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

    **health-check-action**

        **Description** 'health-check': Enable health Check; 'health-check-disable': Disable health check; 

        **Type:** string

        **Supported Values:** health-check, health-check-disable

        **Default:** health-check

    **ip-address**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** ip-address and domain are mutually exclusive

    **ipv6-address**

        **Description** IPv6 address

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** ipv6-address and domain are mutually exclusive

    **max-client**

        **Description** Specify maximum number of clients, default is 32768

        **Type:** number

        **Range:** 1-2147483647

        **Default:** 32768

    **msg-format-acos-2x**

        **Description** Run GSLB Protocol in compatible mode with a ACOS 2.x GSLB peer

        **Type:** boolean

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

        **Default:** 0

    **probe-timer**

        **Description** 

        **Type:** number

        **Range:** 1-255

    **proto-aging-fast**

        **Description** Fast GSLB Protocol aging

        **Type:** boolean

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

        **Default:** 1

    **proto-aging-time**

        **Description** Specify GSLB Protocol aging time, default is 60

        **Type:** number

        **Range:** 1-65535

        **Default:** 60

    **proto-compatible**

        **Description** Run GSLB Protocol in compatible mode

        **Type:** boolean

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

        **Default:** 0

    **rdt-type**

        **Description** 'rdt': rdt; 'site-rdt': site-rdt; 

        **Type:** string

        **Supported Values:** rdt, site-rdt

    **rdt-value**

        **Description** Specify Round-delay-time

        **Type:** number

        **Range:** 1-65535

    **session-number**

        **Description** 

        **Type:** number

        **Range:** 0-16777214

    **session-utilization**

        **Description** 

        **Type:** number

        **Range:** 1-100

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

    **vip-server**

        **Description:** vip-server is a **JSON Block**.  Please see below for :ref:`1763_slb-dev-list_vip-server` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/vip-server <gslb_site>`

.. _1763_slb-dev-list_vip-server:

slb-dev-list_vip-server
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **vip-server-name-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/vip-server/vip-server-name/{vip-name} <gslb_site>`

    **vip-server-v4-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/vip-server/vip-server-v4/{ipv4} <gslb_site>`

    **vip-server-v6-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/vip-server/vip-server-v6/{ipv6} <gslb_site>`

.. _1763_slb-dev-list_vip-server_vip-server-v4-list:

slb-dev-list_vip-server_vip-server-v4-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv4**

        **Description** Specify IP address

        **Type:** string

        **Format:** ipv4-address

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1763_slb-dev-list_vip-server_vip-server-v4-list_sampling-enable:

slb-dev-list_vip-server_vip-server-v4-list_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'dev_vip_hits': Number of times the service-ip was selected; 

        **Type:** string

        **Supported Values:** all, dev_vip_hits, dev_vip_recent

.. _1763_slb-dev-list_vip-server_vip-server-v6-list:

slb-dev-list_vip-server_vip-server-v6-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv6**

        **Description** Specify IP address (IPv6 address)

        **Type:** string

        **Format:** ipv6-address

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1763_slb-dev-list_vip-server_vip-server-v6-list_sampling-enable:

slb-dev-list_vip-server_vip-server-v6-list_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'dev_vip_hits': Number of times the service-ip was selected; 

        **Type:** string

        **Supported Values:** all, dev_vip_hits, dev_vip_recent

.. _1763_slb-dev-list_vip-server_vip-server-name-list:

slb-dev-list_vip-server_vip-server-name-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vip-name**

        **Description** Specify a VIP name for the SLB device

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/gslb/service-ip <gslb_service_ip>`

.. _1763_slb-dev-list_vip-server_vip-server-name-list_sampling-enable:

slb-dev-list_vip-server_vip-server-name-list_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'dev_vip_hits': Number of times the service-ip was selected; 

        **Type:** string

        **Supported Values:** all, dev_vip_hits, dev_vip_recent

.. _1763_multiple-geo-locations:

multiple-geo-locations
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **geo-location**

        **Description** Specify the geographic location of the GSLB site (Specify geo-location for this site)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

.. _1763_easy-rdt:

easy-rdt
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **aging-time**

        **Description** Aging Time, Unit: min, default is 10

        **Type:** number

        **Range:** 1-15360

        **Default:** 10

    **bind-geoloc**

        **Description** Bind RDT to geo-location

        **Type:** boolean

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

        **Default:** 0

    **ignore-count**

        **Description** Ignore count if RDT is out of range, default is 5

        **Type:** number

        **Range:** 0-15

        **Default:** 5

    **ipv6-mask**

        **Description** Client IPv6 subnet mask, default is 128

        **Type:** number

        **Range:** 1-128

        **Default:** 128

    **limit**

        **Description** Limit of valid RDT, default is 16383 (Limit, unit: millisecond)

        **Type:** number

        **Range:** 1-16383

        **Default:** 16383

    **mask**

        **Description** Client IP subnet mask, default is 32

        **Type:** string

        **Format:** ipv4-netmask-brief

        **Default:** /32

    **overlap**

        **Description** Enable overlap for geo-location to do longest match

        **Type:** boolean

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

        **Default:** 0

    **range-factor**

        **Description** Factor of RDT Range, default is 25 (Range Factor of Smooth RDT)

        **Type:** number

        **Range:** 0-1000

        **Default:** 25

    **smooth-factor**

        **Description** Factor of Smooth RDT, default is 10

        **Type:** number

        **Range:** 0-100

        **Default:** 10

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1763_active-rdt:

active-rdt
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **aging-time**

        **Description** Aging Time, Unit: min, default is 10

        **Type:** number

        **Range:** 1-15360

        **Default:** 10

    **bind-geoloc**

        **Description** Bind RDT to geo-location

        **Type:** boolean

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

        **Default:** 0

    **ignore-count**

        **Description** Ignore count if RDT is out of range, default is 5

        **Type:** number

        **Range:** 0-15

        **Default:** 5

    **ipv6-mask**

        **Description** Client IPv6 subnet mask, default is 128

        **Type:** number

        **Range:** 1-128

        **Default:** 128

    **limit**

        **Description** Limit of valid RDT, default is 16383 (Limit, unit: millisecond)

        **Type:** number

        **Range:** 1-16383

        **Default:** 16383

    **mask**

        **Description** Client IP subnet mask, default is 32

        **Type:** string

        **Format:** ipv4-netmask-brief

        **Default:** /32

    **overlap**

        **Description** Enable overlap for geo-location to do longest match

        **Type:** boolean

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

        **Default:** 0

    **range-factor**

        **Description** Factor of RDT Range, default is 25 (Range Factor of Smooth RDT)

        **Type:** number

        **Range:** 0-1000

        **Default:** 25

    **smooth-factor**

        **Description** Factor of Smooth RDT, default is 10

        **Type:** number

        **Range:** 0-100

        **Default:** 10

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters