.. _dnssec_key_rollover:

dnssec key-rollover
===================

DNSSEC Key rollover


key-rollover Specification
--------------------------

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

	===================================== ============================================================
	 **Type**                              *operational*

	 **Element Name**                      key-rollover

	 **Element URI**                       /axapi/v3/dnssec/key-rollover

	 **Element Attributes**                key-rollover_attributes

	 **Partition Visibility**              shared

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


EXECUTE Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/dnssec/key-rollover



.. raw:: html

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


:ref:`1434_key-rollover_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1434_key-rollover_attributes:

key-rollover attributes
-----------------------

    **dnssec-key-type**

        **Description** 'ZSK': Zone Signing Key; 'KSK': Key Signing Key; 

        **Type:** string

        **Supported Values:** ZSK, KSK

    **ds-ready-in-parent-zone**

        **Description** DS RR is already ready in the parent zone

        **Type:** boolean

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

        **Default:** 0

    **ksk-start**

        **Description** start KSK rollover in emergency mode

        **Type:** boolean

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

        **Default:** 0

    **zone-name**

        **Description** Specify the name for the DNS zone

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **zsk-start**

        **Description** start ZSK rollover in emergency mode

        **Type:** boolean

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

        **Default:** 0