Manual pages

Programs and configuration

• zfs-assistant(1)Manage ZFS pools, datasets, snapshots and backups in a window
• zfs-assistant-tray(1)ZFS pool status and notifications in the system tray
• zfsa(1)Manage ZFS pools, datasets and snapshots
• zfs-assistant-helper(8)The privileged service of ZFS Assistant
• zfs-assistant.toml(5)The machine configuration of ZFS Assistant

Everyday commands

• zfsa-completions(1)Shell completions on stdout
• zfsa-list(1)Datasets, volumes, snapshots and bookmarks
• zfsa-prune(1)Delete the snapshots a policy no longer needs now, instead of waiting for the snapshot job
• zfsa-rollback(1)Throw away every change since a snapshot (zfs rollback)
• zfsa-status(1)Health, protection, space and problems of the pools

zfsa backup

Backups: copies of snapshot policies to other pools and machines

• zfsa-backup-add(1)Back up a policy to a remote or another pool
• zfsa-backup-cancel(1)Stop a running backup. The next one continues where it stopped
• zfsa-backup-change(1)Change how often a backup runs or how much it keeps
• zfsa-backup-list(1)Every backup with when it last ran, how it went and how far behind it is
• zfsa-backup-remove(1)Stop backing up. The backups already made stay
• zfsa-backup-status(1)The same as backup list, with progress for running backups
• zfsa-backup-sync(1)Run a backup now, outside its schedule

zfsa dataset

Datasets

• zfsa-dataset-allow(1)Let someone who isn't root do these things with the dataset
• zfsa-dataset-create(1)Create a dataset or volume
• zfsa-dataset-destroy(1)Destroy a dataset (and with -r what is inside it)
• zfsa-dataset-mount(1)Mount a dataset
• zfsa-dataset-permissions(1)What is delegated on the dataset, including what it inherits
• zfsa-dataset-promote(1)Make a clone independent of its origin
• zfsa-dataset-rename(1)Rename a dataset. Snapshots and mountpoints follow
• zfsa-dataset-space(1)What uses the dataset's space, largest first
• zfsa-dataset-unallow(1)Take delegated permissions back
• zfsa-dataset-unmount(1)Unmount a dataset

zfsa disk

Disks that pools can be made on

• zfsa-disk-list(1)Every disk with model, size, serial, type and why it is in use (needs the manage grant)

zfsa file

Files inside snapshots

• zfsa-file-copy(1)Save a copy of a file as it was in a snapshot
• zfsa-file-diff(1)How a text file differs between a snapshot and now, or between two snapshots
• zfsa-file-versions(1)Every different version of a file across the snapshots, newest first

zfsa job

Scheduled jobs, their history and logs

• zfsa-job-add(1)Schedule a scrub or trim of a pool
• zfsa-job-cancel(1)Stop a running job at its next safe point
• zfsa-job-change(1)Change when a scrub or trim job runs
• zfsa-job-delete(1)Delete a scrub or trim job
• zfsa-job-history(1)Started, finished, result and message of past runs, newest first
• zfsa-job-list(1)Every scheduled job with its schedule, what is installed, next run and state
• zfsa-job-log(1)The log of a run (needs the manage grant)
• zfsa-job-run(1)Run a job now, outside its schedule

zfsa key

Encryption keys

• zfsa-key-change(1)Change the passphrase
• zfsa-key-load(1)Unlock: load the key
• zfsa-key-unload(1)Lock: unmount what the key unlocks and unload it

zfsa policy

Snapshot policies

• zfsa-policy-create(1)Make a snapshot policy
• zfsa-policy-delete(1)Delete a policy. Its snapshots stay and are no longer pruned
• zfsa-policy-list(1)Name, datasets, how often, what it keeps and where it is copied
• zfsa-policy-preview(1)What a policy (with changes that are not saved) keeps and would delete now
• zfsa-policy-set(1)Change keys of a policy
• zfsa-policy-show(1)Everything about a policy

zfsa pool

Pools

