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 2017 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 filesystem Ns | Ns Ar volume
110 .Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ...
111 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
114 .Op Fl r Ns | Ns Fl d Ar depth
116 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
117 .Oo Fl s Ar source Ns Oo , Ns Ar source Oc Ns ... Oc
118 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
119 .Cm all | Ar property Ns Oo , Ns Ar property Oc Ns ...
120 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Ns ...
124 .Ar property Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
134 .Fl a | Ar filesystem
138 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
139 .Oo Fl s Ar field Oc Ns ...
140 .Oo Fl S Ar field Oc Ns ...
141 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
142 .Ar filesystem Ns | Ns Ar snapshot
146 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
147 .Oo Fl s Ar field Oc Ns ...
148 .Oo Fl S Ar field Oc Ns ...
149 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
150 .Ar filesystem Ns | Ns Ar snapshot
154 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
155 .Oo Fl s Ar field Oc Ns ...
156 .Oo Fl S Ar field Oc Ns ...
157 .Ar filesystem Ns | Ns Ar snapshot
160 .Oo Fl d Ns | Ns Fl r Ns Oc
161 .Ar file Ns | Ns Ar directory Ns ...
166 .Ar file Ns | Ns Ar directory Ns ...
171 .Oo Fl d Ns | Ns Fl r Ns Oc
173 .Ar file Ns | Ns Ar directory Ns ...
178 .Ar file Ns | Ns Ar directory Ns ...
185 .Fl a | Ar filesystem
189 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
192 .Fl a | Ar filesystem
195 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
198 .Ar snapshot bookmark
202 .Op Oo Fl I Ns | Ns Fl i Oc Ar snapshot
207 .Op Fl i Ar snapshot Ns | Ns Ar bookmark
208 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
212 .Fl t Ar receive_resume_token
216 .Op Fl o Sy origin Ns = Ns Ar snapshot
217 .Op Fl o Ar property Ns = Ns Ar value
219 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
223 .Op Fl d Ns | Ns Fl e
224 .Op Fl o Sy origin Ns = Ns Ar snapshot
225 .Op Fl o Ar property Ns = Ns Ar value
231 .Ar filesystem Ns | Ns Ar volume
234 .Ar filesystem Ns | Ns Ar volume
238 .Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
239 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
240 .Ar setname Oc Ns ...
241 .Ar filesystem Ns | Ns Ar volume
245 .Fl e Ns | Ns Sy everyone
246 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
247 .Ar setname Oc Ns ...
248 .Ar filesystem Ns | Ns Ar volume
252 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
253 .Ar setname Oc Ns ...
254 .Ar filesystem Ns | Ns Ar volume
257 .Fl s No @ Ns Ar setname
258 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
259 .Ar setname Oc Ns ...
260 .Ar filesystem Ns | Ns Ar volume
264 .Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
265 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
266 .Ar setname Oc Ns ... Oc
267 .Ar filesystem Ns | Ns Ar volume
271 .Fl e Ns | Ns Sy everyone
272 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
273 .Ar setname Oc Ns ... Oc
274 .Ar filesystem Ns | Ns Ar volume
279 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
280 .Ar setname Oc Ns ... Oc
281 .Ar filesystem Ns | Ns Ar volume
285 .Fl s @ Ns Ar setname
286 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
287 .Ar setname Oc Ns ... Oc
288 .Ar filesystem Ns | Ns Ar volume
292 .Ar tag Ar snapshot Ns ...
300 .Ar tag Ar snapshot Ns ...
304 .Ar snapshot Ar snapshot Ns | Ns Ar filesystem
309 .Op Fl m Ar memory_limit
315 .Op Fl L Ar keylocation
316 .Fl a | Ar filesystem
320 .Fl a | Ar filesystem
324 .Op Fl o Ar keylocation Ns = Ns Ar value
325 .Op Fl o Ar keyformat Ns = Ns Ar value
326 .Op Fl o Ar pbkdf2iters Ns = Ns Ar value
336 command configures ZFS datasets within a ZFS storage pool, as described in
338 A dataset is identified by a unique path within the ZFS namespace.
341 pool/{filesystem,volume,snapshot}
344 where the maximum length of a dataset name is
347 and the maximum amount of nesting allowed in a path is 50 levels deep.
349 A dataset can be one of the following:
350 .Bl -tag -width "file system"
352 A ZFS dataset of type
354 can be mounted within the standard system namespace and behaves like other file
356 While ZFS file systems are designed to be POSIX compliant, known issues exist
357 that prevent compliance in some cases.
358 Applications that depend on standards conformance might fail due to non-standard
359 behavior when checking file system free space.
361 A logical volume exported as a raw or block device.
362 This type of dataset should only be used under special circumstances.
363 File systems are typically used in most environments.
365 A read-only version of a file system or volume at a given point in time.
367 .Ar filesystem Ns @ Ns Ar name
369 .Ar volume Ns @ Ns Ar name .
373 but without the hold on on-disk data. It can be used as the source of a send
374 (but not for a receive). It is specified as
375 .Ar filesystem Ns # Ns Ar name
377 .Ar volume Ns # Ns Ar name .
379 .Ss ZFS File System Hierarchy
380 A ZFS storage pool is a logical collection of devices that provide space for
382 A storage pool is also the root of the ZFS file system hierarchy.
384 The root of the pool can be accessed as a file system, such as mounting and
385 unmounting, taking snapshots, and setting properties.
386 The physical storage characteristics, however, are managed by the
392 for more information on creating and administering pools.
394 A snapshot is a read-only copy of a file system or volume.
395 Snapshots can be created extremely quickly, and initially consume no additional
396 space within the pool.
397 As data within the active dataset changes, the snapshot consumes more data than
398 would otherwise be shared with the active dataset.
400 Snapshots can have arbitrary names.
401 Snapshots of volumes can be cloned or rolled back, visibility is determined
404 property of the parent volume.
406 File system snapshots can be accessed under the
408 directory in the root of the file system.
409 Snapshots are automatically mounted on demand and may be unmounted at regular
411 The visibility of the
413 directory can be controlled by the
417 A bookmark is like a snapshot, a read-only copy of a file system or volume.
418 Bookmarks can be created extremely quickly, compared to snapshots, and they
419 consume no additional space within the pool. Bookmarks can also have arbitrary
420 names, much like snapshots.
422 Unlike snapshots, bookmarks can not be accessed through the filesystem in any
423 way. From a storage standpoint a bookmark just provides a way to reference
424 when a snapshot was created as a distinct object. Bookmarks are initially
425 tied to a snapshot, not the filesystem or volume, and they will survive if the
426 snapshot itself is destroyed. Since they are very light weight there's little
427 incentive to destroy them.
429 A clone is a writable volume or file system whose initial contents are the same
431 As with snapshots, creating a clone is nearly instantaneous, and initially
432 consumes no additional space.
434 Clones can only be created from a snapshot.
435 When a snapshot is cloned, it creates an implicit dependency between the parent
437 Even though the clone is created somewhere else in the dataset hierarchy, the
438 original snapshot cannot be destroyed as long as a clone exists.
441 property exposes this dependency, and the
443 command lists any such dependencies, if they exist.
445 The clone parent-child dependency relationship can be reversed by using the
450 file system to become a clone of the specified file system, which makes it
451 possible to destroy the file system that the clone was created from.
453 Creating a ZFS file system is a simple operation, so the number of file systems
454 per system is likely to be numerous.
455 To cope with this, ZFS automatically manages mounting and unmounting file
456 systems without the need to edit the
459 All automatically managed file systems are mounted by ZFS at boot time.
461 By default, file systems are mounted under
465 is the name of the file system in the ZFS namespace.
466 Directories are created and destroyed as needed.
468 A file system can also have a mount point set in the
471 This directory is created as needed, and ZFS automatically mounts the file
473 .Nm zfs Cm mount Fl a
480 property can be inherited, so if
486 automatically inherits a mount point of
487 .Pa /export/stuff/user .
493 prevents the file system from being mounted.
495 If needed, ZFS file systems can also be managed with traditional tools
501 If a file system's mount point is set to
503 ZFS makes no attempt to manage the file system, and the administrator is
504 responsible for mounting and unmounting the file system. Because pools must
505 be imported before a legacy mount can succeed, administrators should ensure
506 that legacy mounts are only attempted after the zpool import process
507 finishes at boot time. For example, on machines using systemd, the mount
510 .Nm x-systemd.requires=zfs-import.target
512 will ensure that the zfs-import completes before systemd attempts mounting
513 the filesystem. See systemd.mount(5) for details.
515 Deduplication is the process for removing redundant data at the block level,
516 reducing the total amount of data stored. If a file system has the
518 property enabled, duplicate data blocks are removed synchronously. The result
519 is that only unique data is stored and common components are shared among files.
521 Deduplicating data is a very resource-intensive operation. It is generally
522 recommended that you have at least 1.25 GiB of RAM per 1 TiB of storage when
523 you enable deduplication. Calculating the exact requirement depends heavily
524 on the type of data stored in the pool.
526 Enabling deduplication on an improperly-designed system can result in
527 performance issues (slow IO and administrative operations). It can potentially
528 lead to problems importing a pool due to memory exhaustion. Deduplication
529 can consume significant processing power (CPU) and memory as well as generate
532 Before creating a pool with deduplication enabled, ensure that you have planned
533 your hardware requirements appropriately and implemented appropriate recovery
534 practices, such as regular backups. As an alternative to deduplication
537 as a less resource-intensive alternative.
538 .Ss Native Properties
539 Properties are divided into two types, native properties and user-defined
544 Native properties either export internal statistics or control ZFS behavior.
545 In addition, native properties are either editable or read-only.
546 User properties have no effect on ZFS behavior, but you can use them to annotate
547 datasets in a way that is meaningful in your environment.
548 For more information about user properties, see the
552 Every dataset has a set of properties that export statistics about the dataset
553 as well as control various behaviors.
554 Properties are inherited from the parent unless overridden by the child.
555 Some properties apply only to certain types of datasets
556 .Pq file systems, volumes, or snapshots .
558 The values of numeric properties can be specified using human-readable suffixes
568 The following are all valid
571 .Li 1536M, 1.5g, 1.50GB .
573 The values of non-numeric properties are case sensitive and must be lowercase,
580 The following native properties consist of read-only statistics about the
582 These properties can be neither set, nor inherited.
583 Native properties apply to all dataset types unless otherwise noted.
584 .Bl -tag -width "usedbyrefreservation"
586 The amount of space available to the dataset and all its children, assuming that
587 there is no other activity in the pool.
588 Because space is shared within a pool, availability can be limited by any number
589 of factors, including physical pool size, quotas, reservations, or other
590 datasets within the pool.
592 This property can also be referred to by its shortened column name,
595 For non-snapshots, the compression ratio achieved for the
597 space of this dataset, expressed as a multiplier.
600 property includes descendant datasets, and, for clones, does not include the
601 space shared with the origin snapshot.
607 Compression can be turned on by running:
608 .Nm zfs Cm set Sy compression Ns = Ns Sy on Ar dataset .
612 The transaction group (txg) in which the dataset was created. Bookmarks have
615 as the snapshot they are initially tied to. This property is suitable for
616 ordering a list of snapshots, e.g. for incremental send and receive.
618 The time this dataset was created.
620 For snapshots, this property is a comma-separated list of filesystems or volumes
621 which are clones of this snapshot.
624 property is this snapshot.
627 property is not empty, then this snapshot can not be destroyed
634 The roles of origin and clone can be swapped by promoting the clone with the
640 if the snapshot has been marked for deferred destroy by using the
641 .Nm zfs Cm destroy Fl d
643 Otherwise, the property is
645 .It Sy encryptionroot
646 For encrypted datasets, indicates where the dataset is currently inheriting its
647 encryption key from. Loading or unloading a key for the
649 will implicitly load / unload the key for any inheriting datasets (see
652 .Nm zfs Cm unload-key
654 Clones will always share an
655 encryption key with their origin. See the
658 .It Sy filesystem_count
659 The total number of filesystems and volumes that exist under this location in
661 This value is only available when a
663 has been set somewhere in the tree under which the dataset resides.
665 Indicates if an encryption key is currently loaded into ZFS. The possible
674 .Nm zfs Cm unload-key .
676 The 64 bit GUID of this dataset or bookmark which does not change over its
677 entire lifetime. When a snapshot is sent to another pool, the received
678 snapshot has the same GUID. Thus, the
680 is suitable to identify a snapshot across pools.
681 .It Sy logicalreferenced
682 The amount of space that is
684 accessible by this dataset.
688 The logical space ignores the effect of the
692 properties, giving a quantity closer to the amount of data that applications
694 However, it does include space consumed by metadata.
696 This property can also be referred to by its shortened column name,
699 The amount of space that is
701 consumed by this dataset and all its descendents.
705 The logical space ignores the effect of the
709 properties, giving a quantity closer to the amount of data that applications
711 However, it does include space consumed by metadata.
713 This property can also be referred to by its shortened column name,
716 For file systems, indicates whether the file system is currently mounted.
717 This property can be either
722 A unique identifier for this dataset within the pool. Unlike the dataset's
726 of a dataset is not transferred to other pools when the snapshot is copied
727 with a send/receive operation.
730 can be reused (for a new datatset) after the dataset is deleted.
732 For cloned file systems or volumes, the snapshot from which the clone was
737 .It Sy receive_resume_token
738 For filesystems or volumes which have saved partially-completed state from
740 this opaque token can be provided to
742 to resume and complete the
745 The amount of data that is accessible by this dataset, which may or may not be
746 shared with other datasets in the pool.
747 When a snapshot or clone is created, it initially references the same amount of
748 space as the file system or snapshot it was created from, since its contents are
751 This property can also be referred to by its shortened column name,
753 .It Sy refcompressratio
754 The compression ratio achieved for the
756 space of this dataset, expressed as a multiplier.
760 .It Sy snapshot_count
761 The total number of snapshots that exist under this location in the dataset
763 This value is only available when a
765 has been set somewhere in the tree under which the dataset resides.
773 The amount of space consumed by this dataset and all its descendents.
774 This is the value that is checked against this dataset's quota and reservation.
775 The space used does not include this dataset's reservation, but does take into
776 account the reservations of any descendent datasets.
777 The amount of space that a dataset consumes from its parent, as well as the
778 amount of space that is freed if this dataset is recursively destroyed, is the
779 greater of its space used and its reservation.
781 The used space of a snapshot
786 is space that is referenced exclusively by this snapshot.
787 If this snapshot is destroyed, the amount of
790 Space that is shared by multiple snapshots isn't accounted for in this metric.
791 When a snapshot is destroyed, space that was previously shared with this
792 snapshot can become unique to snapshots adjacent to it, thus changing the used
793 space of those snapshots.
794 The used space of the latest snapshot can also be affected by changes in the
798 space of a snapshot is a subset of the
800 space of the snapshot.
802 The amount of space used, available, or referenced does not take into account
804 Pending changes are generally accounted for within a few seconds.
805 Committing a change to a disk using
809 does not necessarily guarantee that the space usage information is updated
814 properties decompose the
816 properties into the various reasons that space is used.
819 .Sy usedbychildren No +
820 .Sy usedbydataset No +
821 .Sy usedbyrefreservation No +
822 .Sy usedbysnapshots .
823 These properties are only available for datasets created on
827 .It Sy usedbychildren
828 The amount of space used by children of this dataset, which would be freed if
829 all the dataset's children were destroyed.
831 The amount of space used by this dataset itself, which would be freed if the
832 dataset were destroyed
833 .Po after first removing any
835 and destroying any necessary snapshots or descendents
837 .It Sy usedbyrefreservation
838 The amount of space used by a
840 set on this dataset, which would be freed if the
843 .It Sy usedbysnapshots
844 The amount of space consumed by snapshots of this dataset.
845 In particular, it is the amount of space that would be freed if all of this
846 dataset's snapshots were destroyed.
847 Note that this is not simply the sum of the snapshots'
849 properties because space can be shared by multiple snapshots.
850 .It Sy userused Ns @ Ns Em user
851 The amount of space consumed by the specified user in this dataset.
852 Space is charged to the owner of each file, as displayed by
854 The amount of space charged is displayed by
860 subcommand for more information.
862 Unprivileged users can access only their own space usage.
863 The root user, or a user who has been granted the
867 can access everyone's usage.
870 .Sy userused Ns @ Ns Em ...
871 properties are not displayed by
872 .Nm zfs Cm get Sy all .
873 The user's name must be appended after the @ symbol, using one of the following
875 .Bl -bullet -width ""
889 .Sy joe.smith@mydomain
898 Files created on Linux always have POSIX owners.
899 .It Sy userobjused Ns @ Ns Em user
902 property is similar to
904 but instead it counts the number of objects consumed by a user. This property
905 counts all objects allocated on behalf of the user, it may differ from the
906 results of system tools such as
911 is set on a file system additional objects will be created per-file to store
912 extended attributes. These additional objects are reflected in the
914 value and are counted against the user's
916 When a file system is configured to use
918 no additional internal objects are normally required.
920 This property is set to the number of user holds on this snapshot.
921 User holds are set by using the
924 .It Sy groupused Ns @ Ns Em group
925 The amount of space consumed by the specified group in this dataset.
926 Space is charged to the group of each file, as displayed by
929 .Sy userused Ns @ Ns Em user
930 property for more information.
932 Unprivileged users can only access their own groups' space usage.
933 The root user, or a user who has been granted the
937 can access all groups' usage.
938 .It Sy groupobjused Ns @ Ns Em group
939 The number of objects consumed by the specified group in this dataset.
940 Multiple objects may be charged to the group for each file when extended
941 attributes are in use. See the
942 .Sy userobjused Ns @ Ns Em user
943 property for more information.
945 Unprivileged users can only access their own groups' space usage.
946 The root user, or a user who has been granted the
950 can access all groups' usage.
951 .It Sy projectused Ns @ Ns Em project
952 The amount of space consumed by the specified project in this dataset. Project
953 is identified via the project identifier (ID) that is object-based numeral
954 attribute. An object can inherit the project ID from its parent object (if the
955 parent has the flag of inherit project ID that can be set and changed via
958 .Nm zfs project Fl s )
959 when being created. The privileged user can set and change object's project
964 anytime. Space is charged to the project of each file, as displayed by
969 .Sy userused Ns @ Ns Em user
970 property for more information.
972 The root user, or a user who has been granted the
976 can access all projects' usage.
977 .It Sy projectobjused Ns @ Ns Em project
982 but instead it counts the number of objects consumed by project. When the
985 is set on a fileset, ZFS will create additional objects per-file to store
986 extended attributes. These additional objects are reflected in the
988 value and are counted against the project's
989 .Sy projectobjquota .
990 When a filesystem is configured to use
992 no additional internal objects are required. See the
993 .Sy userobjused Ns @ Ns Em user
994 property for more information.
996 The root user, or a user who has been granted the
1000 can access all projects' objects usage.
1002 For volumes, specifies the block size of the volume.
1005 cannot be changed once the volume has been written, so it should be set at
1006 volume creation time.
1009 for volumes is 8 Kbytes.
1010 Any power of 2 from 512 bytes to 128 Kbytes is valid.
1012 This property can also be referred to by its shortened column name,
1017 by this dataset, that was written since the previous snapshot
1018 .Pq i.e. that is not referenced by the previous snapshot .
1019 .It Sy written Ns @ Ns Em snapshot
1022 space written to this dataset since the specified snapshot.
1023 This is the space that is referenced by this dataset but was not referenced by
1024 the specified snapshot.
1028 may be specified as a short snapshot name
1029 .Po just the part after the
1032 in which case it will be interpreted as a snapshot in the same filesystem as
1036 may be a full snapshot name
1037 .Po Em filesystem Ns @ Ns Em snapshot Pc ,
1038 which for clones may be a snapshot in the origin's filesystem
1039 .Pq or the origin of the origin's filesystem, etc.
1042 The following native properties can be used to change the behavior of a ZFS
1046 .Sy aclinherit Ns = Ns Sy discard Ns | Ns Sy noallow Ns | Ns
1047 .Sy restricted Ns | Ns Sy passthrough Ns | Ns Sy passthrough-x
1049 Controls how ACEs are inherited when files and directories are created.
1050 .Bl -tag -width "passthrough-x"
1052 does not inherit any ACEs.
1054 only inherits inheritable ACEs that specify
1058 default, removes the
1062 permissions when the ACE is inherited.
1064 inherits all inheritable ACEs without any modifications.
1065 .It Sy passthrough-x
1073 ACEs inherit the execute permission only if the file creation mode also requests
1077 When the property value is set to
1079 files are created with a mode determined by the inheritable ACEs.
1080 If no inheritable ACEs exist that affect the mode, then the mode is set in
1081 accordance to the requested mode from the application.
1085 property does not apply to posix ACLs.
1086 .It Sy acltype Ns = Ns Sy off Ns | Ns Sy noacl Ns | Ns Sy posixacl
1087 Controls whether ACLs are enabled and if so what type of ACL to use.
1088 .Bl -tag -width "posixacl"
1090 default, when a file system has the
1092 property set to off then ACLs are disabled.
1097 indicates posix ACLs should be used. Posix ACLs are specific to Linux and are
1098 not functional on other platforms. Posix ACLs are stored as an extended
1099 attribute and therefore will not overwrite any existing NFSv4 ACLs which
1103 To obtain the best performance when setting
1105 users are strongly encouraged to set the
1107 property. This will result in the posix ACL being stored more efficiently on
1108 disk. But as a consequence of this all new extended attributes will only be
1109 accessible from OpenZFS implementations which support the
1113 property for more details.
1114 .It Sy atime Ns = Ns Sy on Ns | Ns Sy off
1115 Controls whether the access time for files is updated when they are read.
1116 Turning this property off avoids producing write traffic when reading files and
1117 can result in significant performance gains, though it might confuse mailers
1118 and other similar utilities. The values
1122 are equivalent to the
1126 mount options. The default value is
1131 .It Sy canmount Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy noauto
1132 If this property is set to
1134 the file system cannot be mounted, and is ignored by
1135 .Nm zfs Cm mount Fl a .
1136 Setting this property to
1138 is similar to setting the
1142 except that the dataset still has a normal
1144 property, which can be inherited.
1145 Setting this property to
1147 allows datasets to be used solely as a mechanism to inherit properties.
1148 One example of setting
1149 .Sy canmount Ns = Ns Sy off
1150 is to have two datasets with the same
1152 so that the children of both datasets appear in the same directory, but might
1153 have different inherited characteristics.
1157 a dataset can only be mounted and unmounted explicitly.
1158 The dataset is not mounted automatically when the dataset is created or
1159 imported, nor is it mounted by the
1160 .Nm zfs Cm mount Fl a
1161 command or unmounted by the
1162 .Nm zfs Cm unmount Fl a
1165 This property is not inherited.
1167 .Sy checksum Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy fletcher2 Ns | Ns
1168 .Sy fletcher4 Ns | Ns Sy sha256 Ns | Ns Sy noparity Ns | Ns
1169 .Sy sha512 Ns | Ns Sy skein Ns | Ns Sy edonr
1171 Controls the checksum used to verify data integrity.
1172 The default value is
1174 which automatically selects an appropriate algorithm
1177 but this may change in future releases
1181 disables integrity checking on user data.
1184 not only disables integrity but also disables maintaining parity for user data.
1185 This setting is used internally by a dump device residing on a RAID-Z pool and
1186 should not be used by any other dataset.
1187 Disabling checksums is
1189 a recommended practice.
1196 checksum algorithms require enabling the appropriate features on the pool.
1197 These algorithms are not supported by GRUB and should not be set on the
1199 filesystem when using GRUB to boot the system.
1201 .Xr zpool-features 5
1202 for more information on these algorithms.
1204 Changing this property affects only newly-written data.
1206 .Sy compression Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy gzip Ns | Ns
1207 .Sy gzip- Ns Em N Ns | Ns Sy lz4 Ns | Ns Sy lzjb Ns | Ns Sy zle
1209 Controls the compression algorithm used for this dataset.
1211 Setting compression to
1213 indicates that the current default compression algorithm should be used.
1214 The default balances compression and decompression speed, with compression ratio
1215 and is expected to work well on a wide variety of workloads.
1216 Unlike all other settings for this property,
1218 does not select a fixed compression type.
1219 As new compression algorithms are added to ZFS and enabled on a pool, the
1220 default compression algorithm may change.
1221 The current default compression algorithm is either
1230 compression algorithm is a high-performance replacement for the
1233 It features significantly faster compression and decompression, as well as a
1234 moderately higher compression ratio than
1236 but can only be used on pools with the
1241 .Xr zpool-features 5
1242 for details on ZFS feature flags and the
1248 compression algorithm is optimized for performance while providing decent data
1253 compression algorithm uses the same compression as the
1258 level by using the value
1262 is an integer from 1
1265 .Pq best compression ratio .
1270 .Po which is also the default for
1276 compression algorithm compresses runs of zeros.
1278 This property can also be referred to by its shortened column name
1280 Changing this property affects only newly-written data.
1282 .Sy context Ns = Ns Sy none Ns | Ns
1283 .Em SELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level
1285 This flag sets the SELinux context for all files in the file system under
1286 a mount point for that file system. See
1288 for more information.
1290 .Sy fscontext Ns = Ns Sy none Ns | Ns
1291 .Em SELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level
1293 This flag sets the SELinux context for the file system file system being
1296 for more information.
1298 .Sy defcontext Ns = Ns Sy none Ns | Ns
1299 .Em SELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level
1301 This flag sets the SELinux default context for unlabeled files. See
1303 for more information.
1305 .Sy rootcontext Ns = Ns Sy none Ns | Ns
1306 .Em SELinux_User:SElinux_Role:Selinux_Type:Sensitivity_Level
1308 This flag sets the SELinux context for the root inode of the file system. See
1310 for more information.
1311 .It Sy copies Ns = Ns Sy 1 Ns | Ns Sy 2 Ns | Ns Sy 3
1312 Controls the number of copies of data stored for this dataset.
1313 These copies are in addition to any redundancy provided by the pool, for
1314 example, mirroring or RAID-Z.
1315 The copies are stored on different disks, if possible.
1316 The space used by multiple copies is charged to the associated file and dataset,
1319 property and counting against quotas and reservations.
1321 Changing this property only affects newly-written data.
1322 Therefore, set this property at file system creation time by using the
1323 .Fl o Sy copies Ns = Ns Ar N
1326 Remember that ZFS will not import a pool with a missing top-level vdev. Do
1328 create, for example a two-disk striped pool and set
1330 on some datasets thinking you have setup redundancy for them. When a disk
1331 fails you will not be able to import the pool and will have lost all of your
1333 .It Sy devices Ns = Ns Sy on Ns | Ns Sy off
1334 Controls whether device nodes can be opened on this file system.
1335 The default value is
1341 are equivalent to the
1347 .Sy dedup Ns = Ns Sy off Ns | Ns Sy on Ns | Ns Sy verify Ns | Ns
1348 .Sy sha256[,verify] Ns | Ns Sy sha512[,verify] Ns | Ns Sy skein[,verify] Ns | Ns
1351 Configures deduplication for a dataset. The default value is
1353 The default deduplication checksum is
1355 (this may change in the future). When
1357 is enabled, the checksum defined here overrides the
1359 property. Setting the value to
1361 has the same effect as the setting
1366 ZFS will do a byte-to-byte comparsion in case of two blocks having the same
1367 signature to make sure the block contents are identical. Specifying
1369 is mandatory for the
1373 Unless necessary, deduplication should NOT be enabled on a system. See
1377 .Sy dnodesize Ns = Ns Sy legacy Ns | Ns Sy auto Ns | Ns Sy 1k Ns | Ns
1378 .Sy 2k Ns | Ns Sy 4k Ns | Ns Sy 8k Ns | Ns Sy 16k
1380 Specifies a compatibility mode or literal value for the size of dnodes in the
1381 file system. The default value is
1383 Setting this property to a value other than
1385 requires the large_dnode pool feature to be enabled.
1391 if the dataset uses the
1393 property setting and the workload makes heavy use of extended attributes. This
1394 may be applicable to SELinux-enabled systems, Lustre servers, and Samba
1395 servers, for example. Literal values are supported for cases where the optimal
1396 size is known in advance and for performance testing.
1402 if you need to receive a send stream of this dataset on a pool that doesn't
1403 enable the large_dnode feature, or if you need to import this pool on a system
1404 that doesn't support the large_dnode feature.
1406 This property can also be referred to by its shortened column name,
1409 .Sy encryption Ns = Ns Sy off Ns | Ns Sy on Ns | Ns Sy aes-128-ccm Ns | Ns
1410 .Sy aes-192-ccm Ns | Ns Sy aes-256-ccm Ns | Ns Sy aes-128-gcm Ns | Ns
1411 .Sy aes-192-gcm Ns | Ns Sy aes-256-gcm
1413 Controls the encryption cipher suite (block cipher, key length, and mode) used
1414 for this dataset. Requires the
1416 feature to be enabled on the pool.
1419 to be set at dataset creation time.
1422 .Sy encryption Ns = Ns Sy on
1423 when creating a dataset indicates that the default encryption suite will be
1424 selected, which is currently
1426 In order to provide consistent data protection, encryption must be specified at
1427 dataset creation time and it cannot be changed afterwards.
1429 For more details and caveats about encryption see the
1432 .It Sy keyformat Ns = Ns Sy raw Ns | Ns Sy hex Ns | Ns Sy passphrase
1433 Controls what format the user's encryption key will be provided as. This
1434 property is only set when the dataset is encrypted.
1436 Raw keys and hex keys must be 32 bytes long (regardless of the chosen
1437 encryption suite) and must be randomly generated. A raw key can be generated
1438 with the following command:
1440 # dd if=/dev/urandom of=/path/to/output/key bs=32 count=1
1443 Passphrases must be between 8 and 512 bytes long and will be processed through
1444 PBKDF2 before being used (see the
1446 property). Even though the
1447 encryption suite cannot be changed after dataset creation, the keyformat can be
1449 .Nm zfs Cm change-key .
1451 .Sy keylocation Ns = Ns Sy prompt Ns | Ns Sy file:// Ns Em </absolute/file/path>
1453 Controls where the user's encryption key will be loaded from by default for
1457 .Nm zfs Cm mount Cm -l .
1458 This property is only set for encrypted datasets which are encryption roots. If
1459 unspecified, the default is
1462 Even though the encryption suite cannot be changed after dataset creation, the
1463 keylocation can be with either
1466 .Nm zfs Cm change-key .
1469 is selected ZFS will ask for the key at the command prompt when it is required
1470 to access the encrypted data (see
1472 for details). This setting will also allow the key to be passed in via STDIN,
1473 but users should be careful not to place keys which should be kept secret on
1474 the command line. If a file URI is selected, the key will be loaded from the
1475 specified absolute file path.
1476 .It Sy pbkdf2iters Ns = Ns Ar iterations
1477 Controls the number of PBKDF2 iterations that a
1479 encryption key should be run through when processing it into an encryption key.
1480 This property is only defined when encryption is enabled and a keyformat of
1482 is selected. The goal of PBKDF2 is to significantly increase the
1483 computational difficulty needed to brute force a user's passphrase. This is
1484 accomplished by forcing the attacker to run each passphrase through a
1485 computationally expensive hashing function many times before they arrive at the
1486 resulting key. A user who actually knows the passphrase will only have to pay
1487 this cost once. As CPUs become better at processing, this number should be
1488 raised to ensure that a brute force attack is still not possible. The current
1493 This property may be changed with
1494 .Nm zfs Cm change-key .
1495 .It Sy exec Ns = Ns Sy on Ns | Ns Sy off
1496 Controls whether processes can be executed from within this file system.
1497 The default value is
1503 are equivalent to the
1508 .It Sy filesystem_limit Ns = Ns Em count Ns | Ns Sy none
1509 Limits the number of filesystems and volumes that can exist under this point in
1511 The limit is not enforced if the user is allowed to change the limit.
1513 .Sy filesystem_limit
1516 a descendent of a filesystem that already has a
1517 .Sy filesystem_limit
1518 does not override the ancestor's
1519 .Sy filesystem_limit ,
1520 but rather imposes an additional limit.
1521 This feature must be enabled to be used
1523 .Xr zpool-features 5
1525 .It Sy mountpoint Ns = Ns Pa path Ns | Ns Sy none Ns | Ns Sy legacy
1526 Controls the mount point used for this file system.
1529 section for more information on how this property is used.
1533 property is changed for a file system, the file system and any children that
1534 inherit the mount point are unmounted.
1537 then they remain unmounted.
1538 Otherwise, they are automatically remounted in the new location if the property
1543 or if they were mounted before the property was changed.
1544 In addition, any shared file systems are unshared and shared in the new
1546 .It Sy nbmand Ns = Ns Sy on Ns | Ns Sy off
1547 Controls whether the file system should be mounted with
1549 .Pq Non Blocking mandatory locks .
1550 This is used for SMB clients.
1551 Changes to this property only take effect when the file system is umounted and
1555 for more information on
1557 mounts. This property is not used on Linux.
1558 .It Sy overlay Ns = Ns Sy off Ns | Ns Sy on
1559 Allow mounting on a busy directory or a directory which already contains
1560 files or directories. This is the default mount behavior for Linux file systems.
1561 For consistency with OpenZFS on other platforms overlay mounts are
1565 to enable overlay mounts.
1566 .It Sy primarycache Ns = Ns Sy all Ns | Ns Sy none Ns | Ns Sy metadata
1567 Controls what is cached in the primary cache
1569 If this property is set to
1571 then both user data and metadata is cached.
1572 If this property is set to
1574 then neither user data nor metadata is cached.
1575 If this property is set to
1577 then only metadata is cached.
1578 The default value is
1580 .It Sy quota Ns = Ns Em size Ns | Ns Sy none
1581 Limits the amount of space a dataset and its descendents can consume.
1582 This property enforces a hard limit on the amount of space used.
1583 This includes all space consumed by descendents, including file systems and
1585 Setting a quota on a descendent of a dataset that already has a quota does not
1586 override the ancestor's quota, but rather imposes an additional limit.
1588 Quotas cannot be set on volumes, as the
1590 property acts as an implicit quota.
1591 .It Sy snapshot_limit Ns = Ns Em count Ns | Ns Sy none
1592 Limits the number of snapshots that can be created on a dataset and its
1596 on a descendent of a dataset that already has a
1598 does not override the ancestor's
1599 .Sy snapshot_limit ,
1600 but rather imposes an additional limit.
1601 The limit is not enforced if the user is allowed to change the limit.
1602 For example, this means that recursive snapshots taken from the global zone are
1603 counted against each delegated dataset within a zone.
1604 This feature must be enabled to be used
1606 .Xr zpool-features 5
1608 .It Sy userquota@ Ns Em user Ns = Ns Em size Ns | Ns Sy none
1609 Limits the amount of space consumed by the specified user.
1610 User space consumption is identified by the
1611 .Sy userspace@ Ns Em user
1614 Enforcement of user quotas may be delayed by several seconds.
1615 This delay means that a user might exceed their quota before the system notices
1616 that they are over quota and begins to refuse additional writes with the
1620 .Nm zfs Cm userspace
1621 subcommand for more information.
1623 Unprivileged users can only access their own groups' space usage.
1624 The root user, or a user who has been granted the
1628 can get and set everyone's quota.
1630 This property is not available on volumes, on file systems before version 4, or
1631 on pools before version 15.
1633 .Sy userquota@ Ns Em ...
1634 properties are not displayed by
1635 .Nm zfs Cm get Sy all .
1636 The user's name must be appended after the
1638 symbol, using one of the following forms:
1646 .Em POSIX numeric ID
1653 .Sy joe.smith@mydomain
1662 Files created on Linux always have POSIX owners.
1663 .It Sy userobjquota@ Ns Em user Ns = Ns Em size Ns | Ns Sy none
1668 but it limits the number of objects a user can create. Please refer to
1670 for more information about how objects are counted.
1671 .It Sy groupquota@ Ns Em group Ns = Ns Em size Ns | Ns Sy none
1672 Limits the amount of space consumed by the specified group.
1673 Group space consumption is identified by the
1674 .Sy groupused@ Ns Em group
1677 Unprivileged users can access only their own groups' space usage.
1678 The root user, or a user who has been granted the
1682 can get and set all groups' quotas.
1683 .It Sy groupobjquota@ Ns Em group Ns = Ns Em size Ns | Ns Sy none
1688 but it limits number of objects a group can consume. Please refer to
1690 for more information about how objects are counted.
1691 .It Sy projectquota@ Ns Em project Ns = Ns Em size Ns | Ns Sy none
1692 Limits the amount of space consumed by the specified project. Project
1693 space consumption is identified by the
1694 .Sy projectused@ Ns Em project
1695 property. Please refer to
1697 for more information about how project is identified and set/changed.
1699 The root user, or a user who has been granted the
1703 can access all projects' quota.
1704 .It Sy projectobjquota@ Ns Em project Ns = Ns Em size Ns | Ns Sy none
1709 but it limits number of objects a project can consume. Please refer to
1711 for more information about how objects are counted.
1712 .It Sy readonly Ns = Ns Sy on Ns | Ns Sy off
1713 Controls whether this dataset can be modified.
1714 The default value is
1720 are equivalent to the
1726 This property can also be referred to by its shortened column name,
1728 .It Sy recordsize Ns = Ns Em size
1729 Specifies a suggested block size for files in the file system.
1730 This property is designed solely for use with database workloads that access
1731 files in fixed-size records.
1732 ZFS automatically tunes block sizes according to internal algorithms optimized
1733 for typical access patterns.
1735 For databases that create very large files but access them in small random
1736 chunks, these algorithms may be suboptimal.
1739 greater than or equal to the record size of the database can result in
1740 significant performance gains.
1741 Use of this property for general purpose file systems is strongly discouraged,
1742 and may adversely affect performance.
1744 The size specified must be a power of two greater than or equal to 512 and less
1745 than or equal to 128 Kbytes.
1748 feature is enabled on the pool, the size may be up to 1 Mbyte.
1750 .Xr zpool-features 5
1751 for details on ZFS feature flags.
1753 Changing the file system's
1755 affects only files created afterward; existing files are unaffected.
1757 This property can also be referred to by its shortened column name,
1759 .It Sy redundant_metadata Ns = Ns Sy all Ns | Ns Sy most
1760 Controls what types of metadata are stored redundantly.
1761 ZFS stores an extra copy of metadata, so that if a single block is corrupted,
1762 the amount of user data lost is limited.
1763 This extra copy is in addition to any redundancy provided at the pool level
1764 .Pq e.g. by mirroring or RAID-Z ,
1765 and is in addition to an extra copy specified by the
1768 .Pq up to a total of 3 copies .
1769 For example if the pool is mirrored,
1770 .Sy copies Ns = Ns 2 ,
1772 .Sy redundant_metadata Ns = Ns Sy most ,
1773 then ZFS stores 6 copies of most metadata, and 4 copies of data and some
1778 ZFS stores an extra copy of all metadata.
1779 If a single on-disk block is corrupt, at worst a single block of user data
1788 ZFS stores an extra copy of most types of metadata.
1789 This can improve performance of random writes, because less metadata must be
1791 In practice, at worst about 100 blocks
1796 of user data can be lost if a single on-disk block is corrupt.
1797 The exact behavior of which metadata blocks are stored redundantly may change in
1800 The default value is
1802 .It Sy refquota Ns = Ns Em size Ns | Ns Sy none
1803 Limits the amount of space a dataset can consume.
1804 This property enforces a hard limit on the amount of space used.
1805 This hard limit does not include space used by descendents, including file
1806 systems and snapshots.
1807 .It Sy refreservation Ns = Ns Em size Ns | Ns Sy none Ns | Ns Sy auto
1808 The minimum amount of space guaranteed to a dataset, not including its
1810 When the amount of space used is below this value, the dataset is treated as if
1811 it were taking up the amount of space specified by
1812 .Sy refreservation .
1815 reservation is accounted for in the parent datasets' space used, and counts
1816 against the parent datasets' quotas and reservations.
1820 is set, a snapshot is only allowed if there is enough free pool space outside of
1821 this reservation to accommodate the current number of
1823 bytes in the dataset.
1829 a volume is thick provisioned
1833 .Sy refreservation Ns = Ns Sy auto
1834 is only supported on volumes.
1838 .Sx Native Properties
1839 section for more information about sparse volumes.
1841 This property can also be referred to by its shortened column name,
1843 .It Sy relatime Ns = Ns Sy on Ns | Ns Sy off
1844 Controls the manner in which the access time is updated when
1846 is set. Turning this property on causes the access time to be updated relative
1847 to the modify or change time. Access time is only updated if the previous
1848 access time was earlier than the current modify or change time or if the
1849 existing access time hasn't been updated within the past 24 hours. The default
1856 are equivalent to the
1861 .It Sy reservation Ns = Ns Em size Ns | Ns Sy none
1862 The minimum amount of space guaranteed to a dataset and its descendants.
1863 When the amount of space used is below this value, the dataset is treated as if
1864 it were taking up the amount of space specified by its reservation.
1865 Reservations are accounted for in the parent datasets' space used, and count
1866 against the parent datasets' quotas and reservations.
1868 This property can also be referred to by its shortened column name,
1870 .It Sy secondarycache Ns = Ns Sy all Ns | Ns Sy none Ns | Ns Sy metadata
1871 Controls what is cached in the secondary cache
1873 If this property is set to
1875 then both user data and metadata is cached.
1876 If this property is set to
1878 then neither user data nor metadata is cached.
1879 If this property is set to
1881 then only metadata is cached.
1882 The default value is
1884 .It Sy setuid Ns = Ns Sy on Ns | Ns Sy off
1885 Controls whether the setuid bit is respected for the file system.
1886 The default value is
1892 are equivalent to the
1897 .It Sy sharesmb Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Em opts
1898 Controls whether the file system is shared by using
1899 .Sy Samba USERSHARES
1900 and what options are to be used. Otherwise, the file system is automatically
1901 shared and unshared with the
1905 commands. If the property is set to on, the
1907 command is invoked to create a
1910 Because SMB shares requires a resource name, a unique resource name is
1911 constructed from the dataset name. The constructed name is a copy of the
1912 dataset name except that the characters in the dataset name, which would be
1913 invalid in the resource name, are replaced with underscore (_) characters.
1914 Linux does not currently support additional options which might be available
1921 the file systems are unshared.
1923 The share is created with the ACL (Access Control List) "Everyone:F" ("F"
1924 stands for "full permissions", ie. read and write permissions) and no guest
1925 access (which means Samba must be able to authenticate a real user, system
1926 passwd/shadow, LDAP or smbpasswd based) by default. This means that any
1927 additional access control (disallow specific user specific access etc) must
1928 be done on the underlying file system.
1929 .It Sy sharenfs Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Em opts
1930 Controls whether the file system is shared via NFS, and what options are to be
1932 A file system with a
1938 command and entries in the
1941 Otherwise, the file system is automatically shared and unshared with the
1946 If the property is set to
1948 the dataset is shared using the default options:
1950 .Em sec=sys,rw,crossmnt,no_subtree_check,no_root_squash
1954 for the meaning of the default options. Otherwise, the
1956 command is invoked with options equivalent to the contents of this property.
1960 property is changed for a dataset, the dataset and any children inheriting the
1961 property are re-shared with the new options, only if the property was previously
1963 or if they were shared before the property was changed.
1964 If the new property is
1966 the file systems are unshared.
1967 .It Sy logbias Ns = Ns Sy latency Ns | Ns Sy throughput
1968 Provide a hint to ZFS about handling of synchronous requests in this dataset.
1974 ZFS will use pool log devices
1976 to handle the requests at low latency.
1981 ZFS will not use configured pool log devices.
1982 ZFS will instead optimize synchronous operations for global pool throughput and
1983 efficient use of resources.
1984 .It Sy snapdev Ns = Ns Sy hidden Ns | Ns Sy visible
1985 Controls whether the volume snapshot devices under
1986 .Em /dev/zvol/<pool>
1987 are hidden or visible. The default value is
1989 .It Sy snapdir Ns = Ns Sy hidden Ns | Ns Sy visible
1990 Controls whether the
1992 directory is hidden or visible in the root of the file system as discussed in
1996 The default value is
1998 .It Sy sync Ns = Ns Sy standard Ns | Ns Sy always Ns | Ns Sy disabled
1999 Controls the behavior of synchronous requests
2000 .Pq e.g. fsync, O_DSYNC .
2004 specified behavior of ensuring all synchronous requests are written to stable
2005 storage and all devices are flushed to ensure data is not cached by device
2007 .Pq this is the default .
2009 causes every file system transaction to be written and flushed before its
2010 system call returns.
2011 This has a large performance penalty.
2013 disables synchronous requests.
2014 File system transactions are only committed to stable storage periodically.
2015 This option will give the highest performance.
2016 However, it is very dangerous as ZFS would be ignoring the synchronous
2017 transaction demands of applications such as databases or NFS.
2018 Administrators should only use this option when the risks are understood.
2019 .It Sy version Ns = Ns Em N Ns | Ns Sy current
2020 The on-disk version of this file system, which is independent of the pool
2022 This property can only be set to later supported versions.
2026 .It Sy volsize Ns = Ns Em size
2027 For volumes, specifies the logical size of the volume.
2028 By default, creating a volume establishes a reservation of equal size.
2029 For storage pools with a version number of 9 or higher, a
2034 are reflected in an equivalent change to the reservation
2040 can only be set to a multiple of
2044 The reservation is kept equal to the volume's logical size to prevent unexpected
2045 behavior for consumers.
2046 Without the reservation, the volume could run out of space, resulting in
2047 undefined behavior or data corruption, depending on how the volume is used.
2048 These effects can also occur when the volume size is changed while it is in use
2049 .Pq particularly when shrinking the size .
2050 Extreme care should be used when adjusting the volume size.
2052 Though not recommended, a
2055 .Qq thin provisioned
2057 can be created by specifying the
2060 .Nm zfs Cm create Fl V
2061 command, or by changing the value of the
2066 property on pool version 8 or earlier
2068 after the volume has been created.
2071 is a volume where the value of
2073 is less than the size of the volume plus the space required to store its
2075 Consequently, writes to a sparse volume can fail with
2077 when the pool is low on space.
2078 For a sparse volume, changes to
2080 are not reflected in the
2082 A volume that is not sparse is said to be
2083 .Qq thick provisioned .
2084 A sparse volume can become thick provisioned by setting
2088 .It Sy volmode Ns = Ns Cm default | full | geom | dev | none
2089 This property specifies how volumes should be exposed to the OS.
2092 exposes volumes as fully fledged block devices, providing maximal
2093 functionality. The value
2095 is just an alias for
2097 and is kept for compatibility.
2100 hides its partitions.
2101 Volumes with property set to
2103 are not exposed outside ZFS, but can be snapshoted, cloned, replicated, etc,
2104 that can be suitable for backup purposes.
2107 means that volumes exposition is controlled by system-wide tunable
2114 are encoded as 1, 2 and 3 respectively.
2115 The default values is
2117 .It Sy vscan Ns = Ns Sy on Ns | Ns Sy off
2118 Controls whether regular files should be scanned for viruses when a file is
2120 In addition to enabling this property, the virus scan service must also be
2121 enabled for virus scanning to occur.
2122 The default value is
2124 This property is not used on Linux.
2125 .It Sy xattr Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy sa
2126 Controls whether extended attributes are enabled for this file system. Two
2127 styles of extended attributes are supported either directory based or system
2130 The default value of
2132 enables directory based extended attributes. This style of extended attribute
2133 imposes no practical limit on either the size or number of attributes which
2134 can be set on a file. Although under Linux the
2138 system calls limit the maximum size to 64K. This is the most compatible
2139 style of extended attribute and is supported by all OpenZFS implementations.
2141 System attribute based xattrs can be enabled by setting the value to
2143 The key advantage of this type of xattr is improved performance. Storing
2144 extended attributes as system attributes significantly decreases the amount of
2145 disk IO required. Up to 64K of data may be stored per-file in the space
2146 reserved for system attributes. If there is not enough space available for
2147 an extended attribute then it will be automatically written as a directory
2148 based xattr. System attribute based extended attributes are not accessible
2149 on platforms which do not support the
2153 The use of system attribute based xattrs is strongly encouraged for users of
2154 SELinux or posix ACLs. Both of these features heavily rely of extended
2155 attributes and benefit significantly from the reduced access time.
2161 are equivalent to the
2166 .It Sy zoned Ns = Ns Sy on Ns | Ns Sy off
2167 Controls whether the dataset is managed from a non-global zone. Zones are a
2168 Solaris feature and are not relevant on Linux. The default value is
2172 The following three properties cannot be changed after the file system is
2173 created, and therefore, should be set when the file system is created.
2174 If the properties are not set with the
2178 commands, these properties are inherited from the parent dataset.
2179 If the parent dataset lacks these properties due to having been created prior to
2180 these features being supported, the new file system will have the default values
2181 for these properties.
2184 .Sy casesensitivity Ns = Ns Sy sensitive Ns | Ns
2185 .Sy insensitive Ns | Ns Sy mixed
2187 Indicates whether the file name matching algorithm used by the file system
2188 should be case-sensitive, case-insensitive, or allow a combination of both
2190 The default value for the
2198 file systems have case-sensitive file names.
2204 property indicates that the file system can support requests for both
2205 case-sensitive and case-insensitive matching behavior.
2206 Currently, case-insensitive matching behavior on a file system that supports
2207 mixed behavior is limited to the SMB server product.
2208 For more information about the
2210 value behavior, see the "ZFS Administration Guide".
2212 .Sy normalization Ns = Ns Sy none Ns | Ns Sy formC Ns | Ns
2213 .Sy formD Ns | Ns Sy formKC Ns | Ns Sy formKD
2215 Indicates whether the file system should perform a
2217 normalization of file names whenever two file names are compared, and which
2218 normalization algorithm should be used.
2219 File names are always stored unmodified, names are normalized as part of any
2221 If this property is set to a legal value other than
2225 property was left unspecified, the
2227 property is automatically set to
2229 The default value of the
2233 This property cannot be changed after the file system is created.
2234 .It Sy utf8only Ns = Ns Sy on Ns | Ns Sy off
2235 Indicates whether the file system should reject file names that include
2236 characters that are not present in the
2239 If this property is explicitly set to
2241 the normalization property must either not be explicitly set or be set to
2243 The default value for the
2247 This property cannot be changed after the file system is created.
2251 .Sy casesensitivity ,
2255 properties are also new permissions that can be assigned to non-privileged users
2256 by using the ZFS delegated administration feature.
2257 .Ss "Temporary Mount Point Properties"
2258 When a file system is mounted, either through
2260 for legacy mounts or the
2262 command for normal file systems, its mount options are set according to its
2264 The correlation between properties and mount options is as follows:
2266 PROPERTY MOUNT OPTION
2268 canmount auto/noauto
2272 relatime relatime/norelatime
2277 In addition, these options can be set on a per-mount basis using the
2279 option, without affecting the property that is stored on disk.
2280 The values specified on the command line override the values stored in the
2284 option is an alias for
2285 .Sy nodevices Ns \&, Ns Sy nosetuid .
2286 These properties are reported as
2291 If the properties are changed while the dataset is mounted, the new setting
2292 overrides any temporary settings.
2293 .Ss "User Properties"
2294 In addition to the standard native properties, ZFS supports arbitrary user
2296 User properties have no effect on ZFS behavior, but applications or
2297 administrators can use them to annotate datasets
2298 .Pq file systems, volumes, and snapshots .
2300 User property names must contain a colon
2302 character to distinguish them from native properties.
2303 They may contain lowercase letters, numbers, and the following punctuation
2312 The expected convention is that the property name is divided into two portions
2314 .Em module Ns \&: Ns Em property ,
2315 but this namespace is not enforced by ZFS.
2316 User property names can be at most 256 characters, and cannot begin with a dash
2319 When making programmatic use of user properties, it is strongly suggested to use
2324 component of property names to reduce the chance that two
2325 independently-developed packages use the same property name for different
2328 The values of user properties are arbitrary strings, are always inherited, and
2329 are never validated.
2330 All of the commands that operate on properties
2331 .Po Nm zfs Cm list ,
2336 can be used to manipulate both native properties and user properties.
2339 command to clear a user property.
2340 If the property is not defined in any parent dataset, it is removed entirely.
2341 Property values are limited to 8192 bytes.
2342 .Ss ZFS Volumes as Swap
2343 ZFS volumes may be used as swap devices. After creating the volume with the
2344 .Nm zfs Cm create Fl V
2345 command set up and enable the swap area using the
2349 commands. Do not swap to a file on a ZFS file system. A ZFS swap file
2350 configuration is not supported.
2354 feature allows for the creation of encrypted filesystems and volumes.
2356 will encrypt all user data including file and zvol data, file attributes,
2357 ACLs, permission bits, directory listings, FUID mappings, and userused /
2360 will not encrypt metadata related to the pool structure, including dataset
2361 names, dataset hierarchy, file size, file holes, and dedup tables. Key rotation
2362 is managed internally by the kernel module and changing the user's key does not
2363 require re-encrypting the entire dataset. Datasets can be scrubbed, resilvered,
2364 renamed, and deleted without the encryption keys being loaded (see the
2366 subcommand for more info on key loading).
2368 Creating an encrypted dataset requires specifying the
2372 properties at creation time, along with an optional
2376 After entering an encryption key, the
2377 created dataset will become an encryption root. Any descendant datasets will
2378 inherit their encryption key from the encryption root by default, meaning that
2379 loading, unloading, or changing the key for the encryption root will implicitly
2380 do the same for all inheriting datasets. If this inheritance is not desired,
2383 when creating the child dataset or use
2384 .Nm zfs Cm change-key
2385 to break an existing relationship, creating a new encryption root on the child.
2386 Note that the child's
2388 may match that of the parent while still creating a new encryption root, and
2391 property alone does not create a new encryption root; this would simply use a
2392 different cipher suite with the same key as its encryption root. The one
2393 exception is that clones will always use their origin's encryption key.
2394 As a result of this exception, some encryption-related properties (namely
2400 do not inherit like other ZFS properties and instead use the value determined
2401 by their encryption root. Encryption root inheritance can be tracked via the
2406 Encryption changes the behavior of a few
2408 operations. Encryption is applied after compression so compression ratios are
2409 preserved. Normally checksums in ZFS are 256 bits long, but for encrypted data
2410 the checksum is 128 bits of the user-chosen checksum and 128 bits of MAC from
2411 the encryption suite, which provides additional protection against maliciously
2412 altered data. Deduplication is still possible with encryption enabled but for
2413 security, datasets will only dedup against themselves, their snapshots, and
2416 There are a few limitations on encrypted datasets. Encrypted data cannot be
2419 feature. Encrypted datasets may not have
2420 .Sy copies Ns = Ns Em 3
2421 since the implementation stores some encryption metadata where the third copy
2422 would normally be. Since compression is applied before encryption datasets may
2423 be vulnerable to a CRIME-like attack if applications accessing the data allow
2424 for it. Deduplication with encryption will leak information about which blocks
2425 are equivalent in a dataset and will incur an extra CPU cost per block written.
2427 All subcommands that modify state are logged persistently to the pool in their
2431 Displays a help message.
2436 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2439 Creates a new ZFS file system.
2440 The file system is automatically mounted according to the
2442 property inherited from the parent.
2443 .Bl -tag -width "-o"
2444 .It Fl o Ar property Ns = Ns Ar value
2445 Sets the specified property as if the command
2446 .Nm zfs Cm set Ar property Ns = Ns Ar value
2447 was invoked at the same time the dataset was created.
2448 Any editable ZFS property can also be set at creation time.
2451 options can be specified.
2452 An error results if the same property is specified in multiple
2456 Creates all the non-existing parent datasets.
2457 Datasets created in this manner are automatically mounted according to the
2459 property inherited from their parent.
2460 Any property specified on the command line using the
2463 If the target filesystem already exists, the operation completes successfully.
2469 .Op Fl b Ar blocksize
2470 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2471 .Fl V Ar size Ar volume
2473 Creates a volume of the given size.
2474 The volume is exported as a block device in
2475 .Pa /dev/zvol/path ,
2478 is the name of the volume in the ZFS namespace.
2479 The size represents the logical size as exported by the device.
2480 By default, a reservation of equal size is created.
2483 is automatically rounded up to the nearest 128 Kbytes to ensure that the volume
2484 has an integral number of blocks regardless of
2486 .Bl -tag -width "-b"
2487 .It Fl b Ar blocksize
2489 .Fl o Sy volblocksize Ns = Ns Ar blocksize .
2490 If this option is specified in conjunction with
2491 .Fl o Sy volblocksize ,
2492 the resulting behavior is undefined.
2493 .It Fl o Ar property Ns = Ns Ar value
2494 Sets the specified property as if the
2495 .Nm zfs Cm set Ar property Ns = Ns Ar value
2496 command was invoked at the same time the dataset was created.
2497 Any editable ZFS property can also be set at creation time.
2500 options can be specified.
2501 An error results if the same property is specified in multiple
2505 Creates all the non-existing parent datasets.
2506 Datasets created in this manner are automatically mounted according to the
2508 property inherited from their parent.
2509 Any property specified on the command line using the
2512 If the target filesystem already exists, the operation completes successfully.
2514 Creates a sparse volume with no reservation.
2518 .Sx Native Properties
2519 section for more information about sparse volumes.
2525 .Ar filesystem Ns | Ns Ar volume
2527 Destroys the given dataset.
2528 By default, the command unshares any file systems that are currently shared,
2529 unmounts any file systems that are currently mounted, and refuses to destroy a
2530 dataset that has active dependents
2531 .Pq children or clones .
2532 .Bl -tag -width "-R"
2534 Recursively destroy all dependents, including cloned file systems outside the
2537 Force an unmount of any file systems using the
2540 This option has no effect on non-file systems or unmounted file systems.
2545 No data will be deleted.
2546 This is useful in conjunction with the
2550 flags to determine what data would be deleted.
2552 Print machine-parsable verbose information about the deleted data.
2554 Recursively destroy all children.
2556 Print verbose information about the deleted data.
2559 Extreme care should be taken when applying either the
2563 options, as they can destroy large portions of a pool and cause unexpected
2564 behavior for mounted file systems in use.
2569 .Ar filesystem Ns | Ns Ar volume Ns @ Ns Ar snap Ns
2570 .Oo % Ns Ar snap Ns Oo , Ns Ar snap Ns Oo % Ns Ar snap Oc Oc Oc Ns ...
2572 The given snapshots are destroyed immediately if and only if the
2576 option would have destroyed it.
2577 Such immediate destruction would occur, for example, if the snapshot had no
2578 clones and the user-initiated reference count were zero.
2580 If a snapshot does not qualify for immediate destruction, it is marked for
2582 In this state, it exists as a usable, visible snapshot until both of the
2583 preconditions listed above are met, at which point it is destroyed.
2585 An inclusive range of snapshots may be specified by separating the first and
2586 last snapshots with a percent sign.
2587 The first and/or last snapshots may be left blank, in which case the
2588 filesystem's oldest or newest snapshot will be implied.
2591 .Pq or ranges of snapshots
2592 of the same filesystem or volume may be specified in a comma-separated list of
2594 Only the snapshot's short name
2595 .Po the part after the
2598 should be specified when using a range or comma-separated list to identify
2600 .Bl -tag -width "-R"
2602 Recursively destroy all clones of these snapshots, including the clones,
2603 snapshots, and children.
2604 If this flag is specified, the
2606 flag will have no effect.
2608 Destroy immediately. If a snapshot cannot be destroyed now, mark it for
2609 deferred destruction.
2614 No data will be deleted.
2615 This is useful in conjunction with the
2619 flags to determine what data would be deleted.
2621 Print machine-parsable verbose information about the deleted data.
2624 .Pq or mark for deferred deletion
2625 all snapshots with this name in descendent file systems.
2627 Print verbose information about the deleted data.
2629 Extreme care should be taken when applying either the
2633 options, as they can destroy large portions of a pool and cause unexpected
2634 behavior for mounted file systems in use.
2639 .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
2641 The given bookmark is destroyed.
2646 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2647 .Ar filesystem Ns @ Ns Ar snapname Ns | Ns Ar volume Ns @ Ns Ar snapname Ns ...
2649 Creates snapshots with the given names.
2650 All previous modifications by successful system calls to the file system are
2651 part of the snapshots.
2652 Snapshots are taken atomically, so that all snapshots correspond to the same
2655 can be used as an alias for
2656 .Nm zfs Cm snapshot.
2659 section for details.
2660 .Bl -tag -width "-o"
2661 .It Fl o Ar property Ns = Ns Ar value
2662 Sets the specified property; see
2666 Recursively create snapshots of all descendent datasets
2674 Roll back the given dataset to a previous snapshot.
2675 When a dataset is rolled back, all data that has changed since the snapshot is
2676 discarded, and the dataset reverts to the state at the time of the snapshot.
2677 By default, the command refuses to roll back to a snapshot other than the most
2679 In order to do so, all intermediate snapshots and bookmarks must be destroyed by
2686 options do not recursively destroy the child snapshots of a recursive snapshot.
2687 Only direct snapshots of the specified filesystem are destroyed by either of
2689 To completely roll back a recursive snapshot, you must rollback the individual
2691 .Bl -tag -width "-R"
2693 Destroy any more recent snapshots and bookmarks, as well as any clones of those
2698 option to force an unmount of any clone file systems that are to be destroyed.
2700 Destroy any snapshots and bookmarks more recent than the one specified.
2706 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
2707 .Ar snapshot Ar filesystem Ns | Ns Ar volume
2709 Creates a clone of the given snapshot.
2712 section for details.
2713 The target dataset can be located anywhere in the ZFS hierarchy, and is created
2714 as the same type as the original.
2715 .Bl -tag -width "-o"
2716 .It Fl o Ar property Ns = Ns Ar value
2717 Sets the specified property; see
2721 Creates all the non-existing parent datasets.
2722 Datasets created in this manner are automatically mounted according to the
2724 property inherited from their parent.
2725 If the target filesystem or volume already exists, the operation completes
2731 .Ar clone-filesystem
2733 Promotes a clone file system to no longer be dependent on its
2736 This makes it possible to destroy the file system that the clone was created
2738 The clone parent-child dependency relationship is reversed, so that the origin
2739 file system becomes a clone of the specified file system.
2741 The snapshot that was cloned, and any snapshots previous to this snapshot, are
2742 now owned by the promoted clone.
2743 The space they use moves from the origin file system to the promoted clone, so
2744 enough space must be available to accommodate these snapshots.
2745 No new space is consumed by this operation, but the space accounting is
2747 The promoted clone must not have any conflicting snapshot names of its own.
2750 subcommand can be used to rename any conflicting snapshots.
2755 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2756 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2762 .Ar filesystem Ns | Ns Ar volume
2763 .Ar filesystem Ns | Ns Ar volume
2765 Renames the given dataset.
2766 The new target can be located anywhere in the ZFS hierarchy, with the exception
2768 Snapshots can only be renamed within the parent file system or volume.
2769 When renaming a snapshot, the parent file system of the snapshot does not need
2770 to be specified as part of the second argument.
2771 Renamed file systems can inherit new mount points, in which case they are
2772 unmounted and remounted at the new mount point.
2773 .Bl -tag -width "-a"
2775 Force unmount any filesystems that need to be unmounted in the process.
2777 Creates all the nonexistent parent datasets.
2778 Datasets created in this manner are automatically mounted according to the
2780 property inherited from their parent.
2786 .Ar snapshot Ar snapshot
2788 Recursively rename the snapshots of all descendent datasets.
2789 Snapshots are the only dataset that can be renamed recursively.
2793 .Op Fl r Ns | Ns Fl d Ar depth
2795 .Oo Fl o Ar property Ns Oo , Ns Ar property Oc Ns ... Oc
2796 .Oo Fl s Ar property Oc Ns ...
2797 .Oo Fl S Ar property Oc Ns ...
2798 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
2799 .Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Oc Ns ...
2801 Lists the property information for the given datasets in tabular form.
2802 If specified, you can list property information by the absolute pathname or the
2804 By default, all file systems and volumes are displayed.
2805 Snapshots are displayed if the
2812 The following fields are displayed:
2813 .Sy name Ns \&, Sy used Ns \&, Sy available Ns \&, Sy referenced Ns \&, Sy mountpoint Ns .
2814 .Bl -tag -width "-H"
2816 Used for scripting mode.
2817 Do not print headers and separate fields by a single tab instead of arbitrary
2819 .It Fl S Ar property
2822 option, but sorts by property in descending order.
2824 Recursively display any children of the dataset, limiting the recursion to
2830 will display only the dataset and its direct children.
2831 .It Fl o Ar property
2832 A comma-separated list of properties to display.
2833 The property must be:
2836 One of the properties described in the
2837 .Sx Native Properties
2844 to display the dataset name
2848 to display space usage properties on file systems and volumes.
2849 This is a shortcut for specifying
2850 .Fl o Sy name Ns \&, Ns Sy avail Ns \&, Ns Sy used Ns \&, Ns Sy usedsnap Ns \&, Ns
2851 .Sy usedds Ns \&, Ns Sy usedrefreserv Ns \&, Ns Sy usedchild Fl t
2852 .Sy filesystem Ns \&, Ns Sy volume
2856 Display numbers in parsable
2860 Recursively display any children of the dataset on the command line.
2861 .It Fl s Ar property
2862 A property for sorting the output by column in ascending order based on the
2863 value of the property.
2864 The property must be one of the properties described in the
2866 section, or the special value
2868 to sort by the dataset name.
2869 Multiple properties can be specified at one time using multiple
2874 options are evaluated from left to right in decreasing order of importance.
2875 The following is a list of sorting criteria:
2878 Numeric types sort in numeric order.
2880 String types sort in alphabetical order.
2882 Types inappropriate for a row sort that row to the literal bottom, regardless of
2883 the specified ordering.
2886 If no sorting options are specified the existing behavior of
2890 A comma-separated list of types to display, where
2899 For example, specifying
2901 displays only snapshots.
2906 .Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ...
2907 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
2909 Sets the property or list of properties to the given value(s) for each dataset.
2910 Only some properties can be edited.
2913 section for more information on what properties can be set and acceptable
2915 Numeric values can be specified as exact values, or in a human-readable form
2917 .Sy B , K , M , G , T , P , E , Z
2918 .Po for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes,
2919 or zettabytes, respectively
2921 User properties can be set on snapshots.
2922 For more information, see the
2928 .Op Fl r Ns | Ns Fl d Ar depth
2930 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
2931 .Oo Fl s Ar source Ns Oo , Ns Ar source Oc Ns ... Oc
2932 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
2933 .Cm all | Ar property Ns Oo , Ns Ar property Oc Ns ...
2934 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Ns ...
2936 Displays properties for the given datasets.
2937 If no datasets are specified, then the command displays properties for all
2938 datasets on the system.
2939 For each property, the following columns are displayed:
2942 property Property name
2943 value Property value
2944 source Property source. Can either be local, default,
2945 temporary, inherited, or none (-).
2948 All columns are displayed by default, though this can be controlled by using the
2951 This command takes a comma-separated list of properties as described in the
2952 .Sx Native Properties
2959 can be used to display all properties that apply to the given dataset's type
2960 .Pq filesystem, volume, snapshot, or bookmark .
2961 .Bl -tag -width "-H"
2963 Display output in a form more easily parsed by scripts.
2964 Any headers are omitted, and fields are explicitly separated by a single tab
2965 instead of an arbitrary amount of space.
2967 Recursively display any children of the dataset, limiting the recursion to
2971 will display only the dataset and its direct children.
2973 A comma-separated list of columns to display.
2974 .Sy name Ns \&, Ns Sy property Ns \&, Ns Sy value Ns \&, Ns Sy source
2975 is the default value.
2977 Display numbers in parsable
2981 Recursively display properties for any children.
2983 A comma-separated list of sources to display.
2984 Those properties coming from a source other than those in this list are ignored.
2985 Each source must be one of the following:
2992 The default value is all sources.
2994 A comma-separated list of types to display, where
3008 .Ar property Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
3010 Clears the specified property, causing it to be inherited from an ancestor,
3011 restored to default if no ancestor has the property set, or with the
3013 option reverted to the received value if one exists.
3016 section for a listing of default values, and details on which properties can be
3018 .Bl -tag -width "-r"
3020 Recursively inherit the given property for all children.
3022 Revert the property to the received value if one exists; otherwise operate as
3025 option was not specified.
3030 .Ar filesystem Ns | Ns Ar volume
3032 Remap the indirect blocks in the given fileystem or volume so that they no
3033 longer reference blocks on previously removed vdevs and we can eventually
3034 shrink the size of the indirect mapping objects for the previously removed
3035 vdevs. Note that remapping all blocks might not be possible and that
3036 references from snapshots will still exist and cannot be remapped.
3041 Displays a list of file systems that are not the most recent version.
3047 Displays a list of currently supported file system versions.
3053 .Fl a | Ar filesystem
3055 Upgrades file systems to a new on-disk version.
3056 Once this is done, the file systems will no longer be accessible on systems
3057 running older versions of the software.
3059 streams generated from new snapshots of these file systems cannot be accessed on
3060 systems running older versions of the software.
3062 In general, the file system version is independent of the pool version.
3065 for information on the
3066 .Nm zpool Cm upgrade
3069 In some cases, the file system version and the pool version are interrelated and
3070 the pool version must be upgraded before the file system version can be
3072 .Bl -tag -width "-V"
3074 Upgrade to the specified
3078 flag is not specified, this command upgrades to the most recent version.
3080 option can only be used to increase the version number, and only up to the most
3081 recent version supported by this software.
3083 Upgrade all file systems on all imported pools.
3085 Upgrade the specified file system.
3087 Upgrade the specified file system and all descendent file systems.
3093 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
3094 .Oo Fl s Ar field Oc Ns ...
3095 .Oo Fl S Ar field Oc Ns ...
3096 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
3097 .Ar filesystem Ns | Ns Ar snapshot
3099 Displays space consumed by, and quotas on, each user in the specified filesystem
3101 This corresponds to the
3102 .Sy userused@ Ns Em user ,
3103 .Sy userobjused@ Ns Em user ,
3104 .Sy userquota@ Ns Em user,
3106 .Sy userobjquota@ Ns Em user
3108 .Bl -tag -width "-H"
3110 Do not print headers, use tab-delimited output.
3112 Sort by this field in reverse order.
3116 Translate SID to POSIX ID.
3117 The POSIX ID may be ephemeral if no mapping exists.
3118 Normal POSIX interfaces
3123 perform this translation, so the
3125 option allows the output from
3126 .Nm zfs Cm userspace
3127 to be compared directly with those utilities.
3130 may lead to confusion if some files were created by an SMB user before a
3131 SMB-to-POSIX name mapping was established.
3132 In such a case, some files will be owned by the SMB entity and some by the POSIX
3136 option will report that the POSIX entity has the total usage and quota for both.
3138 Print numeric ID instead of user/group name.
3139 .It Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
3140 Display only the specified fields from the following set:
3145 The default is to display all fields.
3151 Sort output by this field.
3156 flags may be specified multiple times to sort first by one field, then by
3159 .Fl s Sy type Fl s Sy name .
3160 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
3161 Print only the specified types from the following set:
3168 .Fl t Sy posixuser Ns \&, Ns Sy smbuser .
3169 The default can be changed to include group types.
3175 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
3176 .Oo Fl s Ar field Oc Ns ...
3177 .Oo Fl S Ar field Oc Ns ...
3178 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
3179 .Ar filesystem Ns | Ns Ar snapshot
3181 Displays space consumed by, and quotas on, each group in the specified
3182 filesystem or snapshot.
3183 This subcommand is identical to
3184 .Nm zfs Cm userspace ,
3185 except that the default types to display are
3186 .Fl t Sy posixgroup Ns \&, Ns Sy smbgroup .
3191 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
3192 .Oo Fl s Ar field Oc Ns ...
3193 .Oo Fl S Ar field Oc Ns ...
3194 .Ar filesystem Ns | Ns Ar snapshot
3196 Displays space consumed by, and quotas on, each project in the specified
3197 filesystem or snapshot. This subcommand is identical to
3198 .Nm zfs Cm userspace ,
3199 except that the project identifier is numeral, not name. So need neither
3202 for SID to POSIX ID nor
3210 .Oo Fl d Ns | Ns Fl r Ns Oc
3211 .Ar file Ns | Ns Ar directory Ns ...
3213 List project identifier (ID) and inherit flag of file(s) or directories.
3214 .Bl -tag -width "-d"
3216 Show the directory project ID and inherit flag, not its childrens. It will
3217 overwrite the former specified
3221 Show on subdirectories recursively. It will overwrite the former specified
3230 .Ar file Ns | Ns Ar directory Ns ...
3232 Clear project inherit flag and/or ID on the file(s) or directories.
3233 .Bl -tag -width "-k"
3235 Keep the project ID unchanged. If not specified, the project ID will be reset
3238 Clear on subdirectories recursively.
3245 .Oo Fl d Ns | Ns Fl r Ns Oc
3247 .Ar file Ns | Ns Ar directory Ns ...
3249 Check project ID and inherit flag on the file(s) or directories, report the
3250 entries without project inherit flag or with different project IDs from the
3253 option) value or the target directory's project ID.
3254 .Bl -tag -width "-0"
3256 Print file name with a trailing NUL instead of newline (by default), like
3259 Check the directory project ID and inherit flag, not its childrens. It will
3260 overwrite the former specified
3264 Specify the referenced ID for comparing with the target file(s) or directories'
3265 project IDs. If not specified, the target (top) directory's project ID will be
3266 used as the referenced one.
3268 Check on subdirectories recursively. It will overwrite the former specified
3277 .Ar file Ns | Ns Ar directory Ns ...
3279 .Bl -tag -width "-p"
3280 Set project ID and/or inherit flag on the file(s) or directories.
3282 Set the file(s)' or directories' project ID with the given value.
3284 Set on subdirectories recursively.
3286 Set project inherit flag on the given file(s) or directories. It is usually used
3287 for setup tree quota on the directory target with
3289 option specified together. When setup tree quota, by default the directory's
3290 project ID will be set to all its descendants unless you specify the project
3299 Displays all ZFS file systems currently mounted.
3305 .Fl a | Ar filesystem
3307 Mounts ZFS file systems.
3308 .Bl -tag -width "-O"
3310 Perform an overlay mount.
3313 for more information.
3315 Mount all available ZFS file systems.
3316 Invoked automatically as part of the boot process.
3318 Mount the specified filesystem.
3320 An optional, comma-separated list of mount options to use temporarily for the
3321 duration of the mount.
3323 .Sx Temporary Mount Point Properties
3324 section for details.
3326 Load keys for encrypted filesystems as they are being mounted. This is
3327 equivalent to executing
3329 on each encryption root before mounting it. Note that if a filesystem has a
3333 this will cause the terminal to interactively block after asking for the key.
3335 Report mount progress.
3341 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
3343 Unmounts currently mounted ZFS file systems.
3344 .Bl -tag -width "-a"
3346 Unmount all available ZFS file systems.
3347 Invoked automatically as part of the shutdown process.
3348 .It Ar filesystem Ns | Ns Ar mountpoint
3349 Unmount the specified filesystem.
3350 The command can also be given a path to a ZFS file system mount point on the
3353 Forcefully unmount the file system, even if it is currently in use.
3358 .Fl a | Ar filesystem
3360 Shares available ZFS file systems.
3361 .Bl -tag -width "-a"
3363 Share all available ZFS file systems.
3364 Invoked automatically as part of the boot process.
3366 Share the specified filesystem according to the
3371 File systems are shared when the
3380 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
3382 Unshares currently shared ZFS file systems.
3383 .Bl -tag -width "-a"
3385 Unshare all available ZFS file systems.
3386 Invoked automatically as part of the shutdown process.
3387 .It Ar filesystem Ns | Ns Ar mountpoint
3388 Unshare the specified filesystem.
3389 The command can also be given a path to a ZFS file system shared on the system.
3394 .Ar snapshot bookmark
3396 Creates a bookmark of the given snapshot.
3397 Bookmarks mark the point in time when the snapshot was created, and can be used
3398 as the incremental source for a
3402 This feature must be enabled to be used.
3404 .Xr zpool-features 5
3405 for details on ZFS feature flags and the
3412 .Op Oo Fl I Ns | Ns Fl i Oc Ar snapshot
3415 Creates a stream representation of the second
3417 which is written to standard output.
3418 The output can be redirected to a file or to a different system
3419 .Po for example, using
3422 By default, a full stream is generated.
3423 .Bl -tag -width "-D"
3425 Generate a deduplicated stream.
3426 Blocks which would have been sent multiple times in the send stream will only be
3428 The receiving system must also support this feature to receive a deduplicated
3430 This flag can be used regardless of the dataset's
3432 property, but performance will be much better if the filesystem uses a
3433 dedup-capable checksum
3437 .It Fl I Ar snapshot
3438 Generate a stream package that sends all intermediary snapshots from the first
3439 snapshot to the second snapshot.
3443 .Fl i Em @a Em fs@b Ns \&; Fl i Em @b Em fs@c Ns \&; Fl i Em @c Em fs@d .
3444 The incremental source may be specified as with the
3447 .It Fl L, -large-block
3448 Generate a stream which may contain blocks larger than 128KB.
3449 This flag has no effect if the
3451 pool feature is disabled, or if the
3453 property of this filesystem has never been set above 128KB.
3454 The receiving system must have the
3456 pool feature enabled as well.
3458 .Xr zpool-features 5
3459 for details on ZFS feature flags and the
3463 Print machine-parsable verbose information about the stream package generated.
3464 .It Fl R, -replicate
3465 Generate a replication stream package, which will replicate the specified
3466 file system, and all descendent file systems, up to the named snapshot.
3467 When received, all properties, snapshots, descendent file systems, and clones
3474 flags are used in conjunction with the
3476 flag, an incremental replication stream is generated.
3477 The current values of properties, and current snapshot and file system names are
3478 set when the stream is received.
3481 flag is specified when this stream is received, snapshots and file systems that
3482 do not exist on the sending side are destroyed.
3484 Generate a more compact stream by using
3486 records for blocks which are stored more compactly on disk by the
3489 This flag has no effect if the
3491 feature is disabled.
3492 The receiving system must have the
3497 feature is active on the sending system, then the receiving system must have
3498 that feature enabled as well. Datasets that are sent with this flag may not be
3499 received as an encrypted dataset, since encrypted datasets cannot use the
3503 .Xr zpool-features 5
3504 for details on ZFS feature flags and the
3508 Sends only received property values whether or not they are overridden by local
3509 settings, but only if the dataset has ever been received. Use this option when
3512 to restore received properties backed up on the sent dataset and to avoid
3513 sending local settings that may have nothing to do with the source dataset,
3514 but only with how the data is backed up.
3515 .It Fl c, -compressed
3516 Generate a more compact stream by using compressed WRITE records for blocks
3517 which are compressed on disk and in memory
3520 property for details
3524 feature is active on the sending system, then the receiving system must have
3525 that feature enabled as well.
3528 feature is enabled on the sending system but the
3530 option is not supplied in conjunction with
3532 then the data will be decompressed before sending so it can be split into
3533 smaller block sizes.
3535 For encrypted datasets, send data exactly as it exists on disk. This allows
3536 backups to be taken even if encryption keys are not currently loaded. The
3537 backup may then be received on an untrusted machine since that machine will
3538 not have the encryption keys to read the protected data or alter it without
3539 being detected. Upon being received, the dataset will have the same encryption
3540 keys as it did on the send side, although the
3542 property will be defaulted to
3544 if not otherwise provided. For unencrypted datasets, this flag will be
3547 Note that if you do not use this flag for sending encrypted datasets, data will
3548 be sent unencrypted and may be re-encrypted with a different encryption key on
3549 the receiving system, which will disable the ability to do a raw send to that
3550 system for incrementals.
3551 .It Fl i Ar snapshot
3552 Generate an incremental stream from the first
3554 .Pq the incremental source
3557 .Pq the incremental target .
3558 The incremental source can be specified as the last component of the snapshot
3562 character and following
3564 and it is assumed to be from the same file system as the incremental target.
3566 If the destination is a clone, the source may be the origin snapshot, which must
3569 .Em pool/fs@origin ,
3577 Do not generate any actual send data.
3578 This is useful in conjunction with the
3582 flags to determine what data will be sent.
3583 In this case, the verbose output will be written to standard output
3584 .Po contrast with a non-dry-run, where the stream is written to standard output
3585 and the verbose output goes to standard error
3588 Include the dataset's properties in the stream.
3589 This flag is implicit when
3592 The receiving system must also support this feature. Sends of encrypted datasets
3595 when using this flag.
3597 Print verbose information about the stream package generated.
3598 This information includes a per-second report of how much data has been sent.
3600 The format of the stream is committed.
3601 You will be able to receive your streams on future versions of ZFS.
3607 .Op Fl i Ar snapshot Ns | Ns Ar bookmark
3608 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
3610 Generate a send stream, which may be of a filesystem, and may be incremental
3612 If the destination is a filesystem or volume, the pool must be read-only, or the
3613 filesystem must not be mounted.
3614 When the stream generated from a filesystem or volume is received, the default
3615 snapshot name will be
3617 .Bl -tag -width "-L"
3618 .It Fl L, -large-block
3619 Generate a stream which may contain blocks larger than 128KB.
3620 This flag has no effect if the
3622 pool feature is disabled, or if the
3624 property of this filesystem has never been set above 128KB.
3625 The receiving system must have the
3627 pool feature enabled as well.
3629 .Xr zpool-features 5
3630 for details on ZFS feature flags and the
3634 Print machine-parsable verbose information about the stream package generated.
3635 .It Fl c, -compressed
3636 Generate a more compact stream by using compressed WRITE records for blocks
3637 which are compressed on disk and in memory
3640 property for details
3644 feature is active on the sending system, then the receiving system must have
3645 that feature enabled as well.
3648 feature is enabled on the sending system but the
3650 option is not supplied in conjunction with
3652 then the data will be decompressed before sending so it can be split into
3653 smaller block sizes.
3655 For encrypted datasets, send data exactly as it exists on disk. This allows
3656 backups to be taken even if encryption keys are not currently loaded. The
3657 backup may then be received on an untrusted machine since that machine will
3658 not have the encryption keys to read the protected data or alter it without
3659 being detected. Upon being received, the dataset will have the same encryption
3660 keys as it did on the send side, although the
3662 property will be defaulted to
3664 if not otherwise provided. For unencrypted datasets, this flag will be
3667 Note that if you do not use this flag for sending encrypted datasets, data will
3668 be sent unencrypted and may be re-encrypted with a different encryption key on
3669 the receiving system, which will disable the ability to do a raw send to that
3670 system for incrementals.
3672 Generate a more compact stream by using
3674 records for blocks which are stored more compactly on disk by the
3677 This flag has no effect if the
3679 feature is disabled.
3680 The receiving system must have the
3685 feature is active on the sending system, then the receiving system must have
3686 that feature enabled as well. Datasets that are sent with this flag may not be
3687 received as an encrypted dataset, since encrypted datasets cannot use the
3691 .Xr zpool-features 5
3692 for details on ZFS feature flags and the
3695 .It Fl i Ar snapshot Ns | Ns Ar bookmark
3696 Generate an incremental send stream.
3697 The incremental source must be an earlier snapshot in the destination's history.
3698 It will commonly be an earlier snapshot in the destination's file system, in
3699 which case it can be specified as the last component of the name
3704 character and following
3707 If the incremental target is a clone, the incremental source can be the origin
3708 snapshot, or an earlier snapshot in the origin's filesystem, or the origin's
3714 Do not generate any actual send data.
3715 This is useful in conjunction with the
3719 flags to determine what data will be sent.
3720 In this case, the verbose output will be written to standard output
3721 .Po contrast with a non-dry-run, where the stream is written to standard output
3722 and the verbose output goes to standard error
3725 Print verbose information about the stream package generated.
3726 This information includes a per-second report of how much data has been sent.
3733 .Ar receive_resume_token
3735 Creates a send stream which resumes an interrupted receive.
3737 .Ar receive_resume_token
3738 is the value of this property on the filesystem or volume that was being
3740 See the documentation for
3747 .Op Fl o Sy origin Ns = Ns Ar snapshot
3748 .Op Fl o Ar property Ns = Ns Ar value
3749 .Op Fl x Ar property
3750 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
3756 .Op Fl d Ns | Ns Fl e
3757 .Op Fl o Sy origin Ns = Ns Ar snapshot
3758 .Op Fl o Ar property Ns = Ns Ar value
3759 .Op Fl x Ar property
3762 Creates a snapshot whose contents are as specified in the stream provided on
3764 If a full stream is received, then a new file system is created as well.
3765 Streams are created using the
3767 subcommand, which by default creates a full stream.
3769 can be used as an alias for
3772 If an incremental stream is received, then the destination file system must
3773 already exist, and its most recent snapshot must match the incremental stream's
3777 the destination device link is destroyed and recreated, which means the
3779 cannot be accessed during the
3783 When a snapshot replication package stream that is generated by using the
3784 .Nm zfs Cm send Fl R
3785 command is received, any snapshots that do not exist on the sending location are
3786 destroyed by using the
3787 .Nm zfs Cm destroy Fl d
3791 .Fl o Em property Ns = Ns Ar value
3794 is specified, it applies to the effective value of the property throughout
3795 the entire subtree of replicated datasets. Effective property values will be
3800 ) on the topmost in the replicated subtree. In descendant datasets, if the
3801 property is set by the send stream, it will be overridden by forcing the
3802 property to be inherited from the top‐most file system. Received properties
3803 are retained in spite of being overridden and may be restored with
3804 .Nm zfs Cm inherit Fl S .
3806 .Fl o Sy origin Ns = Ns Em snapshot
3807 is a special case because, even if
3809 is a read-only property and cannot be set, it's allowed to receive the send
3810 stream as a clone of the given snapshot.
3812 Raw encrypted send streams (created with
3813 .Nm zfs Cm send Fl w
3814 ) may only be received as is, and cannot be re-encrypted, decrypted, or
3815 recompressed by the receive process. Unencrypted streams can be received as
3816 encrypted datasets, either through inheritance or by specifying encryption
3821 The name of the snapshot
3822 .Pq and file system, if a full stream is received
3823 that this subcommand creates depends on the argument type and the use of the
3829 If the argument is a snapshot name, the specified
3832 If the argument is a file system or volume name, a snapshot with the same name
3833 as the sent snapshot is created within the specified
3841 options are specified, the provided target snapshot name is used exactly as
3848 options cause the file system name of the target snapshot to be determined by
3849 appending a portion of the sent snapshot's name to the specified target
3853 option is specified, all but the first element of the sent snapshot's file
3855 .Pq usually the pool name
3856 is used and any required intermediate file systems within the specified one are
3860 option is specified, then only the last element of the sent snapshot's file
3862 .Pq i.e. the name of the source file system itself
3863 is used as the target file system name.
3864 .Bl -tag -width "-F"
3866 Force a rollback of the file system to the most recent snapshot before
3867 performing the receive operation.
3868 If receiving an incremental replication stream
3869 .Po for example, one generated by
3870 .Nm zfs Cm send Fl R Op Fl i Ns | Ns Fl I
3872 destroy snapshots and file systems that do not exist on the sending side.
3874 Discard the first element of the sent snapshot's file system name, using the
3875 remaining elements to determine the name of the target file system for the new
3876 snapshot as described in the paragraph above.
3878 Discard all but the last element of the sent snapshot's file system name, using
3879 that element to determine the name of the target file system for the new
3880 snapshot as described in the paragraph above.
3882 Do not actually receive the stream.
3883 This can be useful in conjunction with the
3885 option to verify the name the receive operation would use.
3886 .It Fl o Sy origin Ns = Ns Ar snapshot
3887 Forces the stream to be received as a clone of the given snapshot.
3888 If the stream is a full send stream, this will create the filesystem
3889 described by the stream as a clone of the specified snapshot.
3890 Which snapshot was specified will not affect the success or failure of the
3891 receive, as long as the snapshot does exist.
3892 If the stream is an incremental send stream, all the normal verification will be
3894 .It Fl o Em property Ns = Ns Ar value
3895 Sets the specified property as if the command
3896 .Nm zfs Cm set Em property Ns = Ns Ar value
3897 was invoked immediately before the receive. When receiving a stream from
3898 .Nm zfs Cm send Fl R ,
3899 causes the property to be inherited by all descendant datasets, as through
3900 .Nm zfs Cm inherit Em property
3901 was run on any descendant datasets that have this property set on the
3904 Any editable property can be set at receive time. Set-once properties bound
3905 to the received data, such as
3908 .Sy casesensitivity ,
3909 cannot be set at receive time even when the datasets are newly created by
3910 .Nm zfs Cm receive .
3911 Additionally both settable properties
3915 cannot be set at receive time.
3919 option may be specified multiple times, for different properties. An error
3920 results if the same property is specified in multiple
3928 option may also be used to override encryption properties upon initial
3929 receive. This allows unencrypted streams to be received as encrypted datasets.
3930 To cause the received dataset (or root dataset of a recursive stream) to be
3931 received as an encryption root, specify encryption properties in the same
3932 manner as is required for
3937 # zfs send tank/test@snap1 | zfs recv -o encryption=on -o keyformat=passphrase -o keylocation=file:///path/to/keyfile
3941 .Op Fl o Ar keylocation Ns = Ns Ar prompt
3942 may not be specified here, since stdin is already being utilized for the send
3943 stream. Once the receive has completed, you can use
3946 to change this setting after the fact. Similarly, you can receive a dataset as
3947 an encrypted child by specifying
3948 .Op Fl x Ar encryption
3949 to force the property to be inherited. Overriding encryption properties (except
3951 .Sy keylocation Ns )
3952 is not possible with raw send streams.
3954 If the receive is interrupted, save the partially received state, rather
3956 Interruption may be due to premature termination of the stream
3957 .Po e.g. due to network failure or failure of the remote system
3958 if the stream is being read over a network connection
3960 a checksum error in the stream, termination of the
3962 process, or unclean shutdown of the system.
3964 The receive can be resumed with a stream generated by
3965 .Nm zfs Cm send Fl t Ar token ,
3969 .Sy receive_resume_token
3970 property of the filesystem or volume which is received into.
3972 To use this flag, the storage pool must have the
3973 .Sy extensible_dataset
3976 .Xr zpool-features 5
3977 for details on ZFS feature flags.
3979 File system that is associated with the received stream is not mounted.
3981 Print verbose information about the stream and the time required to perform the
3983 .It Fl x Em property
3984 Ensures that the effective value of the specified property after the
3985 receive is unaffected by the value of that property in the send stream (if any),
3986 as if the property had been excluded from the send stream.
3988 If the specified property is not present in the send stream, this option does
3991 If a received property needs to be overridden, the effective value will be
3992 set or inherited, depending on whether the property is inheritable or not.
3994 In the case of an incremental update,
3996 leaves any existing local setting or explicit inheritance unchanged.
4000 restrictions on set-once and special properties apply equally to
4007 .Ar filesystem Ns | Ns Ar volume
4009 Abort an interrupted
4010 .Nm zfs Cm receive Fl s ,
4011 deleting its saved partially received state.
4015 .Ar filesystem Ns | Ns Ar volume
4017 Displays permissions that have been delegated on the specified filesystem or
4019 See the other forms of
4021 for more information.
4023 Delegations are supported under Linux with the exception of
4031 These permissions cannot be delegated because the Linux
4033 command restricts modifications of the global namespace to the root user.
4038 .Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
4039 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4040 .Ar setname Oc Ns ...
4041 .Ar filesystem Ns | Ns Ar volume
4046 .Fl e Ns | Ns Sy everyone
4047 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4048 .Ar setname Oc Ns ...
4049 .Ar filesystem Ns | Ns Ar volume
4051 Delegates ZFS administration permission for the file systems to non-privileged
4053 .Bl -tag -width "-d"
4055 Allow only for the descendent file systems.
4056 .It Fl e Ns | Ns Sy everyone
4057 Specifies that the permissions be delegated to everyone.
4058 .It Fl g Ar group Ns Oo , Ns Ar group Oc Ns ...
4059 Explicitly specify that permissions are delegated to the group.
4063 only for the specified file system.
4064 .It Fl u Ar user Ns Oo , Ns Ar user Oc Ns ...
4065 Explicitly specify that permissions are delegated to the user.
4066 .It Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
4067 Specifies to whom the permissions are delegated.
4068 Multiple entities can be specified as a comma-separated list.
4071 options are specified, then the argument is interpreted preferentially as the
4074 then as a user name, and lastly as a group name.
4075 To specify a user or group named
4082 To specify a group with the same name as a user, use the
4086 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4087 .Ar setname Oc Ns ...
4089 The permissions to delegate.
4090 Multiple permissions may be specified as a comma-separated list.
4091 Permission names are the same as ZFS subcommand and property names.
4092 See the property list below.
4093 Property set names, which begin with
4098 form below for details.
4103 options are specified, or both are, then the permissions are allowed for the
4104 file system or volume, and all of its descendents.
4106 Permissions are generally the ability to use a ZFS subcommand or change a ZFS
4108 The following permissions are available:
4111 allow subcommand Must also have the permission that is
4113 clone subcommand Must also have the 'create' ability and
4114 'mount' ability in the origin file system
4115 create subcommand Must also have the 'mount' ability
4116 destroy subcommand Must also have the 'mount' ability
4117 diff subcommand Allows lookup of paths within a dataset
4118 given an object number, and the ability
4119 to create snapshots necessary to
4121 load-key subcommand Allows loading and unloading of encryption key
4122 (see 'zfs load-key' and 'zfs unload-key').
4123 change-key subcommand Allows changing an encryption key via
4125 mount subcommand Allows mount/umount of ZFS datasets
4126 promote subcommand Must also have the 'mount' and 'promote'
4127 ability in the origin file system
4128 receive subcommand Must also have the 'mount' and 'create'
4130 rename subcommand Must also have the 'mount' and 'create'
4131 ability in the new parent
4132 rollback subcommand Must also have the 'mount' ability
4134 share subcommand Allows sharing file systems over NFS
4136 snapshot subcommand Must also have the 'mount' ability
4138 groupquota other Allows accessing any groupquota@...
4140 groupused other Allows reading any groupused@... property
4141 userprop other Allows changing any user property
4142 userquota other Allows accessing any userquota@...
4144 userused other Allows reading any userused@... property
4145 projectobjquota other Allows accessing any projectobjquota@...
4147 projectquota other Allows accessing any projectquota@... property
4148 projectobjused other Allows reading any projectobjused@... property
4149 projectused other Allows reading any projectused@... property
4155 casesensitivity property
4157 compression property
4161 filesystem_limit property
4164 normalization property
4165 primarycache property
4170 refreservation property
4171 reservation property
4172 secondarycache property
4177 snapshot_limit property
4180 volblocksize property
4190 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4191 .Ar setname Oc Ns ...
4192 .Ar filesystem Ns | Ns Ar volume
4197 These permissions are granted
4199 to the creator of any newly-created descendent file system.
4203 .Fl s No @ Ns Ar setname
4204 .Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4205 .Ar setname Oc Ns ...
4206 .Ar filesystem Ns | Ns Ar volume
4208 Defines or adds permissions to a permission set.
4209 The set can be used by other
4211 commands for the specified file system and its descendents.
4212 Sets are evaluated dynamically, so changes to a set are immediately reflected.
4213 Permission sets follow the same naming restrictions as ZFS file systems, but the
4214 name must begin with
4216 and can be no more than 64 characters long.
4221 .Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
4222 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4223 .Ar setname Oc Ns ... Oc
4224 .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
4238 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4239 .Ar setname Oc Ns ... Oc
4240 .Ar filesystem Ns | Ns Ar volume
4242 Removes permissions that were granted with the
4245 No permissions are explicitly denied, so other permissions granted are still in
4247 For example, if the permission is granted by an ancestor.
4248 If no permissions are specified, then all permissions for the specified
4260 only removes the permissions that were granted to everyone, not all permissions
4261 for every user and group.
4264 command for a description of the
4267 .Bl -tag -width "-r"
4269 Recursively remove the permissions from this file system and all descendents.
4275 .Fl s No @ Ns Ar setname
4276 .Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4277 .Ar setname Oc Ns ... Oc
4278 .Ar filesystem Ns | Ns Ar volume
4280 Removes permissions from a permission set.
4281 If no permissions are specified, then all permissions are removed, thus removing
4287 .Ar tag Ar snapshot Ns ...
4289 Adds a single reference, named with the
4291 argument, to the specified snapshot or snapshots.
4292 Each snapshot has its own tag namespace, and tags must be unique within that
4295 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
4299 .Bl -tag -width "-r"
4301 Specifies that a hold with the given tag is applied recursively to the snapshots
4302 of all descendent file systems.
4310 Lists all existing user references for the given snapshot or snapshots.
4311 .Bl -tag -width "-r"
4313 Lists the holds that are set on the named descendent snapshots, in addition to
4314 listing the holds on the named snapshot.
4316 Do not print headers, use tab-delimited output.
4322 .Ar tag Ar snapshot Ns ...
4324 Removes a single reference, named with the
4326 argument, from the specified snapshot or snapshots.
4327 The tag must already exist for each snapshot.
4328 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
4332 .Bl -tag -width "-r"
4334 Recursively releases a hold with the given tag on the snapshots of all
4335 descendent file systems.
4341 .Ar snapshot Ar snapshot Ns | Ns Ar filesystem
4343 Display the difference between a snapshot of a given filesystem and another
4344 snapshot of that filesystem from a later time or the current contents of the
4346 The first column is a character indicating the type of change, the other columns
4347 indicate pathname, new pathname
4348 .Pq in case of rename ,
4349 change in link count, and optionally file type and/or change time.
4350 The types of change are:
4352 - The path has been removed
4353 + The path has been created
4354 M The path has been modified
4355 R The path has been renamed
4357 .Bl -tag -width "-F"
4359 Display an indication of the type of file, in a manner similar to the
4375 Give more parsable tab-separated output, without header lines and without
4378 Display the path's inode change time as the first column of output.
4385 .Op Fl m Ar memory_limit
4391 as a ZFS channel program on
4394 program interface allows ZFS administrative operations to be run
4395 programmatically via a Lua script.
4396 The entire script is executed atomically, with no other administrative
4397 operations taking effect concurrently.
4398 A library of ZFS calls is made available to channel program scripts.
4399 Channel programs may only be run with root privileges.
4401 For full documentation of the ZFS channel program interface, see the manual
4406 Display channel program output in JSON format. When this flag is specified and
4407 standard output is empty - channel program encountered an error. The details of
4408 such an error will be printed to standard error in plain text.
4410 Executes a read-only channel program, which runs faster.
4411 The program cannot change on-disk state by calling functions from
4412 the zfs.sync submodule.
4413 The program can be used to gather information such as properties and
4414 determining if changes would succeed (zfs.check.*).
4415 Without this flag, all pending changes must be synced to disk before
4416 a channel program can complete.
4418 Execution time limit, in milliseconds.
4419 If a channel program executes for longer than the provided timeout, it will
4420 be stopped and an error will be returned.
4421 The default timeout is 1000 ms, and can be set to a maximum of 10000 ms.
4422 .It Fl m Ar memory-limit
4423 Memory limit, in bytes.
4424 If a channel program attempts to allocate more memory than the given limit,
4425 it will be stopped and an error returned.
4426 The default memory limit is 10 MB, and can be set to a maximum of 100 MB.
4428 All remaining argument strings are passed directly to the channel program as
4432 for more information.
4438 .Op Fl L Ar keylocation
4439 .Fl a | Ar filesystem
4443 allowing it and all children that inherit the
4445 property to be accessed. The key will be expected in the format specified by the
4447 and location specified by the
4449 property. Note that if the
4453 the terminal will interactively wait for the key to be entered. Loading a key
4454 will not automatically mount the dataset. If that functionality is desired,
4455 .Nm zfs Cm mount Sy -l
4456 will ask for the key and mount the dataset. Once the key is loaded the
4458 property will become
4460 .Bl -tag -width "-r"
4462 Recursively loads the keys for the specified filesystem and all descendent
4465 Loads the keys for all encryption roots in all imported pools.
4469 load-key. This will cause zfs to simply check that the
4470 provided key is correct. This command may be run even if the key is already
4472 .It Fl L Ar keylocation
4477 property. This will not change the value of the property on the dataset. Note
4478 that if used with either
4483 may only be given as
4490 .Fl a | Ar filesystem
4492 Unloads a key from ZFS, removing the ability to access the dataset and all of
4493 its children that inherit the
4495 property. This requires that the dataset is not currently open or mounted. Once
4496 the key is unloaded the
4498 property will become
4500 .Bl -tag -width "-r"
4502 Recursively unloads the keys for the specified filesystem and all descendent
4505 Unloads the keys for all encryption roots in all imported pools.
4511 .Op Fl o Ar keylocation Ns = Ns Ar value
4512 .Op Fl o Ar keyformat Ns = Ns Ar value
4513 .Op Fl o Ar pbkdf2iters Ns = Ns Ar value
4523 Allows a user to change the encryption key used to access a dataset. This
4524 command requires that the existing key for the dataset is already loaded into
4525 ZFS. This command may also be used to change the
4530 properties as needed. If the dataset was not previously an encryption root it
4531 will become one. Alternatively, the
4533 flag may be provided to cause an encryption root to inherit the parent's key
4535 .Bl -tag -width "-r"
4537 Ensures the key is loaded before attempting to change the key. This is
4538 effectively equivalent to
4539 .Qq Nm zfs Cm load-key Ar filesystem ; Nm zfs Cm change-key Ar filesystem
4540 .It Fl o Ar property Ns = Ns Ar value
4541 Allows the user to set encryption key properties (
4546 ) while changing the key. This is the only way to alter
4550 after the dataset has been created.
4552 Indicates that zfs should make
4554 inherit the key of its parent. Note that this command can only be run on an
4555 encryption root that has an encrypted parent.
4561 utility exits 0 on success, 1 if an error occurs, and 2 if invalid command line
4562 options were specified.
4565 .It Sy Example 1 No Creating a ZFS File System Hierarchy
4566 The following commands create a file system named
4568 and a file system named
4572 is set for the parent file system, and is automatically inherited by the child
4575 # zfs create pool/home
4576 # zfs set mountpoint=/export/home pool/home
4577 # zfs create pool/home/bob
4579 .It Sy Example 2 No Creating a ZFS Snapshot
4580 The following command creates a snapshot named
4582 This snapshot is mounted on demand in the
4584 directory at the root of the
4588 # zfs snapshot pool/home/bob@yesterday
4590 .It Sy Example 3 No Creating and Destroying Multiple Snapshots
4591 The following command creates snapshots named
4595 and all of its descendent file systems.
4596 Each snapshot is mounted on demand in the
4598 directory at the root of its file system.
4599 The second command destroys the newly created snapshots.
4601 # zfs snapshot -r pool/home@yesterday
4602 # zfs destroy -r pool/home@yesterday
4604 .It Sy Example 4 No Disabling and Enabling File System Compression
4605 The following command disables the
4607 property for all file systems under
4609 The next command explicitly enables
4612 .Em pool/home/anne .
4614 # zfs set compression=off pool/home
4615 # zfs set compression=on pool/home/anne
4617 .It Sy Example 5 No Listing ZFS Datasets
4618 The following command lists all active file systems and volumes in the system.
4619 Snapshots are displayed if the
4627 for more information on pool properties.
4630 NAME USED AVAIL REFER MOUNTPOINT
4631 pool 450K 457G 18K /pool
4632 pool/home 315K 457G 21K /export/home
4633 pool/home/anne 18K 457G 18K /export/home/anne
4634 pool/home/bob 276K 457G 276K /export/home/bob
4636 .It Sy Example 6 No Setting a Quota on a ZFS File System
4637 The following command sets a quota of 50 Gbytes for
4640 # zfs set quota=50G pool/home/bob
4642 .It Sy Example 7 No Listing ZFS Properties
4643 The following command lists all properties for
4646 # zfs get all pool/home/bob
4647 NAME PROPERTY VALUE SOURCE
4648 pool/home/bob type filesystem -
4649 pool/home/bob creation Tue Jul 21 15:53 2009 -
4650 pool/home/bob used 21K -
4651 pool/home/bob available 20.0G -
4652 pool/home/bob referenced 21K -
4653 pool/home/bob compressratio 1.00x -
4654 pool/home/bob mounted yes -
4655 pool/home/bob quota 20G local
4656 pool/home/bob reservation none default
4657 pool/home/bob recordsize 128K default
4658 pool/home/bob mountpoint /pool/home/bob default
4659 pool/home/bob sharenfs off default
4660 pool/home/bob checksum on default
4661 pool/home/bob compression on local
4662 pool/home/bob atime on default
4663 pool/home/bob devices on default
4664 pool/home/bob exec on default
4665 pool/home/bob setuid on default
4666 pool/home/bob readonly off default
4667 pool/home/bob zoned off default
4668 pool/home/bob snapdir hidden default
4669 pool/home/bob acltype off default
4670 pool/home/bob aclinherit restricted default
4671 pool/home/bob canmount on default
4672 pool/home/bob xattr on default
4673 pool/home/bob copies 1 default
4674 pool/home/bob version 4 -
4675 pool/home/bob utf8only off -
4676 pool/home/bob normalization none -
4677 pool/home/bob casesensitivity sensitive -
4678 pool/home/bob vscan off default
4679 pool/home/bob nbmand off default
4680 pool/home/bob sharesmb off default
4681 pool/home/bob refquota none default
4682 pool/home/bob refreservation none default
4683 pool/home/bob primarycache all default
4684 pool/home/bob secondarycache all default
4685 pool/home/bob usedbysnapshots 0 -
4686 pool/home/bob usedbydataset 21K -
4687 pool/home/bob usedbychildren 0 -
4688 pool/home/bob usedbyrefreservation 0 -
4691 The following command gets a single property value.
4693 # zfs get -H -o value compression pool/home/bob
4696 The following command lists all properties with local settings for
4699 # zfs get -r -s local -o name,property,value all pool/home/bob
4701 pool/home/bob quota 20G
4702 pool/home/bob compression on
4704 .It Sy Example 8 No Rolling Back a ZFS File System
4705 The following command reverts the contents of
4707 to the snapshot named
4709 deleting all intermediate snapshots.
4711 # zfs rollback -r pool/home/anne@yesterday
4713 .It Sy Example 9 No Creating a ZFS Clone
4714 The following command creates a writable file system whose initial contents are
4716 .Em pool/home/bob@yesterday .
4718 # zfs clone pool/home/bob@yesterday pool/clone
4720 .It Sy Example 10 No Promoting a ZFS Clone
4721 The following commands illustrate how to test out changes to a file system, and
4722 then replace the original file system with the changed one, using clones, clone
4723 promotion, and renaming:
4725 # zfs create pool/project/production
4726 populate /pool/project/production with data
4727 # zfs snapshot pool/project/production@today
4728 # zfs clone pool/project/production@today pool/project/beta
4729 make changes to /pool/project/beta and test them
4730 # zfs promote pool/project/beta
4731 # zfs rename pool/project/production pool/project/legacy
4732 # zfs rename pool/project/beta pool/project/production
4733 once the legacy version is no longer needed, it can be destroyed
4734 # zfs destroy pool/project/legacy
4736 .It Sy Example 11 No Inheriting ZFS Properties
4737 The following command causes
4743 property from their parent.
4745 # zfs inherit checksum pool/home/bob pool/home/anne
4747 .It Sy Example 12 No Remotely Replicating ZFS Data
4748 The following commands send a full stream and then an incremental stream to a
4749 remote machine, restoring them into
4750 .Em poolB/received/fs@a
4752 .Em poolB/received/fs@b ,
4755 must contain the file system
4756 .Em poolB/received ,
4757 and must not initially contain
4758 .Em poolB/received/fs .
4760 # zfs send pool/fs@a | \e
4761 ssh host zfs receive poolB/received/fs@a
4762 # zfs send -i a pool/fs@b | \e
4763 ssh host zfs receive poolB/received/fs
4765 .It Sy Example 13 No Using the zfs receive -d Option
4766 The following command sends a full stream of
4767 .Em poolA/fsA/fsB@snap
4768 to a remote machine, receiving it into
4769 .Em poolB/received/fsA/fsB@snap .
4772 portion of the received snapshot's name is determined from the name of the sent
4775 must contain the file system
4776 .Em poolB/received .
4778 .Em poolB/received/fsA
4779 does not exist, it is created as an empty file system.
4781 # zfs send poolA/fsA/fsB@snap | \e
4782 ssh host zfs receive -d poolB/received
4784 .It Sy Example 14 No Setting User Properties
4785 The following example sets the user-defined
4786 .Sy com.example:department
4787 property for a dataset.
4789 # zfs set com.example:department=12345 tank/accounting
4791 .It Sy Example 15 No Performing a Rolling Snapshot
4792 The following example shows how to maintain a history of snapshots with a
4793 consistent naming scheme.
4794 To keep a week's worth of snapshots, the user destroys the oldest snapshot,
4795 renames the remaining snapshots, and then creates a new snapshot, as follows:
4797 # zfs destroy -r pool/users@7daysago
4798 # zfs rename -r pool/users@6daysago @7daysago
4799 # zfs rename -r pool/users@5daysago @6daysago
4800 # zfs rename -r pool/users@yesterday @5daysago
4801 # zfs rename -r pool/users@yesterday @4daysago
4802 # zfs rename -r pool/users@yesterday @3daysago
4803 # zfs rename -r pool/users@yesterday @2daysago
4804 # zfs rename -r pool/users@today @yesterday
4805 # zfs snapshot -r pool/users@today
4807 .It Sy Example 16 No Setting sharenfs Property Options on a ZFS File System
4808 The following commands show how to set
4810 property options to enable
4814 addresses and to enable root access for system
4820 # zfs set sharenfs='rw=@123.123.0.0/16,root=neo' tank/home
4825 for host name resolution, specify the fully qualified hostname.
4826 .It Sy Example 17 No Delegating ZFS Administration Permissions on a ZFS Dataset
4827 The following example shows how to set permissions so that user
4829 can create, destroy, mount, and take snapshots on
4835 # zfs allow cindys create,destroy,mount,snapshot tank/cindys
4836 # zfs allow tank/cindys
4837 ---- Permissions on tank/cindys --------------------------------------
4838 Local+Descendent permissions:
4839 user cindys create,destroy,mount,snapshot
4844 mount point permission is set to 755 by default, user
4846 will be unable to mount file systems under
4848 Add an ACE similar to the following syntax to provide mount point access:
4850 # chmod A+user:cindys:add_subdirectory:allow /tank/cindys
4852 .It Sy Example 18 No Delegating Create Time Permissions on a ZFS Dataset
4853 The following example shows how to grant anyone in the group
4855 to create file systems in
4857 This syntax also allows staff members to destroy their own file systems, but not
4858 destroy anyone else's file system.
4863 # zfs allow staff create,mount tank/users
4864 # zfs allow -c destroy tank/users
4865 # zfs allow tank/users
4866 ---- Permissions on tank/users ---------------------------------------
4869 Local+Descendent permissions:
4870 group staff create,mount
4872 .It Sy Example 19 No Defining and Granting a Permission Set on a ZFS Dataset
4873 The following example shows how to define and grant a permission set on the
4880 # zfs allow -s @pset create,destroy,snapshot,mount tank/users
4881 # zfs allow staff @pset tank/users
4882 # zfs allow tank/users
4883 ---- Permissions on tank/users ---------------------------------------
4885 @pset create,destroy,mount,snapshot
4886 Local+Descendent permissions:
4889 .It Sy Example 20 No Delegating Property Permissions on a ZFS Dataset
4890 The following example shows to grant the ability to set quotas and reservations
4898 # zfs allow cindys quota,reservation users/home
4899 # zfs allow users/home
4900 ---- Permissions on users/home ---------------------------------------
4901 Local+Descendent permissions:
4902 user cindys quota,reservation
4903 cindys% zfs set quota=10G users/home/marks
4904 cindys% zfs get quota users/home/marks
4905 NAME PROPERTY VALUE SOURCE
4906 users/home/marks quota 10G local
4908 .It Sy Example 21 No Removing ZFS Delegated Permissions on a ZFS Dataset
4909 The following example shows how to remove the snapshot permission from the
4918 # zfs unallow staff snapshot tank/users
4919 # zfs allow tank/users
4920 ---- Permissions on tank/users ---------------------------------------
4922 @pset create,destroy,mount,snapshot
4923 Local+Descendent permissions:
4926 .It Sy Example 22 No Showing the differences between a snapshot and a ZFS Dataset
4927 The following example shows how to see what has changed between a prior
4928 snapshot of a ZFS dataset and its current state.
4931 option is used to indicate type information for the files affected.
4933 # zfs diff -F tank/test@before tank/test
4935 M F /tank/test/linked (+1)
4936 R F /tank/test/oldname -> /tank/test/newname
4937 - F /tank/test/deleted
4938 + F /tank/test/created
4939 M F /tank/test/modified
4941 .It Sy Example 23 No Creating a bookmark
4942 The following example create a bookmark to a snapshot. This bookmark
4943 can then be used instead of snapshot in send streams.
4945 # zfs bookmark rpool@snapshot rpool#bookmark
4947 .It Sy Example 24 No Setting sharesmb Property Options on a ZFS File System
4948 The following example show how to share SMB filesystem through ZFS. Note that
4949 that a user and his/her password must be given.
4951 # smbmount //127.0.0.1/share_tmp /mnt/tmp \\
4952 -o user=workgroup/turbo,password=obrut,uid=1000
4956 .Em /etc/samba/smb.conf
4957 configuration required:
4959 Samba will need to listen to 'localhost' (127.0.0.1) for the ZFS utilities to
4960 communicate with Samba. This is the default behavior for most Linux
4963 Samba must be able to authenticate a user. This can be done in a number of
4964 ways, depending on if using the system password file, LDAP or the Samba
4965 specific smbpasswd file. How to do this is outside the scope of this manual.
4968 man page for more information.
4971 .Sy USERSHARE section
4974 man page for all configuration options in case you need to modify any options
4975 to the share afterwards. Do note that any changes done with the
4977 command will be undone if the share is ever unshared (such as at a reboot etc).
4979 .Sh INTERFACE STABILITY
projects / mirror_zfs.git / blob