.. _dnssec_template:

dnssec template
===============

template Settings


template Specification
----------------------

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

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

	 **Object Key(s)**                     *dnssec-temp-name*

	 **Collection Name**                   :ref:`1437_template_list`

	 **Collection URI**                    /axapi/v3/dnssec/template

	                                       

	 **Element Name**                      template

	 **Element URI**                       /axapi/v3/dnssec/template/{dnssec-temp-name}

	 **Element Attributes**                template_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1437_template_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/dnssec_template_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/dnssec/template



.. raw:: html

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


:ref:`1437_template_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/dnssec/template/{dnssec-temp-name}



.. raw:: html

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


:ref:`1437_template_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/dnssec_template_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/dnssec/template



.. raw:: html

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


:ref:`1437_template_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/dnssec/template/{dnssec-temp-name}



.. raw:: html

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


:ref:`1437_template_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/dnssec/template/{dnssec-temp-name}



.. raw:: html

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


:ref:`1437_template_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/dnssec_template_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/dnssec/template



.. raw:: html

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


:ref:`1437_template_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/dnssec/template/{dnssec-temp-name}



.. raw:: html

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


:ref:`1437_template_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/dnssec_template_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1437_template_list:

template-list
-------------


    template-list is **JSON List** of :ref:`1437_template_attributes` 

        template-list : [

             { :ref:`1437_template_attributes` },

             { :ref:`1437_template_attributes` },

             ...

         ]

.. _1437_template_attributes:

template attributes
-------------------

    **algorithm**

        **Description** 'RSASHA1': RSASHA1 algorithm; 'RSASHA256': RSASHA256 algorithm; 'RSASHA512': RSASHA512 algorithm; 

        **Type:** string

        **Supported Values:** RSASHA1, RSASHA256, RSASHA512

    **combinations-limit**

        **Description** the max number of combinations per RRset (Default value is 31)

        **Type:** number

        **Range:** 1-65535

    **dnskey-ttl-k**

        **Description** The TTL value of DNSKEY RR

        **Type:** boolean

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

        **Default:** 0

    **dnskey-ttl-v**

        **Description** in seconds, 14400 seconds by default

        **Type:** number

        **Range:** 1-864000

        **Default:** 14400

    **dnssec-temp-name**

        **Description** DNSSEC Template Name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **dnssec-template-ksk**

        **Description:** dnssec-template-ksk is a **JSON Block**.  Please see below for :ref:`1437_dnssec-template-ksk` 

        **Type:** Object

    **dnssec-template-zsk**

        **Description:** dnssec-template-zsk is a **JSON Block**.  Please see below for :ref:`1437_dnssec-template-zsk` 

        **Type:** Object

    **enable-nsec3**

        **Description** enable NSEC3 support. disabled by default

        **Type:** boolean

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

        **Default:** 0

    **hsm**

        **Description** specify the HSM template

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/hsm/template <hsm_template>`

    **return-nsec-on-failure**

        **Description** return NSEC/NSEC3 or not on failure case. return by default

        **Type:** boolean

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

        **Default:** 1

    **signature-validity-period-k**

        **Description** The period that a signature is valid

        **Type:** boolean

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

        **Default:** 0

    **signature-validity-period-v**

        **Description** in days, 10 days by default

        **Type:** number

        **Range:** 5-30

        **Default:** 10

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

.. _1437_dnssec-template-ksk:

dnssec-template-ksk
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ksk-keysize-k**

        **Description** Specify the number of bits in the DNSSEC KSK keys

        **Type:** boolean

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

        **Default:** 0

    **ksk-keysize-v**

        **Description** Default size is 2048 and must be an exact multiple of 64

        **Type:** number

        **Range:** 1024-4096

    **ksk-lifetime-k**

        **Description** Set the lifetime for DNSSEC KSK keys in days

        **Type:** boolean

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

        **Default:** 0

    **ksk-lifetime-v**

        **Description** Default value is 365 days

        **Type:** number

        **Range:** 2-3650

    **ksk-rollover-time-k**

        **Description** Set the rollover time in days

        **Type:** boolean

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

        **Default:** 0

    **zsk-rollover-time-v**

        **Description** 7 days less than the lifetime by default

        **Type:** number

        **Range:** 1-3650

        **Default:** 358

.. _1437_dnssec-template-zsk:

dnssec-template-zsk
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **zsk-keysize-k**

        **Description** Specify the number of bits in the DNSSEC ZSK keys

        **Type:** boolean

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

        **Default:** 0

    **zsk-keysize-v**

        **Description** Default size is 2048 and must be an exact multiple of 64

        **Type:** number

        **Range:** 1024-4096

    **zsk-lifetime-k**

        **Description** Set the lifetime for DNSSEC ZSK keys in days

        **Type:** boolean

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

        **Default:** 0

    **zsk-lifetime-v**

        **Description** Default value is 90 days

        **Type:** number

        **Range:** 2-3650

        **Default:** 90

    **zsk-rollover-time-k**

        **Description** Set the rollover time in days

        **Type:** boolean

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

        **Default:** 0

    **zsk-rollover-time-v**

        **Description** 7 days less than the lifetime by default

        **Type:** number

        **Range:** 1-3650

        **Default:** 83