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. Valid values are zero or a
1525 power of two from 512B up to 128K. The default size is 0 which means no
1526 small file blocks will be allocated in the special class.
1528 Before setting this property, a special class vdev must be added to the
1531 for more details on the special allocation class.
1532 .It Sy mountpoint Ns = Ns Pa path Ns | Ns Sy none Ns | Ns Sy legacy
1533 Controls the mount point used for this file system.
1536 section for more information on how this property is used.
1540 property is changed for a file system, the file system and any children that
1541 inherit the mount point are unmounted.
1544 then they remain unmounted.
1545 Otherwise, they are automatically remounted in the new location if the property
1550 or if they were mounted before the property was changed.
1551 In addition, any shared file systems are unshared and shared in the new
1553 .It Sy nbmand Ns = Ns Sy on Ns | Ns Sy off
1554 Controls whether the file system should be mounted with
1556 .Pq Non Blocking mandatory locks .
1557 This is used for SMB clients.
1558 Changes to this property only take effect when the file system is umounted and
1562 for more information on
1564 mounts. This property is not used on Linux.
1565 .It Sy overlay Ns = Ns Sy off Ns | Ns Sy on
1566 Allow mounting on a busy directory or a directory which already contains
1567 files or directories. This is the default mount behavior for Linux file systems.
1568 For consistency with OpenZFS on other platforms overlay mounts are
1572 to enable overlay mounts.
1573 .It Sy primarycache Ns = Ns Sy all Ns | Ns Sy none Ns | Ns Sy metadata
1574 Controls what is cached in the primary cache
1576 If this property is set to
1578 then both user data and metadata is cached.
1579 If this property is set to
1581 then neither user data nor metadata is cached.
1582 If this property is set to
1584 then only metadata is cached.
1585 The default value is
1587 .It Sy quota Ns = Ns Em size Ns | Ns Sy none
1588 Limits the amount of space a dataset and its descendents can consume.
1589 This property enforces a hard limit on the amount of space used.
1590 This includes all space consumed by descendents, including file systems and
1592 Setting a quota on a descendent of a dataset that already has a quota does not
1593 override the ancestor's quota, but rather imposes an additional limit.
1595 Quotas cannot be set on volumes, as the
1597 property acts as an implicit quota.
1598 .It Sy snapshot_limit Ns = Ns Em count Ns | Ns Sy none
1599 Limits the number of snapshots that can be created on a dataset and its
1603 on a descendent of a dataset that already has a
1605 does not override the ancestor's
1606 .Sy snapshot_limit ,
1607 but rather imposes an additional limit.
1608 The limit is not enforced if the user is allowed to change the limit.
1609 For example, this means that recursive snapshots taken from the global zone are
1610 counted against each delegated dataset within a zone.
1611 This feature must be enabled to be used
1613 .Xr zpool-features 5
1615 .It Sy userquota@ Ns Em user Ns = Ns Em size Ns | Ns Sy none
1616 Limits the amount of space consumed by the specified user.
1617 User space consumption is identified by the
1618 .Sy userspace@ Ns Em user
1621 Enforcement of user quotas may be delayed by several seconds.
1622 This delay means that a user might exceed their quota before the system notices
1623 that they are over quota and begins to refuse additional writes with the
1627 .Nm zfs Cm userspace
1628 subcommand for more information.
1630 Unprivileged users can only access their own groups' space usage.
1631 The root user, or a user who has been granted the
1635 can get and set everyone's quota.
1637 This property is not available on volumes, on file systems before version 4, or
1638 on pools before version 15.
1640 .Sy userquota@ Ns Em ...
1641 properties are not displayed by
1642 .Nm zfs Cm get Sy all .
1643 The user's name must be appended after the
1645 symbol, using one of the following forms:
1653 .Em POSIX numeric ID
1660 .Sy joe.smith@mydomain
1669 Files created on Linux always have POSIX owners.
1670 .It Sy userobjquota@ Ns Em user Ns = Ns Em size Ns | Ns Sy none
1675 but it limits the number of objects a user can create. Please refer to
1677 for more information about how objects are counted.
1678 .It Sy groupquota@ Ns Em group Ns = Ns Em size Ns | Ns Sy none
1679 Limits the amount of space consumed by the specified group.
1680 Group space consumption is identified by the
1681 .Sy groupused@ Ns Em group
1684 Unprivileged users can access only their own groups' space usage.
1685 The root user, or a user who has been granted the
1689 can get and set all groups' quotas.
1690 .It Sy groupobjquota@ Ns Em group Ns = Ns Em size Ns | Ns Sy none
1695 but it limits number of objects a group can consume. Please refer to
1697 for more information about how objects are counted.
1698 .It Sy projectquota@ Ns Em project Ns = Ns Em size Ns | Ns Sy none
1699 Limits the amount of space consumed by the specified project. Project
1700 space consumption is identified by the
1701 .Sy projectused@ Ns Em project
1702 property. Please refer to
1704 for more information about how project is identified and set/changed.
1706 The root user, or a user who has been granted the
1710 can access all projects' quota.
1711 .It Sy projectobjquota@ Ns Em project Ns = Ns Em size Ns | Ns Sy none
1716 but it limits number of objects a project can consume. Please refer to
1718 for more information about how objects are counted.
1719 .It Sy readonly Ns = Ns Sy on Ns | Ns Sy off
1720 Controls whether this dataset can be modified.
1721 The default value is
1727 are equivalent to the
1733 This property can also be referred to by its shortened column name,
1735 .It Sy recordsize Ns = Ns Em size
1736 Specifies a suggested block size for files in the file system.
1737 This property is designed solely for use with database workloads that access
1738 files in fixed-size records.
1739 ZFS automatically tunes block sizes according to internal algorithms optimized
1740 for typical access patterns.
1742 For databases that create very large files but access them in small random
1743 chunks, these algorithms may be suboptimal.
1746 greater than or equal to the record size of the database can result in
1747 significant performance gains.
1748 Use of this property for general purpose file systems is strongly discouraged,
1749 and may adversely affect performance.
1751 The size specified must be a power of two greater than or equal to 512 and less
1752 than or equal to 128 Kbytes.
1755 feature is enabled on the pool, the size may be up to 1 Mbyte.
1757 .Xr zpool-features 5
1758 for details on ZFS feature flags.
1760 Changing the file system's
1762 affects only files created afterward; existing files are unaffected.
1764 This property can also be referred to by its shortened column name,
1766 .It Sy redundant_metadata Ns = Ns Sy all Ns | Ns Sy most
1767 Controls what types of metadata are stored redundantly.
1768 ZFS stores an extra copy of metadata, so that if a single block is corrupted,
1769 the amount of user data lost is limited.
1770 This extra copy is in addition to any redundancy provided at the pool level
1771 .Pq e.g. by mirroring or RAID-Z ,
1772 and is in addition to an extra copy specified by the
1775 .Pq up to a total of 3 copies .
1776 For example if the pool is mirrored,
1777 .Sy copies Ns = Ns 2 ,
1779 .Sy redundant_metadata Ns = Ns Sy most ,
1780 then ZFS stores 6 copies of most metadata, and 4 copies of data and some
1785 ZFS stores an extra copy of all metadata.
1786 If a single on-disk block is corrupt, at worst a single block of user data
1795 ZFS stores an extra copy of most types of metadata.
1796 This can improve performance of random writes, because less metadata must be
1798 In practice, at worst about 100 blocks
1803 of user data can be lost if a single on-disk block is corrupt.
1804 The exact behavior of which metadata blocks are stored redundantly may change in
1807 The default value is
1809 .It Sy refquota Ns = Ns Em size Ns | Ns Sy none
1810 Limits the amount of space a dataset can consume.
1811 This property enforces a hard limit on the amount of space used.
1812 This hard limit does not include space used by descendents, including file
1813 systems and snapshots.
1814 .It Sy refreservation Ns = Ns Em size Ns | Ns Sy none Ns | Ns Sy auto
1815 The minimum amount of space guaranteed to a dataset, not including its
1817 When the amount of space used is below this value, the dataset is treated as if
1818 it were taking up the amount of space specified by
1819 .Sy refreservation .
1822 reservation is accounted for in the parent datasets' space used, and counts
1823 against the parent datasets' quotas and reservations.
1827 is set, a snapshot is only allowed if there is enough free pool space outside of
1828 this reservation to accommodate the current number of
1830 bytes in the dataset.
1836 a volume is thick provisioned
1840 .Sy refreservation Ns = Ns Sy auto
1841 is only supported on volumes.
1845 .Sx Native Properties
1846 section for more information about sparse volumes.
1848 This property can also be referred to by its shortened column name,
1850 .It Sy relatime Ns = Ns Sy on Ns | Ns Sy off
1851 Controls the manner in which the access time is updated when
1853 is set. Turning this property on causes the access time to be updated relative
1854 to the modify or change time. Access time is only updated if the previous
1855 access time was earlier than the current modify or change time or if the
1856 existing access time hasn't been updated within the past 24 hours. The default
1863 are equivalent to the
1868 .It Sy reservation Ns = Ns Em size Ns | Ns Sy none
1869 The minimum amount of space guaranteed to a dataset and its descendants.
1870 When the amount of space used is below this value, the dataset is treated as if
1871 it were taking up the amount of space specified by its reservation.
1872 Reservations are accounted for in the parent datasets' space used, and count
1873 against the parent datasets' quotas and reservations.
1875 This property can also be referred to by its shortened column name,
1877 .It Sy secondarycache Ns = Ns Sy all Ns | Ns Sy none Ns | Ns Sy metadata
1878 Controls what is cached in the secondary cache
1880 If this property is set to
1882 then both user data and metadata is cached.
1883 If this property is set to
1885 then neither user data nor metadata is cached.
1886 If this property is set to
1888 then only metadata is cached.
1889 The default value is
1891 .It Sy setuid Ns = Ns Sy on Ns | Ns Sy off
1892 Controls whether the setuid bit is respected for the file system.
1893 The default value is
1899 are equivalent to the
1904 .It Sy sharesmb Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Em opts
1905 Controls whether the file system is shared by using
1906 .Sy Samba USERSHARES
1907 and what options are to be used. Otherwise, the file system is automatically
1908 shared and unshared with the
1912 commands. If the property is set to on, the
1914 command is invoked to create a
1917 Because SMB shares requires a resource name, a unique resource name is
1918 constructed from the dataset name. The constructed name is a copy of the
1919 dataset name except that the characters in the dataset name, which would be
1920 invalid in the resource name, are replaced with underscore (_) characters.
1921 Linux does not currently support additional options which might be available
1928 the file systems are unshared.
1930 The share is created with the ACL (Access Control List) "Everyone:F" ("F"
1931 stands for "full permissions", ie. read and write permissions) and no guest
1932 access (which means Samba must be able to authenticate a real user, system
1933 passwd/shadow, LDAP or smbpasswd based) by default. This means that any
1934 additional access control (disallow specific user specific access etc) must
1935 be done on the underlying file system.
1936 .It Sy sharenfs Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Em opts
1937 Controls whether the file system is shared via NFS, and what options are to be
1939 A file system with a
1945 command and entries in the
1948 Otherwise, the file system is automatically shared and unshared with the
1953 If the property is set to
1955 the dataset is shared using the default options:
1957 .Em sec=sys,rw,crossmnt,no_subtree_check,no_root_squash
1961 for the meaning of the default options. Otherwise, the
1963 command is invoked with options equivalent to the contents of this property.
1967 property is changed for a dataset, the dataset and any children inheriting the
1968 property are re-shared with the new options, only if the property was previously
1970 or if they were shared before the property was changed.
1971 If the new property is
1973 the file systems are unshared.
1974 .It Sy logbias Ns = Ns Sy latency Ns | Ns Sy throughput
1975 Provide a hint to ZFS about handling of synchronous requests in this dataset.
1981 ZFS will use pool log devices
1983 to handle the requests at low latency.
1988 ZFS will not use configured pool log devices.
1989 ZFS will instead optimize synchronous operations for global pool throughput and
1990 efficient use of resources.
1991 .It Sy snapdev Ns = Ns Sy hidden Ns | Ns Sy visible
1992 Controls whether the volume snapshot devices under
1993 .Em /dev/zvol/<pool>
1994 are hidden or visible. The default value is
1996 .It Sy snapdir Ns = Ns Sy hidden Ns | Ns Sy visible
1997 Controls whether the
1999 directory is hidden or visible in the root of the file system as discussed in
2003 The default value is
2005 .It Sy sync Ns = Ns Sy standard Ns | Ns Sy always Ns | Ns Sy disabled
2006 Controls the behavior of synchronous requests
2007 .Pq e.g. fsync, O_DSYNC .
2011 specified behavior of ensuring all synchronous requests are written to stable
2012 storage and all devices are flushed to ensure data is not cached by device
2014 .Pq this is the default .
2016 causes every file system transaction to be written and flushed before its
2017 system call returns.
2018 This has a large performance penalty.
2020 disables synchronous requests.
2021 File system transactions are only committed to stable storage periodically.
2022 This option will give the highest performance.
2023 However, it is very dangerous as ZFS would be ignoring the synchronous
2024 transaction demands of applications such as databases or NFS.
2025 Administrators should only use this option when the risks are understood.
2026 .It Sy version Ns = Ns Em N Ns | Ns Sy current
2027 The on-disk version of this file system, which is independent of the pool
2029 This property can only be set to later supported versions.
2033 .It Sy volsize Ns = Ns Em size
2034 For volumes, specifies the logical size of the volume.
2035 By default, creating a volume establishes a reservation of equal size.
2036 For storage pools with a version number of 9 or higher, a
2041 are reflected in an equivalent change to the reservation
2047 can only be set to a multiple of
2051 The reservation is kept equal to the volume's logical size to prevent unexpected
2052 behavior for consumers.
2053 Without the reservation, the volume could run out of space, resulting in
2054 undefined behavior or data corruption, depending on how the volume is used.
2055 These effects can also occur when the volume size is changed while it is in use
2056 .Pq particularly when shrinking the size .
2057 Extreme care should be used when adjusting the volume size.
2059 Though not recommended, a
2062 .Qq thin provisioned
2064 can be created by specifying the
2067 .Nm zfs Cm create Fl V
2068 command, or by changing the value of the
2073 property on pool version 8 or earlier
2075 after the volume has been created.
2078 is a volume where the value of
2080 is less than the size of the volume plus the space required to store its
2082 Consequently, writes to a sparse volume can fail with
2084 when the pool is low on space.
2085 For a sparse volume, changes to
2087 are not reflected in the
2089 A volume that is not sparse is said to be
2090 .Qq thick provisioned .
2091 A sparse volume can become thick provisioned by setting
2095 .It Sy volmode Ns = Ns Cm default | full | geom | dev | none
2096 This property specifies how volumes should be exposed to the OS.
2099 exposes volumes as fully fledged block devices, providing maximal
2100 functionality. The value
2102 is just an alias for
2104 and is kept for compatibility.
2107 hides its partitions.
2108 Volumes with property set to
2110 are not exposed outside ZFS, but can be snapshoted, cloned, replicated, etc,
2111 that can be suitable for backup purposes.
2114 means that volumes exposition is controlled by system-wide tunable
2121 are encoded as 1, 2 and 3 respectively.
2122 The default values is
2124 .It Sy vscan Ns = Ns Sy on Ns | Ns Sy off
2125 Controls whether regular files should be scanned for viruses when a file is
2127 In addition to enabling this property, the virus scan service must also be
2128 enabled for virus scanning to occur.
2129 The default value is
2131 This property is not used on Linux.
2132 .It Sy xattr Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy sa
2133 Controls whether extended attributes are enabled for this file system. Two
2134 styles of extended attributes are supported either directory based or system
2137 The default value of
2139 enables directory based extended attributes. This style of extended attribute
2140 imposes no practical limit on either the size or number of attributes which
2141 can be set on a file. Although under Linux the
2145 system calls limit the maximum size to 64K. This is the most compatible
2146 style of extended attribute and is supported by all OpenZFS implementations.
2148 System attribute based xattrs can be enabled by setting the value to
2150 The key advantage of this type of xattr is improved performance. Storing
2151 extended attributes as system attributes significantly decreases the amount of
2152 disk IO required. Up to 64K of data may be stored per-file in the space
2153 reserved for system attributes. If there is not enough space available for
2154 an extended attribute then it will be automatically written as a directory
2155 based xattr. System attribute based extended attributes are not accessible
2156 on platforms which do not support the
2160 The use of system attribute based xattrs is strongly encouraged for users of
2161 SELinux or POSIX ACLs. Both of these features heavily rely of extended
2162 attributes and benefit significantly from the reduced access time.
2168 are equivalent to the
2173 .It Sy zoned Ns = Ns Sy on Ns | Ns Sy off
2174 Controls whether the dataset is managed from a non-global zone. Zones are a
2175 Solaris feature and are not relevant on Linux. The default value is
2179 The following three properties cannot be changed after the file system is
2180 created, and therefore, should be set when the file system is created.
2181 If the properties are not set with the
2185 commands, these properties are inherited from the parent dataset.
2186 If the parent dataset lacks these properties due to having been created prior to
2187 these features being supported, the new file system will have the default values
2188 for these properties.
2191 .Sy casesensitivity Ns = Ns Sy sensitive Ns | Ns
2192 .Sy insensitive Ns | Ns Sy mixed
2194 Indicates whether the file name matching algorithm used by the file system
2195 should be case-sensitive, case-insensitive, or allow a combination of both
2197 The default value for the
2205 file systems have case-sensitive file names.
2211 property indicates that the file system can support requests for both
2212 case-sensitive and case-insensitive matching behavior.
2213 Currently, case-insensitive matching behavior on a file system that supports
2214 mixed behavior is limited to the SMB server product.
2215 For more information about the
2217 value behavior, see the "ZFS Administration Guide".
2219 .Sy normalization Ns = Ns Sy none Ns | Ns Sy formC Ns | Ns
2220 .Sy formD Ns | Ns Sy formKC Ns | Ns Sy formKD
2222 Indicates whether the file system should perform a
2224 normalization of file names whenever two file names are compared, and which
2225 normalization algorithm should be used.
2226 File names are always stored unmodified, names are normalized as part of any
2228 If this property is set to a legal value other than
2232 property was left unspecified, the
2234 property is automatically set to
2236 The default value of the
2240 This property cannot be changed after the file system is created.
2241 .It Sy utf8only Ns = Ns Sy on Ns | Ns Sy off
2242 Indicates whether the file system should reject file names that include
2243 characters that are not present in the
2246 If this property is explicitly set to
2248 the normalization property must either not be explicitly set or be set to
2250 The default value for the
2254 This property cannot be changed after the file system is created.
2258 .Sy casesensitivity ,
2262 properties are also new permissions that can be assigned to non-privileged users
2263 by using the ZFS delegated administration feature.
2264 .Ss "Temporary Mount Point Properties"
2265 When a file system is mounted, either through
2267 for legacy mounts or the
2269 command for normal file systems, its mount options are set according to its
2271 The correlation between properties and mount options is as follows:
2273 PROPERTY MOUNT OPTION
2275 canmount auto/noauto
2279 relatime relatime/norelatime
2284 In addition, these options can be set on a per-mount basis using the
2286 option, without affecting the property that is stored on disk.
2287 The values specified on the command line override the values stored in the
2291 option is an alias for
2292 .Sy nodevices Ns \&, Ns Sy nosetuid .
2293 These properties are reported as
2298 If the properties are changed while the dataset is mounted, the new setting
2299 overrides any temporary settings.
2300 .Ss "User Properties"
2301 In addition to the standard native properties, ZFS supports arbitrary user
2303 User properties have no effect on ZFS behavior, but applications or
2304 administrators can use them to annotate datasets
2305 .Pq file systems, volumes, and snapshots .
2307 User property names must contain a colon
2309 character to distinguish them from native properties.
2310 They may contain lowercase letters, numbers, and the following punctuation
2319 The expected convention is that the property name is divided into two portions
2321 .Em module Ns \&: Ns Em property ,
2322 but this namespace is not enforced by ZFS.
2323 User property names can be at most 256 characters, and cannot begin with a dash
2326 When making programmatic use of user properties, it is strongly suggested to use
2331 component of property names to reduce the chance that two
2332 independently-developed packages use the same property name for different
2335 The values of user properties are arbitrary strings, are always inherited, and
2336 are never validated.
2337 All of the commands that operate on properties
2338 .Po Nm zfs Cm list ,
2343 can be used to manipulate both native properties and user properties.
2346 command to clear a user property.
2347 If the property is not defined in any parent dataset, it is removed entirely.
2348 Property values are limited to 8192 bytes.
2349 .Ss ZFS Volumes as Swap
2350 ZFS volumes may be used as swap devices. After creating the volume with the
2351 .Nm zfs Cm create Fl V
2352 command set up and enable the swap area using the
2356 commands. Do not swap to a file on a ZFS file system. A ZFS swap file
2357 configuration is not supported.
2361 feature allows for the creation of encrypted filesystems and volumes.
2363 will encrypt all user data including file and zvol data, file attributes,
2364 ACLs, permission bits, directory listings, FUID mappings, and userused /
2367 will not encrypt metadata related to the pool structure, including dataset
2368 names, dataset hierarchy, file size, file holes, and dedup tables. Key rotation
2369 is managed internally by the kernel module and changing the user's key does not
2370 require re-encrypting the entire dataset. Datasets can be scrubbed, resilvered,
2371 renamed, and deleted without the encryption keys being loaded (see the
2373 subcommand for more info on key loading).
2375 Creating an encrypted dataset requires specifying the
2379 properties at creation time, along with an optional
2383 After entering an encryption key, the
2384 created dataset will become an encryption root. Any descendant datasets will
2385 inherit their encryption key from the encryption root by default, meaning that
2386 loading, unloading, or changing the key for the encryption root will implicitly
2387 do the same for all inheriting datasets. If this inheritance is not desired,
2390 when creating the child dataset or use
2391 .Nm zfs Cm change-key
2392 to break an existing relationship, creating a new encryption root on the child.
2393 Note that the child's
2395 may match that of the parent while still creating a new encryption root, and
2398 property alone does not create a new encryption root; this would simply use a
2399 different cipher suite with the same key as its encryption root. The one
2400 exception is that clones will always use their origin's encryption key.
2401 As a result of this exception, some encryption-related properties (namely
2407 do not inherit like other ZFS properties and instead use the value determined
2408 by their encryption root. Encryption root inheritance can be tracked via the
2413 Encryption changes the behavior of a few
2415 operations. Encryption is applied after compression so compression ratios are
2416 preserved. Normally checksums in ZFS are 256 bits long, but for encrypted data
2417 the checksum is 128 bits of the user-chosen checksum and 128 bits of MAC from
2418 the encryption suite, which provides additional protection against maliciously
2419 altered data. Deduplication is still possible with encryption enabled but for
2420 security, datasets will only dedup against themselves, their snapshots, and
2423 There are a few limitations on encrypted datasets. Encrypted data cannot be
2426 feature. Encrypted datasets may not have
2427 .Sy copies Ns = Ns Em 3
2428 since the implementation stores some encryption metadata where the third copy
2429 would normally be. Since compression is applied before encryption datasets may
2430 be vulnerable to a CRIME-like attack if applications accessing the data allow
2431 for it. Deduplication with encryption will leak information about which blocks
2432 are equivalent in a dataset and will incur an extra CPU cost per block written.
2434 All subcommands that modify state are logged persistently to the pool in their
2438 Displays a help message.
2443 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2446 Creates a new ZFS file system.
2447 The file system is automatically mounted according to the
2449 property inherited from the parent.
2450 .Bl -tag -width "-o"
2451 .It Fl o Ar property Ns = Ns Ar value
2452 Sets the specified property as if the command
2453 .Nm zfs Cm set Ar property Ns = Ns Ar value
2454 was invoked at the same time the dataset was created.
2455 Any editable ZFS property can also be set at creation time.
2458 options can be specified.
2459 An error results if the same property is specified in multiple
2463 Creates all the non-existing parent datasets.
2464 Datasets created in this manner are automatically mounted according to the
2466 property inherited from their parent.
2467 Any property specified on the command line using the
2470 If the target filesystem already exists, the operation completes successfully.
2476 .Op Fl b Ar blocksize
2477 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2478 .Fl V Ar size Ar volume
2480 Creates a volume of the given size.
2481 The volume is exported as a block device in
2482 .Pa /dev/zvol/path ,
2485 is the name of the volume in the ZFS namespace.
2486 The size represents the logical size as exported by the device.
2487 By default, a reservation of equal size is created.
2490 is automatically rounded up to the nearest 128 Kbytes to ensure that the volume
2491 has an integral number of blocks regardless of
2493 .Bl -tag -width "-b"
2494 .It Fl b Ar blocksize
2496 .Fl o Sy volblocksize Ns = Ns Ar blocksize .
2497 If this option is specified in conjunction with
2498 .Fl o Sy volblocksize ,
2499 the resulting behavior is undefined.
2500 .It Fl o Ar property Ns = Ns Ar value
2501 Sets the specified property as if the
2502 .Nm zfs Cm set Ar property Ns = Ns Ar value
2503 command was invoked at the same time the dataset was created.
2504 Any editable ZFS property can also be set at creation time.
2507 options can be specified.
2508 An error results if the same property is specified in multiple
2512 Creates all the non-existing parent datasets.
2513 Datasets created in this manner are automatically mounted according to the
2515 property inherited from their parent.
2516 Any property specified on the command line using the
2519 If the target filesystem already exists, the operation completes successfully.
2521 Creates a sparse volume with no reservation.
2525 .Sx Native Properties
2526 section for more information about sparse volumes.
2532 .Ar filesystem Ns | Ns Ar volume
2534 Destroys the given dataset.
2535 By default, the command unshares any file systems that are currently shared,
2536 unmounts any file systems that are currently mounted, and refuses to destroy a
2537 dataset that has active dependents
2538 .Pq children or clones .
2539 .Bl -tag -width "-R"
2541 Recursively destroy all dependents, including cloned file systems outside the
2544 Force an unmount of any file systems using the
2547 This option has no effect on non-file systems or unmounted file systems.
2552 No data will be deleted.
2553 This is useful in conjunction with the
2557 flags to determine what data would be deleted.
2559 Print machine-parsable verbose information about the deleted data.
2561 Recursively destroy all children.
2563 Print verbose information about the deleted data.
2566 Extreme care should be taken when applying either the
2570 options, as they can destroy large portions of a pool and cause unexpected
2571 behavior for mounted file systems in use.
2576 .Ar filesystem Ns | Ns Ar volume Ns @ Ns Ar snap Ns
2577 .Oo % Ns Ar snap Ns Oo , Ns Ar snap Ns Oo % Ns Ar snap Oc Oc Oc Ns ...
2579 The given snapshots are destroyed immediately if and only if the
2583 option would have destroyed it.
2584 Such immediate destruction would occur, for example, if the snapshot had no
2585 clones and the user-initiated reference count were zero.
2587 If a snapshot does not qualify for immediate destruction, it is marked for
2589 In this state, it exists as a usable, visible snapshot until both of the
2590 preconditions listed above are met, at which point it is destroyed.
2592 An inclusive range of snapshots may be specified by separating the first and
2593 last snapshots with a percent sign.
2594 The first and/or last snapshots may be left blank, in which case the
2595 filesystem's oldest or newest snapshot will be implied.
2598 .Pq or ranges of snapshots
2599 of the same filesystem or volume may be specified in a comma-separated list of
2601 Only the snapshot's short name
2602 .Po the part after the
2605 should be specified when using a range or comma-separated list to identify
2607 .Bl -tag -width "-R"
2609 Recursively destroy all clones of these snapshots, including the clones,
2610 snapshots, and children.
2611 If this flag is specified, the
2613 flag will have no effect.
2615 Destroy immediately. If a snapshot cannot be destroyed now, mark it for
2616 deferred destruction.
2621 No data will be deleted.
2622 This is useful in conjunction with the
2626 flags to determine what data would be deleted.
2628 Print machine-parsable verbose information about the deleted data.
2631 .Pq or mark for deferred deletion
2632 all snapshots with this name in descendent file systems.
2634 Print verbose information about the deleted data.
2636 Extreme care should be taken when applying either the
2640 options, as they can destroy large portions of a pool and cause unexpected
2641 behavior for mounted file systems in use.
2646 .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
2648 The given bookmark is destroyed.
2653 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2654 .Ar filesystem Ns @ Ns Ar snapname Ns | Ns Ar volume Ns @ Ns Ar snapname Ns ...
2656 Creates snapshots with the given names.
2657 All previous modifications by successful system calls to the file system are
2658 part of the snapshots.
2659 Snapshots are taken atomically, so that all snapshots correspond to the same
2662 can be used as an alias for
2663 .Nm zfs Cm snapshot.
2666 section for details.
2667 .Bl -tag -width "-o"
2668 .It Fl o Ar property Ns = Ns Ar value
2669 Sets the specified property; see
2673 Recursively create snapshots of all descendent datasets
2681 Roll back the given dataset to a previous snapshot.
2682 When a dataset is rolled back, all data that has changed since the snapshot is
2683 discarded, and the dataset reverts to the state at the time of the snapshot.
2684 By default, the command refuses to roll back to a snapshot other than the most
2686 In order to do so, all intermediate snapshots and bookmarks must be destroyed by
2693 options do not recursively destroy the child snapshots of a recursive snapshot.
2694 Only direct snapshots of the specified filesystem are destroyed by either of
2696 To completely roll back a recursive snapshot, you must rollback the individual
2698 .Bl -tag -width "-R"
2700 Destroy any more recent snapshots and bookmarks, as well as any clones of those
2705 option to force an unmount of any clone file systems that are to be destroyed.
2707 Destroy any snapshots and bookmarks more recent than the one specified.
2713 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2714 .Ar snapshot Ar filesystem Ns | Ns Ar volume
2716 Creates a clone of the given snapshot.
2719 section for details.
2720 The target dataset can be located anywhere in the ZFS hierarchy, and is created
2721 as the same type as the original.
2722 .Bl -tag -width "-o"
2723 .It Fl o Ar property Ns = Ns Ar value
2724 Sets the specified property; see
2728 Creates all the non-existing parent datasets.
2729 Datasets created in this manner are automatically mounted according to the
2731 property inherited from their parent.
2732 If the target filesystem or volume already exists, the operation completes
2738 .Ar clone-filesystem
2740 Promotes a clone file system to no longer be dependent on its
2743 This makes it possible to destroy the file system that the clone was created
2745 The clone parent-child dependency relationship is reversed, so that the origin
2746 file system becomes a clone of the specified file system.
2748 The snapshot that was cloned, and any snapshots previous to this snapshot, are
2749 now owned by the promoted clone.
2750 The space they use moves from the origin file system to the promoted clone, so
2751 enough space must be available to accommodate these snapshots.
2752 No new space is consumed by this operation, but the space accounting is
2754 The promoted clone must not have any conflicting snapshot names of its own.
2757 subcommand can be used to rename any conflicting snapshots.
2762 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2763 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2769 .Ar filesystem Ns | Ns Ar volume
2770 .Ar filesystem Ns | Ns Ar volume
2772 Renames the given dataset.
2773 The new target can be located anywhere in the ZFS hierarchy, with the exception
2775 Snapshots can only be renamed within the parent file system or volume.
2776 When renaming a snapshot, the parent file system of the snapshot does not need
2777 to be specified as part of the second argument.
2778 Renamed file systems can inherit new mount points, in which case they are
2779 unmounted and remounted at the new mount point.
2780 .Bl -tag -width "-a"
2782 Force unmount any filesystems that need to be unmounted in the process.
2784 Creates all the nonexistent parent datasets.
2785 Datasets created in this manner are automatically mounted according to the
2787 property inherited from their parent.
2793 .Ar snapshot Ar snapshot
2795 Recursively rename the snapshots of all descendent datasets.
2796 Snapshots are the only dataset that can be renamed recursively.
2800 .Op Fl r Ns | Ns Fl d Ar depth
2802 .Oo Fl o Ar property Ns Oo , Ns Ar property Oc Ns ... Oc
2803 .Oo Fl s Ar property Oc Ns ...
2804 .Oo Fl S Ar property Oc Ns ...
2805 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
2806 .Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Oc Ns ...
2808 Lists the property information for the given datasets in tabular form.
2809 If specified, you can list property information by the absolute pathname or the
2811 By default, all file systems and volumes are displayed.
2812 Snapshots are displayed if the
2819 The following fields are displayed:
2820 .Sy name Ns \&, Sy used Ns \&, Sy available Ns \&, Sy referenced Ns \&, Sy mountpoint Ns .
2821 .Bl -tag -width "-H"
2823 Used for scripting mode.
2824 Do not print headers and separate fields by a single tab instead of arbitrary
2826 .It Fl S Ar property
2829 option, but sorts by property in descending order.
2831 Recursively display any children of the dataset, limiting the recursion to
2837 will display only the dataset and its direct children.
2838 .It Fl o Ar property
2839 A comma-separated list of properties to display.
2840 The property must be:
2843 One of the properties described in the
2844 .Sx Native Properties
2851 to display the dataset name
2855 to display space usage properties on file systems and volumes.
2856 This is a shortcut for specifying
2857 .Fl o Sy name Ns \&, Ns Sy avail Ns \&, Ns Sy used Ns \&, Ns Sy usedsnap Ns \&, Ns
2858 .Sy usedds Ns \&, Ns Sy usedrefreserv Ns \&, Ns Sy usedchild Fl t
2859 .Sy filesystem Ns \&, Ns Sy volume
2863 Display numbers in parsable
2867 Recursively display any children of the dataset on the command line.
2868 .It Fl s Ar property
2869 A property for sorting the output by column in ascending order based on the
2870 value of the property.
2871 The property must be one of the properties described in the
2873 section, or the special value
2875 to sort by the dataset name.
2876 Multiple properties can be specified at one time using multiple
2881 options are evaluated from left to right in decreasing order of importance.
2882 The following is a list of sorting criteria:
2885 Numeric types sort in numeric order.
2887 String types sort in alphabetical order.
2889 Types inappropriate for a row sort that row to the literal bottom, regardless of
2890 the specified ordering.
2893 If no sorting options are specified the existing behavior of
2897 A comma-separated list of types to display, where
2906 For example, specifying
2908 displays only snapshots.
2913 .Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ...
2914 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
2916 Sets the property or list of properties to the given value(s) for each dataset.
2917 Only some properties can be edited.
2920 section for more information on what properties can be set and acceptable
2922 Numeric values can be specified as exact values, or in a human-readable form
2924 .Sy B , K , M , G , T , P , E , Z
2925 .Po for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes,
2926 or zettabytes, respectively
2928 User properties can be set on snapshots.
2929 For more information, see the
2935 .Op Fl r Ns | Ns Fl d Ar depth
2937 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
2938 .Oo Fl s Ar source Ns Oo , Ns Ar source Oc Ns ... Oc
2939 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
2940 .Cm all | Ar property Ns Oo , Ns Ar property Oc Ns ...
2941 .Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Oc Ns ...
2943 Displays properties for the given datasets.
2944 If no datasets are specified, then the command displays properties for all
2945 datasets on the system.
2946 For each property, the following columns are displayed:
2949 property Property name
2950 value Property value
2951 source Property source \fBlocal\fP, \fBdefault\fP, \fBinherited\fP,
2952 \fBtemporary\fP, \fBreceived\fP or none (\fB-\fP).
2955 All columns are displayed by default, though this can be controlled by using the
2958 This command takes a comma-separated list of properties as described in the
2959 .Sx Native Properties
2966 can be used to display all properties that apply to the given dataset's type
2967 .Pq filesystem, volume, snapshot, or bookmark .
2968 .Bl -tag -width "-H"
2970 Display output in a form more easily parsed by scripts.
2971 Any headers are omitted, and fields are explicitly separated by a single tab
2972 instead of an arbitrary amount of space.
2974 Recursively display any children of the dataset, limiting the recursion to
2978 will display only the dataset and its direct children.
2980 A comma-separated list of columns to display.
2981 .Sy name Ns \&, Ns Sy property Ns \&, Ns Sy value Ns \&, Ns Sy source
2982 is the default value.
2984 Display numbers in parsable
2988 Recursively display properties for any children.
2990 A comma-separated list of sources to display.
2991 Those properties coming from a source other than those in this list are ignored.
2992 Each source must be one of the following:
3000 The default value is all sources.
3002 A comma-separated list of types to display, where
3016 .Ar property Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
3018 Clears the specified property, causing it to be inherited from an ancestor,
3019 restored to default if no ancestor has the property set, or with the
3021 option reverted to the received value if one exists.
3024 section for a listing of default values, and details on which properties can be
3026 .Bl -tag -width "-r"
3028 Recursively inherit the given property for all children.
3030 Revert the property to the received value if one exists; otherwise operate as
3033 option was not specified.
3039 Displays a list of file systems that are not the most recent version.
3045 Displays a list of currently supported file system versions.
3051 .Fl a | Ar filesystem
3053 Upgrades file systems to a new on-disk version.
3054 Once this is done, the file systems will no longer be accessible on systems
3055 running older versions of the software.
3057 streams generated from new snapshots of these file systems cannot be accessed on
3058 systems running older versions of the software.
3060 In general, the file system version is independent of the pool version.
3063 for information on the
3064 .Nm zpool Cm upgrade
3067 In some cases, the file system version and the pool version are interrelated and
3068 the pool version must be upgraded before the file system version can be
3070 .Bl -tag -width "-V"
3072 Upgrade to the specified
3076 flag is not specified, this command upgrades to the most recent version.
3078 option can only be used to increase the version number, and only up to the most
3079 recent version supported by this software.
3081 Upgrade all file systems on all imported pools.
3083 Upgrade the specified file system.
3085 Upgrade the specified file system and all descendent file systems.
3091 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
3092 .Oo Fl s Ar field Oc Ns ...
3093 .Oo Fl S Ar field Oc Ns ...
3094 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
3095 .Ar filesystem Ns | Ns Ar snapshot
3097 Displays space consumed by, and quotas on, each user in the specified filesystem
3099 This corresponds to the
3100 .Sy userused@ Ns Em user ,
3101 .Sy userobjused@ Ns Em user ,
3102 .Sy userquota@ Ns Em user,
3104 .Sy userobjquota@ Ns Em user
3106 .Bl -tag -width "-H"
3108 Do not print headers, use tab-delimited output.
3110 Sort by this field in reverse order.
3114 Translate SID to POSIX ID.
3115 The POSIX ID may be ephemeral if no mapping exists.
3116 Normal POSIX interfaces
3121 perform this translation, so the
3123 option allows the output from
3124 .Nm zfs Cm userspace
3125 to be compared directly with those utilities.
3128 may lead to confusion if some files were created by an SMB user before a
3129 SMB-to-POSIX name mapping was established.
3130 In such a case, some files will be owned by the SMB entity and some by the POSIX
3134 option will report that the POSIX entity has the total usage and quota for both.
3136 Print numeric ID instead of user/group name.
3137 .It Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
3138 Display only the specified fields from the following set:
3143 The default is to display all fields.
3149 Sort output by this field.
3154 flags may be specified multiple times to sort first by one field, then by
3157 .Fl s Sy type Fl s Sy name .
3158 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
3159 Print only the specified types from the following set:
3166 .Fl t Sy posixuser Ns \&, Ns Sy smbuser .
3167 The default can be changed to include group types.
3173 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
3174 .Oo Fl s Ar field Oc Ns ...
3175 .Oo Fl S Ar field Oc Ns ...
3176 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
3177 .Ar filesystem Ns | Ns Ar snapshot
3179 Displays space consumed by, and quotas on, each group in the specified
3180 filesystem or snapshot.
3181 This subcommand is identical to
3182 .Nm zfs Cm userspace ,
3183 except that the default types to display are
3184 .Fl t Sy posixgroup Ns \&, Ns Sy smbgroup .
3189 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
3190 .Oo Fl s Ar field Oc Ns ...
3191 .Oo Fl S Ar field Oc Ns ...
3192 .Ar filesystem Ns | Ns Ar snapshot
3194 Displays space consumed by, and quotas on, each project in the specified
3195 filesystem or snapshot. This subcommand is identical to
3196 .Nm zfs Cm userspace ,
3197 except that the project identifier is numeral, not name. So need neither
3200 for SID to POSIX ID nor
3208 .Oo Fl d Ns | Ns Fl r Ns Oc
3209 .Ar file Ns | Ns Ar directory Ns ...
3211 List project identifier (ID) and inherit flag of file(s) or directories.
3212 .Bl -tag -width "-d"
3214 Show the directory project ID and inherit flag, not its childrens. It will
3215 overwrite the former specified
3219 Show on subdirectories recursively. It will overwrite the former specified
3228 .Ar file Ns | Ns Ar directory Ns ...
3230 Clear project inherit flag and/or ID on the file(s) or directories.
3231 .Bl -tag -width "-k"
3233 Keep the project ID unchanged. If not specified, the project ID will be reset
3236 Clear on subdirectories recursively.
3243 .Oo Fl d Ns | Ns Fl r Ns Oc
3245 .Ar file Ns | Ns Ar directory Ns ...
3247 Check project ID and inherit flag on the file(s) or directories, report the
3248 entries without project inherit flag or with different project IDs from the
3251 option) value or the target directory's project ID.
3252 .Bl -tag -width "-0"
3254 Print file name with a trailing NUL instead of newline (by default), like
3257 Check the directory project ID and inherit flag, not its childrens. It will
3258 overwrite the former specified
3262 Specify the referenced ID for comparing with the target file(s) or directories'
3263 project IDs. If not specified, the target (top) directory's project ID will be
3264 used as the referenced one.
3266 Check on subdirectories recursively. It will overwrite the former specified
3275 .Ar file Ns | Ns Ar directory Ns ...
3277 .Bl -tag -width "-p"
3278 Set project ID and/or inherit flag on the file(s) or directories.
3280 Set the file(s)' or directories' project ID with the given value.
3282 Set on subdirectories recursively.
3284 Set project inherit flag on the given file(s) or directories. It is usually used
3285 for setup tree quota on the directory target with
3287 option specified together. When setup tree quota, by default the directory's
3288 project ID will be set to all its descendants unless you specify the project
3297 Displays all ZFS file systems currently mounted.
3303 .Fl a | Ar filesystem
3305 Mounts ZFS file systems.
3306 .Bl -tag -width "-O"
3308 Perform an overlay mount.
3311 for more information.
3313 Mount all available ZFS file systems.
3314 Invoked automatically as part of the boot process.
3316 Mount the specified filesystem.
3318 An optional, comma-separated list of mount options to use temporarily for the
3319 duration of the mount.
3321 .Sx Temporary Mount Point Properties
3322 section for details.
3324 Load keys for encrypted filesystems as they are being mounted. This is
3325 equivalent to executing
3327 on each encryption root before mounting it. Note that if a filesystem has a
3331 this will cause the terminal to interactively block after asking for the key.
3333 Report mount progress.
3339 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
3341 Unmounts currently mounted ZFS file systems.
3342 .Bl -tag -width "-a"
3344 Unmount all available ZFS file systems.
3345 Invoked automatically as part of the shutdown process.
3346 .It Ar filesystem Ns | Ns Ar mountpoint
3347 Unmount the specified filesystem.
3348 The command can also be given a path to a ZFS file system mount point on the
3351 Forcefully unmount the file system, even if it is currently in use.
3356 .Fl a | Ar filesystem
3358 Shares available ZFS file systems.
3359 .Bl -tag -width "-a"
3361 Share all available ZFS file systems.
3362 Invoked automatically as part of the boot process.
3364 Share the specified filesystem according to the
3369 File systems are shared when the
3378 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
3380 Unshares currently shared ZFS file systems.
3381 .Bl -tag -width "-a"
3383 Unshare all available ZFS file systems.
3384 Invoked automatically as part of the shutdown process.
3385 .It Ar filesystem Ns | Ns Ar mountpoint
3386 Unshare the specified filesystem.
3387 The command can also be given a path to a ZFS file system shared on the system.
3392 .Ar snapshot bookmark
3394 Creates a bookmark of the given snapshot.
3395 Bookmarks mark the point in time when the snapshot was created, and can be used
3396 as the incremental source for a
3400 This feature must be enabled to be used.
3402 .Xr zpool-features 5
3403 for details on ZFS feature flags and the
3410 .Op Oo Fl I Ns | Ns Fl i Oc Ar snapshot
3413 Creates a stream representation of the second
3415 which is written to standard output.
3416 The output can be redirected to a file or to a different system
3417 .Po for example, using
3420 By default, a full stream is generated.
3421 .Bl -tag -width "-D"
3423 Generate a deduplicated stream.
3424 Blocks which would have been sent multiple times in the send stream will only be
3426 The receiving system must also support this feature to receive a deduplicated
3428 This flag can be used regardless of the dataset's
3430 property, but performance will be much better if the filesystem uses a
3431 dedup-capable checksum
3435 .It Fl I Ar snapshot
3436 Generate a stream package that sends all intermediary snapshots from the first
3437 snapshot to the second snapshot.
3441 .Fl i Em @a Em fs@b Ns \&; Fl i Em @b Em fs@c Ns \&; Fl i Em @c Em fs@d .
3442 The incremental source may be specified as with the
3445 .It Fl L, -large-block
3446 Generate a stream which may contain blocks larger than 128KB.
3447 This flag has no effect if the
3449 pool feature is disabled, or if the
3451 property of this filesystem has never been set above 128KB.
3452 The receiving system must have the
3454 pool feature enabled as well.
3456 .Xr zpool-features 5
3457 for details on ZFS feature flags and the
3461 Print machine-parsable verbose information about the stream package generated.
3462 .It Fl R, -replicate
3463 Generate a replication stream package, which will replicate the specified
3464 file system, and all descendent file systems, up to the named snapshot.
3465 When received, all properties, snapshots, descendent file systems, and clones
3472 flags are used in conjunction with the
3474 flag, an incremental replication stream is generated.
3475 The current values of properties, and current snapshot and file system names are
3476 set when the stream is received.
3479 flag is specified when this stream is received, snapshots and file systems that
3480 do not exist on the sending side are destroyed.
3482 Generate a more compact stream by using
3484 records for blocks which are stored more compactly on disk by the
3487 This flag has no effect if the
3489 feature is disabled.
3490 The receiving system must have the
3495 feature is active on the sending system, then the receiving system must have
3496 that feature enabled as well. Datasets that are sent with this flag may not be
3497 received as an encrypted dataset, since encrypted datasets cannot use the
3501 .Xr zpool-features 5
3502 for details on ZFS feature flags and the
3506 Sends only received property values whether or not they are overridden by local
3507 settings, but only if the dataset has ever been received. Use this option when
3510 to restore received properties backed up on the sent dataset and to avoid
3511 sending local settings that may have nothing to do with the source dataset,
3512 but only with how the data is backed up.
3513 .It Fl c, -compressed
3514 Generate a more compact stream by using compressed WRITE records for blocks
3515 which are compressed on disk and in memory
3518 property for details
3522 feature is active on the sending system, then the receiving system must have
3523 that feature enabled as well.
3526 feature is enabled on the sending system but the
3528 option is not supplied in conjunction with
3530 then the data will be decompressed before sending so it can be split into
3531 smaller block sizes.
3533 For encrypted datasets, send data exactly as it exists on disk. This allows
3534 backups to be taken even if encryption keys are not currently loaded. The
3535 backup may then be received on an untrusted machine since that machine will
3536 not have the encryption keys to read the protected data or alter it without
3537 being detected. Upon being received, the dataset will have the same encryption
3538 keys as it did on the send side, although the
3540 property will be defaulted to
3542 if not otherwise provided. For unencrypted datasets, this flag will be
3545 Note that if you do not use this flag for sending encrypted datasets, data will
3546 be sent unencrypted and may be re-encrypted with a different encryption key on
3547 the receiving system, which will disable the ability to do a raw send to that
3548 system for incrementals.
3549 .It Fl i Ar snapshot
3550 Generate an incremental stream from the first
3552 .Pq the incremental source
3555 .Pq the incremental target .
3556 The incremental source can be specified as the last component of the snapshot
3560 character and following
3562 and it is assumed to be from the same file system as the incremental target.
3564 If the destination is a clone, the source may be the origin snapshot, which must
3567 .Em pool/fs@origin ,
3575 Do not generate any actual send data.
3576 This is useful in conjunction with the
3580 flags to determine what data will be sent.
3581 In this case, the verbose output will be written to standard output
3582 .Po contrast with a non-dry-run, where the stream is written to standard output
3583 and the verbose output goes to standard error
3586 Include the dataset's properties in the stream.
3587 This flag is implicit when
3590 The receiving system must also support this feature. Sends of encrypted datasets
3593 when using this flag.
3595 Print verbose information about the stream package generated.
3596 This information includes a per-second report of how much data has been sent.
3598 The format of the stream is committed.
3599 You will be able to receive your streams on future versions of ZFS.
3605 .Op Fl i Ar snapshot Ns | Ns Ar bookmark
3606 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
3608 Generate a send stream, which may be of a filesystem, and may be incremental
3610 If the destination is a filesystem or volume, the pool must be read-only, or the
3611 filesystem must not be mounted.
3612 When the stream generated from a filesystem or volume is received, the default
3613 snapshot name will be
3615 .Bl -tag -width "-L"
3616 .It Fl L, -large-block
3617 Generate a stream which may contain blocks larger than 128KB.
3618 This flag has no effect if the
3620 pool feature is disabled, or if the
3622 property of this filesystem has never been set above 128KB.
3623 The receiving system must have the
3625 pool feature enabled as well.
3627 .Xr zpool-features 5
3628 for details on ZFS feature flags and the
3632 Print machine-parsable verbose information about the stream package generated.
3633 .It Fl c, -compressed
3634 Generate a more compact stream by using compressed WRITE records for blocks
3635 which are compressed on disk and in memory
3638 property for details
3642 feature is active on the sending system, then the receiving system must have
3643 that feature enabled as well.
3646 feature is enabled on the sending system but the
3648 option is not supplied in conjunction with
3650 then the data will be decompressed before sending so it can be split into
3651 smaller block sizes.
3653 For encrypted datasets, send data exactly as it exists on disk. This allows
3654 backups to be taken even if encryption keys are not currently loaded. The
3655 backup may then be received on an untrusted machine since that machine will
3656 not have the encryption keys to read the protected data or alter it without
3657 being detected. Upon being received, the dataset will have the same encryption
3658 keys as it did on the send side, although the
3660 property will be defaulted to
3662 if not otherwise provided. For unencrypted datasets, this flag will be
3665 Note that if you do not use this flag for sending encrypted datasets, data will
3666 be sent unencrypted and may be re-encrypted with a different encryption key on
3667 the receiving system, which will disable the ability to do a raw send to that
3668 system for incrementals.
3670 Generate a more compact stream by using
3672 records for blocks which are stored more compactly on disk by the
3675 This flag has no effect if the
3677 feature is disabled.
3678 The receiving system must have the
3683 feature is active on the sending system, then the receiving system must have
3684 that feature enabled as well. Datasets that are sent with this flag may not be
3685 received as an encrypted dataset, since encrypted datasets cannot use the
3689 .Xr zpool-features 5
3690 for details on ZFS feature flags and the
3693 .It Fl i Ar snapshot Ns | Ns Ar bookmark
3694 Generate an incremental send stream.
3695 The incremental source must be an earlier snapshot in the destination's history.
3696 It will commonly be an earlier snapshot in the destination's file system, in
3697 which case it can be specified as the last component of the name
3702 character and following
3705 If the incremental target is a clone, the incremental source can be the origin
3706 snapshot, or an earlier snapshot in the origin's filesystem, or the origin's
3712 Do not generate any actual send data.
3713 This is useful in conjunction with the
3717 flags to determine what data will be sent.
3718 In this case, the verbose output will be written to standard output
3719 .Po contrast with a non-dry-run, where the stream is written to standard output
3720 and the verbose output goes to standard error
3723 Print verbose information about the stream package generated.
3724 This information includes a per-second report of how much data has been sent.
3731 .Ar receive_resume_token
3733 Creates a send stream which resumes an interrupted receive.
3735 .Ar receive_resume_token
3736 is the value of this property on the filesystem or volume that was being
3738 See the documentation for
3745 .Op Fl o Sy origin Ns = Ns Ar snapshot
3746 .Op Fl o Ar property Ns = Ns Ar value
3747 .Op Fl x Ar property
3748 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
3754 .Op Fl d Ns | Ns Fl e
3755 .Op Fl o Sy origin Ns = Ns Ar snapshot
3756 .Op Fl o Ar property Ns = Ns Ar value
3757 .Op Fl x Ar property
3760 Creates a snapshot whose contents are as specified in the stream provided on
3762 If a full stream is received, then a new file system is created as well.
3763 Streams are created using the
3765 subcommand, which by default creates a full stream.
3767 can be used as an alias for
3770 If an incremental stream is received, then the destination file system must
3771 already exist, and its most recent snapshot must match the incremental stream's
3775 the destination device link is destroyed and recreated, which means the
3777 cannot be accessed during the
3781 When a snapshot replication package stream that is generated by using the
3782 .Nm zfs Cm send Fl R
3783 command is received, any snapshots that do not exist on the sending location are
3784 destroyed by using the
3785 .Nm zfs Cm destroy Fl d
3789 .Fl o Em property Ns = Ns Ar value
3792 is specified, it applies to the effective value of the property throughout
3793 the entire subtree of replicated datasets. Effective property values will be
3798 ) on the topmost in the replicated subtree. In descendant datasets, if the
3799 property is set by the send stream, it will be overridden by forcing the
3800 property to be inherited from the top‐most file system. Received properties
3801 are retained in spite of being overridden and may be restored with
3802 .Nm zfs Cm inherit Fl S .
3804 .Fl o Sy origin Ns = Ns Em snapshot
3805 is a special case because, even if
3807 is a read-only property and cannot be set, it's allowed to receive the send
3808 stream as a clone of the given snapshot.
3810 Raw encrypted send streams (created with
3811 .Nm zfs Cm send Fl w
3812 ) may only be received as is, and cannot be re-encrypted, decrypted, or
3813 recompressed by the receive process. Unencrypted streams can be received as
3814 encrypted datasets, either through inheritance or by specifying encryption
3819 The name of the snapshot
3820 .Pq and file system, if a full stream is received
3821 that this subcommand creates depends on the argument type and the use of the
3827 If the argument is a snapshot name, the specified
3830 If the argument is a file system or volume name, a snapshot with the same name
3831 as the sent snapshot is created within the specified
3839 options are specified, the provided target snapshot name is used exactly as
3846 options cause the file system name of the target snapshot to be determined by
3847 appending a portion of the sent snapshot's name to the specified target
3851 option is specified, all but the first element of the sent snapshot's file
3853 .Pq usually the pool name
3854 is used and any required intermediate file systems within the specified one are
3858 option is specified, then only the last element of the sent snapshot's file
3860 .Pq i.e. the name of the source file system itself
3861 is used as the target file system name.
3862 .Bl -tag -width "-F"
3864 Force a rollback of the file system to the most recent snapshot before
3865 performing the receive operation.
3866 If receiving an incremental replication stream
3867 .Po for example, one generated by
3868 .Nm zfs Cm send Fl R Op Fl i Ns | Ns Fl I
3870 destroy snapshots and file systems that do not exist on the sending side.
3872 Discard the first element of the sent snapshot's file system name, using the
3873 remaining elements to determine the name of the target file system for the new
3874 snapshot as described in the paragraph above.
3876 Discard all but the last element of the sent snapshot's file system name, using
3877 that element to determine the name of the target file system for the new
3878 snapshot as described in the paragraph above.
3880 Do not actually receive the stream.
3881 This can be useful in conjunction with the
3883 option to verify the name the receive operation would use.
3884 .It Fl o Sy origin Ns = Ns Ar snapshot
3885 Forces the stream to be received as a clone of the given snapshot.
3886 If the stream is a full send stream, this will create the filesystem
3887 described by the stream as a clone of the specified snapshot.
3888 Which snapshot was specified will not affect the success or failure of the
3889 receive, as long as the snapshot does exist.
3890 If the stream is an incremental send stream, all the normal verification will be
3892 .It Fl o Em property Ns = Ns Ar value
3893 Sets the specified property as if the command
3894 .Nm zfs Cm set Em property Ns = Ns Ar value
3895 was invoked immediately before the receive. When receiving a stream from
3896 .Nm zfs Cm send Fl R ,
3897 causes the property to be inherited by all descendant datasets, as through
3898 .Nm zfs Cm inherit Em property
3899 was run on any descendant datasets that have this property set on the
3902 Any editable property can be set at receive time. Set-once properties bound
3903 to the received data, such as
3906 .Sy casesensitivity ,
3907 cannot be set at receive time even when the datasets are newly created by
3908 .Nm zfs Cm receive .
3909 Additionally both settable properties
3913 cannot be set at receive time.
3917 option may be specified multiple times, for different properties. An error
3918 results if the same property is specified in multiple
3926 option may also be used to override encryption properties upon initial
3927 receive. This allows unencrypted streams to be received as encrypted datasets.
3928 To cause the received dataset (or root dataset of a recursive stream) to be
3929 received as an encryption root, specify encryption properties in the same
3930 manner as is required for
3935 # zfs send tank/test@snap1 | zfs recv -o encryption=on -o keyformat=passphrase -o keylocation=file:///path/to/keyfile
3939 .Op Fl o Ar keylocation Ns = Ns Ar prompt
3940 may not be specified here, since stdin is already being utilized for the send
3941 stream. Once the receive has completed, you can use
3944 to change this setting after the fact. Similarly, you can receive a dataset as
3945 an encrypted child by specifying
3946 .Op Fl x Ar encryption
3947 to force the property to be inherited. Overriding encryption properties (except
3949 .Sy keylocation Ns )
3950 is not possible with raw send streams.
3952 If the receive is interrupted, save the partially received state, rather
3954 Interruption may be due to premature termination of the stream
3955 .Po e.g. due to network failure or failure of the remote system
3956 if the stream is being read over a network connection
3958 a checksum error in the stream, termination of the
3960 process, or unclean shutdown of the system.
3962 The receive can be resumed with a stream generated by
3963 .Nm zfs Cm send Fl t Ar token ,
3967 .Sy receive_resume_token
3968 property of the filesystem or volume which is received into.
3970 To use this flag, the storage pool must have the
3971 .Sy extensible_dataset
3974 .Xr zpool-features 5
3975 for details on ZFS feature flags.
3977 File system that is associated with the received stream is not mounted.
3979 Print verbose information about the stream and the time required to perform the
3981 .It Fl x Em property
3982 Ensures that the effective value of the specified property after the
3983 receive is unaffected by the value of that property in the send stream (if any),
3984 as if the property had been excluded from the send stream.
3986 If the specified property is not present in the send stream, this option does
3989 If a received property needs to be overridden, the effective value will be
3990 set or inherited, depending on whether the property is inheritable or not.
3992 In the case of an incremental update,
3994 leaves any existing local setting or explicit inheritance unchanged.
3998 restrictions on set-once and special properties apply equally to
4005 .Ar filesystem Ns | Ns Ar volume
4007 Abort an interrupted
4008 .Nm zfs Cm receive Fl s ,
4009 deleting its saved partially received state.
4013 .Ar filesystem Ns | Ns Ar volume
4015 Displays permissions that have been delegated on the specified filesystem or
4017 See the other forms of
4019 for more information.
4021 Delegations are supported under Linux with the exception of
4029 These permissions cannot be delegated because the Linux
4031 command restricts modifications of the global namespace to the root user.
4036 .Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
4037 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4038 .Ar setname Oc Ns ...
4039 .Ar filesystem Ns | Ns Ar volume
4045 .Fl e Ns | Ns Sy everyone
4046 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4047 .Ar setname Oc Ns ...
4048 .Ar filesystem Ns | Ns Ar volume
4050 Delegates ZFS administration permission for the file systems to non-privileged
4052 .Bl -tag -width "-d"
4054 Allow only for the descendent file systems.
4055 .It Fl e Ns | Ns Sy everyone
4056 Specifies that the permissions be delegated to everyone.
4057 .It Fl g Ar group Ns Oo , Ns Ar group Oc Ns ...
4058 Explicitly specify that permissions are delegated to the group.
4062 only for the specified file system.
4063 .It Fl u Ar user Ns Oo , Ns Ar user Oc Ns ...
4064 Explicitly specify that permissions are delegated to the user.
4065 .It Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
4066 Specifies to whom the permissions are delegated.
4067 Multiple entities can be specified as a comma-separated list.
4070 options are specified, then the argument is interpreted preferentially as the
4073 then as a user name, and lastly as a group name.
4074 To specify a user or group named
4081 To specify a group with the same name as a user, use the
4085 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4086 .Ar setname Oc Ns ...
4088 The permissions to delegate.
4089 Multiple permissions may be specified as a comma-separated list.
4090 Permission names are the same as ZFS subcommand and property names.
4091 See the property list below.
4092 Property set names, which begin with
4097 form below for details.
4102 options are specified, or both are, then the permissions are allowed for the
4103 file system or volume, and all of its descendents.
4105 Permissions are generally the ability to use a ZFS subcommand or change a ZFS
4107 The following permissions are available:
4110 allow subcommand Must also have the permission that is
4112 clone subcommand Must also have the 'create' ability and
4113 'mount' ability in the origin file system
4114 create subcommand Must also have the 'mount' ability
4115 destroy subcommand Must also have the 'mount' ability
4116 diff subcommand Allows lookup of paths within a dataset
4117 given an object number, and the ability
4118 to create snapshots necessary to
4120 load-key subcommand Allows loading and unloading of encryption key
4121 (see 'zfs load-key' and 'zfs unload-key').
4122 change-key subcommand Allows changing an encryption key via
4124 mount subcommand Allows mount/umount of ZFS datasets
4125 promote subcommand Must also have the 'mount' and 'promote'
4126 ability in the origin file system
4127 receive subcommand Must also have the 'mount' and 'create'
4129 rename subcommand Must also have the 'mount' and 'create'
4130 ability in the new parent
4131 rollback subcommand Must also have the 'mount' ability
4133 share subcommand Allows sharing file systems over NFS
4135 snapshot subcommand Must also have the 'mount' ability
4137 groupquota other Allows accessing any groupquota@...
4139 groupused other Allows reading any groupused@... property
4140 userprop other Allows changing any user property
4141 userquota other Allows accessing any userquota@...
4143 userused other Allows reading any userused@... property
4144 projectobjquota other Allows accessing any projectobjquota@...
4146 projectquota other Allows accessing any projectquota@... property
4147 projectobjused other Allows reading any projectobjused@... property
4148 projectused other Allows reading any projectused@... property
4154 casesensitivity property
4156 compression property
4160 filesystem_limit property
4163 normalization property
4164 primarycache property
4169 refreservation property
4170 reservation property
4171 secondarycache property
4176 snapshot_limit property
4179 volblocksize property
4189 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4190 .Ar setname Oc Ns ...
4191 .Ar filesystem Ns | Ns Ar volume
4196 These permissions are granted
4198 to the creator of any newly-created descendent file system.
4202 .Fl s No @ Ns Ar setname
4203 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4204 .Ar setname Oc Ns ...
4205 .Ar filesystem Ns | Ns Ar volume
4207 Defines or adds permissions to a permission set.
4208 The set can be used by other
4210 commands for the specified file system and its descendents.
4211 Sets are evaluated dynamically, so changes to a set are immediately reflected.
4212 Permission sets follow the same naming restrictions as ZFS file systems, but the
4213 name must begin with
4215 and can be no more than 64 characters long.
4220 .Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
4221 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4222 .Ar setname Oc Ns ... Oc
4223 .Ar filesystem Ns | Ns Ar volume
4229 .Fl e Ns | Ns Sy everyone
4230 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4231 .Ar setname Oc Ns ... Oc
4232 .Ar filesystem Ns | Ns Ar volume
4239 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4240 .Ar setname Oc Ns ... Oc
4241 .Ar filesystem Ns | Ns Ar volume
4243 Removes permissions that were granted with the
4246 No permissions are explicitly denied, so other permissions granted are still in
4248 For example, if the permission is granted by an ancestor.
4249 If no permissions are specified, then all permissions for the specified
4261 only removes the permissions that were granted to everyone, not all permissions
4262 for every user and group.
4265 command for a description of the
4268 .Bl -tag -width "-r"
4270 Recursively remove the permissions from this file system and all descendents.
4276 .Fl s No @ Ns Ar setname
4277 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4278 .Ar setname Oc Ns ... Oc
4279 .Ar filesystem Ns | Ns Ar volume
4281 Removes permissions from a permission set.
4282 If no permissions are specified, then all permissions are removed, thus removing
4288 .Ar tag Ar snapshot Ns ...
4290 Adds a single reference, named with the
4292 argument, to the specified snapshot or snapshots.
4293 Each snapshot has its own tag namespace, and tags must be unique within that
4296 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
4300 .Bl -tag -width "-r"
4302 Specifies that a hold with the given tag is applied recursively to the snapshots
4303 of all descendent file systems.
4311 Lists all existing user references for the given snapshot or snapshots.
4312 .Bl -tag -width "-r"
4314 Lists the holds that are set on the named descendent snapshots, in addition to
4315 listing the holds on the named snapshot.
4317 Do not print headers, use tab-delimited output.
4323 .Ar tag Ar snapshot Ns ...
4325 Removes a single reference, named with the
4327 argument, from the specified snapshot or snapshots.
4328 The tag must already exist for each snapshot.
4329 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
4333 .Bl -tag -width "-r"
4335 Recursively releases a hold with the given tag on the snapshots of all
4336 descendent file systems.
4342 .Ar snapshot Ar snapshot Ns | Ns Ar filesystem
4344 Display the difference between a snapshot of a given filesystem and another
4345 snapshot of that filesystem from a later time or the current contents of the
4347 The first column is a character indicating the type of change, the other columns
4348 indicate pathname, new pathname
4349 .Pq in case of rename ,
4350 change in link count, and optionally file type and/or change time.
4351 The types of change are:
4353 - The path has been removed
4354 + The path has been created
4355 M The path has been modified
4356 R The path has been renamed
4358 .Bl -tag -width "-F"
4360 Display an indication of the type of file, in a manner similar to the
4376 Give more parsable tab-separated output, without header lines and without
4379 Display the path's inode change time as the first column of output.
4386 .Op Fl m Ar memory_limit
4392 as a ZFS channel program on
4395 program interface allows ZFS administrative operations to be run
4396 programmatically via a Lua script.
4397 The entire script is executed atomically, with no other administrative
4398 operations taking effect concurrently.
4399 A library of ZFS calls is made available to channel program scripts.
4400 Channel programs may only be run with root privileges.
4402 For full documentation of the ZFS channel program interface, see the manual
4407 Display channel program output in JSON format. When this flag is specified and
4408 standard output is empty - channel program encountered an error. The details of
4409 such an error will be printed to standard error in plain text.
4411 Executes a read-only channel program, which runs faster.
4412 The program cannot change on-disk state by calling functions from
4413 the zfs.sync submodule.
4414 The program can be used to gather information such as properties and
4415 determining if changes would succeed (zfs.check.*).
4416 Without this flag, all pending changes must be synced to disk before
4417 a channel program can complete.
4419 Execution time limit, in milliseconds.
4420 If a channel program executes for longer than the provided timeout, it will
4421 be stopped and an error will be returned.
4422 The default timeout is 1000 ms, and can be set to a maximum of 10000 ms.
4423 .It Fl m Ar memory-limit
4424 Memory limit, in bytes.
4425 If a channel program attempts to allocate more memory than the given limit,
4426 it will be stopped and an error returned.
4427 The default memory limit is 10 MB, and can be set to a maximum of 100 MB.
4429 All remaining argument strings are passed directly to the channel program as
4433 for more information.
4439 .Op Fl L Ar keylocation
4440 .Fl a | Ar filesystem
4444 allowing it and all children that inherit the
4446 property to be accessed. The key will be expected in the format specified by the
4448 and location specified by the
4450 property. Note that if the
4454 the terminal will interactively wait for the key to be entered. Loading a key
4455 will not automatically mount the dataset. If that functionality is desired,
4456 .Nm zfs Cm mount Sy -l
4457 will ask for the key and mount the dataset. Once the key is loaded the
4459 property will become
4461 .Bl -tag -width "-r"
4463 Recursively loads the keys for the specified filesystem and all descendent
4466 Loads the keys for all encryption roots in all imported pools.
4470 load-key. This will cause zfs to simply check that the
4471 provided key is correct. This command may be run even if the key is already
4473 .It Fl L Ar keylocation
4478 property. This will not change the value of the property on the dataset. Note
4479 that if used with either
4484 may only be given as
4491 .Fl a | Ar filesystem
4493 Unloads a key from ZFS, removing the ability to access the dataset and all of
4494 its children that inherit the
4496 property. This requires that the dataset is not currently open or mounted. Once
4497 the key is unloaded the
4499 property will become
4501 .Bl -tag -width "-r"
4503 Recursively unloads the keys for the specified filesystem and all descendent
4506 Unloads the keys for all encryption roots in all imported pools.
4512 .Op Fl o Ar keylocation Ns = Ns Ar value
4513 .Op Fl o Ar keyformat Ns = Ns Ar value
4514 .Op Fl o Ar pbkdf2iters Ns = Ns Ar value
4524 Allows a user to change the encryption key used to access a dataset. This
4525 command requires that the existing key for the dataset is already loaded into
4526 ZFS. This command may also be used to change the
4531 properties as needed. If the dataset was not previously an encryption root it
4532 will become one. Alternatively, the
4534 flag may be provided to cause an encryption root to inherit the parent's key
4536 .Bl -tag -width "-r"
4538 Ensures the key is loaded before attempting to change the key. This is
4539 effectively equivalent to
4540 .Qq Nm zfs Cm load-key Ar filesystem ; Nm zfs Cm change-key Ar filesystem
4541 .It Fl o Ar property Ns = Ns Ar value
4542 Allows the user to set encryption key properties (
4547 ) while changing the key. This is the only way to alter
4551 after the dataset has been created.
4553 Indicates that zfs should make
4555 inherit the key of its parent. Note that this command can only be run on an
4556 encryption root that has an encrypted parent.
4562 utility exits 0 on success, 1 if an error occurs, and 2 if invalid command line
4563 options were specified.
4566 .It Sy Example 1 No Creating a ZFS File System Hierarchy
4567 The following commands create a file system named
4569 and a file system named
4573 is set for the parent file system, and is automatically inherited by the child
4576 # zfs create pool/home
4577 # zfs set mountpoint=/export/home pool/home
4578 # zfs create pool/home/bob
4580 .It Sy Example 2 No Creating a ZFS Snapshot
4581 The following command creates a snapshot named
4583 This snapshot is mounted on demand in the
4585 directory at the root of the
4589 # zfs snapshot pool/home/bob@yesterday
4591 .It Sy Example 3 No Creating and Destroying Multiple Snapshots
4592 The following command creates snapshots named
4596 and all of its descendent file systems.
4597 Each snapshot is mounted on demand in the
4599 directory at the root of its file system.
4600 The second command destroys the newly created snapshots.
4602 # zfs snapshot -r pool/home@yesterday
4603 # zfs destroy -r pool/home@yesterday
4605 .It Sy Example 4 No Disabling and Enabling File System Compression
4606 The following command disables the
4608 property for all file systems under
4610 The next command explicitly enables
4613 .Em pool/home/anne .
4615 # zfs set compression=off pool/home
4616 # zfs set compression=on pool/home/anne
4618 .It Sy Example 5 No Listing ZFS Datasets
4619 The following command lists all active file systems and volumes in the system.
4620 Snapshots are displayed if the
4628 for more information on pool properties.
4631 NAME USED AVAIL REFER MOUNTPOINT
4632 pool 450K 457G 18K /pool
4633 pool/home 315K 457G 21K /export/home
4634 pool/home/anne 18K 457G 18K /export/home/anne
4635 pool/home/bob 276K 457G 276K /export/home/bob
4637 .It Sy Example 6 No Setting a Quota on a ZFS File System
4638 The following command sets a quota of 50 Gbytes for
4641 # zfs set quota=50G pool/home/bob
4643 .It Sy Example 7 No Listing ZFS Properties
4644 The following command lists all properties for
4647 # zfs get all pool/home/bob
4648 NAME PROPERTY VALUE SOURCE
4649 pool/home/bob type filesystem -
4650 pool/home/bob creation Tue Jul 21 15:53 2009 -
4651 pool/home/bob used 21K -
4652 pool/home/bob available 20.0G -
4653 pool/home/bob referenced 21K -
4654 pool/home/bob compressratio 1.00x -
4655 pool/home/bob mounted yes -
4656 pool/home/bob quota 20G local
4657 pool/home/bob reservation none default
4658 pool/home/bob recordsize 128K default
4659 pool/home/bob mountpoint /pool/home/bob default
4660 pool/home/bob sharenfs off default
4661 pool/home/bob checksum on default
4662 pool/home/bob compression on local
4663 pool/home/bob atime on default
4664 pool/home/bob devices on default
4665 pool/home/bob exec on default
4666 pool/home/bob setuid on default
4667 pool/home/bob readonly off default
4668 pool/home/bob zoned off default
4669 pool/home/bob snapdir hidden default
4670 pool/home/bob acltype off default
4671 pool/home/bob aclinherit restricted default
4672 pool/home/bob canmount on default
4673 pool/home/bob xattr on default
4674 pool/home/bob copies 1 default
4675 pool/home/bob version 4 -
4676 pool/home/bob utf8only off -
4677 pool/home/bob normalization none -
4678 pool/home/bob casesensitivity sensitive -
4679 pool/home/bob vscan off default
4680 pool/home/bob nbmand off default
4681 pool/home/bob sharesmb off default
4682 pool/home/bob refquota none default
4683 pool/home/bob refreservation none default
4684 pool/home/bob primarycache all default
4685 pool/home/bob secondarycache all default
4686 pool/home/bob usedbysnapshots 0 -
4687 pool/home/bob usedbydataset 21K -
4688 pool/home/bob usedbychildren 0 -
4689 pool/home/bob usedbyrefreservation 0 -
4692 The following command gets a single property value.
4694 # zfs get -H -o value compression pool/home/bob
4697 The following command lists all properties with local settings for
4700 # zfs get -r -s local -o name,property,value all pool/home/bob
4702 pool/home/bob quota 20G
4703 pool/home/bob compression on
4705 .It Sy Example 8 No Rolling Back a ZFS File System
4706 The following command reverts the contents of
4708 to the snapshot named
4710 deleting all intermediate snapshots.
4712 # zfs rollback -r pool/home/anne@yesterday
4714 .It Sy Example 9 No Creating a ZFS Clone
4715 The following command creates a writable file system whose initial contents are
4717 .Em pool/home/bob@yesterday .
4719 # zfs clone pool/home/bob@yesterday pool/clone
4721 .It Sy Example 10 No Promoting a ZFS Clone
4722 The following commands illustrate how to test out changes to a file system, and
4723 then replace the original file system with the changed one, using clones, clone
4724 promotion, and renaming:
4726 # zfs create pool/project/production
4727 populate /pool/project/production with data
4728 # zfs snapshot pool/project/production@today
4729 # zfs clone pool/project/production@today pool/project/beta
4730 make changes to /pool/project/beta and test them
4731 # zfs promote pool/project/beta
4732 # zfs rename pool/project/production pool/project/legacy
4733 # zfs rename pool/project/beta pool/project/production
4734 once the legacy version is no longer needed, it can be destroyed
4735 # zfs destroy pool/project/legacy
4737 .It Sy Example 11 No Inheriting ZFS Properties
4738 The following command causes
4744 property from their parent.
4746 # zfs inherit checksum pool/home/bob pool/home/anne
4748 .It Sy Example 12 No Remotely Replicating ZFS Data
4749 The following commands send a full stream and then an incremental stream to a
4750 remote machine, restoring them into
4751 .Em poolB/received/fs@a
4753 .Em poolB/received/fs@b ,
4756 must contain the file system
4757 .Em poolB/received ,
4758 and must not initially contain
4759 .Em poolB/received/fs .
4761 # zfs send pool/fs@a | \e
4762 ssh host zfs receive poolB/received/fs@a
4763 # zfs send -i a pool/fs@b | \e
4764 ssh host zfs receive poolB/received/fs
4766 .It Sy Example 13 No Using the zfs receive -d Option
4767 The following command sends a full stream of
4768 .Em poolA/fsA/fsB@snap
4769 to a remote machine, receiving it into
4770 .Em poolB/received/fsA/fsB@snap .
4773 portion of the received snapshot's name is determined from the name of the sent
4776 must contain the file system
4777 .Em poolB/received .
4779 .Em poolB/received/fsA
4780 does not exist, it is created as an empty file system.
4782 # zfs send poolA/fsA/fsB@snap | \e
4783 ssh host zfs receive -d poolB/received
4785 .It Sy Example 14 No Setting User Properties
4786 The following example sets the user-defined
4787 .Sy com.example:department
4788 property for a dataset.
4790 # zfs set com.example:department=12345 tank/accounting
4792 .It Sy Example 15 No Performing a Rolling Snapshot
4793 The following example shows how to maintain a history of snapshots with a
4794 consistent naming scheme.
4795 To keep a week's worth of snapshots, the user destroys the oldest snapshot,
4796 renames the remaining snapshots, and then creates a new snapshot, as follows:
4798 # zfs destroy -r pool/users@7daysago
4799 # zfs rename -r pool/users@6daysago @7daysago
4800 # zfs rename -r pool/users@5daysago @6daysago
4801 # zfs rename -r pool/users@4daysago @5daysago
4802 # zfs rename -r pool/users@3daysago @4daysago
4803 # zfs rename -r pool/users@2daysago @3daysago
4804 # zfs rename -r pool/users@yesterday @2daysago
4805 # zfs rename -r pool/users@today @yesterday
4806 # zfs snapshot -r pool/users@today
4808 .It Sy Example 16 No Setting sharenfs Property Options on a ZFS File System
4809 The following commands show how to set
4811 property options to enable
4815 addresses and to enable root access for system
4821 # zfs set sharenfs='rw=@123.123.0.0/16,root=neo' tank/home
4826 for host name resolution, specify the fully qualified hostname.
4827 .It Sy Example 17 No Delegating ZFS Administration Permissions on a ZFS Dataset
4828 The following example shows how to set permissions so that user
4830 can create, destroy, mount, and take snapshots on
4836 # zfs allow cindys create,destroy,mount,snapshot tank/cindys
4837 # zfs allow tank/cindys
4838 ---- Permissions on tank/cindys --------------------------------------
4839 Local+Descendent permissions:
4840 user cindys create,destroy,mount,snapshot
4845 mount point permission is set to 755 by default, user
4847 will be unable to mount file systems under
4849 Add an ACE similar to the following syntax to provide mount point access:
4851 # chmod A+user:cindys:add_subdirectory:allow /tank/cindys
4853 .It Sy Example 18 No Delegating Create Time Permissions on a ZFS Dataset
4854 The following example shows how to grant anyone in the group
4856 to create file systems in
4858 This syntax also allows staff members to destroy their own file systems, but not
4859 destroy anyone else's file system.
4864 # zfs allow staff create,mount tank/users
4865 # zfs allow -c destroy tank/users
4866 # zfs allow tank/users
4867 ---- Permissions on tank/users ---------------------------------------
4870 Local+Descendent permissions:
4871 group staff create,mount
4873 .It Sy Example 19 No Defining and Granting a Permission Set on a ZFS Dataset
4874 The following example shows how to define and grant a permission set on the
4881 # zfs allow -s @pset create,destroy,snapshot,mount tank/users
4882 # zfs allow staff @pset tank/users
4883 # zfs allow tank/users
4884 ---- Permissions on tank/users ---------------------------------------
4886 @pset create,destroy,mount,snapshot
4887 Local+Descendent permissions:
4890 .It Sy Example 20 No Delegating Property Permissions on a ZFS Dataset
4891 The following example shows to grant the ability to set quotas and reservations
4899 # zfs allow cindys quota,reservation users/home
4900 # zfs allow users/home
4901 ---- Permissions on users/home ---------------------------------------
4902 Local+Descendent permissions:
4903 user cindys quota,reservation
4904 cindys% zfs set quota=10G users/home/marks
4905 cindys% zfs get quota users/home/marks
4906 NAME PROPERTY VALUE SOURCE
4907 users/home/marks quota 10G local
4909 .It Sy Example 21 No Removing ZFS Delegated Permissions on a ZFS Dataset
4910 The following example shows how to remove the snapshot permission from the
4919 # zfs unallow staff snapshot tank/users
4920 # zfs allow tank/users
4921 ---- Permissions on tank/users ---------------------------------------
4923 @pset create,destroy,mount,snapshot
4924 Local+Descendent permissions:
4927 .It Sy Example 22 No Showing the differences between a snapshot and a ZFS Dataset
4928 The following example shows how to see what has changed between a prior
4929 snapshot of a ZFS dataset and its current state.
4932 option is used to indicate type information for the files affected.
4934 # zfs diff -F tank/test@before tank/test
4936 M F /tank/test/linked (+1)
4937 R F /tank/test/oldname -> /tank/test/newname
4938 - F /tank/test/deleted
4939 + F /tank/test/created
4940 M F /tank/test/modified
4942 .It Sy Example 23 No Creating a bookmark
4943 The following example create a bookmark to a snapshot. This bookmark
4944 can then be used instead of snapshot in send streams.
4946 # zfs bookmark rpool@snapshot rpool#bookmark
4948 .It Sy Example 24 No Setting sharesmb Property Options on a ZFS File System
4949 The following example show how to share SMB filesystem through ZFS. Note that
4950 that a user and his/her password must be given.
4952 # smbmount //127.0.0.1/share_tmp /mnt/tmp \\
4953 -o user=workgroup/turbo,password=obrut,uid=1000
4957 .Em /etc/samba/smb.conf
4958 configuration required:
4960 Samba will need to listen to 'localhost' (127.0.0.1) for the ZFS utilities to
4961 communicate with Samba. This is the default behavior for most Linux
4964 Samba must be able to authenticate a user. This can be done in a number of
4965 ways, depending on if using the system password file, LDAP or the Samba
4966 specific smbpasswd file. How to do this is outside the scope of this manual.
4969 man page for more information.
4972 .Sy USERSHARE section
4975 man page for all configuration options in case you need to modify any options
4976 to the share afterwards. Do note that any changes done with the
4978 command will be undone if the share is ever unshared (such as at a reboot etc).
4980 .Sh INTERFACE STABILITY
projects / mirror_zfs.git / blob