.. _backup:

backup
======

Backup system files


backup Specification
--------------------

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

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

	 **Element Name**                      backup

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

	 **Element Attributes**                backup_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`223_backup_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _223_backup_attributes:

backup attributes
-----------------

    **log**

        **Description:** log is a **JSON Block**.  Please see below for :ref:`223_log` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/backup/log <backup_log>`

    **status**

        **Description:** status is a **JSON Block**.  Please see below for :ref:`223_status` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/backup/status <backup_status>`

    **store**

        **Description:** store is a **JSON Block**.  Please see below for :ref:`223_store` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/backup/store <backup_store>`

    **system**

        **Description:** system is a **JSON Block**.  Please see below for :ref:`223_system` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/backup/system <backup_system>`

.. _223_status:

status
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _223_system:

system
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

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

.. _223_store:

store
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **creat-cfg**

        **Description:** creat-cfg is a **JSON Block**.  Please see below for :ref:`223_store_creat-cfg` 

        **Type:** Object

    **delete-cfg**

        **Description:** delete-cfg is a **JSON Block**.  Please see below for :ref:`223_store_delete-cfg` 

        **Type:** Object

.. _223_store_delete-cfg:

store_delete-cfg
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **delete**

        **Description** Delete store

        **Type:** boolean

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

        **Default:** 0

    **store-name-del**

        **Description** profile name for deleting

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

.. _223_store_creat-cfg:

store_creat-cfg
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **create**

        **Description** Create store

        **Type:** boolean

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

        **Default:** 0

    **remote-file**

        **Description** profile name for remote url

        **Type:** string

        **Format:** url

    **store-name**

        **Description** profile name to store remote url

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

.. _223_log:

log
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **all**

        **Description** all log

        **Type:** boolean

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

        **Default:** 0

    **core**

        **Description** Backup core files only

        **Type:** boolean

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

        **Default:** 0

    **date**

        **Description** specify number of days

        **Type:** number

        **Range:** 1-31

    **day**

        **Description** Most recent day

        **Type:** boolean

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

        **Default:** 0

    **expedite**

        **Description** Expedite the Backup

        **Type:** boolean

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

        **Default:** 0

    **messages**

        **Description** Backup messages file only

        **Type:** boolean

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

        **Default:** 0

    **month**

        **Description**  Most recent month

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

    **period**

        **Description** Specify backup period

        **Type:** boolean

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

        **Default:** 0

    **remote-file**

        **Description** profile name for remote url

        **Type:** string

        **Format:** url

    **showtech**

        **Description** Backup showtech files only

        **Type:** boolean

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

        **Default:** 0

    **stats-data**

        **Description** Backup web statistical data

        **Type:** boolean

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

        **Default:** 0

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

    **week**

        **Description** Most recent week

        **Type:** boolean

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

        **Default:** 0