.. _backup_periodic:

backup-periodic
===============

Configure backup periodically


backup-periodic Specification
-----------------------------

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

	===================================== =======================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *system, log*

	 **Collection Name**                   :ref:`24_backup-periodic_list`

	 **Collection URI**                    /axapi/v3/backup-periodic

	                                       

	 **Element Name**                      backup-periodic

	 **Element URI**                       /axapi/v3/backup-periodic/{system}+{log}

	 **Element Attributes**                backup-periodic_attributes

	 **Partition Visibility**              shared

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


Create Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/backup-periodic



.. raw:: html

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


:ref:`24_backup-periodic_attributes`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/backup-periodic



.. raw:: html

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


:ref:`24_backup-periodic_attributes`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/backup-periodic/{system}+{log}



.. raw:: html

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


:ref:`24_backup-periodic_attributes`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/backup-periodic



.. raw:: html

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


:ref:`24_backup-periodic_list`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/backup-periodic/{system}+{log}



.. raw:: html

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


:ref:`24_backup-periodic_attributes`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/backup-periodic/{system}+{log}



.. raw:: html

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


:ref:`24_backup-periodic_attributes`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/backup-periodic



.. raw:: html

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


:ref:`24_backup-periodic_list`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

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


DELETE



.. raw:: html

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


/axapi/v3/backup-periodic/{system}+{log}



.. raw:: html

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


:ref:`24_backup-periodic_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _24_backup-periodic_list:

backup-periodic-list
--------------------


    backup-periodic-list is **JSON List** of :ref:`24_backup-periodic_attributes` 

        backup-periodic-list : [

             { :ref:`24_backup-periodic_attributes` },

             { :ref:`24_backup-periodic_attributes` },

             ...

         ]

.. _24_backup-periodic_attributes:

backup-periodic attributes
--------------------------

    **day**

        **Description** Specify interval days

        **Type:** number

        **Range:** 1-199

        **Mutual Exclusion:** day, hour, and week are mutually exclusive

    **hour**

        **Description** Specify interval hours

        **Type:** number

        **Range:** 1-65534

        **Mutual Exclusion:** hour, day, and week are mutually exclusive

    **log**

        **Description** Backup log files

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

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **system**

        **Description** Backup system files

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **week**

        **Description** Specify interval weeks

        **Type:** number

        **Range:** 1-199

        **Mutual Exclusion:** week, day, and hour are mutually exclusive