.. _slb_template_dns_rpz:

slb template dns rpz
====================

Response Policy Zone File


rpz Specification
-----------------

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

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

	 **Object Key(s)**                     *seq-id*

	 **Collection Name**                   :ref:`2984_rpz_list`

	 **Collection URI**                    /axapi/v3/slb/template/dns/{name}/rpz

	                                       

	 **Element Name**                      rpz

	 **Element URI**                       /axapi/v3/slb/template/dns/{name}/rpz/{seq-id}

	 **Element Attributes**                rpz_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2984_rpz_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}/rpz



.. raw:: html

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


:ref:`2984_rpz_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}/rpz/{seq-id}



.. raw:: html

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


:ref:`2984_rpz_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}/rpz



.. raw:: html

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


:ref:`2984_rpz_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}/rpz/{seq-id}



.. raw:: html

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


:ref:`2984_rpz_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}/rpz/{seq-id}



.. raw:: html

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


:ref:`2984_rpz_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}/rpz



.. raw:: html

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


:ref:`2984_rpz_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}/rpz/{seq-id}



.. raw:: html

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


:ref:`2984_rpz_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2984_rpz_list:

rpz-list
--------


    rpz-list is **JSON List** of :ref:`2984_rpz_attributes` 

        rpz-list : [

             { :ref:`2984_rpz_attributes` },

             { :ref:`2984_rpz_attributes` },

             ...

         ]

.. _2984_rpz_attributes:

rpz attributes
--------------

    **logging**

        **Description:** logging is a **JSON Block**.  Please see below for :ref:`2984_logging` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/rpz/{seq-id}/logging <slb_template_dns>`

    **name**

        **Description** Specify a Response Policy Zone name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **seq-id**

        **Description** sequential id of RPZ

        **Type:** number

        **Range:** 1-8

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

.. _2984_logging:

logging
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **enable**

        **Description** Log RPZ triggered action

        **Type:** boolean

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

        **Default:** 0

    **rpz-action**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2984_logging_rpz-action:

logging_rpz-action
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **str-rpz-action**

        **Description** 'drop': Log RPZ due to drop action; 'pass-thru': Log RPZ due to pass-thru action; 'nxdomain': Log RPZ due to nxdomain action; 'nodata': Log RPZ due to nodata action; 'tcp-only': Log RPZ due to tcp-only action; 'local-data': Log RPZ due to local-data action; 

        **Type:** string

        **Supported Values:** drop, pass-thru, nxdomain, nodata, tcp-only, local-data