`zfs-assistant(1)`

Manage ZFS pools, datasets, snapshots and backups in a window

NAME

zfs-assistant - manage ZFS pools, datasets, snapshots and backups in a window

SYNOPSIS

zfs-assistant [--page PAGE] [--pool GUID]
zfs-assistant -h|--help|-v|--version

DESCRIPTION

zfs-assistant is the window of ZFS Assistant. It shows the health, protection and space of the pools, and manages pools, datasets, snapshots, snapshot policies, scrub and trim schedules, backups to other pools and computers, and restores.

Run it as your normal user, never as root. It does nothing privileged itself: it asks zfs-assistant-helper(8) on the system D-Bus, which starts on demand. Viewing normally needs no password at the console. A button with a lock asks for an administrator's authorization through polkit before it changes something or shows private information, and declining keeps your work in the window. Show command previews the ZFS commands the helper plans to run.

Only one window runs per session. Starting zfs-assistant again brings the running window forward, on the page the options ask for. It also starts zfs-assistant-tray(1) unless the tray is turned off in Settings.

The pages are Overview, Pools, Datasets, Snapshots, Schedules, Backups and Settings. zfsa(1) offers the same operations on the command line.

OPTIONS

--page PAGE: Show a page: overview, pools, datasets, snapshots, schedules, backups or settings.
--pool GUID: Show the pool with this numeric GUID, on the overview unless --page names another page. zfsa --json pool list shows the GUIDs.
-h, --help: Print the options and exit.
-v, --version: Print the version and exit.

The standard Qt options, such as -platform, work as well. A page or GUID that isn't valid is ignored.

FILES

$XDG_CONFIG_HOME/zfs-assistant/tray.conf: The tray and notification settings, shared with zfs-assistant-tray(1). $XDG_CONFIG_HOME is ~/.config when it is not set.
$XDG_CONFIG_HOME/autostart/org.zfsassistant.Tray.desktop: Starts the tray at login, when Start at login is turned on.

The machine configuration belongs to the helper; see zfs-assistant.toml(5).