.. _slb_template_dns_category_lookup:

slb template dns category-lookup
================================

Configure web-category list for DNS domains matching (Up to 8 lists)


category-lookup Specification
-----------------------------

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

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

	 **Object Key(s)**                     *category-name*

	 **Collection Name**                   :ref:`3048_category-lookup_list`

	 **Collection URI**                    /axapi/v3/slb/template/dns/{name}/category-lookup

	                                       

	 **Element Name**                      category-lookup

	 **Element URI**                       /axapi/v3/slb/template/dns/{name}/category-lookup/{category-name}

	 **Element Attributes**                category-lookup_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3048_category-lookup_attributes`



.. raw:: html

   </td><td></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/dns/{name}/category-lookup



.. raw:: html

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


:ref:`3048_category-lookup_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/dns/{name}/category-lookup/{category-name}



.. raw:: html

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


:ref:`3048_category-lookup_attributes`



.. raw:: html

   </td><td></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/dns/{name}/category-lookup



.. raw:: html

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


:ref:`3048_category-lookup_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/dns/{name}/category-lookup/{category-name}



.. raw:: html

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


:ref:`3048_category-lookup_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/dns/{name}/category-lookup/{category-name}



.. raw:: html

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


:ref:`3048_category-lookup_attributes`



.. raw:: html

   </td><td></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/dns/{name}/category-lookup



.. raw:: html

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


:ref:`3048_category-lookup_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/dns/{name}/category-lookup/{category-name}



.. raw:: html

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


:ref:`3048_category-lookup_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3048_category-lookup_list:

category-lookup-list
--------------------


    category-lookup-list is **JSON List** of :ref:`3048_category-lookup_attributes` 

        category-lookup-list : [

             { :ref:`3048_category-lookup_attributes` },

             { :ref:`3048_category-lookup_attributes` },

             ...

         ]

.. _3048_category-lookup_attributes:

category-lookup attributes
--------------------------

    **category-name**

        **Description** category-list name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/web-category/category-list <web_category_category_list>`

    **drop**

        **Description** Deny matching DNS domains

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** drop,permit, respond, respond-nxdomain, respond-ip-addr,  respond-ipv6-addr, and respond-cname-str are mutually exclusive

    **permit**

        **Description** Permit matching DNS domains

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** permit,drop, respond, respond-nxdomain, respond-ip-addr,  respond-ipv6-addr, and respond-cname-str are mutually exclusive

    **respond**

        **Description** Respond to matching DNS domains

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** respond, permit, and drop are mutually exclusive

    **respond-cname-str**

        **Description** CNAME to respond (Canonical name)

        **Type:** string

        **Maximum Length:** 256 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** respond-cname-str,permit,  drop, and respond-nxdomain are mutually exclusive

    **respond-ip-addr**

        **Description** Type A record to respond (IPv4 address)

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** respond-ip-addr,permit,  drop, and respond-nxdomain are mutually exclusive

    **respond-ipv6-addr**

        **Description** TYPE AAAA record to respond (IPv6 address)

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** respond-ipv6-addr,permit,  drop, and respond-nxdomain are mutually exclusive

    **respond-nxdomain**

        **Description** Respond with NXDOMAIN

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** respond-nxdomain,permit, drop, respond-ip-addr,  respond-ipv6-addr, and respond-cname-str are mutually exclusive

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters