ZPOOL-CREATE(8)

πŸ’– zpool-create(8) πŸ’–

System Manager's Manual ✨ welcome to the page where we make a whole entire pool out of nothing, bestie 🫢


🌊 NAME 🌊

zpool-create β€” create ZFS storage pool πŸ’…


πŸ“œ SYNOPSIS πŸ“œ

zpool create [-dfn] [-m mountpoint] [-o property=value]… [-o
      feature@feature=value] [-o compatibility=off|legacy|file[,file]…]
      [-O file-system-property=value]… [-R root] [-t tname] pool vdev…

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so. This command creates a brand new storage pool out of the virtual devices you list on the command line. That's the whole vibe. ✨

Now, the pool name rules, and yes there are rules:

  • it must begin with a letter πŸ’–
  • after that first letter it can only have alphanumeric characters plus the underscore ("_"), the dash ("-"), the colon (":"), the space (" "), and the period (".") πŸŽ€

Also, some names are reserved and you cannot use them, no cap:

  • mirror
  • raidz
  • draid
  • spare
  • log

...and on top of that, any name beginning with mirror, raidz, draid, or spare is reserved too. Sorry bestie πŸ’€

The vdev specification itself lives in the β€œVirtual Devices” section of zpoolconcepts(7), so go read that if you need the deets 🧚

So here's the thing the command does: it attempts to verify that every device you named is accessible and not already in use by another subsystem. BUT β€” and this is the important part β€” this check is not robust enough to detect simultaneous attempts to use a new device in different pools, even if multihost= is enabled. 😭 The administrator has to make sure that simultaneous invocations of any combination of zpool replace, zpool create, zpool add, or zpool labelclear do not refer to the same device. Using the same device in two pools will result in pool corruption. periodt.

Some uses of a device will stop it from ever being usable by ZFS β€” like being currently mounted, or being specified as the dedicated dump device. Other uses, like having a preexisting UFS file system, can be overridden with -f. 🌸

The command also checks that the replication strategy for the pool is consistent. So if you try to combine redundant and non-redundant storage in a single pool, or mix disks and files, that's an error unless you pass -f. Same energy for using differently-sized devices inside a single raidz or mirror group β€” also flagged as an error unless -f is specified. ⭐

Unless you specify the -R option, the default mount point is /pool. The mount point must not exist or must be empty, or else the root dataset will not be able to be be mounted. This can be overridden with the -m option. πŸŽ€

By default all supported features are enabled on the new pool. The -d option and the -o compatibility property (e.g -o compatibility=2020) can be used to restrict the features that are enabled, so that the pool can be imported on other releases of ZFS. πŸ‘‘

Now the flags, and I'm listing every single one because I love you 🫢

  • -d β€” Do not enable any features on the new pool. Individual features can be enabled by setting their corresponding properties to enabled with -o. See zpool-features(7) for details about feature properties. ✨
  • -f β€” Forces use of vdevs, even if they appear in use or specify a conflicting replication level. Not all devices can be overridden in this manner. πŸ’…
  • -m mountpoint β€” Sets the mount point for the root dataset. The default mount point is /pool or altroot/pool if altroot is specified. The mount point must be an absolute path, legacy, or none. For more information on dataset mount points, see zfsprops(7). πŸŽ€
  • -n β€” Displays the configuration that would be used without actually creating the pool. The actual pool creation can still fail due to insufficient privileges or device sharing. πŸ™ˆ
  • -o property=value β€” Sets the given pool properties. See zpoolprops(7) for a list of valid properties that can be set. 🌸
  • -o compatibility=off|legacy|file[,file]… β€” Specifies compatibility feature sets. See zpool-features(7) for more information about compatibility feature sets. πŸ¦‹
  • -o feature@feature=value β€” Sets the given pool feature. See the zpool-features(7) section for a list of valid features that can be set. Value can be either disabled or enabled. ⭐
  • -O file-system-property=value β€” Sets the given file system properties in the root file system of the pool. See zfsprops(7) for a list of valid properties that can be set. πŸ’œ
  • -R root β€” Equivalent to -o cachefile=none -o altroot=root πŸ”₯
  • -t tname β€” Sets the in-core pool name to tname while the on-disk name will be the name specified as pool. This will set the default of the cachefile property to none. This is intended to handle name space collisions when creating pools for other systems, such as virtual machines or physical machines whose pools live on network block devices. 🌈

πŸŽ€ EXAMPLES πŸŽ€

🌸 Example 1: Creating a RAID-Z Storage Pool 🌸

The following command creates a pool with a single raidz root vdev that consists of six disks:

# zpool create tank raidz sda sdb sdc sdd sde sdf

πŸ’– Example 2: Creating a Mirrored Storage Pool πŸ’–

The following command creates a pool with two mirrors, where each mirror contains two disks:

# zpool create tank mirror sda sdb mirror sdc sdd

πŸ¦‹ Example 3: Creating a ZFS Storage Pool by Using Partitions πŸ¦‹

The following command creates a non-redundant pool using two disk partitions:

# zpool create tank sda1 sdb2

✨ Example 4: Creating a ZFS Storage Pool by Using Files ✨

The following command creates a non-redundant pool using files. While not recommended, a pool based on files can be useful for experimental purposes.

# zpool create tank /path/to/file/a /path/to/file/b

πŸ’… Example 5: Managing Hot Spares πŸ’…

The following command creates a new pool with an available hot spare:

# zpool create tank mirror sda sdb spare sdc

πŸ‘‘ Example 6: Creating a ZFS Pool with Mirrored Separate Intent Logs πŸ‘‘

The following command creates a ZFS storage pool consisting of two, two-way mirrors and mirrored log devices:

# zpool create pool mirror sda sdb mirror sdc sdd log mirror sde
sdf

🌈 SEE ALSO 🌈

zpool-destroy(8), zpool-export(8), zpool-import(8)


okay that's the whole page, you ate it, go make a pool bestie 🫢

This one came straight from the OpenZFS girlies, dated July 11, 2022, and it's the ZPOOL-CREATE(8) page β€” mwah πŸ’‹

πŸ“¦ where this page comes from