.. _slb_template_doh_forwarder:

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

DNS over HTTP(s) template forwarding policy


forwarder Specification
-----------------------

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

	===================================== ==========================================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      forwarder

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

	 **Element Attributes**                forwarder_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2988_forwarder_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_forwarder_POST.txt
   :literal:




.. raw:: html

   </div></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}/forwarder



.. raw:: html

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


:ref:`2988_forwarder_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_forwarder_GET.txt
   :literal:




.. raw:: html

   </div></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}/forwarder



.. raw:: html

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


:ref:`2988_forwarder_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}/forwarder



.. raw:: html

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


:ref:`2988_forwarder_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_forwarder_PUT.txt
   :literal:




.. raw:: html

   </div></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}/forwarder



.. raw:: html

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


:ref:`2988_forwarder_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_forwarder_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2988_forwarder_attributes:

forwarder attributes
--------------------

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