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
pleskbackup <command> [<arguments>] [<options>]
Commands
Command Argument Description

server

 

Backs up whole Plesk server.

resellers-name

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

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

If no logins 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, if on Windows, 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

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

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

If no logins are specified and the -f option is not used, all customers 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, if on Windows, 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 IDs are specified and the -f option is not used, all customers are backed up.

domains-name

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

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

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

domains-id

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

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

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

--help

 

Displays help on the utility usage.

Exclude Options
Option Description

--exclude-reseller[=<login1>,<login2>,...]

Skips resellers with the specified logins during backup.

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

Skips resellers listed in the specified file during backup.

--exclude-client=[<login1>,<login2>,...]

Skips customers with the specified logins during backup.

--exclude-client-file=<file>

Skips customers listed in the specified file during backup.

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

Skips domain with the specified names during backup.

--exclude-domain-file=<file>

Skips domains listed in the specified file during backup.

General Options
Option Description

-v|--verbose

Shows more information about the backup process. Multiple -v options increase verbosity. For the maximum verbosity level, define 5 options.

-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, size is interpreted as being in bytes.

If no argument is specified, a default value of 2 Gbytes is used.

-z|--no-gzip

Sets that object 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, also backs up server-wide mail configuration.

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

--only-hosting

Backs up only physical hosting configuration and Web site content, including site applications, databases and subdomains.

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

--suspend

Suspends domains during backup operation.

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

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

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

--skip-logs

Sets that log files are not saved to backup.

--prefix=<string>

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

--ftp-login=<ftp_login>

Specifies FTP login 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 a passive mode 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://[<login>[:<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 a password.

The --ftp-login and --ftp-password FTP options can be used for setting login 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.