.. _gslb_protocol:

gslb protocol
=============

Specify GSLB Message Protocol parameters


protocol Specification
----------------------

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

	===================================== ======================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      protocol

	 **Element URI**                       /axapi/v3/gslb/protocol

	 **Element Attributes**                protocol_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/gslb/protocol/oper

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



.. raw:: html

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


:ref:`1693_protocol_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_protocol_POST.txt
   :literal:




.. raw:: html

   </div></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/protocol



.. raw:: html

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


:ref:`1693_protocol_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_protocol_GET.txt
   :literal:




.. raw:: html

   </div></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/protocol



.. raw:: html

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


:ref:`1693_protocol_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/protocol



.. raw:: html

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


:ref:`1693_protocol_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_protocol_PUT.txt
   :literal:




.. raw:: html

   </div></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/protocol



.. raw:: html

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


:ref:`1693_protocol_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_protocol_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1693_protocol_attributes:

protocol attributes
-------------------

    **auto-detect**

        **Description** Automatically detect SLB Config

        **Type:** boolean

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

        **Default:** 0

    **disable-new-gslb-sync**

        **Description** Disable new gslb config sync

        **Type:** boolean

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

        **Default:** 0

    **enable-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/gslb/protocol/enable/{type} <gslb_protocol_enable>`

    **limit**

        **Description:** limit is a **JSON Block**.  Please see below for :ref:`1693_limit` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/gslb/protocol/limit <gslb_protocol_limit>`

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

    **ping-site**

        **Description** name of site or ip address to ping

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **secure**

        **Description:** secure is a **JSON Block**.  Please see below for :ref:`1693_secure` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/gslb/protocol/secure <gslb_protocol_secure>`

    **status-interval**

        **Description** Specify GSLB Message Protocol update period (The GSLB Protocol update interval (seconds), default is 30)

        **Type:** number

        **Range:** 1-1800

    **use-mgmt-port**

        **Description** Use management port for connections in Shared Partition

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** use-mgmt-port and use-mgmt-port-for-all-partitions are mutually exclusive

    **use-mgmt-port-for-all-partitions**

        **Description** Use management port for connections in all L3v Partitions

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** use-mgmt-port-for-all-partitions and use-mgmt-port are mutually exclusive

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1693_secure:

secure
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **action**

        **Description** 'enable': Enable Secure; 'disable': Disable Secure (default); 'enable-fallback': Fall back to non-secure if fail; 

        **Type:** string

        **Supported Values:** enable, disable, enable-fallback

        **Default:** disable

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1693_limit:

limit
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ardt-query**

        **Description** Query Messages of Active RDT, default is 200 (Number)

        **Type:** number

        **Range:** 0-1000000

        **Default:** 200

    **ardt-response**

        **Description** Response Messages of Active RDT, default is 1000 (Number)

        **Type:** number

        **Range:** 0-1000000

        **Default:** 1000

    **ardt-session**

        **Description** Sessions of Active RDT, default is 32768 (Number)

        **Type:** number

        **Range:** 0-1000000

        **Default:** 32768

    **conn-response**

        **Description** Response Messages of Connection Load, default is no limit (Number)

        **Type:** number

        **Range:** 0-1000000

        **Default:** 0

    **message**

        **Description** Amount of Messages, default is 10000 (Number)

        **Type:** number

        **Range:** 0-1000000

        **Default:** 10000

    **response**

        **Description** Amount of Response Messages, default is 3600 (Number)

        **Type:** number

        **Range:** 0-1000000

        **Default:** 3600

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1693_enable-list:

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

	 **Block object keys**             

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

    **type**

        **Description** 'controller': Enable/Disable GSLB protocol as GSLB controller; 'device': Enable/Disable GSLB protocol as site device; 

        **Type:** string

        **Supported Values:** controller, device

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters