Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Reference: keys

What you will learn

  • Every key of every section, in one place.

This list is checked against the program's own Help screen (?) by the book's tests, so it cannot drift from it. The hint bar at the bottom of the screen always shows the keys that work right now; where a key behaves differently in two places, the heading says where.

Tip: Esc always means "back out", and every question that can change data takes two keys (y/n, then Enter). See the screen.

Global

KeyWhat it does
Tab / Shift+Tabswitch sections
Up / Downselect a row (host/pool/dataset/snapshot/disk/share, or a property/permission/ACL row)
rrefresh the focused pane
F2in a form, on a field with known values (Permissions, Flags, Type, Recipient, Valid user, Root user mapping, a pool property with fixed values such as failmode or autoexpand, a from-disks Redundancy, a job's Host, Pool or Dataset, a replication's Destination host, a backup's Source (new, the prefixes the dataset uses, and each snapshot as @name), and Schedule): open a picker (type filter, Enter OK, Esc cancel; Space toggles in multi-select ones)
F5in the backup job form: check the repository and password file on the job's host; in the cloud mirror form: check the remote (both read-only; never block saving), with Note: lines when the password file is in a home or temp directory or other users can read it
Escdismiss a status message, back out of a focused pane, or cancel a modal (in a y/n confirmation Esc selects No, then Enter)
y / n, Entera y/n confirmation takes two keys: y (yes) or n / Esc (no) selects, then Enter applies it; Enter alone does nothing. Forms that cannot be undone (create pool, add vdev, replace disk, revoke, shrinking a volume, pool features) end in one, showing the exact command
?this Help screen
!open a shell on the selected host (remote hosts: your unprivileged ssh login); exit returns to zfsctl
AAbout: the zfsctl wordmark, the version and what the tool is for (include the version when you report a bug)
qquit

Hosts

KeyWhat it does
Up / Downselect the active host
/filter the host list by name, address, tag, site or type (Enter keeps it, Esc clears it)
ccheck the selected host's disks (smartctl) and shares (NFS, Samba) now; the result joins the Dashboard (read-only)
Spacemark or unmark the selected host (a marked host shows + instead of ●); Esc unmarks them all
eedit the tag and site of the marked hosts, or of the selected one when none is marked
nadd a new host (prompts for Name, SSH target and an optional Tag)

Pools

KeyWhat it does
Enterdrill into vdev/disk tree
Right / Leftfocus/unfocus the properties pane
n / dcreate / destroy a pool
s / Rscrub / resilver (y/n confirm)
Jschedule a recurring scrub of the selected pool (opens the job form)
J(in Datasets) schedule recurring snapshots of the selected dataset

Vdevs (inside a drilled-into pool)

KeyWhat it does
o / Ooffline / online the selected disk
xreplace the selected disk
+attach a disk to the selected mirror (another side), lone disk (making a mirror) or raidz group (widening it); a form, then the question
aadd a vdev/mirror/raidz group, or a log, cache, special, dedup or spare device
Xremove the selected log, cache or spare device (a plain question first)

Pool/Dataset properties pane

KeyWhat it does
Enteredit the selected property
rre-fetch for the current pool/dataset

Datasets

KeyWhat it does
Right / Leftfocus/unfocus the detail pane
n / dcreate / destroy a dataset (type its name; zfs refuses if it has snapshots or children)
Ddestroy a dataset AND its child datasets and snapshots (type its name; says how many; never -R)
ssnapshot the selected dataset
Ecreate an encrypted dataset (name, cipher, passphrase twice, then type the name)
Hlist every property set by hand on this host (source local), grouped by dataset, without the ones at their built-in default (d shows them); Enter selects that dataset
L / U / Cload / unload / change the key of the selected encrypted dataset (its encryption root)
Ncreate/edit an NFS share
Mcreate/edit an SMB share
'[' / ']'cycle Properties / Permissions / ACL sub-tabs (once focused)

Datasets: Permissions sub-tab

KeyWhat it does
n / s / cgrant: to a recipient / as a named set / as create-time
d / xrevoke everything / revoke specific permissions

Datasets: ACL sub-tab

KeyWhat it does
nadd an ACL entry (always appended at the end)
dremove the selected entry by position

Snapshots

KeyWhat it does
ddestroy (type dataset@name to confirm)
broll back (type dataset@name to confirm)
Hhold the selected snapshot, or release zfsctl's hold on it (a hold stops it being destroyed or pruned; other tags are never released)
cshow what changed since the previous snapshot, by folder (read-only): Enter opens a folder, / inside a folder filters its entries by name as you type (`a
Cthe same, but compared with the live dataset: what has changed since this snapshot
flook inside the selected snapshot (read-only, names and metadata only; other hosts need the browse sudoers feature): Enter opens a folder, ← goes up, / filters by name as you type (`a
Rin the snapshot browser, on a regular file: copy it back next to the original under a new name (asks for the name, then shows the exact command; y then Enter runs it; it never replaces a file; other hosts need the restore sudoers feature)

Disks

KeyWhat it does
Spacetoggle-select a disk
n / acreate a pool / add a vdev from the selected disk(s)
Escclear selection

Shares

KeyWhat it does
Enteredit the selected share
dremove the selected share

Boot Envs

KeyWhat it does
nnew boot environment (F2 on the second field picks one to clone)
amake the selected one the boot environment for every future boot (confirms)
t / Tuse it for the next boot only (confirms) / clear that
Rrename
m / umount / unmount (the Mountpoint column shows where)
d / Ddestroy (type its name) / destroy and remove its origin snapshot

Jobs

KeyWhat it does
Up / Downselect a scheduled job
Enteredit the job (host, pool, schedule, catch up)
nnew scrub job (or press J on a pool in Pools)
Nnew snapshot job (or press J on a dataset in Datasets)
Rnew replication job
Bnew backup job (restic: back up a snapshot through a temporary clone)
Cnew cloud mirror job (rclone: copy a snapshot clone to a cloud bucket as plain files)
ccancel the selected replication or backup while it is running
Spaceenable / disable the job
ddelete the job (y/n; its past runs stay in the history)

Dashboard

KeyWhat it does
Up / Downselect a line of Needs attention, then (with tags) a group row, then the data-safety line
Entergo to the section that owns that line; on an unprotected-data line, open the form that makes the missing job, or (on "and N more") the list of the unprotected datasets ; on a group row, open the Hosts list narrowed to that tag; on the data-safety line, show where each dataset's data lives; on the ignored by choice line, open the list of ignored datasets (Space marks, Enter or u checks the marked ones again after a confirmation)
ewith tags: list every host under its group, or only the ones that need a look
rreload the jobs, alerts, cloud list and [dashboard] settings

Cloud

KeyWhat it does
Up / Downselect an rclone remote (the hub's, and those of hosts that have a cloud job)
smeasure the bucket: the size of current/ and old/ of the remote's cloud mirror jobs (reads the file list, which a cloud account may count as requests)
F5check the selected remote (read-only): the remote of its cloud mirror job, or, when no job uses it yet, its top level
nset up a provider: a list (Backblaze B2, Amazon S3, Google Drive, OneDrive, Dropbox, SFTP...) and the steps for the one you pick; nothing is created
Cnew cloud mirror job
rrefresh the list of remotes and jobs

Alerts

KeyWhat it does
eedit the alert settings (saved into the [notify] section of config.toml only; y/n to confirm)
tsend a test message through the saved settings (a real message; asks first)
ppreview the daily report as it would be sent now (sends nothing)
Up / Downscroll the recent events

Settings

KeyWhat it does
Up / Downselect a setting
Enteredit the setting in a form (blank = default; on Ignored datasets it opens the list of ignored datasets instead; saved into config.toml after a y/n confirmation)
eon the Ignored datasets row: edit the list as text (Enter there opens the list, to check datasets again)
rreload the settings from config.toml

Try it

Press ? in zfsctl and compare it with this list; they are the same words.

Where next