Backup Utility Commands and Options
Location
$PRODUCT_ROOT_D/bin/pleskbackup
where the $PRODUCT_ROOT_D
is /usr/local/psa
for RPM-based systems or /opt/psa
on DEB-based systems.
Usage
Commands
Command | Argument | Description |
---|---|---|
|
|
Backs up whole Plesk server. |
|
|
Backs up all data for the resellers specified by logins. Logins should be separated by spaces, and, if on Windows, enclosed in quotes. Can be used with the If no logins are specified and the |
|
|
Backs up all data for the resellers specified by IDs. IDs should be separated by spaces, and, if on Windows, enclosed in quotes. Can be used with the If no IDs are specified and the |
|
|
Backs up all data for the customers specified by logins. Logins should be separated by spaces, and, if on Windows, enclosed in quotes. Can be used with the If no logins are specified and the |
|
|
Backs up all data for the customers specified by IDs. IDs should be separated by spaces, and, if on Windows, enclosed in quotes. Can be used with the If no IDs are specified and the |
|
|
Backs up all data for the domains specified by names. Names should be separated by spaces, and, if on Windows, enclosed in quotes. Can be used with the If no names are specified and the |
|
|
Backs up all data for the domains specified by IDs. IDs should be separated by spaces, and, if on Windows, enclosed in quotes. Can be used with the If no IDs are specified and the |
|
|
Displays help on the utility usage. |
Exclude Options
Option | Description |
---|---|
|
Skips resellers with the specified logins during backup. |
|
Skips resellers listed in the specified file during backup. |
|
Skips customers with the specified logins during backup. |
|
Skips customers listed in the specified file during backup. |
|
Skips domain with the specified names during backup. |
|
Skips domains listed in the specified file during backup. |
General Options
Option | Description |
---|---|
|
Shows more information about the backup process. Multiple |
|
Backs up only configurations of Plesk objects, excluding their content. |
|
Splits the backup files into parts of the specified size. The parts are numbered by appending numerical suffixes starting with Size is specified in Kbytes, Mbytes or Gbytes. If none is defined, size is interpreted as being in bytes. If no argument is specified, a default value of 2 Gbytes is used. |
|
Sets that object content is archived without compressing. |
|
Backs up only mail configuration and content. When used with the When used with the Cannot be used with the |
|
Backs up only physical hosting configuration and Web site content, including site applications, databases and subdomains. Cannot be used with the |
|
Suspends domains during backup operation. |
|
Backs up resellers|customers|domains listed in the specified file, ignoring those specified in the command line as arguments. The file should be in plain text format and should contain a list of resellers|customers|domains, one per line. Used only with the Depending on the command, resellers|customers|domains are listed in the file by either logins or IDs. |
|
Sets that log files are not saved to backup. |
|
Adds a specified prefix to the backup file names. Used to customize backup file name which is created with the backup prefix by default. |
FTP Options
Option | Description |
---|---|
|
Specifies FTP login that will be used for uploading backup file to the FTP server. |
|
Specifies password that will be used for uploading backup file to the FTP server. |
|
Specifies that a passive mode FTP connection should be used. |
Output File Option
Option | Description |
---|---|
|
Exports backup as a single file to |
|
Exports backup as a single file with the specified name to a local file system and removes backup from Plesk's storage. |
|
Exports backup as a single file to the specified FTP server and removes backup from Plesk's storage. The The |