.. _hsm_fw_upgrade:

hsm fw-upgrade
==============

Upgrade firmware to a HSM device


fw-upgrade Specification
------------------------

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

	 **Element Name**                      fw-upgrade

	 **Element URI**                       /axapi/v3/hsm/fw-upgrade

	 **Element Attributes**                fw-upgrade_attributes

	 **Schema**                             :download:`fw-upgrade schema <hsm-fw-upgrade/hsm-fw-upgrade.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/hsm/fw-upgrade



.. raw:: html

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


:ref:`984_fw-upgrade_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _984_fw-upgrade_attributes:

fw-upgrade attributes
---------------------

    **all**

        **Description** Upgrade firmware on all HSM device-ids

        **Type:** boolean

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

        **Default:** 0

    **dev_id**

        **Description** Firmware upgrade on a HSM device-id

        **Type:** number

        **Range:** 0-3

    **file**

        **Description** firmware file name

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **sign-file**

        **Description** firmware signature file name

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **zeroize**

        **Description** Zeroized action required or not

        **Type:** boolean

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

        **Default:** 0