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

--server

 

Backs up all data related to the Plesk installation.

--resellers-name

[<username-1> <username-2> <...> <username-n>]

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 --from-file option. In such case, resellers specified in the file are backed up and resellers specified as command arguments are ignored.

If no usernames are specified and the -f option is not used, all resellers are backed up.

--resellers-id

[<ID1> <ID2> <...> <IDn>]

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 --from-file option. In such case, resellers specified in the file are backed up and resellers specified as command arguments are ignored.

If no IDs are specified and the -f option is not used, all resellers are backed up.

--clients-name

[<username-1> <username-2> <...> <username-n>]

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 --from-file option. In such case, customers specified in the file are backed up and customers specified as command arguments are ignored.

If no usernames are specified and the -f option is not used, all customer accounts are backed up.

--clients-id

[<ID1> <ID2> <...> <IDn>]

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 --from-file option. In such case, customers specified in the file are backed up and customers specified as command arguments are ignored.

If no IDs are specified and the -f option is not used, all customer accounts are backed up.

--domains-name

[<name-1> <name-2> <...> <name-n>]

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 --from-file option. In such a case, subscriptions specified in the file are backed up and subscriptions specified as command arguments are ignored.

If no names are specified and the -f option is not used, all subscriptions are backed up.

--domains-id

[<ID1> <ID2> <...> <IDn>]

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 --from-file option. In such case, subscriptions specified in the file are backed up and subscriptions specified as command arguments are ignored.

If no IDs are specified and the -f option is not used, all subscriptions are backed up.

--help

 

Displays help on the utility usage.

 

Exclude Options
Option Description

--exclude-reseller[=<username1>,<username2>,...]

Skips resellers with the specified usernames during backup.

--exclude-reseller-file[=<file>]

Skips resellers listed in the specified file during backup.

--exclude-client=[<username1>,<username2>,...]

Skips customer accounts with the specified usernames during backup.

--exclude-client-file=<file>

Skips customer accounts listed in the specified file during backup.

--exclude-domain[=<name1>,<name2>,...]

Skips subscriptions with the specified names during backup.

--exclude-domain-file=<file>

Skips subscriptions listed in the specified file during backup.

--exclude-pattern [=<path1>,<path2>,...]

Skips files and directories with the specified paths during backup.

--exclude-pattern-file=<file>

Skips files and directories listed in the specified file during backup.

 

General Options
Option Description

-v|--verbose

Shows more information about the backup process.

-c|--configuration

Backs up only configurations of Plesk objects, excluding their content.

-s|--split[=<integer>[K|M|G]]

Splits the backup files into parts of the specified size. The parts are numbered by appending numerical suffixes starting with .1.

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.

-z|--no-gzip

Sets that objects content is archived without compressing.

--only-mail

Backs up only mail configuration and content.

When used with the resellers|clients|domains-login|id commands, backs up configuration of domain-level mail system, and content and configuration of mail accounts.

When used with the server command, backs up also server-wide mail configuration.

Cannot be used together with the --only-hosting option.

--only-hosting

Backs up only web hosting configuration and website content, including site applications, databases and subdomains.

Cannot be used together with the --only-mail option.

--suspend

Suspends sites during backup operation.

-f| --from-file=<file>

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 resellers-name, resellers-id, clients-name, clients-id, domains-name, domains-id commands.

Depending on the command, resellers|customers|subscriptions are listed in the file by either usernames or IDs.

--skip-logs

Sets that log files are not saved to backup.

--prefix=<string>

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

--ftp-login=<ftp_username>

Specifies FTP account username that will be used for uploading backup file to the FTP server.

--ftp-password=<ftp_password>

Specifies password that will be used for uploading backup file to the FTP server.

--ftp-passive-mode

Specifies that the passive mode for FTP connection should be used.

 

Output File Option
Option Description

--output-file

Exports backup as a single file to stdout and removes backup from Plesk's storage.

--output-file=<fullpath/filename>

Exports backup as a single file with the specified name to a local file system and removes backup from Plesk's storage.

--output-file=<ftp://[<username>[:<password>]@]<server>/<filepath>>

Exports backup as a single file to the specified FTP server and removes backup from Plesk's storage.

The FTP_PASSWORD environment variable can be used for setting password.

The --ftp-login and --ftp-password FTP options can be used for setting username and password.

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.