• zfsa-pool-add(1)Add disks to a pool
• zfsa-pool-attach(1)Add a disk as a mirror partner of a device
• zfsa-pool-checkpoint(1)Take a checkpoint of a pool, or discard its checkpoint
• zfsa-pool-clear(1)Reset the error counters of a pool or a device
• zfsa-pool-create(1)Create a pool from whole disks
• zfsa-pool-destroy(1)Destroy a pool and everything on it
• zfsa-pool-detach(1)Take a disk out of a mirror
• zfsa-pool-errors(1)The files with errors ZFS couldn't repair (needs the manage grant)
• zfsa-pool-expand(1)Grow a RAIDZ group by one disk (OpenZFS 2.3 or newer)
• zfsa-pool-export(1)Export a pool: unmount it and release its disks
• zfsa-pool-history(1)What zpool history records, newest first (needs the manage grant)
• zfsa-pool-import(1)Import a pool found on the connected disks, or list the pools that can be imported
• zfsa-pool-list(1)Name, health, size, space and protection of every pool
• zfsa-pool-offline(1)Take a disk offline
• zfsa-pool-online(1)Bring a disk online
• zfsa-pool-remove(1)Remove a top-level device and move its data to the others
• zfsa-pool-replace(1)Replace a disk with another
• zfsa-pool-show(1)The vdev tree of a pool with states and error counters
• zfsa-pool-upgrade(1)Enable the features the installed OpenZFS has and the pool lacks

zfsa property

Pool and dataset properties

• zfsa-property-explain(1)What a property means, which values it takes and what changing it does
• zfsa-property-get(1)Property values with their source and what they mean
• zfsa-property-inherit(1)Take the dataset's own value away, so that it follows its parent again
• zfsa-property-set(1)Set properties, applied together

zfsa remote

Computers that backups are sent to

• zfsa-remote-add(1)Add a remote: confirm its host key, make a key and test the connection
• zfsa-remote-browse(1)The remote's backups: the datasets with copies, or the snapshots of one dataset
• zfsa-remote-delete(1)Remove a remote nothing is backed up to
• zfsa-remote-delete-snapshots(1)Delete backups on a remote
• zfsa-remote-edit(1)Change a remote
• zfsa-remote-list(1)Name, host, protection and state of every remote
• zfsa-remote-restore(1)Bring a snapshot back from a remote as a new dataset
• zfsa-remote-test(1)Connect, and say whether ZFS Assistant answers there
• zfsa-remote-trust(1)Confirm the remote's host key again, after it changed

zfsa restore

Bring back files, folders or a whole dataset from a snapshot

• zfsa-restore-dataset(1)The snapshot as a new dataset next to the original, or in its place
• zfsa-restore-file(1)Put a file or folder back as it was in a snapshot

zfsa schedule

What runs the scheduled jobs

• zfsa-schedule-apply(1)Rewrite the generated timers or cron lines from the configuration
• zfsa-schedule-show(1)The scheduler, what is installed against what the configuration asks for, and other tools
• zfsa-schedule-use(1)Switch the scheduler after removing everything installed for the old one

zfsa scrub

Scrubs

• zfsa-scrub-cancel(1)Stop a scrub for good
• zfsa-scrub-pause(1)Pause a scrub. Use scrub start to resume it
• zfsa-scrub-start(1)Start a scrub, or resume a paused one
• zfsa-scrub-status(1)How a scrub goes and how the last one ended

zfsa settings

ZFS Assistant's own settings

• zfsa-settings-set(1)Change settings, applied together
• zfsa-settings-show(1)Every setting with its value and what it does

zfsa snapshot

Snapshots

• zfsa-snapshot-bookmark(1)Make a bookmark of a snapshot
• zfsa-snapshot-bookmarks(1)The bookmarks of a dataset with their times
• zfsa-snapshot-clone(1)Make a new dataset from a snapshot
• zfsa-snapshot-create(1)Take a snapshot of one or more datasets
• zfsa-snapshot-delete(1)Delete snapshots or bookmarks. Use dataset@a%b for the range from a to b
• zfsa-snapshot-diff(1)What changed in a dataset since a snapshot, or between two
• zfsa-snapshot-files(1)List a folder inside a snapshot
• zfsa-snapshot-hold(1)Keep a snapshot from being deleted by giving it a hold tag
• zfsa-snapshot-list(1)Snapshots of a dataset with time, policy, space, holds and what they are kept for
• zfsa-snapshot-release(1)Take a hold tag off a snapshot
• zfsa-snapshot-rename(1)Rename a snapshot

zfsa trim

Trims

• zfsa-trim-cancel(1)Stop a trim
• zfsa-trim-start(1)Start a trim