.. _backup_system:

backup system
=============

Backup system files


system Specification
--------------------

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

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

	 **Element Name**                      system

	 **Element URI**                       /axapi/v3/backup/system

	 **Element Attributes**                system_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`222_system_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _222_system_attributes:

system attributes
-----------------

    **encrypt**

        **Description** Encrypt the backup file

        **Type:** boolean

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

        **Default:** 0

    **password**

        **Description** password for the remote site

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **remote-file**

        **Description** profile name for remote url

        **Type:** string

        **Format:** url

    **store-name**

        **Description** Save backup store information

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **use-mgmt-port**

        **Description** Use management port as source port

        **Type:** boolean

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

        **Default:** 0