4 .\" The contents of this file are subject to the terms of the
5 .\" Common Development and Distribution License (the "License").
6 .\" You may not use this file except in compliance with the License.
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 .\" or http://www.opensolaris.org/os/licensing.
10 .\" See the License for the specific language governing permissions
11 .\" and limitations under the License.
13 .\" When distributing Covered Code, include this CDDL HEADER in each
14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 .\" If applicable, add the following below this CDDL HEADER, with the
16 .\" fields enclosed by brackets "[]" replaced with your own identifying
17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
22 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
23 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
24 .\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
25 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
26 .\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
27 .\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
28 .\" Copyright (c) 2014 Integros [integros.com]
29 .\" Copyright 2016 Richard Laager. All rights reserved.
30 .\" Copyright 2018 Nexenta Systems, Inc.
31 .\" Copyright 2018 Joyent, Inc.
38 .Nd configures ZFS file systems
45 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
51 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
52 .Fl V Ar size Ar volume
56 .Ar filesystem Ns | Ns Ar volume
60 .Ar filesystem Ns | Ns Ar volume Ns @ Ns Ar snap Ns
61 .Oo % Ns Ar snap Ns Oo , Ns Ar snap Ns Oo % Ns Ar snap Oc Oc Oc Ns ...
64 .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
68 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
69 .Ar filesystem Ns @ Ns Ar snapname Ns | Ns Ar volume Ns @ Ns Ar snapname Ns ...
77 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
78 .Ar snapshot Ar filesystem Ns | Ns Ar volume
85 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
86 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
90 .Ar filesystem Ns | Ns Ar volume
91 .Ar filesystem Ns | Ns Ar volume
95 .Ar snapshot Ar snapshot
98 .Op Fl r Ns | Ns Fl d Ar depth
100 .Oo Fl o Ar property Ns Oo , Ns Ar property Oc Ns ... Oc
101 .Oo Fl s Ar property Oc Ns ...
102 .Oo Fl S Ar property Oc Ns ...
103 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
104 .Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Oc Ns ...
107 .Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ...
108 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
111 .Op Fl r Ns | Ns Fl d Ar depth
113 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
114 .Oo Fl s Ar source Ns Oo , Ns Ar source Oc Ns ... Oc
115 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
116 .Cm all | Ar property Ns Oo , Ns Ar property Oc Ns ...
117 .Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Oc Ns ...
121 .Ar property Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
131 .Fl a | Ar filesystem
135 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
136 .Oo Fl s Ar field Oc Ns ...
137 .Oo Fl S Ar field Oc Ns ...
138 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
139 .Ar filesystem Ns | Ns Ar snapshot
143 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
144 .Oo Fl s Ar field Oc Ns ...
145 .Oo Fl S Ar field Oc Ns ...
146 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
147 .Ar filesystem Ns | Ns Ar snapshot
151 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
152 .Oo Fl s Ar field Oc Ns ...
153 .Oo Fl S Ar field Oc Ns ...
154 .Ar filesystem Ns | Ns Ar snapshot
157 .Oo Fl d Ns | Ns Fl r Ns Oc
158 .Ar file Ns | Ns Ar directory Ns ...
163 .Ar file Ns | Ns Ar directory Ns ...
168 .Oo Fl d Ns | Ns Fl r Ns Oc
170 .Ar file Ns | Ns Ar directory Ns ...
175 .Ar file Ns | Ns Ar directory Ns ...
182 .Fl a | Ar filesystem
186 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
189 .Fl a | Ar filesystem
192 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
195 .Ar snapshot bookmark
199 .Op Oo Fl I Ns | Ns Fl i Oc Ar snapshot
204 .Op Fl i Ar snapshot Ns | Ns Ar bookmark
205 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
209 .Fl t Ar receive_resume_token
213 .Op Fl o Sy origin Ns = Ns Ar snapshot
214 .Op Fl o Ar property Ns = Ns Ar value
216 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
220 .Op Fl d Ns | Ns Fl e
221 .Op Fl o Sy origin Ns = Ns Ar snapshot
222 .Op Fl o Ar property Ns = Ns Ar value
228 .Ar filesystem Ns | Ns Ar volume
231 .Ar filesystem Ns | Ns Ar volume
235 .Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
236 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
237 .Ar setname Oc Ns ...
238 .Ar filesystem Ns | Ns Ar volume
242 .Fl e Ns | Ns Sy everyone
243 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
244 .Ar setname Oc Ns ...
245 .Ar filesystem Ns | Ns Ar volume
249 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
250 .Ar setname Oc Ns ...
251 .Ar filesystem Ns | Ns Ar volume
254 .Fl s No @ Ns Ar setname
255 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
256 .Ar setname Oc Ns ...
257 .Ar filesystem Ns | Ns Ar volume
261 .Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
262 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
263 .Ar setname Oc Ns ... Oc
264 .Ar filesystem Ns | Ns Ar volume
268 .Fl e Ns | Ns Sy everyone
269 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
270 .Ar setname Oc Ns ... Oc
271 .Ar filesystem Ns | Ns Ar volume
276 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
277 .Ar setname Oc Ns ... Oc
278 .Ar filesystem Ns | Ns Ar volume
282 .Fl s @ Ns Ar setname
283 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
284 .Ar setname Oc Ns ... Oc
285 .Ar filesystem Ns | Ns Ar volume
289 .Ar tag Ar snapshot Ns ...
297 .Ar tag Ar snapshot Ns ...
301 .Ar snapshot Ar snapshot Ns | Ns Ar filesystem
305 .Op Fl t Ar instruction-limit
306 .Op Fl m Ar memory-limit
312 .Op Fl L Ar keylocation
313 .Fl a | Ar filesystem
317 .Fl a | Ar filesystem
321 .Op Fl o Ar keylocation Ns = Ns Ar value
322 .Op Fl o Ar keyformat Ns = Ns Ar value
323 .Op Fl o Ar pbkdf2iters Ns = Ns Ar value
333 command configures ZFS datasets within a ZFS storage pool, as described in
335 A dataset is identified by a unique path within the ZFS namespace.
338 pool/{filesystem,volume,snapshot}
341 where the maximum length of a dataset name is
344 and the maximum amount of nesting allowed in a path is 50 levels deep.
346 A dataset can be one of the following:
347 .Bl -tag -width "file system"
349 A ZFS dataset of type
351 can be mounted within the standard system namespace and behaves like other file
353 While ZFS file systems are designed to be POSIX compliant, known issues exist
354 that prevent compliance in some cases.
355 Applications that depend on standards conformance might fail due to non-standard
356 behavior when checking file system free space.
358 A logical volume exported as a raw or block device.
359 This type of dataset should only be used under special circumstances.
360 File systems are typically used in most environments.
362 A read-only version of a file system or volume at a given point in time.
364 .Ar filesystem Ns @ Ns Ar name
366 .Ar volume Ns @ Ns Ar name .
370 but without the hold on on-disk data. It can be used as the source of a send
371 (but not for a receive). It is specified as
372 .Ar filesystem Ns # Ns Ar name
374 .Ar volume Ns # Ns Ar name .
376 .Ss ZFS File System Hierarchy
377 A ZFS storage pool is a logical collection of devices that provide space for
379 A storage pool is also the root of the ZFS file system hierarchy.
381 The root of the pool can be accessed as a file system, such as mounting and
382 unmounting, taking snapshots, and setting properties.
383 The physical storage characteristics, however, are managed by the
389 for more information on creating and administering pools.
391 A snapshot is a read-only copy of a file system or volume.
392 Snapshots can be created extremely quickly, and initially consume no additional
393 space within the pool.
394 As data within the active dataset changes, the snapshot consumes more data than
395 would otherwise be shared with the active dataset.
397 Snapshots can have arbitrary names.
398 Snapshots of volumes can be cloned or rolled back, visibility is determined
401 property of the parent volume.
403 File system snapshots can be accessed under the
405 directory in the root of the file system.
406 Snapshots are automatically mounted on demand and may be unmounted at regular
408 The visibility of the
410 directory can be controlled by the
414 A bookmark is like a snapshot, a read-only copy of a file system or volume.
415 Bookmarks can be created extremely quickly, compared to snapshots, and they
416 consume no additional space within the pool. Bookmarks can also have arbitrary
417 names, much like snapshots.
419 Unlike snapshots, bookmarks can not be accessed through the filesystem in any
420 way. From a storage standpoint a bookmark just provides a way to reference
421 when a snapshot was created as a distinct object. Bookmarks are initially
422 tied to a snapshot, not the filesystem or volume, and they will survive if the
423 snapshot itself is destroyed. Since they are very light weight there's little
424 incentive to destroy them.
426 A clone is a writable volume or file system whose initial contents are the same
428 As with snapshots, creating a clone is nearly instantaneous, and initially
429 consumes no additional space.
431 Clones can only be created from a snapshot.
432 When a snapshot is cloned, it creates an implicit dependency between the parent
434 Even though the clone is created somewhere else in the dataset hierarchy, the
435 original snapshot cannot be destroyed as long as a clone exists.
438 property exposes this dependency, and the
440 command lists any such dependencies, if they exist.
442 The clone parent-child dependency relationship can be reversed by using the
447 file system to become a clone of the specified file system, which makes it
448 possible to destroy the file system that the clone was created from.
450 Creating a ZFS file system is a simple operation, so the number of file systems
451 per system is likely to be numerous.
452 To cope with this, ZFS automatically manages mounting and unmounting file
453 systems without the need to edit the
456 All automatically managed file systems are mounted by ZFS at boot time.
458 By default, file systems are mounted under
462 is the name of the file system in the ZFS namespace.
463 Directories are created and destroyed as needed.
465 A file system can also have a mount point set in the
468 This directory is created as needed, and ZFS automatically mounts the file
470 .Nm zfs Cm mount Fl a
477 property can be inherited, so if
483 automatically inherits a mount point of
484 .Pa /export/stuff/user .
490 prevents the file system from being mounted.
492 If needed, ZFS file systems can also be managed with traditional tools
498 If a file system's mount point is set to
500 ZFS makes no attempt to manage the file system, and the administrator is
501 responsible for mounting and unmounting the file system. Because pools must
502 be imported before a legacy mount can succeed, administrators should ensure
503 that legacy mounts are only attempted after the zpool import process
504 finishes at boot time. For example, on machines using systemd, the mount
507 .Nm x-systemd.requires=zfs-import.target
509 will ensure that the zfs-import completes before systemd attempts mounting
510 the filesystem. See systemd.mount(5) for details.
512 Deduplication is the process for removing redundant data at the block level,
513 reducing the total amount of data stored. If a file system has the
515 property enabled, duplicate data blocks are removed synchronously. The result
516 is that only unique data is stored and common components are shared among files.
518 Deduplicating data is a very resource-intensive operation. It is generally
519 recommended that you have at least 1.25 GiB of RAM per 1 TiB of storage when
520 you enable deduplication. Calculating the exact requirement depends heavily
521 on the type of data stored in the pool.
523 Enabling deduplication on an improperly-designed system can result in
524 performance issues (slow IO and administrative operations). It can potentially
525 lead to problems importing a pool due to memory exhaustion. Deduplication
526 can consume significant processing power (CPU) and memory as well as generate
529 Before creating a pool with deduplication enabled, ensure that you have planned
530 your hardware requirements appropriately and implemented appropriate recovery
531 practices, such as regular backups. As an alternative to deduplication
534 as a less resource-intensive alternative.
535 .Ss Native Properties
536 Properties are divided into two types, native properties and user-defined
541 Native properties either export internal statistics or control ZFS behavior.
542 In addition, native properties are either editable or read-only.
543 User properties have no effect on ZFS behavior, but you can use them to annotate
544 datasets in a way that is meaningful in your environment.
545 For more information about user properties, see the
549 Every dataset has a set of properties that export statistics about the dataset
550 as well as control various behaviors.
551 Properties are inherited from the parent unless overridden by the child.
552 Some properties apply only to certain types of datasets
553 .Pq file systems, volumes, or snapshots .
555 The values of numeric properties can be specified using human-readable suffixes
565 The following are all valid
568 .Li 1536M, 1.5g, 1.50GB .
570 The values of non-numeric properties are case sensitive and must be lowercase,
577 The following native properties consist of read-only statistics about the
579 These properties can be neither set, nor inherited.
580 Native properties apply to all dataset types unless otherwise noted.
581 .Bl -tag -width "usedbyrefreservation"
583 The amount of space available to the dataset and all its children, assuming that
584 there is no other activity in the pool.
585 Because space is shared within a pool, availability can be limited by any number
586 of factors, including physical pool size, quotas, reservations, or other
587 datasets within the pool.
589 This property can also be referred to by its shortened column name,
592 For non-snapshots, the compression ratio achieved for the
594 space of this dataset, expressed as a multiplier.
597 property includes descendant datasets, and, for clones, does not include the
598 space shared with the origin snapshot.
604 Compression can be turned on by running:
605 .Nm zfs Cm set Sy compression Ns = Ns Sy on Ar dataset .
609 The transaction group (txg) in which the dataset was created. Bookmarks have
612 as the snapshot they are initially tied to. This property is suitable for
613 ordering a list of snapshots, e.g. for incremental send and receive.
615 The time this dataset was created.
617 For snapshots, this property is a comma-separated list of filesystems or volumes
618 which are clones of this snapshot.
621 property is this snapshot.
624 property is not empty, then this snapshot can not be destroyed
631 The roles of origin and clone can be swapped by promoting the clone with the
637 if the snapshot has been marked for deferred destroy by using the
638 .Nm zfs Cm destroy Fl d
640 Otherwise, the property is
642 .It Sy encryptionroot
643 For encrypted datasets, indicates where the dataset is currently inheriting its
644 encryption key from. Loading or unloading a key for the
646 will implicitly load / unload the key for any inheriting datasets (see
649 .Nm zfs Cm unload-key
651 Clones will always share an
652 encryption key with their origin. See the
655 .It Sy filesystem_count
656 The total number of filesystems and volumes that exist under this location in
658 This value is only available when a
660 has been set somewhere in the tree under which the dataset resides.
662 Indicates if an encryption key is currently loaded into ZFS. The possible
671 .Nm zfs Cm unload-key .
673 The 64 bit GUID of this dataset or bookmark which does not change over its
674 entire lifetime. When a snapshot is sent to another pool, the received
675 snapshot has the same GUID. Thus, the
677 is suitable to identify a snapshot across pools.
678 .It Sy logicalreferenced
679 The amount of space that is
681 accessible by this dataset.
685 The logical space ignores the effect of the
689 properties, giving a quantity closer to the amount of data that applications
691 However, it does include space consumed by metadata.
693 This property can also be referred to by its shortened column name,
696 The amount of space that is
698 consumed by this dataset and all its descendents.
702 The logical space ignores the effect of the
706 properties, giving a quantity closer to the amount of data that applications
708 However, it does include space consumed by metadata.
710 This property can also be referred to by its shortened column name,
713 For file systems, indicates whether the file system is currently mounted.
714 This property can be either
719 A unique identifier for this dataset within the pool. Unlike the dataset's
723 of a dataset is not transferred to other pools when the snapshot is copied
724 with a send/receive operation.
727 can be reused (for a new datatset) after the dataset is deleted.
729 For cloned file systems or volumes, the snapshot from which the clone was
734 .It Sy receive_resume_token
735 For filesystems or volumes which have saved partially-completed state from
737 this opaque token can be provided to
739 to resume and complete the
742 The amount of data that is accessible by this dataset, which may or may not be
743 shared with other datasets in the pool.
744 When a snapshot or clone is created, it initially references the same amount of
745 space as the file system or snapshot it was created from, since its contents are
748 This property can also be referred to by its shortened column name,
750 .It Sy refcompressratio
751 The compression ratio achieved for the
753 space of this dataset, expressed as a multiplier.
757 .It Sy snapshot_count
758 The total number of snapshots that exist under this location in the dataset
760 This value is only available when a
762 has been set somewhere in the tree under which the dataset resides.
770 The amount of space consumed by this dataset and all its descendents.
771 This is the value that is checked against this dataset's quota and reservation.
772 The space used does not include this dataset's reservation, but does take into
773 account the reservations of any descendent datasets.
774 The amount of space that a dataset consumes from its parent, as well as the
775 amount of space that is freed if this dataset is recursively destroyed, is the
776 greater of its space used and its reservation.
778 The used space of a snapshot
783 is space that is referenced exclusively by this snapshot.
784 If this snapshot is destroyed, the amount of
787 Space that is shared by multiple snapshots isn't accounted for in this metric.
788 When a snapshot is destroyed, space that was previously shared with this
789 snapshot can become unique to snapshots adjacent to it, thus changing the used
790 space of those snapshots.
791 The used space of the latest snapshot can also be affected by changes in the
795 space of a snapshot is a subset of the
797 space of the snapshot.
799 The amount of space used, available, or referenced does not take into account
801 Pending changes are generally accounted for within a few seconds.
802 Committing a change to a disk using
806 does not necessarily guarantee that the space usage information is updated
811 properties decompose the
813 properties into the various reasons that space is used.
816 .Sy usedbychildren No +
817 .Sy usedbydataset No +
818 .Sy usedbyrefreservation No +
819 .Sy usedbysnapshots .
820 These properties are only available for datasets created on
824 .It Sy usedbychildren
825 The amount of space used by children of this dataset, which would be freed if
826 all the dataset's children were destroyed.
828 The amount of space used by this dataset itself, which would be freed if the
829 dataset were destroyed
830 .Po after first removing any
832 and destroying any necessary snapshots or descendents
834 .It Sy usedbyrefreservation
835 The amount of space used by a
837 set on this dataset, which would be freed if the
840 .It Sy usedbysnapshots
841 The amount of space consumed by snapshots of this dataset.
842 In particular, it is the amount of space that would be freed if all of this
843 dataset's snapshots were destroyed.
844 Note that this is not simply the sum of the snapshots'
846 properties because space can be shared by multiple snapshots.
847 .It Sy userused Ns @ Ns Em user
848 The amount of space consumed by the specified user in this dataset.
849 Space is charged to the owner of each file, as displayed by
851 The amount of space charged is displayed by
857 subcommand for more information.
859 Unprivileged users can access only their own space usage.
860 The root user, or a user who has been granted the
864 can access everyone's usage.
867 .Sy userused Ns @ Ns Em ...
868 properties are not displayed by
869 .Nm zfs Cm get Sy all .
870 The user's name must be appended after the @ symbol, using one of the following
872 .Bl -bullet -width ""
886 .Sy joe.smith@mydomain
895 Files created on Linux always have POSIX owners.
896 .It Sy userobjused Ns @ Ns Em user
899 property is similar to
901 but instead it counts the number of objects consumed by a user. This property
902 counts all objects allocated on behalf of the user, it may differ from the
903 results of system tools such as
908 is set on a file system additional objects will be created per-file to store
909 extended attributes. These additional objects are reflected in the
911 value and are counted against the user's
913 When a file system is configured to use
915 no additional internal objects are normally required.
917 This property is set to the number of user holds on this snapshot.
918 User holds are set by using the
921 .It Sy groupused Ns @ Ns Em group
922 The amount of space consumed by the specified group in this dataset.
923 Space is charged to the group of each file, as displayed by
926 .Sy userused Ns @ Ns Em user
927 property for more information.
929 Unprivileged users can only access their own groups' space usage.
930 The root user, or a user who has been granted the
934 can access all groups' usage.
935 .It Sy groupobjused Ns @ Ns Em group
936 The number of objects consumed by the specified group in this dataset.
937 Multiple objects may be charged to the group for each file when extended
938 attributes are in use. See the
939 .Sy userobjused Ns @ Ns Em user
940 property for more information.
942 Unprivileged users can only access their own groups' space usage.
943 The root user, or a user who has been granted the
947 can access all groups' usage.
948 .It Sy projectused Ns @ Ns Em project
949 The amount of space consumed by the specified project in this dataset. Project
950 is identified via the project identifier (ID) that is object-based numeral
951 attribute. An object can inherit the project ID from its parent object (if the
952 parent has the flag of inherit project ID that can be set and changed via
955 .Nm zfs project Fl s )
956 when being created. The privileged user can set and change object's project
961 anytime. Space is charged to the project of each file, as displayed by
966 .Sy userused Ns @ Ns Em user
967 property for more information.
969 The root user, or a user who has been granted the
973 can access all projects' usage.
974 .It Sy projectobjused Ns @ Ns Em project
979 but instead it counts the number of objects consumed by project. When the
982 is set on a fileset, ZFS will create additional objects per-file to store
983 extended attributes. These additional objects are reflected in the
985 value and are counted against the project's
986 .Sy projectobjquota .
987 When a filesystem is configured to use
989 no additional internal objects are required. See the
990 .Sy userobjused Ns @ Ns Em user
991 property for more information.
993 The root user, or a user who has been granted the
997 can access all projects' objects usage.
999 For volumes, specifies the block size of the volume.
1002 cannot be changed once the volume has been written, so it should be set at
1003 volume creation time.
1006 for volumes is 8 Kbytes.
1007 Any power of 2 from 512 bytes to 128 Kbytes is valid.
1009 This property can also be referred to by its shortened column name,
1014 by this dataset, that was written since the previous snapshot
1015 .Pq i.e. that is not referenced by the previous snapshot .
1016 .It Sy written Ns @ Ns Em snapshot
1019 space written to this dataset since the specified snapshot.
1020 This is the space that is referenced by this dataset but was not referenced by
1021 the specified snapshot.
1025 may be specified as a short snapshot name
1026 .Po just the part after the
1029 in which case it will be interpreted as a snapshot in the same filesystem as
1033 may be a full snapshot name
1034 .Po Em filesystem Ns @ Ns Em snapshot Pc ,
1035 which for clones may be a snapshot in the origin's filesystem
1036 .Pq or the origin of the origin's filesystem, etc.
1039 The following native properties can be used to change the behavior of a ZFS
1043 .Sy aclinherit Ns = Ns Sy discard Ns | Ns Sy noallow Ns | Ns
1044 .Sy restricted Ns | Ns Sy passthrough Ns | Ns Sy passthrough-x
1046 Controls how ACEs are inherited when files and directories are created.
1047 .Bl -tag -width "passthrough-x"
1049 does not inherit any ACEs.
1051 only inherits inheritable ACEs that specify
1055 default, removes the
1059 permissions when the ACE is inherited.
1061 inherits all inheritable ACEs without any modifications.
1062 .It Sy passthrough-x
1070 ACEs inherit the execute permission only if the file creation mode also requests
1074 When the property value is set to
1076 files are created with a mode determined by the inheritable ACEs.
1077 If no inheritable ACEs exist that affect the mode, then the mode is set in
1078 accordance to the requested mode from the application.
1082 property does not apply to POSIX ACLs.
1083 .It Sy acltype Ns = Ns Sy off Ns | Ns Sy noacl Ns | Ns Sy posixacl
1084 Controls whether ACLs are enabled and if so what type of ACL to use.
1085 .Bl -tag -width "posixacl"
1087 default, when a file system has the
1089 property set to off then ACLs are disabled.
1094 indicates POSIX ACLs should be used. POSIX ACLs are specific to Linux and are
1095 not functional on other platforms. POSIX ACLs are stored as an extended
1096 attribute and therefore will not overwrite any existing NFSv4 ACLs which
1100 To obtain the best performance when setting
1102 users are strongly encouraged to set the
1104 property. This will result in the POSIX ACL being stored more efficiently on
1105 disk. But as a consequence, all new extended attributes will only be
1106 accessible from OpenZFS implementations which support the
1110 property for more details.
1111 .It Sy atime Ns = Ns Sy on Ns | Ns Sy off
1112 Controls whether the access time for files is updated when they are read.
1113 Turning this property off avoids producing write traffic when reading files and
1114 can result in significant performance gains, though it might confuse mailers
1115 and other similar utilities. The values
1119 are equivalent to the
1123 mount options. The default value is
1128 .It Sy canmount Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy noauto
1129 If this property is set to
1131 the file system cannot be mounted, and is ignored by
1132 .Nm zfs Cm mount Fl a .
1133 Setting this property to
1135 is similar to setting the
1139 except that the dataset still has a normal
1141 property, which can be inherited.
1142 Setting this property to
1144 allows datasets to be used solely as a mechanism to inherit properties.
1145 One example of setting
1146 .Sy canmount Ns = Ns Sy off
1147 is to have two datasets with the same
1149 so that the children of both datasets appear in the same directory, but might
1150 have different inherited characteristics.
1154 a dataset can only be mounted and unmounted explicitly.
1155 The dataset is not mounted automatically when the dataset is created or
1156 imported, nor is it mounted by the
1157 .Nm zfs Cm mount Fl a
1158 command or unmounted by the
1159 .Nm zfs Cm unmount Fl a
1162 This property is not inherited.
1164 .Sy checksum Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy fletcher2 Ns | Ns
1165 .Sy fletcher4 Ns | Ns Sy sha256 Ns | Ns Sy noparity Ns | Ns
1166 .Sy sha512 Ns | Ns Sy skein Ns | Ns Sy edonr
1168 Controls the checksum used to verify data integrity.
1169 The default value is
1171 which automatically selects an appropriate algorithm
1174 but this may change in future releases
1178 disables integrity checking on user data.
1181 not only disables integrity but also disables maintaining parity for user data.
1182 This setting is used internally by a dump device residing on a RAID-Z pool and
1183 should not be used by any other dataset.
1184 Disabling checksums is
1186 a recommended practice.
1193 checksum algorithms require enabling the appropriate features on the pool.
1194 These algorithms are not supported by GRUB and should not be set on the
1196 filesystem when using GRUB to boot the system.
1198 .Xr zpool-features 5
1199 for more information on these algorithms.
1201 Changing this property affects only newly-written data.
1203 .Sy compression Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy gzip Ns | Ns
1204 .Sy gzip- Ns Em N Ns | Ns Sy lz4 Ns | Ns Sy lzjb Ns | Ns Sy zle
1206 Controls the compression algorithm used for this dataset.
1208 Setting compression to
1210 indicates that the current default compression algorithm should be used.
1211 The default balances compression and decompression speed, with compression ratio
1212 and is expected to work well on a wide variety of workloads.
1213 Unlike all other settings for this property,
1215 does not select a fixed compression type.
1216 As new compression algorithms are added to ZFS and enabled on a pool, the
1217 default compression algorithm may change.
1218 The current default compression algorithm is either
1227 compression algorithm is a high-performance replacement for the
1230 It features significantly faster compression and decompression, as well as a
1231 moderately higher compression ratio than
1233 but can only be used on pools with the
1238 .Xr zpool-features 5
1239 for details on ZFS feature flags and the
1245 compression algorithm is optimized for performance while providing decent data
1250 compression algorithm uses the same compression as the
1255 level by using the value
1259 is an integer from 1
1262 .Pq best compression ratio .
1267 .Po which is also the default for
1273 compression algorithm compresses runs of zeros.
1275 This property can also be referred to by its shortened column name
1277 Changing this property affects only newly-written data.
1279 When any setting except
1281 is selected, compression will explicitly check for blocks consisting of only
1282 zeroes (the NUL byte). When a zero-filled block is detected, it is stored as
1283 a hole and not compressed using the indicated compression algorithm.
1285 Any block being compressed must be no larger than 7/8 of its original size
1286 after compression, otherwise the compression will not be considered worthwhile
1287 and the block saved uncompressed. Note that when the logical block is less than
1288 8 times the disk sector size this effectively reduces the necessary compression
1289 ratio; for example 8k blocks on disks with 4k disk sectors must compress to 1/2
1290 or less of their original size.
1292 .Sy context Ns = Ns Sy none Ns | Ns
1293 .Em SELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level
1295 This flag sets the SELinux context for all files in the file system under
1296 a mount point for that file system. See
1298 for more information.
1300 .Sy fscontext Ns = Ns Sy none Ns | Ns
1301 .Em SELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level
1303 This flag sets the SELinux context for the file system file system being
1306 for more information.
1308 .Sy defcontext Ns = Ns Sy none Ns | Ns
1309 .Em SELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level
1311 This flag sets the SELinux default context for unlabeled files. See
1313 for more information.
1315 .Sy rootcontext Ns = Ns Sy none Ns | Ns
1316 .Em SELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level
1318 This flag sets the SELinux context for the root inode of the file system. See
1320 for more information.
1321 .It Sy copies Ns = Ns Sy 1 Ns | Ns Sy 2 Ns | Ns Sy 3
1322 Controls the number of copies of data stored for this dataset.
1323 These copies are in addition to any redundancy provided by the pool, for
1324 example, mirroring or RAID-Z.
1325 The copies are stored on different disks, if possible.
1326 The space used by multiple copies is charged to the associated file and dataset,
1329 property and counting against quotas and reservations.
1331 Changing this property only affects newly-written data.
1332 Therefore, set this property at file system creation time by using the
1333 .Fl o Sy copies Ns = Ns Ar N
1336 Remember that ZFS will not import a pool with a missing top-level vdev. Do
1338 create, for example a two-disk striped pool and set
1340 on some datasets thinking you have setup redundancy for them. When a disk
1341 fails you will not be able to import the pool and will have lost all of your
1343 .It Sy devices Ns = Ns Sy on Ns | Ns Sy off
1344 Controls whether device nodes can be opened on this file system.
1345 The default value is
1351 are equivalent to the
1357 .Sy dedup Ns = Ns Sy off Ns | Ns Sy on Ns | Ns Sy verify Ns | Ns
1358 .Sy sha256[,verify] Ns | Ns Sy sha512[,verify] Ns | Ns Sy skein[,verify] Ns | Ns
1361 Configures deduplication for a dataset. The default value is
1363 The default deduplication checksum is
1365 (this may change in the future). When
1367 is enabled, the checksum defined here overrides the
1369 property. Setting the value to
1371 has the same effect as the setting
1376 ZFS will do a byte-to-byte comparsion in case of two blocks having the same
1377 signature to make sure the block contents are identical. Specifying
1379 is mandatory for the
1383 Unless necessary, deduplication should NOT be enabled on a system. See
1387 .Sy dnodesize Ns = Ns Sy legacy Ns | Ns Sy auto Ns | Ns Sy 1k Ns | Ns
1388 .Sy 2k Ns | Ns Sy 4k Ns | Ns Sy 8k Ns | Ns Sy 16k
1390 Specifies a compatibility mode or literal value for the size of dnodes in the
1391 file system. The default value is
1393 Setting this property to a value other than
1395 requires the large_dnode pool feature to be enabled.
1401 if the dataset uses the
1403 property setting and the workload makes heavy use of extended attributes. This
1404 may be applicable to SELinux-enabled systems, Lustre servers, and Samba
1405 servers, for example. Literal values are supported for cases where the optimal
1406 size is known in advance and for performance testing.
1412 if you need to receive a send stream of this dataset on a pool that doesn't
1413 enable the large_dnode feature, or if you need to import this pool on a system
1414 that doesn't support the large_dnode feature.
1416 This property can also be referred to by its shortened column name,
1419 .Sy encryption Ns = Ns Sy off Ns | Ns Sy on Ns | Ns Sy aes-128-ccm Ns | Ns
1420 .Sy aes-192-ccm Ns | Ns Sy aes-256-ccm Ns | Ns Sy aes-128-gcm Ns | Ns
1421 .Sy aes-192-gcm Ns | Ns Sy aes-256-gcm
1423 Controls the encryption cipher suite (block cipher, key length, and mode) used
1424 for this dataset. Requires the
1426 feature to be enabled on the pool.
1429 to be set at dataset creation time.
1432 .Sy encryption Ns = Ns Sy on
1433 when creating a dataset indicates that the default encryption suite will be
1434 selected, which is currently
1436 In order to provide consistent data protection, encryption must be specified at
1437 dataset creation time and it cannot be changed afterwards.
1439 For more details and caveats about encryption see the
1442 .It Sy keyformat Ns = Ns Sy raw Ns | Ns Sy hex Ns | Ns Sy passphrase
1443 Controls what format the user's encryption key will be provided as. This
1444 property is only set when the dataset is encrypted.
1446 Raw keys and hex keys must be 32 bytes long (regardless of the chosen
1447 encryption suite) and must be randomly generated. A raw key can be generated
1448 with the following command:
1450 # dd if=/dev/urandom of=/path/to/output/key bs=32 count=1
1453 Passphrases must be between 8 and 512 bytes long and will be processed through
1454 PBKDF2 before being used (see the
1456 property). Even though the
1457 encryption suite cannot be changed after dataset creation, the keyformat can be
1459 .Nm zfs Cm change-key .
1461 .Sy keylocation Ns = Ns Sy prompt Ns | Ns Sy file:// Ns Em </absolute/file/path>
1463 Controls where the user's encryption key will be loaded from by default for
1467 .Nm zfs Cm mount Cm -l .
1468 This property is only set for encrypted datasets which are encryption roots. If
1469 unspecified, the default is
1472 Even though the encryption suite cannot be changed after dataset creation, the
1473 keylocation can be with either
1476 .Nm zfs Cm change-key .
1479 is selected ZFS will ask for the key at the command prompt when it is required
1480 to access the encrypted data (see
1482 for details). This setting will also allow the key to be passed in via STDIN,
1483 but users should be careful not to place keys which should be kept secret on
1484 the command line. If a file URI is selected, the key will be loaded from the
1485 specified absolute file path.
1486 .It Sy pbkdf2iters Ns = Ns Ar iterations
1487 Controls the number of PBKDF2 iterations that a
1489 encryption key should be run through when processing it into an encryption key.
1490 This property is only defined when encryption is enabled and a keyformat of
1492 is selected. The goal of PBKDF2 is to significantly increase the
1493 computational difficulty needed to brute force a user's passphrase. This is
1494 accomplished by forcing the attacker to run each passphrase through a
1495 computationally expensive hashing function many times before they arrive at the
1496 resulting key. A user who actually knows the passphrase will only have to pay
1497 this cost once. As CPUs become better at processing, this number should be
1498 raised to ensure that a brute force attack is still not possible. The current
1503 This property may be changed with
1504 .Nm zfs Cm change-key .
1505 .It Sy exec Ns = Ns Sy on Ns | Ns Sy off
1506 Controls whether processes can be executed from within this file system.
1507 The default value is
1513 are equivalent to the
1518 .It Sy filesystem_limit Ns = Ns Em count Ns | Ns Sy none
1519 Limits the number of filesystems and volumes that can exist under this point in
1521 The limit is not enforced if the user is allowed to change the limit.
1523 .Sy filesystem_limit
1526 a descendent of a filesystem that already has a
1527 .Sy filesystem_limit
1528 does not override the ancestor's
1529 .Sy filesystem_limit ,
1530 but rather imposes an additional limit.
1531 This feature must be enabled to be used
1533 .Xr zpool-features 5
1535 .It Sy special_small_blocks Ns = Ns Em size
1536 This value represents the threshold block size for including small file
1537 blocks into the special allocation class. Blocks smaller than or equal to this
1538 value will be assigned to the special allocation class while greater blocks
1539 will be assigned to the regular class. Valid values are zero or a power of two
1540 from 512B up to 128K. The default size is 0 which means no small file blocks
1541 will be allocated in the special class.
1543 Before setting this property, a special class vdev must be added to the
1546 for more details on the special allocation class.
1547 .It Sy mountpoint Ns = Ns Pa path Ns | Ns Sy none Ns | Ns Sy legacy
1548 Controls the mount point used for this file system.
1551 section for more information on how this property is used.
1555 property is changed for a file system, the file system and any children that
1556 inherit the mount point are unmounted.
1559 then they remain unmounted.
1560 Otherwise, they are automatically remounted in the new location if the property
1565 or if they were mounted before the property was changed.
1566 In addition, any shared file systems are unshared and shared in the new
1568 .It Sy nbmand Ns = Ns Sy on Ns | Ns Sy off
1569 Controls whether the file system should be mounted with
1571 .Pq Non Blocking mandatory locks .
1572 This is used for SMB clients.
1573 Changes to this property only take effect when the file system is umounted and
1577 for more information on
1579 mounts. This property is not used on Linux.
1580 .It Sy overlay Ns = Ns Sy off Ns | Ns Sy on
1581 Allow mounting on a busy directory or a directory which already contains
1582 files or directories. This is the default mount behavior for Linux file systems.
1583 For consistency with OpenZFS on other platforms overlay mounts are
1587 to enable overlay mounts.
1588 .It Sy primarycache Ns = Ns Sy all Ns | Ns Sy none Ns | Ns Sy metadata
1589 Controls what is cached in the primary cache
1591 If this property is set to
1593 then both user data and metadata is cached.
1594 If this property is set to
1596 then neither user data nor metadata is cached.
1597 If this property is set to
1599 then only metadata is cached.
1600 The default value is
1602 .It Sy quota Ns = Ns Em size Ns | Ns Sy none
1603 Limits the amount of space a dataset and its descendents can consume.
1604 This property enforces a hard limit on the amount of space used.
1605 This includes all space consumed by descendents, including file systems and
1607 Setting a quota on a descendent of a dataset that already has a quota does not
1608 override the ancestor's quota, but rather imposes an additional limit.
1610 Quotas cannot be set on volumes, as the
1612 property acts as an implicit quota.
1613 .It Sy snapshot_limit Ns = Ns Em count Ns | Ns Sy none
1614 Limits the number of snapshots that can be created on a dataset and its
1618 on a descendent of a dataset that already has a
1620 does not override the ancestor's
1621 .Sy snapshot_limit ,
1622 but rather imposes an additional limit.
1623 The limit is not enforced if the user is allowed to change the limit.
1624 For example, this means that recursive snapshots taken from the global zone are
1625 counted against each delegated dataset within a zone.
1626 This feature must be enabled to be used
1628 .Xr zpool-features 5
1630 .It Sy userquota@ Ns Em user Ns = Ns Em size Ns | Ns Sy none
1631 Limits the amount of space consumed by the specified user.
1632 User space consumption is identified by the
1633 .Sy userspace@ Ns Em user
1636 Enforcement of user quotas may be delayed by several seconds.
1637 This delay means that a user might exceed their quota before the system notices
1638 that they are over quota and begins to refuse additional writes with the
1642 .Nm zfs Cm userspace
1643 subcommand for more information.
1645 Unprivileged users can only access their own groups' space usage.
1646 The root user, or a user who has been granted the
1650 can get and set everyone's quota.
1652 This property is not available on volumes, on file systems before version 4, or
1653 on pools before version 15.
1655 .Sy userquota@ Ns Em ...
1656 properties are not displayed by
1657 .Nm zfs Cm get Sy all .
1658 The user's name must be appended after the
1660 symbol, using one of the following forms:
1668 .Em POSIX numeric ID
1675 .Sy joe.smith@mydomain
1684 Files created on Linux always have POSIX owners.
1685 .It Sy userobjquota@ Ns Em user Ns = Ns Em size Ns | Ns Sy none
1690 but it limits the number of objects a user can create. Please refer to
1692 for more information about how objects are counted.
1693 .It Sy groupquota@ Ns Em group Ns = Ns Em size Ns | Ns Sy none
1694 Limits the amount of space consumed by the specified group.
1695 Group space consumption is identified by the
1696 .Sy groupused@ Ns Em group
1699 Unprivileged users can access only their own groups' space usage.
1700 The root user, or a user who has been granted the
1704 can get and set all groups' quotas.
1705 .It Sy groupobjquota@ Ns Em group Ns = Ns Em size Ns | Ns Sy none
1710 but it limits number of objects a group can consume. Please refer to
1712 for more information about how objects are counted.
1713 .It Sy projectquota@ Ns Em project Ns = Ns Em size Ns | Ns Sy none
1714 Limits the amount of space consumed by the specified project. Project
1715 space consumption is identified by the
1716 .Sy projectused@ Ns Em project
1717 property. Please refer to
1719 for more information about how project is identified and set/changed.
1721 The root user, or a user who has been granted the
1725 can access all projects' quota.
1726 .It Sy projectobjquota@ Ns Em project Ns = Ns Em size Ns | Ns Sy none
1731 but it limits number of objects a project can consume. Please refer to
1733 for more information about how objects are counted.
1734 .It Sy readonly Ns = Ns Sy on Ns | Ns Sy off
1735 Controls whether this dataset can be modified.
1736 The default value is
1742 are equivalent to the
1748 This property can also be referred to by its shortened column name,
1750 .It Sy recordsize Ns = Ns Em size
1751 Specifies a suggested block size for files in the file system.
1752 This property is designed solely for use with database workloads that access
1753 files in fixed-size records.
1754 ZFS automatically tunes block sizes according to internal algorithms optimized
1755 for typical access patterns.
1757 For databases that create very large files but access them in small random
1758 chunks, these algorithms may be suboptimal.
1761 greater than or equal to the record size of the database can result in
1762 significant performance gains.
1763 Use of this property for general purpose file systems is strongly discouraged,
1764 and may adversely affect performance.
1766 The size specified must be a power of two greater than or equal to 512 and less
1767 than or equal to 128 Kbytes.
1770 feature is enabled on the pool, the size may be up to 1 Mbyte.
1772 .Xr zpool-features 5
1773 for details on ZFS feature flags.
1775 Changing the file system's
1777 affects only files created afterward; existing files are unaffected.
1779 This property can also be referred to by its shortened column name,
1781 .It Sy redundant_metadata Ns = Ns Sy all Ns | Ns Sy most
1782 Controls what types of metadata are stored redundantly.
1783 ZFS stores an extra copy of metadata, so that if a single block is corrupted,
1784 the amount of user data lost is limited.
1785 This extra copy is in addition to any redundancy provided at the pool level
1786 .Pq e.g. by mirroring or RAID-Z ,
1787 and is in addition to an extra copy specified by the
1790 .Pq up to a total of 3 copies .
1791 For example if the pool is mirrored,
1792 .Sy copies Ns = Ns 2 ,
1794 .Sy redundant_metadata Ns = Ns Sy most ,
1795 then ZFS stores 6 copies of most metadata, and 4 copies of data and some
1800 ZFS stores an extra copy of all metadata.
1801 If a single on-disk block is corrupt, at worst a single block of user data
1810 ZFS stores an extra copy of most types of metadata.
1811 This can improve performance of random writes, because less metadata must be
1813 In practice, at worst about 100 blocks
1818 of user data can be lost if a single on-disk block is corrupt.
1819 The exact behavior of which metadata blocks are stored redundantly may change in
1822 The default value is
1824 .It Sy refquota Ns = Ns Em size Ns | Ns Sy none
1825 Limits the amount of space a dataset can consume.
1826 This property enforces a hard limit on the amount of space used.
1827 This hard limit does not include space used by descendents, including file
1828 systems and snapshots.
1829 .It Sy refreservation Ns = Ns Em size Ns | Ns Sy none Ns | Ns Sy auto
1830 The minimum amount of space guaranteed to a dataset, not including its
1832 When the amount of space used is below this value, the dataset is treated as if
1833 it were taking up the amount of space specified by
1834 .Sy refreservation .
1837 reservation is accounted for in the parent datasets' space used, and counts
1838 against the parent datasets' quotas and reservations.
1842 is set, a snapshot is only allowed if there is enough free pool space outside of
1843 this reservation to accommodate the current number of
1845 bytes in the dataset.
1851 a volume is thick provisioned
1855 .Sy refreservation Ns = Ns Sy auto
1856 is only supported on volumes.
1860 .Sx Native Properties
1861 section for more information about sparse volumes.
1863 This property can also be referred to by its shortened column name,
1865 .It Sy relatime Ns = Ns Sy on Ns | Ns Sy off
1866 Controls the manner in which the access time is updated when
1868 is set. Turning this property on causes the access time to be updated relative
1869 to the modify or change time. Access time is only updated if the previous
1870 access time was earlier than the current modify or change time or if the
1871 existing access time hasn't been updated within the past 24 hours. The default
1878 are equivalent to the
1883 .It Sy reservation Ns = Ns Em size Ns | Ns Sy none
1884 The minimum amount of space guaranteed to a dataset and its descendants.
1885 When the amount of space used is below this value, the dataset is treated as if
1886 it were taking up the amount of space specified by its reservation.
1887 Reservations are accounted for in the parent datasets' space used, and count
1888 against the parent datasets' quotas and reservations.
1890 This property can also be referred to by its shortened column name,
1892 .It Sy secondarycache Ns = Ns Sy all Ns | Ns Sy none Ns | Ns Sy metadata
1893 Controls what is cached in the secondary cache
1895 If this property is set to
1897 then both user data and metadata is cached.
1898 If this property is set to
1900 then neither user data nor metadata is cached.
1901 If this property is set to
1903 then only metadata is cached.
1904 The default value is
1906 .It Sy setuid Ns = Ns Sy on Ns | Ns Sy off
1907 Controls whether the setuid bit is respected for the file system.
1908 The default value is
1914 are equivalent to the
1919 .It Sy sharesmb Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Em opts
1920 Controls whether the file system is shared by using
1921 .Sy Samba USERSHARES
1922 and what options are to be used. Otherwise, the file system is automatically
1923 shared and unshared with the
1927 commands. If the property is set to on, the
1929 command is invoked to create a
1932 Because SMB shares requires a resource name, a unique resource name is
1933 constructed from the dataset name. The constructed name is a copy of the
1934 dataset name except that the characters in the dataset name, which would be
1935 invalid in the resource name, are replaced with underscore (_) characters.
1936 Linux does not currently support additional options which might be available
1943 the file systems are unshared.
1945 The share is created with the ACL (Access Control List) "Everyone:F" ("F"
1946 stands for "full permissions", ie. read and write permissions) and no guest
1947 access (which means Samba must be able to authenticate a real user, system
1948 passwd/shadow, LDAP or smbpasswd based) by default. This means that any
1949 additional access control (disallow specific user specific access etc) must
1950 be done on the underlying file system.
1951 .It Sy sharenfs Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Em opts
1952 Controls whether the file system is shared via NFS, and what options are to be
1954 A file system with a
1960 command and entries in the
1963 Otherwise, the file system is automatically shared and unshared with the
1968 If the property is set to
1970 the dataset is shared using the default options:
1972 .Em sec=sys,rw,crossmnt,no_subtree_check,no_root_squash
1976 for the meaning of the default options. Otherwise, the
1978 command is invoked with options equivalent to the contents of this property.
1982 property is changed for a dataset, the dataset and any children inheriting the
1983 property are re-shared with the new options, only if the property was previously
1985 or if they were shared before the property was changed.
1986 If the new property is
1988 the file systems are unshared.
1989 .It Sy logbias Ns = Ns Sy latency Ns | Ns Sy throughput
1990 Provide a hint to ZFS about handling of synchronous requests in this dataset.
1996 ZFS will use pool log devices
1998 to handle the requests at low latency.
2003 ZFS will not use configured pool log devices.
2004 ZFS will instead optimize synchronous operations for global pool throughput and
2005 efficient use of resources.
2006 .It Sy snapdev Ns = Ns Sy hidden Ns | Ns Sy visible
2007 Controls whether the volume snapshot devices under
2008 .Em /dev/zvol/<pool>
2009 are hidden or visible. The default value is
2011 .It Sy snapdir Ns = Ns Sy hidden Ns | Ns Sy visible
2012 Controls whether the
2014 directory is hidden or visible in the root of the file system as discussed in
2018 The default value is
2020 .It Sy sync Ns = Ns Sy standard Ns | Ns Sy always Ns | Ns Sy disabled
2021 Controls the behavior of synchronous requests
2022 .Pq e.g. fsync, O_DSYNC .
2026 specified behavior of ensuring all synchronous requests are written to stable
2027 storage and all devices are flushed to ensure data is not cached by device
2029 .Pq this is the default .
2031 causes every file system transaction to be written and flushed before its
2032 system call returns.
2033 This has a large performance penalty.
2035 disables synchronous requests.
2036 File system transactions are only committed to stable storage periodically.
2037 This option will give the highest performance.
2038 However, it is very dangerous as ZFS would be ignoring the synchronous
2039 transaction demands of applications such as databases or NFS.
2040 Administrators should only use this option when the risks are understood.
2041 .It Sy version Ns = Ns Em N Ns | Ns Sy current
2042 The on-disk version of this file system, which is independent of the pool
2044 This property can only be set to later supported versions.
2048 .It Sy volsize Ns = Ns Em size
2049 For volumes, specifies the logical size of the volume.
2050 By default, creating a volume establishes a reservation of equal size.
2051 For storage pools with a version number of 9 or higher, a
2056 are reflected in an equivalent change to the reservation
2062 can only be set to a multiple of
2066 The reservation is kept equal to the volume's logical size to prevent unexpected
2067 behavior for consumers.
2068 Without the reservation, the volume could run out of space, resulting in
2069 undefined behavior or data corruption, depending on how the volume is used.
2070 These effects can also occur when the volume size is changed while it is in use
2071 .Pq particularly when shrinking the size .
2072 Extreme care should be used when adjusting the volume size.
2074 Though not recommended, a
2077 .Qq thin provisioned
2079 can be created by specifying the
2082 .Nm zfs Cm create Fl V
2083 command, or by changing the value of the
2088 property on pool version 8 or earlier
2090 after the volume has been created.
2093 is a volume where the value of
2095 is less than the size of the volume plus the space required to store its
2097 Consequently, writes to a sparse volume can fail with
2099 when the pool is low on space.
2100 For a sparse volume, changes to
2102 are not reflected in the
2104 A volume that is not sparse is said to be
2105 .Qq thick provisioned .
2106 A sparse volume can become thick provisioned by setting
2110 .It Sy volmode Ns = Ns Cm default | full | geom | dev | none
2111 This property specifies how volumes should be exposed to the OS.
2114 exposes volumes as fully fledged block devices, providing maximal
2115 functionality. The value
2117 is just an alias for
2119 and is kept for compatibility.
2122 hides its partitions.
2123 Volumes with property set to
2125 are not exposed outside ZFS, but can be snapshoted, cloned, replicated, etc,
2126 that can be suitable for backup purposes.
2129 means that volumes exposition is controlled by system-wide tunable
2136 are encoded as 1, 2 and 3 respectively.
2137 The default values is
2139 .It Sy vscan Ns = Ns Sy on Ns | Ns Sy off
2140 Controls whether regular files should be scanned for viruses when a file is
2142 In addition to enabling this property, the virus scan service must also be
2143 enabled for virus scanning to occur.
2144 The default value is
2146 This property is not used on Linux.
2147 .It Sy xattr Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy sa
2148 Controls whether extended attributes are enabled for this file system. Two
2149 styles of extended attributes are supported either directory based or system
2152 The default value of
2154 enables directory based extended attributes. This style of extended attribute
2155 imposes no practical limit on either the size or number of attributes which
2156 can be set on a file. Although under Linux the
2160 system calls limit the maximum size to 64K. This is the most compatible
2161 style of extended attribute and is supported by all OpenZFS implementations.
2163 System attribute based xattrs can be enabled by setting the value to
2165 The key advantage of this type of xattr is improved performance. Storing
2166 extended attributes as system attributes significantly decreases the amount of
2167 disk IO required. Up to 64K of data may be stored per-file in the space
2168 reserved for system attributes. If there is not enough space available for
2169 an extended attribute then it will be automatically written as a directory
2170 based xattr. System attribute based extended attributes are not accessible
2171 on platforms which do not support the
2175 The use of system attribute based xattrs is strongly encouraged for users of
2176 SELinux or POSIX ACLs. Both of these features heavily rely of extended
2177 attributes and benefit significantly from the reduced access time.
2183 are equivalent to the
2188 .It Sy zoned Ns = Ns Sy on Ns | Ns Sy off
2189 Controls whether the dataset is managed from a non-global zone. Zones are a
2190 Solaris feature and are not relevant on Linux. The default value is
2194 The following three properties cannot be changed after the file system is
2195 created, and therefore, should be set when the file system is created.
2196 If the properties are not set with the
2200 commands, these properties are inherited from the parent dataset.
2201 If the parent dataset lacks these properties due to having been created prior to
2202 these features being supported, the new file system will have the default values
2203 for these properties.
2206 .Sy casesensitivity Ns = Ns Sy sensitive Ns | Ns
2207 .Sy insensitive Ns | Ns Sy mixed
2209 Indicates whether the file name matching algorithm used by the file system
2210 should be case-sensitive, case-insensitive, or allow a combination of both
2212 The default value for the
2220 file systems have case-sensitive file names.
2226 property indicates that the file system can support requests for both
2227 case-sensitive and case-insensitive matching behavior.
2228 Currently, case-insensitive matching behavior on a file system that supports
2229 mixed behavior is limited to the SMB server product.
2230 For more information about the
2232 value behavior, see the "ZFS Administration Guide".
2234 .Sy normalization Ns = Ns Sy none Ns | Ns Sy formC Ns | Ns
2235 .Sy formD Ns | Ns Sy formKC Ns | Ns Sy formKD
2237 Indicates whether the file system should perform a
2239 normalization of file names whenever two file names are compared, and which
2240 normalization algorithm should be used.
2241 File names are always stored unmodified, names are normalized as part of any
2243 If this property is set to a legal value other than
2247 property was left unspecified, the
2249 property is automatically set to
2251 The default value of the
2255 This property cannot be changed after the file system is created.
2256 .It Sy utf8only Ns = Ns Sy on Ns | Ns Sy off
2257 Indicates whether the file system should reject file names that include
2258 characters that are not present in the
2261 If this property is explicitly set to
2263 the normalization property must either not be explicitly set or be set to
2265 The default value for the
2269 This property cannot be changed after the file system is created.
2273 .Sy casesensitivity ,
2277 properties are also new permissions that can be assigned to non-privileged users
2278 by using the ZFS delegated administration feature.
2279 .Ss "Temporary Mount Point Properties"
2280 When a file system is mounted, either through
2282 for legacy mounts or the
2284 command for normal file systems, its mount options are set according to its
2286 The correlation between properties and mount options is as follows:
2288 PROPERTY MOUNT OPTION
2290 canmount auto/noauto
2294 relatime relatime/norelatime
2299 In addition, these options can be set on a per-mount basis using the
2301 option, without affecting the property that is stored on disk.
2302 The values specified on the command line override the values stored in the
2306 option is an alias for
2307 .Sy nodevices Ns \&, Ns Sy nosetuid .
2308 These properties are reported as
2313 If the properties are changed while the dataset is mounted, the new setting
2314 overrides any temporary settings.
2315 .Ss "User Properties"
2316 In addition to the standard native properties, ZFS supports arbitrary user
2318 User properties have no effect on ZFS behavior, but applications or
2319 administrators can use them to annotate datasets
2320 .Pq file systems, volumes, and snapshots .
2322 User property names must contain a colon
2324 character to distinguish them from native properties.
2325 They may contain lowercase letters, numbers, and the following punctuation
2334 The expected convention is that the property name is divided into two portions
2336 .Em module Ns \&: Ns Em property ,
2337 but this namespace is not enforced by ZFS.
2338 User property names can be at most 256 characters, and cannot begin with a dash
2341 When making programmatic use of user properties, it is strongly suggested to use
2346 component of property names to reduce the chance that two
2347 independently-developed packages use the same property name for different
2350 The values of user properties are arbitrary strings, are always inherited, and
2351 are never validated.
2352 All of the commands that operate on properties
2353 .Po Nm zfs Cm list ,
2358 can be used to manipulate both native properties and user properties.
2361 command to clear a user property.
2362 If the property is not defined in any parent dataset, it is removed entirely.
2363 Property values are limited to 8192 bytes.
2364 .Ss ZFS Volumes as Swap
2365 ZFS volumes may be used as swap devices. After creating the volume with the
2366 .Nm zfs Cm create Fl V
2367 command set up and enable the swap area using the
2371 commands. Do not swap to a file on a ZFS file system. A ZFS swap file
2372 configuration is not supported.
2376 feature allows for the creation of encrypted filesystems and volumes.
2378 will encrypt all user data including file and zvol data, file attributes,
2379 ACLs, permission bits, directory listings, FUID mappings, and userused /
2382 will not encrypt metadata related to the pool structure, including dataset
2383 names, dataset hierarchy, file size, file holes, and dedup tables. Key rotation
2384 is managed internally by the kernel module and changing the user's key does not
2385 require re-encrypting the entire dataset. Datasets can be scrubbed, resilvered,
2386 renamed, and deleted without the encryption keys being loaded (see the
2388 subcommand for more info on key loading).
2390 Creating an encrypted dataset requires specifying the
2394 properties at creation time, along with an optional
2398 After entering an encryption key, the
2399 created dataset will become an encryption root. Any descendant datasets will
2400 inherit their encryption key from the encryption root by default, meaning that
2401 loading, unloading, or changing the key for the encryption root will implicitly
2402 do the same for all inheriting datasets. If this inheritance is not desired,
2405 when creating the child dataset or use
2406 .Nm zfs Cm change-key
2407 to break an existing relationship, creating a new encryption root on the child.
2408 Note that the child's
2410 may match that of the parent while still creating a new encryption root, and
2413 property alone does not create a new encryption root; this would simply use a
2414 different cipher suite with the same key as its encryption root. The one
2415 exception is that clones will always use their origin's encryption key.
2416 As a result of this exception, some encryption-related properties (namely
2422 do not inherit like other ZFS properties and instead use the value determined
2423 by their encryption root. Encryption root inheritance can be tracked via the
2428 Encryption changes the behavior of a few
2430 operations. Encryption is applied after compression so compression ratios are
2431 preserved. Normally checksums in ZFS are 256 bits long, but for encrypted data
2432 the checksum is 128 bits of the user-chosen checksum and 128 bits of MAC from
2433 the encryption suite, which provides additional protection against maliciously
2434 altered data. Deduplication is still possible with encryption enabled but for
2435 security, datasets will only dedup against themselves, their snapshots, and
2438 There are a few limitations on encrypted datasets. Encrypted data cannot be
2441 feature. Encrypted datasets may not have
2442 .Sy copies Ns = Ns Em 3
2443 since the implementation stores some encryption metadata where the third copy
2444 would normally be. Since compression is applied before encryption datasets may
2445 be vulnerable to a CRIME-like attack if applications accessing the data allow
2446 for it. Deduplication with encryption will leak information about which blocks
2447 are equivalent in a dataset and will incur an extra CPU cost per block written.
2449 All subcommands that modify state are logged persistently to the pool in their
2453 Displays a help message.
2458 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2461 Creates a new ZFS file system.
2462 The file system is automatically mounted according to the
2464 property inherited from the parent.
2465 .Bl -tag -width "-o"
2466 .It Fl o Ar property Ns = Ns Ar value
2467 Sets the specified property as if the command
2468 .Nm zfs Cm set Ar property Ns = Ns Ar value
2469 was invoked at the same time the dataset was created.
2470 Any editable ZFS property can also be set at creation time.
2473 options can be specified.
2474 An error results if the same property is specified in multiple
2478 Creates all the non-existing parent datasets.
2479 Datasets created in this manner are automatically mounted according to the
2481 property inherited from their parent.
2482 Any property specified on the command line using the
2485 If the target filesystem already exists, the operation completes successfully.
2491 .Op Fl b Ar blocksize
2492 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2493 .Fl V Ar size Ar volume
2495 Creates a volume of the given size.
2496 The volume is exported as a block device in
2497 .Pa /dev/zvol/path ,
2500 is the name of the volume in the ZFS namespace.
2501 The size represents the logical size as exported by the device.
2502 By default, a reservation of equal size is created.
2505 is automatically rounded up to the nearest 128 Kbytes to ensure that the volume
2506 has an integral number of blocks regardless of
2508 .Bl -tag -width "-b"
2509 .It Fl b Ar blocksize
2511 .Fl o Sy volblocksize Ns = Ns Ar blocksize .
2512 If this option is specified in conjunction with
2513 .Fl o Sy volblocksize ,
2514 the resulting behavior is undefined.
2515 .It Fl o Ar property Ns = Ns Ar value
2516 Sets the specified property as if the
2517 .Nm zfs Cm set Ar property Ns = Ns Ar value
2518 command was invoked at the same time the dataset was created.
2519 Any editable ZFS property can also be set at creation time.
2522 options can be specified.
2523 An error results if the same property is specified in multiple
2527 Creates all the non-existing parent datasets.
2528 Datasets created in this manner are automatically mounted according to the
2530 property inherited from their parent.
2531 Any property specified on the command line using the
2534 If the target filesystem already exists, the operation completes successfully.
2536 Creates a sparse volume with no reservation.
2540 .Sx Native Properties
2541 section for more information about sparse volumes.
2547 .Ar filesystem Ns | Ns Ar volume
2549 Destroys the given dataset.
2550 By default, the command unshares any file systems that are currently shared,
2551 unmounts any file systems that are currently mounted, and refuses to destroy a
2552 dataset that has active dependents
2553 .Pq children or clones .
2554 .Bl -tag -width "-R"
2556 Recursively destroy all dependents, including cloned file systems outside the
2559 Force an unmount of any file systems using the
2562 This option has no effect on non-file systems or unmounted file systems.
2567 No data will be deleted.
2568 This is useful in conjunction with the
2572 flags to determine what data would be deleted.
2574 Print machine-parsable verbose information about the deleted data.
2576 Recursively destroy all children.
2578 Print verbose information about the deleted data.
2581 Extreme care should be taken when applying either the
2585 options, as they can destroy large portions of a pool and cause unexpected
2586 behavior for mounted file systems in use.
2591 .Ar filesystem Ns | Ns Ar volume Ns @ Ns Ar snap Ns
2592 .Oo % Ns Ar snap Ns Oo , Ns Ar snap Ns Oo % Ns Ar snap Oc Oc Oc Ns ...
2594 The given snapshots are destroyed immediately if and only if the
2598 option would have destroyed it.
2599 Such immediate destruction would occur, for example, if the snapshot had no
2600 clones and the user-initiated reference count were zero.
2602 If a snapshot does not qualify for immediate destruction, it is marked for
2604 In this state, it exists as a usable, visible snapshot until both of the
2605 preconditions listed above are met, at which point it is destroyed.
2607 An inclusive range of snapshots may be specified by separating the first and
2608 last snapshots with a percent sign.
2609 The first and/or last snapshots may be left blank, in which case the
2610 filesystem's oldest or newest snapshot will be implied.
2613 .Pq or ranges of snapshots
2614 of the same filesystem or volume may be specified in a comma-separated list of
2616 Only the snapshot's short name
2617 .Po the part after the
2620 should be specified when using a range or comma-separated list to identify
2622 .Bl -tag -width "-R"
2624 Recursively destroy all clones of these snapshots, including the clones,
2625 snapshots, and children.
2626 If this flag is specified, the
2628 flag will have no effect.
2630 Destroy immediately. If a snapshot cannot be destroyed now, mark it for
2631 deferred destruction.
2636 No data will be deleted.
2637 This is useful in conjunction with the
2641 flags to determine what data would be deleted.
2643 Print machine-parsable verbose information about the deleted data.
2646 .Pq or mark for deferred deletion
2647 all snapshots with this name in descendent file systems.
2649 Print verbose information about the deleted data.
2651 Extreme care should be taken when applying either the
2655 options, as they can destroy large portions of a pool and cause unexpected
2656 behavior for mounted file systems in use.
2661 .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
2663 The given bookmark is destroyed.
2668 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2669 .Ar filesystem Ns @ Ns Ar snapname Ns | Ns Ar volume Ns @ Ns Ar snapname Ns ...
2671 Creates snapshots with the given names.
2672 All previous modifications by successful system calls to the file system are
2673 part of the snapshots.
2674 Snapshots are taken atomically, so that all snapshots correspond to the same
2677 can be used as an alias for
2678 .Nm zfs Cm snapshot.
2681 section for details.
2682 .Bl -tag -width "-o"
2683 .It Fl o Ar property Ns = Ns Ar value
2684 Sets the specified property; see
2688 Recursively create snapshots of all descendent datasets
2696 Roll back the given dataset to a previous snapshot.
2697 When a dataset is rolled back, all data that has changed since the snapshot is
2698 discarded, and the dataset reverts to the state at the time of the snapshot.
2699 By default, the command refuses to roll back to a snapshot other than the most
2701 In order to do so, all intermediate snapshots and bookmarks must be destroyed by
2708 options do not recursively destroy the child snapshots of a recursive snapshot.
2709 Only direct snapshots of the specified filesystem are destroyed by either of
2711 To completely roll back a recursive snapshot, you must rollback the individual
2713 .Bl -tag -width "-R"
2715 Destroy any more recent snapshots and bookmarks, as well as any clones of those
2720 option to force an unmount of any clone file systems that are to be destroyed.
2722 Destroy any snapshots and bookmarks more recent than the one specified.
2728 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2729 .Ar snapshot Ar filesystem Ns | Ns Ar volume
2731 Creates a clone of the given snapshot.
2734 section for details.
2735 The target dataset can be located anywhere in the ZFS hierarchy, and is created
2736 as the same type as the original.
2737 .Bl -tag -width "-o"
2738 .It Fl o Ar property Ns = Ns Ar value
2739 Sets the specified property; see
2743 Creates all the non-existing parent datasets.
2744 Datasets created in this manner are automatically mounted according to the
2746 property inherited from their parent.
2747 If the target filesystem or volume already exists, the operation completes
2753 .Ar clone-filesystem
2755 Promotes a clone file system to no longer be dependent on its
2758 This makes it possible to destroy the file system that the clone was created
2760 The clone parent-child dependency relationship is reversed, so that the origin
2761 file system becomes a clone of the specified file system.
2763 The snapshot that was cloned, and any snapshots previous to this snapshot, are
2764 now owned by the promoted clone.
2765 The space they use moves from the origin file system to the promoted clone, so
2766 enough space must be available to accommodate these snapshots.
2767 No new space is consumed by this operation, but the space accounting is
2769 The promoted clone must not have any conflicting snapshot names of its own.
2772 subcommand can be used to rename any conflicting snapshots.
2777 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2778 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2784 .Ar filesystem Ns | Ns Ar volume
2785 .Ar filesystem Ns | Ns Ar volume
2787 Renames the given dataset.
2788 The new target can be located anywhere in the ZFS hierarchy, with the exception
2790 Snapshots can only be renamed within the parent file system or volume.
2791 When renaming a snapshot, the parent file system of the snapshot does not need
2792 to be specified as part of the second argument.
2793 Renamed file systems can inherit new mount points, in which case they are
2794 unmounted and remounted at the new mount point.
2795 .Bl -tag -width "-a"
2797 Force unmount any filesystems that need to be unmounted in the process.
2799 Creates all the nonexistent parent datasets.
2800 Datasets created in this manner are automatically mounted according to the
2802 property inherited from their parent.
2808 .Ar snapshot Ar snapshot
2810 Recursively rename the snapshots of all descendent datasets.
2811 Snapshots are the only dataset that can be renamed recursively.
2815 .Op Fl r Ns | Ns Fl d Ar depth
2817 .Oo Fl o Ar property Ns Oo , Ns Ar property Oc Ns ... Oc
2818 .Oo Fl s Ar property Oc Ns ...
2819 .Oo Fl S Ar property Oc Ns ...
2820 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
2821 .Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Oc Ns ...
2823 Lists the property information for the given datasets in tabular form.
2824 If specified, you can list property information by the absolute pathname or the
2826 By default, all file systems and volumes are displayed.
2827 Snapshots are displayed if the
2834 The following fields are displayed:
2835 .Sy name Ns \&, Sy used Ns \&, Sy available Ns \&, Sy referenced Ns \&, Sy mountpoint Ns .
2836 .Bl -tag -width "-H"
2838 Used for scripting mode.
2839 Do not print headers and separate fields by a single tab instead of arbitrary
2841 .It Fl S Ar property
2844 option, but sorts by property in descending order.
2846 Recursively display any children of the dataset, limiting the recursion to
2852 will display only the dataset and its direct children.
2853 .It Fl o Ar property
2854 A comma-separated list of properties to display.
2855 The property must be:
2858 One of the properties described in the
2859 .Sx Native Properties
2866 to display the dataset name
2870 to display space usage properties on file systems and volumes.
2871 This is a shortcut for specifying
2872 .Fl o Sy name Ns \&, Ns Sy avail Ns \&, Ns Sy used Ns \&, Ns Sy usedsnap Ns \&, Ns
2873 .Sy usedds Ns \&, Ns Sy usedrefreserv Ns \&, Ns Sy usedchild Fl t
2874 .Sy filesystem Ns \&, Ns Sy volume
2878 Display numbers in parsable
2882 Recursively display any children of the dataset on the command line.
2883 .It Fl s Ar property
2884 A property for sorting the output by column in ascending order based on the
2885 value of the property.
2886 The property must be one of the properties described in the
2888 section, or the special value
2890 to sort by the dataset name.
2891 Multiple properties can be specified at one time using multiple
2896 options are evaluated from left to right in decreasing order of importance.
2897 The following is a list of sorting criteria:
2900 Numeric types sort in numeric order.
2902 String types sort in alphabetical order.
2904 Types inappropriate for a row sort that row to the literal bottom, regardless of
2905 the specified ordering.
2908 If no sorting options are specified the existing behavior of
2912 A comma-separated list of types to display, where
2921 For example, specifying
2923 displays only snapshots.
2928 .Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ...
2929 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
2931 Sets the property or list of properties to the given value(s) for each dataset.
2932 Only some properties can be edited.
2935 section for more information on what properties can be set and acceptable
2937 Numeric values can be specified as exact values, or in a human-readable form
2939 .Sy B , K , M , G , T , P , E , Z
2940 .Po for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes,
2941 or zettabytes, respectively
2943 User properties can be set on snapshots.
2944 For more information, see the
2950 .Op Fl r Ns | Ns Fl d Ar depth
2952 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
2953 .Oo Fl s Ar source Ns Oo , Ns Ar source Oc Ns ... Oc
2954 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
2955 .Cm all | Ar property Ns Oo , Ns Ar property Oc Ns ...
2956 .Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Oc Ns ...
2958 Displays properties for the given datasets.
2959 If no datasets are specified, then the command displays properties for all
2960 datasets on the system.
2961 For each property, the following columns are displayed:
2964 property Property name
2965 value Property value
2966 source Property source \fBlocal\fP, \fBdefault\fP, \fBinherited\fP,
2967 \fBtemporary\fP, \fBreceived\fP or none (\fB-\fP).
2970 All columns are displayed by default, though this can be controlled by using the
2973 This command takes a comma-separated list of properties as described in the
2974 .Sx Native Properties
2981 can be used to display all properties that apply to the given dataset's type
2982 .Pq filesystem, volume, snapshot, or bookmark .
2983 .Bl -tag -width "-H"
2985 Display output in a form more easily parsed by scripts.
2986 Any headers are omitted, and fields are explicitly separated by a single tab
2987 instead of an arbitrary amount of space.
2989 Recursively display any children of the dataset, limiting the recursion to
2993 will display only the dataset and its direct children.
2995 A comma-separated list of columns to display.
2996 .Sy name Ns \&, Ns Sy property Ns \&, Ns Sy value Ns \&, Ns Sy source
2997 is the default value.
2999 Display numbers in parsable
3003 Recursively display properties for any children.
3005 A comma-separated list of sources to display.
3006 Those properties coming from a source other than those in this list are ignored.
3007 Each source must be one of the following:
3015 The default value is all sources.
3017 A comma-separated list of types to display, where
3031 .Ar property Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
3033 Clears the specified property, causing it to be inherited from an ancestor,
3034 restored to default if no ancestor has the property set, or with the
3036 option reverted to the received value if one exists.
3039 section for a listing of default values, and details on which properties can be
3041 .Bl -tag -width "-r"
3043 Recursively inherit the given property for all children.
3045 Revert the property to the received value if one exists; otherwise operate as
3048 option was not specified.
3054 Displays a list of file systems that are not the most recent version.
3060 Displays a list of currently supported file system versions.
3066 .Fl a | Ar filesystem
3068 Upgrades file systems to a new on-disk version.
3069 Once this is done, the file systems will no longer be accessible on systems
3070 running older versions of the software.
3072 streams generated from new snapshots of these file systems cannot be accessed on
3073 systems running older versions of the software.
3075 In general, the file system version is independent of the pool version.
3078 for information on the
3079 .Nm zpool Cm upgrade
3082 In some cases, the file system version and the pool version are interrelated and
3083 the pool version must be upgraded before the file system version can be
3085 .Bl -tag -width "-V"
3087 Upgrade to the specified
3091 flag is not specified, this command upgrades to the most recent version.
3093 option can only be used to increase the version number, and only up to the most
3094 recent version supported by this software.
3096 Upgrade all file systems on all imported pools.
3098 Upgrade the specified file system.
3100 Upgrade the specified file system and all descendent file systems.
3106 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
3107 .Oo Fl s Ar field Oc Ns ...
3108 .Oo Fl S Ar field Oc Ns ...
3109 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
3110 .Ar filesystem Ns | Ns Ar snapshot
3112 Displays space consumed by, and quotas on, each user in the specified filesystem
3114 This corresponds to the
3115 .Sy userused@ Ns Em user ,
3116 .Sy userobjused@ Ns Em user ,
3117 .Sy userquota@ Ns Em user,
3119 .Sy userobjquota@ Ns Em user
3121 .Bl -tag -width "-H"
3123 Do not print headers, use tab-delimited output.
3125 Sort by this field in reverse order.
3129 Translate SID to POSIX ID.
3130 The POSIX ID may be ephemeral if no mapping exists.
3131 Normal POSIX interfaces
3136 perform this translation, so the
3138 option allows the output from
3139 .Nm zfs Cm userspace
3140 to be compared directly with those utilities.
3143 may lead to confusion if some files were created by an SMB user before a
3144 SMB-to-POSIX name mapping was established.
3145 In such a case, some files will be owned by the SMB entity and some by the POSIX
3149 option will report that the POSIX entity has the total usage and quota for both.
3151 Print numeric ID instead of user/group name.
3152 .It Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
3153 Display only the specified fields from the following set:
3158 The default is to display all fields.
3164 Sort output by this field.
3169 flags may be specified multiple times to sort first by one field, then by
3172 .Fl s Sy type Fl s Sy name .
3173 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
3174 Print only the specified types from the following set:
3181 .Fl t Sy posixuser Ns \&, Ns Sy smbuser .
3182 The default can be changed to include group types.
3188 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
3189 .Oo Fl s Ar field Oc Ns ...
3190 .Oo Fl S Ar field Oc Ns ...
3191 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
3192 .Ar filesystem Ns | Ns Ar snapshot
3194 Displays space consumed by, and quotas on, each group in the specified
3195 filesystem or snapshot.
3196 This subcommand is identical to
3197 .Nm zfs Cm userspace ,
3198 except that the default types to display are
3199 .Fl t Sy posixgroup Ns \&, Ns Sy smbgroup .
3204 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
3205 .Oo Fl s Ar field Oc Ns ...
3206 .Oo Fl S Ar field Oc Ns ...
3207 .Ar filesystem Ns | Ns Ar snapshot
3209 Displays space consumed by, and quotas on, each project in the specified
3210 filesystem or snapshot. This subcommand is identical to
3211 .Nm zfs Cm userspace ,
3212 except that the project identifier is numeral, not name. So need neither
3215 for SID to POSIX ID nor
3223 .Oo Fl d Ns | Ns Fl r Ns Oc
3224 .Ar file Ns | Ns Ar directory Ns ...
3226 List project identifier (ID) and inherit flag of file(s) or directories.
3227 .Bl -tag -width "-d"
3229 Show the directory project ID and inherit flag, not its childrens. It will
3230 overwrite the former specified
3234 Show on subdirectories recursively. It will overwrite the former specified
3243 .Ar file Ns | Ns Ar directory Ns ...
3245 Clear project inherit flag and/or ID on the file(s) or directories.
3246 .Bl -tag -width "-k"
3248 Keep the project ID unchanged. If not specified, the project ID will be reset
3251 Clear on subdirectories recursively.
3258 .Oo Fl d Ns | Ns Fl r Ns Oc
3260 .Ar file Ns | Ns Ar directory Ns ...
3262 Check project ID and inherit flag on the file(s) or directories, report the
3263 entries without project inherit flag or with different project IDs from the
3266 option) value or the target directory's project ID.
3267 .Bl -tag -width "-0"
3269 Print file name with a trailing NUL instead of newline (by default), like
3272 Check the directory project ID and inherit flag, not its childrens. It will
3273 overwrite the former specified
3277 Specify the referenced ID for comparing with the target file(s) or directories'
3278 project IDs. If not specified, the target (top) directory's project ID will be
3279 used as the referenced one.
3281 Check on subdirectories recursively. It will overwrite the former specified
3290 .Ar file Ns | Ns Ar directory Ns ...
3292 .Bl -tag -width "-p"
3293 Set project ID and/or inherit flag on the file(s) or directories.
3295 Set the file(s)' or directories' project ID with the given value.
3297 Set on subdirectories recursively.
3299 Set project inherit flag on the given file(s) or directories. It is usually used
3300 for setup tree quota on the directory target with
3302 option specified together. When setup tree quota, by default the directory's
3303 project ID will be set to all its descendants unless you specify the project
3312 Displays all ZFS file systems currently mounted.
3318 .Fl a | Ar filesystem
3320 Mount ZFS filesystem on a path described by its
3322 property, if the path exists and is empty. If
3326 the filesystem should be instead mounted using
3328 .Bl -tag -width "-O"
3330 Perform an overlay mount. Allows mounting in non-empty
3334 for more information.
3336 Mount all available ZFS file systems.
3337 Invoked automatically as part of the boot process if configured.
3339 Mount the specified filesystem.
3341 An optional, comma-separated list of mount options to use temporarily for the
3342 duration of the mount.
3344 .Sx Temporary Mount Point Properties
3345 section for details.
3347 Load keys for encrypted filesystems as they are being mounted. This is
3348 equivalent to executing
3350 on each encryption root before mounting it. Note that if a filesystem has a
3354 this will cause the terminal to interactively block after asking for the key.
3356 Report mount progress.
3362 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
3364 Unmounts currently mounted ZFS file systems.
3365 .Bl -tag -width "-a"
3367 Unmount all available ZFS file systems.
3368 Invoked automatically as part of the shutdown process.
3369 .It Ar filesystem Ns | Ns Ar mountpoint
3370 Unmount the specified filesystem.
3371 The command can also be given a path to a ZFS file system mount point on the
3374 Forcefully unmount the file system, even if it is currently in use.
3379 .Fl a | Ar filesystem
3381 Shares available ZFS file systems.
3382 .Bl -tag -width "-a"
3384 Share all available ZFS file systems.
3385 Invoked automatically as part of the boot process.
3387 Share the specified filesystem according to the
3392 File systems are shared when the
3401 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
3403 Unshares currently shared ZFS file systems.
3404 .Bl -tag -width "-a"
3406 Unshare all available ZFS file systems.
3407 Invoked automatically as part of the shutdown process.
3408 .It Ar filesystem Ns | Ns Ar mountpoint
3409 Unshare the specified filesystem.
3410 The command can also be given a path to a ZFS file system shared on the system.
3415 .Ar snapshot bookmark
3417 Creates a bookmark of the given snapshot.
3418 Bookmarks mark the point in time when the snapshot was created, and can be used
3419 as the incremental source for a
3423 This feature must be enabled to be used.
3425 .Xr zpool-features 5
3426 for details on ZFS feature flags and the
3433 .Op Oo Fl I Ns | Ns Fl i Oc Ar snapshot
3436 Creates a stream representation of the second
3438 which is written to standard output.
3439 The output can be redirected to a file or to a different system
3440 .Po for example, using
3443 By default, a full stream is generated.
3444 .Bl -tag -width "-D"
3446 Generate a deduplicated stream.
3447 Blocks which would have been sent multiple times in the send stream will only be
3449 The receiving system must also support this feature to receive a deduplicated
3451 This flag can be used regardless of the dataset's
3453 property, but performance will be much better if the filesystem uses a
3454 dedup-capable checksum
3458 .It Fl I Ar snapshot
3459 Generate a stream package that sends all intermediary snapshots from the first
3460 snapshot to the second snapshot.
3464 .Fl i Em @a Em fs@b Ns \&; Fl i Em @b Em fs@c Ns \&; Fl i Em @c Em fs@d .
3465 The incremental source may be specified as with the
3468 .It Fl L, -large-block
3469 Generate a stream which may contain blocks larger than 128KB.
3470 This flag has no effect if the
3472 pool feature is disabled, or if the
3474 property of this filesystem has never been set above 128KB.
3475 The receiving system must have the
3477 pool feature enabled as well.
3479 .Xr zpool-features 5
3480 for details on ZFS feature flags and the
3484 Print machine-parsable verbose information about the stream package generated.
3485 .It Fl R, -replicate
3486 Generate a replication stream package, which will replicate the specified
3487 file system, and all descendent file systems, up to the named snapshot.
3488 When received, all properties, snapshots, descendent file systems, and clones
3495 flags are used in conjunction with the
3497 flag, an incremental replication stream is generated.
3498 The current values of properties, and current snapshot and file system names are
3499 set when the stream is received.
3502 flag is specified when this stream is received, snapshots and file systems that
3503 do not exist on the sending side are destroyed.
3505 Generate a more compact stream by using
3507 records for blocks which are stored more compactly on disk by the
3510 This flag has no effect if the
3512 feature is disabled.
3513 The receiving system must have the
3518 feature is active on the sending system, then the receiving system must have
3519 that feature enabled as well. Datasets that are sent with this flag may not be
3520 received as an encrypted dataset, since encrypted datasets cannot use the
3524 .Xr zpool-features 5
3525 for details on ZFS feature flags and the
3529 Sends only received property values whether or not they are overridden by local
3530 settings, but only if the dataset has ever been received. Use this option when
3533 to restore received properties backed up on the sent dataset and to avoid
3534 sending local settings that may have nothing to do with the source dataset,
3535 but only with how the data is backed up.
3536 .It Fl c, -compressed
3537 Generate a more compact stream by using compressed WRITE records for blocks
3538 which are compressed on disk and in memory
3541 property for details
3545 feature is active on the sending system, then the receiving system must have
3546 that feature enabled as well.
3549 feature is enabled on the sending system but the
3551 option is not supplied in conjunction with
3553 then the data will be decompressed before sending so it can be split into
3554 smaller block sizes.
3556 For encrypted datasets, send data exactly as it exists on disk. This allows
3557 backups to be taken even if encryption keys are not currently loaded. The
3558 backup may then be received on an untrusted machine since that machine will
3559 not have the encryption keys to read the protected data or alter it without
3560 being detected. Upon being received, the dataset will have the same encryption
3561 keys as it did on the send side, although the
3563 property will be defaulted to
3565 if not otherwise provided. For unencrypted datasets, this flag will be
3568 Note that if you do not use this flag for sending encrypted datasets, data will
3569 be sent unencrypted and may be re-encrypted with a different encryption key on
3570 the receiving system, which will disable the ability to do a raw send to that
3571 system for incrementals.
3573 Generate a stream package that includes any snapshot holds (created with the
3575 command), and indicating to
3577 that the holds be applied to the dataset on the receiving system.
3578 .It Fl i Ar snapshot
3579 Generate an incremental stream from the first
3581 .Pq the incremental source
3584 .Pq the incremental target .
3585 The incremental source can be specified as the last component of the snapshot
3589 character and following
3591 and it is assumed to be from the same file system as the incremental target.
3593 If the destination is a clone, the source may be the origin snapshot, which must
3596 .Em pool/fs@origin ,
3604 Do not generate any actual send data.
3605 This is useful in conjunction with the
3609 flags to determine what data will be sent.
3610 In this case, the verbose output will be written to standard output
3611 .Po contrast with a non-dry-run, where the stream is written to standard output
3612 and the verbose output goes to standard error
3615 Include the dataset's properties in the stream.
3616 This flag is implicit when
3619 The receiving system must also support this feature. Sends of encrypted datasets
3622 when using this flag.
3624 Print verbose information about the stream package generated.
3625 This information includes a per-second report of how much data has been sent.
3627 The format of the stream is committed.
3628 You will be able to receive your streams on future versions of ZFS.
3634 .Op Fl i Ar snapshot Ns | Ns Ar bookmark
3635 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
3637 Generate a send stream, which may be of a filesystem, and may be incremental
3639 If the destination is a filesystem or volume, the pool must be read-only, or the
3640 filesystem must not be mounted.
3641 When the stream generated from a filesystem or volume is received, the default
3642 snapshot name will be
3644 .Bl -tag -width "-L"
3645 .It Fl L, -large-block
3646 Generate a stream which may contain blocks larger than 128KB.
3647 This flag has no effect if the
3649 pool feature is disabled, or if the
3651 property of this filesystem has never been set above 128KB.
3652 The receiving system must have the
3654 pool feature enabled as well.
3656 .Xr zpool-features 5
3657 for details on ZFS feature flags and the
3661 Print machine-parsable verbose information about the stream package generated.
3662 .It Fl c, -compressed
3663 Generate a more compact stream by using compressed WRITE records for blocks
3664 which are compressed on disk and in memory
3667 property for details
3671 feature is active on the sending system, then the receiving system must have
3672 that feature enabled as well.
3675 feature is enabled on the sending system but the
3677 option is not supplied in conjunction with
3679 then the data will be decompressed before sending so it can be split into
3680 smaller block sizes.
3682 For encrypted datasets, send data exactly as it exists on disk. This allows
3683 backups to be taken even if encryption keys are not currently loaded. The
3684 backup may then be received on an untrusted machine since that machine will
3685 not have the encryption keys to read the protected data or alter it without
3686 being detected. Upon being received, the dataset will have the same encryption
3687 keys as it did on the send side, although the
3689 property will be defaulted to
3691 if not otherwise provided. For unencrypted datasets, this flag will be
3694 Note that if you do not use this flag for sending encrypted datasets, data will
3695 be sent unencrypted and may be re-encrypted with a different encryption key on
3696 the receiving system, which will disable the ability to do a raw send to that
3697 system for incrementals.
3699 Generate a more compact stream by using
3701 records for blocks which are stored more compactly on disk by the
3704 This flag has no effect if the
3706 feature is disabled.
3707 The receiving system must have the
3712 feature is active on the sending system, then the receiving system must have
3713 that feature enabled as well. Datasets that are sent with this flag may not be
3714 received as an encrypted dataset, since encrypted datasets cannot use the
3718 .Xr zpool-features 5
3719 for details on ZFS feature flags and the
3722 .It Fl i Ar snapshot Ns | Ns Ar bookmark
3723 Generate an incremental send stream.
3724 The incremental source must be an earlier snapshot in the destination's history.
3725 It will commonly be an earlier snapshot in the destination's file system, in
3726 which case it can be specified as the last component of the name
3731 character and following
3734 If the incremental target is a clone, the incremental source can be the origin
3735 snapshot, or an earlier snapshot in the origin's filesystem, or the origin's
3741 Do not generate any actual send data.
3742 This is useful in conjunction with the
3746 flags to determine what data will be sent.
3747 In this case, the verbose output will be written to standard output
3748 .Po contrast with a non-dry-run, where the stream is written to standard output
3749 and the verbose output goes to standard error
3752 Print verbose information about the stream package generated.
3753 This information includes a per-second report of how much data has been sent.
3760 .Ar receive_resume_token
3762 Creates a send stream which resumes an interrupted receive.
3764 .Ar receive_resume_token
3765 is the value of this property on the filesystem or volume that was being
3767 See the documentation for
3774 .Op Fl o Sy origin Ns = Ns Ar snapshot
3775 .Op Fl o Ar property Ns = Ns Ar value
3776 .Op Fl x Ar property
3777 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
3783 .Op Fl d Ns | Ns Fl e
3784 .Op Fl o Sy origin Ns = Ns Ar snapshot
3785 .Op Fl o Ar property Ns = Ns Ar value
3786 .Op Fl x Ar property
3789 Creates a snapshot whose contents are as specified in the stream provided on
3791 If a full stream is received, then a new file system is created as well.
3792 Streams are created using the
3794 subcommand, which by default creates a full stream.
3796 can be used as an alias for
3799 If an incremental stream is received, then the destination file system must
3800 already exist, and its most recent snapshot must match the incremental stream's
3804 the destination device link is destroyed and recreated, which means the
3806 cannot be accessed during the
3810 When a snapshot replication package stream that is generated by using the
3811 .Nm zfs Cm send Fl R
3812 command is received, any snapshots that do not exist on the sending location are
3813 destroyed by using the
3814 .Nm zfs Cm destroy Fl d
3818 .Fl o Em property Ns = Ns Ar value
3821 is specified, it applies to the effective value of the property throughout
3822 the entire subtree of replicated datasets. Effective property values will be
3827 ) on the topmost in the replicated subtree. In descendant datasets, if the
3828 property is set by the send stream, it will be overridden by forcing the
3829 property to be inherited from the top‐most file system. Received properties
3830 are retained in spite of being overridden and may be restored with
3831 .Nm zfs Cm inherit Fl S .
3833 .Fl o Sy origin Ns = Ns Em snapshot
3834 is a special case because, even if
3836 is a read-only property and cannot be set, it's allowed to receive the send
3837 stream as a clone of the given snapshot.
3839 Raw encrypted send streams (created with
3840 .Nm zfs Cm send Fl w
3841 ) may only be received as is, and cannot be re-encrypted, decrypted, or
3842 recompressed by the receive process. Unencrypted streams can be received as
3843 encrypted datasets, either through inheritance or by specifying encryption
3848 The name of the snapshot
3849 .Pq and file system, if a full stream is received
3850 that this subcommand creates depends on the argument type and the use of the
3856 If the argument is a snapshot name, the specified
3859 If the argument is a file system or volume name, a snapshot with the same name
3860 as the sent snapshot is created within the specified
3868 options are specified, the provided target snapshot name is used exactly as
3875 options cause the file system name of the target snapshot to be determined by
3876 appending a portion of the sent snapshot's name to the specified target
3880 option is specified, all but the first element of the sent snapshot's file
3882 .Pq usually the pool name
3883 is used and any required intermediate file systems within the specified one are
3887 option is specified, then only the last element of the sent snapshot's file
3889 .Pq i.e. the name of the source file system itself
3890 is used as the target file system name.
3891 .Bl -tag -width "-F"
3893 Force a rollback of the file system to the most recent snapshot before
3894 performing the receive operation.
3895 If receiving an incremental replication stream
3896 .Po for example, one generated by
3897 .Nm zfs Cm send Fl R Op Fl i Ns | Ns Fl I
3899 destroy snapshots and file systems that do not exist on the sending side.
3901 Discard the first element of the sent snapshot's file system name, using the
3902 remaining elements to determine the name of the target file system for the new
3903 snapshot as described in the paragraph above.
3905 Discard all but the last element of the sent snapshot's file system name, using
3906 that element to determine the name of the target file system for the new
3907 snapshot as described in the paragraph above.
3909 Skip the receive of holds. There is no effect if holds are not sent.
3911 Do not actually receive the stream.
3912 This can be useful in conjunction with the
3914 option to verify the name the receive operation would use.
3915 .It Fl o Sy origin Ns = Ns Ar snapshot
3916 Forces the stream to be received as a clone of the given snapshot.
3917 If the stream is a full send stream, this will create the filesystem
3918 described by the stream as a clone of the specified snapshot.
3919 Which snapshot was specified will not affect the success or failure of the
3920 receive, as long as the snapshot does exist.
3921 If the stream is an incremental send stream, all the normal verification will be
3923 .It Fl o Em property Ns = Ns Ar value
3924 Sets the specified property as if the command
3925 .Nm zfs Cm set Em property Ns = Ns Ar value
3926 was invoked immediately before the receive. When receiving a stream from
3927 .Nm zfs Cm send Fl R ,
3928 causes the property to be inherited by all descendant datasets, as through
3929 .Nm zfs Cm inherit Em property
3930 was run on any descendant datasets that have this property set on the
3933 Any editable property can be set at receive time. Set-once properties bound
3934 to the received data, such as
3937 .Sy casesensitivity ,
3938 cannot be set at receive time even when the datasets are newly created by
3939 .Nm zfs Cm receive .
3940 Additionally both settable properties
3944 cannot be set at receive time.
3948 option may be specified multiple times, for different properties. An error
3949 results if the same property is specified in multiple
3957 option may also be used to override encryption properties upon initial
3958 receive. This allows unencrypted streams to be received as encrypted datasets.
3959 To cause the received dataset (or root dataset of a recursive stream) to be
3960 received as an encryption root, specify encryption properties in the same
3961 manner as is required for
3966 # zfs send tank/test@snap1 | zfs recv -o encryption=on -o keyformat=passphrase -o keylocation=file:///path/to/keyfile
3970 .Op Fl o Ar keylocation Ns = Ns Ar prompt
3971 may not be specified here, since stdin is already being utilized for the send
3972 stream. Once the receive has completed, you can use
3975 to change this setting after the fact. Similarly, you can receive a dataset as
3976 an encrypted child by specifying
3977 .Op Fl x Ar encryption
3978 to force the property to be inherited. Overriding encryption properties (except
3980 .Sy keylocation Ns )
3981 is not possible with raw send streams.
3983 If the receive is interrupted, save the partially received state, rather
3985 Interruption may be due to premature termination of the stream
3986 .Po e.g. due to network failure or failure of the remote system
3987 if the stream is being read over a network connection
3989 a checksum error in the stream, termination of the
3991 process, or unclean shutdown of the system.
3993 The receive can be resumed with a stream generated by
3994 .Nm zfs Cm send Fl t Ar token ,
3998 .Sy receive_resume_token
3999 property of the filesystem or volume which is received into.
4001 To use this flag, the storage pool must have the
4002 .Sy extensible_dataset
4005 .Xr zpool-features 5
4006 for details on ZFS feature flags.
4008 File system that is associated with the received stream is not mounted.
4010 Print verbose information about the stream and the time required to perform the
4012 .It Fl x Em property
4013 Ensures that the effective value of the specified property after the
4014 receive is unaffected by the value of that property in the send stream (if any),
4015 as if the property had been excluded from the send stream.
4017 If the specified property is not present in the send stream, this option does
4020 If a received property needs to be overridden, the effective value will be
4021 set or inherited, depending on whether the property is inheritable or not.
4023 In the case of an incremental update,
4025 leaves any existing local setting or explicit inheritance unchanged.
4029 restrictions on set-once and special properties apply equally to
4036 .Ar filesystem Ns | Ns Ar volume
4038 Abort an interrupted
4039 .Nm zfs Cm receive Fl s ,
4040 deleting its saved partially received state.
4044 .Ar filesystem Ns | Ns Ar volume
4046 Displays permissions that have been delegated on the specified filesystem or
4048 See the other forms of
4050 for more information.
4052 Delegations are supported under Linux with the exception of
4060 These permissions cannot be delegated because the Linux
4062 command restricts modifications of the global namespace to the root user.
4067 .Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
4068 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4069 .Ar setname Oc Ns ...
4070 .Ar filesystem Ns | Ns Ar volume
4076 .Fl e Ns | Ns Sy everyone
4077 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4078 .Ar setname Oc Ns ...
4079 .Ar filesystem Ns | Ns Ar volume
4081 Delegates ZFS administration permission for the file systems to non-privileged
4083 .Bl -tag -width "-d"
4085 Allow only for the descendent file systems.
4086 .It Fl e Ns | Ns Sy everyone
4087 Specifies that the permissions be delegated to everyone.
4088 .It Fl g Ar group Ns Oo , Ns Ar group Oc Ns ...
4089 Explicitly specify that permissions are delegated to the group.
4093 only for the specified file system.
4094 .It Fl u Ar user Ns Oo , Ns Ar user Oc Ns ...
4095 Explicitly specify that permissions are delegated to the user.
4096 .It Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
4097 Specifies to whom the permissions are delegated.
4098 Multiple entities can be specified as a comma-separated list.
4101 options are specified, then the argument is interpreted preferentially as the
4104 then as a user name, and lastly as a group name.
4105 To specify a user or group named
4112 To specify a group with the same name as a user, use the
4116 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4117 .Ar setname Oc Ns ...
4119 The permissions to delegate.
4120 Multiple permissions may be specified as a comma-separated list.
4121 Permission names are the same as ZFS subcommand and property names.
4122 See the property list below.
4123 Property set names, which begin with
4128 form below for details.
4133 options are specified, or both are, then the permissions are allowed for the
4134 file system or volume, and all of its descendents.
4136 Permissions are generally the ability to use a ZFS subcommand or change a ZFS
4138 The following permissions are available:
4141 allow subcommand Must also have the permission that is
4143 clone subcommand Must also have the 'create' ability and
4144 'mount' ability in the origin file system
4145 create subcommand Must also have the 'mount' ability
4146 destroy subcommand Must also have the 'mount' ability
4147 diff subcommand Allows lookup of paths within a dataset
4148 given an object number, and the ability
4149 to create snapshots necessary to
4151 load-key subcommand Allows loading and unloading of encryption key
4152 (see 'zfs load-key' and 'zfs unload-key').
4153 change-key subcommand Allows changing an encryption key via
4155 mount subcommand Allows mount/umount of ZFS datasets
4156 promote subcommand Must also have the 'mount' and 'promote'
4157 ability in the origin file system
4158 receive subcommand Must also have the 'mount' and 'create'
4160 rename subcommand Must also have the 'mount' and 'create'
4161 ability in the new parent
4162 rollback subcommand Must also have the 'mount' ability
4164 share subcommand Allows sharing file systems over NFS
4166 snapshot subcommand Must also have the 'mount' ability
4168 groupquota other Allows accessing any groupquota@...
4170 groupused other Allows reading any groupused@... property
4171 userprop other Allows changing any user property
4172 userquota other Allows accessing any userquota@...
4174 userused other Allows reading any userused@... property
4175 projectobjquota other Allows accessing any projectobjquota@...
4177 projectquota other Allows accessing any projectquota@... property
4178 projectobjused other Allows reading any projectobjused@... property
4179 projectused other Allows reading any projectused@... property
4185 casesensitivity property
4187 compression property
4191 filesystem_limit property
4194 normalization property
4195 primarycache property
4200 refreservation property
4201 reservation property
4202 secondarycache property
4207 snapshot_limit property
4210 volblocksize property
4220 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4221 .Ar setname Oc Ns ...
4222 .Ar filesystem Ns | Ns Ar volume
4227 These permissions are granted
4229 to the creator of any newly-created descendent file system.
4233 .Fl s No @ Ns Ar setname
4234 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4235 .Ar setname Oc Ns ...
4236 .Ar filesystem Ns | Ns Ar volume
4238 Defines or adds permissions to a permission set.
4239 The set can be used by other
4241 commands for the specified file system and its descendents.
4242 Sets are evaluated dynamically, so changes to a set are immediately reflected.
4243 Permission sets follow the same naming restrictions as ZFS file systems, but the
4244 name must begin with
4246 and can be no more than 64 characters long.
4251 .Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
4252 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4253 .Ar setname Oc Ns ... Oc
4254 .Ar filesystem Ns | Ns Ar volume
4260 .Fl e Ns | Ns Sy everyone
4261 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4262 .Ar setname Oc Ns ... Oc
4263 .Ar filesystem Ns | Ns Ar volume
4270 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4271 .Ar setname Oc Ns ... Oc
4272 .Ar filesystem Ns | Ns Ar volume
4274 Removes permissions that were granted with the
4277 No permissions are explicitly denied, so other permissions granted are still in
4279 For example, if the permission is granted by an ancestor.
4280 If no permissions are specified, then all permissions for the specified
4292 only removes the permissions that were granted to everyone, not all permissions
4293 for every user and group.
4296 command for a description of the
4299 .Bl -tag -width "-r"
4301 Recursively remove the permissions from this file system and all descendents.
4307 .Fl s No @ Ns Ar setname
4308 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4309 .Ar setname Oc Ns ... Oc
4310 .Ar filesystem Ns | Ns Ar volume
4312 Removes permissions from a permission set.
4313 If no permissions are specified, then all permissions are removed, thus removing
4319 .Ar tag Ar snapshot Ns ...
4321 Adds a single reference, named with the
4323 argument, to the specified snapshot or snapshots.
4324 Each snapshot has its own tag namespace, and tags must be unique within that
4327 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
4331 .Bl -tag -width "-r"
4333 Specifies that a hold with the given tag is applied recursively to the snapshots
4334 of all descendent file systems.
4342 Lists all existing user references for the given snapshot or snapshots.
4343 .Bl -tag -width "-r"
4345 Lists the holds that are set on the named descendent snapshots, in addition to
4346 listing the holds on the named snapshot.
4348 Do not print headers, use tab-delimited output.
4354 .Ar tag Ar snapshot Ns ...
4356 Removes a single reference, named with the
4358 argument, from the specified snapshot or snapshots.
4359 The tag must already exist for each snapshot.
4360 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
4364 .Bl -tag -width "-r"
4366 Recursively releases a hold with the given tag on the snapshots of all
4367 descendent file systems.
4373 .Ar snapshot Ar snapshot Ns | Ns Ar filesystem
4375 Display the difference between a snapshot of a given filesystem and another
4376 snapshot of that filesystem from a later time or the current contents of the
4378 The first column is a character indicating the type of change, the other columns
4379 indicate pathname, new pathname
4380 .Pq in case of rename ,
4381 change in link count, and optionally file type and/or change time.
4382 The types of change are:
4384 - The path has been removed
4385 + The path has been created
4386 M The path has been modified
4387 R The path has been renamed
4389 .Bl -tag -width "-F"
4391 Display an indication of the type of file, in a manner similar to the
4407 Give more parsable tab-separated output, without header lines and without
4410 Display the path's inode change time as the first column of output.
4416 .Op Fl t Ar instruction-limit
4417 .Op Fl m Ar memory-limit
4423 as a ZFS channel program on
4426 program interface allows ZFS administrative operations to be run
4427 programmatically via a Lua script.
4428 The entire script is executed atomically, with no other administrative
4429 operations taking effect concurrently.
4430 A library of ZFS calls is made available to channel program scripts.
4431 Channel programs may only be run with root privileges.
4433 For full documentation of the ZFS channel program interface, see the manual
4438 Display channel program output in JSON format. When this flag is specified and
4439 standard output is empty - channel program encountered an error. The details of
4440 such an error will be printed to standard error in plain text.
4442 Executes a read-only channel program, which runs faster.
4443 The program cannot change on-disk state by calling functions from
4444 the zfs.sync submodule.
4445 The program can be used to gather information such as properties and
4446 determining if changes would succeed (zfs.check.*).
4447 Without this flag, all pending changes must be synced to disk before
4448 a channel program can complete.
4449 .It Fl t Ar instruction-limit
4450 Limit the number of Lua instructions to execute.
4451 If a channel program executes more than the specified number of instructions,
4452 it will be stopped and an error will be returned.
4453 The default limit is 10 million instructions, and it can be set to a maximum of
4454 100 million instructions.
4455 .It Fl m Ar memory-limit
4456 Memory limit, in bytes.
4457 If a channel program attempts to allocate more memory than the given limit,
4458 it will be stopped and an error returned.
4459 The default memory limit is 10 MB, and can be set to a maximum of 100 MB.
4461 All remaining argument strings are passed directly to the channel program as
4465 for more information.
4471 .Op Fl L Ar keylocation
4472 .Fl a | Ar filesystem
4476 allowing it and all children that inherit the
4478 property to be accessed. The key will be expected in the format specified by the
4480 and location specified by the
4482 property. Note that if the
4486 the terminal will interactively wait for the key to be entered. Loading a key
4487 will not automatically mount the dataset. If that functionality is desired,
4488 .Nm zfs Cm mount Sy -l
4489 will ask for the key and mount the dataset. Once the key is loaded the
4491 property will become
4493 .Bl -tag -width "-r"
4495 Recursively loads the keys for the specified filesystem and all descendent
4498 Loads the keys for all encryption roots in all imported pools.
4502 load-key. This will cause zfs to simply check that the
4503 provided key is correct. This command may be run even if the key is already
4505 .It Fl L Ar keylocation
4510 property. This will not change the value of the property on the dataset. Note
4511 that if used with either
4516 may only be given as
4523 .Fl a | Ar filesystem
4525 Unloads a key from ZFS, removing the ability to access the dataset and all of
4526 its children that inherit the
4528 property. This requires that the dataset is not currently open or mounted. Once
4529 the key is unloaded the
4531 property will become
4533 .Bl -tag -width "-r"
4535 Recursively unloads the keys for the specified filesystem and all descendent
4538 Unloads the keys for all encryption roots in all imported pools.
4544 .Op Fl o Ar keylocation Ns = Ns Ar value
4545 .Op Fl o Ar keyformat Ns = Ns Ar value
4546 .Op Fl o Ar pbkdf2iters Ns = Ns Ar value
4556 Allows a user to change the encryption key used to access a dataset. This
4557 command requires that the existing key for the dataset is already loaded into
4558 ZFS. This command may also be used to change the
4563 properties as needed. If the dataset was not previously an encryption root it
4564 will become one. Alternatively, the
4566 flag may be provided to cause an encryption root to inherit the parent's key
4568 .Bl -tag -width "-r"
4570 Ensures the key is loaded before attempting to change the key. This is
4571 effectively equivalent to
4572 .Qq Nm zfs Cm load-key Ar filesystem ; Nm zfs Cm change-key Ar filesystem
4573 .It Fl o Ar property Ns = Ns Ar value
4574 Allows the user to set encryption key properties (
4579 ) while changing the key. This is the only way to alter
4583 after the dataset has been created.
4585 Indicates that zfs should make
4587 inherit the key of its parent. Note that this command can only be run on an
4588 encryption root that has an encrypted parent.
4594 utility exits 0 on success, 1 if an error occurs, and 2 if invalid command line
4595 options were specified.
4598 .It Sy Example 1 No Creating a ZFS File System Hierarchy
4599 The following commands create a file system named
4601 and a file system named
4605 is set for the parent file system, and is automatically inherited by the child
4608 # zfs create pool/home
4609 # zfs set mountpoint=/export/home pool/home
4610 # zfs create pool/home/bob
4612 .It Sy Example 2 No Creating a ZFS Snapshot
4613 The following command creates a snapshot named
4615 This snapshot is mounted on demand in the
4617 directory at the root of the
4621 # zfs snapshot pool/home/bob@yesterday
4623 .It Sy Example 3 No Creating and Destroying Multiple Snapshots
4624 The following command creates snapshots named
4628 and all of its descendent file systems.
4629 Each snapshot is mounted on demand in the
4631 directory at the root of its file system.
4632 The second command destroys the newly created snapshots.
4634 # zfs snapshot -r pool/home@yesterday
4635 # zfs destroy -r pool/home@yesterday
4637 .It Sy Example 4 No Disabling and Enabling File System Compression
4638 The following command disables the
4640 property for all file systems under
4642 The next command explicitly enables
4645 .Em pool/home/anne .
4647 # zfs set compression=off pool/home
4648 # zfs set compression=on pool/home/anne
4650 .It Sy Example 5 No Listing ZFS Datasets
4651 The following command lists all active file systems and volumes in the system.
4652 Snapshots are displayed if the
4660 for more information on pool properties.
4663 NAME USED AVAIL REFER MOUNTPOINT
4664 pool 450K 457G 18K /pool
4665 pool/home 315K 457G 21K /export/home
4666 pool/home/anne 18K 457G 18K /export/home/anne
4667 pool/home/bob 276K 457G 276K /export/home/bob
4669 .It Sy Example 6 No Setting a Quota on a ZFS File System
4670 The following command sets a quota of 50 Gbytes for
4673 # zfs set quota=50G pool/home/bob
4675 .It Sy Example 7 No Listing ZFS Properties
4676 The following command lists all properties for
4679 # zfs get all pool/home/bob
4680 NAME PROPERTY VALUE SOURCE
4681 pool/home/bob type filesystem -
4682 pool/home/bob creation Tue Jul 21 15:53 2009 -
4683 pool/home/bob used 21K -
4684 pool/home/bob available 20.0G -
4685 pool/home/bob referenced 21K -
4686 pool/home/bob compressratio 1.00x -
4687 pool/home/bob mounted yes -
4688 pool/home/bob quota 20G local
4689 pool/home/bob reservation none default
4690 pool/home/bob recordsize 128K default
4691 pool/home/bob mountpoint /pool/home/bob default
4692 pool/home/bob sharenfs off default
4693 pool/home/bob checksum on default
4694 pool/home/bob compression on local
4695 pool/home/bob atime on default
4696 pool/home/bob devices on default
4697 pool/home/bob exec on default
4698 pool/home/bob setuid on default
4699 pool/home/bob readonly off default
4700 pool/home/bob zoned off default
4701 pool/home/bob snapdir hidden default
4702 pool/home/bob acltype off default
4703 pool/home/bob aclinherit restricted default
4704 pool/home/bob canmount on default
4705 pool/home/bob xattr on default
4706 pool/home/bob copies 1 default
4707 pool/home/bob version 4 -
4708 pool/home/bob utf8only off -
4709 pool/home/bob normalization none -
4710 pool/home/bob casesensitivity sensitive -
4711 pool/home/bob vscan off default
4712 pool/home/bob nbmand off default
4713 pool/home/bob sharesmb off default
4714 pool/home/bob refquota none default
4715 pool/home/bob refreservation none default
4716 pool/home/bob primarycache all default
4717 pool/home/bob secondarycache all default
4718 pool/home/bob usedbysnapshots 0 -
4719 pool/home/bob usedbydataset 21K -
4720 pool/home/bob usedbychildren 0 -
4721 pool/home/bob usedbyrefreservation 0 -
4724 The following command gets a single property value.
4726 # zfs get -H -o value compression pool/home/bob
4729 The following command lists all properties with local settings for
4732 # zfs get -r -s local -o name,property,value all pool/home/bob
4734 pool/home/bob quota 20G
4735 pool/home/bob compression on
4737 .It Sy Example 8 No Rolling Back a ZFS File System
4738 The following command reverts the contents of
4740 to the snapshot named
4742 deleting all intermediate snapshots.
4744 # zfs rollback -r pool/home/anne@yesterday
4746 .It Sy Example 9 No Creating a ZFS Clone
4747 The following command creates a writable file system whose initial contents are
4749 .Em pool/home/bob@yesterday .
4751 # zfs clone pool/home/bob@yesterday pool/clone
4753 .It Sy Example 10 No Promoting a ZFS Clone
4754 The following commands illustrate how to test out changes to a file system, and
4755 then replace the original file system with the changed one, using clones, clone
4756 promotion, and renaming:
4758 # zfs create pool/project/production
4759 populate /pool/project/production with data
4760 # zfs snapshot pool/project/production@today
4761 # zfs clone pool/project/production@today pool/project/beta
4762 make changes to /pool/project/beta and test them
4763 # zfs promote pool/project/beta
4764 # zfs rename pool/project/production pool/project/legacy
4765 # zfs rename pool/project/beta pool/project/production
4766 once the legacy version is no longer needed, it can be destroyed
4767 # zfs destroy pool/project/legacy
4769 .It Sy Example 11 No Inheriting ZFS Properties
4770 The following command causes
4776 property from their parent.
4778 # zfs inherit checksum pool/home/bob pool/home/anne
4780 .It Sy Example 12 No Remotely Replicating ZFS Data
4781 The following commands send a full stream and then an incremental stream to a
4782 remote machine, restoring them into
4783 .Em poolB/received/fs@a
4785 .Em poolB/received/fs@b ,
4788 must contain the file system
4789 .Em poolB/received ,
4790 and must not initially contain
4791 .Em poolB/received/fs .
4793 # zfs send pool/fs@a | \e
4794 ssh host zfs receive poolB/received/fs@a
4795 # zfs send -i a pool/fs@b | \e
4796 ssh host zfs receive poolB/received/fs
4798 .It Sy Example 13 No Using the zfs receive -d Option
4799 The following command sends a full stream of
4800 .Em poolA/fsA/fsB@snap
4801 to a remote machine, receiving it into
4802 .Em poolB/received/fsA/fsB@snap .
4805 portion of the received snapshot's name is determined from the name of the sent
4808 must contain the file system
4809 .Em poolB/received .
4811 .Em poolB/received/fsA
4812 does not exist, it is created as an empty file system.
4814 # zfs send poolA/fsA/fsB@snap | \e
4815 ssh host zfs receive -d poolB/received
4817 .It Sy Example 14 No Setting User Properties
4818 The following example sets the user-defined
4819 .Sy com.example:department
4820 property for a dataset.
4822 # zfs set com.example:department=12345 tank/accounting
4824 .It Sy Example 15 No Performing a Rolling Snapshot
4825 The following example shows how to maintain a history of snapshots with a
4826 consistent naming scheme.
4827 To keep a week's worth of snapshots, the user destroys the oldest snapshot,
4828 renames the remaining snapshots, and then creates a new snapshot, as follows:
4830 # zfs destroy -r pool/users@7daysago
4831 # zfs rename -r pool/users@6daysago @7daysago
4832 # zfs rename -r pool/users@5daysago @6daysago
4833 # zfs rename -r pool/users@4daysago @5daysago
4834 # zfs rename -r pool/users@3daysago @4daysago
4835 # zfs rename -r pool/users@2daysago @3daysago
4836 # zfs rename -r pool/users@yesterday @2daysago
4837 # zfs rename -r pool/users@today @yesterday
4838 # zfs snapshot -r pool/users@today
4840 .It Sy Example 16 No Setting sharenfs Property Options on a ZFS File System
4841 The following commands show how to set
4843 property options to enable
4847 addresses and to enable root access for system
4853 # zfs set sharenfs='rw=@123.123.0.0/16,root=neo' tank/home
4858 for host name resolution, specify the fully qualified hostname.
4859 .It Sy Example 17 No Delegating ZFS Administration Permissions on a ZFS Dataset
4860 The following example shows how to set permissions so that user
4862 can create, destroy, mount, and take snapshots on
4868 # zfs allow cindys create,destroy,mount,snapshot tank/cindys
4869 # zfs allow tank/cindys
4870 ---- Permissions on tank/cindys --------------------------------------
4871 Local+Descendent permissions:
4872 user cindys create,destroy,mount,snapshot
4877 mount point permission is set to 755 by default, user
4879 will be unable to mount file systems under
4881 Add an ACE similar to the following syntax to provide mount point access:
4883 # chmod A+user:cindys:add_subdirectory:allow /tank/cindys
4885 .It Sy Example 18 No Delegating Create Time Permissions on a ZFS Dataset
4886 The following example shows how to grant anyone in the group
4888 to create file systems in
4890 This syntax also allows staff members to destroy their own file systems, but not
4891 destroy anyone else's file system.
4896 # zfs allow staff create,mount tank/users
4897 # zfs allow -c destroy tank/users
4898 # zfs allow tank/users
4899 ---- Permissions on tank/users ---------------------------------------
4902 Local+Descendent permissions:
4903 group staff create,mount
4905 .It Sy Example 19 No Defining and Granting a Permission Set on a ZFS Dataset
4906 The following example shows how to define and grant a permission set on the
4913 # zfs allow -s @pset create,destroy,snapshot,mount tank/users
4914 # zfs allow staff @pset tank/users
4915 # zfs allow tank/users
4916 ---- Permissions on tank/users ---------------------------------------
4918 @pset create,destroy,mount,snapshot
4919 Local+Descendent permissions:
4922 .It Sy Example 20 No Delegating Property Permissions on a ZFS Dataset
4923 The following example shows to grant the ability to set quotas and reservations
4931 # zfs allow cindys quota,reservation users/home
4932 # zfs allow users/home
4933 ---- Permissions on users/home ---------------------------------------
4934 Local+Descendent permissions:
4935 user cindys quota,reservation
4936 cindys% zfs set quota=10G users/home/marks
4937 cindys% zfs get quota users/home/marks
4938 NAME PROPERTY VALUE SOURCE
4939 users/home/marks quota 10G local
4941 .It Sy Example 21 No Removing ZFS Delegated Permissions on a ZFS Dataset
4942 The following example shows how to remove the snapshot permission from the
4951 # zfs unallow staff snapshot tank/users
4952 # zfs allow tank/users
4953 ---- Permissions on tank/users ---------------------------------------
4955 @pset create,destroy,mount,snapshot
4956 Local+Descendent permissions:
4959 .It Sy Example 22 No Showing the differences between a snapshot and a ZFS Dataset
4960 The following example shows how to see what has changed between a prior
4961 snapshot of a ZFS dataset and its current state.
4964 option is used to indicate type information for the files affected.
4966 # zfs diff -F tank/test@before tank/test
4968 M F /tank/test/linked (+1)
4969 R F /tank/test/oldname -> /tank/test/newname
4970 - F /tank/test/deleted
4971 + F /tank/test/created
4972 M F /tank/test/modified
4974 .It Sy Example 23 No Creating a bookmark
4975 The following example create a bookmark to a snapshot. This bookmark
4976 can then be used instead of snapshot in send streams.
4978 # zfs bookmark rpool@snapshot rpool#bookmark
4980 .It Sy Example 24 No Setting sharesmb Property Options on a ZFS File System
4981 The following example show how to share SMB filesystem through ZFS. Note that
4982 that a user and his/her password must be given.
4984 # smbmount //127.0.0.1/share_tmp /mnt/tmp \\
4985 -o user=workgroup/turbo,password=obrut,uid=1000
4989 .Em /etc/samba/smb.conf
4990 configuration required:
4992 Samba will need to listen to 'localhost' (127.0.0.1) for the ZFS utilities to
4993 communicate with Samba. This is the default behavior for most Linux
4996 Samba must be able to authenticate a user. This can be done in a number of
4997 ways, depending on if using the system password file, LDAP or the Samba
4998 specific smbpasswd file. How to do this is outside the scope of this manual.
5001 man page for more information.
5004 .Sy USERSHARE section
5007 man page for all configuration options in case you need to modify any options
5008 to the share afterwards. Do note that any changes done with the
5010 command will be undone if the share is ever unshared (such as at a reboot etc).
5012 .Sh INTERFACE STABILITY
projects / mirror_zfs.git / blob