The backup-storage utility is used for managing remote FTP storages that contain Plesk server backups.

Usage 

backup-storage <command> [<arguments>] [<options>]

Example

The following command disables the remote FTP storage of the reseller John Doe:

plesk bin backup-storage --disable ftp -reseller jdoe

Commands

Command

Argument

Description

Example

--enable

<ftp|google-drive-backup|...>

Enables the specified backup storage.

To enable the remote storage on Google Drive:

plesk bin backup-storage --enable google-drive-backup

--disable

<ftp|google-drive-backup|...>

Disables the specified backup storage.

To disable the FTP remote storage:

plesk bin backup-storage --disable ftp

--configure

<ftp>

Configures the specified FTP storage.

To set the credentials and the IP address of the FTP storage:

SET FTP_PASSWORD=<****> plesk bin backup-storage --configure ftp -server -ftp-login <ftp_user> -ftp-password -ftp-server <FTP_server_IP_address>

--list-backups

<server|ftp|google-drive-backup|...>

Shows the list of backups on the specified remote storage.

To see the list of backups stored remotely on Google Drive:

plesk bin backup-storage --list-backups google-drive-backup

--enable-password-protection

Enables password protection for backups on remote storage. To set the password, use the ‘PLESK_BACKUP_PASSWORD’ environment variable.

To enable password protection for the server-level backups on remote storage:

SET PLESK_BACKUP_PASSWORD=<****> plesk bin backup-storage --enable-password-protection -server

--disable-password-protection

Disables password protection for backups on remote storage.

To disable password protection for backups of the reseller John Doe on remote storage:

plesk bin backup-storage --disable-password-protection -reseller jdoe

--help or --h

<hourly|daily|weekly|monthly>

Displays the help reference for the utility.

To see the utility help:

plesk bin backup-storage --help

Options

Option

Parameter

Description

Example

-server

Specifies the server-level backup storage. This is the default option.

Used only with the --enable, --disable, --configure, --enable-password-protection, and --disable-password-protection commands.

To enable remote FTP storage for the server-level backups:

plesk bin backup-storage --enable ftp -server

-reseller

<login_name>

Specifies the reseller whose backups on remote storages will be affected by the command.

Used only with the --enable, --disable, --configure, --run, and --list commands.

To enable remote FTP storage for the reseller John Doe:

plesk bin backup-storage --enable ftp -reseller jdoe

-customer

<login_name>

Specifies the customer whose backups on remote storages will be affected by the command.

Used only with the --enable, --disable, --configure, --enable-password-protection, and --disable-password-protection commands.

To disable remote Google Drive storage of the customer John Doe:

plesk bin backup-storage --disable google-drive-backups -customer jdoe

-subscription

<domain_name>

Specifies the domain's subscription whose backups on remote storages will be affected by the command.

Used only with the --enable, --disable, --configure, --enable-password-protection, and --disable-password-protection commands.

To enable remote FTP storage for the domain “example.com”:

plesk bin backup-storage --enable ftp -subscription example.com

-ftp-login

<ftp_login>

Specifies the FTP server login.

Used only with the --configure command.

To set “jdoe” as the login for the remote FTP server:

plesk bin backup-storage --configure ftp -ftp-login jdoe

-ftp-password

Specifies that the FTP password is set using the ‘FTP_PASSWORD’ environment variable.

Used only with the --configure command.

To use the FTP password set using the ‘FTP_PASSWORD’ environment variable:

plesk bin backup-storage --configure ftp -server <FTP_server_IP_address> -ftp-password

-ftp-server

<ftp_server>

Specifies the FTP server hostname or IP address.

Used only with the --configure command.

To set “example.com” as the FTP server hostname:

plesk bin backup-storage --configure ftp -ftp-server example.com

-ftp-path

<ftp_path>

Specifies the path to the directory for storing backups on the FTP server.

Used only with the --configure command.

To store backups in the backups directory on the FTP server:

plesk bin backup-storage --configure ftp -ftp_path backups

-ftp-passive-mode

<true|false>

Enables/disables the use of passive FTP mode.

Used only with the --configure command.

To make the Plesk server use passive FTP mode when uploading files to remote storage:

plesk bin backup-storage --configure ftp -ftp-passive-mode true

-use-ftps

<true|false>

Enables/disables the use of the FTPS protocol.

Used only with the --configure command.

To make the Plesk server use the FTPS protocol when uploading files to remote storage:

plesk bin backup-storage --configure ftp -use-ftps true

-json

Displays the output in the JSON format (if true) or in plain text format (if false).

Used only with the --list-backups command.

To display the list of remote backups in the JSON format:

plesk bin backup-storage --list-backups ftp -json