.. _slb_template_dynamic_service:

slb template dynamic-service
============================

Dynamic service template


dynamic-service Specification
-----------------------------

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

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

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

	 **Collection Name**                   :ref:`2991_dynamic-service_list`

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

	                                       

	 **Element Name**                      dynamic-service

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

	 **Element Attributes**                dynamic-service_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2991_dynamic-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_dynamic_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/dynamic-service



.. raw:: html

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


:ref:`2991_dynamic-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/dynamic-service/{name}



.. raw:: html

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


:ref:`2991_dynamic-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_dynamic_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/dynamic-service



.. raw:: html

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


:ref:`2991_dynamic-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/dynamic-service/{name}



.. raw:: html

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


:ref:`2991_dynamic-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/dynamic-service/{name}



.. raw:: html

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


:ref:`2991_dynamic-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_dynamic_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/dynamic-service



.. raw:: html

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


:ref:`2991_dynamic-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/dynamic-service/{name}



.. raw:: html

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


:ref:`2991_dynamic-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_dynamic_service_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2991_dynamic-service_list:

dynamic-service-list
--------------------


    dynamic-service-list is **JSON List** of :ref:`2991_dynamic-service_attributes` 

        dynamic-service-list : [

             { :ref:`2991_dynamic-service_attributes` },

             { :ref:`2991_dynamic-service_attributes` },

             ...

         ]

.. _2991_dynamic-service_attributes:

dynamic-service attributes
--------------------------

    **class-list-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/slb/template/dynamic-service/{name}/class-list/{dns-class-list} <slb_template_dynamic_service>`

    **dns-server**

        **Type:** List

    **name**

        **Description** Dynamic Service Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

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

.. _2991_dns-server:

dns-server
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv4-dns-server**

        **Description** DNS Server IPv4 Address

        **Type:** string

        **Format:** ipv4-address

    **ipv6-dns-server**

        **Description** DNS Server IPv6 Address

        **Type:** string

        **Format:** ipv6-address

.. _2991_class-list-list:

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

	 **Block object keys**             

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

    **dns-class-list**

        **Description** Name of Aho-Corasick class-list

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **dns-server**

        **Type:** List

    **priority**

        **Description** Priority of the class-list(the larger number, the higher priority)

        **Type:** number

        **Range:** 1-64

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

.. _2991_class-list-list_dns-server:

class-list-list_dns-server
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv4-dns-server**

        **Description** DNS Server IPv4 Address

        **Type:** string

        **Format:** ipv4-address

    **ipv6-dns-server**

        **Description** DNS Server IPv6 Address

        **Type:** string

        **Format:** ipv6-address