pleskbackup: Backing Up Content and Configuration
The pleskbackup utility is used for backing up configuration and data.
Usage
pleskbackup <command> [<arguments>] [<options>]
To back up the Plesk server excluding the customers listed in the file customers.txt:
Example
The following command backs up the Plesk server excluding the domains listed in the file domains.txt with displaying information about the backup process:
plesk bin pleskbackup server --exclude-client-file=domains.txt -v
Commands
1. serverBacks up whole Plesk server.
To back up the whole Plesk server:
plesk bin pleskbackup server
2. 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.
To back up the reseller with the login name reseller1:
plesk bin pleskbackup resellers-name reseller1
3. 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.
To back up the reseller with id 1:
plesk bin pleskbackup resellers-id 1
4. 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.
To back up all data for the customers specified by the logins user1 and user2:
plesk bin pleskbackup clients-name user1 user2
5. 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.
To back up the customer with id 1:
plesk bin pleskbackup clients-id 1
6. 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.
To back up the domain with the name example.net:
plesk bin pleskbackup domains-name example.net
7. 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.
To back up the domain with id 1:
plesk bin pleskbackup domains-id 1
8. --help or -hDisplays help on the utility usage.
To see the help on the utility usage:
plesk bin pleskbackup --help
or
plesk bin pleskbackup -h
9. --suspendSuspends domains during backup operation.
To back up the Plesk server with suspending domains during the backup operation:
plesk bin pleskbackup server --suspend
10. --incrementalCreates incremental backup - a backup that contains only the data that was changed since the time of the last previously created backup. If there is no full backup available, this option will be ignored.
To create an incremental backup of the Plesk server:
plesk bin pleskbackup server --incremental
11. --ftp-login= <ftp_login>Specifies FTP login that will be used for uploading backup file to the FTP server.
To back up the Plesk server with specifying FTP user login and password that will be used for updoading the backup file to the FTP server:
plesk bin pleskbackup server --ftp-login=ftpuser1
12. --ftp-passive-modeSpecifies that a passive mode FTP connection should be used.
To back up the Plesk server with passive FTP mode:
plesk bin pleskbackup server --ftp-passive-mode
13. --exclude-reseller=[ <login1>,<login2> ,...]Skips resellers with the specified logins during backup.
To back up the Plesk server excluding the resellers with the login names reseller1 and r eseller2:
plesk bin pleskbackup server --exclude-reseller=reseller1,reseller2
14. --exclude-reseller-file=[ <file> ]Skips resellers listed in the specified file during backup.
To back up the Plesk server excluding the resellers specified in the file resellers.txt:
plesk bin pleskbackup server --exclude-reseller-file=resellers.txt
15. --exclude-logsSkip log files during backup.
To back up the Plesk server excluding log files:
plesk bin pleskbackup server --exclude-logs
