ZFS-MOUNT(8)

📦
version 2.4.4 · 6 versions
, in alpine 3.23, alpine 3.24, nixos 26.05, nixpkgs unstable, ubuntu resolute, ubuntu stonking

💖 ZFS-MOUNT 💖

ok so this is zfs-mount from section 8 of the System Manager's Manual — it's the girlies who handle the mount state of ZFS filesystems. mounting, unmounting, the whole vibe. let's get into it bestie 🦋

✨ SYNOPSIS ✨

zfs mount [-j]
zfs mount [-Oflv] [-o options] -a|-R filesystem|filesystem
zfs unmount [-fu] -a|filesystem|mountpoint

🌸 DESCRIPTION 🌸

zfs mount [-j] 👑

Displays all ZFS file systems currently mounted. just... showing you the receipts, no cap.

  • -j, --json — Displays all mounted file systems in JSON format. it's giving structured data, it's giving machine-readable, we love her 💅

zfs mount [-Oflv] [-o options] -a|-R filesystem|filesystem 🎀

Mount ZFS filesystem on a path described by its mountpoint property, if the path exists and is empty. If mountpoint is set to legacy, the filesystem should be instead mounted using mount(8).

lowkey important: the path has to exist and be empty, or it's not happening. and if you set mountpoint to legacy?? girl, that's a whole different manpage, go see mount(8) 💀
  • -O — Perform an overlay mount. Allows mounting in non-empty mountpoint. See mount(8) for more information. (yes bestie, she'll let you mount over stuff, she's bold like that)
  • -a — Mount all available ZFS file systems. Invoked automatically as part of the boot process if configured. main character boot energy 🌈
  • -R — Mount the specified filesystems along with all their children. the whole family's coming 🫶
  • filesystem — Mount the specified filesystem. that's it, that's the girl.
  • -o options — An optional, comma-separated list of mount options to use temporarily for the duration of the mount. See the Temporary Mount Point Properties section of zfsprops(7) for details. temporary!! as in, this vibe does not persist, iykyk ✨
  • -l — Load keys for encrypted filesystems as they are being mounted. This is equivalent to executing zfs load-key on each encryption root before mounting it.
🚨 okay so heads up: note that if a filesystem has keylocation=prompt, this will cause the terminal to interactively block after asking for the key. like, she WILL just sit there waiting for you. don't be confused, just type your key 😭
  • -v — Report mount progress. narrating the whole thing for you, love that for us 📢
  • -f — Attempt to force mounting of all filesystems, even those that couldn't normally be mounted (e.g. redacted datasets). she's persistent!! 🔥

zfs unmount [-fu] -a|filesystem|mountpoint 🧚

Unmounts currently mounted ZFS file systems. the reverse slay.

  • -a — Unmount all available ZFS file systems. Invoked automatically as part of the shutdown process. goodbye besties, see you at next boot 💜
  • -f — Forcefully unmount the file system, even if it is currently in use.
💀 not supported on Linux. just so you know.
  • -u — Unload keys for any encryption roots unmounted by this command. keys go back in the vault 🔐
  • filesystem|mountpoint — Unmount the specified filesystem. The command can also be given a path to a ZFS file system mount point on the system. so you can point at the fs or the path, either one works, flexible queen 🌸

🎬 SEE ALSO

(no see-also section on this page bestie, but we did shout out mount(8) and zfsprops(7) up top if you need more 👀)

ok that's the whole page!! written by OpenZFS, dated October 12, 2024 — go forth and mount responsibly, and remember: if the path isn't empty, -O is your girl. bye bestie 🎀✨💖

📦 where this page comes from