third-party-mirrors/zfs_autobackup
1
0
Fork 1
mirror of https://github.com/psy0rz/zfs_autobackup.git synced 2025-04-13 22:47:12 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
DatuX 2016-03-31 16:12:16 +02:00
parent 0caedeae74
commit a4ca038bfa
1 changed files with 30 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -28,8 +28,10 @@ Usage
``` ```
usage: zfs_autobackup [-h] [--ssh-source SSH_SOURCE] [--ssh-target SSH_TARGET] usage: zfs_autobackup [-h] [--ssh-source SSH_SOURCE] [--ssh-target SSH_TARGET]
[--ssh-cipher SSH_CIPHER] [--keep-source KEEP_SOURCE] [--ssh-cipher SSH_CIPHER] [--keep-source KEEP_SOURCE]
[--keep-target KEEP_TARGET] [--finish] [--compress] [--keep-target KEEP_TARGET] [--no-snapshot] [--no-send]
[--test] [--verbose] [--debug] [--destroy-stale] [--clear-refreservation]
[--clear-mountpoint] [--rollback] [--compress] [--test]
[--verbose] [--debug]
backup_name target_fs backup_name target_fs
ZFS autobackup v2.0 ZFS autobackup v2.0
@ -51,16 +53,32 @@ optional arguments:
--ssh-cipher SSH_CIPHER --ssh-cipher SSH_CIPHER
SSH cipher to use (default arcfour128) SSH cipher to use (default arcfour128)
--keep-source KEEP_SOURCE --keep-source KEEP_SOURCE
Number of old snapshots to keep on source. Default 30. Number of days to keep old snapshots on source.
Default 30.
--keep-target KEEP_TARGET --keep-target KEEP_TARGET
Number of old snapshots to keep on target. Default 30. Number of days to keep old snapshots on target.
--finish dont create new snapshot, just finish sending current Default 30.
snapshots --no-snapshot dont create new snapshot (usefull for finishing
--compress use compression during zfs send/recv uncompleted backups, or cleanups)
--test dont change anything, just show what would be done --no-send dont send snapshots (usefull to only do a cleanup)
(still does all read-only operations) --destroy-stale Destroy stale backups that have no more snapshots. Be
--verbose verbose output sure to verify the output before using this!
--debug debug output (shows commands that are executed) --clear-refreservation
Set refreservation property to none for new
filesystems. Usefull when backupping SmartOS volumes.
--clear-mountpoint Clear mountpoint property, to prevent the received
filesystem from mounting over existing filesystems.
--rollback Rollback changes on the target before starting a
backup. (normally you can prevent changes by setting
the readonly property on the target_fs to on)
--compress use compression during zfs send/recv
--test dont change anything, just show what would be done
(still does all read-only operations)
--verbose verbose output
--debug debug output (shows commands that are executed)
``` ```
Example Example
@ -138,7 +156,7 @@ All done
Tips Tips
---- ----
* Set the ```readonly``` property of the target filesystem to ```on```. This prevents changes on the target side. If there are changes the next backup will fail and will require a zfs rollback. * Set the ```readonly``` property of the target filesystem to ```on```. This prevents changes on the target side. If there are changes the next backup will fail and will require a zfs rollback. (by using the --rollback option for example)
* Use ```--clear-refreservation``` to save space on your backup server. * Use ```--clear-refreservation``` to save space on your backup server.
* Use ```--clear-mountpoint``` to prevent the target server from mounting the backupped filesystem in the wrong place during a reboot. If this happens on systems like SmartOS or Openindia, svc://filesystem/local wont be able to mount some stuff and you need to resolve these issues on the console. * Use ```--clear-mountpoint``` to prevent the target server from mounting the backupped filesystem in the wrong place during a reboot. If this happens on systems like SmartOS or Openindia, svc://filesystem/local wont be able to mount some stuff and you need to resolve these issues on the console.