.. _slb_template_external_service:

slb template external-service
=============================

External service template


external-service Specification
------------------------------

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

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

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

	 **Collection Name**                   :ref:`2992_external-service_list`

	 **Collection URI**                    /axapi/v3/slb/template/external-service

	                                       

	 **Element Name**                      external-service

	 **Element URI**                       /axapi/v3/slb/template/external-service/{name}

	 **Element Attributes**                external-service_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2992_external-service_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_external_service_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/external-service



.. raw:: html

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


:ref:`2992_external-service_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/external-service/{name}



.. raw:: html

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


:ref:`2992_external-service_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_external_service_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/external-service



.. raw:: html

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


:ref:`2992_external-service_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/external-service/{name}



.. raw:: html

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


:ref:`2992_external-service_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/external-service/{name}



.. raw:: html

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


:ref:`2992_external-service_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_external_service_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/external-service



.. raw:: html

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


:ref:`2992_external-service_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/external-service/{name}



.. raw:: html

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


:ref:`2992_external-service_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_external_service_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2992_external-service_list:

external-service-list
---------------------


    external-service-list is **JSON List** of :ref:`2992_external-service_attributes` 

        external-service-list : [

             { :ref:`2992_external-service_attributes` },

             { :ref:`2992_external-service_attributes` },

             ...

         ]

.. _2992_external-service_attributes:

external-service attributes
---------------------------

    **action**

        **Description** 'continue': Continue; 'drop': Drop; 'reset': Reset; 

        **Type:** string

        **Supported Values:** continue, drop, reset

        **Default:** continue

    **bypass-ip-cfg**

        **Type:** List

    **failure-action**

        **Description** 'continue': Continue; 'drop': Drop; 'reset': Reset; 

        **Type:** string

        **Supported Values:** continue, drop, reset

        **Default:** continue

    **name**

        **Description** External Service Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **request-header-forward-list**

        **Type:** List

    **service-group**

        **Description** Bind a Service Group to the template (Service Group Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/service-group <slb_service_group>`

    **shared-partition-persist-source-ip-template**

        **Description** Reference a persist source ip template from shared partition

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** shared-partition-persist-source-ip-template and source-ip are mutually exclusive

    **shared-partition-tcp-proxy-template**

        **Description** Reference a TCP Proxy template from shared partition

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** shared-partition-tcp-proxy-template and tcp-proxy are mutually exclusive

    **source-ip**

        **Description** Source IP persistence template (Source IP persistence template name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** source-ip and shared-partition-persist-source-ip-template are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/slb/template/persist/source-ip <slb_template_persist_source_ip>`

    **tcp-proxy**

        **Description** TCP Proxy Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** tcp-proxy and shared-partition-tcp-proxy-template are mutually exclusive

    **template-persist-source-ip-shared**

        **Description** Source IP Persistence Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/template/persist/source-ip <slb_template_persist_source_ip>`

    **template-tcp-proxy-shared**

        **Description** TCP Proxy Template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy <slb_template_tcp_proxy>`

    **timeout**

        **Description** Timeout value 1 - 200 in units of 200ms, default is 5 (default is 1000ms) (1 - 200 in units of 200ms, default is 5 (1000ms))

        **Type:** number

        **Range:** 1-200

        **Default:** 5

    **type**

        **Description** 'skyfire-icap': Skyfire ICAP service; 'url-filter': URL filtering service; 

        **Type:** string

        **Supported Values:** skyfire-icap, url-filter

        **Default:** url-filter

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

.. _2992_bypass-ip-cfg:

bypass-ip-cfg
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **bypass-ip**

        **Description** ip address to bypass external service

        **Type:** string

        **Format:** ipv4-address

    **mask**

        **Description** IP prefix mask

        **Type:** string

        **Format:** ipv4-netmask

.. _2992_request-header-forward-list:

request-header-forward-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **request-header-forward**

        **Description** Request header to be forwarded to external service (Header Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters