Planning Your Data Protection

When it comes to local filesystem protection, you're limited to running the SHIELD agent on the machine with the disks attached to it.

System Prerequisites

SHIELD can natively read and write files without any help from any external tools or utilities.

Configuring Backup Jobs

How you snapshot your filesystem is highly specific on the types of files you've got and what's in them. The most straightforward approach is to back up everything. However, there may be times where you know you don't want specific files. Still other times, you know exactly what you want.

It's entirely up to you.

Backing up Everything

The default configuration of the Local Filesystem backup plugin is to protect aevery single file and directory found, without discrimination.

You dont' have to do anything — just make sure to leave the Files to Include and Files to Exclude parameters blank (their default values)!

Excluding Files

Not all files and directory are created equally. Sometimes, tools leave temporary files, scratch files and primitive backup files lying around. You may not want these taking up space in storage. Sometimes, it's faster to just regenerate missing compiled files from their more important source file brethren.

For those scenarios, you can make use of the Files to Exclude parameter to specify a file name or file name pattern to skip while traversing the base directory.

If a file name matches the exclusion pattern, it will be omitted from the snapshot archive.

If a directory name matches the pattern, it will be skipped, and none of the files or sub-directories underneath it will be included.

Including Files

Some times, it's easier to be explicit about what you want to protect. With the Local Filesystem plugin, you can do that via the Files to Include parameter. Specify a file name pattern (or, more rarely, an explicit file name), and SHIELD will only consider files matching the pattern for inclusion in the snapshot archive.

Note: unlike the Files to Exclude parmeter, Files to Include is not applied to directory names as the plugin traverses the hierarchy. This makes it possible to include something like *.db, and have it work properly with sub-directories.

File inclusion rules are processed before file exclusion rules.

Strict Mode

By default, the file hierarchy walker will ignore files that go missing between the time it enumerates a directory entry and the time it actually attempts to access the child file entry. This makes it more robust in the face of small temporary files popping into and out of existence as the backup is being taken.

If that is not desirable behavior, however, and you would rather have the entire snapshot archive be considered invalid or unusable, you may enable the Strict Mode parameter when you configure the data system. This will cause the plugin to treat such missing files as fatal errors, halting the backup oepration and marking the data system as unhealthy.

Restoring Snapshots

When a filesystem archive is restored, the Base Directory is not removed from the disk. Instead, any missing directories from the snapshot archive are created, and files from the snapshot reconstituted. This is an additive restore.

Configuration Reference

This section details all available configuration parameters for the Local Filesystem data protection plugin.

Base Directory
Absolute path of the directory to backup.
Files to Include
Only files that match this pattern will be included in the backup archive. If not specified, all files will be included.
Files to Exclude
Files that match this pattern will be excluded from the backup archive. If not specified, no files will be excluded.
Strict Mode
If files go missing while walking the directory, consider that a fatal error.
Verbose Logging
List the names of files included in the backup.