.. _slb_template_doh:

slb template doh
================

DNS over HTTP(s) template


doh Specification
-----------------

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

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

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

	 **Collection Name**                   :ref:`2989_doh_list`

	 **Collection URI**                    /axapi/v3/slb/template/doh

	                                       

	 **Element Name**                      doh

	 **Element URI**                       /axapi/v3/slb/template/doh/{name}

	 **Element Attributes**                doh_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2989_doh_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_doh_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/doh



.. raw:: html

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


:ref:`2989_doh_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/doh/{name}



.. raw:: html

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


:ref:`2989_doh_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_doh_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/doh



.. raw:: html

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


:ref:`2989_doh_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/doh/{name}



.. raw:: html

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


:ref:`2989_doh_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/doh/{name}



.. raw:: html

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


:ref:`2989_doh_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_doh_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/doh



.. raw:: html

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


:ref:`2989_doh_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/doh/{name}



.. raw:: html

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


:ref:`2989_doh_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_doh_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2989_doh_list:

doh-list
--------


    doh-list is **JSON List** of :ref:`2989_doh_attributes` 

        doh-list : [

             { :ref:`2989_doh_attributes` },

             { :ref:`2989_doh_attributes` },

             ...

         ]

.. _2989_doh_attributes:

doh attributes
--------------

    **conn-reuse**

        **Description** 'enable': Enable Connection Reuse; 'disable': Disable Connection-Reuse (Default); 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **dns**

        **Description** DNS Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Default:** default

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

        **Reference Object:** :doc:`/axapi/v3/slb/template/dns <slb_template_dns>`

    **dns-retry**

        **Description:** dns-retry is a **JSON Block**.  Please see below for :ref:`2989_dns-retry` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/slb/template/doh/{name}/dns-retry <slb_template_doh>`

    **forwarder**

        **Description:** forwarder is a **JSON Block**.  Please see below for :ref:`2989_forwarder` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/slb/template/doh/{name}/forwarder <slb_template_doh>`

    **name**

        **Description** DNS over HTTP(s) Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **non-dns-request**

        **Description** 'allow': Forward Non-DoH request to http server bound to vport; 'reject': Reject Non-DoH requests with HTTP 400 Bad Request (Default); 

        **Type:** string

        **Supported Values:** allow, reject

        **Default:** reject

    **reject-status-code**

        **Description** '400': Status Code 400 BAD Request (Default); '500': Status Code 500 Internal Server Error; '501': Status Code 501 Not Implemented; 

        **Type:** string

        **Supported Values:** 400, 500, 501

        **Default:** 400

    **shared-partition-dns-template**

        **Description** Reference a DNS template from shared partition

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** shared-partition-dns-template and dns 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

    **snat-pool**

        **Description** Source NAT pool or pool group

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ip/nat/pool <ip_nat_pool>`

    **source-nat**

        **Description** 'auto': Perform Source NAT Auto for service-group(Default) (Not supported with forwarding-ip); 'disable': Don't perform source-nat for server side DNS queries; 'pool': Perform Source NAT with specific pool; 

        **Type:** string

        **Supported Values:** auto, disable, pool

        **Default:** auto

    **tcp-proxy**

        **Description** TCP Proxy Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Default:** default

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

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

    **template-dns-shared**

        **Description** DNS Template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/template/dns <slb_template_dns>`

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

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

.. _2989_forwarder:

forwarder
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **bypass-doh**

        **Description** Forward valid DoH HTTP request as is, no DNS packet extraction (Bypass DoH)

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** bypass-doh,forwarding-ipv4, forwarding-ipv6,  tcp-service-group, and udp-service-group are mutually exclusive

    **forwarding-ipv4**

        **Description** SLB VIP IPv4 address to forward DOH query (IP address)

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** forwarding-ipv4,forwarding-ipv6, tcp-service-group,  udp-service-group, and bypass-doh are mutually exclusive

    **forwarding-ipv6**

        **Description** SLB VIP IPv6 address to forward DOH query (IP address)

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** forwarding-ipv6,forwarding-ipv4, tcp-service-group,  udp-service-group, and bypass-doh are mutually exclusive

    **tcp-service-group**

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

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** tcp-service-group,forwarding-ipv4,  forwarding-ipv6, and bypass-doh are mutually exclusive

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

    **udp-service-group**

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

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** udp-service-group,forwarding-ipv4,  forwarding-ipv6, and bypass-doh are mutually exclusive

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **v4-internal**

        **Description** Try to find this IP as a VIP in this L3v Partition and forward it internally to the VIP

        **Type:** boolean

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

        **Default:** 0

    **v4-l4-proto**

        **Description** 'tcp': Use TCP only when forwarding DNS traffic; 'udp': Use UDP only when forwarding DNS traffic; 'both': Use UDP 1st and if unreachable, retry with TCP when forwarding DNS traffic; 

        **Type:** string

        **Supported Values:** tcp, udp, both

        **Default:** both

    **v4-port**

        **Description** Forwarding port number, Default is 53

        **Type:** number

        **Range:** 1-65534

        **Default:** 53

    **v6-internal**

        **Description** Try to find this IP as a VIP in this L3v Partition and forward it internally to the VIP

        **Type:** boolean

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

        **Default:** 0

    **v6-l4-proto**

        **Description** 'tcp': Use TCP only when forwarding DNS traffic; 'udp': Use UDP only when forwarding DNS traffic; 'both': Use UDP 1st and if unreachable, retry with TCP when forwarding DNS traffic; 

        **Type:** string

        **Supported Values:** tcp, udp, both

        **Default:** both

    **v6-port**

        **Description** Forwarding port number, Default is 53

        **Type:** number

        **Range:** 1-65534

        **Default:** 53

.. _2989_dns-retry:

dns-retry
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **after-timeout**

        **Description** 'close': Close client side connection; 'retry-with-tcp': Retry DNS query to server using TCP (If UDP was tried initially. Close after.); 

        **Type:** string

        **Supported Values:** close, retry-with-tcp

        **Default:** close

    **max-trials**

        **Description** Total number of times to try DNS query to server before closing client connection, default 3

        **Type:** number

        **Range:** 1-5

        **Default:** 3

    **retry-interval**

        **Description** DNS Retry Interval value 1 - 400 in units of 100ms, default is 10 (default is 1000ms) (1 - 400 in units of 100ms, default is 10 (1000ms/1sec))

        **Type:** number

        **Range:** 1-400

        **Default:** 10

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters