Create New Backup Job

To create a new backup job, navigate to: "Backup Jobs" and Click on "Create New Backup Job". .

backup job page


Example configuration page for the backup job:

create backup job


Job Name

Specify an internal name for your job.


Destination

Choose a backup destination for this job.
You can find more details about backup destinations in the following Destinations Overview link.


Backup Type

  • Accounts - Copy files/folders from cPanel account that you choose to include (same as "/scripts/pkgacct").

You can choose to include/exclude the following:
cPanel Configurations
Home dir Files
Databases (Incremental backups is not supported for this type **)
Emails
Cron Jobs
DNS Zones
SSL Certificates

** In case of incremental job, all files included in this job are backed up incrementally with the exception of databases. Databases are regenerated and synced to the destination. Each job run will add the disk usage of each database dump file to the backup.

  • Directories - Copy server files/folders that you choose to include (not necessarily related to cPanel accounts).
  • Replicate - Copy files/folders "as is".

Backup Structure

  • Incremental - Copy only files (changed or new) since the last full backup.
  • Archived - Copy files to uncompressed archive (.tar file).
  • Compressed - Copy files to compressed archive (.tar.gz file).

For more information about the Backup Structure you can use for you destination go to Destinations Overview.


Account Filters

All accounts will be backed up unless a filter is created to exclude specific accounts.
You may use more than one filter type per backup job which will be joined together with an AND or OR statement.
AND - when using an AND statement between two filters the conditions of BOTH filters must be met in order for an account to be included by the backup job.
OR - when using an OR statement between two filters the condition of EITHER filters should be met in order for an account to be included by the backup job.

Examples:

All Accounts: {acct01,acct02,acct03}
Filter A: Account Filter, Include: {acct01, acct02}
Filter B: Account Filter, Include: {acct01}
Filter C: Account Filter, Exclude: {acct02}

Creating a filter with the following filter type combinations will provide these results:
Filter A AND Filter B => Only {acct01} will be backed up.
Filter B OR Filter C => Only {acct01, acct03} will be backed up.
Filter A OR Filter B => Only {acct01, acct02} will be backed up.
Filter A AND Filter B AND Filter C => Only {acct01} will be backed up.
Filter A OR Filter B AND Filter C => Only {acct01, acct02} will be backed up.

For more information about how to create new filter click on the following link: Create New Filter.


Directories and Files to Exclude

Choose directories to be excludes from backup, you can enter one or many.
Click Exclude Files link for more details.


Schedules

Click on Create Schedule for more details about schedules.
You can set multi-schedule for backup/clone/reindex jobs.
If multiple schedules sets to run at the same time only one snap will be stored for both.


Schedule Time

The time that you want the all schedules to be executed.


Limit Accounts to Backup

Setting this value to "10" will backup only 10 accounts for each cron run.
If the server has 60 accounts and the job is scheduled to run daily it will backup 10 accounts each time. In this scenario, fully backing up 60 accounts will take 6 days. The backup order is alphabetical.
This feature will not work with multi schedule job.


Maximum Execution Run Time

Maximum Execution Run Time in minutes.
Setting this value to "600" will backup only 10 hours for each cron run (Insert 0 to disable).
This feature will not work with multi schedule job.


Performance Override

Override the default performance settings for this specific job:
CloudLinux LVE/ionice/renice.
For more detail about performance options click Resource Settings.


Job Monitor

Choose whether to notify if there where no backups for x days and if job process runs more then x days. insert 0 to disable.


Pre/Post Job Scripts

If you want to add script to run before/after the job, paste it in the text box.