.. _upgrade:

upgrade
=======

Upgrade System


upgrade Specification
---------------------

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

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

	 **Element Name**                      upgrade

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

	 **Element Attributes**                upgrade_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3525_upgrade_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3525_upgrade_attributes:

upgrade attributes
------------------

    **cf**

        **Description:** cf is a **JSON Block**.  Please see below for :ref:`3525_cf` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/upgrade/cf <upgrade_cf>`

    **gui**

        **Description:** gui is a **JSON Block**.  Please see below for :ref:`3525_gui` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/upgrade/gui <upgrade_gui>`

    **hd**

        **Description:** hd is a **JSON Block**.  Please see below for :ref:`3525_hd` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/upgrade/hd <upgrade_hd>`

.. _3525_gui:

gui
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **delete**

        **Type:** List

    **file-url**

        **Description** File URL

        **Type:** string

        **Format:** url

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

    **gui-upload**

        **Description** image file from AXAPI

        **Type:** boolean

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

        **Default:** 0

    **image**

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

        **Type:** string

        **Supported Values:** pri, sec

    **image-file**

        **Description** image file from AXAPI,

        **Type:** string

        **Format:** string-rlx

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

    **local**

        **Description** Local GUI image name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

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

    **remote-url**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **rollback**

        **Description** Rollback to a specific local GUI image

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** rollback,use-mgmt-port, source-ip-address, show-percentage, save-gui, upload,  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, rollback, and use-mgmt-port are mutually exclusive

    **upload**

        **Description** Upload GUI image from remote

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** upload and rollback are mutually exclusive

    **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, rollback, and source-ip-address are mutually exclusive

.. _3525_gui_delete:

gui_delete
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **file**

        **Description** Delete one local GUI image

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _3525_cf:

cf
^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **Device**

        **Description** 

        **Type:** number

    **file-url**

        **Description** File URL

        **Type:** string

        **Format:** url

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

    **image**

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

        **Type:** string

        **Supported Values:** pri

    **image-file**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Mutual Exclusion:** image-file, local, 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, 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

    **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 and local are mutually exclusive

.. _3525_hd:

hd
^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

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