ZPOOL-GET(8)

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

✨ ZPOOL-GET — bestie edition 💖

okay so this is zpool-get from section 8 of the System Manager's Manual, and it's literally the vibe check for your ZFS storage pools 🫶 it's giving "tell me everything about my pools and my vdevs, and also let me set stuff" and honestly? iconic.

🌸 NAME 🌸

zpool-get — retrieve properties of ZFS storage pools 💅

🎀 SYNOPSIS 🎀

zpool get [-Hp] [-j [--json-int, --json-pool-key-guid]]
      [-o field[,field]…] all|property[,property]… [pool]…
zpool get [-Hp] [-j [--json-int]] [-o field[,field]…]
      all|property[,property]… pool [all-vdevs|vdev]…
zpool set property=value pool
zpool set property=value pool vdev

🦋 DESCRIPTION 🦋

getting properties for your pools 🏊

zpool get [-Hp] [-j [--json-int, --json-pool-key-guid]] [-o
        field[,field]…] all|property[,property]… [pool]…

So basically this pulls the given list of properties — or literally all the properties if you pass all — for the storage pool(s) you point at. no cap. 🔥

These properties come back with the following fields:

  • name — name of storage pool ✨
  • property — property name 💫
  • value — property value 🌈
  • source — property source, either default or local 👑
if you wanna know more about which pool properties exist, go read the zpoolprops(7) manual page, bestie, it's all in there 📖

and here are the flags for this one:

  • -j, --json [--json-int, --json-pool-key-guid] — display the list of properties in JSON format 🧚 specify --json-int to display the numbers in integer format instead of strings in JSON output. specify --json-pool-key-guid to set pool GUID as key for pool objects instead of pool name 👑
  • -H — scripted mode 💀 do not display headers, and separate fields by a single tab instead of arbitrary space. perfect for when you're piping into something else, iykyk
  • -o field — a comma-separated list of columns to display, defaults to name,property,value,source 🌸
  • -p — display numbers in parsable (exact) values 🔢

getting properties for your vdevs 🧊

zpool get [-j [--json-int]] [-Hp] [-o field[,field]…]
        all|property[,property]… pool [all-vdevs|vdev]…

This one retrieves the given list of properties — or all of them if you say all — for the specified vdevs (or literally all the vdevs if you say all-vdevs) in the pool you specified. obsessed. 🫶

These properties show up with the following fields:

  • name — name of vdev ✨
  • property — property name 💫
  • value — property value 🌈
  • source — property source, either default or local 👑
more deets on the available pool properties live in the vdevprops(7) manual page 📖

and the flags:

  • -j, --json [--json-int] — display the list of properties in JSON format 🧚 specify --json-int to display the numbers in integer format instead of strings in JSON output.
  • -H — scripted mode 💀 no headers, and fields separated by a single tab instead of arbitrary space.
  • -o field — a comma-separated list of columns to display, defaults to name,property,value,source 🌸
  • -p — display numbers in parsable (exact) values 🔢

setting properties, the main character move 👑

zpool set property=value pool

Sets the given property on the specified pool. wanna know which properties you can set and what values are acceptable? the zpoolprops(7) manual page has you, bestie 💖

zpool set property=value pool vdev

Sets the given property on the specified vdev in the specified pool. and yep, vdevprops(7) is where you go for what you can set there and what values are acceptable 🌟

🌈 SEE ALSO 🌈

and that's the whole thing!! mwah 💅 this came to you from OpenZFS, dated October 12, 2024, page ZPOOL-GET(8) in the System Manager's Manual. slay, go check your pool properties, ily 🎀✨🦋

📦 where this page comes from