2 .\" Copyright (c) 2013, Martin Matuska <mm@FreeBSD.org>.
3 .\" All Rights Reserved.
5 .\" The contents of this file are subject to the terms of the
6 .\" Common Development and Distribution License (the "License").
7 .\" You may not use this file except in compliance with the License.
9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10 .\" or http://www.opensolaris.org/os/licensing.
11 .\" See the License for the specific language governing permissions
12 .\" and limitations under the License.
14 .\" When distributing Covered Code, include this CDDL HEADER in each
15 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16 .\" If applicable, add the following below this CDDL HEADER, with the
17 .\" fields enclosed by brackets "[]" replaced with your own identifying
18 .\" information: Portions Copyright [yyyy] [name of copyright owner]
20 .\" Copyright (c) 2010, Sun Microsystems, Inc. All Rights Reserved.
21 .\" Copyright (c) 2013 by Delphix. All rights reserved.
22 .\" Copyright (c) 2011, Pawel Jakub Dawidek <pjd@FreeBSD.org>
23 .\" Copyright (c) 2012, Bryan Drewery <bdrewery@FreeBSD.org>
24 .\" Copyright (c) 2012, Glen Barber <gjb@FreeBSD.org>
25 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
26 .\" Copyright (c) 2013 Nexenta Systems, Inc. All Rights Reserved.
27 .\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
28 .\" Copyright (c) 2013, Steven Hartland <smh@FreeBSD.org>
29 .\" Copyright (c) 2014, Xin LI <delphij@FreeBSD.org>
38 .Nd configures ZFS file systems
45 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... Ar filesystem
50 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
56 .Ar filesystem Ns | Ns Ar volume
61 .Ar filesystem Ns | Ns volume
64 .Op , Ns Ar snap Op % Ns Ar snap
69 .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
71 .Cm snapshot Ns | Ns Cm snap
73 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
74 .Ar filesystem@snapname Ns | Ns Ar volume@snapname
75 .Ar filesystem@snapname Ns | Ns Ar volume@snapname Ns ...
83 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
84 .Ar snapshot filesystem Ns | Ns Ar volume
91 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
92 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
97 .Ar filesystem Ns | Ns Ar volume
98 .Ar filesystem Ns | Ns Ar volume
102 .Ar snapshot snapshot
107 .Ar filesystem filesystem
110 .Op Fl r Ns | Ns Fl d Ar depth
112 .Op Fl o Ar property Ns Oo , Ns property Ns Oc Ns ...
113 .Op Fl t Ar type Ns Oo , Ns type Ns Oc Ns ...
114 .Oo Fl s Ar property Oc Ns ...
115 .Oo Fl S Ar property Oc Ns ...
116 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
119 .Ar property Ns = Ns Ar value
120 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
123 .Op Fl r Ns | Ns Fl d Ar depth
125 .Op Fl o Ar all | field Ns Oo , Ns Ar field Oc Ns ...
126 .Op Fl t Ar type Ns Oo Ns , Ar type Oc Ns ...
127 .Op Fl s Ar source Ns Oo Ns , Ns Ar source Oc Ns ...
128 .Ar all | property Ns Oo Ns , Ns Ar property Oc Ns ...
129 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
134 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
142 .Fl a | Ar filesystem
146 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
147 .Oo Fl s Ar field Oc Ns ...
148 .Oo Fl S Ar field Oc Ns ...
149 .Op Fl t Ar type Ns Oo Ns , Ns Ar type Oc Ns ...
150 .Ar filesystem Ns | Ns Ar snapshot
154 .Op Fl o Ar field Ns Oo , Ns field Oc Ns ...
155 .Oo Fl s Ar field Oc Ns ...
156 .Oo Fl S Ar field Oc Ns ...
157 .Op Fl t Ar type Ns Oo Ns , Ns Ar type Oc Ns ...
158 .Ar filesystem Ns | Ns Ar snapshot
164 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
165 .Fl a | Ar filesystem
167 .Cm unmount Ns | Ns Cm umount
169 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
172 .Fl a | Ar filesystem
175 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
183 .Op Fl i Ar snapshot | Fl I Ar snapshot
187 .Op Fl i Ar snapshot Ns | Ns bookmark
188 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
190 .Cm receive Ns | Ns Cm recv
192 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
194 .Cm receive Ns | Ns Cm recv
200 .Ar filesystem Ns | Ns Ar volume
204 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
205 .Ar perm Ns | Ns Ar @setname Ns
206 .Oo Ns , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
207 .Ar filesystem Ns | Ns Ar volume
211 .Fl e Ns | Ns Cm everyone
212 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
214 .Ar filesystem Ns | Ns Ar volume
218 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
220 .Ar filesystem Ns | Ns Ar volume
225 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
227 .Ar filesystem Ns | Ns Ar volume
231 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
232 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
234 .Ar filesystem Ns | Ns Ar volume
238 .Fl e Ns | Ns Cm everyone
239 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
241 .Ar filesystem Ns | Ns Ar volume
246 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
248 .Ar filesystem Ns | Ns Ar volume
254 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
256 .Ar filesystem Ns | Ns Ar volume
260 .Ar tag snapshot Ns ...
268 .Ar tag snapshot Ns ...
273 .Op Ar snapshot Ns | Ns Ar filesystem
276 .Ar jailid Ns | Ns Ar jailname filesystem
279 .Ar jailid Ns | Ns Ar jailname filesystem
287 storage pool, as described in
289 A dataset is identified by a unique path within the
291 namespace. For example:
292 .Bd -ragged -offset 4n
293 .No pool/ Ns Brq filesystem,volume,snapshot
296 where the maximum length of a dataset name is
300 A dataset can be one of the following:
307 can be mounted within the standard system namespace and behaves like other file
310 file systems are designed to be
312 compliant, known issues exist that prevent compliance in some cases.
313 Applications that depend on standards conformance might fail due to nonstandard
314 behavior when checking file system free space.
316 A logical volume exported as a raw or block device. This type of dataset should
317 only be used under special circumstances. File systems are typically used in
320 A read-only version of a file system or volume at a given point in time. It is
326 .Ss ZFS File System Hierarchy
329 storage pool is a logical collection of devices that provide space for
330 datasets. A storage pool is also the root of the
332 file system hierarchy.
334 The root of the pool can be accessed as a file system, such as mounting and
335 unmounting, taking snapshots, and setting properties. The physical storage
336 characteristics, however, are managed by the
342 for more information on creating and administering pools.
344 A snapshot is a read-only copy of a file system or volume. Snapshots can be
345 created extremely quickly, and initially consume no additional space within the
346 pool. As data within the active dataset changes, the snapshot consumes more
347 data than would otherwise be shared with the active dataset.
349 Snapshots can have arbitrary names. Snapshots of volumes can be cloned or
350 rolled back, but cannot be accessed independently.
352 File system snapshots can be accessed under the
354 directory in the root of the file system. Snapshots are automatically mounted
355 on demand and may be unmounted at regular intervals. The visibility of the
357 directory can be controlled by the
361 A clone is a writable volume or file system whose initial contents are the same
362 as another dataset. As with snapshots, creating a clone is nearly
363 instantaneous, and initially consumes no additional space.
365 Clones can only be created from a snapshot. When a snapshot is cloned, it
366 creates an implicit dependency between the parent and child. Even though the
367 clone is created somewhere else in the dataset hierarchy, the original snapshot
368 cannot be destroyed as long as a clone exists. The
370 property exposes this dependency, and the
372 command lists any such dependencies, if they exist.
374 The clone parent-child dependency relationship can be reversed by using the
376 subcommand. This causes the "origin" file system to become a clone of the
377 specified file system, which makes it possible to destroy the file system that
378 the clone was created from.
382 file system is a simple operation, so the number of file systems per system is
383 likely to be numerous. To cope with this,
385 automatically manages mounting and unmounting file systems without the need to
388 file. All automatically managed file systems are mounted by
392 By default, file systems are mounted under
396 is the name of the file system in the
398 namespace. Directories are created and destroyed as needed.
400 A file system can also have a mount point set in the
402 property. This directory is created as needed, and
404 automatically mounts the file system when the
406 command is invoked (without editing
410 property can be inherited, so if
416 automatically inherits a mount point of
423 prevents the file system from being mounted.
427 file systems can also be managed with traditional tools
428 .Pq Xr mount 8 , Xr umount 8 , Xr fstab 5 .
429 If a file system's mount point is set to
432 makes no attempt to manage the file system, and the administrator is
433 responsible for mounting and unmounting the file system.
436 dataset can be attached to a jail by using the
438 subcommand. You cannot attach a dataset to one jail and the children of the
439 same dataset to another jails. To allow management of the dataset from within
442 property has to be set. The
444 property cannot be changed from within a jail.
447 dataset can be detached from a jail using the
451 After a dataset is attached to a jail and the jailed property is set, a jailed
452 file system cannot be mounted outside the jail, since the jail administrator
453 might have set the mount point to an unacceptable value.
455 Deduplication is the process for removing redundant data at the block-level,
456 reducing the total amount of data stored. If a file system has the
458 property enabled, duplicate data blocks are removed synchronously. The result
459 is that only unique data is stored and common components are shared among
461 .Ss Native Properties
462 Properties are divided into two types, native properties and user-defined (or
463 "user") properties. Native properties either export internal statistics or
466 behavior. In addition, native properties are either editable or read-only. User
467 properties have no effect on
469 behavior, but you can use them to annotate datasets in a way that is meaningful
470 in your environment. For more information about user properties, see the
471 .Qq Sx User Properties
474 Every dataset has a set of properties that export statistics about the dataset
475 as well as control various behaviors. Properties are inherited from the parent
476 unless overridden by the child. Some properties apply only to certain types of
477 datasets (file systems, volumes, or snapshots).
479 The values of numeric properties can be specified using human-readable suffixes
481 .Sy k , KB , M , Gb ,
484 for zettabyte). The following are all valid (and equal) specifications:
485 .Bd -ragged -offset 4n
489 The values of non-numeric properties are case sensitive and must be lowercase,
491 .Sy mountpoint , sharenfs , No and Sy sharesmb .
493 The following native properties consist of read-only statistics about the
494 dataset. These properties can be neither set, nor inherited. Native properties
495 apply to all dataset types unless otherwise noted.
498 The amount of space available to the dataset and all its children, assuming
499 that there is no other activity in the pool. Because space is shared within a
500 pool, availability can be limited by any number of factors, including physical
501 pool size, quotas, reservations, or other datasets within the pool.
503 This property can also be referred to by its shortened column name,
506 For non-snapshots, the compression ratio achieved for the
508 space of this dataset, expressed as a multiplier. The
510 property includes descendant datasets, and, for clones, does not include
511 the space shared with the origin snapshot. For snapshots, the
515 property. Compression can be turned on by running:
516 .Qq Nm Cm set compression=on Ar dataset
520 The time this dataset was created.
522 For snapshots, this property is a comma-separated list of filesystems or
523 volumes which are clones of this snapshot. The clones'
525 property is this snapshot. If the
527 property is not empty, then this snapshot can not be destroyed (even with the
535 if the snapshot has been marked for deferred destroy by using the
537 command. Otherwise, the property is
539 .It Sy filesystem_count
540 The total number of filesystems and volumes that exist under this location in the
542 This value is only available when a
545 been set somewhere in the tree under which the dataset resides.
546 .It Sy logicalreferenced
547 The amount of space that is
549 accessible by this dataset.
553 The logical space ignores the effect of the
557 properties, giving a quantity closer to the amount of data that applications
559 However, it does include space consumed by metadata.
561 This property can also be referred to by its shortened column name,
564 The amount of space that is
566 consumed by this dataset and all its descendents.
570 The logical space ignores the effect of the
574 properties, giving a quantity closer to the amount of data that applications
577 This property can also be referred to by its shortened column name,
580 For file systems, indicates whether the file system is currently mounted. This
581 property can be either
586 For cloned file systems or volumes, the snapshot from which the clone was
587 created. See also the
591 The amount of data that is accessible by this dataset, which may or may not be
592 shared with other datasets in the pool. When a snapshot or clone is created, it
593 initially references the same amount of space as the file system or snapshot it
594 was created from, since its contents are identical.
596 This property can also be referred to by its shortened column name,
598 .It Sy refcompressratio
599 The compression ratio achieved for the
601 space of this dataset, expressed as a multiplier. See also the
604 .It Sy snapshot_count
605 The total number of snapshots that exist under this location in the dataset tree.
606 This value is only available when a
608 has been set somewhere
609 in the tree under which the dataset resides.
612 .Sy filesystem , volume , No or Sy snapshot .
614 The amount of space consumed by this dataset and all its descendents. This is
615 the value that is checked against this dataset's quota and reservation. The
616 space used does not include this dataset's reservation, but does take into
617 account the reservations of any descendent datasets. The amount of space that a
618 dataset consumes from its parent, as well as the amount of space that are freed
619 if this dataset is recursively destroyed, is the greater of its space used and
622 When snapshots (see the
624 section) are created, their space is
625 initially shared between the snapshot and the file system, and possibly with
626 previous snapshots. As the file system changes, space that was previously
627 shared becomes unique to the snapshot, and counted in the snapshot's space
628 used. Additionally, deleting snapshots can increase the amount of space unique
629 to (and used by) other snapshots.
631 The amount of space used, available, or referenced does not take into account
632 pending changes. Pending changes are generally accounted for within a few
633 seconds. Committing a change to a disk using
637 does not necessarily guarantee that the space usage information is updated
642 properties decompose the
644 properties into the various reasons that space is used. Specifically,
646 .Sy usedbysnapshots + usedbydataset + usedbychildren + usedbyrefreservation .
647 These properties are only available for datasets created
650 pool version 13 pools and higher.
651 .It Sy usedbysnapshots
652 The amount of space consumed by snapshots of this dataset. In particular, it is
653 the amount of space that would be freed if all of this dataset's snapshots were
654 destroyed. Note that this is not simply the sum of the snapshots'
656 properties because space can be shared by multiple snapshots.
658 The amount of space used by this dataset itself, which would be freed if the
659 dataset were destroyed (after first removing any
661 and destroying any necessary snapshots or descendents).
662 .It Sy usedbychildren
663 The amount of space used by children of this dataset, which would be freed if
664 all the dataset's children were destroyed.
665 .It Sy usedbyrefreservation
666 The amount of space used by a
668 set on this dataset, which would be freed if the
671 .It Sy userused@ Ns Ar user
672 The amount of space consumed by the specified user in this dataset. Space is
673 charged to the owner of each file, as displayed by
675 The amount of space charged is displayed by
681 subcommand for more information.
683 Unprivileged users can access only their own space usage. The root user, or a
684 user who has been granted the
688 can access everyone's usage.
692 properties are not displayed by
694 The user's name must be appended after the
696 symbol, using one of the following forms:
697 .Bl -bullet -offset 2n
699 POSIX name (for example,
702 POSIX numeric ID (for example,
706 This property is set to the number of user holds on this snapshot. User holds
710 .It Sy groupused@ Ns Ar group
711 The amount of space consumed by the specified group in this dataset. Space is
712 charged to the group of each file, as displayed by
715 .Sy userused@ Ns Ar user
716 property for more information.
718 Unprivileged users can only access their own groups' space usage. The root
719 user, or a user who has been granted the
723 can access all groups' usage.
724 .It Sy volblocksize Ns = Ns Ar blocksize
725 For volumes, specifies the block size of the volume. The
727 cannot be changed once the volume has been written, so it should be set at
728 volume creation time. The default
730 for volumes is 8 Kbytes. Any
731 power of 2 from 512 bytes to 128 Kbytes is valid.
733 This property can also be referred to by its shortened column name,
738 space written to this dataset since the previous snapshot.
739 .It Sy written@ Ns Ar snapshot
742 space written to this dataset since the specified snapshot. This is the space
743 that is referenced by this dataset but was not referenced by the specified
748 may be specified as a short snapshot name (just the part after the
750 in which case it will be interpreted as a snapshot in the same filesystem as
753 may be a full snapshot name
754 .Pq Em filesystem@snapshot ,
755 which for clones may be a snapshot in the origin's filesystem (or the origin of
756 the origin's filesystem, etc).
759 The following native properties can be used to change the behavior of a
764 .Sy aclinherit Ns = Ns Cm discard |
772 entries are inherited when files and directories are created. A file system
779 entries. A file system with an
783 only inherits inheritable
785 entries that specify "deny" permissions. The property value
787 (the default) removes the
793 entry is inherited. A file system with an
797 inherits all inheritable
799 entries without any modifications made to the
801 entries when they are inherited. A file system with an
805 has the same meaning as
808 .Em owner@ , group@ , No and Em everyone@ Tn ACE Ns s
809 inherit the execute permission only if the file creation mode also requests the
812 When the property value is set to
814 files are created with a mode determined by the inheritable
818 exist that affect the mode, then the mode is set in accordance to the requested
819 mode from the application.
820 .It Sy aclmode Ns = Ns Cm discard | groupmask | passthrough | restricted
825 A file system with an
829 (the default) deletes all
831 entries that do not represent the mode of the file. An
835 reduces permissions granted in all
839 such that they are no greater than the group permissions specified by
841 A file system with an
845 indicates that no changes are made to the
847 other than creating or updating the necessary
849 entries to represent the new mode of the file or directory.
856 operation to return an error when used on any file or directory which has
859 whose entries can not be represented by a mode.
861 is required to change the set user ID, set group ID, or sticky bits on a file
862 or directory, as they do not have equivalent
867 on a file or directory with a non-trivial
873 you must first remove all
875 entries which do not represent the current mode.
876 .It Sy atime Ns = Ns Cm on | off
877 Controls whether the access time for files is updated when they are read.
878 Turning this property off avoids producing write traffic when reading files and
879 can result in significant performance gains, though it might confuse mailers
880 and other similar utilities. The default value is
882 .It Sy canmount Ns = Ns Cm on | off | noauto
883 If this property is set to
885 the file system cannot be mounted, and is ignored by
886 .Qq Nm Cm mount Fl a .
887 Setting this property to
889 is similar to setting the
893 except that the dataset still has a normal
895 property, which can be inherited. Setting this property to
897 allows datasets to be used solely as a mechanism to inherit properties. One
899 .Sy canmount Ns = Ns Cm off
900 is to have two datasets with the same
902 so that the children of both datasets appear in the same directory, but might
903 have different inherited characteristics.
907 value is set, a dataset can only be mounted and unmounted explicitly. The
908 dataset is not mounted automatically when the dataset is created or imported,
909 nor is it mounted by the
911 command or unmounted by the
912 .Qq Nm Cm umount Fl a
915 This property is not inherited.
916 .It Sy checksum Ns = Ns Cm on | off | fletcher2 | fletcher4 | sha256 | noparity
917 Controls the checksum used to verify data integrity. The default value is
919 which automatically selects an appropriate algorithm (currently,
921 but this may change in future releases). The value
923 disables integrity checking on user data.
927 disables integrity but also disables maintaining parity for user data. This
928 setting is used internally by a dump device residing on a RAID-Z pool and should
929 not be used by any other dataset.
930 Disabling checksums is
932 a recommended practice.
933 .It Sy compression Ns = Ns Cm on | off | lzjb | gzip | gzip- Ns Ar N | zle | Cm lz4
934 Controls the compression algorithm used for this dataset. The
936 compression algorithm is optimized for performance while providing decent data
937 compression. Setting compression to
941 compression algorithm. The
943 compression algorithm uses the same compression as the
945 command. You can specify the
947 level by using the value
951 is an integer from 1 (fastest) to 9 (best compression ratio). Currently,
955 (which is also the default for
959 compression algorithm compresses runs of zeros.
963 compression algorithm is a high-performance replacement
966 algorithm. It features significantly faster
967 compression and decompression, as well as a moderately higher
968 compression ratio than
970 but can only be used on pools with
977 for details on ZFS feature flags and the
981 This property can also be referred to by its shortened column name
983 Changing this property affects only newly-written data.
984 .It Sy copies Ns = Ns Cm 1 | 2 | 3
985 Controls the number of copies of data stored for this dataset. These copies are
986 in addition to any redundancy provided by the pool, for example, mirroring or
987 RAID-Z. The copies are stored on different disks, if possible. The space used
988 by multiple copies is charged to the associated file and dataset, changing the
990 property and counting against quotas and reservations.
992 Changing this property only affects newly-written data. Therefore, set this
993 property at file system creation time by using the
994 .Fl o Cm copies= Ns Ar N
996 .It Sy dedup Ns = Ns Cm on | off | verify | sha256 Ns Op Cm ,verify
997 Configures deduplication for a dataset. The default value is
999 The default deduplication checksum is
1001 (this may change in the future).
1004 is enabled, the checksum defined here overrides the
1006 property. Setting the value to
1008 has the same effect as the setting
1014 will do a byte-to-byte comparsion in case of two blocks having the same
1015 signature to make sure the block contents are identical.
1016 .It Sy devices Ns = Ns Cm on | off
1019 property is currently not supported on
1021 .It Sy exec Ns = Ns Cm on | off
1022 Controls whether processes can be executed from within this file system. The
1025 .It Sy mlslabel Ns = Ns Ar label | Cm none
1028 property is currently not supported on
1030 .It Sy filesystem_limit Ns = Ns Ar count | Cm none
1031 Limits the number of filesystems and volumes that can exist under this point in
1033 The limit is not enforced if the user is allowed to change
1036 .Sy filesystem_limit
1037 on a descendent of a filesystem that
1039 .Sy filesystem_limit
1040 does not override the ancestor's
1041 .Sy filesystem_limit ,
1042 but rather imposes an additional limit.
1043 This feature must be enabled to be used
1045 .Xr zpool-features 7
1047 .It Sy mountpoint Ns = Ns Ar path | Cm none | legacy
1048 Controls the mount point used for this file system. See the
1050 section for more information on how this property is used.
1054 property is changed for a file system, the file system and any children that
1055 inherit the mount point are unmounted. If the new value is
1057 then they remain unmounted. Otherwise, they are automatically remounted in the
1058 new location if the property was previously
1062 or if they were mounted before the property was changed. In addition, any
1063 shared file systems are unshared and shared in the new location.
1064 .It Sy nbmand Ns = Ns Cm on | off
1067 property is currently not supported on
1069 .It Sy primarycache Ns = Ns Cm all | none | metadata
1070 Controls what is cached in the primary cache (ARC). If this property is set to
1072 then both user data and metadata is cached. If this property is set to
1074 then neither user data nor metadata is cached. If this property is set to
1076 then only metadata is cached. The default value is
1078 .It Sy quota Ns = Ns Ar size | Cm none
1079 Limits the amount of space a dataset and its descendents can consume. This
1080 property enforces a hard limit on the amount of space used. This includes all
1081 space consumed by descendents, including file systems and snapshots. Setting a
1082 quota on a descendent of a dataset that already has a quota does not override
1083 the ancestor's quota, but rather imposes an additional limit.
1085 Quotas cannot be set on volumes, as the
1087 property acts as an implicit quota.
1088 .It Sy snapshot_limit Ns = Ns Ar count | Cm none
1089 Limits the number of snapshots that can be created on a dataset and its
1093 on a descendent of a dataset that already
1096 does not override the ancestor's
1097 .Sy snapshot_limit ,
1099 rather imposes an additional limit.
1100 The limit is not enforced if the user is
1101 allowed to change the limit.
1102 For example, this means that recursive snapshots
1103 taken from the global zone are counted against each delegated dataset within
1105 This feature must be enabled to be used
1107 .Xr zpool-features 7
1109 .It Sy userquota@ Ns Ar user Ns = Ns Ar size | Cm none
1110 Limits the amount of space consumed by the specified user.
1115 space calculation does not include space that is used by descendent datasets,
1116 such as snapshots and clones. User space consumption is identified by the
1117 .Sy userspace@ Ns Ar user
1120 Enforcement of user quotas may be delayed by several seconds. This delay means
1121 that a user might exceed their quota before the system notices that they are
1122 over quota and begins to refuse additional writes with the
1124 error message. See the
1126 subcommand for more information.
1128 Unprivileged users can only access their own groups' space usage. The root
1129 user, or a user who has been granted the
1133 can get and set everyone's quota.
1135 This property is not available on volumes, on file systems before version 4, or
1136 on pools before version 15. The
1137 .Sy userquota@ Ns ...
1138 properties are not displayed by
1140 The user's name must be appended after the
1142 symbol, using one of the following forms:
1143 .Bl -bullet -offset 2n
1145 POSIX name (for example,
1148 POSIX numeric ID (for example,
1151 .It Sy groupquota@ Ns Ar group Ns = Ns Ar size | Cm none
1152 Limits the amount of space consumed by the specified group. Group space
1153 consumption is identified by the
1154 .Sy userquota@ Ns Ar user
1157 Unprivileged users can access only their own groups' space usage. The root
1158 user, or a user who has been granted the
1162 can get and set all groups' quotas.
1163 .It Sy readonly Ns = Ns Cm on | off
1164 Controls whether this dataset can be modified. The default value is
1166 .It Sy recordsize Ns = Ns Ar size
1167 Specifies a suggested block size for files in the file system. This property is
1168 designed solely for use with database workloads that access files in fixed-size
1171 automatically tunes block sizes according to internal algorithms optimized for
1172 typical access patterns.
1174 For databases that create very large files but access them in small random
1175 chunks, these algorithms may be suboptimal. Specifying a
1177 greater than or equal to the record size of the database can result in
1178 significant performance gains. Use of this property for general purpose file
1179 systems is strongly discouraged, and may adversely affect performance.
1181 The size specified must be a power of two greater than or equal to 512 and less
1182 than or equal to 128 Kbytes.
1184 Changing the file system's
1186 affects only files created afterward; existing files are unaffected.
1188 This property can also be referred to by its shortened column name,
1190 .It Sy refquota Ns = Ns Ar size | Cm none
1191 Limits the amount of space a dataset can consume. This property enforces a hard
1192 limit on the amount of space used. This hard limit does not include space used
1193 by descendents, including file systems and snapshots.
1194 .It Sy refreservation Ns = Ns Ar size | Cm none
1195 The minimum amount of space guaranteed to a dataset, not including its
1196 descendents. When the amount of space used is below this value, the dataset is
1197 treated as if it were taking up the amount of space specified by
1198 .Sy refreservation .
1201 reservation is accounted for in the parent datasets' space used, and counts
1202 against the parent datasets' quotas and reservations.
1206 is set, a snapshot is only allowed if there is enough free pool space outside
1207 of this reservation to accommodate the current number of "referenced" bytes in
1210 This property can also be referred to by its shortened column name,
1212 .It Sy reservation Ns = Ns Ar size | Cm none
1213 The minimum amount of space guaranteed to a dataset and its descendents. When
1214 the amount of space used is below this value, the dataset is treated as if it
1215 were taking up the amount of space specified by its reservation. Reservations
1216 are accounted for in the parent datasets' space used, and count against the
1217 parent datasets' quotas and reservations.
1219 This property can also be referred to by its shortened column name,
1221 .It Sy secondarycache Ns = Ns Cm all | none | metadata
1222 Controls what is cached in the secondary cache (L2ARC). If this property is set
1225 then both user data and metadata is cached. If this property is set to
1227 then neither user data nor metadata is cached. If this property is set to
1229 then only metadata is cached. The default value is
1231 .It Sy setuid Ns = Ns Cm on | off
1232 Controls whether the
1234 bit is respected for the file system. The default value is
1236 .It Sy sharesmb Ns = Ns Cm on | off | Ar opts
1239 property currently has no effect on
1241 .It Sy sharenfs Ns = Ns Cm on | off | Ar opts
1242 Controls whether the file system is shared via
1244 and what options are used. A file system with a
1248 is managed the traditional way via
1250 Otherwise, the file system is automatically shared and unshared with the
1254 commands. If the property is set to
1258 export options are used. Otherwise,
1260 export options are equivalent to the contents of this property. The export
1261 options may be comma-separated. See
1263 for a list of valid options.
1267 property is changed for a dataset, the
1270 .It Sy logbias Ns = Ns Cm latency | throughput
1273 about handling of synchronous requests in this dataset.
1280 will use pool log devices (if configured) to handle the requests at low
1286 will not use configured pool log devices.
1288 will instead optimize synchronous operations for global pool throughput and
1289 efficient use of resources.
1290 .It Sy snapdir Ns = Ns Cm hidden | visible
1291 Controls whether the
1293 directory is hidden or visible in the root of the file system as discussed in
1296 section. The default value is
1298 .It Sy sync Ns = Ns Cm standard | always | disabled
1299 Controls the behavior of synchronous requests (e.g.
1301 O_DSYNC). This property accepts the following values:
1302 .Bl -tag -offset 4n -width 8n
1304 This is the POSIX specified behavior of ensuring all synchronous requests are
1305 written to stable storage and all devices are flushed to ensure data is not
1306 cached by device controllers (this is the default).
1308 All file system transactions are written and flushed before their system calls
1309 return. This has a large performance penalty.
1311 Disables synchronous requests. File system transactions are only committed to
1312 stable storage periodically. This option will give the highest performance.
1313 However, it is very dangerous as
1315 would be ignoring the synchronous transaction demands of applications such as
1318 Administrators should only use this option when the risks are understood.
1320 .It Sy volsize Ns = Ns Ar size
1321 For volumes, specifies the logical size of the volume. By default, creating a
1322 volume establishes a reservation of equal size. For storage pools with a
1323 version number of 9 or higher, a
1325 is set instead. Any changes to
1327 are reflected in an equivalent change to the reservation (or
1328 .Sy refreservation ) .
1331 can only be set to a multiple of
1335 The reservation is kept equal to the volume's logical size to prevent
1336 unexpected behavior for consumers. Without the reservation, the volume could
1337 run out of space, resulting in undefined behavior or data corruption, depending
1338 on how the volume is used. These effects can also occur when the volume size is
1339 changed while it is in use (particularly when shrinking the size). Extreme care
1340 should be used when adjusting the volume size.
1342 Though not recommended, a "sparse volume" (also known as "thin provisioning")
1343 can be created by specifying the
1346 .Qq Nm Cm create Fl V
1347 command, or by changing the reservation after the volume has been created. A
1348 "sparse volume" is a volume where the reservation is less then the volume size.
1349 Consequently, writes to a sparse volume can fail with
1351 when the pool is low on space. For a sparse volume, changes to
1353 are not reflected in the reservation.
1354 .It Sy vscan Ns = Ns Cm off | on
1357 property is currently not supported on
1359 .It Sy xattr Ns = Ns Cm off | on
1362 property is currently not supported on
1364 .It Sy jailed Ns = Ns Cm off | on
1365 Controls whether the dataset is managed from a jail. See the
1367 section for more information. The default value is
1371 The following three properties cannot be changed after the file system is
1372 created, and therefore, should be set when the file system is created. If the
1373 properties are not set with the
1377 commands, these properties are inherited from the parent dataset. If the parent
1378 dataset lacks these properties due to having been created prior to these
1379 features being supported, the new file system will have the default values for
1382 .It Sy casesensitivity Ns = Ns Cm sensitive | insensitive | mixed
1383 Indicates whether the file name matching algorithm used by the file system
1384 should be case-sensitive, case-insensitive, or allow a combination of both
1385 styles of matching. The default value for the
1389 Traditionally, UNIX and POSIX file systems have case-sensitive file names.
1395 property indicates that the
1396 file system can support requests for both case-sensitive and case-insensitive
1398 .It Sy normalization Ns = Ns Cm none | formC | formD | formKC | formKD
1399 Indicates whether the file system should perform a
1401 normalization of file names whenever two file names are compared, and which
1402 normalization algorithm should be used. File names are always stored
1403 unmodified, names are normalized as part of any comparison process. If this
1404 property is set to a legal value other than
1408 property was left unspecified, the
1410 property is automatically set to
1412 The default value of the
1416 This property cannot be changed after the file system is created.
1417 .It Sy utf8only Ns = Ns Cm on | off
1418 Indicates whether the file system should reject file names that include
1419 characters that are not present in the
1421 character code set. If this property is explicitly set to
1423 the normalization property must either not be explicitly set or be set to
1425 The default value for the
1429 This property cannot be changed after the file system is created.
1433 .Sy casesensitivity , normalization , No and Sy utf8only
1434 properties are also new permissions that can be assigned to non-privileged
1437 delegated administration feature.
1438 .Ss Temporary Mount Point Properties
1439 When a file system is mounted, either through
1441 for legacy mounts or the
1443 command for normal file systems, its mount options are set according to its
1444 properties. The correlation between properties and mount options is as follows:
1445 .Bl -column -offset 4n "PROPERTY" "MOUNT OPTION"
1446 .It PROPERTY MOUNT OPTION
1447 .It atime atime/noatime
1448 .It exec exec/noexec
1450 .It setuid suid/nosuid
1453 In addition, these options can be set on a per-mount basis using the
1455 option, without affecting the property that is stored on disk. The values
1456 specified on the command line override the values stored in the dataset. These
1457 properties are reported as "temporary" by the
1459 command. If the properties are changed while the dataset is mounted, the new
1460 setting overrides any temporary settings.
1462 In addition to the standard native properties,
1464 supports arbitrary user properties. User properties have no effect on
1466 behavior, but applications or administrators can use them to annotate datasets
1467 (file systems, volumes, and snapshots).
1469 User property names must contain a colon
1471 character to distinguish them from native properties. They may contain
1472 lowercase letters, numbers, and the following punctuation characters: colon
1480 The expected convention is that the property name is divided into two portions
1482 .Em module Ns Sy \&: Ns Em property ,
1483 but this namespace is not enforced by
1485 User property names can be at most 256 characters, and cannot begin with a dash
1488 When making programmatic use of user properties, it is strongly suggested to
1493 component of property names to reduce the chance that two
1494 independently-developed packages use the same property name for different
1495 purposes. Property names beginning with
1497 are reserved for use by Sun Microsystems.
1499 The values of user properties are arbitrary strings, are always inherited, and
1500 are never validated. All of the commands that operate on properties
1507 can be used to manipulate both native properties and user properties. Use the
1509 command to clear a user property. If the property is not defined in any parent
1510 dataset, it is removed entirely. Property values are limited to 1024
1513 All subcommands that modify state are logged persistently to the pool in their
1521 Displays a help message.
1526 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1532 file system. The file system is automatically mounted according to the
1534 property inherited from the parent.
1535 .Bl -tag -width indent
1537 Creates all the non-existing parent datasets. Datasets created in this manner
1538 are automatically mounted according to the
1540 property inherited from their parent. Any property specified on the command
1543 option is ignored. If the target filesystem already exists, the operation
1544 completes successfully.
1545 .It Fl o Ar property Ns = Ns Ar value
1546 Sets the specified property as if the command
1547 .Qq Nm Cm set Ar property Ns = Ns Ar value
1548 was invoked at the same time the dataset was created. Any editable
1550 property can also be set at creation time. Multiple
1552 options can be specified. An error results if the same property is specified in
1561 .Op Fl b Ar blocksize
1562 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1567 Creates a volume of the given size. The volume is exported as a block device in
1568 .Pa /dev/zvol/path ,
1571 is the name of the volume in the
1573 namespace. The size represents the logical size as exported by the device. By
1574 default, a reservation of equal size is created.
1577 is automatically rounded up to the nearest 128 Kbytes to ensure that
1578 the volume has an integral number of blocks regardless of
1580 .Bl -tag -width indent
1582 Creates all the non-existing parent datasets. Datasets created in this manner
1583 are automatically mounted according to the
1585 property inherited from their parent. Any property specified on the command
1588 option is ignored. If the target filesystem already exists, the operation
1589 completes successfully.
1591 Creates a sparse volume with no reservation. See
1594 .Qq Sx Native Properties
1595 section for more information about sparse volumes.
1596 .It Fl b Ar blocksize
1598 .Fl o Cm volblocksize Ns = Ns Ar blocksize .
1599 If this option is specified in conjunction with
1600 .Fl o Cm volblocksize ,
1601 the resulting behavior is undefined.
1602 .It Fl o Ar property Ns = Ns Ar value
1603 Sets the specified property as if the
1604 .Qq Nm Cm set Ar property Ns = Ns Ar value
1605 command was invoked at the same time the dataset was created. Any editable
1607 property can also be set at creation time. Multiple
1609 options can be specified. An error results if the same property is specified in
1618 .Ar filesystem Ns | Ns Ar volume
1621 Destroys the given dataset. By default, the command unshares any file systems
1622 that are currently shared, unmounts any file systems that are currently
1623 mounted, and refuses to destroy a dataset that has active dependents (children
1625 .Bl -tag -width indent
1627 Recursively destroy all children.
1629 Recursively destroy all dependents, including cloned file systems outside the
1632 Force an unmount of any file systems using the
1633 .Qq Nm Cm unmount Fl f
1634 command. This option has no effect on non-file systems or unmounted file
1637 Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in
1638 conjunction with the
1642 flags to determine what data would be deleted.
1644 Print machine-parsable verbose information about the deleted data.
1646 Print verbose information about the deleted data.
1649 Extreme care should be taken when applying either the
1653 options, as they can destroy large portions of a pool and cause unexpected
1654 behavior for mounted file systems in use.
1661 .Op % Ns Ar snapname
1666 The given snapshots are destroyed immediately if and only if the
1670 option would have destroyed it. Such immediate destruction would occur, for
1671 example, if the snapshot had no clones and the user-initiated reference count
1674 If a snapshot does not qualify for immediate destruction, it is marked for
1675 deferred deletion. In this state, it exists as a usable, visible snapshot until
1676 both of the preconditions listed above are met, at which point it is destroyed.
1678 An inclusive range of snapshots may be specified by separating the
1679 first and last snapshots with a percent sign
1681 The first and/or last snapshots may be left blank, in which case the
1682 filesystem's oldest or newest snapshot will be implied.
1685 (or ranges of snapshots) of the same filesystem or volume may be specified
1686 in a comma-separated list of snapshots.
1687 Only the snapshot's short name (the
1690 should be specified when using a range or comma-separated list to identify
1692 .Bl -tag -width indent
1694 Destroy (or mark for deferred deletion) all snapshots with this name in
1695 descendent file systems.
1697 Recursively destroy all clones of these snapshots, including the clones,
1698 snapshots, and children.
1699 If this flag is specified, the
1701 flag will have no effect.
1703 Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in
1704 conjunction with the
1708 flags to determine what data would be deleted.
1710 Print machine-parsable verbose information about the deleted data.
1712 Print verbose information about the deleted data.
1714 Defer snapshot deletion.
1717 Extreme care should be taken when applying either the
1721 options, as they can destroy large portions of a pool and cause unexpected
1722 behavior for mounted file systems in use.
1726 .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
1729 The given bookmark is destroyed.
1732 .Cm snapshot Ns | Ns Cm snap
1734 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1735 .Ar filesystem@snapname Ns | Ns volume@snapname
1736 .Ar filesystem@snapname Ns | Ns volume@snapname Ns ...
1739 Creates snapshots with the given names. All previous modifications by
1740 successful system calls to the file system are part of the snapshots.
1741 Snapshots are taken atomically, so that all snapshots correspond to the same
1742 moment in time. See the
1744 section for details.
1745 .Bl -tag -width indent
1747 Recursively create snapshots of all descendent datasets
1748 .It Fl o Ar property Ns = Ns Ar value
1749 Sets the specified property; see
1760 Roll back the given dataset to a previous snapshot. When a dataset is rolled
1761 back, all data that has changed since the snapshot is discarded, and the
1762 dataset reverts to the state at the time of the snapshot. By default, the
1763 command refuses to roll back to a snapshot other than the most recent one. In
1764 order to do so, all intermediate snapshots and bookmarks must be destroyed
1771 options do not recursively destroy the child snapshots of a
1773 Only direct snapshots of the specified filesystem
1774 are destroyed by either of these options.
1775 To completely roll back a
1776 recursive snapshot, you must rollback the individual child snapshots.
1777 .Bl -tag -width indent
1779 Destroy any snapshots and bookmarks more recent than the one specified.
1781 Destroy any more recent snapshots and bookmarks, as well as any clones of those
1786 option to force an unmount of any clone file systems that are to be destroyed.
1792 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1793 .Ar snapshot filesystem Ns | Ns Ar volume
1796 Creates a clone of the given snapshot. See the
1798 section for details. The target dataset can be located anywhere in the
1800 hierarchy, and is created as the same type as the original.
1801 .Bl -tag -width indent
1803 Creates all the non-existing parent datasets. Datasets created in this manner
1804 are automatically mounted according to the
1806 property inherited from their parent. If the target filesystem or volume
1807 already exists, the operation completes successfully.
1808 .It Fl o Ar property Ns = Ns Ar value
1809 Sets the specified property; see
1816 .Ar clone-filesystem
1819 Promotes a clone file system to no longer be dependent on its "origin"
1820 snapshot. This makes it possible to destroy the file system that the clone was
1821 created from. The clone parent-child dependency relationship is reversed, so
1822 that the origin file system becomes a clone of the specified file system.
1824 The snapshot that was cloned, and any snapshots previous to this snapshot, are
1825 now owned by the promoted clone. The space they use moves from the origin file
1826 system to the promoted clone, so enough space must be available to accommodate
1827 these snapshots. No new space is consumed by this operation, but the space
1828 accounting is adjusted. The promoted clone must not have any conflicting
1829 snapshot names of its own. The
1831 subcommand can be used to rename any conflicting snapshots.
1836 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1837 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1844 .Ar filesystem Ns | Ns Ar volume
1845 .Ar filesystem Ns | Ns Ar volume
1852 .Ar filesystem filesystem
1855 Renames the given dataset. The new target can be located anywhere in the
1857 hierarchy, with the exception of snapshots. Snapshots can only be renamed
1858 within the parent file system or volume. When renaming a snapshot, the parent
1859 file system of the snapshot does not need to be specified as part of the second
1860 argument. Renamed file systems can inherit new mount points, in which case they
1861 are unmounted and remounted at the new mount point.
1862 .Bl -tag -width indent
1864 Creates all the nonexistent parent datasets. Datasets created in this manner
1865 are automatically mounted according to the
1867 property inherited from their parent.
1869 Do not remount file systems during rename. If a file system's
1875 file system is not unmounted even if this option is not given.
1877 Force unmount any filesystems that need to be unmounted in the process.
1878 This flag has no effect if used together with the
1886 .Ar snapshot snapshot
1889 Recursively rename the snapshots of all descendent datasets. Snapshots are the
1890 only dataset that can be renamed recursively.
1894 .Op Fl r Ns | Ns Fl d Ar depth
1896 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
1897 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
1898 .Oo Fl s Ar property Oc Ns ...
1899 .Oo Fl S Ar property Oc Ns ...
1900 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
1903 Lists the property information for the given datasets in tabular form. If
1904 specified, you can list property information by the absolute pathname or the
1905 relative pathname. By default, all file systems and volumes are displayed.
1906 Snapshots are displayed if the
1912 The following fields are displayed,
1913 .Sy name , used , available , referenced , mountpoint .
1914 .Bl -tag -width indent
1916 Recursively display any children of the dataset on the command line.
1918 Recursively display any children of the dataset, limiting the recursion to
1922 will display only the dataset and its direct children.
1924 Used for scripting mode. Do not print headers and separate fields by a single
1925 tab instead of arbitrary white space.
1927 Display numbers in parsable (exact) values.
1928 .It Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
1929 A comma-separated list of properties to display. The property must be:
1930 .Bl -bullet -offset 2n
1932 One of the properties described in the
1933 .Qq Sx Native Properties
1940 to display the dataset name
1944 to display space usage properties on file systems and volumes. This is a
1945 shortcut for specifying
1947 .Sy name,avail,used,usedsnap,usedds,usedrefreserv,usedchild
1949 .Sy filesystem,volume
1952 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
1953 A comma-separated list of types to display, where
1956 .Sy filesystem , snapshot , snap , volume , bookmark , No or Sy all .
1957 For example, specifying
1959 displays only snapshots.
1960 .It Fl s Ar property
1961 A property for sorting the output by column in ascending order based on the
1962 value of the property. The property must be one of the properties described in
1965 section, or the special value
1967 to sort by the dataset name. Multiple properties can be specified at one time
1970 property options. Multiple
1972 options are evaluated from left to right in decreasing order of importance.
1974 The following is a list of sorting criteria:
1975 .Bl -bullet -offset 2n
1977 Numeric types sort in numeric order.
1979 String types sort in alphabetical order.
1981 Types inappropriate for a row sort that row to the literal bottom, regardless
1982 of the specified ordering.
1984 If no sorting options are specified the existing behavior of
1988 .It Fl S Ar property
1991 option, but sorts by property in descending order.
1996 .Ar property Ns = Ns Ar value
1997 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2000 Sets the property to the given value for each dataset. Only some properties can
2001 be edited. See the "Properties" section for more information on what properties
2002 can be set and acceptable values. Numeric values can be specified as exact
2003 values, or in a human-readable form with a suffix of
2004 .Sy B , K , M , G , T , P , E , Z
2005 (for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes, or
2006 zettabytes, respectively). User properties can be set on snapshots. For more
2007 information, see the
2008 .Qq Sx User Properties
2013 .Op Fl r Ns | Ns Fl d Ar depth
2015 .Op Fl o Ar all | field Ns Oo , Ns Ar field Oc Ns ...
2016 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2017 .Op Fl s Ar source Ns Oo , Ns Ar source Oc Ns ...
2018 .Ar all | property Ns Oo , Ns Ar property Oc Ns ...
2019 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
2022 Displays properties for the given datasets. If no datasets are specified, then
2023 the command displays properties for all datasets on the system. For each
2024 property, the following columns are displayed:
2026 .Bl -hang -width "property" -offset indent -compact
2034 Property source. Can either be local, default, temporary, inherited, or none
2038 All columns except the
2040 column are displayed by default. The columns to display can be specified
2043 option. This command takes a comma-separated list of properties as described in
2045 .Qq Sx Native Properties
2047 .Qq Sx User Properties
2052 can be used to display all properties that apply to the given dataset's type
2053 (filesystem, volume, snapshot, or bookmark).
2054 .Bl -tag -width indent
2056 Recursively display properties for any children.
2058 Recursively display any children of the dataset, limiting the recursion to
2062 will display only the dataset and its direct children.
2064 Display output in a form more easily parsed by scripts. Any headers are
2065 omitted, and fields are explicitly separated by a single tab instead of an
2066 arbitrary amount of space.
2068 Display numbers in parsable (exact) values.
2069 .It Fl o Cm all | Ar field Ns Oo , Ns Ar field Oc Ns ...
2070 A comma-separated list of columns to display. Supported values are
2071 .Sy name,property,value,received,source .
2073 .Sy name,property,value,source .
2076 specifies all columns.
2077 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2078 A comma-separated list of types to display, where
2081 .Sy filesystem , snapshot , volume , No or Sy all .
2082 For example, specifying
2084 displays only snapshots.
2085 .It Fl s Ar source Ns Oo , Ns Ar source Oc Ns ...
2086 A comma-separated list of sources to display. Those properties coming from a
2087 source other than those in this list are ignored. Each source must be one of
2089 .Sy local,default,inherited,temporary,received,none .
2090 The default value is all sources.
2097 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
2100 Clears the specified property, causing it to be inherited from an ancestor. If
2101 no ancestor has the property set, then the default value is used. See the
2103 section for a listing of default values, and details on which properties can be
2105 .Bl -tag -width indent
2107 Recursively inherit the given property for all children.
2109 For properties with a received value, revert to this value. This flag has no
2110 effect on properties that do not have a received value.
2118 Displays a list of file systems that are not the most recent version.
2119 .Bl -tag -width indent
2123 filesystem versions supported by the current software. The current
2125 filesystem version and all previous supported versions are displayed, along
2126 with an explanation of the features provided with each version.
2133 .Fl a | Ar filesystem
2136 Upgrades file systems to a new on-disk version. Once this is done, the file
2137 systems will no longer be accessible on systems running older versions of the
2140 streams generated from new snapshots of these file systems cannot be accessed
2141 on systems running older versions of the software.
2143 In general, the file system version is independent of the pool version. See
2145 for information on the
2146 .Nm zpool Cm upgrade
2149 In some cases, the file system version and the pool version are interrelated
2150 and the pool version must be upgraded before the file system version can be
2152 .Bl -tag -width indent
2154 Upgrade the specified file system and all descendent file systems.
2156 Upgrade to the specified
2160 flag is not specified, this command upgrades to the most recent version. This
2161 option can only be used to increase the version number, and only up to the most
2162 recent version supported by this software.
2164 Upgrade all file systems on all imported pools.
2166 Upgrade the specified file system.
2172 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2173 .Oo Fl s Ar field Oc Ns ...
2174 .Oo Fl S Ar field Oc Ns ...
2175 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2176 .Ar filesystem Ns | Ns Ar snapshot
2179 Displays space consumed by, and quotas on, each user in the specified
2180 filesystem or snapshot. This corresponds to the
2181 .Sy userused@ Ns Ar user
2183 .Sy userquota@ Ns Ar user
2185 .Bl -tag -width indent
2187 Print numeric ID instead of user/group name.
2189 Do not print headers, use tab-delimited output.
2191 Use exact (parsable) numeric output.
2192 .It Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2193 Display only the specified fields from the following set:
2194 .Sy type,name,used,quota .
2195 The default is to display all fields.
2197 Sort output by this field. The
2201 flags may be specified multiple times to sort first by one field, then by
2202 another. The default is
2203 .Fl s Cm type Fl s Cm name .
2205 Sort by this field in reverse order. See
2207 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2208 Print only the specified types from the following set:
2209 .Sy all,posixuser,smbuser,posixgroup,smbgroup .
2212 .Fl t Cm posixuser,smbuser .
2214 The default can be changed to include group types.
2216 Translate SID to POSIX ID. This flag currently has no effect on
2223 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2224 .Oo Fl s Ar field Oc Ns ...
2225 .Oo Fl S Ar field Oc Ns ...
2226 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2227 .Ar filesystem Ns | Ns Ar snapshot
2230 Displays space consumed by, and quotas on, each group in the specified
2231 filesystem or snapshot. This subcommand is identical to
2232 .Qq Nm Cm userspace ,
2233 except that the default types to display are
2234 .Fl t Sy posixgroup,smbgroup .
2242 file systems currently mounted.
2243 .Bl -tag -width indent
2250 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2251 .Fl a | Ar filesystem
2257 .Bl -tag -width indent
2259 Report mount progress.
2261 Perform an overlay mount. Overlay mounts are not supported on
2263 .It Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2264 An optional, comma-separated list of mount options to use temporarily for the
2265 duration of the mount. See the
2266 .Qq Sx Temporary Mount Point Properties
2267 section for details.
2272 This command may be executed on
2276 For more information, see variable
2281 Mount the specified filesystem.
2285 .Cm unmount Ns | Ns Cm umount
2287 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
2290 Unmounts currently mounted
2293 .Bl -tag -width indent
2295 Forcefully unmount the file system, even if it is currently in use.
2297 Unmount all available
2300 .It Ar filesystem | mountpoint
2301 Unmount the specified filesystem. The command can also be given a path to a
2303 file system mount point on the system.
2308 .Fl a | Ar filesystem
2313 file systems that have the
2316 .Bl -tag -width indent
2320 file systems that have the
2323 This command may be executed on
2327 For more information, see variable
2332 Share the specified filesystem according to the
2334 property. File systems are shared when the
2341 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
2346 file systems that have the
2349 .Bl -tag -width indent
2353 file systems that have the
2356 This command may be executed on
2360 For more information, see variable
2364 .It Ar filesystem | mountpoint
2365 Unshare the specified filesystem. The command can also be given a path to a
2367 file system shared on the system.
2376 Creates a bookmark of the given snapshot.
2377 Bookmarks mark the point in time
2378 when the snapshot was created, and can be used as the incremental source for
2383 This feature must be enabled to be used.
2385 .Xr zpool-features 7
2386 for details on ZFS feature flags and the
2393 .Op Fl i Ar snapshot | Fl I Ar snapshot
2397 Creates a stream representation of the last
2399 argument (not part of
2403 which is written to standard output. The output can be redirected to
2404 a file or to a different system (for example, using
2406 By default, a full stream is generated.
2407 .Bl -tag -width indent
2408 .It Fl i Ar snapshot
2409 Generate an incremental stream from the first
2410 .Ar snapshot Pq the incremental source
2412 .Ar snapshot Pq the incremental target .
2413 The incremental source can be specified as the last component of the
2415 .Pq the Em @ No character and following
2417 it is assumed to be from the same file system as the incremental target.
2419 If the destination is a clone, the source may be the origin snapshot, which
2420 must be fully specified (for example,
2421 .Cm pool/fs@origin ,
2424 .It Fl I Ar snapshot
2425 Generate a stream package that sends all intermediary snapshots from the first
2432 .Ic -i @a fs@b; -i @b fs@c; -i @c fs@d .
2434 source may be specified as with the
2438 Generate a replication stream package, which will replicate the specified
2439 filesystem, and all descendent file systems, up to the named snapshot. When
2440 received, all properties, snapshots, descendent file systems, and clones are
2447 flags are used in conjunction with the
2449 flag, an incremental replication stream is generated. The current values of
2450 properties, and current snapshot and file system names are set when the stream
2453 flag is specified when this stream is received, snapshots and file systems that
2454 do not exist on the sending side are destroyed.
2456 Generate a deduplicated stream. Blocks which would have been sent multiple
2457 times in the send stream will only be sent once. The receiving system must
2458 also support this feature to receive a deduplicated stream. This flag can
2459 be used regardless of the dataset's
2461 property, but performance will be much better if the filesystem uses a
2462 dedup-capable checksum (eg.
2465 Include the dataset's properties in the stream. This flag is implicit when
2467 is specified. The receiving system must also support this feature.
2469 Do a dry-run ("No-op") send. Do not generate any actual send data. This is
2470 useful in conjunction with the
2474 flags to determine what data will be sent.
2476 Print machine-parsable verbose information about the stream package generated.
2478 Print verbose information about the stream package generated.
2479 This information includes a per-second report of how much data has been sent.
2482 The format of the stream is committed. You will be able to receive your streams
2483 on future versions of
2488 .Op Fl i Ar snapshot Ns | Ns Ar bookmark
2489 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2492 Generate a send stream, which may be of a filesystem, and may be
2493 incremental from a bookmark.
2494 If the destination is a filesystem or volume,
2495 the pool must be read-only, or the filesystem must not be mounted.
2497 stream generated from a filesystem or volume is received, the default snapshot
2500 .Bl -tag -width indent
2501 .It Fl i Ar snapshot Ns | Ns bookmark
2502 Generate an incremental send stream.
2503 The incremental source must be an earlier
2504 snapshot in the destination's history.
2505 It will commonly be an earlier
2506 snapshot in the destination's filesystem, in which case it can be
2507 specified as the last component of the name
2508 .Pq the Em # No or Em @ No character and following .
2510 If the incremental target is a clone, the incremental source can
2511 be the origin snapshot, or an earlier snapshot in the origin's filesystem,
2512 or the origin's origin, etc.
2516 .Cm receive Ns | Ns Cm recv
2518 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2522 .Cm receive Ns | Ns Cm recv
2528 Creates a snapshot whose contents are as specified in the stream provided on
2529 standard input. If a full stream is received, then a new file system is created
2530 as well. Streams are created using the
2532 subcommand, which by default creates a full stream.
2534 can be used as an alias for
2537 If an incremental stream is received, then the destination file system must
2538 already exist, and its most recent snapshot must match the incremental stream's
2541 the destination device link is destroyed and recreated, which means the
2543 cannot be accessed during the
2547 When a snapshot replication package stream that is generated by using the
2549 command is received, any snapshots that do not exist on the sending location
2550 are destroyed by using the
2551 .Qq Nm Cm destroy Fl d
2554 The name of the snapshot (and file system, if a full stream is received) that
2555 this subcommand creates depends on the argument type and the
2561 If the argument is a snapshot name, the specified
2563 is created. If the argument is a file system or volume name, a snapshot with
2564 the same name as the sent snapshot is created within the specified
2572 option is specified, the snapshot name is determined by appending the sent
2573 snapshot's name to the specified
2577 option is specified, all but the pool name of the sent snapshot path is
2578 appended (for example,
2580 appended from sent snapshot
2584 option is specified, only the tail of the sent snapshot path is appended (for
2587 appended from sent snapshot
2591 any file systems needed to replicate the path of the sent snapshot are created
2592 within the specified file system.
2593 .Bl -tag -width indent
2595 Use the full sent snapshot path without the first element (without pool name)
2596 to determine the name of the new snapshot as described in the paragraph above.
2598 Use only the last element of the sent snapshot path to determine the name of
2599 the new snapshot as described in the paragraph above.
2601 File system that is associated with the received stream is not mounted.
2603 Print verbose information about the stream and the time required to perform the
2606 Do not actually receive the stream. This can be useful in conjunction with the
2608 option to verify the name the receive operation would use.
2610 Force a rollback of the file system to the most recent snapshot before
2611 performing the receive operation. If receiving an incremental replication
2612 stream (for example, one generated by
2613 .Qq Nm Cm send Fl R Bro Fl i | Fl I Brc ) ,
2614 destroy snapshots and file systems that do not exist on the sending side.
2619 .Ar filesystem Ns | Ns Ar volume
2622 Displays permissions that have been delegated on the specified filesystem or
2623 volume. See the other forms of
2625 for more information.
2630 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
2631 .Ar perm Ns | Ns Ar @setname Ns
2632 .Oo Ns , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
2633 .Ar filesystem Ns | Ns Ar volume
2639 .Fl e Ns | Ns Cm everyone
2640 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
2642 .Ar filesystem Ns | Ns Ar volume
2647 administration permission for the file systems to non-privileged users.
2648 .Bl -tag -width indent
2651 .Ar user Ns | Ns Ar group Ns Oo , Ar user Ns | Ns Ar group Oc Ns ...
2653 Specifies to whom the permissions are delegated. Multiple entities can be
2654 specified as a comma-separated list. If neither of the
2656 options are specified, then the argument is interpreted preferentially as the
2659 then as a user name, and lastly as a group name. To specify
2660 a user or group named
2666 options. To specify a group with the same name as a user, use the
2669 .It Op Fl e Ns | Ns Cm everyone
2670 Specifies that the permissions be delegated to
2673 .Ar perm Ns | Ns Ar @setname Ns Oo , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
2675 The permissions to delegate. Multiple permissions
2676 may be specified as a comma-separated list. Permission names are the same as
2678 subcommand and property names. See the property list below. Property set names,
2679 which begin with an at sign
2681 may be specified. See the
2683 form below for details.
2686 .Ar filesystem Ns | Ns Ar volume
2688 Specifies where the permissions are delegated. If neither of the
2690 options are specified, or both are, then the permissions are allowed for the
2691 file system or volume, and all of its descendents. If only the
2693 option is used, then is allowed "locally" only for the specified file system.
2696 option is used, then is allowed only for the descendent file systems.
2699 Permissions are generally the ability to use a
2701 subcommand or change a
2703 property. The following permissions are available:
2704 .Bl -column -offset 4n "secondarycache" "subcommand"
2705 .It NAME Ta TYPE Ta NOTES
2706 .It allow Ta subcommand Ta Must Xo
2707 also have the permission that is being allowed
2709 .It clone Ta subcommand Ta Must Xo
2710 also have the 'create' ability and 'mount' ability in the origin file system
2712 .It create Ta subcommand Ta Must also have the 'mount' ability
2713 .It destroy Ta subcommand Ta Must also have the 'mount' ability
2714 .It diff Ta subcommand Ta Allows lookup of paths within a dataset given an
2715 object number, and the ability to create snapshots necessary to 'zfs diff'
2716 .It hold Ta subcommand Ta Allows adding a user hold to a snapshot
2717 .It mount Ta subcommand Ta Allows mount/umount of Tn ZFS No datasets
2718 .It promote Ta subcommand Ta Must Xo
2719 also have the 'mount' and 'promote' ability in the origin file system
2721 .It receive Ta subcommand Ta Must also have the 'mount' and 'create' ability
2722 .It release Ta subcommand Ta Allows Xo
2723 releasing a user hold which might destroy the snapshot
2725 .It rename Ta subcommand Ta Must Xo
2726 also have the 'mount' and 'create' ability in the new parent
2728 .It rollback Ta subcommand Ta Must also have the 'mount' ability
2729 .It send Ta subcommand
2730 .It share Ta subcommand Ta Allows Xo
2731 sharing file systems over the
2735 .It snapshot Ta subcommand Ta Must also have the 'mount' ability
2736 .It groupquota Ta other Ta Allows accessing any groupquota@... property
2737 .It groupused Ta other Ta Allows reading any groupused@... property
2738 .It userprop Ta other Ta Allows changing any user property
2739 .It userquota Ta other Ta Allows accessing any userquota@... property
2740 .It userused Ta other Ta Allows reading any userused@... property
2741 .It aclinherit Ta property
2742 .It aclmode Ta property
2743 .It atime Ta property
2744 .It canmount Ta property
2745 .It casesensitivity Ta property
2746 .It checksum Ta property
2747 .It compression Ta property
2748 .It copies Ta property
2749 .It dedup Ta property
2750 .It devices Ta property
2751 .It exec Ta property
2752 .It filesystem_limit Ta property
2753 .It logbias Ta property
2754 .It jailed Ta property
2755 .It mlslabel Ta property
2756 .It mountpoint Ta property
2757 .It nbmand Ta property
2758 .It normalization Ta property
2759 .It primarycache Ta property
2760 .It quota Ta property
2761 .It readonly Ta property
2762 .It recordsize Ta property
2763 .It refquota Ta property
2764 .It refreservation Ta property
2765 .It reservation Ta property
2766 .It secondarycache Ta property
2767 .It setuid Ta property
2768 .It sharenfs Ta property
2769 .It sharesmb Ta property
2770 .It snapdir Ta property
2771 .It snapshot_limit Ta property
2772 .It sync Ta property
2773 .It utf8only Ta property
2774 .It version Ta property
2775 .It volblocksize Ta property
2776 .It volsize Ta property
2777 .It vscan Ta property
2778 .It xattr Ta property
2784 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
2786 .Ar filesystem Ns | Ns Ar volume
2789 Sets "create time" permissions. These permissions are granted (locally) to the
2790 creator of any newly-created descendent file system.
2796 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
2798 .Ar filesystem Ns | Ns Ar volume
2801 Defines or adds permissions to a permission set. The set can be used by other
2803 commands for the specified file system and its descendents. Sets are evaluated
2804 dynamically, so changes to a set are immediately reflected. Permission sets
2805 follow the same naming restrictions as ZFS file systems, but the name must
2806 begin with an "at sign"
2808 and can be no more than 64 characters long.
2813 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
2814 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
2816 .Ar filesystem Ns | Ns Ar volume
2822 .Fl e Ns | Ns Cm everyone
2823 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
2825 .Ar filesystem Ns | Ns Ar volume
2832 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
2834 .Ar filesystem Ns | Ns Ar volume
2837 Removes permissions that were granted with the
2839 command. No permissions are explicitly denied, so other permissions granted are
2840 still in effect. For example, if the permission is granted by an ancestor. If
2841 no permissions are specified, then all permissions for the specified
2842 .Ar user , group , No or everyone
2843 are removed. Specifying
2845 .Po or using the Fl e
2847 .Pc only removes the permissions that were granted to everyone ,
2848 not all permissions for every user and group. See the
2850 command for a description of the
2853 .Bl -tag -width indent
2855 Recursively remove the permissions from this file system and all descendents.
2863 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
2865 .Ar filesystem Ns | Ns Ar volume
2868 Removes permissions from a permission set. If no permissions are specified,
2869 then all permissions are removed, thus removing the set entirely.
2874 .Ar tag snapshot Ns ...
2877 Adds a single reference, named with the
2879 argument, to the specified snapshot or snapshots. Each snapshot has its own tag
2880 namespace, and tags must be unique within that space.
2882 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
2886 .Bl -tag -width indent
2888 Specifies that a hold with the given tag is applied recursively to the
2889 snapshots of all descendent file systems.
2898 Lists all existing user references for the given snapshot or snapshots.
2899 .Bl -tag -width indent
2901 Lists the holds that are set on the named descendent snapshots, in addition to
2902 listing the holds on the named snapshot.
2908 .Ar tag snapshot Ns ...
2911 Removes a single reference, named with the
2913 argument, from the specified snapshot or snapshots. The tag must already exist
2915 .Bl -tag -width indent
2917 Recursively releases a hold with the given tag on the snapshots of all
2918 descendent file systems.
2925 .Op Ar snapshot Ns | Ns Ar filesystem
2928 Display the difference between a snapshot of a given filesystem and another
2929 snapshot of that filesystem from a later time or the current contents of the
2930 filesystem. The first column is a character indicating the type of change,
2931 the other columns indicate pathname, new pathname
2932 .Pq in case of rename ,
2933 change in link count, and optionally file type and/or change time.
2935 The types of change are:
2936 .Bl -column -offset 2n indent
2937 .It \&- Ta path was removed
2938 .It \&+ Ta path was added
2939 .It \&M Ta path was modified
2940 .It \&R Ta path was renamed
2942 .Bl -tag -width indent
2944 Display an indication of the type of file, in a manner similar to the
2948 .Bl -column -offset 2n indent
2949 .It \&B Ta block device
2950 .It \&C Ta character device
2951 .It \&F Ta regular file
2952 .It \&/ Ta directory
2953 .It \&@ Ta symbolic link
2955 .It \&> Ta door (not supported on Fx )
2956 .It \&| Ta named pipe (not supported on Fx )
2957 .It \&P Ta event port (not supported on Fx )
2960 Give more parsable tab-separated output, without header lines and without
2963 Display the path's inode change time as the first column of output.
2968 .Ar jailid filesystem
2971 Attaches the specified
2973 to the jail identified by JID
2975 From now on this file system tree can be managed from within a jail if the
2977 property has been set. To use this functionality, the jail needs the
2988 for more information on managing jails and configuring the parameters above.
2992 .Ar jailid filesystem
2995 Detaches the specified
2997 from the jail identified by JID
3001 The following exit values are returned:
3002 .Bl -tag -offset 2n -width 2n
3004 Successful completion.
3008 Invalid command line options were specified.
3012 .It Sy Example 1 No Creating a Tn ZFS No File System Hierarchy
3014 The following commands create a file system named
3016 and a file system named
3020 is set for the parent file system, and is automatically inherited by the child
3022 .Bd -literal -offset 2n
3023 .Li # Ic zfs create pool/home
3024 .Li # Ic zfs set mountpoint=/home pool/home
3025 .Li # Ic zfs create pool/home/bob
3027 .It Sy Example 2 No Creating a Tn ZFS No Snapshot
3029 The following command creates a snapshot named
3031 This snapshot is mounted on demand in the
3033 directory at the root of the
3036 .Bd -literal -offset 2n
3037 .Li # Ic zfs snapshot pool/home/bob@yesterday
3039 .It Sy Example 3 No Creating and Destroying Multiple Snapshots
3041 The following command creates snapshots named
3045 and all of its descendent file systems. Each snapshot is mounted on demand in
3048 directory at the root of its file system. The second command destroys the newly
3050 .Bd -literal -offset 2n
3051 .Li # Ic zfs snapshot -r pool/home@yesterday
3052 .Li # Ic zfs destroy -r pool/home@yesterday
3054 .It Sy Example 4 No Disabling and Enabling File System Compression
3056 The following command disables the
3058 property for all file systems under
3060 The next command explicitly enables
3063 .Em pool/home/anne .
3064 .Bd -literal -offset 2n
3065 .Li # Ic zfs set compression=off pool/home
3066 .Li # Ic zfs set compression=on pool/home/anne
3068 .It Sy Example 5 No Listing Tn ZFS No Datasets
3070 The following command lists all active file systems and volumes in the system.
3071 Snapshots are displayed if the
3079 for more information on pool properties.
3080 .Bd -literal -offset 2n
3082 NAME USED AVAIL REFER MOUNTPOINT
3083 pool 450K 457G 18K /pool
3084 pool/home 315K 457G 21K /home
3085 pool/home/anne 18K 457G 18K /home/anne
3086 pool/home/bob 276K 457G 276K /home/bob
3088 .It Sy Example 6 No Setting a Quota on a Tn ZFS No File System
3090 The following command sets a quota of 50 Gbytes for
3092 .Bd -literal -offset 2n
3093 .Li # Ic zfs set quota=50G pool/home/bob
3095 .It Sy Example 7 No Listing Tn ZFS No Properties
3097 The following command lists all properties for
3099 .Bd -literal -offset 2n
3100 .Li # Ic zfs get all pool/home/bob
3101 NAME PROPERTY VALUE SOURCE
3102 pool/home/bob type filesystem -
3103 pool/home/bob creation Tue Jul 21 15:53 2009 -
3104 pool/home/bob used 21K -
3105 pool/home/bob available 20.0G -
3106 pool/home/bob referenced 21K -
3107 pool/home/bob compressratio 1.00x -
3108 pool/home/bob mounted yes -
3109 pool/home/bob quota 20G local
3110 pool/home/bob reservation none default
3111 pool/home/bob recordsize 128K default
3112 pool/home/bob mountpoint /home/bob default
3113 pool/home/bob sharenfs off default
3114 pool/home/bob checksum on default
3115 pool/home/bob compression on local
3116 pool/home/bob atime on default
3117 pool/home/bob devices on default
3118 pool/home/bob exec on default
3119 pool/home/bob filesystem_limit none default
3120 pool/home/bob setuid on default
3121 pool/home/bob readonly off default
3122 pool/home/bob jailed off default
3123 pool/home/bob snapdir hidden default
3124 pool/home/bob snapshot_limit none default
3125 pool/home/bob aclmode discard default
3126 pool/home/bob aclinherit restricted default
3127 pool/home/bob canmount on default
3128 pool/home/bob xattr on default
3129 pool/home/bob copies 1 default
3130 pool/home/bob version 5 -
3131 pool/home/bob utf8only off -
3132 pool/home/bob normalization none -
3133 pool/home/bob casesensitivity sensitive -
3134 pool/home/bob vscan off default
3135 pool/home/bob nbmand off default
3136 pool/home/bob sharesmb off default
3137 pool/home/bob refquota none default
3138 pool/home/bob refreservation none default
3139 pool/home/bob primarycache all default
3140 pool/home/bob secondarycache all default
3141 pool/home/bob usedbysnapshots 0 -
3142 pool/home/bob usedbydataset 21K -
3143 pool/home/bob usedbychildren 0 -
3144 pool/home/bob usedbyrefreservation 0 -
3145 pool/home/bob logbias latency default
3146 pool/home/bob dedup off default
3147 pool/home/bob mlslabel -
3148 pool/home/bob sync standard default
3149 pool/home/bob refcompressratio 1.00x -
3152 The following command gets a single property value.
3153 .Bd -literal -offset 2n
3154 .Li # Ic zfs get -H -o value compression pool/home/bob
3158 The following command lists all properties with local settings for
3160 .Bd -literal -offset 2n
3161 .Li # Ic zfs get -s local -o name,property,value all pool/home/bob
3163 pool/home/bob quota 20G
3164 pool/home/bob compression on
3166 .It Sy Example 8 No Rolling Back a Tn ZFS No File System
3168 The following command reverts the contents of
3170 to the snapshot named
3172 deleting all intermediate snapshots.
3173 .Bd -literal -offset 2n
3174 .Li # Ic zfs rollback -r pool/home/anne@yesterday
3176 .It Sy Example 9 No Creating a Tn ZFS No Clone
3178 The following command creates a writable file system whose initial contents are
3180 .Em pool/home/bob@yesterday .
3181 .Bd -literal -offset 2n
3182 .Li # Ic zfs clone pool/home/bob@yesterday pool/clone
3184 .It Sy Example 10 No Promoting a Tn ZFS No Clone
3186 The following commands illustrate how to test out changes to a file system, and
3187 then replace the original file system with the changed one, using clones, clone
3188 promotion, and renaming:
3189 .Bd -literal -offset 2n
3190 .Li # Ic zfs create pool/project/production
3194 .Pa /pool/project/production
3195 with data and continue with the following commands:
3196 .Bd -literal -offset 2n
3197 .Li # Ic zfs snapshot pool/project/production@today
3198 .Li # Ic zfs clone pool/project/production@today pool/project/beta
3202 .Pa /pool/project/beta
3203 and continue with the following commands:
3204 .Bd -literal -offset 2n
3205 .Li # Ic zfs promote pool/project/beta
3206 .Li # Ic zfs rename pool/project/production pool/project/legacy
3207 .Li # Ic zfs rename pool/project/beta pool/project/production
3210 Once the legacy version is no longer needed, it can be destroyed.
3211 .Bd -literal -offset 2n
3212 .Li # Ic zfs destroy pool/project/legacy
3214 .It Sy Example 11 No Inheriting Tn ZFS No Properties
3216 The following command causes
3222 property from their parent.
3223 .Bd -literal -offset 2n
3224 .Li # Ic zfs inherit checksum pool/home/bob pool/home/anne
3226 .It Sy Example 12 No Remotely Replicating Tn ZFS No Data
3228 The following commands send a full stream and then an incremental stream to a
3229 remote machine, restoring them into
3230 .Sy poolB/received/fs@a
3232 .Sy poolB/received/fs@b ,
3235 must contain the file system
3236 .Sy poolB/received ,
3237 and must not initially contain
3238 .Sy poolB/received/fs .
3239 .Bd -literal -offset 2n
3240 .Li # Ic zfs send pool/fs@a | ssh host zfs receive poolB/received/fs@a
3241 .Li # Ic zfs send -i a pool/fs@b | ssh host zfs receive poolB/received/fs
3250 The following command sends a full stream of
3251 .Sy poolA/fsA/fsB@snap
3252 to a remote machine, receiving it into
3253 .Sy poolB/received/fsA/fsB@snap .
3256 portion of the received snapshot's name is determined from the name of the sent
3259 must contain the file system
3260 .Sy poolB/received .
3262 .Sy poolB/received/fsA
3263 does not exist, it is created as an empty file system.
3264 .Bd -literal -offset 2n
3265 .Li # Ic zfs send poolA/fsA/fsB@snap | ssh host zfs receive -d poolB/received
3267 .It Sy Example 14 No Setting User Properties
3269 The following example sets the user-defined
3270 .Sy com.example:department
3271 property for a dataset.
3272 .Bd -literal -offset 2n
3273 .Li # Ic zfs set com.example:department=12345 tank/accounting
3275 .It Sy Example 15 No Performing a Rolling Snapshot
3277 The following example shows how to maintain a history of snapshots with a
3278 consistent naming scheme. To keep a week's worth of snapshots, the user
3279 destroys the oldest snapshot, renames the remaining snapshots, and then creates
3280 a new snapshot, as follows:
3281 .Bd -literal -offset 2n
3282 .Li # Ic zfs destroy -r pool/users@7daysago
3283 .Li # Ic zfs rename -r pool/users@6daysago @7daysago
3284 .Li # Ic zfs rename -r pool/users@5daysago @6daysago
3285 .Li # Ic zfs rename -r pool/users@4daysago @5daysago
3286 .Li # Ic zfs rename -r pool/users@3daysago @4daysago
3287 .Li # Ic zfs rename -r pool/users@2daysago @3daysago
3288 .Li # Ic zfs rename -r pool/users@yesterday @2daysago
3289 .Li # Ic zfs rename -r pool/users@today @yesterday
3290 .Li # Ic zfs snapshot -r pool/users@today
3296 Property Options on a ZFS File System
3299 The following command shows how to set
3301 property options to enable root access for a specific network on the
3303 file system. The contents of the
3308 .Bd -literal -offset 2n
3309 .Li # Ic zfs set sharenfs="maproot=root,network 192.168.0.0/24" tank/home
3312 Another way to write this command with the same result is:
3313 .Bd -literal -offset 2n
3314 .Li # Ic set zfs sharenfs="-maproot=root -network 192.168.0.0/24" tank/home
3320 Administration Permissions on a
3325 The following example shows how to set permissions so that user
3327 can create, destroy, mount, and take snapshots on
3332 .Bd -literal -offset 2n
3333 .Li # Ic zfs allow cindys create,destroy,mount,snapshot tank/cindys
3334 .Li # Ic zfs allow tank/cindys
3335 -------------------------------------------------------------
3336 Local+Descendent permissions on (tank/cindys)
3337 user cindys create,destroy,mount,snapshot
3338 -------------------------------------------------------------
3340 .It Sy Example 18 No Delegating Create Time Permissions on a Tn ZFS No Dataset
3342 The following example shows how to grant anyone in the group
3344 to create file systems in
3346 This syntax also allows staff members to destroy their own file systems, but
3347 not destroy anyone else's file system. The permissions on
3350 .Bd -literal -offset 2n
3351 .Li # Ic zfs allow staff create,mount tank/users
3352 .Li # Ic zfs allow -c destroy tank/users
3353 .Li # Ic zfs allow tank/users
3354 -------------------------------------------------------------
3355 Create time permissions on (tank/users)
3357 Local+Descendent permissions on (tank/users)
3358 group staff create,mount
3359 -------------------------------------------------------------
3363 Defining and Granting a Permission Set on a
3368 The following example shows how to define and grant a permission set on the
3370 file system. The permissions on
3373 .Bd -literal -offset 2n
3374 .Li # Ic zfs allow -s @pset create,destroy,snapshot,mount tank/users
3375 .Li # Ic zfs allow staff @pset tank/users
3376 .Li # Ic zfs allow tank/users
3377 -------------------------------------------------------------
3378 Permission sets on (tank/users)
3379 @pset create,destroy,mount,snapshot
3380 Create time permissions on (tank/users)
3382 Local+Descendent permissions on (tank/users)
3383 group staff @pset,create,mount
3384 -------------------------------------------------------------
3386 .It Sy Example 20 No Delegating Property Permissions on a Tn ZFS No Dataset
3388 The following example shows to grant the ability to set quotas and reservations
3391 file system. The permissions on
3394 .Bd -literal -offset 2n
3395 .Li # Ic zfs allow cindys quota,reservation users/home
3396 .Li # Ic zfs allow cindys
3397 -------------------------------------------------------------
3398 Local+Descendent permissions on (users/home)
3399 user cindys quota,reservation
3400 -------------------------------------------------------------
3401 .Li # Ic su - cindys
3402 .Li cindys% Ic zfs set quota=10G users/home/marks
3403 .Li cindys% Ic zfs get quota users/home/marks
3404 NAME PROPERTY VALUE SOURCE
3405 users/home/marks quota 10G local
3407 .It Sy Example 21 No Removing ZFS Delegated Permissions on a Tn ZFS No Dataset
3409 The following example shows how to remove the snapshot permission from the
3413 file system. The permissions on
3416 .Bd -literal -offset 2n
3417 .Li # Ic zfs unallow staff snapshot tank/users
3418 .Li # Ic zfs allow tank/users
3419 -------------------------------------------------------------
3420 Permission sets on (tank/users)
3421 @pset create,destroy,mount,snapshot
3422 Create time permissions on (tank/users)
3424 Local+Descendent permissions on (tank/users)
3425 group staff @pset,create,mount
3426 -------------------------------------------------------------
3428 .It Sy Example 22 Showing the differences between a snapshot and a ZFS Dataset
3430 The following example shows how to see what has changed between a prior
3431 snapshot of a ZFS Dataset and its current state. The
3433 option is used to indicate type information for the files affected.
3434 .Bd -literal -offset 2n
3435 .Li # Ic zfs diff tank/test@before tank/test
3437 M F /tank/test/linked (+1)
3438 R F /tank/test/oldname -> /tank/test/newname
3439 - F /tank/test/deleted
3440 + F /tank/test/created
3441 M F /tank/test/modified
3455 This manual page is a
3457 reimplementation of the
3461 modified and customized for
3463 and licensed under the
3464 Common Development and Distribution License
3469 implementation of this manual page was initially written by
3470 .An Martin Matuska Aq mm@FreeBSD.org .
projects / FreeBSD / stable / 9.git / blob