zetaback_agent - client-side component of zetaback.
zetaback_agent -v
zetaback_agent -l [-c conf]
zetaback_agent -r [-b <timestamp>] [-c conf] [-z zfs]
zetaback -f <timestamp> [-c conf] [-z zfs]
zetaback -i <timestamp> [-c conf] [-z zfs]
zetaback -d <snap> -z <zfs> [-c conf]
zetaback_agent handles requests from zetaback and performs the requested
operations on a host. Normally
zetaback_agent is only called by
zetaback and should never need to be invoked directly.
The following options are available:
- -c <conf>
- Use the specified file as the configuration file. The default file, if
none is specified is /usr/local/etc/zetaback_agent.conf. The prefix of
this file may also be specified as an argument to the configure
script.
- -d <snap>
- Delete the specified snapshot. Requires the use of -z to specify the ZFS
filesystem.
- -f <timestamp>
- Perform a full backup. The name of the backup will include
<timestamp>, which is provided by the backup server.
- -i <timestamp>
- Perform an incremental backup. The name of the backup will include
<timestamp>, which is provided by the backup server.
- -s <timestamp>
- Perform a dataset backup. The name of the backup will include
<timestamp>, which is provided by the backup server. This requires
the -i option to specify the base dataset the expected by the backup
server.
- -l
- List ZFS filesystems.
- -r
- Perform a restore.
- -b
- When performing a restore, if -b is specified, it informs the agent that
the receive command is an incremental based of the full snapshot with the
timestamp specified. The agent will unmount and rollback the filesystem
prior to applying the incremental in order to work around bug
6343779.
- -v
- Print the version number and exit.
- -z
- Specify a ZFS filesystem to backup, restore, or delete.
The zetaback_agent configuration file contains a pattern list of ZFS filesystems
to be backed up. The pattern list is a Perl-compatible regular expression
(PCRE). Only one 'pattern=' line is permitted.
The pattern acts as a filter to reduce the list of filesystems to be backed up.
Further excludes from this list are possible by setting a user property on any
filesystem that should not be backed up, even if it matches the pattern:
zfs set com.omniti.labs.zetaback:exclude=on pool/fs
User properties are available on Solaris 10 8/07 and newer, and on Solaris
Express build 48 and newer.
Once a pattern and/or exclude properties have been configured on a host, the
list of remaining filesystems can be validated by invoking zetaback_agent with
the -l option.
The zetaback_agent configuration file also has an option to not back up
filesystems that are part of an alternate/inactive boot environment. To enable
this option, add the following to the configuration file:
exclude_inactive_be=1
This pattern matches all ZFS filesystems.
pattern=.
This will match anywhere in the name of the ZFS filesystem. This is helpful for
catching all ZFS filesystems in a particular zpool, while excluding any
others.
pattern=zones
This pattern matches all ZFS filesystems whose names begin with 'www'.
pattern=^www
This pattern matches specific ZFS filesystems.
pattern=(?:data|mirrors|www)
All filesystems in pool 'zones' except 'foo'
pattern=^zones
(At a root shell or with pfexec/sudo):
zfs set com.omniti.labs.zetaback:exclude=on zones/foo
- zetaback_agent.conf
- The zetaback_agent configuration file. The location of the file can be
specified on the command line with the -c flag. The prefix of this file
may also be specified as an argument to the configure script.
zetaback(1)