Skip to content

Latest commit

 

History

History
168 lines (102 loc) · 4.41 KB

znapzend.pod

File metadata and controls

168 lines (102 loc) · 4.41 KB
Raw

NAME

znapzend - znapzend daemon

SYNOPSIS

znapzend [options...]

--man              show man-page and exit
-h,--help          display this help and exit
-d,--debug         print debug messages to STDERR
-n,--noaction      run in simulation mode. does no changes to the filesystem
--nodestroy        does all changes to the filesystem except destroy
--logto=x          select where to log to (syslog::<facility> or <filepath>)
--loglevel=x       define the log level when logging to file
--pidfile=x        write a pid file when running in daemon mode
--daemonize        fork into the background
--runonce=x        run one round on source dataset x
--features=x       comma separated list of features to be enabled
--connectTimeout=x sets the ConnectTimeout for ssh commands
--autoCreation     automatically create dataset on dest if it not exists

DESCRIPTION

ZnapZend is a snapshot based zfs backup daemon creating snapshots on a scheduled basis on the source filesystem and on destination filesystems.

ZnapZend reads its configuration from custom properties in the fileset. Use znapzendzetup to set these properties.

-d, --debug

talk a lot while running. Sends debug messages to stderr.

-n, --noaction

don't do any actions which have lasting effect. Ideal to try our new new configurations together with --debug

--nodestroy

do all changes to the filesystem except destroy old snapshots

--logto={syslog::facility|filepath}

send logs out to either syslog or a logfile. Default is to send logs to syslog::daemon when runing daemonized. When running in debug mode, the logs will go to STDERR by default.

Examples:

--logto=/var/log/znapzend.log
--logto=syslog::daemon
--loglevel={debug|info|warning|err|alert}

Define the log level when logging to file. Default is debug.

--pidfile=path

write a pid file when running in daemon mode pidfile defaults to /var/run/znapzend.pid if no pidfile is given

--daemonize

Fork into the background.

--runonce=fileset

run one round on source fileset. This is very useful for testing. Use it in connection with --noaction and --debug while testing your new configuration

--features=feature1,feature2,...

enables enhanced zfs features not supported by all zfs implementations. Do not enable features unless you are sure your zfs supports it

Available features:

oracleMode

working around the following zfs issues we have seen on oracle:

  • The multi snapshot destroy syntax is not available. So stick to destroying them individually.

  • Sometimes a snapshot can not be destroyed because of some oracle zfs bug. Only a reeboot seems to be able to fix this. So we just destroy the ones we can destroy. Logging an error about the problem

recvu

use the -u option on the receive end, to keep the destination zfs filesystems unmounted.

pfexec

use 'pfexec' for zfs commands (e.g. when running znapzend as non-priviledged user)

sudo

use 'sudo' for zfs commands (e.g. when running znapzend as non-priviledged user)

--connectTimeout=timeout

sets the ssh connection timeout (in seconds)

--autoCreation

Automatically create a dataset on a destination host if it's not there yet.

EXAMPLE

To test a new config

znapzend --debug --noaction --runonce=tank/test

To run as a daemon

znapzend --daemonize --pidfile=/var/run/znapzend.pid --logto=syslog::daemon

COPYRIGHT

Copyright (c) 2014 by OETIKER+PARTNER AG. All rights reserved.

LICENSE

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

AUTHOR

Tobias Oetiker <[email protected]>, Dominik Hassler <[email protected]>

HISTORY

2014-06-01 had Multi destination backup
2014-05-30 had Initial Version