FABSYS_BACKUP-START(1)

NAME
fabsys_backup-start - Start a new FABS backup run

SYNOPSIS
fabsys backup-start [--note <note>] (--all | --volume <pattern>)

DESCRIPTION
The fabsys backup-start command creates and starts a new FABS backup run. This command does not wait for the backup run to finish; it just schedules the backup run and lets fabsys server actually process it.

OPTIONS

--all
    Backup all configured volumes. With this option specified, FABS will backup volumes according to "dump/include/*", "dump/exclude/*", and "dump/filter_cmd/*" configuration directives. See fabsys_config(1) for more details.

    You must specify either this option, or --volume, but not both.

--volume <pattern>
    Backup only the specified volume (or volume pattern). With this option specified, FABS will only try to backup volumes matching the specified pattern. The pattern is a simple shell-style glob (for example, "vol.*").

    You can only specify one pattern at once. If you wish to backup multiple different individual volumes (instead of all configured volumes), just issue fabsys backup-start multiple times, with different patterns.

    You must specify either this option, or --all, but not both.

--note <note>
    This option specifies a human-readable arbitrary "note" to be associated with this backup run. This can be used to indicate why a backup run is being created, and is displayed by fabsys backup-status when viewing the backup run's status. For example, you may want to specify a note of "daily backup for Fri Jun 19" or "retrying backup for app.perl58 after failure last night".

    By default, a note is added that indicates the backup run was initiated from a manual command-line invocation.

PRIVILEGED REQUIRED
The issuer of this command must be able to read the FABS configuration (specifically, the database access information), typically in /etc/fabs/fabs.yaml.d/.

COPYRIGHT
Copyright (c) 2015, Sine Nomine Associates.

See the provided LICENSE file for licensing terms.