Job Types in Detail¶
Job Type push¶
| Parameter | Comment |
|---|---|
type |
= push |
name |
unique name of the job (must not change) |
connect |
connect specification |
filesystems |
filter specification for filesystems to be snapshotted and pushed to the sink |
send |
send options, e.g. for encrypted sends |
snapshotting |
snapshotting specification |
pruning |
pruning specification |
Example config: config/samples/push.yml
Job Type sink¶
| Parameter | Comment |
|---|---|
type |
= sink |
name |
unique name of the job (must not change) |
serve |
serve specification |
root_fs |
ZFS filesystems are received to
$root_fs/$client_identity/$source_path |
Example config: config/samples/sink.yml
Job Type pull¶
| Parameter | Comment |
|---|---|
type |
= pull |
name |
unique name of the job (must not change) |
connect |
connect specification |
root_fs |
ZFS filesystems are received to
$root_fs/$source_path |
interval |
Interval at which to pull from the source job (e.g.
10m).manual disables periodic pulling, replication then only happens on wakeup. |
pruning |
pruning specification |
Example config: config/samples/pull.yml
Job Type source¶
| Parameter | Comment |
|---|---|
type |
= source |
name |
unique name of the job (must not change) |
serve |
serve specification |
filesystems |
filter specification for filesystems to be snapshotted and exposed to connecting clients |
send |
send options, e.g. for encrypted sends |
snapshotting |
snapshotting specification |
Example config: config/samples/source.yml
Local replication¶
If you have the need for local replication (most likely between two local storage pools), you can use the local transport type to connect a local push job to a local sink job.
Example config: config/samples/local.yml.
Job Type snap (snapshot & prune only)¶
Job type that only takes snapshots and performs pruning on the local machine.
| Parameter | Comment |
|---|---|
type |
= snap |
name |
unique name of the job (must not change) |
filesystems |
filter specification for filesystems to be snapshotted |
snapshotting |
snapshotting specification |
pruning |
pruning specification |
Example config: config/samples/snap.yml