Backup Utility Commands and Options
Location
%plesk_dir%\bin\pleskbackup<br>where %plesk_dir% is an environment variable for Plesk installation directory. By default, it is "C:\Program Files\Parallels\Plesk".
Usage
pleskbackup <command> [<arguments>] [<options>]
Commands
Command | Argument | Description |
---|---|---|
|
|
Backs up all data related to the Plesk installation. |
|
|
Backs up all data for the resellers specified by usernames. Usernames should be separated by spaces and enclosed in quotes. Can be used with the If no usernames are specified and the |
|
|
Backs up all data for the resellers specified by IDs. IDs should be separated by spaces and enclosed in quotes. Can be used with the If no IDs are specified and the |
|
|
Backs up all data for the customers specified by usernames. Usernames should be separated by spaces and enclosed in quotes. Can be used with the If no usernames are specified and the |
|
|
Backs up all data for the customers specified by IDs. IDs should be separated by spaces and enclosed in quotation marks. Can be used with the If no IDs are specified and the |
|
|
Backs up all data for the subscriptions specified by domain names. Names should be separated by spaces and enclosed in quotation marks. Can be used with the If no names are specified and the |
|
|
Backs up all data for the subscriptions specified by IDs. IDs should be separated by spaces and enclosed in quotation marks. 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 usernames during backup. |
|
Skips resellers listed in the specified file during backup. |
|
Skips customer accounts with the specified usernames during backup. |
|
Skips customer accounts listed in the specified file during backup. |
|
Skips subscriptions with the specified names during backup. |
|
Skips subscriptions listed in the specified file during backup. |
|
Skips files and directories with the specified paths during backup. |
|
Skips files and directories listed in the specified file during backup. |
General Options
Option | Description |
---|---|
|
Shows more information about the backup process. |
|
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, then interpreted as being in bytes. If no argument is specified, the default value of 2 Gbytes is used. |
|
Sets that objects content is archived without compressing. |
|
Backs up only mail configuration and content. When used with the When used with the Cannot be used together with the |
|
Backs up only web hosting configuration and website content, including site applications, databases and subdomains. Cannot be used together with the |
|
Suspends sites during backup operation. |
|
Backs up resellers|customers|subscriptions 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|subscriptions, one per line. Used only with the Depending on the command, resellers|customers|subscriptions are listed in the file by either usernames or IDs. |
|
Sets that log files are not saved to backup. |
|
Adds 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 account username 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 the passive mode for 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 |