`space`¶

backpy space¶

Actions related to creating and managing backup spaces.

Usage

backpy space [OPTIONS] COMMAND [ARGS]...

clear¶

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

Usage

backpy space clear [OPTIONS] BACKUP_SPACE

Options

-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 or interactive mode to print full error traces in case of a problem.

Arguments

BACKUP_SPACE¶: Required argument

create¶

Create backup spaces with different types.

Usage

backpy space create [OPTIONS] COMMAND [ARGS]...

file_system¶

Create a backup space with a ’NAME’ for a file system at a ’FILE_PATH’.

Usage

backpy space create file_system [OPTIONS] [NAME] [FILE_PATH]

Options

-i, --interactive¶: Create the backup in interactive mode.

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

-v, --verbose¶: Sets the verbosity level of the output.

-r, --remote <remote>¶: The name or UUID of the remote to which the backups for this backup space should be send.

--auto-delete-rule <auto_delete_rule>¶

The rule after which to choose the backup which should be automatically deleted. The possible values are: ‘oldest’ (the oldest backup), ‘newest’ (the newest backup), ‘largest’ (the backup with the largest file size’), ‘smallest’ (the backup with the smallest file size).

Options:: oldest | newest | largest | smallest

--auto-delete¶: Whether or not to automatically delete backups when the backup space is full or out of disk space.

--max-size <max_size>¶: The maximum disk usage of the backup space as an integer in bytes or as a string (e.g. ‘1 kB’).

--max-backups <max_backups>¶: The maximum allowed number of backups in the backup space.

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

--default-include <default_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!

--compression-level <compression_level>¶: The compression level to which the backed up files should be compressed. Depending on the compression algorithm this might not have an effect.

--compression-algorithm <compression_algorithm>¶

The compression algorithm to be used to compress the backed up files.

Options:: zip | gztar | bztar | xztar

Arguments

NAME¶: Optional argument

FILE_PATH¶: Optional argument

delete¶

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

Usage

backpy space delete [OPTIONS] BACKUP_SPACE

Options

-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 or interactive mode to print full error traces in case of a problem.

Arguments

BACKUP_SPACE¶: Required argument

edit¶

Edit backup spaces with different types.

Usage

backpy space edit [OPTIONS] COMMAND [ARGS]...

file_system¶

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

Usage

backpy space edit file_system [OPTIONS] BACKUP_SPACE

Options

--file-path <file_path>¶: The path to the directory that should be backed up.

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

-v, --verbose¶: Sets the verbosity level of the output.

-f, --force¶: Force changes that might lead to data loss. This will skip the confirmation step.

-r, --remote <remote>¶: The name or UUID of the remote to which the backups for this backup space should be send. If set to ‘None’, the existing remote will be removed.

--auto-delete-rule <auto_delete_rule>¶

Options:: oldest | newest | largest | smallest

--auto-delete <auto_delete>¶: Whether or not to automatically delete backups when the backup space is full or out of disk space.

--max-size <max_size>¶: The maximum disk usage of the backup space as an integer in bytes or as a string (e.g. ‘1 kB’).

--max-backups <max_backups>¶: The maximum allowed number of backups in the backup space.

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

--default-include <default_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!

--compression-level <compression_level>¶: The compression level to which the backed up files should be compressed. Depending on the compression algorithm this might not have an effect.

--compression-algorithm <compression_algorithm>¶

The compression algorithm to be used to compress the backed up files.

Options:: zip | gztar | bztar | xztar

Arguments

BACKUP_SPACE¶: Required argument

info¶

Get info about a ’BACKUP_SPACE’ identified by its UUID or name.

Usage

backpy space info [OPTIONS] BACKUP_SPACE

Options

-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

list¶

List information about the available backup spaces.

Usage

backpy space list [OPTIONS]

Options

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

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