.. _debug_gslb:

debug gslb
==========

Debug GSLB


gslb Specification
------------------

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

	===================================== ===================================================
	 **Type**                              *operational*

	 **Element Name**                      gslb

	 **Element URI**                       /axapi/v3/debug/gslb

	 **Element Attributes**                gslb_attributes

	 **Partition Visibility**              shared

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


EXECUTE Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/debug/gslb



.. raw:: html

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


:ref:`1306_gslb_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1306_gslb_attributes:

gslb attributes
---------------

    **glname**

        **Description** Debug for matched Geo-location

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **group**

        **Description:** group is a **JSON Block**.  Please see below for :ref:`1306_group` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/debug/gslb/group <debug_gslb_group>`

    **id**

        **Description** Specify ID

        **Type:** number

        **Range:** 0-128

        **Default:** 0

    **ip-addr**

        **Description** Debug for matched IP address

        **Type:** string

        **Format:** ipv4-address

    **ipv6-addr**

        **Description** Debug for matched IPv6 address

        **Type:** string

        **Format:** ipv6-address

    **memory**

        **Description** Debug GSLB memory

        **Type:** boolean

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

        **Default:** 0

    **one-shot**

        **Description** Stop after get 64 states

        **Type:** boolean

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

        **Default:** 0

    **protocol**

        **Description:** protocol is a **JSON Block**.  Please see below for :ref:`1306_protocol` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/debug/gslb/protocol <debug_gslb_protocol>`

    **state**

        **Description** Keep GSLB state information

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1306_group:

group
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **all**

        **Description** All trace information

        **Type:** boolean

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

        **Default:** 0

    **cache**

        **Description** Cache trace information

        **Type:** boolean

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

        **Default:** 0

    **event**

        **Description** EVENTS trace information

        **Type:** boolean

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

        **Default:** 0

    **fsm**

        **Description** FSM trace information

        **Type:** boolean

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

        **Default:** 0

    **ip**

        **Description** Remote IP address of GSLB controller of the group

        **Type:** boolean

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

        **Default:** 0

    **ipc**

        **Description** IPC trace information

        **Type:** boolean

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

        **Default:** 0

    **keep-alive**

        **Description** KEEPALIVE trace information

        **Type:** boolean

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

        **Default:** 0

    **message**

        **Description** Debug GSLB group message

        **Type:** boolean

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

        **Default:** 0

    **message-all**

        **Description** All messages

        **Type:** boolean

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

        **Default:** 0

    **message-control**

        **Description** GMP control messages

        **Type:** boolean

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

        **Default:** 0

    **message-group**

        **Description** GMP group messages

        **Type:** boolean

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

        **Default:** 0

    **message-keepalive**

        **Description** GMP keepalive messages

        **Type:** boolean

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

        **Default:** 0

    **message-notify**

        **Description** GMP notify messages

        **Type:** boolean

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

        **Default:** 0

    **message-open**

        **Description** GMP open messages

        **Type:** boolean

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

        **Default:** 0

    **message-query**

        **Description** GMP query messages

        **Type:** boolean

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

        **Default:** 0

    **name**

        **Description** Name of GSLB group

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **normal**

        **Description** Normal trace information

        **Type:** boolean

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

        **Default:** 0

    **peer-ipv4**

        **Description** Specify remote IPv4 Address

        **Type:** string

        **Format:** ipv4-address

    **peer-ipv6**

        **Description** Specify remote IPv6 Address

        **Type:** string

        **Format:** ipv6-address

    **timer**

        **Description** Timer trace information

        **Type:** boolean

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

        **Default:** 0

    **update**

        **Description** Update trace information

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1306_protocol:

protocol
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **active-rdt**

        **Description** ARDT trace information

        **Type:** boolean

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

        **Default:** 0

    **all**

        **Description** All trace information

        **Type:** boolean

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

        **Default:** 0

    **cache**

        **Description** Cache trace information

        **Type:** boolean

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

        **Default:** 0

    **event**

        **Description** EVENTS trace information

        **Type:** boolean

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

        **Default:** 0

    **fsm**

        **Description** FSM trace information

        **Type:** boolean

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

        **Default:** 0

    **ip**

        **Description** Specify the remote IP address

        **Type:** boolean

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

        **Default:** 0

    **ipc**

        **Description** IPC trace information

        **Type:** boolean

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

        **Default:** 0

    **keep-alive**

        **Description** KEEPALIVE trace information

        **Type:** boolean

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

        **Default:** 0

    **message**

        **Description** Debug GSLB protocol message

        **Type:** boolean

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

        **Default:** 0

    **message-all**

        **Description** All messages

        **Type:** boolean

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

        **Default:** 0

    **message-ardt-query**

        **Description** GMP ardt-query messages

        **Type:** boolean

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

        **Default:** 0

    **message-ardt-report**

        **Description** GMP ardt-report messages

        **Type:** boolean

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

        **Default:** 0

    **message-control**

        **Description** GMP control messages

        **Type:** boolean

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

        **Default:** 0

    **message-keepalive**

        **Description** GMP keepalive messages

        **Type:** boolean

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

        **Default:** 0

    **message-notify**

        **Description** GMP notify messages

        **Type:** boolean

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

        **Default:** 0

    **message-open**

        **Description** GMP open messages

        **Type:** boolean

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

        **Default:** 0

    **message-query**

        **Description** GMP query messages

        **Type:** boolean

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

        **Default:** 0

    **message-update**

        **Description** GMP update messages

        **Type:** boolean

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

        **Default:** 0

    **name**

        **Description** Specify the slb device name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **normal**

        **Description** Normal trace information

        **Type:** boolean

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

        **Default:** 0

    **peer-ipv4**

        **Description** Specify remote IPv4 Address

        **Type:** string

        **Format:** ipv4-address

    **peer-ipv6**

        **Description** Specify remote IPv6 Address

        **Type:** string

        **Format:** ipv6-address

    **timer**

        **Description** Timer trace information

        **Type:** boolean

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

        **Default:** 0

    **update**

        **Description** Update trace information

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters