`backup`¶

backpy backup¶

Actions related to creating and managing backups.

Usage

backpy backup [OPTIONS] COMMAND [ARGS]...

create¶

Create a new backup for a ’BACKUP_SPACE’ identified by its UUID or name.

Usage

backpy backup create [OPTIONS] [BACKUP_SPACE]

Options

-l, --location <location>¶

The location(s) to save the backup at.

Options:: all | local | remote

-c, --comment <comment>¶: A custom comment describing the backup contents.

-I, --include <include>¶: A list of elements (e.g. paths, patterns, tables, databases) to include. If not set, every non-excluded element will be used backed up. Depending on the Backup Space this might not have an effect. Important: Symbols like ‘,’ and ‘”’ have to be escaped!

-X, --exclude <exclude>¶: A list of elements (e.g. paths, patterns, tables, databases) to exclude. Depending on the Backup Space this might not have an effect. Important: Symbols like ‘,’ and ‘”’ have to be escaped!

--lock¶: Whether to lock the backup, meaning it cannot be deleted automatically.

-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 backup in interactive mode.

Arguments

BACKUP_SPACE¶: Optional argument

delete¶

Delete a ’BACKUP’ identified by its UUID or a keyword (‘latest’, ‘oldest’ or ‘largest’, ‘smallest’) from a ’BACKUP_SPACE’ identified by its UUID or name.

Usage

backpy backup delete [OPTIONS] [BACKUP_SPACE] [BACKUP]

Options

-f, --force¶: Force the deletion of the backup. This will skip the confirmation step.

-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¶: Delete the backup in interactive mode.

Arguments

BACKUP_SPACE¶: Optional argument

BACKUP¶: Optional argument

info¶

Get info about a ’BACKUP’ identified by its UUID or a keyword (‘latest’, ‘oldest’ or ‘largest’, ‘smallest’) from a ’BACKUP_SPACE’ identified by its UUID or name.

Usage

backpy backup info [OPTIONS] [BACKUP_SPACE] [BACKUP]

Options

--check-hash¶: Whether to check the SHA256 hash of the backups.

-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¶: Get information about a backup in interactive mode.

Arguments

BACKUP_SPACE¶: Optional argument

BACKUP¶: Optional argument

list¶

List all backups in a ’BACKUP_SPACE’ identified by its UUID or name.

Usage

backpy backup list [OPTIONS] BACKUP_SPACE

Options

-s, --sort-by <sort_by>¶

The property to sort the backups by.

Options:: date | size

--depth <depth>¶: The amount of details to show for each remote. Default is 1.

--check-hash¶: Whether to check the SHA256 hash of the file.

-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.

Arguments

BACKUP_SPACE¶: Required argument

lock¶

Lock a ’BACKUP’ identified by its UUID or a keyword (‘latest’, ‘oldest’ or ‘largest’, ‘smallest’) from a ’BACKUP_SPACE’ identified by its UUID or name. A locked backup cannot be deleted automatically (e.g. if the backup space is full).

Usage

backpy backup lock [OPTIONS] [BACKUP_SPACE] [BACKUP]

Options

-f, --force¶: Force the locking of the backup. This will skip the confirmation step.

-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¶: Lock the backup in interactive mode.

Arguments

BACKUP_SPACE¶: Optional argument

BACKUP¶: Optional argument

restore¶

Restore a ’BACKUP’ identified by its UUID or a keyword (‘latest’, ‘oldest’ or ‘largest’, ‘smallest’) to a ’BACKUP_SPACE’ identified by its UUID or name.

Usage

backpy backup restore [OPTIONS] [BACKUP_SPACE] [BACKUP]

Options

--incremental <incremental>¶: Restore the backup incrementally. This means that only content, which is included in the backup will be affected. If this is ‘False’, the contents will be deleted and replaced by the backed up content.

-s, --source <source>¶

The location from which to restore the backup.

Options:: local | remote

-f, --force¶: Force the deletion of the backup. This will skip the confirmation step.

-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¶: Delete the backup in interactive mode.

Arguments

BACKUP_SPACE¶: Optional argument

BACKUP¶: Optional argument

unlock¶

Unlock a ’BACKUP’ identified by its UUID or a keyword (‘latest’, ‘oldest’ or ‘largest’, ‘smallest’) from a ’BACKUP_SPACE’ identified by its UUID or name. An unlocked backup can be deleted automatically (e.g. if the backup space is full).

Usage

backpy backup unlock [OPTIONS] [BACKUP_SPACE] [BACKUP]

Options

-f, --force¶: Force the locking of the backup. This will skip the confirmation step.

-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¶: Lock the backup in interactive mode.

Arguments

BACKUP_SPACE¶: Optional argument

BACKUP¶: Optional argument