.. _gslb_site_slb_dev:

gslb site slb-dev
=================

Specify a SLB device for the GSLB site


slb-dev Specification
---------------------

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

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

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

	 **Collection Name**                   :ref:`1761_slb-dev_list`

	 **Collection URI**                    /axapi/v3/gslb/site/{site-name}/slb-dev

	                                       

	 **Element Name**                      slb-dev

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

	 **Element Attributes**                slb-dev_attributes

	 **Partition Visibility**              shared

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

	 **Schema**                             :download:`slb-dev schema <gslb-site-slb-dev/gslb-site-slb-dev.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/{site-name}/slb-dev



.. raw:: html

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


:ref:`1761_slb-dev_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/gslb/site/{site-name}/slb-dev



.. raw:: html

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


:ref:`1761_slb-dev_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}/slb-dev/{device-name}



.. raw:: html

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


:ref:`1761_slb-dev_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/gslb/site/{site-name}/slb-dev



.. raw:: html

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


:ref:`1761_slb-dev_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}/slb-dev/{device-name}



.. raw:: html

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


:ref:`1761_slb-dev_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}/slb-dev/{device-name}



.. raw:: html

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


:ref:`1761_slb-dev_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/gslb/site/{site-name}/slb-dev



.. raw:: html

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


:ref:`1761_slb-dev_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}/slb-dev/{device-name}



.. raw:: html

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


:ref:`1761_slb-dev_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1761_slb-dev_list:

slb-dev-list
------------


    slb-dev-list is **JSON List** of :ref:`1761_slb-dev_attributes` 

        slb-dev-list : [

             { :ref:`1761_slb-dev_attributes` },

             { :ref:`1761_slb-dev_attributes` },

             ...

         ]

.. _1761_slb-dev_attributes:

slb-dev attributes
------------------

    **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:`1761_vip-server` 

        **Type:** Object

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

.. _1761_vip-server:

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

.. _1761_vip-server_vip-server-v4-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

.. _1761_vip-server_vip-server-v4-list_sampling-enable:

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

.. _1761_vip-server_vip-server-v6-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

.. _1761_vip-server_vip-server-v6-list_sampling-enable:

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

.. _1761_vip-server_vip-server-name-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>`

.. _1761_vip-server_vip-server-name-list_sampling-enable:

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