remote

backpy remote

Actions related to remote locations to save backups at.

Usage

backpy remote [OPTIONS] COMMAND [ARGS]...

create

Create a remote to save backups at.

Usage

backpy remote create [OPTIONS]

Options

-n, --name <name>

The alias of the remote.

-p, --protocol <protocol>

The transfer protocol to use for the file up- and download.

Options:

scp | sftp

-h, --hostname <hostname>

The hostname / IP of the remote server.

-u, --username <username>

The name of the user to connect with.

-k, --key <key>

The path to a SSH-Key to use for connecting to the remote. This requires the chosen protocol to support SSH key authentication. The given file may be protected with a passphrase which has to be entered interactively. The usage of SSH keys is optional but recommended if possible.

--use-system-keys <use_system_keys>

Whether to attempt the usage of keys saved in the system’s agent.

--timeout <timeout>

The time in seconds to wait for the connection to complete.

--root-dir <root_dir>

The backpy root directory on the remote server. If not set, the default value set in the variable configuration is used.

--sha256-cmd <sha256_cmd>

The shell command to calculate a file’s SHA-256 sum on the remote server. If not set, the default value set in the variable configuration is used.

-v, --verbose

Sets the verbosity level of the output.

-d, --debug

Activate the debug log for the command or interactive mode to print full error traces in case of a problem.

-i, --interactive

Create the remote in interactive mode.

delete

Delete a ’REMOTE’ identified by its name or UUID.

Usage

backpy remote delete [OPTIONS] REMOTE

Options

--delete-files

Delete all backup spaces on the remote.

-f, --force

Force the deletion. This will skip the confirmation step.

-v, --verbose

Sets the verbosity level of the output.

-d, --debug

Activate the debug log for the command to print full error traces in case of a problem.

Arguments

REMOTE

Required argument

edit

Edit a ’REMOTE’ identified by its name or UUID.

Usage

backpy remote edit [OPTIONS] REMOTE

Options

-n, --name <name>

The alias of the remote.

-p, --protocol <protocol>

The transfer protocol to use for the file up- and download.

Options:

scp | sftp

-h, --hostname <hostname>

The hostname / IP of the remote server.

-u, --username <username>

The name of the user to connect with.

-k, --key <key>

The path to a SSH-Key to use for connecting to the remote. This requires the chosen protocol to support SSH key authentication. The given file may be protected with a passphrase which has to be entered interactively. The usage of SSH keys is optional but recommended if possible.

--password

Whether to change the password / passphrase. Do not enter a password here! This will trigger a dialog to change the password in!

--use-system-keys <use_system_keys>

Whether to attempt the usage of keys saved in the system’s agent.

--timeout <timeout>

The time in seconds to wait for the connection to complete.

--root-dir <root_dir>

The backpy root directory on the remote server. If not set, the default value set in the variable configuration is used.

--sha256-cmd <sha256_cmd>

The shell command to calculate a file’s SHA-256 sum on the remote server. If not set, the default value set in the variable configuration is used.

-v, --verbose

Sets the verbosity level of the output.

-d, --debug

Activate the debug log for the command to print full error traces in case of a problem.

Arguments

REMOTE

Required argument

info

Show information about a specific ’REMOTE’ identified by its name or UUID.

Usage

backpy remote info [OPTIONS] REMOTE

Options

-d, --debug

Activate the debug log for the command to print full error traces in case of a problem.

Arguments

REMOTE

Required argument

list

List information about the available remotes.

Usage

backpy remote list [OPTIONS]

Options

--depth <depth>

The amount of details to show for each remote. Default is 1.

-d, --debug

Activate the debug log for the command to print full error traces in case of a problem.

test

Test the connection of a ’REMOTE’ identified by its name or UUID.

Usage

backpy remote test [OPTIONS] REMOTE

Options

-v, --verbose

Sets the verbosity level of the output.

-d, --debug

Activate the debug log for the command to print full error traces in case of a problem.

Arguments

REMOTE

Required argument