.. _slb_template_link_probe:

slb template link-probe
=======================

Link probe template


link-probe Specification
------------------------

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

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

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`3006_link-probe_list`

	 **Collection URI**                    /axapi/v3/slb/template/link-probe

	                                       

	 **Element Name**                      link-probe

	 **Element URI**                       /axapi/v3/slb/template/link-probe/{name}

	 **Element Attributes**                link-probe_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`link-probe schema <slb-template-link-probe/slb-template-link-probe.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/slb/template/link-probe



.. raw:: html

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


:ref:`3006_link-probe_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/slb_template_link_probe_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/slb/template/link-probe



.. raw:: html

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


:ref:`3006_link-probe_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/slb/template/link-probe/{name}



.. raw:: html

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


:ref:`3006_link-probe_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/slb_template_link_probe_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/slb/template/link-probe



.. raw:: html

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


:ref:`3006_link-probe_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/slb/template/link-probe/{name}



.. raw:: html

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


:ref:`3006_link-probe_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/slb/template/link-probe/{name}



.. raw:: html

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


:ref:`3006_link-probe_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/slb_template_link_probe_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/slb/template/link-probe



.. raw:: html

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


:ref:`3006_link-probe_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/slb/template/link-probe/{name}



.. raw:: html

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


:ref:`3006_link-probe_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/slb_template_link_probe_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3006_link-probe_list:

link-probe-list
---------------


    link-probe-list is **JSON List** of :ref:`3006_link-probe_attributes` 

        link-probe-list : [

             { :ref:`3006_link-probe_attributes` },

             { :ref:`3006_link-probe_attributes` },

             ...

         ]

.. _3006_link-probe_attributes:

link-probe attributes
---------------------

    **destination**

        **Description:** destination is a **JSON Block**.  Please see below for :ref:`3006_destination` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/slb/template/link-probe/{name}/destination <slb_template_link_probe>`

    **disable**

        **Description** Disable Probe template

        **Type:** boolean

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

        **Default:** 0

    **expected-status-code**

        **Description** Specify response code range (e.g. 200,400-430), default is 200 (Format is xx,xx-xx (xx between [100, 899]), default is 200)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

        **Default:** 200

    **name**

        **Description** probe template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **probe-interval**

        **Description** Time between each probe that needs to be sent out (in seconds, default is 5)

        **Type:** number

        **Range:** 1-7200

        **Default:** 5

    **probes-per-test**

        **Description** Total number of probes to be sent out for each test

        **Type:** number

        **Range:** 1-10

        **Default:** 5

    **rtt-method**

        **Description** 'http-rtt': Calculate Round Trip Time between HTTP request and response; 'tcp-srtt': Use TCP Smoothed round trip time in the HTTP connection; 

        **Type:** string

        **Supported Values:** http-rtt, tcp-srtt

        **Default:** http-rtt

    **selection-rule**

        **Description** 'threshold': Use all links below a threshold before selecting the fastest link; 'fastest-link-always': Always use the link with the lowest average latency; 

        **Type:** string

        **Supported Values:** threshold, fastest-link-always

        **Default:** fastest-link-always

    **test-interval**

        **Description** time interval between subsequent tests (in seconds, default is 60)

        **Type:** number

        **Range:** 1-7200

        **Default:** 60

    **threshold-value**

        **Description** Use all links below a threshold before selecting the fastest link (RTT in milliseconds)

        **Type:** number

        **Range:** 0-65534

        **Default:** 0

    **url**

        **Description** Specify URL to which probes should be sent out. Default is /

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1023 characters

        **Maximum Length:** 1 characters

        **Default:** /

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

.. _3006_destination:

destination
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **hostname**

        **Description** Target Hostname

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **resolve-as**

        **Description** 'resolve-to-ipv4': Use A Query only to resolve the configured hostname; 'resolve-to-ipv6': Use AAAA Query only to resolve the configured hostname; 

        **Type:** string

        **Supported Values:** resolve-to-ipv4, resolve-to-ipv6

        **Mutual Exclusion:** resolve-as, static-ipv4-addr, and static-ipv6-addr are mutually exclusive

    **static-ipv4-addr**

        **Description** Target IPv4 Address

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** static-ipv4-addr, resolve-as, and static-ipv6-addr are mutually exclusive

    **static-ipv6-addr**

        **Description** Target IPv6 Address

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** static-ipv6-addr, resolve-as, and static-ipv4-addr are mutually exclusive

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters