schedule

backpy schedule

Actions related to scheduling for automatic backups.

Usage

backpy schedule [OPTIONS] COMMAND [ARGS]...

activate

Activate a ’SCHEDULE’ identified by its UUID. Alternatively every schedule for a specific backup space can be activated by not providing a schedule and instead providing the name or UUID of a backup space to the –backup-space option.

Usage

backpy schedule activate [OPTIONS] [SCHEDULE]

Options

-b, --backup-space <backup_space>

-f, --force

Force the activation of the schedule. 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

Activate the schedule(s) in interactive mode.

Arguments

SCHEDULE

Optional argument

create

Creates a schedule for a BACKUP_SPACE given a specific UNIX cron TIME_PATTERN.

Usage

backpy schedule create [OPTIONS] [BACKUP_SPACE] [TIME_PATTERN]

Options

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

-l, --location <location>

The location(s) to save the backup at.

Options:

all | local | remote

-D, --description <description>

The description of the schedule.

-a, --activate <activate>

Whether to activate the schedule after creation

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

Arguments

BACKUP_SPACE

Optional argument

TIME_PATTERN

Optional argument

deactivate

Deactivate a ’SCHEDULE’ identified by its UUID. Alternatively every schedule for a specific backup space can be deactivated by not providing a schedule and instead providing the name or UUID of a backup space to the –backup-space option.

Usage

backpy schedule deactivate [OPTIONS] [SCHEDULE]

Options

-b, --backup-space <backup_space>

-f, --force

Force the deactivation of the schedule. 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

Deactivate the schedule(s) in interactive mode.

Arguments

SCHEDULE

Optional argument

delete

Delete a ’SCHEDULE’ identified by its UUID. Alternatively every schedule for a specific backup space can be deleted by not providing a schedule and instead providing the name or UUID of a backup space to the –backup-space option.

Usage

backpy schedule delete [OPTIONS] [SCHEDULE]

Options

-b, --backup-space <backup_space>

-f, --force

Force the deletion of the schedule. 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 schedule(s) in interactive mode.

Arguments

SCHEDULE

Optional argument

info

Get info about a ’SCHEDULE’ identified by its UUID.

Usage

backpy schedule info [OPTIONS] [SCHEDULE]

Options

--show-command

Show the command that is saved in the Cronjob.

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

Arguments

SCHEDULE

Optional argument

list

List all schedules.

Usage

backpy schedule list [OPTIONS]

Options

--backup-space <backup_space>

Backup space to list the schedules for

--active-only

List only active schedules.

--depth <depth>

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

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