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) 2011, 2014 by Delphix. All rights reserved.
22 .\" Copyright (c) 2011, Pawel Jakub Dawidek <pjd@FreeBSD.org>
23 .\" Copyright (c) 2012, Glen Barber <gjb@FreeBSD.org>
24 .\" Copyright (c) 2012, Bryan Drewery <bdrewery@FreeBSD.org>
25 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
26 .\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
27 .\" Copyright (c) 2013, Steven Hartland <smh@FreeBSD.org>
28 .\" Copyright (c) 2014 Nexenta Systems, Inc. All Rights Reserved.
29 .\" Copyright (c) 2014, Xin LI <delphij@FreeBSD.org>
30 .\" Copyright (c) 2014-2015, The FreeBSD Foundation, All Rights Reserved.
34 .Dd September 14, 2015
39 .Nd configures ZFS file systems
46 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... Ar filesystem
51 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
57 .Ar filesystem Ns | Ns Ar volume
62 .Ar filesystem Ns | Ns volume
65 .Op , Ns Ar snap Op % Ns Ar snap
70 .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
72 .Cm snapshot Ns | Ns Cm snap
74 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
75 .Ar filesystem@snapname Ns | Ns Ar volume@snapname
76 .Ar filesystem@snapname Ns | Ns Ar volume@snapname Ns ...
84 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
85 .Ar snapshot filesystem Ns | Ns Ar volume
92 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
93 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
98 .Ar filesystem Ns | Ns Ar volume
99 .Ar filesystem Ns | Ns Ar volume
103 .Ar snapshot snapshot
108 .Ar filesystem filesystem
111 .Op Fl r Ns | Ns Fl d Ar depth
113 .Op Fl o Ar property Ns Oo , Ns property Ns Oc Ns ...
114 .Op Fl t Ar type Ns Oo , Ns type Ns Oc Ns ...
115 .Oo Fl s Ar property Oc Ns ...
116 .Oo Fl S Ar property Oc Ns ...
117 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
120 .Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ...
121 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
124 .Op Fl r Ns | Ns Fl d Ar depth
126 .Op Fl o Ar all | field Ns Oo , Ns Ar field Oc Ns ...
127 .Op Fl t Ar type Ns Oo Ns , Ar type Oc Ns ...
128 .Op Fl s Ar source Ns Oo Ns , Ns Ar source Oc Ns ...
129 .Ar all | property Ns Oo Ns , Ns Ar property Oc Ns ...
130 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
135 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
143 .Fl a | Ar filesystem
147 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
148 .Oo Fl s Ar field Oc Ns ...
149 .Oo Fl S Ar field Oc Ns ...
150 .Op Fl t Ar type Ns Oo Ns , Ns Ar type Oc Ns ...
151 .Ar filesystem Ns | Ns Ar snapshot
155 .Op Fl o Ar field Ns Oo , Ns field Oc Ns ...
156 .Oo Fl s Ar field Oc Ns ...
157 .Oo Fl S Ar field Oc Ns ...
158 .Op Fl t Ar type Ns Oo Ns , Ns Ar type Oc Ns ...
159 .Ar filesystem Ns | Ns Ar snapshot
165 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
166 .Fl a | Ar filesystem
168 .Cm unmount Ns | Ns Cm umount
170 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
173 .Fl a | Ar filesystem
176 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
184 .Op Fl i Ar snapshot | Fl I Ar snapshot
189 .Op Fl i Ar snapshot Ns | Ns bookmark
190 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
194 .Fl t Ar receive_resume_token
196 .Cm receive Ns | Ns Cm recv
198 .Op Fl o Sy origin Ns = Ns Ar snapshot
199 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
201 .Cm receive Ns | Ns Cm recv
204 .Op Fl o Sy origin Ns = Ns Ar snapshot
207 .Cm receive Ns | Ns Cm recv
209 .Ar filesystem Ns | Ns Ar volume
212 .Ar filesystem Ns | Ns Ar volume
216 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
217 .Ar perm Ns | Ns Ar @setname Ns
218 .Oo Ns , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
219 .Ar filesystem Ns | Ns Ar volume
223 .Fl e Ns | Ns Cm everyone
224 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
226 .Ar filesystem Ns | Ns Ar volume
230 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
232 .Ar filesystem Ns | Ns Ar volume
237 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
239 .Ar filesystem Ns | Ns Ar volume
243 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
244 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
246 .Ar filesystem Ns | Ns Ar volume
250 .Fl e Ns | Ns Cm everyone
251 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
253 .Ar filesystem Ns | Ns Ar volume
258 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
260 .Ar filesystem Ns | Ns Ar volume
266 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
268 .Ar filesystem Ns | Ns Ar volume
272 .Ar tag snapshot Ns ...
280 .Ar tag snapshot Ns ...
285 .Op Ar snapshot Ns | Ns Ar filesystem
288 .Ar jailid Ns | Ns Ar jailname filesystem
291 .Ar jailid Ns | Ns Ar jailname filesystem
299 storage pool, as described in
301 A dataset is identified by a unique path within the
303 namespace. For example:
304 .Bd -ragged -offset 4n
305 .No pool/ Ns Brq filesystem,volume,snapshot
308 where the maximum length of a dataset name is
312 A dataset can be one of the following:
319 can be mounted within the standard system namespace and behaves like other file
322 file systems are designed to be
324 compliant, known issues exist that prevent compliance in some cases.
325 Applications that depend on standards conformance might fail due to nonstandard
326 behavior when checking file system free space.
328 A logical volume exported as a raw or block device. This type of dataset should
329 only be used under special circumstances. File systems are typically used in
332 A read-only version of a file system or volume at a given point in time. It is
338 .Ss ZFS File System Hierarchy
341 storage pool is a logical collection of devices that provide space for
342 datasets. A storage pool is also the root of the
344 file system hierarchy.
346 The root of the pool can be accessed as a file system, such as mounting and
347 unmounting, taking snapshots, and setting properties. The physical storage
348 characteristics, however, are managed by the
354 for more information on creating and administering pools.
356 A snapshot is a read-only copy of a file system or volume. Snapshots can be
357 created extremely quickly, and initially consume no additional space within the
358 pool. As data within the active dataset changes, the snapshot consumes more
359 data than would otherwise be shared with the active dataset.
361 Snapshots can have arbitrary names. Snapshots of volumes can be cloned or
362 rolled back, but cannot be accessed independently.
364 File system snapshots can be accessed under the
366 directory in the root of the file system. Snapshots are automatically mounted
367 on demand and may be unmounted at regular intervals. The visibility of the
369 directory can be controlled by the
373 A clone is a writable volume or file system whose initial contents are the same
374 as another dataset. As with snapshots, creating a clone is nearly
375 instantaneous, and initially consumes no additional space.
377 Clones can only be created from a snapshot. When a snapshot is cloned, it
378 creates an implicit dependency between the parent and child. Even though the
379 clone is created somewhere else in the dataset hierarchy, the original snapshot
380 cannot be destroyed as long as a clone exists. The
382 property exposes this dependency, and the
384 command lists any such dependencies, if they exist.
386 The clone parent-child dependency relationship can be reversed by using the
388 subcommand. This causes the "origin" file system to become a clone of the
389 specified file system, which makes it possible to destroy the file system that
390 the clone was created from.
394 file system is a simple operation, so the number of file systems per system is
395 likely to be numerous. To cope with this,
397 automatically manages mounting and unmounting file systems without the need to
400 file. All automatically managed file systems are mounted by
404 By default, file systems are mounted under
408 is the name of the file system in the
410 namespace. Directories are created and destroyed as needed.
412 A file system can also have a mount point set in the
414 property. This directory is created as needed, and
416 automatically mounts the file system when the
418 command is invoked (without editing
422 property can be inherited, so if
428 automatically inherits a mount point of
435 prevents the file system from being mounted.
439 file systems can also be managed with traditional tools
440 .Pq Xr mount 8 , Xr umount 8 , Xr fstab 5 .
441 If a file system's mount point is set to
444 makes no attempt to manage the file system, and the administrator is
445 responsible for mounting and unmounting the file system.
448 dataset can be attached to a jail by using the
450 subcommand. You cannot attach a dataset to one jail and the children of the
451 same dataset to another jails. To allow management of the dataset from within
454 property has to be set and the jail needs access to the
458 property cannot be changed from within a jail. See
460 for information on how to allow mounting
462 datasets from within a jail.
465 dataset can be detached from a jail using the
469 After a dataset is attached to a jail and the jailed property is set, a jailed
470 file system cannot be mounted outside the jail, since the jail administrator
471 might have set the mount point to an unacceptable value.
473 Deduplication is the process for removing redundant data at the block-level,
474 reducing the total amount of data stored. If a file system has the
476 property enabled, duplicate data blocks are removed synchronously. The result
477 is that only unique data is stored and common components are shared among
479 .Ss Native Properties
480 Properties are divided into two types, native properties and user-defined (or
481 "user") properties. Native properties either export internal statistics or
484 behavior. In addition, native properties are either editable or read-only. User
485 properties have no effect on
487 behavior, but you can use them to annotate datasets in a way that is meaningful
488 in your environment. For more information about user properties, see the
489 .Qq Sx User Properties
492 Every dataset has a set of properties that export statistics about the dataset
493 as well as control various behaviors. Properties are inherited from the parent
494 unless overridden by the child. Some properties apply only to certain types of
495 datasets (file systems, volumes, or snapshots).
497 The values of numeric properties can be specified using human-readable suffixes
499 .Sy k , KB , M , Gb ,
502 for zettabyte). The following are all valid (and equal) specifications:
503 .Bd -ragged -offset 4n
507 The values of non-numeric properties are case sensitive and must be lowercase,
509 .Sy mountpoint , sharenfs , No and Sy sharesmb .
511 The following native properties consist of read-only statistics about the
512 dataset. These properties can be neither set, nor inherited. Native properties
513 apply to all dataset types unless otherwise noted.
516 The amount of space available to the dataset and all its children, assuming
517 that there is no other activity in the pool. Because space is shared within a
518 pool, availability can be limited by any number of factors, including physical
519 pool size, quotas, reservations, or other datasets within the pool.
521 This property can also be referred to by its shortened column name,
524 For non-snapshots, the compression ratio achieved for the
526 space of this dataset, expressed as a multiplier. The
528 property includes descendant datasets, and, for clones, does not include
529 the space shared with the origin snapshot. For snapshots, the
533 property. Compression can be turned on by running:
534 .Qq Nm Cm set compression=on Ar dataset
538 The time this dataset was created.
540 For snapshots, this property is a comma-separated list of filesystems or
541 volumes which are clones of this snapshot. The clones'
543 property is this snapshot. If the
545 property is not empty, then this snapshot can not be destroyed (even with the
553 if the snapshot has been marked for deferred destroy by using the
555 command. Otherwise, the property is
557 .It Sy filesystem_count
558 The total number of filesystems and volumes that exist under this location in the
560 This value is only available when a
563 been set somewhere in the tree under which the dataset resides.
564 .It Sy logicalreferenced
565 The amount of space that is
567 accessible by this dataset.
571 The logical space ignores the effect of the
575 properties, giving a quantity closer to the amount of data that applications
577 However, it does include space consumed by metadata.
579 This property can also be referred to by its shortened column name,
582 The amount of space that is
584 consumed by this dataset and all its descendents.
588 The logical space ignores the effect of the
592 properties, giving a quantity closer to the amount of data that applications
595 This property can also be referred to by its shortened column name,
598 For file systems, indicates whether the file system is currently mounted. This
599 property can be either
604 For cloned file systems or volumes, the snapshot from which the clone was
605 created. See also the
608 .It Sy receive_resume_token
609 For filesystems or volumes which have saved partially-completed state from
611 this opaque token can be provided to
613 to resume and complete the
616 The amount of data that is accessible by this dataset, which may or may not be
617 shared with other datasets in the pool. When a snapshot or clone is created, it
618 initially references the same amount of space as the file system or snapshot it
619 was created from, since its contents are identical.
621 This property can also be referred to by its shortened column name,
623 .It Sy refcompressratio
624 The compression ratio achieved for the
626 space of this dataset, expressed as a multiplier. See also the
629 .It Sy snapshot_count
630 The total number of snapshots that exist under this location in the dataset tree.
631 This value is only available when a
633 has been set somewhere
634 in the tree under which the dataset resides.
637 .Sy filesystem , volume , No or Sy snapshot .
639 The amount of space consumed by this dataset and all its descendents. This is
640 the value that is checked against this dataset's quota and reservation. The
641 space used does not include this dataset's reservation, but does take into
642 account the reservations of any descendent datasets. The amount of space that a
643 dataset consumes from its parent, as well as the amount of space that are freed
644 if this dataset is recursively destroyed, is the greater of its space used and
647 When snapshots (see the
649 section) are created, their space is
650 initially shared between the snapshot and the file system, and possibly with
651 previous snapshots. As the file system changes, space that was previously
652 shared becomes unique to the snapshot, and counted in the snapshot's space
653 used. Additionally, deleting snapshots can increase the amount of space unique
654 to (and used by) other snapshots.
656 The amount of space used, available, or referenced does not take into account
657 pending changes. Pending changes are generally accounted for within a few
658 seconds. Committing a change to a disk using
662 does not necessarily guarantee that the space usage information is updated
667 properties decompose the
669 properties into the various reasons that space is used. Specifically,
671 .Sy usedbysnapshots + usedbydataset + usedbychildren + usedbyrefreservation .
672 These properties are only available for datasets created
675 pool version 13 pools and higher.
676 .It Sy usedbysnapshots
677 The amount of space consumed by snapshots of this dataset. In particular, it is
678 the amount of space that would be freed if all of this dataset's snapshots were
679 destroyed. Note that this is not simply the sum of the snapshots'
681 properties because space can be shared by multiple snapshots.
683 The amount of space used by this dataset itself, which would be freed if the
684 dataset were destroyed (after first removing any
686 and destroying any necessary snapshots or descendents).
687 .It Sy usedbychildren
688 The amount of space used by children of this dataset, which would be freed if
689 all the dataset's children were destroyed.
690 .It Sy usedbyrefreservation
691 The amount of space used by a
693 set on this dataset, which would be freed if the
696 .It Sy userused@ Ns Ar user
697 The amount of space consumed by the specified user in this dataset. Space is
698 charged to the owner of each file, as displayed by
700 The amount of space charged is displayed by
706 subcommand for more information.
708 Unprivileged users can access only their own space usage. The root user, or a
709 user who has been granted the
713 can access everyone's usage.
717 properties are not displayed by
719 The user's name must be appended after the
721 symbol, using one of the following forms:
722 .Bl -bullet -offset 2n
724 POSIX name (for example,
727 POSIX numeric ID (for example,
731 This property is set to the number of user holds on this snapshot. User holds
735 .It Sy groupused@ Ns Ar group
736 The amount of space consumed by the specified group in this dataset. Space is
737 charged to the group of each file, as displayed by
740 .Sy userused@ Ns Ar user
741 property for more information.
743 Unprivileged users can only access their own groups' space usage. The root
744 user, or a user who has been granted the
748 can access all groups' usage.
749 .It Sy volblocksize Ns = Ns Ar blocksize
750 For volumes, specifies the block size of the volume. The
752 cannot be changed once the volume has been written, so it should be set at
753 volume creation time. The default
755 for volumes is 8 Kbytes. Any
756 power of 2 from 512 bytes to 128 Kbytes is valid.
758 This property can also be referred to by its shortened column name,
763 space written to this dataset since the previous snapshot.
764 .It Sy written@ Ns Ar snapshot
767 space written to this dataset since the specified snapshot. This is the space
768 that is referenced by this dataset but was not referenced by the specified
773 may be specified as a short snapshot name (just the part after the
775 in which case it will be interpreted as a snapshot in the same filesystem as
778 may be a full snapshot name
779 .Pq Em filesystem@snapshot ,
780 which for clones may be a snapshot in the origin's filesystem (or the origin of
781 the origin's filesystem, etc).
784 The following native properties can be used to change the behavior of a
789 .Sy aclinherit Ns = Ns Cm discard |
797 entries are inherited when files and directories are created. A file system
804 entries. A file system with an
808 only inherits inheritable
810 entries that specify "deny" permissions. The property value
812 (the default) removes the
818 entry is inherited. A file system with an
822 inherits all inheritable
824 entries without any modifications made to the
826 entries when they are inherited. A file system with an
830 has the same meaning as
833 .Em owner@ , group@ , No and Em everyone@ Tn ACE Ns s
834 inherit the execute permission only if the file creation mode also requests the
837 When the property value is set to
839 files are created with a mode determined by the inheritable
843 exist that affect the mode, then the mode is set in accordance to the requested
844 mode from the application.
845 .It Sy aclmode Ns = Ns Cm discard | groupmask | passthrough | restricted
850 A file system with an
854 (the default) deletes all
856 entries that do not represent the mode of the file. An
860 reduces permissions granted in all
864 such that they are no greater than the group permissions specified by
866 A file system with an
870 indicates that no changes are made to the
872 other than creating or updating the necessary
874 entries to represent the new mode of the file or directory.
881 operation to return an error when used on any file or directory which has
884 whose entries can not be represented by a mode.
886 is required to change the set user ID, set group ID, or sticky bits on a file
887 or directory, as they do not have equivalent
892 on a file or directory with a non-trivial
898 you must first remove all
900 entries which do not represent the current mode.
901 .It Sy atime Ns = Ns Cm on | off
902 Controls whether the access time for files is updated when they are read.
903 Turning this property off avoids producing write traffic when reading files and
904 can result in significant performance gains, though it might confuse mailers
905 and other similar utilities. The default value is
907 .It Sy canmount Ns = Ns Cm on | off | noauto
908 If this property is set to
910 the file system cannot be mounted, and is ignored by
911 .Qq Nm Cm mount Fl a .
912 Setting this property to
914 is similar to setting the
918 except that the dataset still has a normal
920 property, which can be inherited. Setting this property to
922 allows datasets to be used solely as a mechanism to inherit properties. One
924 .Sy canmount Ns = Ns Cm off
925 is to have two datasets with the same
927 so that the children of both datasets appear in the same directory, but might
928 have different inherited characteristics.
932 value is set, a dataset can only be mounted and unmounted explicitly. The
933 dataset is not mounted automatically when the dataset is created or imported,
934 nor is it mounted by the
936 command or unmounted by the
937 .Qq Nm Cm umount Fl a
940 This property is not inherited.
941 .It Sy checksum Ns = Ns Cm on | off | fletcher2 | fletcher4 | sha256 | noparity
942 Controls the checksum used to verify data integrity. The default value is
944 which automatically selects an appropriate algorithm (currently,
946 but this may change in future releases). The value
948 disables integrity checking on user data.
952 disables integrity but also disables maintaining parity for user data. This
953 setting is used internally by a dump device residing on a RAID-Z pool and should
954 not be used by any other dataset.
955 Disabling checksums is
957 a recommended practice.
958 .It Sy compression Ns = Ns Cm on | off | lzjb | gzip | gzip- Ns Ar N | Cm zle | Cm lz4
959 Controls the compression algorithm used for this dataset.
960 Setting compression to
962 indicates that the current default compression algorithm should be used.
963 The default balances compression and decompression speed, with compression
964 ratio and is expected to work well on a wide variety of workloads.
965 Unlike all other settings for this property, on does not select a fixed
967 As new compression algorithms are added to ZFS and enabled on a pool, the
968 default compression algorithm may change.
969 The current default compression algorthm is either
977 compression algorithm is optimized for performance while providing decent data
978 compression. Setting compression to
982 compression algorithm. The
984 compression algorithm uses the same compression as the
986 command. You can specify the
988 level by using the value
992 is an integer from 1 (fastest) to 9 (best compression ratio). Currently,
996 (which is also the default for
1000 compression algorithm compresses runs of zeros.
1004 compression algorithm is a high-performance replacement
1007 algorithm. It features significantly faster
1008 compression and decompression, as well as a moderately higher
1009 compression ratio than
1011 but can only be used on pools with
1017 .Xr zpool-features 7
1018 for details on ZFS feature flags and the
1022 This property can also be referred to by its shortened column name
1024 Changing this property affects only newly-written data.
1025 .It Sy copies Ns = Ns Cm 1 | 2 | 3
1026 Controls the number of copies of data stored for this dataset. These copies are
1027 in addition to any redundancy provided by the pool, for example, mirroring or
1028 RAID-Z. The copies are stored on different disks, if possible. The space used
1029 by multiple copies is charged to the associated file and dataset, changing the
1031 property and counting against quotas and reservations.
1033 Changing this property only affects newly-written data. Therefore, set this
1034 property at file system creation time by using the
1035 .Fl o Cm copies= Ns Ar N
1037 .It Sy dedup Ns = Ns Cm on | off | verify | sha256 Ns Op Cm ,verify
1038 Configures deduplication for a dataset. The default value is
1040 The default deduplication checksum is
1042 (this may change in the future).
1045 is enabled, the checksum defined here overrides the
1047 property. Setting the value to
1049 has the same effect as the setting
1055 will do a byte-to-byte comparsion in case of two blocks having the same
1056 signature to make sure the block contents are identical.
1057 .It Sy devices Ns = Ns Cm on | off
1060 property is currently not supported on
1062 .It Sy exec Ns = Ns Cm on | off
1063 Controls whether processes can be executed from within this file system. The
1066 .It Sy mlslabel Ns = Ns Ar label | Cm none
1069 property is currently not supported on
1071 .It Sy filesystem_limit Ns = Ns Ar count | Cm none
1072 Limits the number of filesystems and volumes that can exist under this point in
1074 The limit is not enforced if the user is allowed to change
1077 .Sy filesystem_limit
1078 on a descendent of a filesystem that
1080 .Sy filesystem_limit
1081 does not override the ancestor's
1082 .Sy filesystem_limit ,
1083 but rather imposes an additional limit.
1084 This feature must be enabled to be used
1086 .Xr zpool-features 7
1088 .It Sy mountpoint Ns = Ns Ar path | Cm none | legacy
1089 Controls the mount point used for this file system. See the
1091 section for more information on how this property is used.
1095 property is changed for a file system, the file system and any children that
1096 inherit the mount point are unmounted. If the new value is
1098 then they remain unmounted. Otherwise, they are automatically remounted in the
1099 new location if the property was previously
1103 or if they were mounted before the property was changed. In addition, any
1104 shared file systems are unshared and shared in the new location.
1105 .It Sy nbmand Ns = Ns Cm on | off
1108 property is currently not supported on
1110 .It Sy primarycache Ns = Ns Cm all | none | metadata
1111 Controls what is cached in the primary cache (ARC). If this property is set to
1113 then both user data and metadata is cached. If this property is set to
1115 then neither user data nor metadata is cached. If this property is set to
1117 then only metadata is cached. The default value is
1119 .It Sy quota Ns = Ns Ar size | Cm none
1120 Limits the amount of space a dataset and its descendents can consume. This
1121 property enforces a hard limit on the amount of space used. This includes all
1122 space consumed by descendents, including file systems and snapshots. Setting a
1123 quota on a descendent of a dataset that already has a quota does not override
1124 the ancestor's quota, but rather imposes an additional limit.
1126 Quotas cannot be set on volumes, as the
1128 property acts as an implicit quota.
1129 .It Sy snapshot_limit Ns = Ns Ar count | Cm none
1130 Limits the number of snapshots that can be created on a dataset and its
1134 on a descendent of a dataset that already
1137 does not override the ancestor's
1138 .Sy snapshot_limit ,
1140 rather imposes an additional limit.
1141 The limit is not enforced if the user is
1142 allowed to change the limit.
1143 For example, this means that recursive snapshots
1144 taken from the global zone are counted against each delegated dataset within
1146 This feature must be enabled to be used
1148 .Xr zpool-features 7
1150 .It Sy userquota@ Ns Ar user Ns = Ns Ar size | Cm none
1151 Limits the amount of space consumed by the specified user.
1156 space calculation does not include space that is used by descendent datasets,
1157 such as snapshots and clones. User space consumption is identified by the
1158 .Sy userspace@ Ns Ar user
1161 Enforcement of user quotas may be delayed by several seconds. This delay means
1162 that a user might exceed their quota before the system notices that they are
1163 over quota and begins to refuse additional writes with the
1165 error message. See the
1167 subcommand for more information.
1169 Unprivileged users can only access their own groups' space usage. The root
1170 user, or a user who has been granted the
1174 can get and set everyone's quota.
1176 This property is not available on volumes, on file systems before version 4, or
1177 on pools before version 15. The
1178 .Sy userquota@ Ns ...
1179 properties are not displayed by
1181 The user's name must be appended after the
1183 symbol, using one of the following forms:
1184 .Bl -bullet -offset 2n
1186 POSIX name (for example,
1189 POSIX numeric ID (for example,
1192 .It Sy groupquota@ Ns Ar group Ns = Ns Ar size | Cm none
1193 Limits the amount of space consumed by the specified group. Group space
1194 consumption is identified by the
1195 .Sy userquota@ Ns Ar user
1198 Unprivileged users can access only their own groups' space usage. The root
1199 user, or a user who has been granted the
1203 can get and set all groups' quotas.
1204 .It Sy readonly Ns = Ns Cm on | off
1205 Controls whether this dataset can be modified. The default value is
1207 .It Sy recordsize Ns = Ns Ar size
1208 Specifies a suggested block size for files in the file system. This property is
1209 designed solely for use with database workloads that access files in fixed-size
1212 automatically tunes block sizes according to internal algorithms optimized for
1213 typical access patterns.
1215 For databases that create very large files but access them in small random
1216 chunks, these algorithms may be suboptimal. Specifying a
1218 greater than or equal to the record size of the database can result in
1219 significant performance gains. Use of this property for general purpose file
1220 systems is strongly discouraged, and may adversely affect performance.
1222 The size specified must be a power of two greater than or equal to 512 and less
1223 than or equal to 128 Kbytes.
1226 feature is enabled on the pool, the size may be up to 1 Mbyte.
1228 .Xr zpool-features 7
1229 for details on ZFS feature flags.
1231 Changing the file system's
1233 affects only files created afterward; existing files are unaffected.
1235 This property can also be referred to by its shortened column name,
1237 .It Sy redundant_metadata Ns = Ns Cm all | most
1238 Controls what types of metadata are stored redundantly.
1239 ZFS stores an extra copy of metadata, so that if a single block is corrupted,
1240 the amount of user data lost is limited.
1241 This extra copy is in addition to any redundancy provided at the pool level
1242 .Pq e.g. by mirroring or RAID-Z ,
1243 and is in addition to an extra copy specified by the
1246 .Pq up to a total of 3 copies .
1247 For example if the pool is mirrored,
1248 .Cm copies Ns = Ns Ar 2 ,
1250 .Cm redundant_metadata Ns = Ns Ar most ,
1252 stores 6 copies of most metadata, and 4 copies of data and some
1257 ZFS stores an extra copy of all metadata.
1259 single on-disk block is corrupt, at worst a single block of user data
1268 ZFS stores an extra copy of most types of
1270 This can improve performance of random writes, because less
1271 metadata must be written.
1272 In practice, at worst about 100 blocks
1277 of user data can be lost if a single
1278 on-disk block is corrupt.
1279 The exact behavior of which metadata blocks
1280 are stored redundantly may change in future releases.
1282 The default value is
1284 .It Sy refquota Ns = Ns Ar size | Cm none
1285 Limits the amount of space a dataset can consume. This property enforces a hard
1286 limit on the amount of space used. This hard limit does not include space used
1287 by descendents, including file systems and snapshots.
1288 .It Sy refreservation Ns = Ns Ar size | Cm none
1289 The minimum amount of space guaranteed to a dataset, not including its
1290 descendents. When the amount of space used is below this value, the dataset is
1291 treated as if it were taking up the amount of space specified by
1292 .Sy refreservation .
1295 reservation is accounted for in the parent datasets' space used, and counts
1296 against the parent datasets' quotas and reservations.
1300 is set, a snapshot is only allowed if there is enough free pool space outside
1301 of this reservation to accommodate the current number of "referenced" bytes in
1304 This property can also be referred to by its shortened column name,
1306 .It Sy reservation Ns = Ns Ar size | Cm none
1307 The minimum amount of space guaranteed to a dataset and its descendents. When
1308 the amount of space used is below this value, the dataset is treated as if it
1309 were taking up the amount of space specified by its reservation. Reservations
1310 are accounted for in the parent datasets' space used, and count against the
1311 parent datasets' quotas and reservations.
1313 This property can also be referred to by its shortened column name,
1315 .It Sy secondarycache Ns = Ns Cm all | none | metadata
1316 Controls what is cached in the secondary cache (L2ARC). If this property is set
1319 then both user data and metadata is cached. If this property is set to
1321 then neither user data nor metadata is cached. If this property is set to
1323 then only metadata is cached. The default value is
1325 .It Sy setuid Ns = Ns Cm on | off
1326 Controls whether the
1328 bit is respected for the file system. The default value is
1330 .It Sy sharesmb Ns = Ns Cm on | off | Ar opts
1333 property currently has no effect on
1335 .It Sy sharenfs Ns = Ns Cm on | off | Ar opts
1336 Controls whether the file system is shared via
1338 and what options are used. A file system with a
1342 is managed the traditional way via
1344 Otherwise, the file system is automatically shared and unshared with the
1348 commands. If the property is set to
1352 export options are used. Otherwise,
1354 export options are equivalent to the contents of this property. The export
1355 options may be comma-separated. See
1357 for a list of valid options.
1361 property is changed for a dataset, the
1364 .It Sy logbias Ns = Ns Cm latency | throughput
1367 about handling of synchronous requests in this dataset.
1374 will use pool log devices (if configured) to handle the requests at low
1380 will not use configured pool log devices.
1382 will instead optimize synchronous operations for global pool throughput and
1383 efficient use of resources.
1384 .It Sy snapdir Ns = Ns Cm hidden | visible
1385 Controls whether the
1387 directory is hidden or visible in the root of the file system as discussed in
1390 section. The default value is
1392 .It Sy sync Ns = Ns Cm standard | always | disabled
1393 Controls the behavior of synchronous requests (e.g.
1395 O_DSYNC). This property accepts the following values:
1396 .Bl -tag -offset 4n -width 8n
1398 This is the POSIX specified behavior of ensuring all synchronous requests are
1399 written to stable storage and all devices are flushed to ensure data is not
1400 cached by device controllers (this is the default).
1402 All file system transactions are written and flushed before their system calls
1403 return. This has a large performance penalty.
1405 Disables synchronous requests. File system transactions are only committed to
1406 stable storage periodically. This option will give the highest performance.
1407 However, it is very dangerous as
1409 would be ignoring the synchronous transaction demands of applications such as
1412 Administrators should only use this option when the risks are understood.
1414 .It Sy volsize Ns = Ns Ar size
1415 For volumes, specifies the logical size of the volume. By default, creating a
1416 volume establishes a reservation of equal size. For storage pools with a
1417 version number of 9 or higher, a
1419 is set instead. Any changes to
1421 are reflected in an equivalent change to the reservation (or
1422 .Sy refreservation ) .
1425 can only be set to a multiple of
1429 The reservation is kept equal to the volume's logical size to prevent
1430 unexpected behavior for consumers. Without the reservation, the volume could
1431 run out of space, resulting in undefined behavior or data corruption, depending
1432 on how the volume is used. These effects can also occur when the volume size is
1433 changed while it is in use (particularly when shrinking the size). Extreme care
1434 should be used when adjusting the volume size.
1436 Though not recommended, a "sparse volume" (also known as "thin provisioning")
1437 can be created by specifying the
1440 .Qq Nm Cm create Fl V
1441 command, or by changing the reservation after the volume has been created. A
1442 "sparse volume" is a volume where the reservation is less then the volume size.
1443 Consequently, writes to a sparse volume can fail with
1445 when the pool is low on space. For a sparse volume, changes to
1447 are not reflected in the reservation.
1448 .It Sy volmode Ns = Ns Cm default | geom | dev | none
1449 This property specifies how volumes should be exposed to the OS.
1454 providers, providing maximal functionality.
1457 exposes volumes only as cdev device in devfs.
1458 Such volumes can be accessed only as raw disk device files, i.e. they
1459 can not be partitioned, mounted, participate in RAIDs, etc, but they
1460 are faster, and in some use scenarios with untrusted consumer, such as
1461 NAS or VM storage, can be more safe.
1462 Volumes with property set to
1464 are not exposed outside ZFS, but can be snapshoted, cloned, replicated, etc,
1465 that can be suitable for backup purposes.
1468 means that volumes exposition is controlled by system-wide sysctl/tunable
1469 .Va vfs.zfs.vol.mode ,
1475 are encoded as 1, 2 and 3 respectively.
1476 The default values is
1478 This property can be changed any time, but so far it is processed only
1479 during volume creation and pool import.
1480 .It Sy vscan Ns = Ns Cm off | on
1483 property is currently not supported on
1485 .It Sy xattr Ns = Ns Cm off | on
1488 property is currently not supported on
1490 .It Sy jailed Ns = Ns Cm off | on
1491 Controls whether the dataset is managed from a jail. See the
1493 section for more information. The default value is
1497 The following three properties cannot be changed after the file system is
1498 created, and therefore, should be set when the file system is created. If the
1499 properties are not set with the
1503 commands, these properties are inherited from the parent dataset. If the parent
1504 dataset lacks these properties due to having been created prior to these
1505 features being supported, the new file system will have the default values for
1508 .It Sy casesensitivity Ns = Ns Cm sensitive | insensitive | mixed
1509 Indicates whether the file name matching algorithm used by the file system
1510 should be case-sensitive, case-insensitive, or allow a combination of both
1511 styles of matching. The default value for the
1515 Traditionally, UNIX and POSIX file systems have case-sensitive file names.
1521 property indicates that the
1522 file system can support requests for both case-sensitive and case-insensitive
1524 .It Sy normalization Ns = Ns Cm none | formC | formD | formKC | formKD
1525 Indicates whether the file system should perform a
1527 normalization of file names whenever two file names are compared, and which
1528 normalization algorithm should be used. File names are always stored
1529 unmodified, names are normalized as part of any comparison process. If this
1530 property is set to a legal value other than
1534 property was left unspecified, the
1536 property is automatically set to
1538 The default value of the
1542 This property cannot be changed after the file system is created.
1543 .It Sy utf8only Ns = Ns Cm on | off
1544 Indicates whether the file system should reject file names that include
1545 characters that are not present in the
1547 character code set. If this property is explicitly set to
1549 the normalization property must either not be explicitly set or be set to
1551 The default value for the
1555 This property cannot be changed after the file system is created.
1559 .Sy casesensitivity , normalization , No and Sy utf8only
1560 properties are also new permissions that can be assigned to non-privileged
1563 delegated administration feature.
1564 .Ss Temporary Mount Point Properties
1565 When a file system is mounted, either through
1567 for legacy mounts or the
1569 command for normal file systems, its mount options are set according to its
1570 properties. The correlation between properties and mount options is as follows:
1571 .Bl -column -offset 4n "PROPERTY" "MOUNT OPTION"
1572 .It "PROPERTY MOUNT OPTION"
1573 .It "atime atime/noatime"
1574 .It "exec exec/noexec"
1575 .It "readonly ro/rw"
1576 .It "setuid suid/nosuid"
1579 In addition, these options can be set on a per-mount basis using the
1581 option, without affecting the property that is stored on disk. The values
1582 specified on the command line override the values stored in the dataset. These
1583 properties are reported as "temporary" by the
1585 command. If the properties are changed while the dataset is mounted, the new
1586 setting overrides any temporary settings.
1588 In addition to the standard native properties,
1590 supports arbitrary user properties. User properties have no effect on
1592 behavior, but applications or administrators can use them to annotate datasets
1593 (file systems, volumes, and snapshots).
1595 User property names must contain a colon
1597 character to distinguish them from native properties. They may contain
1598 lowercase letters, numbers, and the following punctuation characters: colon
1606 The expected convention is that the property name is divided into two portions
1608 .Em module Ns Sy \&: Ns Em property ,
1609 but this namespace is not enforced by
1611 User property names can be at most 256 characters, and cannot begin with a dash
1614 When making programmatic use of user properties, it is strongly suggested to
1619 component of property names to reduce the chance that two
1620 independently-developed packages use the same property name for different
1621 purposes. Property names beginning with
1623 are reserved for use by Sun Microsystems.
1625 The values of user properties are arbitrary strings, are always inherited, and
1626 are never validated. All of the commands that operate on properties
1633 can be used to manipulate both native properties and user properties. Use the
1635 command to clear a user property. If the property is not defined in any parent
1636 dataset, it is removed entirely. Property values are limited to 1024
1639 All subcommands that modify state are logged persistently to the pool in their
1647 Displays a help message.
1652 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1658 file system. The file system is automatically mounted according to the
1660 property inherited from the parent.
1661 .Bl -tag -width indent
1663 Creates all the non-existing parent datasets. Datasets created in this manner
1664 are automatically mounted according to the
1666 property inherited from their parent. Any property specified on the command
1669 option is ignored. If the target filesystem already exists, the operation
1670 completes successfully.
1672 Newly created file system is not mounted.
1673 .It Fl o Ar property Ns = Ns Ar value
1674 Sets the specified property as if the command
1675 .Qq Nm Cm set Ar property Ns = Ns Ar value
1676 was invoked at the same time the dataset was created. Any editable
1678 property can also be set at creation time. Multiple
1680 options can be specified. An error results if the same property is specified in
1689 .Op Fl b Ar blocksize
1690 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1695 Creates a volume of the given size. The volume is exported as a block device in
1696 .Pa /dev/zvol/path ,
1699 is the name of the volume in the
1701 namespace. The size represents the logical size as exported by the device. By
1702 default, a reservation of equal size is created.
1705 is automatically rounded up to the nearest 128 Kbytes to ensure that
1706 the volume has an integral number of blocks regardless of
1708 .Bl -tag -width indent
1710 Creates all the non-existing parent datasets. Datasets created in this manner
1711 are automatically mounted according to the
1713 property inherited from their parent. Any property specified on the command
1716 option is ignored. If the target filesystem already exists, the operation
1717 completes successfully.
1719 Creates a sparse volume with no reservation. See
1722 .Qq Sx Native Properties
1723 section for more information about sparse volumes.
1724 .It Fl b Ar blocksize
1726 .Fl o Cm volblocksize Ns = Ns Ar blocksize .
1727 If this option is specified in conjunction with
1728 .Fl o Cm volblocksize ,
1729 the resulting behavior is undefined.
1730 .It Fl o Ar property Ns = Ns Ar value
1731 Sets the specified property as if the
1732 .Qq Nm Cm set Ar property Ns = Ns Ar value
1733 command was invoked at the same time the dataset was created. Any editable
1735 property can also be set at creation time. Multiple
1737 options can be specified. An error results if the same property is specified in
1746 .Ar filesystem Ns | Ns Ar volume
1749 Destroys the given dataset. By default, the command unshares any file systems
1750 that are currently shared, unmounts any file systems that are currently
1751 mounted, and refuses to destroy a dataset that has active dependents (children
1753 .Bl -tag -width indent
1755 Recursively destroy all children.
1757 Recursively destroy all dependents, including cloned file systems outside the
1760 Force an unmount of any file systems using the
1761 .Qq Nm Cm unmount Fl f
1762 command. This option has no effect on non-file systems or unmounted file
1765 Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in
1766 conjunction with the
1770 flags to determine what data would be deleted.
1772 Print machine-parsable verbose information about the deleted data.
1774 Print verbose information about the deleted data.
1777 Extreme care should be taken when applying either the
1781 options, as they can destroy large portions of a pool and cause unexpected
1782 behavior for mounted file systems in use.
1789 .Op % Ns Ar snapname
1794 The given snapshots are destroyed immediately if and only if the
1798 option would have destroyed it. Such immediate destruction would occur, for
1799 example, if the snapshot had no clones and the user-initiated reference count
1802 If a snapshot does not qualify for immediate destruction, it is marked for
1803 deferred deletion. In this state, it exists as a usable, visible snapshot until
1804 both of the preconditions listed above are met, at which point it is destroyed.
1806 An inclusive range of snapshots may be specified by separating the
1807 first and last snapshots with a percent sign
1809 The first and/or last snapshots may be left blank, in which case the
1810 filesystem's oldest or newest snapshot will be implied.
1813 (or ranges of snapshots) of the same filesystem or volume may be specified
1814 in a comma-separated list of snapshots.
1815 Only the snapshot's short name (the
1818 should be specified when using a range or comma-separated list to identify
1820 .Bl -tag -width indent
1822 Destroy (or mark for deferred deletion) all snapshots with this name in
1823 descendent file systems.
1825 Recursively destroy all clones of these snapshots, including the clones,
1826 snapshots, and children.
1827 If this flag is specified, the
1829 flag will have no effect.
1831 Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in
1832 conjunction with the
1836 flags to determine what data would be deleted.
1838 Print machine-parsable verbose information about the deleted data.
1840 Print verbose information about the deleted data.
1842 Defer snapshot deletion.
1845 Extreme care should be taken when applying either the
1849 options, as they can destroy large portions of a pool and cause unexpected
1850 behavior for mounted file systems in use.
1854 .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
1857 The given bookmark is destroyed.
1860 .Cm snapshot Ns | Ns Cm snap
1862 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1863 .Ar filesystem@snapname Ns | Ns volume@snapname
1864 .Ar filesystem@snapname Ns | Ns volume@snapname Ns ...
1867 Creates snapshots with the given names. All previous modifications by
1868 successful system calls to the file system are part of the snapshots.
1869 Snapshots are taken atomically, so that all snapshots correspond to the same
1870 moment in time. See the
1872 section for details.
1873 .Bl -tag -width indent
1875 Recursively create snapshots of all descendent datasets
1876 .It Fl o Ar property Ns = Ns Ar value
1877 Sets the specified property; see
1888 Roll back the given dataset to a previous snapshot. When a dataset is rolled
1889 back, all data that has changed since the snapshot is discarded, and the
1890 dataset reverts to the state at the time of the snapshot. By default, the
1891 command refuses to roll back to a snapshot other than the most recent one. In
1892 order to do so, all intermediate snapshots and bookmarks must be destroyed
1899 options do not recursively destroy the child snapshots of a
1901 Only direct snapshots of the specified filesystem
1902 are destroyed by either of these options.
1903 To completely roll back a
1904 recursive snapshot, you must rollback the individual child snapshots.
1905 .Bl -tag -width indent
1907 Destroy any snapshots and bookmarks more recent than the one specified.
1909 Destroy any more recent snapshots and bookmarks, as well as any clones of those
1914 option to force an unmount of any clone file systems that are to be destroyed.
1920 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1921 .Ar snapshot filesystem Ns | Ns Ar volume
1924 Creates a clone of the given snapshot. See the
1926 section for details. The target dataset can be located anywhere in the
1928 hierarchy, and is created as the same type as the original.
1929 .Bl -tag -width indent
1931 Creates all the non-existing parent datasets. Datasets created in this manner
1932 are automatically mounted according to the
1934 property inherited from their parent. If the target filesystem or volume
1935 already exists, the operation completes successfully.
1936 .It Fl o Ar property Ns = Ns Ar value
1937 Sets the specified property; see
1944 .Ar clone-filesystem
1947 Promotes a clone file system to no longer be dependent on its "origin"
1948 snapshot. This makes it possible to destroy the file system that the clone was
1949 created from. The clone parent-child dependency relationship is reversed, so
1950 that the origin file system becomes a clone of the specified file system.
1952 The snapshot that was cloned, and any snapshots previous to this snapshot, are
1953 now owned by the promoted clone. The space they use moves from the origin file
1954 system to the promoted clone, so enough space must be available to accommodate
1955 these snapshots. No new space is consumed by this operation, but the space
1956 accounting is adjusted. The promoted clone must not have any conflicting
1957 snapshot names of its own. The
1959 subcommand can be used to rename any conflicting snapshots.
1964 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1965 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1972 .Ar filesystem Ns | Ns Ar volume
1973 .Ar filesystem Ns | Ns Ar volume
1980 .Ar filesystem filesystem
1983 Renames the given dataset. The new target can be located anywhere in the
1985 hierarchy, with the exception of snapshots. Snapshots can only be renamed
1986 within the parent file system or volume. When renaming a snapshot, the parent
1987 file system of the snapshot does not need to be specified as part of the second
1988 argument. Renamed file systems can inherit new mount points, in which case they
1989 are unmounted and remounted at the new mount point.
1990 .Bl -tag -width indent
1992 Creates all the nonexistent parent datasets. Datasets created in this manner
1993 are automatically mounted according to the
1995 property inherited from their parent.
1997 Do not remount file systems during rename. If a file system's
2003 file system is not unmounted even if this option is not given.
2005 Force unmount any filesystems that need to be unmounted in the process.
2006 This flag has no effect if used together with the
2014 .Ar snapshot snapshot
2017 Recursively rename the snapshots of all descendent datasets. Snapshots are the
2018 only dataset that can be renamed recursively.
2022 .Op Fl r Ns | Ns Fl d Ar depth
2024 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2025 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2026 .Oo Fl s Ar property Oc Ns ...
2027 .Oo Fl S Ar property Oc Ns ...
2028 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
2031 Lists the property information for the given datasets in tabular form. If
2032 specified, you can list property information by the absolute pathname or the
2033 relative pathname. By default, all file systems and volumes are displayed.
2034 Snapshots are displayed if the
2040 The following fields are displayed,
2041 .Sy name , used , available , referenced , mountpoint .
2042 .Bl -tag -width indent
2044 Recursively display any children of the dataset on the command line.
2046 Recursively display any children of the dataset, limiting the recursion to
2050 will display only the dataset and its direct children.
2052 Used for scripting mode. Do not print headers and separate fields by a single
2053 tab instead of arbitrary white space.
2055 Display numbers in parsable (exact) values.
2056 .It Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2057 A comma-separated list of properties to display. The property must be:
2058 .Bl -bullet -offset 2n
2060 One of the properties described in the
2061 .Qq Sx Native Properties
2068 to display the dataset name
2072 to display space usage properties on file systems and volumes. This is a
2073 shortcut for specifying
2075 .Sy name,avail,used,usedsnap,usedds,usedrefreserv,usedchild
2077 .Sy filesystem,volume
2080 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2081 A comma-separated list of types to display, where
2084 .Sy filesystem , snapshot , snap , volume , bookmark , No or Sy all .
2085 For example, specifying
2087 displays only snapshots.
2088 .It Fl s Ar property
2089 A property for sorting the output by column in ascending order based on the
2090 value of the property. The property must be one of the properties described in
2093 section, or the special value
2095 to sort by the dataset name. Multiple properties can be specified at one time
2098 property options. Multiple
2100 options are evaluated from left to right in decreasing order of importance.
2102 The following is a list of sorting criteria:
2103 .Bl -bullet -offset 2n
2105 Numeric types sort in numeric order.
2107 String types sort in alphabetical order.
2109 Types inappropriate for a row sort that row to the literal bottom, regardless
2110 of the specified ordering.
2112 If no sorting options are specified the existing behavior of
2116 .It Fl S Ar property
2119 option, but sorts by property in descending order.
2124 .Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ...
2125 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2128 Sets the property or list of properties to the given value(s) for each dataset.
2129 Only some properties can be edited. See the "Properties" section for more
2130 information on what properties can be set and acceptable values. Numeric values
2131 can be specified as exact values, or in a human-readable form with a suffix of
2132 .Sy B , K , M , G , T , P , E , Z
2133 (for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes, or
2134 zettabytes, respectively). User properties can be set on snapshots. For more
2135 information, see the
2136 .Qq Sx User Properties
2141 .Op Fl r Ns | Ns Fl d Ar depth
2143 .Op Fl o Ar all | field Ns Oo , Ns Ar field Oc Ns ...
2144 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2145 .Op Fl s Ar source Ns Oo , Ns Ar source Oc Ns ...
2146 .Ar all | property Ns Oo , Ns Ar property Oc Ns ...
2147 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
2150 Displays properties for the given datasets. If no datasets are specified, then
2151 the command displays properties for all datasets on the system. For each
2152 property, the following columns are displayed:
2154 .Bl -hang -width "property" -offset indent -compact
2162 Property source. Can either be local, default, temporary, inherited, received,
2167 All columns except the
2169 column are displayed by default. The columns to display can be specified
2172 option. This command takes a comma-separated list of properties as described in
2174 .Qq Sx Native Properties
2176 .Qq Sx User Properties
2181 can be used to display all properties that apply to the given dataset's type
2182 (filesystem, volume, snapshot, or bookmark).
2183 .Bl -tag -width indent
2185 Recursively display properties for any children.
2187 Recursively display any children of the dataset, limiting the recursion to
2191 will display only the dataset and its direct children.
2193 Display output in a form more easily parsed by scripts. Any headers are
2194 omitted, and fields are explicitly separated by a single tab instead of an
2195 arbitrary amount of space.
2197 Display numbers in parsable (exact) values.
2198 .It Fl o Cm all | Ar field Ns Oo , Ns Ar field Oc Ns ...
2199 A comma-separated list of columns to display. Supported values are
2200 .Sy name,property,value,received,source .
2202 .Sy name,property,value,source .
2205 specifies all columns.
2206 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2207 A comma-separated list of types to display, where
2210 .Sy filesystem , snapshot , volume , No or Sy all .
2211 For example, specifying
2213 displays only snapshots.
2214 .It Fl s Ar source Ns Oo , Ns Ar source Oc Ns ...
2215 A comma-separated list of sources to display. Those properties coming from a
2216 source other than those in this list are ignored. Each source must be one of
2218 .Sy local,default,inherited,temporary,received,none .
2219 The default value is all sources.
2226 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
2229 Clears the specified property, causing it to be inherited from an ancestor,
2230 restored to default if no ancestor has the property set, or with the
2232 option reverted to the received value if one exists.
2235 section for a listing of default values, and details on which properties can be
2237 .Bl -tag -width indent
2239 Recursively inherit the given property for all children.
2241 Revert the property to the received value if one exists; otherwise operate as
2244 option was not specified.
2252 Displays a list of file systems that are not the most recent version.
2253 .Bl -tag -width indent
2257 filesystem versions supported by the current software. The current
2259 filesystem version and all previous supported versions are displayed, along
2260 with an explanation of the features provided with each version.
2267 .Fl a | Ar filesystem
2270 Upgrades file systems to a new on-disk version. Once this is done, the file
2271 systems will no longer be accessible on systems running older versions of the
2274 streams generated from new snapshots of these file systems cannot be accessed
2275 on systems running older versions of the software.
2277 In general, the file system version is independent of the pool version. See
2279 for information on the
2280 .Nm zpool Cm upgrade
2283 In some cases, the file system version and the pool version are interrelated
2284 and the pool version must be upgraded before the file system version can be
2286 .Bl -tag -width indent
2288 Upgrade the specified file system and all descendent file systems.
2290 Upgrade to the specified
2294 flag is not specified, this command upgrades to the most recent version. This
2295 option can only be used to increase the version number, and only up to the most
2296 recent version supported by this software.
2298 Upgrade all file systems on all imported pools.
2300 Upgrade the specified file system.
2306 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2307 .Oo Fl s Ar field Oc Ns ...
2308 .Oo Fl S Ar field Oc Ns ...
2309 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2310 .Ar filesystem Ns | Ns Ar snapshot
2313 Displays space consumed by, and quotas on, each user in the specified
2314 filesystem or snapshot. This corresponds to the
2315 .Sy userused@ Ns Ar user
2317 .Sy userquota@ Ns Ar user
2319 .Bl -tag -width indent
2321 Print numeric ID instead of user/group name.
2323 Do not print headers, use tab-delimited output.
2325 Use exact (parsable) numeric output.
2326 .It Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2327 Display only the specified fields from the following set:
2328 .Sy type,name,used,quota .
2329 The default is to display all fields.
2331 Sort output by this field. The
2335 flags may be specified multiple times to sort first by one field, then by
2336 another. The default is
2337 .Fl s Cm type Fl s Cm name .
2339 Sort by this field in reverse order. See
2341 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2342 Print only the specified types from the following set:
2343 .Sy all,posixuser,smbuser,posixgroup,smbgroup .
2346 .Fl t Cm posixuser,smbuser .
2348 The default can be changed to include group types.
2350 Translate SID to POSIX ID. This flag currently has no effect on
2357 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2358 .Oo Fl s Ar field Oc Ns ...
2359 .Oo Fl S Ar field Oc Ns ...
2360 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2361 .Ar filesystem Ns | Ns Ar snapshot
2364 Displays space consumed by, and quotas on, each group in the specified
2365 filesystem or snapshot. This subcommand is identical to
2366 .Qq Nm Cm userspace ,
2367 except that the default types to display are
2368 .Fl t Sy posixgroup,smbgroup .
2376 file systems currently mounted.
2377 .Bl -tag -width indent
2384 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2385 .Fl a | Ar filesystem
2391 .Bl -tag -width indent
2393 Report mount progress.
2395 Perform an overlay mount. Overlay mounts are not supported on
2397 .It Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2398 An optional, comma-separated list of mount options to use temporarily for the
2399 duration of the mount. See the
2400 .Qq Sx Temporary Mount Point Properties
2401 section for details.
2406 This command may be executed on
2410 For more information, see variable
2415 Mount the specified filesystem.
2419 .Cm unmount Ns | Ns Cm umount
2421 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
2424 Unmounts currently mounted
2427 .Bl -tag -width indent
2429 Forcefully unmount the file system, even if it is currently in use.
2431 Unmount all available
2434 .It Ar filesystem | mountpoint
2435 Unmount the specified filesystem. The command can also be given a path to a
2437 file system mount point on the system.
2442 .Fl a | Ar filesystem
2447 file systems that have the
2450 .Bl -tag -width indent
2454 file systems that have the
2457 This command may be executed on
2461 For more information, see variable
2466 Share the specified filesystem according to the
2468 property. File systems are shared when the
2475 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
2480 file systems that have the
2483 .Bl -tag -width indent
2487 file systems that have the
2490 This command may be executed on
2494 For more information, see variable
2498 .It Ar filesystem | mountpoint
2499 Unshare the specified filesystem. The command can also be given a path to a
2501 file system shared on the system.
2510 Creates a bookmark of the given snapshot.
2511 Bookmarks mark the point in time
2512 when the snapshot was created, and can be used as the incremental source for
2517 This feature must be enabled to be used.
2519 .Xr zpool-features 7
2520 for details on ZFS feature flags and the
2527 .Op Fl i Ar snapshot | Fl I Ar snapshot
2531 Creates a stream representation of the last
2533 argument (not part of
2537 which is written to standard output. The output can be redirected to
2538 a file or to a different system (for example, using
2540 By default, a full stream is generated.
2541 .Bl -tag -width indent
2542 .It Fl i Ar snapshot
2543 Generate an incremental stream from the first
2544 .Ar snapshot Pq the incremental source
2546 .Ar snapshot Pq the incremental target .
2547 The incremental source can be specified as the last component of the
2549 .Pq the Em @ No character and following
2551 it is assumed to be from the same file system as the incremental target.
2553 If the destination is a clone, the source may be the origin snapshot, which
2554 must be fully specified (for example,
2555 .Cm pool/fs@origin ,
2558 .It Fl I Ar snapshot
2559 Generate a stream package that sends all intermediary snapshots from the first
2566 .Ic -i @a fs@b; -i @b fs@c; -i @c fs@d .
2568 source may be specified as with the
2572 Generate a replication stream package, which will replicate the specified
2573 filesystem, and all descendent file systems, up to the named snapshot. When
2574 received, all properties, snapshots, descendent file systems, and clones are
2581 flags are used in conjunction with the
2583 flag, an incremental replication stream is generated. The current values of
2584 properties, and current snapshot and file system names are set when the stream
2587 flag is specified when this stream is received, snapshots and file systems that
2588 do not exist on the sending side are destroyed.
2590 Generate a deduplicated stream. Blocks which would have been sent multiple
2591 times in the send stream will only be sent once. The receiving system must
2592 also support this feature to receive a deduplicated stream. This flag can
2593 be used regardless of the dataset's
2595 property, but performance will be much better if the filesystem uses a
2596 dedup-capable checksum (eg.
2599 Generate a stream which may contain blocks larger than 128KB.
2601 has no effect if the
2603 pool feature is disabled, or if the
2605 property of this filesystem has never been set above 128KB.
2606 The receiving system must have the
2608 pool feature enabled as well.
2610 .Xr zpool-features 7
2611 for details on ZFS feature flags and the
2615 Generate a more compact stream by using WRITE_EMBEDDED records for blocks
2616 which are stored more compactly on disk by the
2620 This flag has no effect if the
2624 The receiving system must have the
2630 feature is active on the sending system,
2631 then the receiving system must have that feature enabled as well.
2633 .Xr zpool-features 7
2634 for details on ZFS feature flags and the
2638 Include the dataset's properties in the stream. This flag is implicit when
2640 is specified. The receiving system must also support this feature.
2642 Do a dry-run ("No-op") send. Do not generate any actual send data. This is
2643 useful in conjunction with the
2647 flags to determine what data will be sent.
2648 In this case, the verbose output will be written to
2649 standard output (contrast with a non-dry-run, where the stream is written
2650 to standard output and the verbose output goes to standard error).
2652 Print machine-parsable verbose information about the stream package generated.
2654 Print verbose information about the stream package generated.
2655 This information includes a per-second report of how much data has been sent.
2658 The format of the stream is committed. You will be able to receive your streams
2659 on future versions of
2665 .Op Fl i Ar snapshot Ns | Ns Ar bookmark
2666 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2669 Generate a send stream, which may be of a filesystem, and may be
2670 incremental from a bookmark.
2671 If the destination is a filesystem or volume,
2672 the pool must be read-only, or the filesystem must not be mounted.
2674 stream generated from a filesystem or volume is received, the default snapshot
2677 .Bl -tag -width indent
2678 .It Fl i Ar snapshot Ns | Ns bookmark
2679 Generate an incremental send stream.
2680 The incremental source must be an earlier
2681 snapshot in the destination's history.
2682 It will commonly be an earlier
2683 snapshot in the destination's filesystem, in which case it can be
2684 specified as the last component of the name
2685 .Pq the Em # No or Em @ No character and following .
2687 If the incremental target is a clone, the incremental source can
2688 be the origin snapshot, or an earlier snapshot in the origin's filesystem,
2689 or the origin's origin, etc.
2691 Generate a stream which may contain blocks larger than 128KB.
2693 has no effect if the
2695 pool feature is disabled, or if the
2697 property of this filesystem has never been set above 128KB.
2698 The receiving system must have the
2700 pool feature enabled as well.
2702 .Xr zpool-features 7
2703 for details on ZFS feature flags and the
2707 Generate a more compact stream by using WRITE_EMBEDDED records for blocks
2708 which are stored more compactly on disk by the
2712 This flag has no effect if the
2716 The receiving system must have the
2722 feature is active on the sending system,
2723 then the receiving system must have that feature enabled as well.
2725 .Xr zpool-features 7
2726 for details on ZFS feature flags and the
2735 .Ar receive_resume_token
2737 Creates a send stream which resumes an interrupted receive. The
2738 .Ar receive_resume_token
2739 is the value of this property on the filesystem
2740 or volume that was being received into. See the documentation for
2745 .Cm receive Ns | Ns Cm recv
2747 .Op Fl o Sy origin Ns = Ns Ar snapshot
2748 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2752 .Cm receive Ns | Ns Cm recv
2755 .Op Fl o Sy origin Ns = Ns Ar snapshot
2759 Creates a snapshot whose contents are as specified in the stream provided on
2760 standard input. If a full stream is received, then a new file system is created
2761 as well. Streams are created using the
2763 subcommand, which by default creates a full stream.
2765 can be used as an alias for
2768 If an incremental stream is received, then the destination file system must
2769 already exist, and its most recent snapshot must match the incremental stream's
2772 the destination device link is destroyed and recreated, which means the
2774 cannot be accessed during the
2778 When a snapshot replication package stream that is generated by using the
2780 command is received, any snapshots that do not exist on the sending location
2781 are destroyed by using the
2782 .Qq Nm Cm destroy Fl d
2785 The name of the snapshot (and file system, if a full stream is received) that
2786 this subcommand creates depends on the argument type and the
2792 If the argument is a snapshot name, the specified
2794 is created. If the argument is a file system or volume name, a snapshot with
2795 the same name as the sent snapshot is created within the specified
2803 option is specified, the snapshot name is determined by appending the sent
2804 snapshot's name to the specified
2808 option is specified, all but the pool name of the sent snapshot path is
2809 appended (for example,
2811 appended from sent snapshot
2815 option is specified, only the tail of the sent snapshot path is appended (for
2818 appended from sent snapshot
2822 any file systems needed to replicate the path of the sent snapshot are created
2823 within the specified file system.
2824 .Bl -tag -width indent
2826 Use the full sent snapshot path without the first element (without pool name)
2827 to determine the name of the new snapshot as described in the paragraph above.
2829 Use only the last element of the sent snapshot path to determine the name of
2830 the new snapshot as described in the paragraph above.
2832 File system that is associated with the received stream is not mounted.
2834 Print verbose information about the stream and the time required to perform the
2837 Do not actually receive the stream. This can be useful in conjunction with the
2839 option to verify the name the receive operation would use.
2840 .It Fl o Sy origin Ns = Ns Ar snapshot
2841 Forces the stream to be received as a clone of the given snapshot.
2842 This is only valid if the stream is an incremental stream whose source
2843 is the same as the provided origin.
2845 Force a rollback of the file system to the most recent snapshot before
2846 performing the receive operation. If receiving an incremental replication
2847 stream (for example, one generated by
2848 .Qq Nm Cm send Fl R Bro Fl i | Fl I Brc ) ,
2849 destroy snapshots and file systems that do not exist on the sending side.
2851 If the receive is interrupted, save the partially received state, rather
2852 than deleting it. Interruption may be due to premature termination of
2854 .Po e.g. due to network failure or failure of the remote system
2855 if the stream is being read over a network connection
2857 a checksum error in the stream, termination of the
2859 process, or unclean shutdown of the system.
2861 The receive can be resumed with a stream generated by
2862 .Nm zfs Cm send Fl t Ar token ,
2866 .Sy receive_resume_token
2867 property of the filesystem or volume which is received into.
2869 To use this flag, the storage pool must have the
2870 .Sy extensible_dataset
2871 feature enabled. See
2872 .Xr zpool-features 5
2873 for details on ZFS feature flags.
2877 .Cm receive Ns | Ns Cm recv
2879 .Ar filesystem Ns | Ns Ar volume
2881 Abort an interrupted
2882 .Nm zfs Cm receive Fl s ,
2883 deleting its saved partially received state.
2887 .Ar filesystem Ns | Ns Ar volume
2890 Displays permissions that have been delegated on the specified filesystem or
2891 volume. See the other forms of
2893 for more information.
2898 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
2899 .Ar perm Ns | Ns Ar @setname Ns
2900 .Oo Ns , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
2901 .Ar filesystem Ns | Ns Ar volume
2907 .Fl e Ns | Ns Cm everyone
2908 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
2910 .Ar filesystem Ns | Ns Ar volume
2915 administration permission for the file systems to non-privileged users.
2916 .Bl -tag -width indent
2919 .Ar user Ns | Ns Ar group Ns Oo , Ar user Ns | Ns Ar group Oc Ns ...
2921 Specifies to whom the permissions are delegated. Multiple entities can be
2922 specified as a comma-separated list. If neither of the
2924 options are specified, then the argument is interpreted preferentially as the
2927 then as a user name, and lastly as a group name. To specify
2928 a user or group named
2934 options. To specify a group with the same name as a user, use the
2937 .It Op Fl e Ns | Ns Cm everyone
2938 Specifies that the permissions be delegated to
2941 .Ar perm Ns | Ns Ar @setname Ns Oo , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
2943 The permissions to delegate. Multiple permissions
2944 may be specified as a comma-separated list. Permission names are the same as
2946 subcommand and property names. See the property list below. Property set names,
2947 which begin with an at sign
2949 may be specified. See the
2951 form below for details.
2954 .Ar filesystem Ns | Ns Ar volume
2956 Specifies where the permissions are delegated. If neither of the
2958 options are specified, or both are, then the permissions are allowed for the
2959 file system or volume, and all of its descendents. If only the
2961 option is used, then is allowed "locally" only for the specified file system.
2964 option is used, then is allowed only for the descendent file systems.
2967 Permissions are generally the ability to use a
2969 subcommand or change a
2971 property. The following permissions are available:
2972 .Bl -column -offset 4n "secondarycache" "subcommand"
2973 .It NAME Ta TYPE Ta NOTES
2974 .It allow Ta subcommand Ta Must Xo
2975 also have the permission that is being allowed
2977 .It clone Ta subcommand Ta Must Xo
2978 also have the 'create' ability and 'mount' ability in the origin file system
2980 .It create Ta subcommand Ta Must also have the 'mount' ability
2981 .It destroy Ta subcommand Ta Must also have the 'mount' ability
2982 .It diff Ta subcommand Ta Allows lookup of paths within a dataset given an
2983 object number, and the ability to create snapshots necessary to 'zfs diff'
2984 .It hold Ta subcommand Ta Allows adding a user hold to a snapshot
2985 .It mount Ta subcommand Ta Allows mount/umount of Tn ZFS No datasets
2986 .It promote Ta subcommand Ta Must Xo
2987 also have the 'mount' and 'promote' ability in the origin file system
2989 .It receive Ta subcommand Ta Must also have the 'mount' and 'create' ability
2990 .It release Ta subcommand Ta Allows Xo
2991 releasing a user hold which might destroy the snapshot
2993 .It rename Ta subcommand Ta Must Xo
2994 also have the 'mount' and 'create' ability in the new parent
2996 .It rollback Ta subcommand Ta Must also have the 'mount' ability
2997 .It send Ta subcommand
2998 .It share Ta subcommand Ta Allows Xo
2999 sharing file systems over the
3003 .It snapshot Ta subcommand Ta Must also have the 'mount' ability
3004 .It groupquota Ta other Ta Allows accessing any groupquota@... property
3005 .It groupused Ta other Ta Allows reading any groupused@... property
3006 .It userprop Ta other Ta Allows changing any user property
3007 .It userquota Ta other Ta Allows accessing any userquota@... property
3008 .It userused Ta other Ta Allows reading any userused@... property
3009 .It aclinherit Ta property
3010 .It aclmode Ta property
3011 .It atime Ta property
3012 .It canmount Ta property
3013 .It casesensitivity Ta property
3014 .It checksum Ta property
3015 .It compression Ta property
3016 .It copies Ta property
3017 .It dedup Ta property
3018 .It devices Ta property
3019 .It exec Ta property
3020 .It filesystem_limit Ta property
3021 .It logbias Ta property
3022 .It jailed Ta property
3023 .It mlslabel Ta property
3024 .It mountpoint Ta property
3025 .It nbmand Ta property
3026 .It normalization Ta property
3027 .It primarycache Ta property
3028 .It quota Ta property
3029 .It readonly Ta property
3030 .It recordsize Ta property
3031 .It refquota Ta property
3032 .It refreservation Ta property
3033 .It reservation Ta property
3034 .It secondarycache Ta property
3035 .It setuid Ta property
3036 .It sharenfs Ta property
3037 .It sharesmb Ta property
3038 .It snapdir Ta property
3039 .It snapshot_limit Ta property
3040 .It sync Ta property
3041 .It utf8only Ta property
3042 .It version Ta property
3043 .It volblocksize Ta property
3044 .It volsize Ta property
3045 .It vscan Ta property
3046 .It xattr Ta property
3052 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
3054 .Ar filesystem Ns | Ns Ar volume
3057 Sets "create time" permissions. These permissions are granted (locally) to the
3058 creator of any newly-created descendent file system.
3064 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
3066 .Ar filesystem Ns | Ns Ar volume
3069 Defines or adds permissions to a permission set. The set can be used by other
3071 commands for the specified file system and its descendents. Sets are evaluated
3072 dynamically, so changes to a set are immediately reflected. Permission sets
3073 follow the same naming restrictions as ZFS file systems, but the name must
3074 begin with an "at sign"
3076 and can be no more than 64 characters long.
3081 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
3082 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
3084 .Ar filesystem Ns | Ns Ar volume
3090 .Fl e Ns | Ns Cm everyone
3091 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
3093 .Ar filesystem Ns | Ns Ar volume
3100 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
3102 .Ar filesystem Ns | Ns Ar volume
3105 Removes permissions that were granted with the
3107 command. No permissions are explicitly denied, so other permissions granted are
3108 still in effect. For example, if the permission is granted by an ancestor. If
3109 no permissions are specified, then all permissions for the specified
3110 .Ar user , group , No or everyone
3111 are removed. Specifying
3113 .Po or using the Fl e
3115 .Pc only removes the permissions that were granted to everyone ,
3116 not all permissions for every user and group. See the
3118 command for a description of the
3121 .Bl -tag -width indent
3123 Recursively remove the permissions from this file system and all descendents.
3131 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
3133 .Ar filesystem Ns | Ns Ar volume
3136 Removes permissions from a permission set. If no permissions are specified,
3137 then all permissions are removed, thus removing the set entirely.
3142 .Ar tag snapshot Ns ...
3145 Adds a single reference, named with the
3147 argument, to the specified snapshot or snapshots. Each snapshot has its own tag
3148 namespace, and tags must be unique within that space.
3150 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
3154 .Bl -tag -width indent
3156 Specifies that a hold with the given tag is applied recursively to the
3157 snapshots of all descendent file systems.
3166 Lists all existing user references for the given snapshot or snapshots.
3167 .Bl -tag -width indent
3169 Lists the holds that are set on the named descendent snapshots, in addition to
3170 listing the holds on the named snapshot.
3176 .Ar tag snapshot Ns ...
3179 Removes a single reference, named with the
3181 argument, from the specified snapshot or snapshots. The tag must already exist
3183 .Bl -tag -width indent
3185 Recursively releases a hold with the given tag on the snapshots of all
3186 descendent file systems.
3193 .Op Ar snapshot Ns | Ns Ar filesystem
3196 Display the difference between a snapshot of a given filesystem and another
3197 snapshot of that filesystem from a later time or the current contents of the
3198 filesystem. The first column is a character indicating the type of change,
3199 the other columns indicate pathname, new pathname
3200 .Pq in case of rename ,
3201 change in link count, and optionally file type and/or change time.
3203 The types of change are:
3204 .Bl -column -offset 2n indent
3205 .It \&- Ta path was removed
3206 .It \&+ Ta path was added
3207 .It \&M Ta path was modified
3208 .It \&R Ta path was renamed
3210 .Bl -tag -width indent
3212 Display an indication of the type of file, in a manner similar to the
3216 .Bl -column -offset 2n indent
3217 .It \&B Ta block device
3218 .It \&C Ta character device
3219 .It \&F Ta regular file
3220 .It \&/ Ta directory
3221 .It \&@ Ta symbolic link
3223 .It \&> Ta door (not supported on Fx )
3224 .It \&| Ta named pipe (not supported on Fx )
3225 .It \&P Ta event port (not supported on Fx )
3228 Give more parsable tab-separated output, without header lines and without
3231 Display the path's inode change time as the first column of output.
3236 .Ar jailid filesystem
3239 Attaches the specified
3241 to the jail identified by JID
3243 From now on this file system tree can be managed from within a jail if the
3245 property has been set. To use this functionality, the jail needs the
3249 parameters set to 1 and the
3251 parameter set to a value lower than 2.
3255 for more information on managing jails and configuring the parameters above.
3259 .Ar jailid filesystem
3262 Detaches the specified
3264 from the jail identified by JID
3268 The following exit values are returned:
3269 .Bl -tag -offset 2n -width 2n
3271 Successful completion.
3275 Invalid command line options were specified.
3279 .It Sy Example 1 No Creating a Tn ZFS No File System Hierarchy
3281 The following commands create a file system named
3283 and a file system named
3287 is set for the parent file system, and is automatically inherited by the child
3289 .Bd -literal -offset 2n
3290 .Li # Ic zfs create pool/home
3291 .Li # Ic zfs set mountpoint=/home pool/home
3292 .Li # Ic zfs create pool/home/bob
3294 .It Sy Example 2 No Creating a Tn ZFS No Snapshot
3296 The following command creates a snapshot named
3298 This snapshot is mounted on demand in the
3300 directory at the root of the
3303 .Bd -literal -offset 2n
3304 .Li # Ic zfs snapshot pool/home/bob@yesterday
3306 .It Sy Example 3 No Creating and Destroying Multiple Snapshots
3308 The following command creates snapshots named
3312 and all of its descendent file systems. Each snapshot is mounted on demand in
3315 directory at the root of its file system. The second command destroys the newly
3317 .Bd -literal -offset 2n
3318 .Li # Ic zfs snapshot -r pool/home@yesterday
3319 .Li # Ic zfs destroy -r pool/home@yesterday
3321 .It Sy Example 4 No Disabling and Enabling File System Compression
3323 The following command disables the
3325 property for all file systems under
3327 The next command explicitly enables
3330 .Em pool/home/anne .
3331 .Bd -literal -offset 2n
3332 .Li # Ic zfs set compression=off pool/home
3333 .Li # Ic zfs set compression=on pool/home/anne
3335 .It Sy Example 5 No Listing Tn ZFS No Datasets
3337 The following command lists all active file systems and volumes in the system.
3338 Snapshots are displayed if the
3346 for more information on pool properties.
3347 .Bd -literal -offset 2n
3349 NAME USED AVAIL REFER MOUNTPOINT
3350 pool 450K 457G 18K /pool
3351 pool/home 315K 457G 21K /home
3352 pool/home/anne 18K 457G 18K /home/anne
3353 pool/home/bob 276K 457G 276K /home/bob
3355 .It Sy Example 6 No Setting a Quota on a Tn ZFS No File System
3357 The following command sets a quota of 50 Gbytes for
3359 .Bd -literal -offset 2n
3360 .Li # Ic zfs set quota=50G pool/home/bob
3362 .It Sy Example 7 No Listing Tn ZFS No Properties
3364 The following command lists all properties for
3366 .Bd -literal -offset 2n
3367 .Li # Ic zfs get all pool/home/bob
3368 NAME PROPERTY VALUE SOURCE
3369 pool/home/bob type filesystem -
3370 pool/home/bob creation Tue Jul 21 15:53 2009 -
3371 pool/home/bob used 21K -
3372 pool/home/bob available 20.0G -
3373 pool/home/bob referenced 21K -
3374 pool/home/bob compressratio 1.00x -
3375 pool/home/bob mounted yes -
3376 pool/home/bob quota 20G local
3377 pool/home/bob reservation none default
3378 pool/home/bob recordsize 128K default
3379 pool/home/bob mountpoint /home/bob default
3380 pool/home/bob sharenfs off default
3381 pool/home/bob checksum on default
3382 pool/home/bob compression on local
3383 pool/home/bob atime on default
3384 pool/home/bob devices on default
3385 pool/home/bob exec on default
3386 pool/home/bob filesystem_limit none default
3387 pool/home/bob setuid on default
3388 pool/home/bob readonly off default
3389 pool/home/bob jailed off default
3390 pool/home/bob snapdir hidden default
3391 pool/home/bob snapshot_limit none default
3392 pool/home/bob aclmode discard default
3393 pool/home/bob aclinherit restricted default
3394 pool/home/bob canmount on default
3395 pool/home/bob xattr on default
3396 pool/home/bob copies 1 default
3397 pool/home/bob version 5 -
3398 pool/home/bob utf8only off -
3399 pool/home/bob normalization none -
3400 pool/home/bob casesensitivity sensitive -
3401 pool/home/bob vscan off default
3402 pool/home/bob nbmand off default
3403 pool/home/bob sharesmb off default
3404 pool/home/bob refquota none default
3405 pool/home/bob refreservation none default
3406 pool/home/bob primarycache all default
3407 pool/home/bob secondarycache all default
3408 pool/home/bob usedbysnapshots 0 -
3409 pool/home/bob usedbydataset 21K -
3410 pool/home/bob usedbychildren 0 -
3411 pool/home/bob usedbyrefreservation 0 -
3412 pool/home/bob logbias latency default
3413 pool/home/bob dedup off default
3414 pool/home/bob mlslabel -
3415 pool/home/bob sync standard default
3416 pool/home/bob refcompressratio 1.00x -
3419 The following command gets a single property value.
3420 .Bd -literal -offset 2n
3421 .Li # Ic zfs get -H -o value compression pool/home/bob
3425 The following command lists all properties with local settings for
3427 .Bd -literal -offset 2n
3428 .Li # Ic zfs get -s local -o name,property,value all pool/home/bob
3430 pool/home/bob quota 20G
3431 pool/home/bob compression on
3433 .It Sy Example 8 No Rolling Back a Tn ZFS No File System
3435 The following command reverts the contents of
3437 to the snapshot named
3439 deleting all intermediate snapshots.
3440 .Bd -literal -offset 2n
3441 .Li # Ic zfs rollback -r pool/home/anne@yesterday
3443 .It Sy Example 9 No Creating a Tn ZFS No Clone
3445 The following command creates a writable file system whose initial contents are
3447 .Em pool/home/bob@yesterday .
3448 .Bd -literal -offset 2n
3449 .Li # Ic zfs clone pool/home/bob@yesterday pool/clone
3451 .It Sy Example 10 No Promoting a Tn ZFS No Clone
3453 The following commands illustrate how to test out changes to a file system, and
3454 then replace the original file system with the changed one, using clones, clone
3455 promotion, and renaming:
3456 .Bd -literal -offset 2n
3457 .Li # Ic zfs create pool/project/production
3461 .Pa /pool/project/production
3462 with data and continue with the following commands:
3463 .Bd -literal -offset 2n
3464 .Li # Ic zfs snapshot pool/project/production@today
3465 .Li # Ic zfs clone pool/project/production@today pool/project/beta
3469 .Pa /pool/project/beta
3470 and continue with the following commands:
3471 .Bd -literal -offset 2n
3472 .Li # Ic zfs promote pool/project/beta
3473 .Li # Ic zfs rename pool/project/production pool/project/legacy
3474 .Li # Ic zfs rename pool/project/beta pool/project/production
3477 Once the legacy version is no longer needed, it can be destroyed.
3478 .Bd -literal -offset 2n
3479 .Li # Ic zfs destroy pool/project/legacy
3481 .It Sy Example 11 No Inheriting Tn ZFS No Properties
3483 The following command causes
3489 property from their parent.
3490 .Bd -literal -offset 2n
3491 .Li # Ic zfs inherit checksum pool/home/bob pool/home/anne
3493 .It Sy Example 12 No Remotely Replicating Tn ZFS No Data
3495 The following commands send a full stream and then an incremental stream to a
3496 remote machine, restoring them into
3497 .Sy poolB/received/fs@a
3499 .Sy poolB/received/fs@b ,
3502 must contain the file system
3503 .Sy poolB/received ,
3504 and must not initially contain
3505 .Sy poolB/received/fs .
3506 .Bd -literal -offset 2n
3507 .Li # Ic zfs send pool/fs@a | ssh host zfs receive poolB/received/fs@a
3508 .Li # Ic zfs send -i a pool/fs@b | ssh host zfs receive poolB/received/fs
3517 The following command sends a full stream of
3518 .Sy poolA/fsA/fsB@snap
3519 to a remote machine, receiving it into
3520 .Sy poolB/received/fsA/fsB@snap .
3523 portion of the received snapshot's name is determined from the name of the sent
3526 must contain the file system
3527 .Sy poolB/received .
3529 .Sy poolB/received/fsA
3530 does not exist, it is created as an empty file system.
3531 .Bd -literal -offset 2n
3532 .Li # Ic zfs send poolA/fsA/fsB@snap | ssh host zfs receive -d poolB/received
3534 .It Sy Example 14 No Setting User Properties
3536 The following example sets the user-defined
3537 .Sy com.example:department
3538 property for a dataset.
3539 .Bd -literal -offset 2n
3540 .Li # Ic zfs set com.example:department=12345 tank/accounting
3542 .It Sy Example 15 No Performing a Rolling Snapshot
3544 The following example shows how to maintain a history of snapshots with a
3545 consistent naming scheme. To keep a week's worth of snapshots, the user
3546 destroys the oldest snapshot, renames the remaining snapshots, and then creates
3547 a new snapshot, as follows:
3548 .Bd -literal -offset 2n
3549 .Li # Ic zfs destroy -r pool/users@7daysago
3550 .Li # Ic zfs rename -r pool/users@6daysago @7daysago
3551 .Li # Ic zfs rename -r pool/users@5daysago @6daysago
3552 .Li # Ic zfs rename -r pool/users@4daysago @5daysago
3553 .Li # Ic zfs rename -r pool/users@3daysago @4daysago
3554 .Li # Ic zfs rename -r pool/users@2daysago @3daysago
3555 .Li # Ic zfs rename -r pool/users@yesterday @2daysago
3556 .Li # Ic zfs rename -r pool/users@today @yesterday
3557 .Li # Ic zfs snapshot -r pool/users@today
3563 Property Options on a ZFS File System
3566 The following command shows how to set
3568 property options to enable root access for a specific network on the
3570 file system. The contents of the
3575 .Bd -literal -offset 2n
3576 .Li # Ic zfs set sharenfs="maproot=root,network 192.168.0.0/24" tank/home
3579 Another way to write this command with the same result is:
3580 .Bd -literal -offset 2n
3581 .Li # Ic set zfs sharenfs="-maproot=root -network 192.168.0.0/24" tank/home
3587 Administration Permissions on a
3592 The following example shows how to set permissions so that user
3594 can create, destroy, mount, and take snapshots on
3599 .Bd -literal -offset 2n
3600 .Li # Ic zfs allow cindys create,destroy,mount,snapshot tank/cindys
3601 .Li # Ic zfs allow tank/cindys
3602 ---- Permissions on tank/cindys --------------------------------------
3603 Local+Descendent permissions:
3604 user cindys create,destroy,mount,snapshot
3606 .It Sy Example 18 No Delegating Create Time Permissions on a Tn ZFS No Dataset
3608 The following example shows how to grant anyone in the group
3610 to create file systems in
3612 This syntax also allows staff members to destroy their own file systems, but
3613 not destroy anyone else's file system. The permissions on
3616 .Bd -literal -offset 2n
3617 .Li # Ic zfs allow staff create,mount tank/users
3618 .Li # Ic zfs allow -c destroy tank/users
3619 .Li # Ic zfs allow tank/users
3620 ---- Permissions on tank/users ---------------------------------------
3623 Local+Descendent permissions:
3624 group staff create,mount
3628 Defining and Granting a Permission Set on a
3633 The following example shows how to define and grant a permission set on the
3635 file system. The permissions on
3638 .Bd -literal -offset 2n
3639 .Li # Ic zfs allow -s @pset create,destroy,snapshot,mount tank/users
3640 .Li # Ic zfs allow staff @pset tank/users
3641 .Li # Ic zfs allow tank/users
3642 ---- Permissions on tank/users ---------------------------------------
3644 @pset create,destroy,mount,snapshot
3645 Local+Descendent permissions:
3648 .It Sy Example 20 No Delegating Property Permissions on a Tn ZFS No Dataset
3650 The following example shows to grant the ability to set quotas and reservations
3653 file system. The permissions on
3656 .Bd -literal -offset 2n
3657 .Li # Ic zfs allow cindys quota,reservation users/home
3658 .Li # Ic zfs allow users/home
3659 ---- Permissions on users/home ---------------------------------------
3660 Local+Descendent permissions:
3661 user cindys quota,reservation
3662 .Li # Ic su - cindys
3663 .Li cindys% Ic zfs set quota=10G users/home/marks
3664 .Li cindys% Ic zfs get quota users/home/marks
3665 NAME PROPERTY VALUE SOURCE
3666 users/home/marks quota 10G local
3668 .It Sy Example 21 No Removing ZFS Delegated Permissions on a Tn ZFS No Dataset
3670 The following example shows how to remove the snapshot permission from the
3674 file system. The permissions on
3677 .Bd -literal -offset 2n
3678 .Li # Ic zfs unallow staff snapshot tank/users
3679 .Li # Ic zfs allow tank/users
3680 ---- Permissions on tank/users ---------------------------------------
3682 @pset create,destroy,mount,snapshot
3683 Local+Descendent permissions:
3686 .It Sy Example 22 Showing the differences between a snapshot and a ZFS Dataset
3688 The following example shows how to see what has changed between a prior
3689 snapshot of a ZFS Dataset and its current state. The
3691 option is used to indicate type information for the files affected.
3692 .Bd -literal -offset 2n
3693 .Li # Ic zfs diff tank/test@before tank/test
3695 M F /tank/test/linked (+1)
3696 R F /tank/test/oldname -> /tank/test/newname
3697 - F /tank/test/deleted
3698 + F /tank/test/created
3699 M F /tank/test/modified
3713 This manual page is a
3715 reimplementation of the
3719 modified and customized for
3721 and licensed under the
3722 Common Development and Distribution License
3727 implementation of this manual page was initially written by
3728 .An Martin Matuska Aq mm@FreeBSD.org .
projects / FreeBSD / releng / 10.3.git / blob