]> git.proxmox.com Git - mirror_zfs.git/blame - man/man5/zpool-features.5
Fix formatting for multi_vdev_crash_dump in zpool-features.5
[mirror_zfs.git] / man / man5 / zpool-features.5
CommitLineData
9ae529ec 1'\" te
d2734cce 2.\" Copyright (c) 2013, 2017 by Delphix. All rights reserved.
9759c60f 3.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
788eb90c 4.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
9ae529ec
CS
5.\" The contents of this file are subject to the terms of the Common Development
6.\" and Distribution License (the "License"). You may not use this file except
7.\" in compliance with the License. You can obtain a copy of the license at
8.\" usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
9.\"
10.\" See the License for the specific language governing permissions and
11.\" limitations under the License. When distributing Covered Code, include this
12.\" CDDL HEADER in each file and include the License file at
13.\" usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this
14.\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your
15.\" own identifying information:
16.\" Portions Copyright [yyyy] [name of copyright owner]
5fadb7fb 17.TH ZPOOL-FEATURES 5 "Jun 8, 2018"
9ae529ec
CS
18.SH NAME
19zpool\-features \- ZFS pool feature descriptions
20.SH DESCRIPTION
21.sp
22.LP
23ZFS pool on\-disk format versions are specified via "features" which replace
24the old on\-disk format numbers (the last supported on\-disk format number is
b9b24bb4 2528). To enable a feature on a pool use the \fBupgrade\fR subcommand of the
9042ca0e 26zpool(8) command, or set the \fBfeature@\fR\fIfeature_name\fR property
b9b24bb4 27to \fBenabled\fR.
9ae529ec
CS
28.sp
29.LP
30The pool format does not affect file system version compatibility or the ability
31to send file systems between pools.
32.sp
33.LP
34Since most features can be enabled independently of each other the on\-disk
35format of the pool is specified by the set of all features marked as
36\fBactive\fR on the pool. If the pool was created by another software version
37this set may include unsupported features.
38.SS "Identifying features"
39.sp
40.LP
393363c5
RL
41Every feature has a GUID of the form \fIcom.example:feature_name\fR. The
42reverse DNS name ensures that the feature's GUID is unique across all ZFS
9ae529ec 43implementations. When unsupported features are encountered on a pool they will
393363c5 44be identified by their GUIDs. Refer to the documentation for the ZFS
9ae529ec
CS
45implementation that created the pool for information about those features.
46.sp
47.LP
48Each supported feature also has a short name. By convention a feature's short
393363c5 49name is the portion of its GUID which follows the ':' (e.g.
9ae529ec
CS
50\fIcom.example:feature_name\fR would have the short name \fIfeature_name\fR),
51however a feature's short name may differ across ZFS implementations if
52following the convention would result in name conflicts.
53.SS "Feature states"
54.sp
55.LP
56Features can be in one of three states:
57.sp
58.ne 2
59.na
60\fB\fBactive\fR\fR
61.ad
62.RS 12n
63This feature's on\-disk format changes are in effect on the pool. Support for
64this feature is required to import the pool in read\-write mode. If this
65feature is not read-only compatible, support is also required to import the pool
66in read\-only mode (see "Read\-only compatibility").
67.RE
68
69.sp
70.ne 2
71.na
72\fB\fBenabled\fR\fR
73.ad
74.RS 12n
75An administrator has marked this feature as enabled on the pool, but the
76feature's on\-disk format changes have not been made yet. The pool can still be
77imported by software that does not support this feature, but changes may be made
78to the on\-disk format at any time which will move the feature to the
79\fBactive\fR state. Some features may support returning to the \fBenabled\fR
80state after becoming \fBactive\fR. See feature\-specific documentation for
81details.
82.RE
83
84.sp
85.ne 2
86.na
87\fBdisabled\fR
88.ad
89.RS 12n
90This feature's on\-disk format changes have not been made and will not be made
91unless an administrator moves the feature to the \fBenabled\fR state. Features
92cannot be disabled once they have been enabled.
93.RE
94
95.sp
96.LP
97The state of supported features is exposed through pool properties of the form
98\fIfeature@short_name\fR.
99.SS "Read\-only compatibility"
100.sp
101.LP
102Some features may make on\-disk format changes that do not interfere with other
103software's ability to read from the pool. These features are referred to as
104"read\-only compatible". If all unsupported features on a pool are read\-only
105compatible, the pool can be imported in read\-only mode by setting the
9042ca0e 106\fBreadonly\fR property during import (see zpool(8) for details on
9ae529ec
CS
107importing pools).
108.SS "Unsupported features"
109.sp
110.LP
111For each unsupported feature enabled on an imported pool a pool property
393363c5 112named \fIunsupported@feature_name\fR will indicate why the import was allowed
9ae529ec
CS
113despite the unsupported feature. Possible values for this property are:
114
115.sp
116.ne 2
117.na
118\fB\fBinactive\fR\fR
119.ad
120.RS 12n
121The feature is in the \fBenabled\fR state and therefore the pool's on\-disk
122format is still compatible with software that does not support this feature.
123.RE
124
125.sp
126.ne 2
127.na
128\fB\fBreadonly\fR\fR
129.ad
130.RS 12n
131The feature is read\-only compatible and the pool has been imported in
132read\-only mode.
133.RE
134
135.SS "Feature dependencies"
136.sp
137.LP
138Some features depend on other features being enabled in order to function
139properly. Enabling a feature will automatically enable any features it
140depends on.
141.SH FEATURES
142.sp
143.LP
144The following features are supported on this system:
145.sp
146.ne 2
147.na
148\fB\fBasync_destroy\fR\fR
149.ad
150.RS 4n
151.TS
152l l .
153GUID com.delphix:async_destroy
154READ\-ONLY COMPATIBLE yes
155DEPENDENCIES none
156.TE
157
158Destroying a file system requires traversing all of its data in order to
159return its used space to the pool. Without \fBasync_destroy\fR the file system
160is not fully removed until all space has been reclaimed. If the destroy
161operation is interrupted by a reboot or power outage the next attempt to open
162the pool will need to complete the destroy operation synchronously.
163
164When \fBasync_destroy\fR is enabled the file system's data will be reclaimed
165by a background process, allowing the destroy operation to complete without
166traversing the entire file system. The background process is able to resume
167interrupted destroys after the pool has been opened, eliminating the need
168to finish interrupted destroys as part of the open operation. The amount
169of space remaining to be reclaimed by the background process is available
170through the \fBfreeing\fR property.
171
172This feature is only \fBactive\fR while \fBfreeing\fR is non\-zero.
173.RE
753c3839
MA
174
175.sp
176.ne 2
177.na
178\fB\fBempty_bpobj\fR\fR
179.ad
180.RS 4n
181.TS
182l l .
183GUID com.delphix:empty_bpobj
184READ\-ONLY COMPATIBLE yes
185DEPENDENCIES none
186.TE
187
188This feature increases the performance of creating and using a large
189number of snapshots of a single filesystem or volume, and also reduces
190the disk space required.
191
192When there are many snapshots, each snapshot uses many Block Pointer
193Objects (bpobj's) to track blocks associated with that snapshot.
194However, in common use cases, most of these bpobj's are empty. This
195feature allows us to create each bpobj on-demand, thus eliminating the
196empty bpobjs.
197
198This feature is \fBactive\fR while there are any filesystems, volumes,
199or snapshots which were created after enabling this feature.
200.RE
201
788eb90c
JJ
202.sp
203.ne 2
204.na
205\fB\fBfilesystem_limits\fR\fR
206.ad
207.RS 4n
208.TS
209l l .
210GUID com.joyent:filesystem_limits
211READ\-ONLY COMPATIBLE yes
212DEPENDENCIES extensible_dataset
213.TE
214
215This feature enables filesystem and snapshot limits. These limits can be used
216to control how many filesystems and/or snapshots can be created at the point in
217the tree on which the limits are set.
218
219This feature is \fBactive\fR once either of the limit properties has been
220set on a dataset. Once activated the feature is never deactivated.
221.RE
222
9759c60f
ED
223.sp
224.ne 2
225.na
226\fB\fBlz4_compress\fR\fR
227.ad
228.RS 4n
229.TS
230l l .
231GUID org.illumos:lz4_compress
232READ\-ONLY COMPATIBLE no
233DEPENDENCIES none
234.TE
235
236\fBlz4\fR is a high-performance real-time compression algorithm that
237features significantly faster compression and decompression as well as a
238higher compression ratio than the older \fBlzjb\fR compression.
239Typically, \fBlz4\fR compression is approximately 50% faster on
240compressible data and 200% faster on incompressible data than
241\fBlzjb\fR. It is also approximately 80% faster on decompression, while
242giving approximately 10% better compression ratio.
243
244When the \fBlz4_compress\fR feature is set to \fBenabled\fR, the
245administrator can turn on \fBlz4\fR compression on any dataset on the
9042ca0e 246pool using the zfs(8) command. Please note that doing so will
9759c60f 247immediately activate the \fBlz4_compress\fR feature on the underlying
9042ca0e 248pool using the zfs(8) command. Also, all newly written metadata
62bdd5eb
DL
249will be compressed with \fBlz4\fR algorithm. Since this feature is not
250read-only compatible, this operation will render the pool unimportable
5fadb7fb
TS
251on systems without support for the \fBlz4_compress\fR feature.
252
253Booting off of \fBlz4\fR-compressed root pools is supported.
62bdd5eb
DL
254
255This feature becomes \fBactive\fR as soon as it is enabled and will
256never return to being \fBenabled\fB.
93cf2076
GW
257.RE
258
259.sp
260.ne 2
261.na
262\fB\fBspacemap_histogram\fR\fR
263.ad
264.RS 4n
265.TS
266l l .
267GUID com.delphix:spacemap_histogram
268READ\-ONLY COMPATIBLE yes
269DEPENDENCIES none
270.TE
271
272This features allows ZFS to maintain more information about how free space
273is organized within the pool. If this feature is \fBenabled\fR, ZFS will
274set this feature to \fBactive\fR when a new space map object is created or
275an existing space map is upgraded to the new format. Once the feature is
276\fBactive\fR, it will remain in that state until the pool is destroyed.
9759c60f
ED
277
278.RE
279
42db43e9
GDN
280.sp
281.ne 2
282.na
283\fB\fBmulti_vdev_crash_dump\fR\fR
284.ad
285.RS 4n
286.TS
287l l .
4d256e89
RL
288GUID com.joyent:multi_vdev_crash_dump
289READ\-ONLY COMPATIBLE no
290DEPENDENCIES none
42db43e9
GDN
291.TE
292
293This feature allows a dump device to be configured with a pool comprised
294of multiple vdevs. Those vdevs may be arranged in any mirrored or raidz
295configuration.
296
297When the \fBmulti_vdev_crash_dump\fR feature is set to \fBenabled\fR,
298the administrator can use the \fBdumpadm\fR(1M) command to configure a
299dump device on a pool comprised of multiple vdevs.
300
301Under Linux this feature is registered for compatibility but not used.
302New pools created under Linux will have the feature \fBenabled\fR but
303will never transition to \fB\fBactive\fR. This functionality is not
304required in order to support crash dumps under Linux. Existing pools
305where this feature is \fB\fBactive\fR can be imported.
306.RE
307
fa86b5db
MA
308.sp
309.ne 2
310.na
311\fB\fBextensible_dataset\fR\fR
312.ad
313.RS 4n
314.TS
315l l .
316GUID com.delphix:extensible_dataset
317READ\-ONLY COMPATIBLE no
318DEPENDENCIES none
319.TE
320
321This feature allows more flexible use of internal ZFS data structures,
322and exists for other features to depend on.
323
324This feature will be \fBactive\fR when the first dependent feature uses it,
325and will be returned to the \fBenabled\fR state when all datasets that use
326this feature are destroyed.
327
328.RE
329
da536844
MA
330.sp
331.ne 2
332.na
333\fB\fBbookmarks\fR\fR
334.ad
335.RS 4n
336.TS
337l l .
338GUID com.delphix:bookmarks
339READ\-ONLY COMPATIBLE yes
340DEPENDENCIES extensible_dataset
341.TE
342
343This feature enables use of the \fBzfs bookmark\fR subcommand.
344
345This feature is \fBactive\fR while any bookmarks exist in the pool.
346All bookmarks in the pool can be listed by running
347\fBzfs list -t bookmark -r \fIpoolname\fR\fR.
348
349.RE
350
b0bc7a84
MG
351.sp
352.ne 2
353.na
354\fB\fBenabled_txg\fR\fR
355.ad
356.RS 4n
357.TS
358l l .
359GUID com.delphix:enabled_txg
360READ\-ONLY COMPATIBLE yes
361DEPENDENCIES none
362.TE
363
364Once this feature is enabled ZFS records the transaction group number
365in which new features are enabled. This has no user-visible impact,
366but other features may depend on this feature.
367
368This feature becomes \fBactive\fR as soon as it is enabled and will
369never return to being \fBenabled\fB.
370
371.RE
372
373.sp
374.ne 2
375.na
376\fB\fBhole_birth\fR\fR
377.ad
378.RS 4n
379.TS
380l l .
381GUID com.delphix:hole_birth
382READ\-ONLY COMPATIBLE no
383DEPENDENCIES enabled_txg
384.TE
385
9042ca0e 386This feature improves performance of incremental sends (\fBzfs send -i\fR)
b0bc7a84
MG
387and receives for objects with many holes. The most common case of
388hole-filled objects is zvols.
389
390An incremental send stream from snapshot \fBA\fR to snapshot \fBB\fR
391contains information about every block that changed between \fBA\fR and
392\fBB\fR. Blocks which did not change between those snapshots can be
393identified and omitted from the stream using a piece of metadata called
394the 'block birth time', but birth times are not recorded for holes (blocks
395filled only with zeroes). Since holes created after \fBA\fR cannot be
396distinguished from holes created before \fBA\fR, information about every
397hole in the entire filesystem or zvol is included in the send stream.
398
399For workloads where holes are rare this is not a problem. However, when
400incrementally replicating filesystems or zvols with many holes (for
401example a zvol formatted with another filesystem) a lot of time will
402be spent sending and receiving unnecessary information about holes that
403already exist on the receiving side.
404
405Once the \fBhole_birth\fR feature has been enabled the block birth times
406of all new holes will be recorded. Incremental sends between snapshots
407created after this feature is enabled will use this new metadata to avoid
408sending information about holes that already exist on the receiving side.
409
410This feature becomes \fBactive\fR as soon as it is enabled and will
411never return to being \fBenabled\fB.
412
413.RE
414
9b67f605
MA
415.sp
416.ne 2
417.na
418\fB\fBembedded_data\fR\fR
419.ad
420.RS 4n
421.TS
422l l .
423GUID com.delphix:embedded_data
424READ\-ONLY COMPATIBLE no
425DEPENDENCIES none
426.TE
427
428This feature improves the performance and compression ratio of
429highly-compressible blocks. Blocks whose contents can compress to 112 bytes
430or smaller can take advantage of this feature.
431
432When this feature is enabled, the contents of highly-compressible blocks are
433stored in the block "pointer" itself (a misnomer in this case, as it contains
6b4e21c6 434the compressed data, rather than a pointer to its location on disk). Thus
9b67f605
MA
435the space of the block (one sector, typically 512 bytes or 4KB) is saved,
436and no additional i/o is needed to read and write the data block.
437
438This feature becomes \fBactive\fR as soon as it is enabled and will
439never return to being \fBenabled\fR.
440
441.RE
a1d477c2
MA
442.sp
443.ne 2
444.na
445\fB\fBdevice_removal\fR\fR
446.ad
447.RS 4n
448.TS
449l l .
450GUID com.delphix:device_removal
451READ\-ONLY COMPATIBLE no
452DEPENDENCIES none
453.TE
454
9042ca0e 455This feature enables the \fBzpool remove\fR subcommand to remove top-level
a1d477c2
MA
456vdevs, evacuating them to reduce the total size of the pool.
457
9042ca0e 458This feature becomes \fBactive\fR when the \fBzpool remove\fR subcommand is used
a1d477c2
MA
459on a top-level vdev, and will never return to being \fBenabled\fR.
460
461.RE
462.sp
463.ne 2
464.na
465\fB\fBobsolete_counts\fR\fR
466.ad
467.RS 4n
468.TS
469l l .
470GUID com.delphix:obsolete_counts
471READ\-ONLY COMPATIBLE yes
472DEPENDENCIES device_removal
473.TE
b0bc7a84 474
a1d477c2
MA
475This feature is an enhancement of device_removal, which will over time
476reduce the memory used to track removed devices. When indirect blocks
477are freed or remapped, we note that their part of the indirect mapping
6e91a72f 478is "obsolete", i.e. no longer needed.
a1d477c2 479
9042ca0e 480This feature becomes \fBactive\fR when the \fBzpool remove\fR subcommand is
a1d477c2
MA
481used on a top-level vdev, and will never return to being \fBenabled\fR.
482
483.RE
f1512ee6
MA
484.sp
485.ne 2
486.na
d2734cce
SD
487\fB\fBzpool_checkpoint\fR\fR
488.ad
489.RS 4n
490.TS
491l l .
492GUID com.delphix:zpool_checkpoint
493READ\-ONLY COMPATIBLE yes
494DEPENDENCIES none
495.TE
496
9042ca0e 497This feature enables the \fBzpool checkpoint\fR subcommand that can
d2734cce
SD
498checkpoint the state of the pool at the time it was issued and later
499rewind back to it or discard it.
500
9042ca0e 501This feature becomes \fBactive\fR when the \fBzpool checkpoint\fR subcommand
d2734cce
SD
502is used to checkpoint the pool.
503The feature will only return back to being \fBenabled\fR when the pool
504is rewound or the checkpoint has been discarded.
3be1eb29 505
4d044c4c
SD
506.RE
507.sp
508.ne 2
509.na
510\fB\fBspacemap_v2\fR\fR
511.ad
512.RS 4n
513.TS
514l l .
515GUID com.delphix:spacemap_v2
516READ\-ONLY COMPATIBLE yes
517DEPENDENCIES none
518.TE
519
520This feature enables the use of the new space map encoding which
521consists of two words (instead of one) whenever it is advantageous.
522The new encoding allows space maps to represent large regions of
523space more efficiently on-disk while also increasing their maximum
524addressable offset.
525
526This feature becomes \fBactive\fR once it is \fBenabled\fR, and never
527returns back to being \fBenabled\fR.
528
3be1eb29
TC
529.RE
530.sp
531.ne 2
532.na
f1512ee6
MA
533\fB\fBlarge_blocks\fR\fR
534.ad
535.RS 4n
536.TS
537l l .
538GUID org.open-zfs:large_block
539READ\-ONLY COMPATIBLE no
540DEPENDENCIES extensible_dataset
541.TE
542
543The \fBlarge_block\fR feature allows the record size on a dataset to be
544set larger than 128KB.
545
405ec516 546This feature becomes \fBactive\fR once a dataset contains a file with
547a block size larger than 128KB, and will return to being \fBenabled\fR once all
f1512ee6
MA
548filesystems that have ever had their recordsize larger than 128KB are destroyed.
549.RE
550
50c957f7
NB
551.sp
552.ne 2
553.na
554\fB\fBlarge_dnode\fR\fR
555.ad
556.RS 4n
557.TS
558l l .
559GUID org.zfsonlinux:large_dnode
560READ\-ONLY COMPATIBLE no
561DEPENDENCIES extensible_dataset
562.TE
563
564The \fBlarge_dnode\fR feature allows the size of dnodes in a dataset to be
565set larger than 512B.
566
567This feature becomes \fBactive\fR once a dataset contains an object with
568a dnode larger than 512B, which occurs as a result of setting the
569\fBdnodesize\fR dataset property to a value other than \fBlegacy\fR. The
570feature will return to being \fBenabled\fR once all filesystems that
571have ever contained a dnode larger than 512B are destroyed. Large dnodes
572allow more data to be stored in the bonus buffer, thus potentially
573improving performance by avoiding the use of spill blocks.
574.RE
575
3c67d83a
TH
576\fB\fBsha512\fR\fR
577.ad
578.RS 4n
579.TS
580l l .
581GUID org.illumos:sha512
582READ\-ONLY COMPATIBLE no
125a406e 583DEPENDENCIES extensible_dataset
3c67d83a
TH
584.TE
585
586This feature enables the use of the SHA-512/256 truncated hash algorithm
587(FIPS 180-4) for checksum and dedup. The native 64-bit arithmetic of
588SHA-512 provides an approximate 50% performance boost over SHA-256 on
58964-bit hardware and is thus a good minimum-change replacement candidate
590for systems where hash performance is important, but these systems
591cannot for whatever reason utilize the faster \fBskein\fR and
592\fBedonr\fR algorithms.
593
594When the \fBsha512\fR feature is set to \fBenabled\fR, the administrator
9042ca0e
RL
595can turn on the \fBsha512\fR checksum on any dataset using
596\fBzfs set checksum=sha512\fR. See zfs(8). This feature becomes
3c67d83a
TH
597\fBactive\fR once a \fBchecksum\fR property has been set to \fBsha512\fR,
598and will return to being \fBenabled\fR once all filesystems that have
599ever had their checksum set to \fBsha512\fR are destroyed.
600
6c0f78f8
RL
601The \fBsha512\fR feature is not supported by GRUB and must not be used on
602the pool if GRUB needs to access the pool (e.g. for /boot).
3c67d83a
TH
603
604.RE
605
606.sp
607.ne 2
608.na
609\fB\fBskein\fR\fR
610.ad
611.RS 4n
612.TS
613l l .
614GUID org.illumos:skein
615READ\-ONLY COMPATIBLE no
125a406e 616DEPENDENCIES extensible_dataset
3c67d83a
TH
617.TE
618
619This feature enables the use of the Skein hash algorithm for checksum
620and dedup. Skein is a high-performance secure hash algorithm that was a
621finalist in the NIST SHA-3 competition. It provides a very high security
622margin and high performance on 64-bit hardware (80% faster than
623SHA-256). This implementation also utilizes the new salted checksumming
624functionality in ZFS, which means that the checksum is pre-seeded with a
625secret 256-bit random key (stored on the pool) before being fed the data
626block to be checksummed. Thus the produced checksums are unique to a
627given pool, preventing hash collision attacks on systems with dedup.
628
629When the \fBskein\fR feature is set to \fBenabled\fR, the administrator
9042ca0e
RL
630can turn on the \fBskein\fR checksum on any dataset using
631\fBzfs set checksum=skein\fR. See zfs(8). This feature becomes
3c67d83a
TH
632\fBactive\fR once a \fBchecksum\fR property has been set to \fBskein\fR,
633and will return to being \fBenabled\fR once all filesystems that have
634ever had their checksum set to \fBskein\fR are destroyed.
635
6c0f78f8
RL
636The \fBskein\fR feature is not supported by GRUB and must not be used on
637the pool if GRUB needs to access the pool (e.g. for /boot).
3c67d83a
TH
638
639.RE
640
641.sp
642.ne 2
643.na
644\fB\fBedonr\fR\fR
645.ad
646.RS 4n
647.TS
648l l .
649GUID org.illumos:edonr
650READ\-ONLY COMPATIBLE no
125a406e 651DEPENDENCIES extensible_dataset
3c67d83a
TH
652.TE
653
654This feature enables the use of the Edon-R hash algorithm for checksum,
655including for nopwrite (if compression is also enabled, an overwrite of
656a block whose checksum matches the data being written will be ignored).
7886aa8a
RL
657In an abundance of caution, Edon-R requires verification when used with
658dedup: \fBzfs set dedup=edonr,verify\fR. See \fBzfs\fR(8).
3c67d83a
TH
659
660Edon-R is a very high-performance hash algorithm that was part
661of the NIST SHA-3 competition. It provides extremely high hash
662performance (over 350% faster than SHA-256), but was not selected
663because of its unsuitability as a general purpose secure hash algorithm.
664This implementation utilizes the new salted checksumming functionality
665in ZFS, which means that the checksum is pre-seeded with a secret
666256-bit random key (stored on the pool) before being fed the data block
667to be checksummed. Thus the produced checksums are unique to a given
668pool.
669
670When the \fBedonr\fR feature is set to \fBenabled\fR, the administrator
671can turn on the \fBedonr\fR checksum on any dataset using the
9042ca0e 672\fBzfs set checksum=edonr\fR. See zfs(8). This feature becomes
3c67d83a
TH
673\fBactive\fR once a \fBchecksum\fR property has been set to \fBedonr\fR,
674and will return to being \fBenabled\fR once all filesystems that have
675ever had their checksum set to \fBedonr\fR are destroyed.
676
6c0f78f8
RL
677The \fBedonr\fR feature is not supported by GRUB and must not be used on
678the pool if GRUB needs to access the pool (e.g. for /boot).
3c67d83a 679
9ff13dbe
BB
680.RE
681
1de321e6
JX
682.sp
683.ne 2
684.na
685\fB\fBuserobj_accounting\fR\fR
686.ad
687.RS 4n
688.TS
689l l .
690GUID org.zfsonlinux:userobj_accounting
691READ\-ONLY COMPATIBLE yes
692DEPENDENCIES extensible_dataset
693.TE
694
695This feature allows administrators to account the object usage information
696by user and group.
697
698This feature becomes \fBactive\fR as soon as it is enabled and will never
699return to being \fBenabled\fR. Each filesystem will be upgraded automatically
700when remounted, or when new files are created under that filesystem.
701The upgrade can also be started manually on filesystems by running
702`zfs set version=current <pool/fs>`. The upgrade process runs in the background
703and may take a while to complete for filesystems containing a large number of
704files.
705
706.RE
707
579ce7c5
TC
708.sp
709.ne 2
710.na
711\fB\fBbookmark_v2\fR\fR
712.ad
713.RS 4n
714.TS
715l l .
716GUID com.datto:bookmark_v2
717READ\-ONLY COMPATIBLE no
718DEPENDENCIES extensible_dataset
719.TE
720
721This feature enables the creation and management of larger bookmarks which are
722needed for other features in ZFS.
723
724This feature becomes \fBactive\fR when a v2 bookmark is created and will be
725returned to the \fBenabled\fR state when all v2 bookmarks are destroyed.
726
727.RE
728
b5256303
TC
729.sp
730.ne 2
731.na
732\fB\fBencryption\fR\fR
733.ad
734.RS 4n
735.TS
736l l .
737GUID com.datto:encryption
738READ\-ONLY COMPATIBLE no
739DEPENDENCIES extensible_dataset
740.TE
741
742This feature enables the creation and management of natively encrypted datasets.
743
744This feature becomes \fBactive\fR when an encrypted dataset is created and will
745be returned to the \fBenabled\fR state when all datasets that use this feature
746are destroyed.
747
748.RE
749
9c5167d1
NF
750.sp
751.ne 2
752.na
753\fB\fBproject_quota\fR\fR
754.ad
755.RS 4n
756.TS
757l l .
758GUID org.zfsonlinux:project_quota
759READ\-ONLY COMPATIBLE yes
760DEPENDENCIES extensible_dataset
761.TE
762
763This feature allows administrators to account the spaces and objects usage
764information against the project identifier (ID).
765
766The project ID is new object-based attribute. When upgrading an existing
767filesystem, object without project ID attribute will be assigned a zero
768project ID. After this feature is enabled, newly created object will inherit
769its parent directory's project ID if the parent inherit flag is set (via
770\fBchattr +/-P\fR or \fBzfs project [-s|-C]\fR). Otherwise, the new object's
771project ID will be set as zero. An object's project ID can be changed at
772anytime by the owner (or privileged user) via \fBchattr -p $prjid\fR or
773\fBzfs project -p $prjid\fR.
774
775This feature will become \fBactive\fR as soon as it is enabled and will never
776return to being \fBdisabled\fR. Each filesystem will be upgraded automatically
777when remounted or when new file is created under that filesystem. The upgrade
778can also be triggered on filesystems via `zfs set version=current <pool/fs>`.
779The upgrade process runs in the background and may take a while to complete
780for the filesystems containing a large number of files.
781
80a91e74
TC
782.RE
783.sp
784.ne 2
785.na
786\fB\fBresilver_defer\fR\fR
787.ad
788.RS 4n
789.TS
790l l .
791GUID com.datto:resilver_defer
792READ\-ONLY COMPATIBLE yes
793DEPENDENCIES none
794.TE
795
796This feature allows zfs to postpone new resilvers if an existing one is already
797in progress. Without this feature, any new resilvers will cause the currently
798running one to be immediately restarted from the beginning.
799
612c4930
RL
800This feature becomes \fBactive\fR once a resilver has been deferred, and
801returns to being \fBenabled\fR when the deferred resilver begins.
80a91e74 802
9c5167d1
NF
803.RE
804
cc99f275
DB
805.sp
806.ne 2
807.na
808\fB\fBallocation_classes\fR\fR
809.ad
810.RS 4n
811.TS
812l l .
81155b29 813GUID org.zfsonlinux:allocation_classes
cc99f275
DB
814READ\-ONLY COMPATIBLE yes
815DEPENDENCIES none
816.TE
817
818This feature enables support for separate allocation classes.
819
820This feature becomes \fBactive\fR when a dedicated allocation class vdev
9042ca0e
RL
821(dedup or special) is created with the \fBzpool create\fR or \fBzpool add\fR
822subcommands. With device removal, it can be returned to the \fBenabled\fR
823state if all the dedicated allocation class vdevs are removed.
cc99f275
DB
824
825.RE
826
9ae529ec 827.SH "SEE ALSO"
9042ca0e 828zpool(8)