2 .\" Copyright (c) 2013, Martin Matuska <mm@FreeBSD.org>.
3 .\" All Rights Reserved.
5 .\" The contents of this file are subject to the terms of the
6 .\" Common Development and Distribution License (the "License").
7 .\" You may not use this file except in compliance with the License.
9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10 .\" or http://www.opensolaris.org/os/licensing.
11 .\" See the License for the specific language governing permissions
12 .\" and limitations under the License.
14 .\" When distributing Covered Code, include this CDDL HEADER in each
15 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16 .\" If applicable, add the following below this CDDL HEADER, with the
17 .\" fields enclosed by brackets "[]" replaced with your own identifying
18 .\" information: Portions Copyright [yyyy] [name of copyright owner]
20 .\" Copyright (c) 2010, Sun Microsystems, Inc. All Rights Reserved.
21 .\" Copyright (c) 2012 by Delphix. All rights reserved.
22 .\" Copyright (c) 2011, Pawel Jakub Dawidek <pjd@FreeBSD.org>
23 .\" Copyright (c) 2012, Glen Barber <gjb@FreeBSD.org>
24 .\" Copyright (c) 2012, Bryan Drewery <bdrewery@FreeBSD.org>
25 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
26 .\" Copyright (c) 2013 Nexenta Systems, Inc. All Rights Reserved.
27 .\" Copyright (c) 2013, Joyent, Inc. All rights reserved.
31 .Dd September 20, 2013
36 .Nd configures ZFS file systems
43 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... Ar filesystem
48 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
54 .Ar filesystem Ns | Ns Ar volume
66 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
67 .Ar filesystem@snapname Ns | Ns Ar volume@snapname
68 .Ar filesystem@snapname Ns | Ns Ar volume@snapname Ns ...
76 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
77 .Ar snapshot filesystem Ns | Ns Ar volume
84 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
85 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
90 .Ar filesystem Ns | Ns Ar volume
91 .Ar filesystem Ns | Ns Ar volume
100 .Ar filesystem filesystem
103 .Op Fl r Ns | Ns Fl d Ar depth
105 .Op Fl o Ar property Ns Oo , Ns property Ns Oc Ns ...
106 .Op Fl t Ar type Ns Oo , Ns type Ns Oc Ns ...
107 .Oo Fl s Ar property Oc Ns ...
108 .Oo Fl S Ar property Oc Ns ...
109 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
112 .Ar property Ns = Ns Ar value
113 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
116 .Op Fl r Ns | Ns Fl d Ar depth
118 .Op Fl o Ar all | field Ns Oo , Ns Ar field Oc Ns ...
119 .Op Fl t Ar type Ns Oo Ns , Ar type Oc Ns ...
120 .Op Fl s Ar source Ns Oo Ns , Ns Ar source Oc Ns ...
121 .Ar all | property Ns Oo Ns , Ns Ar property Oc Ns ...
122 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
127 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
135 .Fl a | Ar filesystem
139 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
140 .Oo Fl s Ar field Oc Ns ...
141 .Oo Fl S Ar field Oc Ns ...
142 .Op Fl t Ar type Ns Oo Ns , Ns Ar type Oc Ns ...
143 .Ar filesystem Ns | Ns Ar snapshot
147 .Op Fl o Ar field Ns Oo , Ns field Oc Ns ...
148 .Oo Fl s Ar field Oc Ns ...
149 .Oo Fl S Ar field Oc Ns ...
150 .Op Fl t Ar type Ns Oo Ns , Ns Ar type Oc Ns ...
151 .Ar filesystem Ns | Ns Ar snapshot
157 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
158 .Fl a | Ar filesystem
162 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
165 .Fl a | Ar filesystem
168 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
172 .Op Fl i Ar snapshot | Fl I Ar snapshot
177 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
185 .Ar filesystem Ns | Ns Ar volume
189 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
190 .Ar perm Ns | Ns Ar @setname Ns
191 .Oo Ns , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
192 .Ar filesystem Ns | Ns Ar volume
196 .Fl e Ns | Ns Cm everyone
197 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
199 .Ar filesystem Ns | Ns Ar volume
203 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
205 .Ar filesystem Ns | Ns Ar volume
210 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
212 .Ar filesystem Ns | Ns Ar volume
216 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
217 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
219 .Ar filesystem Ns | Ns Ar volume
223 .Fl e Ns | Ns Cm everyone
224 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
226 .Ar filesystem Ns | Ns Ar volume
231 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
233 .Ar filesystem Ns | Ns Ar volume
239 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
241 .Ar filesystem Ns | Ns Ar volume
245 .Ar tag snapshot Ns ...
253 .Ar tag snapshot Ns ...
258 .Op Ar snapshot Ns | Ns Ar filesystem
261 .Ar jailid Ns | Ns Ar jailname filesystem
264 .Ar jailid Ns | Ns Ar jailname filesystem
272 storage pool, as described in
274 A dataset is identified by a unique path within the
276 namespace. For example:
277 .Bd -ragged -offset 4n
278 .No pool/ Ns Brq filesystem,volume,snapshot
281 where the maximum length of a dataset name is
285 A dataset can be one of the following:
292 can be mounted within the standard system namespace and behaves like other file
295 file systems are designed to be
297 compliant, known issues exist that prevent compliance in some cases.
298 Applications that depend on standards conformance might fail due to nonstandard
299 behavior when checking file system free space.
301 A logical volume exported as a raw or block device. This type of dataset should
302 only be used under special circumstances. File systems are typically used in
305 A read-only version of a file system or volume at a given point in time. It is
311 .Ss ZFS File System Hierarchy
314 storage pool is a logical collection of devices that provide space for
315 datasets. A storage pool is also the root of the
317 file system hierarchy.
319 The root of the pool can be accessed as a file system, such as mounting and
320 unmounting, taking snapshots, and setting properties. The physical storage
321 characteristics, however, are managed by the
327 for more information on creating and administering pools.
329 A snapshot is a read-only copy of a file system or volume. Snapshots can be
330 created extremely quickly, and initially consume no additional space within the
331 pool. As data within the active dataset changes, the snapshot consumes more
332 data than would otherwise be shared with the active dataset.
334 Snapshots can have arbitrary names. Snapshots of volumes can be cloned or
335 rolled back, but cannot be accessed independently.
337 File system snapshots can be accessed under the
339 directory in the root of the file system. Snapshots are automatically mounted
340 on demand and may be unmounted at regular intervals. The visibility of the
342 directory can be controlled by the
346 A clone is a writable volume or file system whose initial contents are the same
347 as another dataset. As with snapshots, creating a clone is nearly
348 instantaneous, and initially consumes no additional space.
350 Clones can only be created from a snapshot. When a snapshot is cloned, it
351 creates an implicit dependency between the parent and child. Even though the
352 clone is created somewhere else in the dataset hierarchy, the original snapshot
353 cannot be destroyed as long as a clone exists. The
355 property exposes this dependency, and the
357 command lists any such dependencies, if they exist.
359 The clone parent-child dependency relationship can be reversed by using the
361 subcommand. This causes the "origin" file system to become a clone of the
362 specified file system, which makes it possible to destroy the file system that
363 the clone was created from.
367 file system is a simple operation, so the number of file systems per system is
368 likely to be numerous. To cope with this,
370 automatically manages mounting and unmounting file systems without the need to
373 file. All automatically managed file systems are mounted by
377 By default, file systems are mounted under
381 is the name of the file system in the
383 namespace. Directories are created and destroyed as needed.
385 A file system can also have a mount point set in the
387 property. This directory is created as needed, and
389 automatically mounts the file system when the
391 command is invoked (without editing
395 property can be inherited, so if
401 automatically inherits a mount point of
408 prevents the file system from being mounted.
412 file systems can also be managed with traditional tools
413 .Pq Xr mount 8 , Xr umount 8 , Xr fstab 5 .
414 If a file system's mount point is set to
417 makes no attempt to manage the file system, and the administrator is
418 responsible for mounting and unmounting the file system.
421 dataset can be attached to a jail by using the
423 subcommand. You cannot attach a dataset to one jail and the children of the
424 same dataset to another jails. To allow management of the dataset from within
427 property has to be set and the jail needs access to the
431 property cannot be changed from within a jail. See
433 for information on how to allow mounting
435 datasets from within a jail.
438 dataset can be detached from a jail using the
442 After a dataset is attached to a jail and the jailed property is set, a jailed
443 file system cannot be mounted outside the jail, since the jail administrator
444 might have set the mount point to an unacceptable value.
446 Deduplication is the process for removing redundant data at the block-level,
447 reducing the total amount of data stored. If a file system has the
449 property enabled, duplicate data blocks are removed synchronously. The result
450 is that only unique data is stored and common components are shared among
452 .Ss Native Properties
453 Properties are divided into two types, native properties and user-defined (or
454 "user") properties. Native properties either export internal statistics or
457 behavior. In addition, native properties are either editable or read-only. User
458 properties have no effect on
460 behavior, but you can use them to annotate datasets in a way that is meaningful
461 in your environment. For more information about user properties, see the
462 .Qq Sx User Properties
465 Every dataset has a set of properties that export statistics about the dataset
466 as well as control various behaviors. Properties are inherited from the parent
467 unless overridden by the child. Some properties apply only to certain types of
468 datasets (file systems, volumes, or snapshots).
470 The values of numeric properties can be specified using human-readable suffixes
472 .Sy k , KB , M , Gb ,
475 for zettabyte). The following are all valid (and equal) specifications:
476 .Bd -ragged -offset 4n
480 The values of non-numeric properties are case sensitive and must be lowercase,
482 .Sy mountpoint , sharenfs , No and Sy sharesmb .
484 The following native properties consist of read-only statistics about the
485 dataset. These properties can be neither set, nor inherited. Native properties
486 apply to all dataset types unless otherwise noted.
489 The amount of space available to the dataset and all its children, assuming
490 that there is no other activity in the pool. Because space is shared within a
491 pool, availability can be limited by any number of factors, including physical
492 pool size, quotas, reservations, or other datasets within the pool.
494 This property can also be referred to by its shortened column name,
497 For non-snapshots, the compression ratio achieved for the
499 space of this dataset, expressed as a multiplier. The
501 property includes descendant datasets, and, for clones, does not include
502 the space shared with the origin snapshot. For snapshots, the
506 property. Compression can be turned on by running:
507 .Qq Nm Cm set compression=on Ar dataset
511 The time this dataset was created.
513 For snapshots, this property is a comma-separated list of filesystems or
514 volumes which are clones of this snapshot. The clones'
516 property is this snapshot. If the
518 property is not empty, then this snapshot can not be destroyed (even with the
526 if the snapshot has been marked for deferred destroy by using the
528 command. Otherwise, the property is
530 .It Sy logicalreferenced
531 The amount of space that is
533 accessible by this dataset.
537 The logical space ignores the effect of the
541 properties, giving a quantity closer to the amount of data that applications
543 However, it does include space consumed by metadata.
545 This property can also be referred to by its shortened column name,
548 The amount of space that is
550 consumed by this dataset and all its descendents.
554 The logical space ignores the effect of the
558 properties, giving a quantity closer to the amount of data that applications
561 This property can also be referred to by its shortened column name,
564 For file systems, indicates whether the file system is currently mounted. This
565 property can be either
570 For cloned file systems or volumes, the snapshot from which the clone was
571 created. See also the
575 The amount of data that is accessible by this dataset, which may or may not be
576 shared with other datasets in the pool. When a snapshot or clone is created, it
577 initially references the same amount of space as the file system or snapshot it
578 was created from, since its contents are identical.
580 This property can also be referred to by its shortened column name,
582 .It Sy refcompressratio
583 The compression ratio achieved for the
585 space of this dataset, expressed as a multiplier. See also the
590 .Sy filesystem , volume , No or Sy snapshot .
592 The amount of space consumed by this dataset and all its descendents. This is
593 the value that is checked against this dataset's quota and reservation. The
594 space used does not include this dataset's reservation, but does take into
595 account the reservations of any descendent datasets. The amount of space that a
596 dataset consumes from its parent, as well as the amount of space that are freed
597 if this dataset is recursively destroyed, is the greater of its space used and
600 When snapshots (see the
602 section) are created, their space is
603 initially shared between the snapshot and the file system, and possibly with
604 previous snapshots. As the file system changes, space that was previously
605 shared becomes unique to the snapshot, and counted in the snapshot's space
606 used. Additionally, deleting snapshots can increase the amount of space unique
607 to (and used by) other snapshots.
609 The amount of space used, available, or referenced does not take into account
610 pending changes. Pending changes are generally accounted for within a few
611 seconds. Committing a change to a disk using
615 does not necessarily guarantee that the space usage information is updated
620 properties decompose the
622 properties into the various reasons that space is used. Specifically,
624 .Sy usedbysnapshots + usedbydataset + usedbychildren + usedbyrefreservation .
625 These properties are only available for datasets created
628 pool version 13 pools and higher.
629 .It Sy usedbysnapshots
630 The amount of space consumed by snapshots of this dataset. In particular, it is
631 the amount of space that would be freed if all of this dataset's snapshots were
632 destroyed. Note that this is not simply the sum of the snapshots'
634 properties because space can be shared by multiple snapshots.
636 The amount of space used by this dataset itself, which would be freed if the
637 dataset were destroyed (after first removing any
639 and destroying any necessary snapshots or descendents).
640 .It Sy usedbychildren
641 The amount of space used by children of this dataset, which would be freed if
642 all the dataset's children were destroyed.
643 .It Sy usedbyrefreservation
644 The amount of space used by a
646 set on this dataset, which would be freed if the
649 .It Sy userused@ Ns Ar user
650 The amount of space consumed by the specified user in this dataset. Space is
651 charged to the owner of each file, as displayed by
653 The amount of space charged is displayed by
659 subcommand for more information.
661 Unprivileged users can access only their own space usage. The root user, or a
662 user who has been granted the
666 can access everyone's usage.
670 properties are not displayed by
672 The user's name must be appended after the
674 symbol, using one of the following forms:
675 .Bl -bullet -offset 2n
677 POSIX name (for example,
680 POSIX numeric ID (for example,
684 This property is set to the number of user holds on this snapshot. User holds
688 .It Sy groupused@ Ns Ar group
689 The amount of space consumed by the specified group in this dataset. Space is
690 charged to the group of each file, as displayed by
693 .Sy userused@ Ns Ar user
694 property for more information.
696 Unprivileged users can only access their own groups' space usage. The root
697 user, or a user who has been granted the
701 can access all groups' usage.
702 .It Sy volblocksize Ns = Ns Ar blocksize
703 For volumes, specifies the block size of the volume. The
705 cannot be changed once the volume has been written, so it should be set at
706 volume creation time. The default
708 for volumes is 8 Kbytes. Any
709 power of 2 from 512 bytes to 128 Kbytes is valid.
711 This property can also be referred to by its shortened column name,
716 space written to this dataset since the previous snapshot.
717 .It Sy written@ Ns Ar snapshot
720 space written to this dataset since the specified snapshot. This is the space
721 that is referenced by this dataset but was not referenced by the specified
726 may be specified as a short snapshot name (just the part after the
728 in which case it will be interpreted as a snapshot in the same filesystem as
731 may be a full snapshot name
732 .Pq Em filesystem@snapshot ,
733 which for clones may be a snapshot in the origin's filesystem (or the origin of
734 the origin's filesystem, etc).
737 The following native properties can be used to change the behavior of a
742 .Sy aclinherit Ns = Ns Cm discard |
750 entries are inherited when files and directories are created. A file system
757 entries. A file system with an
761 only inherits inheritable
763 entries that specify "deny" permissions. The property value
765 (the default) removes the
771 entry is inherited. A file system with an
775 inherits all inheritable
777 entries without any modifications made to the
779 entries when they are inherited. A file system with an
783 has the same meaning as
786 .Em owner@ , group@ , No and Em everyone@ Tn ACE Ns s
787 inherit the execute permission only if the file creation mode also requests the
790 When the property value is set to
792 files are created with a mode determined by the inheritable
796 exist that affect the mode, then the mode is set in accordance to the requested
797 mode from the application.
798 .It Sy aclmode Ns = Ns Cm discard | groupmask | passthrough | restricted
803 A file system with an
807 (the default) deletes all
809 entries that do not represent the mode of the file. An
813 reduces permissions granted in all
817 such that they are no greater than the group permissions specified by
819 A file system with an
823 indicates that no changes are made to the
825 other than creating or updating the necessary
827 entries to represent the new mode of the file or directory.
834 operation to return an error when used on any file or directory which has
837 whose entries can not be represented by a mode.
839 is required to change the set user ID, set group ID, or sticky bits on a file
840 or directory, as they do not have equivalent
845 on a file or directory with a non-trivial
851 you must first remove all
853 entries which do not represent the current mode.
854 .It Sy atime Ns = Ns Cm on | off
855 Controls whether the access time for files is updated when they are read.
856 Turning this property off avoids producing write traffic when reading files and
857 can result in significant performance gains, though it might confuse mailers
858 and other similar utilities. The default value is
860 .It Sy canmount Ns = Ns Cm on | off | noauto
861 If this property is set to
863 the file system cannot be mounted, and is ignored by
864 .Qq Nm Cm mount Fl a .
865 Setting this property to
867 is similar to setting the
871 except that the dataset still has a normal
873 property, which can be inherited. Setting this property to
875 allows datasets to be used solely as a mechanism to inherit properties. One
877 .Sy canmount Ns = Ns Cm off
878 is to have two datasets with the same
880 so that the children of both datasets appear in the same directory, but might
881 have different inherited characteristics.
885 value is set, a dataset can only be mounted and unmounted explicitly. The
886 dataset is not mounted automatically when the dataset is created or imported,
887 nor is it mounted by the
889 command or unmounted by the
890 .Qq Nm Cm umount Fl a
893 This property is not inherited.
894 .It Sy checksum Ns = Ns Cm on | off | fletcher2 | fletcher4 | sha256 | noparity
895 Controls the checksum used to verify data integrity. The default value is
897 which automatically selects an appropriate algorithm (currently,
899 but this may change in future releases). The value
901 disables integrity checking on user data.
905 disables integrity but also disables maintaining parity for user data. This
906 setting is used internally by a dump device residing on a RAID-Z pool and should
907 not be used by any other dataset.
908 Disabling checksums is
910 a recommended practice.
911 .It Sy compression Ns = Ns Cm on | off | lzjb | gzip | gzip- Ns Ar N | zle | Cm lz4
912 Controls the compression algorithm used for this dataset. The
914 compression algorithm is optimized for performance while providing decent data
915 compression. Setting compression to
919 compression algorithm. The
921 compression algorithm uses the same compression as the
923 command. You can specify the
925 level by using the value
929 is an integer from 1 (fastest) to 9 (best compression ratio). Currently,
933 (which is also the default for
937 compression algorithm compresses runs of zeros.
941 compression algorithm is a high-performance replacement
944 algorithm. It features significantly faster
945 compression and decompression, as well as a moderately higher
946 compression ratio than
948 but can only be used on pools with
955 for details on ZFS feature flags and the
959 This property can also be referred to by its shortened column name
961 Changing this property affects only newly-written data.
962 .It Sy copies Ns = Ns Cm 1 | 2 | 3
963 Controls the number of copies of data stored for this dataset. These copies are
964 in addition to any redundancy provided by the pool, for example, mirroring or
965 RAID-Z. The copies are stored on different disks, if possible. The space used
966 by multiple copies is charged to the associated file and dataset, changing the
968 property and counting against quotas and reservations.
970 Changing this property only affects newly-written data. Therefore, set this
971 property at file system creation time by using the
972 .Fl o Cm copies= Ns Ar N
974 .It Sy dedup Ns = Ns Cm on | off | verify | sha256 Ns Op Cm ,verify
975 Configures deduplication for a dataset. The default value is
977 The default deduplication checksum is
979 (this may change in the future).
982 is enabled, the checksum defined here overrides the
984 property. Setting the value to
986 has the same effect as the setting
992 will do a byte-to-byte comparsion in case of two blocks having the same
993 signature to make sure the block contents are identical.
994 .It Sy devices Ns = Ns Cm on | off
997 property is currently not supported on
999 .It Sy exec Ns = Ns Cm on | off
1000 Controls whether processes can be executed from within this file system. The
1003 .It Sy mlslabel Ns = Ns Ar label | Cm none
1006 property is currently not supported on
1008 .It Sy mountpoint Ns = Ns Ar path | Cm none | legacy
1009 Controls the mount point used for this file system. See the
1011 section for more information on how this property is used.
1015 property is changed for a file system, the file system and any children that
1016 inherit the mount point are unmounted. If the new value is
1018 then they remain unmounted. Otherwise, they are automatically remounted in the
1019 new location if the property was previously
1023 or if they were mounted before the property was changed. In addition, any
1024 shared file systems are unshared and shared in the new location.
1025 .It Sy nbmand Ns = Ns Cm on | off
1028 property is currently not supported on
1030 .It Sy primarycache Ns = Ns Cm all | none | metadata
1031 Controls what is cached in the primary cache (ARC). If this property is set to
1033 then both user data and metadata is cached. If this property is set to
1035 then neither user data nor metadata is cached. If this property is set to
1037 then only metadata is cached. The default value is
1039 .It Sy quota Ns = Ns Ar size | Cm none
1040 Limits the amount of space a dataset and its descendents can consume. This
1041 property enforces a hard limit on the amount of space used. This includes all
1042 space consumed by descendents, including file systems and snapshots. Setting a
1043 quota on a descendent of a dataset that already has a quota does not override
1044 the ancestor's quota, but rather imposes an additional limit.
1046 Quotas cannot be set on volumes, as the
1048 property acts as an implicit quota.
1049 .It Sy userquota@ Ns Ar user Ns = Ns Ar size | Cm none
1050 Limits the amount of space consumed by the specified user.
1055 space calculation does not include space that is used by descendent datasets,
1056 such as snapshots and clones. User space consumption is identified by the
1057 .Sy userspace@ Ns Ar user
1060 Enforcement of user quotas may be delayed by several seconds. This delay means
1061 that a user might exceed their quota before the system notices that they are
1062 over quota and begins to refuse additional writes with the
1064 error message. See the
1066 subcommand for more information.
1068 Unprivileged users can only access their own groups' space usage. The root
1069 user, or a user who has been granted the
1073 can get and set everyone's quota.
1075 This property is not available on volumes, on file systems before version 4, or
1076 on pools before version 15. The
1077 .Sy userquota@ Ns ...
1078 properties are not displayed by
1080 The user's name must be appended after the
1082 symbol, using one of the following forms:
1083 .Bl -bullet -offset 2n
1085 POSIX name (for example,
1088 POSIX numeric ID (for example,
1091 .It Sy groupquota@ Ns Ar group Ns = Ns Ar size | Cm none
1092 Limits the amount of space consumed by the specified group. Group space
1093 consumption is identified by the
1094 .Sy userquota@ Ns Ar user
1097 Unprivileged users can access only their own groups' space usage. The root
1098 user, or a user who has been granted the
1102 can get and set all groups' quotas.
1103 .It Sy readonly Ns = Ns Cm on | off
1104 Controls whether this dataset can be modified. The default value is
1106 .It Sy recordsize Ns = Ns Ar size
1107 Specifies a suggested block size for files in the file system. This property is
1108 designed solely for use with database workloads that access files in fixed-size
1111 automatically tunes block sizes according to internal algorithms optimized for
1112 typical access patterns.
1114 For databases that create very large files but access them in small random
1115 chunks, these algorithms may be suboptimal. Specifying a
1117 greater than or equal to the record size of the database can result in
1118 significant performance gains. Use of this property for general purpose file
1119 systems is strongly discouraged, and may adversely affect performance.
1121 The size specified must be a power of two greater than or equal to 512 and less
1122 than or equal to 128 Kbytes.
1124 Changing the file system's
1126 affects only files created afterward; existing files are unaffected.
1128 This property can also be referred to by its shortened column name,
1130 .It Sy refquota Ns = Ns Ar size | Cm none
1131 Limits the amount of space a dataset can consume. This property enforces a hard
1132 limit on the amount of space used. This hard limit does not include space used
1133 by descendents, including file systems and snapshots.
1134 .It Sy refreservation Ns = Ns Ar size | Cm none
1135 The minimum amount of space guaranteed to a dataset, not including its
1136 descendents. When the amount of space used is below this value, the dataset is
1137 treated as if it were taking up the amount of space specified by
1138 .Sy refreservation .
1141 reservation is accounted for in the parent datasets' space used, and counts
1142 against the parent datasets' quotas and reservations.
1146 is set, a snapshot is only allowed if there is enough free pool space outside
1147 of this reservation to accommodate the current number of "referenced" bytes in
1150 This property can also be referred to by its shortened column name,
1152 .It Sy reservation Ns = Ns Ar size | Cm none
1153 The minimum amount of space guaranteed to a dataset and its descendents. When
1154 the amount of space used is below this value, the dataset is treated as if it
1155 were taking up the amount of space specified by its reservation. Reservations
1156 are accounted for in the parent datasets' space used, and count against the
1157 parent datasets' quotas and reservations.
1159 This property can also be referred to by its shortened column name,
1161 .It Sy secondarycache Ns = Ns Cm all | none | metadata
1162 Controls what is cached in the secondary cache (L2ARC). If this property is set
1165 then both user data and metadata is cached. If this property is set to
1167 then neither user data nor metadata is cached. If this property is set to
1169 then only metadata is cached. The default value is
1171 .It Sy setuid Ns = Ns Cm on | off
1172 Controls whether the
1174 bit is respected for the file system. The default value is
1176 .It Sy sharesmb Ns = Ns Cm on | off | Ar opts
1179 property currently has no effect on
1181 .It Sy sharenfs Ns = Ns Cm on | off | Ar opts
1182 Controls whether the file system is shared via
1184 and what options are used. A file system with a
1188 is managed the traditional way via
1190 Otherwise, the file system is automatically shared and unshared with the
1194 commands. If the property is set to
1198 export options are used. Otherwise,
1200 export options are equivalent to the contents of this property. The export
1201 options may be comma-separated. See
1203 for a list of valid options.
1207 property is changed for a dataset, the
1210 .It Sy logbias Ns = Ns Cm latency | throughput
1213 about handling of synchronous requests in this dataset.
1220 will use pool log devices (if configured) to handle the requests at low
1226 will not use configured pool log devices.
1228 will instead optimize synchronous operations for global pool throughput and
1229 efficient use of resources.
1230 .It Sy snapdir Ns = Ns Cm hidden | visible
1231 Controls whether the
1233 directory is hidden or visible in the root of the file system as discussed in
1236 section. The default value is
1238 .It Sy sync Ns = Ns Cm standard | always | disabled
1239 Controls the behavior of synchronous requests (e.g.
1241 O_DSYNC). This property accepts the following values:
1242 .Bl -tag -offset 4n -width 8n
1244 This is the POSIX specified behavior of ensuring all synchronous requests are
1245 written to stable storage and all devices are flushed to ensure data is not
1246 cached by device controllers (this is the default).
1248 All file system transactions are written and flushed before their system calls
1249 return. This has a large performance penalty.
1251 Disables synchronous requests. File system transactions are only committed to
1252 stable storage periodically. This option will give the highest performance.
1253 However, it is very dangerous as
1255 would be ignoring the synchronous transaction demands of applications such as
1258 Administrators should only use this option when the risks are understood.
1260 .It Sy volsize Ns = Ns Ar size
1261 For volumes, specifies the logical size of the volume. By default, creating a
1262 volume establishes a reservation of equal size. For storage pools with a
1263 version number of 9 or higher, a
1265 is set instead. Any changes to
1267 are reflected in an equivalent change to the reservation (or
1268 .Sy refreservation ) .
1271 can only be set to a multiple of
1275 The reservation is kept equal to the volume's logical size to prevent
1276 unexpected behavior for consumers. Without the reservation, the volume could
1277 run out of space, resulting in undefined behavior or data corruption, depending
1278 on how the volume is used. These effects can also occur when the volume size is
1279 changed while it is in use (particularly when shrinking the size). Extreme care
1280 should be used when adjusting the volume size.
1282 Though not recommended, a "sparse volume" (also known as "thin provisioning")
1283 can be created by specifying the
1286 .Qq Nm Cm create Fl V
1287 command, or by changing the reservation after the volume has been created. A
1288 "sparse volume" is a volume where the reservation is less then the volume size.
1289 Consequently, writes to a sparse volume can fail with
1291 when the pool is low on space. For a sparse volume, changes to
1293 are not reflected in the reservation.
1294 .It Sy vscan Ns = Ns Cm off | on
1297 property is currently not supported on
1299 .It Sy xattr Ns = Ns Cm off | on
1302 property is currently not supported on
1304 .It Sy jailed Ns = Ns Cm off | on
1305 Controls whether the dataset is managed from a jail. See the
1307 section for more information. The default value is
1311 The following three properties cannot be changed after the file system is
1312 created, and therefore, should be set when the file system is created. If the
1313 properties are not set with the
1317 commands, these properties are inherited from the parent dataset. If the parent
1318 dataset lacks these properties due to having been created prior to these
1319 features being supported, the new file system will have the default values for
1322 .It Sy casesensitivity Ns = Ns Cm sensitive | insensitive | mixed
1325 property is currently not supported on
1327 .It Sy normalization Ns = Ns Cm none | formC | formD | formKC | formKD
1328 Indicates whether the file system should perform a
1330 normalization of file names whenever two file names are compared, and which
1331 normalization algorithm should be used. File names are always stored
1332 unmodified, names are normalized as part of any comparison process. If this
1333 property is set to a legal value other than
1337 property was left unspecified, the
1339 property is automatically set to
1341 The default value of the
1345 This property cannot be changed after the file system is created.
1346 .It Sy utf8only Ns = Ns Cm on | off
1347 Indicates whether the file system should reject file names that include
1348 characters that are not present in the
1350 character code set. If this property is explicitly set to
1352 the normalization property must either not be explicitly set or be set to
1354 The default value for the
1358 This property cannot be changed after the file system is created.
1362 .Sy casesensitivity , normalization , No and Sy utf8only
1363 properties are also new permissions that can be assigned to non-privileged
1366 delegated administration feature.
1367 .Ss Temporary Mount Point Properties
1368 When a file system is mounted, either through
1370 for legacy mounts or the
1372 command for normal file systems, its mount options are set according to its
1373 properties. The correlation between properties and mount options is as follows:
1374 .Bl -column -offset 4n "PROPERTY" "MOUNT OPTION"
1375 .It "PROPERTY MOUNT OPTION"
1376 .It "atime atime/noatime"
1377 .It "exec exec/noexec"
1378 .It "readonly ro/rw"
1379 .It "setuid suid/nosuid"
1382 In addition, these options can be set on a per-mount basis using the
1384 option, without affecting the property that is stored on disk. The values
1385 specified on the command line override the values stored in the dataset. These
1386 properties are reported as "temporary" by the
1388 command. If the properties are changed while the dataset is mounted, the new
1389 setting overrides any temporary settings.
1391 In addition to the standard native properties,
1393 supports arbitrary user properties. User properties have no effect on
1395 behavior, but applications or administrators can use them to annotate datasets
1396 (file systems, volumes, and snapshots).
1398 User property names must contain a colon
1400 character to distinguish them from native properties. They may contain
1401 lowercase letters, numbers, and the following punctuation characters: colon
1409 The expected convention is that the property name is divided into two portions
1411 .Em module Ns Sy \&: Ns Em property ,
1412 but this namespace is not enforced by
1414 User property names can be at most 256 characters, and cannot begin with a dash
1417 When making programmatic use of user properties, it is strongly suggested to
1422 component of property names to reduce the chance that two
1423 independently-developed packages use the same property name for different
1424 purposes. Property names beginning with
1426 are reserved for use by Sun Microsystems.
1428 The values of user properties are arbitrary strings, are always inherited, and
1429 are never validated. All of the commands that operate on properties
1436 can be used to manipulate both native properties and user properties. Use the
1438 command to clear a user property. If the property is not defined in any parent
1439 dataset, it is removed entirely. Property values are limited to 1024
1442 All subcommands that modify state are logged persistently to the pool in their
1450 Displays a help message.
1455 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1461 file system. The file system is automatically mounted according to the
1463 property inherited from the parent.
1464 .Bl -tag -width indent
1466 Creates all the non-existing parent datasets. Datasets created in this manner
1467 are automatically mounted according to the
1469 property inherited from their parent. Any property specified on the command
1472 option is ignored. If the target filesystem already exists, the operation
1473 completes successfully.
1475 Newly created file system is not mounted.
1476 .It Fl o Ar property Ns = Ns Ar value
1477 Sets the specified property as if the command
1478 .Qq Nm Cm set Ar property Ns = Ns Ar value
1479 was invoked at the same time the dataset was created. Any editable
1481 property can also be set at creation time. Multiple
1483 options can be specified. An error results if the same property is specified in
1492 .Op Fl b Ar blocksize
1493 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1498 Creates a volume of the given size. The volume is exported as a block device in
1499 .Pa /dev/zvol/path ,
1502 is the name of the volume in the
1504 namespace. The size represents the logical size as exported by the device. By
1505 default, a reservation of equal size is created.
1508 is automatically rounded up to the nearest 128 Kbytes to ensure that
1509 the volume has an integral number of blocks regardless of
1511 .Bl -tag -width indent
1513 Creates all the non-existing parent datasets. Datasets created in this manner
1514 are automatically mounted according to the
1516 property inherited from their parent. Any property specified on the command
1519 option is ignored. If the target filesystem already exists, the operation
1520 completes successfully.
1522 Creates a sparse volume with no reservation. See
1525 .Qq Sx Native Properties
1526 section for more information about sparse volumes.
1527 .It Fl b Ar blocksize
1529 .Fl o Cm volblocksize Ns = Ns Ar blocksize .
1530 If this option is specified in conjunction with
1531 .Fl o Cm volblocksize ,
1532 the resulting behavior is undefined.
1533 .It Fl o Ar property Ns = Ns Ar value
1534 Sets the specified property as if the
1535 .Qq Nm Cm set Ar property Ns = Ns Ar value
1536 command was invoked at the same time the dataset was created. Any editable
1538 property can also be set at creation time. Multiple
1540 options can be specified. An error results if the same property is specified in
1549 .Ar filesystem Ns | Ns Ar volume
1552 Destroys the given dataset. By default, the command unshares any file systems
1553 that are currently shared, unmounts any file systems that are currently
1554 mounted, and refuses to destroy a dataset that has active dependents (children
1556 .Bl -tag -width indent
1558 Recursively destroy all children.
1560 Recursively destroy all dependents, including cloned file systems outside the
1563 Force an unmount of any file systems using the
1564 .Qq Nm Cm unmount Fl f
1565 command. This option has no effect on non-file systems or unmounted file
1568 Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in
1569 conjunction with the
1573 flags to determine what data would be deleted.
1575 Print machine-parsable verbose information about the deleted data.
1577 Print verbose information about the deleted data.
1580 Extreme care should be taken when applying either the
1584 options, as they can destroy large portions of a pool and cause unexpected
1585 behavior for mounted file systems in use.
1592 .Op % Ns Ar snapname
1597 The given snapshots are destroyed immediately if and only if the
1601 option would have destroyed it. Such immediate destruction would occur, for
1602 example, if the snapshot had no clones and the user-initiated reference count
1605 If a snapshot does not qualify for immediate destruction, it is marked for
1606 deferred deletion. In this state, it exists as a usable, visible snapshot until
1607 both of the preconditions listed above are met, at which point it is destroyed.
1609 An inclusive range of snapshots may be specified by separating the
1610 first and last snapshots with a percent sign
1612 The first and/or last snapshots may be left blank, in which case the
1613 filesystem's oldest or newest snapshot will be implied.
1616 (or ranges of snapshots) of the same filesystem or volume may be specified
1617 in a comma-separated list of snapshots.
1618 Only the snapshot's short name (the
1621 should be specified when using a range or comma-separated list to identify
1623 .Bl -tag -width indent
1625 Destroy (or mark for deferred deletion) all snapshots with this name in
1626 descendent file systems.
1628 Recursively destroy all clones of these snapshots, including the clones,
1629 snapshots, and children.
1630 If this flag is specified, the
1632 flag will have no effect.
1634 Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in
1635 conjunction with the
1639 flags to determine what data would be deleted.
1641 Print machine-parsable verbose information about the deleted data.
1643 Print verbose information about the deleted data.
1645 Defer snapshot deletion.
1648 Extreme care should be taken when applying either the
1652 options, as they can destroy large portions of a pool and cause unexpected
1653 behavior for mounted file systems in use.
1658 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1659 .Ar filesystem@snapname Ns | Ns volume@snapname
1660 .Ar filesystem@snapname Ns | Ns volume@snapname Ns ...
1663 Creates snapshots with the given names. All previous modifications by
1664 successful system calls to the file system are part of the snapshots.
1665 Snapshots are taken atomically, so that all snapshots correspond to the same
1666 moment in time. See the
1668 section for details.
1669 .Bl -tag -width indent
1671 Recursively create snapshots of all descendent datasets
1672 .It Fl o Ar property Ns = Ns Ar value
1673 Sets the specified property; see
1684 Roll back the given dataset to a previous snapshot. When a dataset is rolled
1685 back, all data that has changed since the snapshot is discarded, and the
1686 dataset reverts to the state at the time of the snapshot. By default, the
1687 command refuses to roll back to a snapshot other than the most recent one. In
1688 order to do so, all intermediate snapshots must be destroyed by specifying the
1691 .Bl -tag -width indent
1693 Recursively destroy any snapshots more recent than the one specified.
1695 Recursively destroy any more recent snapshots, as well as any clones of those
1700 option to force an unmount of any clone file systems that are to be destroyed.
1706 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1707 .Ar snapshot filesystem Ns | Ns Ar volume
1710 Creates a clone of the given snapshot. See the
1712 section for details. The target dataset can be located anywhere in the
1714 hierarchy, and is created as the same type as the original.
1715 .Bl -tag -width indent
1717 Creates all the non-existing parent datasets. Datasets created in this manner
1718 are automatically mounted according to the
1720 property inherited from their parent. If the target filesystem or volume
1721 already exists, the operation completes successfully.
1722 .It Fl o Ar property Ns = Ns Ar value
1723 Sets the specified property; see
1730 .Ar clone-filesystem
1733 Promotes a clone file system to no longer be dependent on its "origin"
1734 snapshot. This makes it possible to destroy the file system that the clone was
1735 created from. The clone parent-child dependency relationship is reversed, so
1736 that the origin file system becomes a clone of the specified file system.
1738 The snapshot that was cloned, and any snapshots previous to this snapshot, are
1739 now owned by the promoted clone. The space they use moves from the origin file
1740 system to the promoted clone, so enough space must be available to accommodate
1741 these snapshots. No new space is consumed by this operation, but the space
1742 accounting is adjusted. The promoted clone must not have any conflicting
1743 snapshot names of its own. The
1745 subcommand can be used to rename any conflicting snapshots.
1750 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1751 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1758 .Ar filesystem Ns | Ns Ar volume
1759 .Ar filesystem Ns | Ns Ar volume
1766 .Ar filesystem filesystem
1769 Renames the given dataset. The new target can be located anywhere in the
1771 hierarchy, with the exception of snapshots. Snapshots can only be renamed
1772 within the parent file system or volume. When renaming a snapshot, the parent
1773 file system of the snapshot does not need to be specified as part of the second
1774 argument. Renamed file systems can inherit new mount points, in which case they
1775 are unmounted and remounted at the new mount point.
1776 .Bl -tag -width indent
1778 Creates all the nonexistent parent datasets. Datasets created in this manner
1779 are automatically mounted according to the
1781 property inherited from their parent.
1783 Do not remount file systems during rename. If a file system's
1789 file system is not unmounted even if this option is not given.
1791 Force unmount any filesystems that need to be unmounted in the process.
1792 This flag has no effect if used together with the
1800 .Ar snapshot snapshot
1803 Recursively rename the snapshots of all descendent datasets. Snapshots are the
1804 only dataset that can be renamed recursively.
1808 .Op Fl r Ns | Ns Fl d Ar depth
1810 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
1811 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
1812 .Oo Fl s Ar property Oc Ns ...
1813 .Oo Fl S Ar property Oc Ns ...
1814 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
1817 Lists the property information for the given datasets in tabular form. If
1818 specified, you can list property information by the absolute pathname or the
1819 relative pathname. By default, all file systems and volumes are displayed.
1820 Snapshots are displayed if the
1826 The following fields are displayed,
1827 .Sy name , used , available , referenced , mountpoint .
1828 .Bl -tag -width indent
1830 Recursively display any children of the dataset on the command line.
1832 Recursively display any children of the dataset, limiting the recursion to
1836 will display only the dataset and its direct children.
1838 Used for scripting mode. Do not print headers and separate fields by a single
1839 tab instead of arbitrary white space.
1840 .It Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
1841 A comma-separated list of properties to display. The property must be:
1842 .Bl -bullet -offset 2n
1844 One of the properties described in the
1845 .Qq Sx Native Properties
1852 to display the dataset name
1856 to display space usage properties on file systems and volumes. This is a
1857 shortcut for specifying
1859 .Sy name,avail,used,usedsnap,usedds,usedrefreserv,usedchild
1861 .Sy filesystem,volume
1864 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
1865 A comma-separated list of types to display, where
1868 .Sy filesystem , snapshot , volume , No or Sy all .
1869 For example, specifying
1871 displays only snapshots.
1872 .It Fl s Ar property
1873 A property for sorting the output by column in ascending order based on the
1874 value of the property. The property must be one of the properties described in
1877 section, or the special value
1879 to sort by the dataset name. Multiple properties can be specified at one time
1882 property options. Multiple
1884 options are evaluated from left to right in decreasing order of importance.
1886 The following is a list of sorting criteria:
1887 .Bl -bullet -offset 2n
1889 Numeric types sort in numeric order.
1891 String types sort in alphabetical order.
1893 Types inappropriate for a row sort that row to the literal bottom, regardless
1894 of the specified ordering.
1896 If no sorting options are specified the existing behavior of
1900 .It Fl S Ar property
1903 option, but sorts by property in descending order.
1908 .Ar property Ns = Ns Ar value
1909 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1912 Sets the property to the given value for each dataset. Only some properties can
1913 be edited. See the "Properties" section for more information on what properties
1914 can be set and acceptable values. Numeric values can be specified as exact
1915 values, or in a human-readable form with a suffix of
1916 .Sy B , K , M , G , T , P , E , Z
1917 (for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes, or
1918 zettabytes, respectively). User properties can be set on snapshots. For more
1919 information, see the
1920 .Qq Sx User Properties
1925 .Op Fl r Ns | Ns Fl d Ar depth
1927 .Op Fl o Ar all | field Ns Oo , Ns Ar field Oc Ns ...
1928 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
1929 .Op Fl s Ar source Ns Oo , Ns Ar source Oc Ns ...
1930 .Ar all | property Ns Oo , Ns Ar property Oc Ns ...
1931 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
1934 Displays properties for the given datasets. If no datasets are specified, then
1935 the command displays properties for all datasets on the system. For each
1936 property, the following columns are displayed:
1938 .Bl -hang -width "property" -offset indent -compact
1946 Property source. Can either be local, default, temporary, inherited, or none
1950 All columns except the
1952 column are displayed by default. The columns to display can be specified
1955 option. This command takes a comma-separated list of properties as described in
1957 .Qq Sx Native Properties
1959 .Qq Sx User Properties
1964 can be used to display all properties that apply to the given dataset's type
1965 (filesystem, volume, or snapshot).
1966 .Bl -tag -width indent
1968 Recursively display properties for any children.
1970 Recursively display any children of the dataset, limiting the recursion to
1974 will display only the dataset and its direct children.
1976 Display output in a form more easily parsed by scripts. Any headers are
1977 omitted, and fields are explicitly separated by a single tab instead of an
1978 arbitrary amount of space.
1980 Display numbers in parseable (exact) values.
1981 .It Fl o Cm all | Ar field Ns Oo , Ns Ar field Oc Ns ...
1982 A comma-separated list of columns to display. Supported values are
1983 .Sy name,property,value,received,source .
1985 .Sy name,property,value,source .
1988 specifies all columns.
1989 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
1990 A comma-separated list of types to display, where
1993 .Sy filesystem , snapshot , volume , No or Sy all .
1994 For example, specifying
1996 displays only snapshots.
1997 .It Fl s Ar source Ns Oo , Ns Ar source Oc Ns ...
1998 A comma-separated list of sources to display. Those properties coming from a
1999 source other than those in this list are ignored. Each source must be one of
2001 .Sy local,default,inherited,temporary,received,none .
2002 The default value is all sources.
2009 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
2012 Clears the specified property, causing it to be inherited from an ancestor. If
2013 no ancestor has the property set, then the default value is used. See the
2015 section for a listing of default values, and details on which properties can be
2017 .Bl -tag -width indent
2019 Recursively inherit the given property for all children.
2021 For properties with a received value, revert to this value. This flag has no
2022 effect on properties that do not have a received value.
2030 Displays a list of file systems that are not the most recent version.
2031 .Bl -tag -width indent
2035 filesystem versions supported by the current software. The current
2037 filesystem version and all previous supported versions are displayed, along
2038 with an explanation of the features provided with each version.
2045 .Fl a | Ar filesystem
2048 Upgrades file systems to a new on-disk version. Once this is done, the file
2049 systems will no longer be accessible on systems running older versions of the
2052 streams generated from new snapshots of these file systems cannot be accessed
2053 on systems running older versions of the software.
2055 In general, the file system version is independent of the pool version. See
2057 for information on the
2058 .Nm zpool Cm upgrade
2061 In some cases, the file system version and the pool version are interrelated
2062 and the pool version must be upgraded before the file system version can be
2064 .Bl -tag -width indent
2066 Upgrade the specified file system and all descendent file systems.
2068 Upgrade to the specified
2072 flag is not specified, this command upgrades to the most recent version. This
2073 option can only be used to increase the version number, and only up to the most
2074 recent version supported by this software.
2076 Upgrade all file systems on all imported pools.
2078 Upgrade the specified file system.
2084 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2085 .Oo Fl s Ar field Oc Ns ...
2086 .Oo Fl S Ar field Oc Ns ...
2087 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2088 .Ar filesystem Ns | Ns Ar snapshot
2091 Displays space consumed by, and quotas on, each user in the specified
2092 filesystem or snapshot. This corresponds to the
2093 .Sy userused@ Ns Ar user
2095 .Sy userquota@ Ns Ar user
2097 .Bl -tag -width indent
2099 Print numeric ID instead of user/group name.
2101 Do not print headers, use tab-delimited output.
2103 Use exact (parsable) numeric output.
2104 .It Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2105 Display only the specified fields from the following set:
2106 .Sy type,name,used,quota .
2107 The default is to display all fields.
2109 Sort output by this field. The
2113 flags may be specified multiple times to sort first by one field, then by
2114 another. The default is
2115 .Fl s Cm type Fl s Cm name .
2117 Sort by this field in reverse order. See
2119 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2120 Print only the specified types from the following set:
2121 .Sy all,posixuser,smbuser,posixgroup,smbgroup .
2124 .Fl t Cm posixuser,smbuser .
2126 The default can be changed to include group types.
2128 Translate SID to POSIX ID. This flag currently has no effect on
2135 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2136 .Oo Fl s Ar field Oc Ns ...
2137 .Oo Fl S Ar field Oc Ns ...
2138 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2139 .Ar filesystem Ns | Ns Ar snapshot
2142 Displays space consumed by, and quotas on, each group in the specified
2143 filesystem or snapshot. This subcommand is identical to
2144 .Qq Nm Cm userspace ,
2145 except that the default types to display are
2146 .Fl t Sy posixgroup,smbgroup .
2154 file systems currently mounted.
2155 .Bl -tag -width indent
2162 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2163 .Fl a | Ar filesystem
2169 .Bl -tag -width indent
2171 Report mount progress.
2173 Perform an overlay mount. Overlay mounts are not supported on
2175 .It Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2176 An optional, comma-separated list of mount options to use temporarily for the
2177 duration of the mount. See the
2178 .Qq Sx Temporary Mount Point Properties
2179 section for details.
2184 This command may be executed on
2188 For more information, see variable
2193 Mount the specified filesystem.
2199 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
2202 Unmounts currently mounted
2205 .Bl -tag -width indent
2207 Forcefully unmount the file system, even if it is currently in use.
2209 Unmount all available
2212 .It Ar filesystem | mountpoint
2213 Unmount the specified filesystem. The command can also be given a path to a
2215 file system mount point on the system.
2220 .Fl a | Ar filesystem
2225 file systems that have the
2228 .Bl -tag -width indent
2232 file systems that have the
2235 This command may be executed on
2239 For more information, see variable
2244 Share the specified filesystem according to the
2246 property. File systems are shared when the
2253 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
2258 file systems that have the
2261 .Bl -tag -width indent
2265 file systems that have the
2268 This command may be executed on
2272 For more information, see variable
2276 .It Ar filesystem | mountpoint
2277 Unshare the specified filesystem. The command can also be given a path to a
2279 file system shared on the system.
2285 .Op Fl i Ar snapshot | Fl I Ar snapshot
2289 Creates a stream representation of the last
2291 argument (not part of
2295 which is written to standard output. The output can be redirected to
2296 a file or to a different system (for example, using
2298 By default, a full stream is generated.
2299 .Bl -tag -width indent
2300 .It Fl i Ar snapshot
2301 Generate an incremental stream from the
2305 The incremental source (the
2307 can be specified as the last component of the snapshot name (for example, the
2310 and it is assumed to be from the same file system as the last
2313 If the destination is a clone, the source may be the origin snapshot, which
2314 must be fully specified (for example,
2315 .Cm pool/fs@origin ,
2318 .It Fl I Ar snapshot
2319 Generate a stream package that sends all intermediary snapshots from the
2326 .Ic -i @a fs@b; -i @b fs@c; -i @c fs@d .
2327 The incremental source snapshot may be specified as with the
2331 Generate a replication stream package, which will replicate the specified
2332 filesystem, and all descendent file systems, up to the named snapshot. When
2333 received, all properties, snapshots, descendent file systems, and clones are
2340 flags are used in conjunction with the
2342 flag, an incremental replication stream is generated. The current values of
2343 properties, and current snapshot and file system names are set when the stream
2346 flag is specified when this stream is received, snapshots and file systems that
2347 do not exist on the sending side are destroyed.
2349 Generate a deduplicated stream. Blocks which would have been sent multiple
2350 times in the send stream will only be sent once. The receiving system must
2351 also support this feature to receive a deduplicated stream. This flag can
2352 be used regardless of the dataset's
2354 property, but performance will be much better if the filesystem uses a
2355 dedup-capable checksum (eg.
2358 Include the dataset's properties in the stream. This flag is implicit when
2360 is specified. The receiving system must also support this feature.
2362 Do a dry-run ("No-op") send. Do not generate any actual send data. This is
2363 useful in conjunction with the
2367 flags to determine what data will be sent.
2369 Print machine-parsable verbose information about the stream package generated.
2371 Print verbose information about the stream package generated.
2372 This information includes a per-second report of how much data has been sent.
2375 The format of the stream is committed. You will be able to receive your streams
2376 on future versions of
2382 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2392 Creates a snapshot whose contents are as specified in the stream provided on
2393 standard input. If a full stream is received, then a new file system is created
2394 as well. Streams are created using the
2396 subcommand, which by default creates a full stream.
2398 can be used as an alias for
2401 If an incremental stream is received, then the destination file system must
2402 already exist, and its most recent snapshot must match the incremental stream's
2405 the destination device link is destroyed and recreated, which means the
2407 cannot be accessed during the
2411 When a snapshot replication package stream that is generated by using the
2413 command is received, any snapshots that do not exist on the sending location
2414 are destroyed by using the
2415 .Qq Nm Cm destroy Fl d
2418 The name of the snapshot (and file system, if a full stream is received) that
2419 this subcommand creates depends on the argument type and the
2425 If the argument is a snapshot name, the specified
2427 is created. If the argument is a file system or volume name, a snapshot with
2428 the same name as the sent snapshot is created within the specified
2436 option is specified, the snapshot name is determined by appending the sent
2437 snapshot's name to the specified
2441 option is specified, all but the pool name of the sent snapshot path is
2442 appended (for example,
2444 appended from sent snapshot
2448 option is specified, only the tail of the sent snapshot path is appended (for
2451 appended from sent snapshot
2455 any file systems needed to replicate the path of the sent snapshot are created
2456 within the specified file system.
2457 .Bl -tag -width indent
2459 Use the full sent snapshot path without the first element (without pool name)
2460 to determine the name of the new snapshot as described in the paragraph above.
2462 Use only the last element of the sent snapshot path to determine the name of
2463 the new snapshot as described in the paragraph above.
2465 File system that is associated with the received stream is not mounted.
2467 Print verbose information about the stream and the time required to perform the
2470 Do not actually receive the stream. This can be useful in conjunction with the
2472 option to verify the name the receive operation would use.
2474 Force a rollback of the file system to the most recent snapshot before
2475 performing the receive operation. If receiving an incremental replication
2476 stream (for example, one generated by
2477 .Qq Nm Cm send Fl R Fi iI ) ,
2478 destroy snapshots and file systems that do not exist on the sending side.
2483 .Ar filesystem Ns | Ns Ar volume
2486 Displays permissions that have been delegated on the specified filesystem or
2487 volume. See the other forms of
2489 for more information.
2494 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
2495 .Ar perm Ns | Ns Ar @setname Ns
2496 .Oo Ns , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
2497 .Ar filesystem Ns | Ns Ar volume
2503 .Fl e Ns | Ns Cm everyone
2504 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
2506 .Ar filesystem Ns | Ns Ar volume
2511 administration permission for the file systems to non-privileged users.
2512 .Bl -tag -width indent
2515 .Ar user Ns | Ns Ar group Ns Oo , Ar user Ns | Ns Ar group Oc Ns ...
2517 Specifies to whom the permissions are delegated. Multiple entities can be
2518 specified as a comma-separated list. If neither of the
2520 options are specified, then the argument is interpreted preferentially as the
2523 then as a user name, and lastly as a group name. To specify
2524 a user or group named
2530 options. To specify a group with the same name as a user, use the
2533 .It Op Fl e Ns | Ns Cm everyone
2534 Specifies that the permissions be delegated to
2537 .Ar perm Ns | Ns Ar @setname Ns Oo , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
2539 The permissions to delegate. Multiple permissions
2540 may be specified as a comma-separated list. Permission names are the same as
2542 subcommand and property names. See the property list below. Property set names,
2543 which begin with an at sign
2545 may be specified. See the
2547 form below for details.
2550 .Ar filesystem Ns | Ns Ar volume
2552 Specifies where the permissions are delegated. If neither of the
2554 options are specified, or both are, then the permissions are allowed for the
2555 file system or volume, and all of its descendents. If only the
2557 option is used, then is allowed "locally" only for the specified file system.
2560 option is used, then is allowed only for the descendent file systems.
2563 Permissions are generally the ability to use a
2565 subcommand or change a
2567 property. The following permissions are available:
2568 .Bl -column -offset 4n "secondarycache" "subcommand"
2569 .It NAME Ta TYPE Ta NOTES
2570 .It allow Ta subcommand Ta Must Xo
2571 also have the permission that is being allowed
2573 .It clone Ta subcommand Ta Must Xo
2574 also have the 'create' ability and 'mount' ability in the origin file system
2576 .It create Ta subcommand Ta Must also have the 'mount' ability
2577 .It destroy Ta subcommand Ta Must also have the 'mount' ability
2578 .It diff Ta subcommand Ta Allows lookup of paths within a dataset given an
2579 object number, and the ability to create snapshots necessary to 'zfs diff'
2580 .It hold Ta subcommand Ta Allows adding a user hold to a snapshot
2581 .It mount Ta subcommand Ta Allows mount/umount of Tn ZFS No datasets
2582 .It promote Ta subcommand Ta Must Xo
2583 also have the 'mount' and 'promote' ability in the origin file system
2585 .It receive Ta subcommand Ta Must also have the 'mount' and 'create' ability
2586 .It release Ta subcommand Ta Allows Xo
2587 releasing a user hold which might destroy the snapshot
2589 .It rename Ta subcommand Ta Must Xo
2590 also have the 'mount' and 'create' ability in the new parent
2592 .It rollback Ta subcommand Ta Must also have the 'mount' ability
2593 .It send Ta subcommand
2594 .It share Ta subcommand Ta Allows Xo
2595 sharing file systems over the
2599 .It snapshot Ta subcommand Ta Must also have the 'mount' ability
2600 .It groupquota Ta other Ta Allows accessing any groupquota@... property
2601 .It groupused Ta other Ta Allows reading any groupused@... property
2602 .It userprop Ta other Ta Allows changing any user property
2603 .It userquota Ta other Ta Allows accessing any userquota@... property
2604 .It userused Ta other Ta Allows reading any userused@... property
2605 .It aclinherit Ta property
2606 .It aclmode Ta property
2607 .It atime Ta property
2608 .It canmount Ta property
2609 .It casesensitivity Ta property
2610 .It checksum Ta property
2611 .It compression Ta property
2612 .It copies Ta property
2613 .It dedup Ta property
2614 .It devices Ta property
2615 .It exec Ta property
2616 .It logbias Ta property
2617 .It jailed Ta property
2618 .It mlslabel Ta property
2619 .It mountpoint Ta property
2620 .It nbmand Ta property
2621 .It normalization Ta property
2622 .It primarycache Ta property
2623 .It quota Ta property
2624 .It readonly Ta property
2625 .It recordsize Ta property
2626 .It refquota Ta property
2627 .It refreservation Ta property
2628 .It reservation Ta property
2629 .It secondarycache Ta property
2630 .It setuid Ta property
2631 .It sharenfs Ta property
2632 .It sharesmb Ta property
2633 .It snapdir Ta property
2634 .It sync Ta property
2635 .It utf8only Ta property
2636 .It version Ta property
2637 .It volblocksize Ta property
2638 .It volsize Ta property
2639 .It vscan Ta property
2640 .It xattr Ta property
2646 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
2648 .Ar filesystem Ns | Ns Ar volume
2651 Sets "create time" permissions. These permissions are granted (locally) to the
2652 creator of any newly-created descendent file system.
2658 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
2660 .Ar filesystem Ns | Ns Ar volume
2663 Defines or adds permissions to a permission set. The set can be used by other
2665 commands for the specified file system and its descendents. Sets are evaluated
2666 dynamically, so changes to a set are immediately reflected. Permission sets
2667 follow the same naming restrictions as ZFS file systems, but the name must
2668 begin with an "at sign"
2670 and can be no more than 64 characters long.
2675 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
2676 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
2678 .Ar filesystem Ns | Ns Ar volume
2684 .Fl e Ns | Ns Cm everyone
2685 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
2687 .Ar filesystem Ns | Ns Ar volume
2694 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
2696 .Ar filesystem Ns | Ns Ar volume
2699 Removes permissions that were granted with the
2701 command. No permissions are explicitly denied, so other permissions granted are
2702 still in effect. For example, if the permission is granted by an ancestor. If
2703 no permissions are specified, then all permissions for the specified
2704 .Ar user , group , No or everyone
2705 are removed. Specifying
2707 .Po or using the Fl e
2709 .Pc only removes the permissions that were granted to everyone ,
2710 not all permissions for every user and group. See the
2712 command for a description of the
2715 .Bl -tag -width indent
2717 Recursively remove the permissions from this file system and all descendents.
2725 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
2727 .Ar filesystem Ns | Ns Ar volume
2730 Removes permissions from a permission set. If no permissions are specified,
2731 then all permissions are removed, thus removing the set entirely.
2736 .Ar tag snapshot Ns ...
2739 Adds a single reference, named with the
2741 argument, to the specified snapshot or snapshots. Each snapshot has its own tag
2742 namespace, and tags must be unique within that space.
2744 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
2748 .Bl -tag -width indent
2750 Specifies that a hold with the given tag is applied recursively to the
2751 snapshots of all descendent file systems.
2760 Lists all existing user references for the given snapshot or snapshots.
2761 .Bl -tag -width indent
2763 Lists the holds that are set on the named descendent snapshots, in addition to
2764 listing the holds on the named snapshot.
2770 .Ar tag snapshot Ns ...
2773 Removes a single reference, named with the
2775 argument, from the specified snapshot or snapshots. The tag must already exist
2777 .Bl -tag -width indent
2779 Recursively releases a hold with the given tag on the snapshots of all
2780 descendent file systems.
2787 .Op Ar snapshot Ns | Ns Ar filesystem
2790 Display the difference between a snapshot of a given filesystem and another
2791 snapshot of that filesystem from a later time or the current contents of the
2792 filesystem. The first column is a character indicating the type of change,
2793 the other columns indicate pathname, new pathname
2794 .Pq in case of rename ,
2795 change in link count, and optionally file type and/or change time.
2797 The types of change are:
2798 .Bl -column -offset 2n indent
2799 .It \&- Ta path was removed
2800 .It \&+ Ta path was added
2801 .It \&M Ta path was modified
2802 .It \&R Ta path was renamed
2804 .Bl -tag -width indent
2806 Display an indication of the type of file, in a manner similar to the
2810 .Bl -column -offset 2n indent
2811 .It \&B Ta block device
2812 .It \&C Ta character device
2813 .It \&F Ta regular file
2814 .It \&/ Ta directory
2815 .It \&@ Ta symbolic link
2817 .It \&> Ta door (not supported on Fx )
2818 .It \&| Ta named pipe (not supported on Fx )
2819 .It \&P Ta event port (not supported on Fx )
2822 Give more parseable tab-separated output, without header lines and without
2825 Display the path's inode change time as the first column of output.
2830 .Ar jailid filesystem
2833 Attaches the specified
2835 to the jail identified by JID
2837 From now on this file system tree can be managed from within a jail if the
2839 property has been set. To use this functionality, the jail needs the
2843 parameters set to 1 and the
2845 parameter set to a value lower than 2.
2849 for more information on managing jails and configuring the parameters above.
2853 .Ar jailid filesystem
2856 Detaches the specified
2858 from the jail identified by JID
2862 The following exit values are returned:
2863 .Bl -tag -offset 2n -width 2n
2865 Successful completion.
2869 Invalid command line options were specified.
2873 .It Sy Example 1 No Creating a Tn ZFS No File System Hierarchy
2875 The following commands create a file system named
2877 and a file system named
2881 is set for the parent file system, and is automatically inherited by the child
2883 .Bd -literal -offset 2n
2884 .Li # Ic zfs create pool/home
2885 .Li # Ic zfs set mountpoint=/home pool/home
2886 .Li # Ic zfs create pool/home/bob
2888 .It Sy Example 2 No Creating a Tn ZFS No Snapshot
2890 The following command creates a snapshot named
2892 This snapshot is mounted on demand in the
2894 directory at the root of the
2897 .Bd -literal -offset 2n
2898 .Li # Ic zfs snapshot pool/home/bob@yesterday
2900 .It Sy Example 3 No Creating and Destroying Multiple Snapshots
2902 The following command creates snapshots named
2906 and all of its descendent file systems. Each snapshot is mounted on demand in
2909 directory at the root of its file system. The second command destroys the newly
2911 .Bd -literal -offset 2n
2912 .Li # Ic zfs snapshot -r pool/home@yesterday
2913 .Li # Ic zfs destroy -r pool/home@yesterday
2915 .It Sy Example 4 No Disabling and Enabling File System Compression
2917 The following command disables the
2919 property for all file systems under
2921 The next command explicitly enables
2924 .Em pool/home/anne .
2925 .Bd -literal -offset 2n
2926 .Li # Ic zfs set compression=off pool/home
2927 .Li # Ic zfs set compression=on pool/home/anne
2929 .It Sy Example 5 No Listing Tn ZFS No Datasets
2931 The following command lists all active file systems and volumes in the system.
2932 Snapshots are displayed if the
2940 for more information on pool properties.
2941 .Bd -literal -offset 2n
2943 NAME USED AVAIL REFER MOUNTPOINT
2944 pool 450K 457G 18K /pool
2945 pool/home 315K 457G 21K /home
2946 pool/home/anne 18K 457G 18K /home/anne
2947 pool/home/bob 276K 457G 276K /home/bob
2949 .It Sy Example 6 No Setting a Quota on a Tn ZFS No File System
2951 The following command sets a quota of 50 Gbytes for
2953 .Bd -literal -offset 2n
2954 .Li # Ic zfs set quota=50G pool/home/bob
2956 .It Sy Example 7 No Listing Tn ZFS No Properties
2958 The following command lists all properties for
2960 .Bd -literal -offset 2n
2961 .Li # Ic zfs get all pool/home/bob
2962 NAME PROPERTY VALUE SOURCE
2963 pool/home/bob type filesystem -
2964 pool/home/bob creation Tue Jul 21 15:53 2009 -
2965 pool/home/bob used 21K -
2966 pool/home/bob available 20.0G -
2967 pool/home/bob referenced 21K -
2968 pool/home/bob compressratio 1.00x -
2969 pool/home/bob mounted yes -
2970 pool/home/bob quota 20G local
2971 pool/home/bob reservation none default
2972 pool/home/bob recordsize 128K default
2973 pool/home/bob mountpoint /home/bob default
2974 pool/home/bob sharenfs off default
2975 pool/home/bob checksum on default
2976 pool/home/bob compression on local
2977 pool/home/bob atime on default
2978 pool/home/bob devices on default
2979 pool/home/bob exec on default
2980 pool/home/bob setuid on default
2981 pool/home/bob readonly off default
2982 pool/home/bob jailed off default
2983 pool/home/bob snapdir hidden default
2984 pool/home/bob aclmode discard default
2985 pool/home/bob aclinherit restricted default
2986 pool/home/bob canmount on default
2987 pool/home/bob xattr on default
2988 pool/home/bob copies 1 default
2989 pool/home/bob version 5 -
2990 pool/home/bob utf8only off -
2991 pool/home/bob normalization none -
2992 pool/home/bob casesensitivity sensitive -
2993 pool/home/bob vscan off default
2994 pool/home/bob nbmand off default
2995 pool/home/bob sharesmb off default
2996 pool/home/bob refquota none default
2997 pool/home/bob refreservation none default
2998 pool/home/bob primarycache all default
2999 pool/home/bob secondarycache all default
3000 pool/home/bob usedbysnapshots 0 -
3001 pool/home/bob usedbydataset 21K -
3002 pool/home/bob usedbychildren 0 -
3003 pool/home/bob usedbyrefreservation 0 -
3004 pool/home/bob logbias latency default
3005 pool/home/bob dedup off default
3006 pool/home/bob mlslabel -
3007 pool/home/bob sync standard default
3008 pool/home/bob refcompressratio 1.00x -
3011 The following command gets a single property value.
3012 .Bd -literal -offset 2n
3013 .Li # Ic zfs get -H -o value compression pool/home/bob
3017 The following command lists all properties with local settings for
3019 .Bd -literal -offset 2n
3020 .Li # Ic zfs get -s local -o name,property,value all pool/home/bob
3022 pool/home/bob quota 20G
3023 pool/home/bob compression on
3025 .It Sy Example 8 No Rolling Back a Tn ZFS No File System
3027 The following command reverts the contents of
3029 to the snapshot named
3031 deleting all intermediate snapshots.
3032 .Bd -literal -offset 2n
3033 .Li # Ic zfs rollback -r pool/home/anne@yesterday
3035 .It Sy Example 9 No Creating a Tn ZFS No Clone
3037 The following command creates a writable file system whose initial contents are
3039 .Em pool/home/bob@yesterday .
3040 .Bd -literal -offset 2n
3041 .Li # Ic zfs clone pool/home/bob@yesterday pool/clone
3043 .It Sy Example 10 No Promoting a Tn ZFS No Clone
3045 The following commands illustrate how to test out changes to a file system, and
3046 then replace the original file system with the changed one, using clones, clone
3047 promotion, and renaming:
3048 .Bd -literal -offset 2n
3049 .Li # Ic zfs create pool/project/production
3053 .Pa /pool/project/production
3054 with data and continue with the following commands:
3055 .Bd -literal -offset 2n
3056 .Li # Ic zfs snapshot pool/project/production@today
3057 .Li # Ic zfs clone pool/project/production@today pool/project/beta
3061 .Pa /pool/project/beta
3062 and continue with the following commands:
3063 .Bd -literal -offset 2n
3064 .Li # Ic zfs promote pool/project/beta
3065 .Li # Ic zfs rename pool/project/production pool/project/legacy
3066 .Li # Ic zfs rename pool/project/beta pool/project/production
3069 Once the legacy version is no longer needed, it can be destroyed.
3070 .Bd -literal -offset 2n
3071 .Li # Ic zfs destroy pool/project/legacy
3073 .It Sy Example 11 No Inheriting Tn ZFS No Properties
3075 The following command causes
3081 property from their parent.
3082 .Bd -literal -offset 2n
3083 .Li # Ic zfs inherit checksum pool/home/bob pool/home/anne
3085 .It Sy Example 12 No Remotely Replicating Tn ZFS No Data
3087 The following commands send a full stream and then an incremental stream to a
3088 remote machine, restoring them into
3089 .Sy poolB/received/fs@a
3091 .Sy poolB/received/fs@b ,
3094 must contain the file system
3095 .Sy poolB/received ,
3096 and must not initially contain
3097 .Sy poolB/received/fs .
3098 .Bd -literal -offset 2n
3099 .Li # Ic zfs send pool/fs@a | ssh host zfs receive poolB/received/fs@a
3100 .Li # Ic zfs send -i a pool/fs@b | ssh host zfs receive poolB/received/fs
3109 The following command sends a full stream of
3110 .Sy poolA/fsA/fsB@snap
3111 to a remote machine, receiving it into
3112 .Sy poolB/received/fsA/fsB@snap .
3115 portion of the received snapshot's name is determined from the name of the sent
3118 must contain the file system
3119 .Sy poolB/received .
3121 .Sy poolB/received/fsA
3122 does not exist, it is created as an empty file system.
3123 .Bd -literal -offset 2n
3124 .Li # Ic zfs send poolA/fsA/fsB@snap | ssh host zfs receive -d poolB/received
3126 .It Sy Example 14 No Setting User Properties
3128 The following example sets the user-defined
3129 .Sy com.example:department
3130 property for a dataset.
3131 .Bd -literal -offset 2n
3132 .Li # Ic zfs set com.example:department=12345 tank/accounting
3134 .It Sy Example 15 No Performing a Rolling Snapshot
3136 The following example shows how to maintain a history of snapshots with a
3137 consistent naming scheme. To keep a week's worth of snapshots, the user
3138 destroys the oldest snapshot, renames the remaining snapshots, and then creates
3139 a new snapshot, as follows:
3140 .Bd -literal -offset 2n
3141 .Li # Ic zfs destroy -r pool/users@7daysago
3142 .Li # Ic zfs rename -r pool/users@6daysago @7daysago
3143 .Li # Ic zfs rename -r pool/users@5daysago @6daysago
3144 .Li # Ic zfs rename -r pool/users@4daysago @5daysago
3145 .Li # Ic zfs rename -r pool/users@3daysago @4daysago
3146 .Li # Ic zfs rename -r pool/users@2daysago @3daysago
3147 .Li # Ic zfs rename -r pool/users@yesterday @2daysago
3148 .Li # Ic zfs rename -r pool/users@today @yesterday
3149 .Li # Ic zfs snapshot -r pool/users@today
3155 Property Options on a ZFS File System
3158 The following command shows how to set
3160 property options to enable root access for a specific network on the
3162 file system. The contents of the
3167 .Bd -literal -offset 2n
3168 .Li # Ic zfs set sharenfs="maproot=root,network 192.168.0.0/24" tank/home
3171 Another way to write this command with the same result is:
3172 .Bd -literal -offset 2n
3173 .Li # Ic set zfs sharenfs="-maproot=root -network 192.168.0.0/24" tank/home
3179 Administration Permissions on a
3184 The following example shows how to set permissions so that user
3186 can create, destroy, mount, and take snapshots on
3191 .Bd -literal -offset 2n
3192 .Li # Ic zfs allow cindys create,destroy,mount,snapshot tank/cindys
3193 .Li # Ic zfs allow tank/cindys
3194 -------------------------------------------------------------
3195 Local+Descendent permissions on (tank/cindys)
3196 user cindys create,destroy,mount,snapshot
3197 -------------------------------------------------------------
3199 .It Sy Example 18 No Delegating Create Time Permissions on a Tn ZFS No Dataset
3201 The following example shows how to grant anyone in the group
3203 to create file systems in
3205 This syntax also allows staff members to destroy their own file systems, but
3206 not destroy anyone else's file system. The permissions on
3209 .Bd -literal -offset 2n
3210 .Li # Ic zfs allow staff create,mount tank/users
3211 .Li # Ic zfs allow -c destroy tank/users
3212 .Li # Ic zfs allow tank/users
3213 -------------------------------------------------------------
3214 Create time permissions on (tank/users)
3216 Local+Descendent permissions on (tank/users)
3217 group staff create,mount
3218 -------------------------------------------------------------
3222 Defining and Granting a Permission Set on a
3227 The following example shows how to define and grant a permission set on the
3229 file system. The permissions on
3232 .Bd -literal -offset 2n
3233 .Li # Ic zfs allow -s @pset create,destroy,snapshot,mount tank/users
3234 .Li # Ic zfs allow staff @pset tank/users
3235 .Li # Ic zfs allow tank/users
3236 -------------------------------------------------------------
3237 Permission sets on (tank/users)
3238 @pset create,destroy,mount,snapshot
3239 Create time permissions on (tank/users)
3241 Local+Descendent permissions on (tank/users)
3242 group staff @pset,create,mount
3243 -------------------------------------------------------------
3245 .It Sy Example 20 No Delegating Property Permissions on a Tn ZFS No Dataset
3247 The following example shows to grant the ability to set quotas and reservations
3250 file system. The permissions on
3253 .Bd -literal -offset 2n
3254 .Li # Ic zfs allow cindys quota,reservation users/home
3255 .Li # Ic zfs allow cindys
3256 -------------------------------------------------------------
3257 Local+Descendent permissions on (users/home)
3258 user cindys quota,reservation
3259 -------------------------------------------------------------
3260 .Li # Ic su - cindys
3261 .Li cindys% Ic zfs set quota=10G users/home/marks
3262 .Li cindys% Ic zfs get quota users/home/marks
3263 NAME PROPERTY VALUE SOURCE
3264 users/home/marks quota 10G local
3266 .It Sy Example 21 No Removing ZFS Delegated Permissions on a Tn ZFS No Dataset
3268 The following example shows how to remove the snapshot permission from the
3272 file system. The permissions on
3275 .Bd -literal -offset 2n
3276 .Li # Ic zfs unallow staff snapshot tank/users
3277 .Li # Ic zfs allow tank/users
3278 -------------------------------------------------------------
3279 Permission sets on (tank/users)
3280 @pset create,destroy,mount,snapshot
3281 Create time permissions on (tank/users)
3283 Local+Descendent permissions on (tank/users)
3284 group staff @pset,create,mount
3285 -------------------------------------------------------------
3287 .It Sy Example 22 Showing the differences between a snapshot and a ZFS Dataset
3289 The following example shows how to see what has changed between a prior
3290 snapshot of a ZFS Dataset and its current state. The
3292 option is used to indicate type information for the files affected.
3293 .Bd -literal -offset 2n
3294 .Li # Ic zfs diff tank/test@before tank/test
3296 M F /tank/test/linked (+1)
3297 R F /tank/test/oldname -> /tank/test/newname
3298 - F /tank/test/deleted
3299 + F /tank/test/created
3300 M F /tank/test/modified
3314 This manual page is a
3316 reimplementation of the
3320 modified and customized for
3322 and licensed under the
3323 Common Development and Distribution License
3328 implementation of this manual page was initially written by
3329 .An Martin Matuska Aq mm@FreeBSD.org .
projects / FreeBSD / releng / 10.0.git / blob