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, 2017 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
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 .Sy context Ns = Ns Sy none Ns | Ns
1280 .Em SELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level
1282 This flag sets the SELinux context for all files in the file system under
1283 a mount point for that file system. See
1285 for more information.
1287 .Sy fscontext Ns = Ns Sy none Ns | Ns
1288 .Em SELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level
1290 This flag sets the SELinux context for the file system file system being
1293 for more information.
1295 .Sy defcontext Ns = Ns Sy none Ns | Ns
1296 .Em SELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level
1298 This flag sets the SELinux default context for unlabeled files. See
1300 for more information.
1302 .Sy rootcontext Ns = Ns Sy none Ns | Ns
1303 .Em SELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level
1305 This flag sets the SELinux context for the root inode of the file system. See
1307 for more information.
1308 .It Sy copies Ns = Ns Sy 1 Ns | Ns Sy 2 Ns | Ns Sy 3
1309 Controls the number of copies of data stored for this dataset.
1310 These copies are in addition to any redundancy provided by the pool, for
1311 example, mirroring or RAID-Z.
1312 The copies are stored on different disks, if possible.
1313 The space used by multiple copies is charged to the associated file and dataset,
1316 property and counting against quotas and reservations.
1318 Changing this property only affects newly-written data.
1319 Therefore, set this property at file system creation time by using the
1320 .Fl o Sy copies Ns = Ns Ar N
1323 Remember that ZFS will not import a pool with a missing top-level vdev. Do
1325 create, for example a two-disk striped pool and set
1327 on some datasets thinking you have setup redundancy for them. When a disk
1328 fails you will not be able to import the pool and will have lost all of your
1330 .It Sy devices Ns = Ns Sy on Ns | Ns Sy off
1331 Controls whether device nodes can be opened on this file system.
1332 The default value is
1338 are equivalent to the
1344 .Sy dedup Ns = Ns Sy off Ns | Ns Sy on Ns | Ns Sy verify Ns | Ns
1345 .Sy sha256[,verify] Ns | Ns Sy sha512[,verify] Ns | Ns Sy skein[,verify] Ns | Ns
1348 Configures deduplication for a dataset. The default value is
1350 The default deduplication checksum is
1352 (this may change in the future). When
1354 is enabled, the checksum defined here overrides the
1356 property. Setting the value to
1358 has the same effect as the setting
1363 ZFS will do a byte-to-byte comparsion in case of two blocks having the same
1364 signature to make sure the block contents are identical. Specifying
1366 is mandatory for the
1370 Unless necessary, deduplication should NOT be enabled on a system. See
1374 .Sy dnodesize Ns = Ns Sy legacy Ns | Ns Sy auto Ns | Ns Sy 1k Ns | Ns
1375 .Sy 2k Ns | Ns Sy 4k Ns | Ns Sy 8k Ns | Ns Sy 16k
1377 Specifies a compatibility mode or literal value for the size of dnodes in the
1378 file system. The default value is
1380 Setting this property to a value other than
1382 requires the large_dnode pool feature to be enabled.
1388 if the dataset uses the
1390 property setting and the workload makes heavy use of extended attributes. This
1391 may be applicable to SELinux-enabled systems, Lustre servers, and Samba
1392 servers, for example. Literal values are supported for cases where the optimal
1393 size is known in advance and for performance testing.
1399 if you need to receive a send stream of this dataset on a pool that doesn't
1400 enable the large_dnode feature, or if you need to import this pool on a system
1401 that doesn't support the large_dnode feature.
1403 This property can also be referred to by its shortened column name,
1406 .Sy encryption Ns = Ns Sy off Ns | Ns Sy on Ns | Ns Sy aes-128-ccm Ns | Ns
1407 .Sy aes-192-ccm Ns | Ns Sy aes-256-ccm Ns | Ns Sy aes-128-gcm Ns | Ns
1408 .Sy aes-192-gcm Ns | Ns Sy aes-256-gcm
1410 Controls the encryption cipher suite (block cipher, key length, and mode) used
1411 for this dataset. Requires the
1413 feature to be enabled on the pool.
1416 to be set at dataset creation time.
1419 .Sy encryption Ns = Ns Sy on
1420 when creating a dataset indicates that the default encryption suite will be
1421 selected, which is currently
1423 In order to provide consistent data protection, encryption must be specified at
1424 dataset creation time and it cannot be changed afterwards.
1426 For more details and caveats about encryption see the
1429 .It Sy keyformat Ns = Ns Sy raw Ns | Ns Sy hex Ns | Ns Sy passphrase
1430 Controls what format the user's encryption key will be provided as. This
1431 property is only set when the dataset is encrypted.
1433 Raw keys and hex keys must be 32 bytes long (regardless of the chosen
1434 encryption suite) and must be randomly generated. A raw key can be generated
1435 with the following command:
1437 # dd if=/dev/urandom of=/path/to/output/key bs=32 count=1
1440 Passphrases must be between 8 and 512 bytes long and will be processed through
1441 PBKDF2 before being used (see the
1443 property). Even though the
1444 encryption suite cannot be changed after dataset creation, the keyformat can be
1446 .Nm zfs Cm change-key .
1448 .Sy keylocation Ns = Ns Sy prompt Ns | Ns Sy file:// Ns Em </absolute/file/path>
1450 Controls where the user's encryption key will be loaded from by default for
1454 .Nm zfs Cm mount Cm -l .
1455 This property is only set for encrypted datasets which are encryption roots. If
1456 unspecified, the default is
1459 Even though the encryption suite cannot be changed after dataset creation, the
1460 keylocation can be with either
1463 .Nm zfs Cm change-key .
1466 is selected ZFS will ask for the key at the command prompt when it is required
1467 to access the encrypted data (see
1469 for details). This setting will also allow the key to be passed in via STDIN,
1470 but users should be careful not to place keys which should be kept secret on
1471 the command line. If a file URI is selected, the key will be loaded from the
1472 specified absolute file path.
1473 .It Sy pbkdf2iters Ns = Ns Ar iterations
1474 Controls the number of PBKDF2 iterations that a
1476 encryption key should be run through when processing it into an encryption key.
1477 This property is only defined when encryption is enabled and a keyformat of
1479 is selected. The goal of PBKDF2 is to significantly increase the
1480 computational difficulty needed to brute force a user's passphrase. This is
1481 accomplished by forcing the attacker to run each passphrase through a
1482 computationally expensive hashing function many times before they arrive at the
1483 resulting key. A user who actually knows the passphrase will only have to pay
1484 this cost once. As CPUs become better at processing, this number should be
1485 raised to ensure that a brute force attack is still not possible. The current
1490 This property may be changed with
1491 .Nm zfs Cm change-key .
1492 .It Sy exec Ns = Ns Sy on Ns | Ns Sy off
1493 Controls whether processes can be executed from within this file system.
1494 The default value is
1500 are equivalent to the
1505 .It Sy filesystem_limit Ns = Ns Em count Ns | Ns Sy none
1506 Limits the number of filesystems and volumes that can exist under this point in
1508 The limit is not enforced if the user is allowed to change the limit.
1510 .Sy filesystem_limit
1513 a descendent of a filesystem that already has a
1514 .Sy filesystem_limit
1515 does not override the ancestor's
1516 .Sy filesystem_limit ,
1517 but rather imposes an additional limit.
1518 This feature must be enabled to be used
1520 .Xr zpool-features 5
1522 .It Sy special_small_blocks Ns = Ns Em size
1523 This value represents the threshold block size for including small file
1524 blocks into the special allocation class. Blocks smaller than or equal to this
1525 value will be assigned to the special allocation class while greater blocks
1526 will be assigned to the regular class. Valid values are zero or a power of two
1527 from 512B up to 128K. The default size is 0 which means no small file blocks
1528 will be allocated in the special class.
1530 Before setting this property, a special class vdev must be added to the
1533 for more details on the special allocation class.
1534 .It Sy mountpoint Ns = Ns Pa path Ns | Ns Sy none Ns | Ns Sy legacy
1535 Controls the mount point used for this file system.
1538 section for more information on how this property is used.
1542 property is changed for a file system, the file system and any children that
1543 inherit the mount point are unmounted.
1546 then they remain unmounted.
1547 Otherwise, they are automatically remounted in the new location if the property
1552 or if they were mounted before the property was changed.
1553 In addition, any shared file systems are unshared and shared in the new
1555 .It Sy nbmand Ns = Ns Sy on Ns | Ns Sy off
1556 Controls whether the file system should be mounted with
1558 .Pq Non Blocking mandatory locks .
1559 This is used for SMB clients.
1560 Changes to this property only take effect when the file system is umounted and
1564 for more information on
1566 mounts. This property is not used on Linux.
1567 .It Sy overlay Ns = Ns Sy off Ns | Ns Sy on
1568 Allow mounting on a busy directory or a directory which already contains
1569 files or directories. This is the default mount behavior for Linux file systems.
1570 For consistency with OpenZFS on other platforms overlay mounts are
1574 to enable overlay mounts.
1575 .It Sy primarycache Ns = Ns Sy all Ns | Ns Sy none Ns | Ns Sy metadata
1576 Controls what is cached in the primary cache
1578 If this property is set to
1580 then both user data and metadata is cached.
1581 If this property is set to
1583 then neither user data nor metadata is cached.
1584 If this property is set to
1586 then only metadata is cached.
1587 The default value is
1589 .It Sy quota Ns = Ns Em size Ns | Ns Sy none
1590 Limits the amount of space a dataset and its descendents can consume.
1591 This property enforces a hard limit on the amount of space used.
1592 This includes all space consumed by descendents, including file systems and
1594 Setting a quota on a descendent of a dataset that already has a quota does not
1595 override the ancestor's quota, but rather imposes an additional limit.
1597 Quotas cannot be set on volumes, as the
1599 property acts as an implicit quota.
1600 .It Sy snapshot_limit Ns = Ns Em count Ns | Ns Sy none
1601 Limits the number of snapshots that can be created on a dataset and its
1605 on a descendent of a dataset that already has a
1607 does not override the ancestor's
1608 .Sy snapshot_limit ,
1609 but rather imposes an additional limit.
1610 The limit is not enforced if the user is allowed to change the limit.
1611 For example, this means that recursive snapshots taken from the global zone are
1612 counted against each delegated dataset within a zone.
1613 This feature must be enabled to be used
1615 .Xr zpool-features 5
1617 .It Sy userquota@ Ns Em user Ns = Ns Em size Ns | Ns Sy none
1618 Limits the amount of space consumed by the specified user.
1619 User space consumption is identified by the
1620 .Sy userspace@ Ns Em user
1623 Enforcement of user quotas may be delayed by several seconds.
1624 This delay means that a user might exceed their quota before the system notices
1625 that they are over quota and begins to refuse additional writes with the
1629 .Nm zfs Cm userspace
1630 subcommand for more information.
1632 Unprivileged users can only access their own groups' space usage.
1633 The root user, or a user who has been granted the
1637 can get and set everyone's quota.
1639 This property is not available on volumes, on file systems before version 4, or
1640 on pools before version 15.
1642 .Sy userquota@ Ns Em ...
1643 properties are not displayed by
1644 .Nm zfs Cm get Sy all .
1645 The user's name must be appended after the
1647 symbol, using one of the following forms:
1655 .Em POSIX numeric ID
1662 .Sy joe.smith@mydomain
1671 Files created on Linux always have POSIX owners.
1672 .It Sy userobjquota@ Ns Em user Ns = Ns Em size Ns | Ns Sy none
1677 but it limits the number of objects a user can create. Please refer to
1679 for more information about how objects are counted.
1680 .It Sy groupquota@ Ns Em group Ns = Ns Em size Ns | Ns Sy none
1681 Limits the amount of space consumed by the specified group.
1682 Group space consumption is identified by the
1683 .Sy groupused@ Ns Em group
1686 Unprivileged users can access only their own groups' space usage.
1687 The root user, or a user who has been granted the
1691 can get and set all groups' quotas.
1692 .It Sy groupobjquota@ Ns Em group Ns = Ns Em size Ns | Ns Sy none
1697 but it limits number of objects a group can consume. Please refer to
1699 for more information about how objects are counted.
1700 .It Sy projectquota@ Ns Em project Ns = Ns Em size Ns | Ns Sy none
1701 Limits the amount of space consumed by the specified project. Project
1702 space consumption is identified by the
1703 .Sy projectused@ Ns Em project
1704 property. Please refer to
1706 for more information about how project is identified and set/changed.
1708 The root user, or a user who has been granted the
1712 can access all projects' quota.
1713 .It Sy projectobjquota@ Ns Em project Ns = Ns Em size Ns | Ns Sy none
1718 but it limits number of objects a project can consume. Please refer to
1720 for more information about how objects are counted.
1721 .It Sy readonly Ns = Ns Sy on Ns | Ns Sy off
1722 Controls whether this dataset can be modified.
1723 The default value is
1729 are equivalent to the
1735 This property can also be referred to by its shortened column name,
1737 .It Sy recordsize Ns = Ns Em size
1738 Specifies a suggested block size for files in the file system.
1739 This property is designed solely for use with database workloads that access
1740 files in fixed-size records.
1741 ZFS automatically tunes block sizes according to internal algorithms optimized
1742 for typical access patterns.
1744 For databases that create very large files but access them in small random
1745 chunks, these algorithms may be suboptimal.
1748 greater than or equal to the record size of the database can result in
1749 significant performance gains.
1750 Use of this property for general purpose file systems is strongly discouraged,
1751 and may adversely affect performance.
1753 The size specified must be a power of two greater than or equal to 512 and less
1754 than or equal to 128 Kbytes.
1757 feature is enabled on the pool, the size may be up to 1 Mbyte.
1759 .Xr zpool-features 5
1760 for details on ZFS feature flags.
1762 Changing the file system's
1764 affects only files created afterward; existing files are unaffected.
1766 This property can also be referred to by its shortened column name,
1768 .It Sy redundant_metadata Ns = Ns Sy all Ns | Ns Sy most
1769 Controls what types of metadata are stored redundantly.
1770 ZFS stores an extra copy of metadata, so that if a single block is corrupted,
1771 the amount of user data lost is limited.
1772 This extra copy is in addition to any redundancy provided at the pool level
1773 .Pq e.g. by mirroring or RAID-Z ,
1774 and is in addition to an extra copy specified by the
1777 .Pq up to a total of 3 copies .
1778 For example if the pool is mirrored,
1779 .Sy copies Ns = Ns 2 ,
1781 .Sy redundant_metadata Ns = Ns Sy most ,
1782 then ZFS stores 6 copies of most metadata, and 4 copies of data and some
1787 ZFS stores an extra copy of all metadata.
1788 If a single on-disk block is corrupt, at worst a single block of user data
1797 ZFS stores an extra copy of most types of metadata.
1798 This can improve performance of random writes, because less metadata must be
1800 In practice, at worst about 100 blocks
1805 of user data can be lost if a single on-disk block is corrupt.
1806 The exact behavior of which metadata blocks are stored redundantly may change in
1809 The default value is
1811 .It Sy refquota Ns = Ns Em size Ns | Ns Sy none
1812 Limits the amount of space a dataset can consume.
1813 This property enforces a hard limit on the amount of space used.
1814 This hard limit does not include space used by descendents, including file
1815 systems and snapshots.
1816 .It Sy refreservation Ns = Ns Em size Ns | Ns Sy none Ns | Ns Sy auto
1817 The minimum amount of space guaranteed to a dataset, not including its
1819 When the amount of space used is below this value, the dataset is treated as if
1820 it were taking up the amount of space specified by
1821 .Sy refreservation .
1824 reservation is accounted for in the parent datasets' space used, and counts
1825 against the parent datasets' quotas and reservations.
1829 is set, a snapshot is only allowed if there is enough free pool space outside of
1830 this reservation to accommodate the current number of
1832 bytes in the dataset.
1838 a volume is thick provisioned
1842 .Sy refreservation Ns = Ns Sy auto
1843 is only supported on volumes.
1847 .Sx Native Properties
1848 section for more information about sparse volumes.
1850 This property can also be referred to by its shortened column name,
1852 .It Sy relatime Ns = Ns Sy on Ns | Ns Sy off
1853 Controls the manner in which the access time is updated when
1855 is set. Turning this property on causes the access time to be updated relative
1856 to the modify or change time. Access time is only updated if the previous
1857 access time was earlier than the current modify or change time or if the
1858 existing access time hasn't been updated within the past 24 hours. The default
1865 are equivalent to the
1870 .It Sy reservation Ns = Ns Em size Ns | Ns Sy none
1871 The minimum amount of space guaranteed to a dataset and its descendants.
1872 When the amount of space used is below this value, the dataset is treated as if
1873 it were taking up the amount of space specified by its reservation.
1874 Reservations are accounted for in the parent datasets' space used, and count
1875 against the parent datasets' quotas and reservations.
1877 This property can also be referred to by its shortened column name,
1879 .It Sy secondarycache Ns = Ns Sy all Ns | Ns Sy none Ns | Ns Sy metadata
1880 Controls what is cached in the secondary cache
1882 If this property is set to
1884 then both user data and metadata is cached.
1885 If this property is set to
1887 then neither user data nor metadata is cached.
1888 If this property is set to
1890 then only metadata is cached.
1891 The default value is
1893 .It Sy setuid Ns = Ns Sy on Ns | Ns Sy off
1894 Controls whether the setuid bit is respected for the file system.
1895 The default value is
1901 are equivalent to the
1906 .It Sy sharesmb Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Em opts
1907 Controls whether the file system is shared by using
1908 .Sy Samba USERSHARES
1909 and what options are to be used. Otherwise, the file system is automatically
1910 shared and unshared with the
1914 commands. If the property is set to on, the
1916 command is invoked to create a
1919 Because SMB shares requires a resource name, a unique resource name is
1920 constructed from the dataset name. The constructed name is a copy of the
1921 dataset name except that the characters in the dataset name, which would be
1922 invalid in the resource name, are replaced with underscore (_) characters.
1923 Linux does not currently support additional options which might be available
1930 the file systems are unshared.
1932 The share is created with the ACL (Access Control List) "Everyone:F" ("F"
1933 stands for "full permissions", ie. read and write permissions) and no guest
1934 access (which means Samba must be able to authenticate a real user, system
1935 passwd/shadow, LDAP or smbpasswd based) by default. This means that any
1936 additional access control (disallow specific user specific access etc) must
1937 be done on the underlying file system.
1938 .It Sy sharenfs Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Em opts
1939 Controls whether the file system is shared via NFS, and what options are to be
1941 A file system with a
1947 command and entries in the
1950 Otherwise, the file system is automatically shared and unshared with the
1955 If the property is set to
1957 the dataset is shared using the default options:
1959 .Em sec=sys,rw,crossmnt,no_subtree_check,no_root_squash
1963 for the meaning of the default options. Otherwise, the
1965 command is invoked with options equivalent to the contents of this property.
1969 property is changed for a dataset, the dataset and any children inheriting the
1970 property are re-shared with the new options, only if the property was previously
1972 or if they were shared before the property was changed.
1973 If the new property is
1975 the file systems are unshared.
1976 .It Sy logbias Ns = Ns Sy latency Ns | Ns Sy throughput
1977 Provide a hint to ZFS about handling of synchronous requests in this dataset.
1983 ZFS will use pool log devices
1985 to handle the requests at low latency.
1990 ZFS will not use configured pool log devices.
1991 ZFS will instead optimize synchronous operations for global pool throughput and
1992 efficient use of resources.
1993 .It Sy snapdev Ns = Ns Sy hidden Ns | Ns Sy visible
1994 Controls whether the volume snapshot devices under
1995 .Em /dev/zvol/<pool>
1996 are hidden or visible. The default value is
1998 .It Sy snapdir Ns = Ns Sy hidden Ns | Ns Sy visible
1999 Controls whether the
2001 directory is hidden or visible in the root of the file system as discussed in
2005 The default value is
2007 .It Sy sync Ns = Ns Sy standard Ns | Ns Sy always Ns | Ns Sy disabled
2008 Controls the behavior of synchronous requests
2009 .Pq e.g. fsync, O_DSYNC .
2013 specified behavior of ensuring all synchronous requests are written to stable
2014 storage and all devices are flushed to ensure data is not cached by device
2016 .Pq this is the default .
2018 causes every file system transaction to be written and flushed before its
2019 system call returns.
2020 This has a large performance penalty.
2022 disables synchronous requests.
2023 File system transactions are only committed to stable storage periodically.
2024 This option will give the highest performance.
2025 However, it is very dangerous as ZFS would be ignoring the synchronous
2026 transaction demands of applications such as databases or NFS.
2027 Administrators should only use this option when the risks are understood.
2028 .It Sy version Ns = Ns Em N Ns | Ns Sy current
2029 The on-disk version of this file system, which is independent of the pool
2031 This property can only be set to later supported versions.
2035 .It Sy volsize Ns = Ns Em size
2036 For volumes, specifies the logical size of the volume.
2037 By default, creating a volume establishes a reservation of equal size.
2038 For storage pools with a version number of 9 or higher, a
2043 are reflected in an equivalent change to the reservation
2049 can only be set to a multiple of
2053 The reservation is kept equal to the volume's logical size to prevent unexpected
2054 behavior for consumers.
2055 Without the reservation, the volume could run out of space, resulting in
2056 undefined behavior or data corruption, depending on how the volume is used.
2057 These effects can also occur when the volume size is changed while it is in use
2058 .Pq particularly when shrinking the size .
2059 Extreme care should be used when adjusting the volume size.
2061 Though not recommended, a
2064 .Qq thin provisioned
2066 can be created by specifying the
2069 .Nm zfs Cm create Fl V
2070 command, or by changing the value of the
2075 property on pool version 8 or earlier
2077 after the volume has been created.
2080 is a volume where the value of
2082 is less than the size of the volume plus the space required to store its
2084 Consequently, writes to a sparse volume can fail with
2086 when the pool is low on space.
2087 For a sparse volume, changes to
2089 are not reflected in the
2091 A volume that is not sparse is said to be
2092 .Qq thick provisioned .
2093 A sparse volume can become thick provisioned by setting
2097 .It Sy volmode Ns = Ns Cm default | full | geom | dev | none
2098 This property specifies how volumes should be exposed to the OS.
2101 exposes volumes as fully fledged block devices, providing maximal
2102 functionality. The value
2104 is just an alias for
2106 and is kept for compatibility.
2109 hides its partitions.
2110 Volumes with property set to
2112 are not exposed outside ZFS, but can be snapshoted, cloned, replicated, etc,
2113 that can be suitable for backup purposes.
2116 means that volumes exposition is controlled by system-wide tunable
2123 are encoded as 1, 2 and 3 respectively.
2124 The default values is
2126 .It Sy vscan Ns = Ns Sy on Ns | Ns Sy off
2127 Controls whether regular files should be scanned for viruses when a file is
2129 In addition to enabling this property, the virus scan service must also be
2130 enabled for virus scanning to occur.
2131 The default value is
2133 This property is not used on Linux.
2134 .It Sy xattr Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy sa
2135 Controls whether extended attributes are enabled for this file system. Two
2136 styles of extended attributes are supported either directory based or system
2139 The default value of
2141 enables directory based extended attributes. This style of extended attribute
2142 imposes no practical limit on either the size or number of attributes which
2143 can be set on a file. Although under Linux the
2147 system calls limit the maximum size to 64K. This is the most compatible
2148 style of extended attribute and is supported by all OpenZFS implementations.
2150 System attribute based xattrs can be enabled by setting the value to
2152 The key advantage of this type of xattr is improved performance. Storing
2153 extended attributes as system attributes significantly decreases the amount of
2154 disk IO required. Up to 64K of data may be stored per-file in the space
2155 reserved for system attributes. If there is not enough space available for
2156 an extended attribute then it will be automatically written as a directory
2157 based xattr. System attribute based extended attributes are not accessible
2158 on platforms which do not support the
2162 The use of system attribute based xattrs is strongly encouraged for users of
2163 SELinux or POSIX ACLs. Both of these features heavily rely of extended
2164 attributes and benefit significantly from the reduced access time.
2170 are equivalent to the
2175 .It Sy zoned Ns = Ns Sy on Ns | Ns Sy off
2176 Controls whether the dataset is managed from a non-global zone. Zones are a
2177 Solaris feature and are not relevant on Linux. The default value is
2181 The following three properties cannot be changed after the file system is
2182 created, and therefore, should be set when the file system is created.
2183 If the properties are not set with the
2187 commands, these properties are inherited from the parent dataset.
2188 If the parent dataset lacks these properties due to having been created prior to
2189 these features being supported, the new file system will have the default values
2190 for these properties.
2193 .Sy casesensitivity Ns = Ns Sy sensitive Ns | Ns
2194 .Sy insensitive Ns | Ns Sy mixed
2196 Indicates whether the file name matching algorithm used by the file system
2197 should be case-sensitive, case-insensitive, or allow a combination of both
2199 The default value for the
2207 file systems have case-sensitive file names.
2213 property indicates that the file system can support requests for both
2214 case-sensitive and case-insensitive matching behavior.
2215 Currently, case-insensitive matching behavior on a file system that supports
2216 mixed behavior is limited to the SMB server product.
2217 For more information about the
2219 value behavior, see the "ZFS Administration Guide".
2221 .Sy normalization Ns = Ns Sy none Ns | Ns Sy formC Ns | Ns
2222 .Sy formD Ns | Ns Sy formKC Ns | Ns Sy formKD
2224 Indicates whether the file system should perform a
2226 normalization of file names whenever two file names are compared, and which
2227 normalization algorithm should be used.
2228 File names are always stored unmodified, names are normalized as part of any
2230 If this property is set to a legal value other than
2234 property was left unspecified, the
2236 property is automatically set to
2238 The default value of the
2242 This property cannot be changed after the file system is created.
2243 .It Sy utf8only Ns = Ns Sy on Ns | Ns Sy off
2244 Indicates whether the file system should reject file names that include
2245 characters that are not present in the
2248 If this property is explicitly set to
2250 the normalization property must either not be explicitly set or be set to
2252 The default value for the
2256 This property cannot be changed after the file system is created.
2260 .Sy casesensitivity ,
2264 properties are also new permissions that can be assigned to non-privileged users
2265 by using the ZFS delegated administration feature.
2266 .Ss "Temporary Mount Point Properties"
2267 When a file system is mounted, either through
2269 for legacy mounts or the
2271 command for normal file systems, its mount options are set according to its
2273 The correlation between properties and mount options is as follows:
2275 PROPERTY MOUNT OPTION
2277 canmount auto/noauto
2281 relatime relatime/norelatime
2286 In addition, these options can be set on a per-mount basis using the
2288 option, without affecting the property that is stored on disk.
2289 The values specified on the command line override the values stored in the
2293 option is an alias for
2294 .Sy nodevices Ns \&, Ns Sy nosetuid .
2295 These properties are reported as
2300 If the properties are changed while the dataset is mounted, the new setting
2301 overrides any temporary settings.
2302 .Ss "User Properties"
2303 In addition to the standard native properties, ZFS supports arbitrary user
2305 User properties have no effect on ZFS behavior, but applications or
2306 administrators can use them to annotate datasets
2307 .Pq file systems, volumes, and snapshots .
2309 User property names must contain a colon
2311 character to distinguish them from native properties.
2312 They may contain lowercase letters, numbers, and the following punctuation
2321 The expected convention is that the property name is divided into two portions
2323 .Em module Ns \&: Ns Em property ,
2324 but this namespace is not enforced by ZFS.
2325 User property names can be at most 256 characters, and cannot begin with a dash
2328 When making programmatic use of user properties, it is strongly suggested to use
2333 component of property names to reduce the chance that two
2334 independently-developed packages use the same property name for different
2337 The values of user properties are arbitrary strings, are always inherited, and
2338 are never validated.
2339 All of the commands that operate on properties
2340 .Po Nm zfs Cm list ,
2345 can be used to manipulate both native properties and user properties.
2348 command to clear a user property.
2349 If the property is not defined in any parent dataset, it is removed entirely.
2350 Property values are limited to 8192 bytes.
2351 .Ss ZFS Volumes as Swap
2352 ZFS volumes may be used as swap devices. After creating the volume with the
2353 .Nm zfs Cm create Fl V
2354 command set up and enable the swap area using the
2358 commands. Do not swap to a file on a ZFS file system. A ZFS swap file
2359 configuration is not supported.
2363 feature allows for the creation of encrypted filesystems and volumes.
2365 will encrypt all user data including file and zvol data, file attributes,
2366 ACLs, permission bits, directory listings, FUID mappings, and userused /
2369 will not encrypt metadata related to the pool structure, including dataset
2370 names, dataset hierarchy, file size, file holes, and dedup tables. Key rotation
2371 is managed internally by the kernel module and changing the user's key does not
2372 require re-encrypting the entire dataset. Datasets can be scrubbed, resilvered,
2373 renamed, and deleted without the encryption keys being loaded (see the
2375 subcommand for more info on key loading).
2377 Creating an encrypted dataset requires specifying the
2381 properties at creation time, along with an optional
2385 After entering an encryption key, the
2386 created dataset will become an encryption root. Any descendant datasets will
2387 inherit their encryption key from the encryption root by default, meaning that
2388 loading, unloading, or changing the key for the encryption root will implicitly
2389 do the same for all inheriting datasets. If this inheritance is not desired,
2392 when creating the child dataset or use
2393 .Nm zfs Cm change-key
2394 to break an existing relationship, creating a new encryption root on the child.
2395 Note that the child's
2397 may match that of the parent while still creating a new encryption root, and
2400 property alone does not create a new encryption root; this would simply use a
2401 different cipher suite with the same key as its encryption root. The one
2402 exception is that clones will always use their origin's encryption key.
2403 As a result of this exception, some encryption-related properties (namely
2409 do not inherit like other ZFS properties and instead use the value determined
2410 by their encryption root. Encryption root inheritance can be tracked via the
2415 Encryption changes the behavior of a few
2417 operations. Encryption is applied after compression so compression ratios are
2418 preserved. Normally checksums in ZFS are 256 bits long, but for encrypted data
2419 the checksum is 128 bits of the user-chosen checksum and 128 bits of MAC from
2420 the encryption suite, which provides additional protection against maliciously
2421 altered data. Deduplication is still possible with encryption enabled but for
2422 security, datasets will only dedup against themselves, their snapshots, and
2425 There are a few limitations on encrypted datasets. Encrypted data cannot be
2428 feature. Encrypted datasets may not have
2429 .Sy copies Ns = Ns Em 3
2430 since the implementation stores some encryption metadata where the third copy
2431 would normally be. Since compression is applied before encryption datasets may
2432 be vulnerable to a CRIME-like attack if applications accessing the data allow
2433 for it. Deduplication with encryption will leak information about which blocks
2434 are equivalent in a dataset and will incur an extra CPU cost per block written.
2436 All subcommands that modify state are logged persistently to the pool in their
2440 Displays a help message.
2445 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2448 Creates a new ZFS file system.
2449 The file system is automatically mounted according to the
2451 property inherited from the parent.
2452 .Bl -tag -width "-o"
2453 .It Fl o Ar property Ns = Ns Ar value
2454 Sets the specified property as if the command
2455 .Nm zfs Cm set Ar property Ns = Ns Ar value
2456 was invoked at the same time the dataset was created.
2457 Any editable ZFS property can also be set at creation time.
2460 options can be specified.
2461 An error results if the same property is specified in multiple
2465 Creates all the non-existing parent datasets.
2466 Datasets created in this manner are automatically mounted according to the
2468 property inherited from their parent.
2469 Any property specified on the command line using the
2472 If the target filesystem already exists, the operation completes successfully.
2478 .Op Fl b Ar blocksize
2479 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2480 .Fl V Ar size Ar volume
2482 Creates a volume of the given size.
2483 The volume is exported as a block device in
2484 .Pa /dev/zvol/path ,
2487 is the name of the volume in the ZFS namespace.
2488 The size represents the logical size as exported by the device.
2489 By default, a reservation of equal size is created.
2492 is automatically rounded up to the nearest 128 Kbytes to ensure that the volume
2493 has an integral number of blocks regardless of
2495 .Bl -tag -width "-b"
2496 .It Fl b Ar blocksize
2498 .Fl o Sy volblocksize Ns = Ns Ar blocksize .
2499 If this option is specified in conjunction with
2500 .Fl o Sy volblocksize ,
2501 the resulting behavior is undefined.
2502 .It Fl o Ar property Ns = Ns Ar value
2503 Sets the specified property as if the
2504 .Nm zfs Cm set Ar property Ns = Ns Ar value
2505 command was invoked at the same time the dataset was created.
2506 Any editable ZFS property can also be set at creation time.
2509 options can be specified.
2510 An error results if the same property is specified in multiple
2514 Creates all the non-existing parent datasets.
2515 Datasets created in this manner are automatically mounted according to the
2517 property inherited from their parent.
2518 Any property specified on the command line using the
2521 If the target filesystem already exists, the operation completes successfully.
2523 Creates a sparse volume with no reservation.
2527 .Sx Native Properties
2528 section for more information about sparse volumes.
2534 .Ar filesystem Ns | Ns Ar volume
2536 Destroys the given dataset.
2537 By default, the command unshares any file systems that are currently shared,
2538 unmounts any file systems that are currently mounted, and refuses to destroy a
2539 dataset that has active dependents
2540 .Pq children or clones .
2541 .Bl -tag -width "-R"
2543 Recursively destroy all dependents, including cloned file systems outside the
2546 Force an unmount of any file systems using the
2549 This option has no effect on non-file systems or unmounted file systems.
2554 No data will be deleted.
2555 This is useful in conjunction with the
2559 flags to determine what data would be deleted.
2561 Print machine-parsable verbose information about the deleted data.
2563 Recursively destroy all children.
2565 Print verbose information about the deleted data.
2568 Extreme care should be taken when applying either the
2572 options, as they can destroy large portions of a pool and cause unexpected
2573 behavior for mounted file systems in use.
2578 .Ar filesystem Ns | Ns Ar volume Ns @ Ns Ar snap Ns
2579 .Oo % Ns Ar snap Ns Oo , Ns Ar snap Ns Oo % Ns Ar snap Oc Oc Oc Ns ...
2581 The given snapshots are destroyed immediately if and only if the
2585 option would have destroyed it.
2586 Such immediate destruction would occur, for example, if the snapshot had no
2587 clones and the user-initiated reference count were zero.
2589 If a snapshot does not qualify for immediate destruction, it is marked for
2591 In this state, it exists as a usable, visible snapshot until both of the
2592 preconditions listed above are met, at which point it is destroyed.
2594 An inclusive range of snapshots may be specified by separating the first and
2595 last snapshots with a percent sign.
2596 The first and/or last snapshots may be left blank, in which case the
2597 filesystem's oldest or newest snapshot will be implied.
2600 .Pq or ranges of snapshots
2601 of the same filesystem or volume may be specified in a comma-separated list of
2603 Only the snapshot's short name
2604 .Po the part after the
2607 should be specified when using a range or comma-separated list to identify
2609 .Bl -tag -width "-R"
2611 Recursively destroy all clones of these snapshots, including the clones,
2612 snapshots, and children.
2613 If this flag is specified, the
2615 flag will have no effect.
2617 Destroy immediately. If a snapshot cannot be destroyed now, mark it for
2618 deferred destruction.
2623 No data will be deleted.
2624 This is useful in conjunction with the
2628 flags to determine what data would be deleted.
2630 Print machine-parsable verbose information about the deleted data.
2633 .Pq or mark for deferred deletion
2634 all snapshots with this name in descendent file systems.
2636 Print verbose information about the deleted data.
2638 Extreme care should be taken when applying either the
2642 options, as they can destroy large portions of a pool and cause unexpected
2643 behavior for mounted file systems in use.
2648 .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
2650 The given bookmark is destroyed.
2655 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2656 .Ar filesystem Ns @ Ns Ar snapname Ns | Ns Ar volume Ns @ Ns Ar snapname Ns ...
2658 Creates snapshots with the given names.
2659 All previous modifications by successful system calls to the file system are
2660 part of the snapshots.
2661 Snapshots are taken atomically, so that all snapshots correspond to the same
2664 can be used as an alias for
2665 .Nm zfs Cm snapshot.
2668 section for details.
2669 .Bl -tag -width "-o"
2670 .It Fl o Ar property Ns = Ns Ar value
2671 Sets the specified property; see
2675 Recursively create snapshots of all descendent datasets
2683 Roll back the given dataset to a previous snapshot.
2684 When a dataset is rolled back, all data that has changed since the snapshot is
2685 discarded, and the dataset reverts to the state at the time of the snapshot.
2686 By default, the command refuses to roll back to a snapshot other than the most
2688 In order to do so, all intermediate snapshots and bookmarks must be destroyed by
2695 options do not recursively destroy the child snapshots of a recursive snapshot.
2696 Only direct snapshots of the specified filesystem are destroyed by either of
2698 To completely roll back a recursive snapshot, you must rollback the individual
2700 .Bl -tag -width "-R"
2702 Destroy any more recent snapshots and bookmarks, as well as any clones of those
2707 option to force an unmount of any clone file systems that are to be destroyed.
2709 Destroy any snapshots and bookmarks more recent than the one specified.
2715 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2716 .Ar snapshot Ar filesystem Ns | Ns Ar volume
2718 Creates a clone of the given snapshot.
2721 section for details.
2722 The target dataset can be located anywhere in the ZFS hierarchy, and is created
2723 as the same type as the original.
2724 .Bl -tag -width "-o"
2725 .It Fl o Ar property Ns = Ns Ar value
2726 Sets the specified property; see
2730 Creates all the non-existing parent datasets.
2731 Datasets created in this manner are automatically mounted according to the
2733 property inherited from their parent.
2734 If the target filesystem or volume already exists, the operation completes
2740 .Ar clone-filesystem
2742 Promotes a clone file system to no longer be dependent on its
2745 This makes it possible to destroy the file system that the clone was created
2747 The clone parent-child dependency relationship is reversed, so that the origin
2748 file system becomes a clone of the specified file system.
2750 The snapshot that was cloned, and any snapshots previous to this snapshot, are
2751 now owned by the promoted clone.
2752 The space they use moves from the origin file system to the promoted clone, so
2753 enough space must be available to accommodate these snapshots.
2754 No new space is consumed by this operation, but the space accounting is
2756 The promoted clone must not have any conflicting snapshot names of its own.
2759 subcommand can be used to rename any conflicting snapshots.
2764 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2765 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2771 .Ar filesystem Ns | Ns Ar volume
2772 .Ar filesystem Ns | Ns Ar volume
2774 Renames the given dataset.
2775 The new target can be located anywhere in the ZFS hierarchy, with the exception
2777 Snapshots can only be renamed within the parent file system or volume.
2778 When renaming a snapshot, the parent file system of the snapshot does not need
2779 to be specified as part of the second argument.
2780 Renamed file systems can inherit new mount points, in which case they are
2781 unmounted and remounted at the new mount point.
2782 .Bl -tag -width "-a"
2784 Force unmount any filesystems that need to be unmounted in the process.
2786 Creates all the nonexistent parent datasets.
2787 Datasets created in this manner are automatically mounted according to the
2789 property inherited from their parent.
2795 .Ar snapshot Ar snapshot
2797 Recursively rename the snapshots of all descendent datasets.
2798 Snapshots are the only dataset that can be renamed recursively.
2802 .Op Fl r Ns | Ns Fl d Ar depth
2804 .Oo Fl o Ar property Ns Oo , Ns Ar property Oc Ns ... Oc
2805 .Oo Fl s Ar property Oc Ns ...
2806 .Oo Fl S Ar property Oc Ns ...
2807 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
2808 .Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Oc Ns ...
2810 Lists the property information for the given datasets in tabular form.
2811 If specified, you can list property information by the absolute pathname or the
2813 By default, all file systems and volumes are displayed.
2814 Snapshots are displayed if the
2821 The following fields are displayed:
2822 .Sy name Ns \&, Sy used Ns \&, Sy available Ns \&, Sy referenced Ns \&, Sy mountpoint Ns .
2823 .Bl -tag -width "-H"
2825 Used for scripting mode.
2826 Do not print headers and separate fields by a single tab instead of arbitrary
2828 .It Fl S Ar property
2831 option, but sorts by property in descending order.
2833 Recursively display any children of the dataset, limiting the recursion to
2839 will display only the dataset and its direct children.
2840 .It Fl o Ar property
2841 A comma-separated list of properties to display.
2842 The property must be:
2845 One of the properties described in the
2846 .Sx Native Properties
2853 to display the dataset name
2857 to display space usage properties on file systems and volumes.
2858 This is a shortcut for specifying
2859 .Fl o Sy name Ns \&, Ns Sy avail Ns \&, Ns Sy used Ns \&, Ns Sy usedsnap Ns \&, Ns
2860 .Sy usedds Ns \&, Ns Sy usedrefreserv Ns \&, Ns Sy usedchild Fl t
2861 .Sy filesystem Ns \&, Ns Sy volume
2865 Display numbers in parsable
2869 Recursively display any children of the dataset on the command line.
2870 .It Fl s Ar property
2871 A property for sorting the output by column in ascending order based on the
2872 value of the property.
2873 The property must be one of the properties described in the
2875 section, or the special value
2877 to sort by the dataset name.
2878 Multiple properties can be specified at one time using multiple
2883 options are evaluated from left to right in decreasing order of importance.
2884 The following is a list of sorting criteria:
2887 Numeric types sort in numeric order.
2889 String types sort in alphabetical order.
2891 Types inappropriate for a row sort that row to the literal bottom, regardless of
2892 the specified ordering.
2895 If no sorting options are specified the existing behavior of
2899 A comma-separated list of types to display, where
2908 For example, specifying
2910 displays only snapshots.
2915 .Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ...
2916 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
2918 Sets the property or list of properties to the given value(s) for each dataset.
2919 Only some properties can be edited.
2922 section for more information on what properties can be set and acceptable
2924 Numeric values can be specified as exact values, or in a human-readable form
2926 .Sy B , K , M , G , T , P , E , Z
2927 .Po for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes,
2928 or zettabytes, respectively
2930 User properties can be set on snapshots.
2931 For more information, see the
2937 .Op Fl r Ns | Ns Fl d Ar depth
2939 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
2940 .Oo Fl s Ar source Ns Oo , Ns Ar source Oc Ns ... Oc
2941 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
2942 .Cm all | Ar property Ns Oo , Ns Ar property Oc Ns ...
2943 .Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Oc Ns ...
2945 Displays properties for the given datasets.
2946 If no datasets are specified, then the command displays properties for all
2947 datasets on the system.
2948 For each property, the following columns are displayed:
2951 property Property name
2952 value Property value
2953 source Property source \fBlocal\fP, \fBdefault\fP, \fBinherited\fP,
2954 \fBtemporary\fP, \fBreceived\fP or none (\fB-\fP).
2957 All columns are displayed by default, though this can be controlled by using the
2960 This command takes a comma-separated list of properties as described in the
2961 .Sx Native Properties
2968 can be used to display all properties that apply to the given dataset's type
2969 .Pq filesystem, volume, snapshot, or bookmark .
2970 .Bl -tag -width "-H"
2972 Display output in a form more easily parsed by scripts.
2973 Any headers are omitted, and fields are explicitly separated by a single tab
2974 instead of an arbitrary amount of space.
2976 Recursively display any children of the dataset, limiting the recursion to
2980 will display only the dataset and its direct children.
2982 A comma-separated list of columns to display.
2983 .Sy name Ns \&, Ns Sy property Ns \&, Ns Sy value Ns \&, Ns Sy source
2984 is the default value.
2986 Display numbers in parsable
2990 Recursively display properties for any children.
2992 A comma-separated list of sources to display.
2993 Those properties coming from a source other than those in this list are ignored.
2994 Each source must be one of the following:
3002 The default value is all sources.
3004 A comma-separated list of types to display, where
3018 .Ar property Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
3020 Clears the specified property, causing it to be inherited from an ancestor,
3021 restored to default if no ancestor has the property set, or with the
3023 option reverted to the received value if one exists.
3026 section for a listing of default values, and details on which properties can be
3028 .Bl -tag -width "-r"
3030 Recursively inherit the given property for all children.
3032 Revert the property to the received value if one exists; otherwise operate as
3035 option was not specified.
3041 Displays a list of file systems that are not the most recent version.
3047 Displays a list of currently supported file system versions.
3053 .Fl a | Ar filesystem
3055 Upgrades file systems to a new on-disk version.
3056 Once this is done, the file systems will no longer be accessible on systems
3057 running older versions of the software.
3059 streams generated from new snapshots of these file systems cannot be accessed on
3060 systems running older versions of the software.
3062 In general, the file system version is independent of the pool version.
3065 for information on the
3066 .Nm zpool Cm upgrade
3069 In some cases, the file system version and the pool version are interrelated and
3070 the pool version must be upgraded before the file system version can be
3072 .Bl -tag -width "-V"
3074 Upgrade to the specified
3078 flag is not specified, this command upgrades to the most recent version.
3080 option can only be used to increase the version number, and only up to the most
3081 recent version supported by this software.
3083 Upgrade all file systems on all imported pools.
3085 Upgrade the specified file system.
3087 Upgrade the specified file system and all descendent file systems.
3093 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
3094 .Oo Fl s Ar field Oc Ns ...
3095 .Oo Fl S Ar field Oc Ns ...
3096 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
3097 .Ar filesystem Ns | Ns Ar snapshot
3099 Displays space consumed by, and quotas on, each user in the specified filesystem
3101 This corresponds to the
3102 .Sy userused@ Ns Em user ,
3103 .Sy userobjused@ Ns Em user ,
3104 .Sy userquota@ Ns Em user,
3106 .Sy userobjquota@ Ns Em user
3108 .Bl -tag -width "-H"
3110 Do not print headers, use tab-delimited output.
3112 Sort by this field in reverse order.
3116 Translate SID to POSIX ID.
3117 The POSIX ID may be ephemeral if no mapping exists.
3118 Normal POSIX interfaces
3123 perform this translation, so the
3125 option allows the output from
3126 .Nm zfs Cm userspace
3127 to be compared directly with those utilities.
3130 may lead to confusion if some files were created by an SMB user before a
3131 SMB-to-POSIX name mapping was established.
3132 In such a case, some files will be owned by the SMB entity and some by the POSIX
3136 option will report that the POSIX entity has the total usage and quota for both.
3138 Print numeric ID instead of user/group name.
3139 .It Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
3140 Display only the specified fields from the following set:
3145 The default is to display all fields.
3151 Sort output by this field.
3156 flags may be specified multiple times to sort first by one field, then by
3159 .Fl s Sy type Fl s Sy name .
3160 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
3161 Print only the specified types from the following set:
3168 .Fl t Sy posixuser Ns \&, Ns Sy smbuser .
3169 The default can be changed to include group types.
3175 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
3176 .Oo Fl s Ar field Oc Ns ...
3177 .Oo Fl S Ar field Oc Ns ...
3178 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
3179 .Ar filesystem Ns | Ns Ar snapshot
3181 Displays space consumed by, and quotas on, each group in the specified
3182 filesystem or snapshot.
3183 This subcommand is identical to
3184 .Nm zfs Cm userspace ,
3185 except that the default types to display are
3186 .Fl t Sy posixgroup Ns \&, Ns Sy smbgroup .
3191 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
3192 .Oo Fl s Ar field Oc Ns ...
3193 .Oo Fl S Ar field Oc Ns ...
3194 .Ar filesystem Ns | Ns Ar snapshot
3196 Displays space consumed by, and quotas on, each project in the specified
3197 filesystem or snapshot. This subcommand is identical to
3198 .Nm zfs Cm userspace ,
3199 except that the project identifier is numeral, not name. So need neither
3202 for SID to POSIX ID nor
3210 .Oo Fl d Ns | Ns Fl r Ns Oc
3211 .Ar file Ns | Ns Ar directory Ns ...
3213 List project identifier (ID) and inherit flag of file(s) or directories.
3214 .Bl -tag -width "-d"
3216 Show the directory project ID and inherit flag, not its childrens. It will
3217 overwrite the former specified
3221 Show on subdirectories recursively. It will overwrite the former specified
3230 .Ar file Ns | Ns Ar directory Ns ...
3232 Clear project inherit flag and/or ID on the file(s) or directories.
3233 .Bl -tag -width "-k"
3235 Keep the project ID unchanged. If not specified, the project ID will be reset
3238 Clear on subdirectories recursively.
3245 .Oo Fl d Ns | Ns Fl r Ns Oc
3247 .Ar file Ns | Ns Ar directory Ns ...
3249 Check project ID and inherit flag on the file(s) or directories, report the
3250 entries without project inherit flag or with different project IDs from the
3253 option) value or the target directory's project ID.
3254 .Bl -tag -width "-0"
3256 Print file name with a trailing NUL instead of newline (by default), like
3259 Check the directory project ID and inherit flag, not its childrens. It will
3260 overwrite the former specified
3264 Specify the referenced ID for comparing with the target file(s) or directories'
3265 project IDs. If not specified, the target (top) directory's project ID will be
3266 used as the referenced one.
3268 Check on subdirectories recursively. It will overwrite the former specified
3277 .Ar file Ns | Ns Ar directory Ns ...
3279 .Bl -tag -width "-p"
3280 Set project ID and/or inherit flag on the file(s) or directories.
3282 Set the file(s)' or directories' project ID with the given value.
3284 Set on subdirectories recursively.
3286 Set project inherit flag on the given file(s) or directories. It is usually used
3287 for setup tree quota on the directory target with
3289 option specified together. When setup tree quota, by default the directory's
3290 project ID will be set to all its descendants unless you specify the project
3299 Displays all ZFS file systems currently mounted.
3305 .Fl a | Ar filesystem
3307 Mounts ZFS file systems.
3308 .Bl -tag -width "-O"
3310 Perform an overlay mount.
3313 for more information.
3315 Mount all available ZFS file systems.
3316 Invoked automatically as part of the boot process.
3318 Mount the specified filesystem.
3320 An optional, comma-separated list of mount options to use temporarily for the
3321 duration of the mount.
3323 .Sx Temporary Mount Point Properties
3324 section for details.
3326 Load keys for encrypted filesystems as they are being mounted. This is
3327 equivalent to executing
3329 on each encryption root before mounting it. Note that if a filesystem has a
3333 this will cause the terminal to interactively block after asking for the key.
3335 Report mount progress.
3341 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
3343 Unmounts currently mounted ZFS file systems.
3344 .Bl -tag -width "-a"
3346 Unmount all available ZFS file systems.
3347 Invoked automatically as part of the shutdown process.
3348 .It Ar filesystem Ns | Ns Ar mountpoint
3349 Unmount the specified filesystem.
3350 The command can also be given a path to a ZFS file system mount point on the
3353 Forcefully unmount the file system, even if it is currently in use.
3358 .Fl a | Ar filesystem
3360 Shares available ZFS file systems.
3361 .Bl -tag -width "-a"
3363 Share all available ZFS file systems.
3364 Invoked automatically as part of the boot process.
3366 Share the specified filesystem according to the
3371 File systems are shared when the
3380 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
3382 Unshares currently shared ZFS file systems.
3383 .Bl -tag -width "-a"
3385 Unshare all available ZFS file systems.
3386 Invoked automatically as part of the shutdown process.
3387 .It Ar filesystem Ns | Ns Ar mountpoint
3388 Unshare the specified filesystem.
3389 The command can also be given a path to a ZFS file system shared on the system.
3394 .Ar snapshot bookmark
3396 Creates a bookmark of the given snapshot.
3397 Bookmarks mark the point in time when the snapshot was created, and can be used
3398 as the incremental source for a
3402 This feature must be enabled to be used.
3404 .Xr zpool-features 5
3405 for details on ZFS feature flags and the
3412 .Op Oo Fl I Ns | Ns Fl i Oc Ar snapshot
3415 Creates a stream representation of the second
3417 which is written to standard output.
3418 The output can be redirected to a file or to a different system
3419 .Po for example, using
3422 By default, a full stream is generated.
3423 .Bl -tag -width "-D"
3425 Generate a deduplicated stream.
3426 Blocks which would have been sent multiple times in the send stream will only be
3428 The receiving system must also support this feature to receive a deduplicated
3430 This flag can be used regardless of the dataset's
3432 property, but performance will be much better if the filesystem uses a
3433 dedup-capable checksum
3437 .It Fl I Ar snapshot
3438 Generate a stream package that sends all intermediary snapshots from the first
3439 snapshot to the second snapshot.
3443 .Fl i Em @a Em fs@b Ns \&; Fl i Em @b Em fs@c Ns \&; Fl i Em @c Em fs@d .
3444 The incremental source may be specified as with the
3447 .It Fl L, -large-block
3448 Generate a stream which may contain blocks larger than 128KB.
3449 This flag has no effect if the
3451 pool feature is disabled, or if the
3453 property of this filesystem has never been set above 128KB.
3454 The receiving system must have the
3456 pool feature enabled as well.
3458 .Xr zpool-features 5
3459 for details on ZFS feature flags and the
3463 Print machine-parsable verbose information about the stream package generated.
3464 .It Fl R, -replicate
3465 Generate a replication stream package, which will replicate the specified
3466 file system, and all descendent file systems, up to the named snapshot.
3467 When received, all properties, snapshots, descendent file systems, and clones
3474 flags are used in conjunction with the
3476 flag, an incremental replication stream is generated.
3477 The current values of properties, and current snapshot and file system names are
3478 set when the stream is received.
3481 flag is specified when this stream is received, snapshots and file systems that
3482 do not exist on the sending side are destroyed.
3484 Generate a more compact stream by using
3486 records for blocks which are stored more compactly on disk by the
3489 This flag has no effect if the
3491 feature is disabled.
3492 The receiving system must have the
3497 feature is active on the sending system, then the receiving system must have
3498 that feature enabled as well. Datasets that are sent with this flag may not be
3499 received as an encrypted dataset, since encrypted datasets cannot use the
3503 .Xr zpool-features 5
3504 for details on ZFS feature flags and the
3508 Sends only received property values whether or not they are overridden by local
3509 settings, but only if the dataset has ever been received. Use this option when
3512 to restore received properties backed up on the sent dataset and to avoid
3513 sending local settings that may have nothing to do with the source dataset,
3514 but only with how the data is backed up.
3515 .It Fl c, -compressed
3516 Generate a more compact stream by using compressed WRITE records for blocks
3517 which are compressed on disk and in memory
3520 property for details
3524 feature is active on the sending system, then the receiving system must have
3525 that feature enabled as well.
3528 feature is enabled on the sending system but the
3530 option is not supplied in conjunction with
3532 then the data will be decompressed before sending so it can be split into
3533 smaller block sizes.
3535 For encrypted datasets, send data exactly as it exists on disk. This allows
3536 backups to be taken even if encryption keys are not currently loaded. The
3537 backup may then be received on an untrusted machine since that machine will
3538 not have the encryption keys to read the protected data or alter it without
3539 being detected. Upon being received, the dataset will have the same encryption
3540 keys as it did on the send side, although the
3542 property will be defaulted to
3544 if not otherwise provided. For unencrypted datasets, this flag will be
3547 Note that if you do not use this flag for sending encrypted datasets, data will
3548 be sent unencrypted and may be re-encrypted with a different encryption key on
3549 the receiving system, which will disable the ability to do a raw send to that
3550 system for incrementals.
3551 .It Fl i Ar snapshot
3552 Generate an incremental stream from the first
3554 .Pq the incremental source
3557 .Pq the incremental target .
3558 The incremental source can be specified as the last component of the snapshot
3562 character and following
3564 and it is assumed to be from the same file system as the incremental target.
3566 If the destination is a clone, the source may be the origin snapshot, which must
3569 .Em pool/fs@origin ,
3577 Do not generate any actual send data.
3578 This is useful in conjunction with the
3582 flags to determine what data will be sent.
3583 In this case, the verbose output will be written to standard output
3584 .Po contrast with a non-dry-run, where the stream is written to standard output
3585 and the verbose output goes to standard error
3588 Include the dataset's properties in the stream.
3589 This flag is implicit when
3592 The receiving system must also support this feature. Sends of encrypted datasets
3595 when using this flag.
3597 Print verbose information about the stream package generated.
3598 This information includes a per-second report of how much data has been sent.
3600 The format of the stream is committed.
3601 You will be able to receive your streams on future versions of ZFS.
3607 .Op Fl i Ar snapshot Ns | Ns Ar bookmark
3608 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
3610 Generate a send stream, which may be of a filesystem, and may be incremental
3612 If the destination is a filesystem or volume, the pool must be read-only, or the
3613 filesystem must not be mounted.
3614 When the stream generated from a filesystem or volume is received, the default
3615 snapshot name will be
3617 .Bl -tag -width "-L"
3618 .It Fl L, -large-block
3619 Generate a stream which may contain blocks larger than 128KB.
3620 This flag has no effect if the
3622 pool feature is disabled, or if the
3624 property of this filesystem has never been set above 128KB.
3625 The receiving system must have the
3627 pool feature enabled as well.
3629 .Xr zpool-features 5
3630 for details on ZFS feature flags and the
3634 Print machine-parsable verbose information about the stream package generated.
3635 .It Fl c, -compressed
3636 Generate a more compact stream by using compressed WRITE records for blocks
3637 which are compressed on disk and in memory
3640 property for details
3644 feature is active on the sending system, then the receiving system must have
3645 that feature enabled as well.
3648 feature is enabled on the sending system but the
3650 option is not supplied in conjunction with
3652 then the data will be decompressed before sending so it can be split into
3653 smaller block sizes.
3655 For encrypted datasets, send data exactly as it exists on disk. This allows
3656 backups to be taken even if encryption keys are not currently loaded. The
3657 backup may then be received on an untrusted machine since that machine will
3658 not have the encryption keys to read the protected data or alter it without
3659 being detected. Upon being received, the dataset will have the same encryption
3660 keys as it did on the send side, although the
3662 property will be defaulted to
3664 if not otherwise provided. For unencrypted datasets, this flag will be
3667 Note that if you do not use this flag for sending encrypted datasets, data will
3668 be sent unencrypted and may be re-encrypted with a different encryption key on
3669 the receiving system, which will disable the ability to do a raw send to that
3670 system for incrementals.
3672 Generate a more compact stream by using
3674 records for blocks which are stored more compactly on disk by the
3677 This flag has no effect if the
3679 feature is disabled.
3680 The receiving system must have the
3685 feature is active on the sending system, then the receiving system must have
3686 that feature enabled as well. Datasets that are sent with this flag may not be
3687 received as an encrypted dataset, since encrypted datasets cannot use the
3691 .Xr zpool-features 5
3692 for details on ZFS feature flags and the
3695 .It Fl i Ar snapshot Ns | Ns Ar bookmark
3696 Generate an incremental send stream.
3697 The incremental source must be an earlier snapshot in the destination's history.
3698 It will commonly be an earlier snapshot in the destination's file system, in
3699 which case it can be specified as the last component of the name
3704 character and following
3707 If the incremental target is a clone, the incremental source can be the origin
3708 snapshot, or an earlier snapshot in the origin's filesystem, or the origin's
3714 Do not generate any actual send data.
3715 This is useful in conjunction with the
3719 flags to determine what data will be sent.
3720 In this case, the verbose output will be written to standard output
3721 .Po contrast with a non-dry-run, where the stream is written to standard output
3722 and the verbose output goes to standard error
3725 Print verbose information about the stream package generated.
3726 This information includes a per-second report of how much data has been sent.
3733 .Ar receive_resume_token
3735 Creates a send stream which resumes an interrupted receive.
3737 .Ar receive_resume_token
3738 is the value of this property on the filesystem or volume that was being
3740 See the documentation for
3747 .Op Fl o Sy origin Ns = Ns Ar snapshot
3748 .Op Fl o Ar property Ns = Ns Ar value
3749 .Op Fl x Ar property
3750 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
3756 .Op Fl d Ns | Ns Fl e
3757 .Op Fl o Sy origin Ns = Ns Ar snapshot
3758 .Op Fl o Ar property Ns = Ns Ar value
3759 .Op Fl x Ar property
3762 Creates a snapshot whose contents are as specified in the stream provided on
3764 If a full stream is received, then a new file system is created as well.
3765 Streams are created using the
3767 subcommand, which by default creates a full stream.
3769 can be used as an alias for
3772 If an incremental stream is received, then the destination file system must
3773 already exist, and its most recent snapshot must match the incremental stream's
3777 the destination device link is destroyed and recreated, which means the
3779 cannot be accessed during the
3783 When a snapshot replication package stream that is generated by using the
3784 .Nm zfs Cm send Fl R
3785 command is received, any snapshots that do not exist on the sending location are
3786 destroyed by using the
3787 .Nm zfs Cm destroy Fl d
3791 .Fl o Em property Ns = Ns Ar value
3794 is specified, it applies to the effective value of the property throughout
3795 the entire subtree of replicated datasets. Effective property values will be
3800 ) on the topmost in the replicated subtree. In descendant datasets, if the
3801 property is set by the send stream, it will be overridden by forcing the
3802 property to be inherited from the top‐most file system. Received properties
3803 are retained in spite of being overridden and may be restored with
3804 .Nm zfs Cm inherit Fl S .
3806 .Fl o Sy origin Ns = Ns Em snapshot
3807 is a special case because, even if
3809 is a read-only property and cannot be set, it's allowed to receive the send
3810 stream as a clone of the given snapshot.
3812 Raw encrypted send streams (created with
3813 .Nm zfs Cm send Fl w
3814 ) may only be received as is, and cannot be re-encrypted, decrypted, or
3815 recompressed by the receive process. Unencrypted streams can be received as
3816 encrypted datasets, either through inheritance or by specifying encryption
3821 The name of the snapshot
3822 .Pq and file system, if a full stream is received
3823 that this subcommand creates depends on the argument type and the use of the
3829 If the argument is a snapshot name, the specified
3832 If the argument is a file system or volume name, a snapshot with the same name
3833 as the sent snapshot is created within the specified
3841 options are specified, the provided target snapshot name is used exactly as
3848 options cause the file system name of the target snapshot to be determined by
3849 appending a portion of the sent snapshot's name to the specified target
3853 option is specified, all but the first element of the sent snapshot's file
3855 .Pq usually the pool name
3856 is used and any required intermediate file systems within the specified one are
3860 option is specified, then only the last element of the sent snapshot's file
3862 .Pq i.e. the name of the source file system itself
3863 is used as the target file system name.
3864 .Bl -tag -width "-F"
3866 Force a rollback of the file system to the most recent snapshot before
3867 performing the receive operation.
3868 If receiving an incremental replication stream
3869 .Po for example, one generated by
3870 .Nm zfs Cm send Fl R Op Fl i Ns | Ns Fl I
3872 destroy snapshots and file systems that do not exist on the sending side.
3874 Discard the first element of the sent snapshot's file system name, using the
3875 remaining elements to determine the name of the target file system for the new
3876 snapshot as described in the paragraph above.
3878 Discard all but the last element of the sent snapshot's file system name, using
3879 that element to determine the name of the target file system for the new
3880 snapshot as described in the paragraph above.
3882 Do not actually receive the stream.
3883 This can be useful in conjunction with the
3885 option to verify the name the receive operation would use.
3886 .It Fl o Sy origin Ns = Ns Ar snapshot
3887 Forces the stream to be received as a clone of the given snapshot.
3888 If the stream is a full send stream, this will create the filesystem
3889 described by the stream as a clone of the specified snapshot.
3890 Which snapshot was specified will not affect the success or failure of the
3891 receive, as long as the snapshot does exist.
3892 If the stream is an incremental send stream, all the normal verification will be
3894 .It Fl o Em property Ns = Ns Ar value
3895 Sets the specified property as if the command
3896 .Nm zfs Cm set Em property Ns = Ns Ar value
3897 was invoked immediately before the receive. When receiving a stream from
3898 .Nm zfs Cm send Fl R ,
3899 causes the property to be inherited by all descendant datasets, as through
3900 .Nm zfs Cm inherit Em property
3901 was run on any descendant datasets that have this property set on the
3904 Any editable property can be set at receive time. Set-once properties bound
3905 to the received data, such as
3908 .Sy casesensitivity ,
3909 cannot be set at receive time even when the datasets are newly created by
3910 .Nm zfs Cm receive .
3911 Additionally both settable properties
3915 cannot be set at receive time.
3919 option may be specified multiple times, for different properties. An error
3920 results if the same property is specified in multiple
3928 option may also be used to override encryption properties upon initial
3929 receive. This allows unencrypted streams to be received as encrypted datasets.
3930 To cause the received dataset (or root dataset of a recursive stream) to be
3931 received as an encryption root, specify encryption properties in the same
3932 manner as is required for
3937 # zfs send tank/test@snap1 | zfs recv -o encryption=on -o keyformat=passphrase -o keylocation=file:///path/to/keyfile
3941 .Op Fl o Ar keylocation Ns = Ns Ar prompt
3942 may not be specified here, since stdin is already being utilized for the send
3943 stream. Once the receive has completed, you can use
3946 to change this setting after the fact. Similarly, you can receive a dataset as
3947 an encrypted child by specifying
3948 .Op Fl x Ar encryption
3949 to force the property to be inherited. Overriding encryption properties (except
3951 .Sy keylocation Ns )
3952 is not possible with raw send streams.
3954 If the receive is interrupted, save the partially received state, rather
3956 Interruption may be due to premature termination of the stream
3957 .Po e.g. due to network failure or failure of the remote system
3958 if the stream is being read over a network connection
3960 a checksum error in the stream, termination of the
3962 process, or unclean shutdown of the system.
3964 The receive can be resumed with a stream generated by
3965 .Nm zfs Cm send Fl t Ar token ,
3969 .Sy receive_resume_token
3970 property of the filesystem or volume which is received into.
3972 To use this flag, the storage pool must have the
3973 .Sy extensible_dataset
3976 .Xr zpool-features 5
3977 for details on ZFS feature flags.
3979 File system that is associated with the received stream is not mounted.
3981 Print verbose information about the stream and the time required to perform the
3983 .It Fl x Em property
3984 Ensures that the effective value of the specified property after the
3985 receive is unaffected by the value of that property in the send stream (if any),
3986 as if the property had been excluded from the send stream.
3988 If the specified property is not present in the send stream, this option does
3991 If a received property needs to be overridden, the effective value will be
3992 set or inherited, depending on whether the property is inheritable or not.
3994 In the case of an incremental update,
3996 leaves any existing local setting or explicit inheritance unchanged.
4000 restrictions on set-once and special properties apply equally to
4007 .Ar filesystem Ns | Ns Ar volume
4009 Abort an interrupted
4010 .Nm zfs Cm receive Fl s ,
4011 deleting its saved partially received state.
4015 .Ar filesystem Ns | Ns Ar volume
4017 Displays permissions that have been delegated on the specified filesystem or
4019 See the other forms of
4021 for more information.
4023 Delegations are supported under Linux with the exception of
4031 These permissions cannot be delegated because the Linux
4033 command restricts modifications of the global namespace to the root user.
4038 .Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
4039 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4040 .Ar setname Oc Ns ...
4041 .Ar filesystem Ns | Ns Ar volume
4047 .Fl e Ns | Ns Sy everyone
4048 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4049 .Ar setname Oc Ns ...
4050 .Ar filesystem Ns | Ns Ar volume
4052 Delegates ZFS administration permission for the file systems to non-privileged
4054 .Bl -tag -width "-d"
4056 Allow only for the descendent file systems.
4057 .It Fl e Ns | Ns Sy everyone
4058 Specifies that the permissions be delegated to everyone.
4059 .It Fl g Ar group Ns Oo , Ns Ar group Oc Ns ...
4060 Explicitly specify that permissions are delegated to the group.
4064 only for the specified file system.
4065 .It Fl u Ar user Ns Oo , Ns Ar user Oc Ns ...
4066 Explicitly specify that permissions are delegated to the user.
4067 .It Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
4068 Specifies to whom the permissions are delegated.
4069 Multiple entities can be specified as a comma-separated list.
4072 options are specified, then the argument is interpreted preferentially as the
4075 then as a user name, and lastly as a group name.
4076 To specify a user or group named
4083 To specify a group with the same name as a user, use the
4087 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4088 .Ar setname Oc Ns ...
4090 The permissions to delegate.
4091 Multiple permissions may be specified as a comma-separated list.
4092 Permission names are the same as ZFS subcommand and property names.
4093 See the property list below.
4094 Property set names, which begin with
4099 form below for details.
4104 options are specified, or both are, then the permissions are allowed for the
4105 file system or volume, and all of its descendents.
4107 Permissions are generally the ability to use a ZFS subcommand or change a ZFS
4109 The following permissions are available:
4112 allow subcommand Must also have the permission that is
4114 clone subcommand Must also have the 'create' ability and
4115 'mount' ability in the origin file system
4116 create subcommand Must also have the 'mount' ability
4117 destroy subcommand Must also have the 'mount' ability
4118 diff subcommand Allows lookup of paths within a dataset
4119 given an object number, and the ability
4120 to create snapshots necessary to
4122 load-key subcommand Allows loading and unloading of encryption key
4123 (see 'zfs load-key' and 'zfs unload-key').
4124 change-key subcommand Allows changing an encryption key via
4126 mount subcommand Allows mount/umount of ZFS datasets
4127 promote subcommand Must also have the 'mount' and 'promote'
4128 ability in the origin file system
4129 receive subcommand Must also have the 'mount' and 'create'
4131 rename subcommand Must also have the 'mount' and 'create'
4132 ability in the new parent
4133 rollback subcommand Must also have the 'mount' ability
4135 share subcommand Allows sharing file systems over NFS
4137 snapshot subcommand Must also have the 'mount' ability
4139 groupquota other Allows accessing any groupquota@...
4141 groupused other Allows reading any groupused@... property
4142 userprop other Allows changing any user property
4143 userquota other Allows accessing any userquota@...
4145 userused other Allows reading any userused@... property
4146 projectobjquota other Allows accessing any projectobjquota@...
4148 projectquota other Allows accessing any projectquota@... property
4149 projectobjused other Allows reading any projectobjused@... property
4150 projectused other Allows reading any projectused@... property
4156 casesensitivity property
4158 compression property
4162 filesystem_limit property
4165 normalization property
4166 primarycache property
4171 refreservation property
4172 reservation property
4173 secondarycache property
4178 snapshot_limit property
4181 volblocksize property
4191 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4192 .Ar setname Oc Ns ...
4193 .Ar filesystem Ns | Ns Ar volume
4198 These permissions are granted
4200 to the creator of any newly-created descendent file system.
4204 .Fl s No @ Ns Ar setname
4205 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4206 .Ar setname Oc Ns ...
4207 .Ar filesystem Ns | Ns Ar volume
4209 Defines or adds permissions to a permission set.
4210 The set can be used by other
4212 commands for the specified file system and its descendents.
4213 Sets are evaluated dynamically, so changes to a set are immediately reflected.
4214 Permission sets follow the same naming restrictions as ZFS file systems, but the
4215 name must begin with
4217 and can be no more than 64 characters long.
4222 .Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
4223 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4224 .Ar setname Oc Ns ... Oc
4225 .Ar filesystem Ns | Ns Ar volume
4231 .Fl e Ns | Ns Sy everyone
4232 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4233 .Ar setname Oc Ns ... Oc
4234 .Ar filesystem Ns | Ns Ar volume
4241 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4242 .Ar setname Oc Ns ... Oc
4243 .Ar filesystem Ns | Ns Ar volume
4245 Removes permissions that were granted with the
4248 No permissions are explicitly denied, so other permissions granted are still in
4250 For example, if the permission is granted by an ancestor.
4251 If no permissions are specified, then all permissions for the specified
4263 only removes the permissions that were granted to everyone, not all permissions
4264 for every user and group.
4267 command for a description of the
4270 .Bl -tag -width "-r"
4272 Recursively remove the permissions from this file system and all descendents.
4278 .Fl s No @ Ns Ar setname
4279 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4280 .Ar setname Oc Ns ... Oc
4281 .Ar filesystem Ns | Ns Ar volume
4283 Removes permissions from a permission set.
4284 If no permissions are specified, then all permissions are removed, thus removing
4290 .Ar tag Ar snapshot Ns ...
4292 Adds a single reference, named with the
4294 argument, to the specified snapshot or snapshots.
4295 Each snapshot has its own tag namespace, and tags must be unique within that
4298 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
4302 .Bl -tag -width "-r"
4304 Specifies that a hold with the given tag is applied recursively to the snapshots
4305 of all descendent file systems.
4313 Lists all existing user references for the given snapshot or snapshots.
4314 .Bl -tag -width "-r"
4316 Lists the holds that are set on the named descendent snapshots, in addition to
4317 listing the holds on the named snapshot.
4319 Do not print headers, use tab-delimited output.
4325 .Ar tag Ar snapshot Ns ...
4327 Removes a single reference, named with the
4329 argument, from the specified snapshot or snapshots.
4330 The tag must already exist for each snapshot.
4331 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
4335 .Bl -tag -width "-r"
4337 Recursively releases a hold with the given tag on the snapshots of all
4338 descendent file systems.
4344 .Ar snapshot Ar snapshot Ns | Ns Ar filesystem
4346 Display the difference between a snapshot of a given filesystem and another
4347 snapshot of that filesystem from a later time or the current contents of the
4349 The first column is a character indicating the type of change, the other columns
4350 indicate pathname, new pathname
4351 .Pq in case of rename ,
4352 change in link count, and optionally file type and/or change time.
4353 The types of change are:
4355 - The path has been removed
4356 + The path has been created
4357 M The path has been modified
4358 R The path has been renamed
4360 .Bl -tag -width "-F"
4362 Display an indication of the type of file, in a manner similar to the
4378 Give more parsable tab-separated output, without header lines and without
4381 Display the path's inode change time as the first column of output.
4388 .Op Fl m Ar memory_limit
4394 as a ZFS channel program on
4397 program interface allows ZFS administrative operations to be run
4398 programmatically via a Lua script.
4399 The entire script is executed atomically, with no other administrative
4400 operations taking effect concurrently.
4401 A library of ZFS calls is made available to channel program scripts.
4402 Channel programs may only be run with root privileges.
4404 For full documentation of the ZFS channel program interface, see the manual
4409 Display channel program output in JSON format. When this flag is specified and
4410 standard output is empty - channel program encountered an error. The details of
4411 such an error will be printed to standard error in plain text.
4413 Executes a read-only channel program, which runs faster.
4414 The program cannot change on-disk state by calling functions from
4415 the zfs.sync submodule.
4416 The program can be used to gather information such as properties and
4417 determining if changes would succeed (zfs.check.*).
4418 Without this flag, all pending changes must be synced to disk before
4419 a channel program can complete.
4421 Execution time limit, in milliseconds.
4422 If a channel program executes for longer than the provided timeout, it will
4423 be stopped and an error will be returned.
4424 The default timeout is 1000 ms, and can be set to a maximum of 10000 ms.
4425 .It Fl m Ar memory-limit
4426 Memory limit, in bytes.
4427 If a channel program attempts to allocate more memory than the given limit,
4428 it will be stopped and an error returned.
4429 The default memory limit is 10 MB, and can be set to a maximum of 100 MB.
4431 All remaining argument strings are passed directly to the channel program as
4435 for more information.
4441 .Op Fl L Ar keylocation
4442 .Fl a | Ar filesystem
4446 allowing it and all children that inherit the
4448 property to be accessed. The key will be expected in the format specified by the
4450 and location specified by the
4452 property. Note that if the
4456 the terminal will interactively wait for the key to be entered. Loading a key
4457 will not automatically mount the dataset. If that functionality is desired,
4458 .Nm zfs Cm mount Sy -l
4459 will ask for the key and mount the dataset. Once the key is loaded the
4461 property will become
4463 .Bl -tag -width "-r"
4465 Recursively loads the keys for the specified filesystem and all descendent
4468 Loads the keys for all encryption roots in all imported pools.
4472 load-key. This will cause zfs to simply check that the
4473 provided key is correct. This command may be run even if the key is already
4475 .It Fl L Ar keylocation
4480 property. This will not change the value of the property on the dataset. Note
4481 that if used with either
4486 may only be given as
4493 .Fl a | Ar filesystem
4495 Unloads a key from ZFS, removing the ability to access the dataset and all of
4496 its children that inherit the
4498 property. This requires that the dataset is not currently open or mounted. Once
4499 the key is unloaded the
4501 property will become
4503 .Bl -tag -width "-r"
4505 Recursively unloads the keys for the specified filesystem and all descendent
4508 Unloads the keys for all encryption roots in all imported pools.
4514 .Op Fl o Ar keylocation Ns = Ns Ar value
4515 .Op Fl o Ar keyformat Ns = Ns Ar value
4516 .Op Fl o Ar pbkdf2iters Ns = Ns Ar value
4526 Allows a user to change the encryption key used to access a dataset. This
4527 command requires that the existing key for the dataset is already loaded into
4528 ZFS. This command may also be used to change the
4533 properties as needed. If the dataset was not previously an encryption root it
4534 will become one. Alternatively, the
4536 flag may be provided to cause an encryption root to inherit the parent's key
4538 .Bl -tag -width "-r"
4540 Ensures the key is loaded before attempting to change the key. This is
4541 effectively equivalent to
4542 .Qq Nm zfs Cm load-key Ar filesystem ; Nm zfs Cm change-key Ar filesystem
4543 .It Fl o Ar property Ns = Ns Ar value
4544 Allows the user to set encryption key properties (
4549 ) while changing the key. This is the only way to alter
4553 after the dataset has been created.
4555 Indicates that zfs should make
4557 inherit the key of its parent. Note that this command can only be run on an
4558 encryption root that has an encrypted parent.
4564 utility exits 0 on success, 1 if an error occurs, and 2 if invalid command line
4565 options were specified.
4568 .It Sy Example 1 No Creating a ZFS File System Hierarchy
4569 The following commands create a file system named
4571 and a file system named
4575 is set for the parent file system, and is automatically inherited by the child
4578 # zfs create pool/home
4579 # zfs set mountpoint=/export/home pool/home
4580 # zfs create pool/home/bob
4582 .It Sy Example 2 No Creating a ZFS Snapshot
4583 The following command creates a snapshot named
4585 This snapshot is mounted on demand in the
4587 directory at the root of the
4591 # zfs snapshot pool/home/bob@yesterday
4593 .It Sy Example 3 No Creating and Destroying Multiple Snapshots
4594 The following command creates snapshots named
4598 and all of its descendent file systems.
4599 Each snapshot is mounted on demand in the
4601 directory at the root of its file system.
4602 The second command destroys the newly created snapshots.
4604 # zfs snapshot -r pool/home@yesterday
4605 # zfs destroy -r pool/home@yesterday
4607 .It Sy Example 4 No Disabling and Enabling File System Compression
4608 The following command disables the
4610 property for all file systems under
4612 The next command explicitly enables
4615 .Em pool/home/anne .
4617 # zfs set compression=off pool/home
4618 # zfs set compression=on pool/home/anne
4620 .It Sy Example 5 No Listing ZFS Datasets
4621 The following command lists all active file systems and volumes in the system.
4622 Snapshots are displayed if the
4630 for more information on pool properties.
4633 NAME USED AVAIL REFER MOUNTPOINT
4634 pool 450K 457G 18K /pool
4635 pool/home 315K 457G 21K /export/home
4636 pool/home/anne 18K 457G 18K /export/home/anne
4637 pool/home/bob 276K 457G 276K /export/home/bob
4639 .It Sy Example 6 No Setting a Quota on a ZFS File System
4640 The following command sets a quota of 50 Gbytes for
4643 # zfs set quota=50G pool/home/bob
4645 .It Sy Example 7 No Listing ZFS Properties
4646 The following command lists all properties for
4649 # zfs get all pool/home/bob
4650 NAME PROPERTY VALUE SOURCE
4651 pool/home/bob type filesystem -
4652 pool/home/bob creation Tue Jul 21 15:53 2009 -
4653 pool/home/bob used 21K -
4654 pool/home/bob available 20.0G -
4655 pool/home/bob referenced 21K -
4656 pool/home/bob compressratio 1.00x -
4657 pool/home/bob mounted yes -
4658 pool/home/bob quota 20G local
4659 pool/home/bob reservation none default
4660 pool/home/bob recordsize 128K default
4661 pool/home/bob mountpoint /pool/home/bob default
4662 pool/home/bob sharenfs off default
4663 pool/home/bob checksum on default
4664 pool/home/bob compression on local
4665 pool/home/bob atime on default
4666 pool/home/bob devices on default
4667 pool/home/bob exec on default
4668 pool/home/bob setuid on default
4669 pool/home/bob readonly off default
4670 pool/home/bob zoned off default
4671 pool/home/bob snapdir hidden default
4672 pool/home/bob acltype off default
4673 pool/home/bob aclinherit restricted default
4674 pool/home/bob canmount on default
4675 pool/home/bob xattr on default
4676 pool/home/bob copies 1 default
4677 pool/home/bob version 4 -
4678 pool/home/bob utf8only off -
4679 pool/home/bob normalization none -
4680 pool/home/bob casesensitivity sensitive -
4681 pool/home/bob vscan off default
4682 pool/home/bob nbmand off default
4683 pool/home/bob sharesmb off default
4684 pool/home/bob refquota none default
4685 pool/home/bob refreservation none default
4686 pool/home/bob primarycache all default
4687 pool/home/bob secondarycache all default
4688 pool/home/bob usedbysnapshots 0 -
4689 pool/home/bob usedbydataset 21K -
4690 pool/home/bob usedbychildren 0 -
4691 pool/home/bob usedbyrefreservation 0 -
4694 The following command gets a single property value.
4696 # zfs get -H -o value compression pool/home/bob
4699 The following command lists all properties with local settings for
4702 # zfs get -r -s local -o name,property,value all pool/home/bob
4704 pool/home/bob quota 20G
4705 pool/home/bob compression on
4707 .It Sy Example 8 No Rolling Back a ZFS File System
4708 The following command reverts the contents of
4710 to the snapshot named
4712 deleting all intermediate snapshots.
4714 # zfs rollback -r pool/home/anne@yesterday
4716 .It Sy Example 9 No Creating a ZFS Clone
4717 The following command creates a writable file system whose initial contents are
4719 .Em pool/home/bob@yesterday .
4721 # zfs clone pool/home/bob@yesterday pool/clone
4723 .It Sy Example 10 No Promoting a ZFS Clone
4724 The following commands illustrate how to test out changes to a file system, and
4725 then replace the original file system with the changed one, using clones, clone
4726 promotion, and renaming:
4728 # zfs create pool/project/production
4729 populate /pool/project/production with data
4730 # zfs snapshot pool/project/production@today
4731 # zfs clone pool/project/production@today pool/project/beta
4732 make changes to /pool/project/beta and test them
4733 # zfs promote pool/project/beta
4734 # zfs rename pool/project/production pool/project/legacy
4735 # zfs rename pool/project/beta pool/project/production
4736 once the legacy version is no longer needed, it can be destroyed
4737 # zfs destroy pool/project/legacy
4739 .It Sy Example 11 No Inheriting ZFS Properties
4740 The following command causes
4746 property from their parent.
4748 # zfs inherit checksum pool/home/bob pool/home/anne
4750 .It Sy Example 12 No Remotely Replicating ZFS Data
4751 The following commands send a full stream and then an incremental stream to a
4752 remote machine, restoring them into
4753 .Em poolB/received/fs@a
4755 .Em poolB/received/fs@b ,
4758 must contain the file system
4759 .Em poolB/received ,
4760 and must not initially contain
4761 .Em poolB/received/fs .
4763 # zfs send pool/fs@a | \e
4764 ssh host zfs receive poolB/received/fs@a
4765 # zfs send -i a pool/fs@b | \e
4766 ssh host zfs receive poolB/received/fs
4768 .It Sy Example 13 No Using the zfs receive -d Option
4769 The following command sends a full stream of
4770 .Em poolA/fsA/fsB@snap
4771 to a remote machine, receiving it into
4772 .Em poolB/received/fsA/fsB@snap .
4775 portion of the received snapshot's name is determined from the name of the sent
4778 must contain the file system
4779 .Em poolB/received .
4781 .Em poolB/received/fsA
4782 does not exist, it is created as an empty file system.
4784 # zfs send poolA/fsA/fsB@snap | \e
4785 ssh host zfs receive -d poolB/received
4787 .It Sy Example 14 No Setting User Properties
4788 The following example sets the user-defined
4789 .Sy com.example:department
4790 property for a dataset.
4792 # zfs set com.example:department=12345 tank/accounting
4794 .It Sy Example 15 No Performing a Rolling Snapshot
4795 The following example shows how to maintain a history of snapshots with a
4796 consistent naming scheme.
4797 To keep a week's worth of snapshots, the user destroys the oldest snapshot,
4798 renames the remaining snapshots, and then creates a new snapshot, as follows:
4800 # zfs destroy -r pool/users@7daysago
4801 # zfs rename -r pool/users@6daysago @7daysago
4802 # zfs rename -r pool/users@5daysago @6daysago
4803 # zfs rename -r pool/users@4daysago @5daysago
4804 # zfs rename -r pool/users@3daysago @4daysago
4805 # zfs rename -r pool/users@2daysago @3daysago
4806 # zfs rename -r pool/users@yesterday @2daysago
4807 # zfs rename -r pool/users@today @yesterday
4808 # zfs snapshot -r pool/users@today
4810 .It Sy Example 16 No Setting sharenfs Property Options on a ZFS File System
4811 The following commands show how to set
4813 property options to enable
4817 addresses and to enable root access for system
4823 # zfs set sharenfs='rw=@123.123.0.0/16,root=neo' tank/home
4828 for host name resolution, specify the fully qualified hostname.
4829 .It Sy Example 17 No Delegating ZFS Administration Permissions on a ZFS Dataset
4830 The following example shows how to set permissions so that user
4832 can create, destroy, mount, and take snapshots on
4838 # zfs allow cindys create,destroy,mount,snapshot tank/cindys
4839 # zfs allow tank/cindys
4840 ---- Permissions on tank/cindys --------------------------------------
4841 Local+Descendent permissions:
4842 user cindys create,destroy,mount,snapshot
4847 mount point permission is set to 755 by default, user
4849 will be unable to mount file systems under
4851 Add an ACE similar to the following syntax to provide mount point access:
4853 # chmod A+user:cindys:add_subdirectory:allow /tank/cindys
4855 .It Sy Example 18 No Delegating Create Time Permissions on a ZFS Dataset
4856 The following example shows how to grant anyone in the group
4858 to create file systems in
4860 This syntax also allows staff members to destroy their own file systems, but not
4861 destroy anyone else's file system.
4866 # zfs allow staff create,mount tank/users
4867 # zfs allow -c destroy tank/users
4868 # zfs allow tank/users
4869 ---- Permissions on tank/users ---------------------------------------
4872 Local+Descendent permissions:
4873 group staff create,mount
4875 .It Sy Example 19 No Defining and Granting a Permission Set on a ZFS Dataset
4876 The following example shows how to define and grant a permission set on the
4883 # zfs allow -s @pset create,destroy,snapshot,mount tank/users
4884 # zfs allow staff @pset tank/users
4885 # zfs allow tank/users
4886 ---- Permissions on tank/users ---------------------------------------
4888 @pset create,destroy,mount,snapshot
4889 Local+Descendent permissions:
4892 .It Sy Example 20 No Delegating Property Permissions on a ZFS Dataset
4893 The following example shows to grant the ability to set quotas and reservations
4901 # zfs allow cindys quota,reservation users/home
4902 # zfs allow users/home
4903 ---- Permissions on users/home ---------------------------------------
4904 Local+Descendent permissions:
4905 user cindys quota,reservation
4906 cindys% zfs set quota=10G users/home/marks
4907 cindys% zfs get quota users/home/marks
4908 NAME PROPERTY VALUE SOURCE
4909 users/home/marks quota 10G local
4911 .It Sy Example 21 No Removing ZFS Delegated Permissions on a ZFS Dataset
4912 The following example shows how to remove the snapshot permission from the
4921 # zfs unallow staff snapshot tank/users
4922 # zfs allow tank/users
4923 ---- Permissions on tank/users ---------------------------------------
4925 @pset create,destroy,mount,snapshot
4926 Local+Descendent permissions:
4929 .It Sy Example 22 No Showing the differences between a snapshot and a ZFS Dataset
4930 The following example shows how to see what has changed between a prior
4931 snapshot of a ZFS dataset and its current state.
4934 option is used to indicate type information for the files affected.
4936 # zfs diff -F tank/test@before tank/test
4938 M F /tank/test/linked (+1)
4939 R F /tank/test/oldname -> /tank/test/newname
4940 - F /tank/test/deleted
4941 + F /tank/test/created
4942 M F /tank/test/modified
4944 .It Sy Example 23 No Creating a bookmark
4945 The following example create a bookmark to a snapshot. This bookmark
4946 can then be used instead of snapshot in send streams.
4948 # zfs bookmark rpool@snapshot rpool#bookmark
4950 .It Sy Example 24 No Setting sharesmb Property Options on a ZFS File System
4951 The following example show how to share SMB filesystem through ZFS. Note that
4952 that a user and his/her password must be given.
4954 # smbmount //127.0.0.1/share_tmp /mnt/tmp \\
4955 -o user=workgroup/turbo,password=obrut,uid=1000
4959 .Em /etc/samba/smb.conf
4960 configuration required:
4962 Samba will need to listen to 'localhost' (127.0.0.1) for the ZFS utilities to
4963 communicate with Samba. This is the default behavior for most Linux
4966 Samba must be able to authenticate a user. This can be done in a number of
4967 ways, depending on if using the system password file, LDAP or the Samba
4968 specific smbpasswd file. How to do this is outside the scope of this manual.
4971 man page for more information.
4974 .Sy USERSHARE section
4977 man page for all configuration options in case you need to modify any options
4978 to the share afterwards. Do note that any changes done with the
4980 command will be undone if the share is ever unshared (such as at a reboot etc).
4982 .Sh INTERFACE STABILITY
projects / mirror_zfs.git / blob