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 usage text as requested in #54

Browse Source
This commit is contained in:
DatuX 2021-03-17 00:11:52 +01:00 committed by GitHub
parent cf72de7c28
commit 80c1bdad1c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 42 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

124
README.md
View File

@ -440,101 +440,61 @@ Here you find all the options:
```console ```console
[root@server ~]# zfs-autobackup --help [root@server ~]# zfs-autobackup --help
usage: zfs-autobackup [-h] [--ssh-config SSH_CONFIG] [--ssh-source SSH_SOURCE] usage: zfs-autobackup [-h] [--ssh-config CONFIG-FILE] [--ssh-source USER@HOST] [--ssh-target USER@HOST] [--keep-source SCHEDULE] [--keep-target SCHEDULE] [--other-snapshots] [--no-snapshot] [--no-send]
[--ssh-target SSH_TARGET] [--keep-source KEEP_SOURCE] [--no-thinning] [--no-holds] [--min-change BYTES] [--allow-empty] [--ignore-replicated] [--strip-path N] [--clear-refreservation] [--clear-mountpoint] [--filter-properties PROPERY,...]
[--keep-target KEEP_TARGET] [--other-snapshots] [--set-properties PROPERTY=VALUE,...] [--rollback] [--destroy-incompatible] [--destroy-missing SCHEDULE] [--ignore-transfer-errors] [--raw] [--test] [--verbose] [--debug] [--debug-output]
[--no-snapshot] [--no-send] [--min-change MIN_CHANGE] [--progress]
[--allow-empty] [--ignore-replicated] [--no-holds] backup-name [target-path]
[--strip-path STRIP_PATH] [--clear-refreservation]
[--clear-mountpoint]
[--filter-properties FILTER_PROPERTIES]
[--set-properties SET_PROPERTIES] [--rollback]
[--destroy-incompatible] [--ignore-transfer-errors]
[--raw] [--test] [--verbose] [--debug] [--debug-output]
[--progress]
backup-name [target-path]
zfs-autobackup v3.0-rc12 - Copyright 2020 E.H.Eefting (edwin@datux.nl) zfs-autobackup v3.1-beta2 - Copyright 2020 E.H.Eefting (edwin@datux.nl)
positional arguments: positional arguments:
backup-name Name of the backup (you should set the zfs property backup-name Name of the backup (you should set the zfs property "autobackup:backup-name" to true on filesystems you want to backup
"autobackup:backup-name" to true on filesystems you target-path Target ZFS filesystem (optional: if not specified, zfs-autobackup will only operate as snapshot-tool on source)
want to backup
target-path Target ZFS filesystem (optional: if not specified,
zfs-autobackup will only operate as snapshot-tool on
source)
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
--ssh-config SSH_CONFIG --ssh-config CONFIG-FILE
Custom ssh client config Custom ssh client config
--ssh-source SSH_SOURCE --ssh-source USER@HOST
Source host to get backup from. (user@hostname) Source host to get backup from.
Default None. --ssh-target USER@HOST
--ssh-target SSH_TARGET Target host to push backup to.
Target host to push backup to. (user@hostname) Default --keep-source SCHEDULE
None. Thinning schedule for old source snapshots. Default: 10,1d1w,1w1m,1m1y
--keep-source KEEP_SOURCE --keep-target SCHEDULE
Thinning schedule for old source snapshots. Default: Thinning schedule for old target snapshots. Default: 10,1d1w,1w1m,1m1y
10,1d1w,1w1m,1m1y --other-snapshots Send over other snapshots as well, not just the ones created by this tool.
--keep-target KEEP_TARGET --no-snapshot Don't create new snapshots (useful for finishing uncompleted backups, or cleanups)
Thinning schedule for old target snapshots. Default: --no-send Don't send snapshots (useful for cleanups, or if you want a serperate send-cronjob)
10,1d1w,1w1m,1m1y --no-thinning Do not destroy any snapshots.
--other-snapshots Send over other snapshots as well, not just the ones --no-holds Don't hold snapshots. (Faster. Allows you to destroy common snapshot.)
created by this tool. --min-change BYTES Number of bytes written after which we consider a dataset changed (default 1)
--no-snapshot Don't create new snapshots (useful for finishing --allow-empty If nothing has changed, still create empty snapshots. (same as --min-change=0)
uncompleted backups, or cleanups) --ignore-replicated Ignore datasets that seem to be replicated some other way. (No changes since lastest snapshot. Useful for proxmox HA replication)
--no-send Don't send snapshots (useful for cleanups, or if you --strip-path N Number of directories to strip from target path (use 1 when cloning zones between 2 SmartOS machines)
want a serperate send-cronjob)
--min-change MIN_CHANGE
Number of bytes written after which we consider a
dataset changed (default 1)
--allow-empty If nothing has changed, still create empty snapshots.
(same as --min-change=0)
--ignore-replicated Ignore datasets that seem to be replicated some other
way. (No changes since lastest snapshot. Useful for
proxmox HA replication)
--no-holds Don't lock snapshots on the source. (Useful to allow
proxmox HA replication to switches nodes)
--strip-path STRIP_PATH
Number of directories to strip from target path (use 1
when cloning zones between 2 SmartOS machines)
--clear-refreservation --clear-refreservation
Filter "refreservation" property. (recommended, safes Filter "refreservation" property. (recommended, safes space. same as --filter-properties refreservation)
space. same as --filter-properties refreservation) --clear-mountpoint Set property canmount=noauto for new datasets. (recommended, prevents mount conflicts. same as --set-properties canmount=noauto)
--clear-mountpoint Set property canmount=noauto for new datasets. --filter-properties PROPERY,...
(recommended, prevents mount conflicts. same as --set- List of properties to "filter" when receiving filesystems. (you can still restore them with zfs inherit -S)
properties canmount=noauto) --set-properties PROPERTY=VALUE,...
--filter-properties FILTER_PROPERTIES List of propererties to override when receiving filesystems. (you can still restore them with zfs inherit -S)
List of properties to "filter" when receiving --rollback Rollback changes to the latest target snapshot before starting. (normally you can prevent changes by setting the readonly property on the target_path to on)
filesystems. (you can still restore them with zfs
inherit -S)
--set-properties SET_PROPERTIES
List of propererties to override when receiving
filesystems. (you can still restore them with zfs
inherit -S)
--rollback Rollback changes to the latest target snapshot before
starting. (normally you can prevent changes by setting
the readonly property on the target_path to on)
--destroy-incompatible --destroy-incompatible
Destroy incompatible snapshots on target. Use with Destroy incompatible snapshots on target. Use with care! (implies --rollback)
care! (implies --rollback) --destroy-missing SCHEDULE
Destroy datasets on target that are missing on the source. Specify the time since the last snapshot, e.g: --destroy-missing 30d
--ignore-transfer-errors --ignore-transfer-errors
Ignore transfer errors (still checks if received Ignore transfer errors (still checks if received filesystem exists. useful for acltype errors)
filesystem exists. useful for acltype errors) --raw For encrypted datasets, send data exactly as it exists on disk.
--raw For encrypted datasets, send data exactly as it exists --test dont change anything, just show what would be done (still does all read-only operations)
on disk.
--test dont change anything, just show what would be done
(still does all read-only operations)
--verbose verbose output --verbose verbose output
--debug Show zfs commands that are executed, stops after an --debug Show zfs commands that are executed, stops after an exception.
exception.
--debug-output Show zfs commands and their output/exit codes. (noisy) --debug-output Show zfs commands and their output/exit codes. (noisy)
--progress show zfs progress output (to stderr). Enabled by --progress show zfs progress output. Enabled automaticly on ttys. (use --no-progress to disable)
default on ttys.
When a filesystem fails, zfs_backup will continue and report the number of Full manual at: https://github.com/psy0rz/zfs_autobackup
failures at that end. Also the exit code will indicate the number of failures.
``` ```
## Troubleshooting ## Troubleshooting