.. _upgrade_hd:

upgrade hd
==========

Hard Disk


hd Specification
----------------

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

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

	 **Element Name**                      hd

	 **Element URI**                       /axapi/v3/upgrade/hd

	 **Element Attributes**                hd_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2675_hd_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2675_hd_attributes:

hd attributes
-------------

    **Device**

        **Description** 

        **Type:** number

    **file-url**

        **Description** File URL

        **Type:** string

        **Format:** url

        **Mutual Exclusion:** file-url,local,  rollback, and image-file are mutually exclusive

    **image**

        **Description** 'pri': Primary image; 'sec': Secondary image; 

        **Type:** string

        **Supported Values:** pri, sec

    **image-file**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Mutual Exclusion:** image-file,local,  rollback, and file-url are mutually exclusive

    **local**

        **Description** Use image from local VCS image repository (Specify an image name, format: aximage_XX_XX_XX_XX.tar.gz)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** local,use-mgmt-port, source-ip-address, show-percentage,  file-url, and image-file are mutually exclusive

    **reboot-after-upgrade**

        **Description** reboot system after upgrade is done

        **Type:** boolean

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

        **Default:** 0

    **rollback**

        **Description** 

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** rollback,use-mgmt-port, source-ip-address, show-percentage,  file-url, and image-file are mutually exclusive

    **source-ip-address**

        **Description** Source ip address

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** source-ip-address,local,  rollback, and use-mgmt-port are mutually exclusive

    **staggered-upgrade-mode**

        **Description** in staggered upgrade mode

        **Type:** boolean

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

        **Default:** 0

    **use-mgmt-port**

        **Description** Use management port as source port

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** use-mgmt-port,local,  rollback, and source-ip-address are mutually exclusive