.. _gslb_service_ip:

gslb service-ip
===============

Service IP


service-ip Specification
------------------------

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

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

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

	 **Collection Name**                   :ref:`1741_service-ip_list`

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

	                                       

	 **Element Name**                      service-ip

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

	 **Element Attributes**                service-ip_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/gslb/service-ip/{node-name}/stats

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

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



.. raw:: html

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


:ref:`1741_service-ip_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_ip_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-ip



.. raw:: html

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


:ref:`1741_service-ip_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-ip/{node-name}



.. raw:: html

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


:ref:`1741_service-ip_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_ip_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-ip



.. raw:: html

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


:ref:`1741_service-ip_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-ip/{node-name}



.. raw:: html

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


:ref:`1741_service-ip_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-ip/{node-name}



.. raw:: html

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


:ref:`1741_service-ip_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_ip_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-ip



.. raw:: html

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


:ref:`1741_service-ip_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-ip/{node-name}



.. raw:: html

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


:ref:`1741_service-ip_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_ip_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1741_service-ip_list:

service-ip-list
---------------


    service-ip-list is **JSON List** of :ref:`1741_service-ip_attributes` 

        service-ip-list : [

             { :ref:`1741_service-ip_attributes` },

             { :ref:`1741_service-ip_attributes` },

             ...

         ]

.. _1741_service-ip_attributes:

service-ip attributes
---------------------

    **action**

        **Description** 'enable': Enable this GSLB server; 'disable': Disable this GSLB server; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** enable

    **external-ip**

        **Description** External IP address for NAT

        **Type:** string

        **Format:** ipv4-address

    **health-check**

        **Description** Health Check Monitor (Monitor Name)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** health-check and health-check-disable are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/health/monitor <health_monitor>`

    **health-check-disable**

        **Description** Disable Health Check Monitor

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** health-check-disable and health-check are mutually exclusive

    **health-check-protocol-disable**

        **Description** Disable GSLB Protocol Health Monitor

        **Type:** boolean

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

        **Default:** 0

    **ip-address**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

    **ipv6**

        **Description** IPv6 address Mapping (Applicable only when service-ip has an IPv4 Address)

        **Type:** string

        **Format:** ipv6-address

    **ipv6-address**

        **Description** IPV6 address

        **Type:** string

        **Format:** ipv6-address

    **node-name**

        **Description** Service-IP Name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **port-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/gslb/service-ip/{node-name}/port/{port-num}+{port-proto} <gslb_service_ip>`

    **sampling-enable**

        **Type:** List

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

.. _1741_port-list:

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

	 **Block object keys**             

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

    **action**

        **Description** 'enable': Enable this GSLB server port; 'disable': Disable this GSLB server port; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** enable

    **follow-port-protocol**

        **Description** 'tcp': TCP Port; 'udp': UDP Port; 

        **Type:** string

        **Supported Values:** tcp, udp

    **health-check**

        **Description** Health Check Monitor (Monitor Name)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** health-check, health-check-follow-port, and health-check-disable are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/health/monitor <health_monitor>`

    **health-check-disable**

        **Description** Disable Health Check Monitor

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** health-check-disable, health-check, and health-check-follow-port are mutually exclusive

    **health-check-follow-port**

        **Description** Specify which port to follow for health status (Port Number)

        **Type:** number

        **Range:** 1-65534

        **Mutual Exclusion:** health-check-follow-port, health-check, and health-check-disable are mutually exclusive

    **health-check-protocol-disable**

        **Description** Disable GSLB Protocol Health Monitor

        **Type:** boolean

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

        **Default:** 0

    **port-num**

        **Description** Port Number

        **Type:** number

        **Range:** 0-65534

    **port-proto**

        **Description** 'tcp': TCP Port; 'udp': UDP Port; 

        **Type:** string

        **Supported Values:** tcp, udp

    **sampling-enable**

        **Type:** List

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

.. _1741_port-list_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'active': Active Servers; 'current': Current Connections; 

        **Type:** string

        **Supported Values:** all, active, current

.. _1741_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'hits': Number of times the service IP has been selected; 'recent': Recent hits; 

        **Type:** string

        **Supported Values:** all, hits, recent