.. _upgrade_gui:

upgrade gui
===========

Upgrade or Rollback GUI


gui Specification
-----------------

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

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

	 **Element Name**                      gui

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

	 **Element Attributes**                gui_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3523_gui_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3523_gui_attributes:

gui attributes
--------------

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

.. _3523_delete:

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