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) 2013 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.
28 .\" Copyright (c) 2013, Steven Hartland <smh@FreeBSD.org>
29 .\" Copyright (c) 2014, Xin LI <delphij@FreeBSD.org>
38 .Nd configures ZFS file systems
45 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... Ar filesystem
50 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
56 .Ar filesystem Ns | Ns Ar volume
61 .Ar filesystem Ns | Ns volume
64 .Op , Ns Ar snap Op % Ns Ar snap
69 .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
71 .Cm snapshot Ns | Ns Cm snap
73 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
74 .Ar filesystem@snapname Ns | Ns Ar volume@snapname
75 .Ar filesystem@snapname Ns | Ns Ar volume@snapname Ns ...
83 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
84 .Ar snapshot filesystem Ns | Ns Ar volume
91 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
92 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
97 .Ar filesystem Ns | Ns Ar volume
98 .Ar filesystem Ns | Ns Ar volume
102 .Ar snapshot snapshot
107 .Ar filesystem filesystem
110 .Op Fl r Ns | Ns Fl d Ar depth
112 .Op Fl o Ar property Ns Oo , Ns property Ns Oc Ns ...
113 .Op Fl t Ar type Ns Oo , Ns type Ns Oc Ns ...
114 .Oo Fl s Ar property Oc Ns ...
115 .Oo Fl S Ar property Oc Ns ...
116 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
119 .Ar property Ns = Ns Ar value
120 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
123 .Op Fl r Ns | Ns Fl d Ar depth
125 .Op Fl o Ar all | field Ns Oo , Ns Ar field Oc Ns ...
126 .Op Fl t Ar type Ns Oo Ns , Ar type Oc Ns ...
127 .Op Fl s Ar source Ns Oo Ns , Ns Ar source Oc Ns ...
128 .Ar all | property Ns Oo Ns , Ns Ar property Oc Ns ...
129 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
134 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
142 .Fl a | Ar filesystem
146 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
147 .Oo Fl s Ar field Oc Ns ...
148 .Oo Fl S Ar field Oc Ns ...
149 .Op Fl t Ar type Ns Oo Ns , Ns Ar type Oc Ns ...
150 .Ar filesystem Ns | Ns Ar snapshot
154 .Op Fl o Ar field Ns Oo , Ns field Oc Ns ...
155 .Oo Fl s Ar field Oc Ns ...
156 .Oo Fl S Ar field Oc Ns ...
157 .Op Fl t Ar type Ns Oo Ns , Ns Ar type Oc Ns ...
158 .Ar filesystem Ns | Ns Ar snapshot
164 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
165 .Fl a | Ar filesystem
167 .Cm unmount Ns | Ns Cm umount
169 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
172 .Fl a | Ar filesystem
175 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
183 .Op Fl i Ar snapshot | Fl I Ar snapshot
187 .Op Fl i Ar snapshot Ns | Ns bookmark
188 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
190 .Cm receive Ns | Ns Cm recv
192 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
194 .Cm receive Ns | Ns Cm recv
200 .Ar filesystem Ns | Ns Ar volume
204 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
205 .Ar perm Ns | Ns Ar @setname Ns
206 .Oo Ns , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
207 .Ar filesystem Ns | Ns Ar volume
211 .Fl e Ns | Ns Cm everyone
212 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
214 .Ar filesystem Ns | Ns Ar volume
218 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
220 .Ar filesystem Ns | Ns Ar volume
225 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
227 .Ar filesystem Ns | Ns Ar volume
231 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
232 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
234 .Ar filesystem Ns | Ns Ar volume
238 .Fl e Ns | Ns Cm everyone
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
246 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
248 .Ar filesystem Ns | Ns Ar volume
254 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
256 .Ar filesystem Ns | Ns Ar volume
260 .Ar tag snapshot Ns ...
268 .Ar tag snapshot Ns ...
273 .Op Ar snapshot Ns | Ns Ar filesystem
276 .Ar jailid Ns | Ns Ar jailname filesystem
279 .Ar jailid Ns | Ns Ar jailname filesystem
287 storage pool, as described in
289 A dataset is identified by a unique path within the
291 namespace. For example:
292 .Bd -ragged -offset 4n
293 .No pool/ Ns Brq filesystem,volume,snapshot
296 where the maximum length of a dataset name is
300 A dataset can be one of the following:
307 can be mounted within the standard system namespace and behaves like other file
310 file systems are designed to be
312 compliant, known issues exist that prevent compliance in some cases.
313 Applications that depend on standards conformance might fail due to nonstandard
314 behavior when checking file system free space.
316 A logical volume exported as a raw or block device. This type of dataset should
317 only be used under special circumstances. File systems are typically used in
320 A read-only version of a file system or volume at a given point in time. It is
326 .Ss ZFS File System Hierarchy
329 storage pool is a logical collection of devices that provide space for
330 datasets. A storage pool is also the root of the
332 file system hierarchy.
334 The root of the pool can be accessed as a file system, such as mounting and
335 unmounting, taking snapshots, and setting properties. The physical storage
336 characteristics, however, are managed by the
342 for more information on creating and administering pools.
344 A snapshot is a read-only copy of a file system or volume. Snapshots can be
345 created extremely quickly, and initially consume no additional space within the
346 pool. As data within the active dataset changes, the snapshot consumes more
347 data than would otherwise be shared with the active dataset.
349 Snapshots can have arbitrary names. Snapshots of volumes can be cloned or
350 rolled back, but cannot be accessed independently.
352 File system snapshots can be accessed under the
354 directory in the root of the file system. Snapshots are automatically mounted
355 on demand and may be unmounted at regular intervals. The visibility of the
357 directory can be controlled by the
361 A clone is a writable volume or file system whose initial contents are the same
362 as another dataset. As with snapshots, creating a clone is nearly
363 instantaneous, and initially consumes no additional space.
365 Clones can only be created from a snapshot. When a snapshot is cloned, it
366 creates an implicit dependency between the parent and child. Even though the
367 clone is created somewhere else in the dataset hierarchy, the original snapshot
368 cannot be destroyed as long as a clone exists. The
370 property exposes this dependency, and the
372 command lists any such dependencies, if they exist.
374 The clone parent-child dependency relationship can be reversed by using the
376 subcommand. This causes the "origin" file system to become a clone of the
377 specified file system, which makes it possible to destroy the file system that
378 the clone was created from.
382 file system is a simple operation, so the number of file systems per system is
383 likely to be numerous. To cope with this,
385 automatically manages mounting and unmounting file systems without the need to
388 file. All automatically managed file systems are mounted by
392 By default, file systems are mounted under
396 is the name of the file system in the
398 namespace. Directories are created and destroyed as needed.
400 A file system can also have a mount point set in the
402 property. This directory is created as needed, and
404 automatically mounts the file system when the
406 command is invoked (without editing
410 property can be inherited, so if
416 automatically inherits a mount point of
423 prevents the file system from being mounted.
427 file systems can also be managed with traditional tools
428 .Pq Xr mount 8 , Xr umount 8 , Xr fstab 5 .
429 If a file system's mount point is set to
432 makes no attempt to manage the file system, and the administrator is
433 responsible for mounting and unmounting the file system.
436 dataset can be attached to a jail by using the
438 subcommand. You cannot attach a dataset to one jail and the children of the
439 same dataset to another jails. To allow management of the dataset from within
442 property has to be set and the jail needs access to the
446 property cannot be changed from within a jail. See
448 for information on how to allow mounting
450 datasets from within a jail.
453 dataset can be detached from a jail using the
457 After a dataset is attached to a jail and the jailed property is set, a jailed
458 file system cannot be mounted outside the jail, since the jail administrator
459 might have set the mount point to an unacceptable value.
461 Deduplication is the process for removing redundant data at the block-level,
462 reducing the total amount of data stored. If a file system has the
464 property enabled, duplicate data blocks are removed synchronously. The result
465 is that only unique data is stored and common components are shared among
467 .Ss Native Properties
468 Properties are divided into two types, native properties and user-defined (or
469 "user") properties. Native properties either export internal statistics or
472 behavior. In addition, native properties are either editable or read-only. User
473 properties have no effect on
475 behavior, but you can use them to annotate datasets in a way that is meaningful
476 in your environment. For more information about user properties, see the
477 .Qq Sx User Properties
480 Every dataset has a set of properties that export statistics about the dataset
481 as well as control various behaviors. Properties are inherited from the parent
482 unless overridden by the child. Some properties apply only to certain types of
483 datasets (file systems, volumes, or snapshots).
485 The values of numeric properties can be specified using human-readable suffixes
487 .Sy k , KB , M , Gb ,
490 for zettabyte). The following are all valid (and equal) specifications:
491 .Bd -ragged -offset 4n
495 The values of non-numeric properties are case sensitive and must be lowercase,
497 .Sy mountpoint , sharenfs , No and Sy sharesmb .
499 The following native properties consist of read-only statistics about the
500 dataset. These properties can be neither set, nor inherited. Native properties
501 apply to all dataset types unless otherwise noted.
504 The amount of space available to the dataset and all its children, assuming
505 that there is no other activity in the pool. Because space is shared within a
506 pool, availability can be limited by any number of factors, including physical
507 pool size, quotas, reservations, or other datasets within the pool.
509 This property can also be referred to by its shortened column name,
512 For non-snapshots, the compression ratio achieved for the
514 space of this dataset, expressed as a multiplier. The
516 property includes descendant datasets, and, for clones, does not include
517 the space shared with the origin snapshot. For snapshots, the
521 property. Compression can be turned on by running:
522 .Qq Nm Cm set compression=on Ar dataset
526 The time this dataset was created.
528 For snapshots, this property is a comma-separated list of filesystems or
529 volumes which are clones of this snapshot. The clones'
531 property is this snapshot. If the
533 property is not empty, then this snapshot can not be destroyed (even with the
541 if the snapshot has been marked for deferred destroy by using the
543 command. Otherwise, the property is
545 .It Sy logicalreferenced
546 The amount of space that is
548 accessible by this dataset.
552 The logical space ignores the effect of the
556 properties, giving a quantity closer to the amount of data that applications
558 However, it does include space consumed by metadata.
560 This property can also be referred to by its shortened column name,
563 The amount of space that is
565 consumed by this dataset and all its descendents.
569 The logical space ignores the effect of the
573 properties, giving a quantity closer to the amount of data that applications
576 This property can also be referred to by its shortened column name,
579 For file systems, indicates whether the file system is currently mounted. This
580 property can be either
585 For cloned file systems or volumes, the snapshot from which the clone was
586 created. See also the
590 The amount of data that is accessible by this dataset, which may or may not be
591 shared with other datasets in the pool. When a snapshot or clone is created, it
592 initially references the same amount of space as the file system or snapshot it
593 was created from, since its contents are identical.
595 This property can also be referred to by its shortened column name,
597 .It Sy refcompressratio
598 The compression ratio achieved for the
600 space of this dataset, expressed as a multiplier. See also the
605 .Sy filesystem , volume , No or Sy snapshot .
607 The amount of space consumed by this dataset and all its descendents. This is
608 the value that is checked against this dataset's quota and reservation. The
609 space used does not include this dataset's reservation, but does take into
610 account the reservations of any descendent datasets. The amount of space that a
611 dataset consumes from its parent, as well as the amount of space that are freed
612 if this dataset is recursively destroyed, is the greater of its space used and
615 When snapshots (see the
617 section) are created, their space is
618 initially shared between the snapshot and the file system, and possibly with
619 previous snapshots. As the file system changes, space that was previously
620 shared becomes unique to the snapshot, and counted in the snapshot's space
621 used. Additionally, deleting snapshots can increase the amount of space unique
622 to (and used by) other snapshots.
624 The amount of space used, available, or referenced does not take into account
625 pending changes. Pending changes are generally accounted for within a few
626 seconds. Committing a change to a disk using
630 does not necessarily guarantee that the space usage information is updated
635 properties decompose the
637 properties into the various reasons that space is used. Specifically,
639 .Sy usedbysnapshots + usedbydataset + usedbychildren + usedbyrefreservation .
640 These properties are only available for datasets created
643 pool version 13 pools and higher.
644 .It Sy usedbysnapshots
645 The amount of space consumed by snapshots of this dataset. In particular, it is
646 the amount of space that would be freed if all of this dataset's snapshots were
647 destroyed. Note that this is not simply the sum of the snapshots'
649 properties because space can be shared by multiple snapshots.
651 The amount of space used by this dataset itself, which would be freed if the
652 dataset were destroyed (after first removing any
654 and destroying any necessary snapshots or descendents).
655 .It Sy usedbychildren
656 The amount of space used by children of this dataset, which would be freed if
657 all the dataset's children were destroyed.
658 .It Sy usedbyrefreservation
659 The amount of space used by a
661 set on this dataset, which would be freed if the
664 .It Sy userused@ Ns Ar user
665 The amount of space consumed by the specified user in this dataset. Space is
666 charged to the owner of each file, as displayed by
668 The amount of space charged is displayed by
674 subcommand for more information.
676 Unprivileged users can access only their own space usage. The root user, or a
677 user who has been granted the
681 can access everyone's usage.
685 properties are not displayed by
687 The user's name must be appended after the
689 symbol, using one of the following forms:
690 .Bl -bullet -offset 2n
692 POSIX name (for example,
695 POSIX numeric ID (for example,
699 This property is set to the number of user holds on this snapshot. User holds
703 .It Sy groupused@ Ns Ar group
704 The amount of space consumed by the specified group in this dataset. Space is
705 charged to the group of each file, as displayed by
708 .Sy userused@ Ns Ar user
709 property for more information.
711 Unprivileged users can only access their own groups' space usage. The root
712 user, or a user who has been granted the
716 can access all groups' usage.
717 .It Sy volblocksize Ns = Ns Ar blocksize
718 For volumes, specifies the block size of the volume. The
720 cannot be changed once the volume has been written, so it should be set at
721 volume creation time. The default
723 for volumes is 8 Kbytes. Any
724 power of 2 from 512 bytes to 128 Kbytes is valid.
726 This property can also be referred to by its shortened column name,
731 space written to this dataset since the previous snapshot.
732 .It Sy written@ Ns Ar snapshot
735 space written to this dataset since the specified snapshot. This is the space
736 that is referenced by this dataset but was not referenced by the specified
741 may be specified as a short snapshot name (just the part after the
743 in which case it will be interpreted as a snapshot in the same filesystem as
746 may be a full snapshot name
747 .Pq Em filesystem@snapshot ,
748 which for clones may be a snapshot in the origin's filesystem (or the origin of
749 the origin's filesystem, etc).
752 The following native properties can be used to change the behavior of a
757 .Sy aclinherit Ns = Ns Cm discard |
765 entries are inherited when files and directories are created. A file system
772 entries. A file system with an
776 only inherits inheritable
778 entries that specify "deny" permissions. The property value
780 (the default) removes the
786 entry is inherited. A file system with an
790 inherits all inheritable
792 entries without any modifications made to the
794 entries when they are inherited. A file system with an
798 has the same meaning as
801 .Em owner@ , group@ , No and Em everyone@ Tn ACE Ns s
802 inherit the execute permission only if the file creation mode also requests the
805 When the property value is set to
807 files are created with a mode determined by the inheritable
811 exist that affect the mode, then the mode is set in accordance to the requested
812 mode from the application.
813 .It Sy aclmode Ns = Ns Cm discard | groupmask | passthrough | restricted
818 A file system with an
822 (the default) deletes all
824 entries that do not represent the mode of the file. An
828 reduces permissions granted in all
832 such that they are no greater than the group permissions specified by
834 A file system with an
838 indicates that no changes are made to the
840 other than creating or updating the necessary
842 entries to represent the new mode of the file or directory.
849 operation to return an error when used on any file or directory which has
852 whose entries can not be represented by a mode.
854 is required to change the set user ID, set group ID, or sticky bits on a file
855 or directory, as they do not have equivalent
860 on a file or directory with a non-trivial
866 you must first remove all
868 entries which do not represent the current mode.
869 .It Sy atime Ns = Ns Cm on | off
870 Controls whether the access time for files is updated when they are read.
871 Turning this property off avoids producing write traffic when reading files and
872 can result in significant performance gains, though it might confuse mailers
873 and other similar utilities. The default value is
875 .It Sy canmount Ns = Ns Cm on | off | noauto
876 If this property is set to
878 the file system cannot be mounted, and is ignored by
879 .Qq Nm Cm mount Fl a .
880 Setting this property to
882 is similar to setting the
886 except that the dataset still has a normal
888 property, which can be inherited. Setting this property to
890 allows datasets to be used solely as a mechanism to inherit properties. One
892 .Sy canmount Ns = Ns Cm off
893 is to have two datasets with the same
895 so that the children of both datasets appear in the same directory, but might
896 have different inherited characteristics.
900 value is set, a dataset can only be mounted and unmounted explicitly. The
901 dataset is not mounted automatically when the dataset is created or imported,
902 nor is it mounted by the
904 command or unmounted by the
905 .Qq Nm Cm umount Fl a
908 This property is not inherited.
909 .It Sy checksum Ns = Ns Cm on | off | fletcher2 | fletcher4 | sha256 | noparity
910 Controls the checksum used to verify data integrity. The default value is
912 which automatically selects an appropriate algorithm (currently,
914 but this may change in future releases). The value
916 disables integrity checking on user data.
920 disables integrity but also disables maintaining parity for user data. This
921 setting is used internally by a dump device residing on a RAID-Z pool and should
922 not be used by any other dataset.
923 Disabling checksums is
925 a recommended practice.
926 .It Sy compression Ns = Ns Cm on | off | lzjb | gzip | gzip- Ns Ar N | zle | Cm lz4
927 Controls the compression algorithm used for this dataset. The
929 compression algorithm is optimized for performance while providing decent data
930 compression. Setting compression to
934 compression algorithm. The
936 compression algorithm uses the same compression as the
938 command. You can specify the
940 level by using the value
944 is an integer from 1 (fastest) to 9 (best compression ratio). Currently,
948 (which is also the default for
952 compression algorithm compresses runs of zeros.
956 compression algorithm is a high-performance replacement
959 algorithm. It features significantly faster
960 compression and decompression, as well as a moderately higher
961 compression ratio than
963 but can only be used on pools with
970 for details on ZFS feature flags and the
974 This property can also be referred to by its shortened column name
976 Changing this property affects only newly-written data.
977 .It Sy copies Ns = Ns Cm 1 | 2 | 3
978 Controls the number of copies of data stored for this dataset. These copies are
979 in addition to any redundancy provided by the pool, for example, mirroring or
980 RAID-Z. The copies are stored on different disks, if possible. The space used
981 by multiple copies is charged to the associated file and dataset, changing the
983 property and counting against quotas and reservations.
985 Changing this property only affects newly-written data. Therefore, set this
986 property at file system creation time by using the
987 .Fl o Cm copies= Ns Ar N
989 .It Sy dedup Ns = Ns Cm on | off | verify | sha256 Ns Op Cm ,verify
990 Configures deduplication for a dataset. The default value is
992 The default deduplication checksum is
994 (this may change in the future).
997 is enabled, the checksum defined here overrides the
999 property. Setting the value to
1001 has the same effect as the setting
1007 will do a byte-to-byte comparsion in case of two blocks having the same
1008 signature to make sure the block contents are identical.
1009 .It Sy devices Ns = Ns Cm on | off
1012 property is currently not supported on
1014 .It Sy exec Ns = Ns Cm on | off
1015 Controls whether processes can be executed from within this file system. The
1018 .It Sy mlslabel Ns = Ns Ar label | Cm none
1021 property is currently not supported on
1023 .It Sy mountpoint Ns = Ns Ar path | Cm none | legacy
1024 Controls the mount point used for this file system. See the
1026 section for more information on how this property is used.
1030 property is changed for a file system, the file system and any children that
1031 inherit the mount point are unmounted. If the new value is
1033 then they remain unmounted. Otherwise, they are automatically remounted in the
1034 new location if the property was previously
1038 or if they were mounted before the property was changed. In addition, any
1039 shared file systems are unshared and shared in the new location.
1040 .It Sy nbmand Ns = Ns Cm on | off
1043 property is currently not supported on
1045 .It Sy primarycache Ns = Ns Cm all | none | metadata
1046 Controls what is cached in the primary cache (ARC). If this property is set to
1048 then both user data and metadata is cached. If this property is set to
1050 then neither user data nor metadata is cached. If this property is set to
1052 then only metadata is cached. The default value is
1054 .It Sy quota Ns = Ns Ar size | Cm none
1055 Limits the amount of space a dataset and its descendents can consume. This
1056 property enforces a hard limit on the amount of space used. This includes all
1057 space consumed by descendents, including file systems and snapshots. Setting a
1058 quota on a descendent of a dataset that already has a quota does not override
1059 the ancestor's quota, but rather imposes an additional limit.
1061 Quotas cannot be set on volumes, as the
1063 property acts as an implicit quota.
1064 .It Sy userquota@ Ns Ar user Ns = Ns Ar size | Cm none
1065 Limits the amount of space consumed by the specified user.
1070 space calculation does not include space that is used by descendent datasets,
1071 such as snapshots and clones. User space consumption is identified by the
1072 .Sy userspace@ Ns Ar user
1075 Enforcement of user quotas may be delayed by several seconds. This delay means
1076 that a user might exceed their quota before the system notices that they are
1077 over quota and begins to refuse additional writes with the
1079 error message. See the
1081 subcommand for more information.
1083 Unprivileged users can only access their own groups' space usage. The root
1084 user, or a user who has been granted the
1088 can get and set everyone's quota.
1090 This property is not available on volumes, on file systems before version 4, or
1091 on pools before version 15. The
1092 .Sy userquota@ Ns ...
1093 properties are not displayed by
1095 The user's name must be appended after the
1097 symbol, using one of the following forms:
1098 .Bl -bullet -offset 2n
1100 POSIX name (for example,
1103 POSIX numeric ID (for example,
1106 .It Sy groupquota@ Ns Ar group Ns = Ns Ar size | Cm none
1107 Limits the amount of space consumed by the specified group. Group space
1108 consumption is identified by the
1109 .Sy userquota@ Ns Ar user
1112 Unprivileged users can access only their own groups' space usage. The root
1113 user, or a user who has been granted the
1117 can get and set all groups' quotas.
1118 .It Sy readonly Ns = Ns Cm on | off
1119 Controls whether this dataset can be modified. The default value is
1121 .It Sy recordsize Ns = Ns Ar size
1122 Specifies a suggested block size for files in the file system. This property is
1123 designed solely for use with database workloads that access files in fixed-size
1126 automatically tunes block sizes according to internal algorithms optimized for
1127 typical access patterns.
1129 For databases that create very large files but access them in small random
1130 chunks, these algorithms may be suboptimal. Specifying a
1132 greater than or equal to the record size of the database can result in
1133 significant performance gains. Use of this property for general purpose file
1134 systems is strongly discouraged, and may adversely affect performance.
1136 The size specified must be a power of two greater than or equal to 512 and less
1137 than or equal to 128 Kbytes.
1139 Changing the file system's
1141 affects only files created afterward; existing files are unaffected.
1143 This property can also be referred to by its shortened column name,
1145 .It Sy refquota Ns = Ns Ar size | Cm none
1146 Limits the amount of space a dataset can consume. This property enforces a hard
1147 limit on the amount of space used. This hard limit does not include space used
1148 by descendents, including file systems and snapshots.
1149 .It Sy refreservation Ns = Ns Ar size | Cm none
1150 The minimum amount of space guaranteed to a dataset, not including its
1151 descendents. When the amount of space used is below this value, the dataset is
1152 treated as if it were taking up the amount of space specified by
1153 .Sy refreservation .
1156 reservation is accounted for in the parent datasets' space used, and counts
1157 against the parent datasets' quotas and reservations.
1161 is set, a snapshot is only allowed if there is enough free pool space outside
1162 of this reservation to accommodate the current number of "referenced" bytes in
1165 This property can also be referred to by its shortened column name,
1167 .It Sy reservation Ns = Ns Ar size | Cm none
1168 The minimum amount of space guaranteed to a dataset and its descendents. When
1169 the amount of space used is below this value, the dataset is treated as if it
1170 were taking up the amount of space specified by its reservation. Reservations
1171 are accounted for in the parent datasets' space used, and count against the
1172 parent datasets' quotas and reservations.
1174 This property can also be referred to by its shortened column name,
1176 .It Sy secondarycache Ns = Ns Cm all | none | metadata
1177 Controls what is cached in the secondary cache (L2ARC). If this property is set
1180 then both user data and metadata is cached. If this property is set to
1182 then neither user data nor metadata is cached. If this property is set to
1184 then only metadata is cached. The default value is
1186 .It Sy setuid Ns = Ns Cm on | off
1187 Controls whether the
1189 bit is respected for the file system. The default value is
1191 .It Sy sharesmb Ns = Ns Cm on | off | Ar opts
1194 property currently has no effect on
1196 .It Sy sharenfs Ns = Ns Cm on | off | Ar opts
1197 Controls whether the file system is shared via
1199 and what options are used. A file system with a
1203 is managed the traditional way via
1205 Otherwise, the file system is automatically shared and unshared with the
1209 commands. If the property is set to
1213 export options are used. Otherwise,
1215 export options are equivalent to the contents of this property. The export
1216 options may be comma-separated. See
1218 for a list of valid options.
1222 property is changed for a dataset, the
1225 .It Sy logbias Ns = Ns Cm latency | throughput
1228 about handling of synchronous requests in this dataset.
1235 will use pool log devices (if configured) to handle the requests at low
1241 will not use configured pool log devices.
1243 will instead optimize synchronous operations for global pool throughput and
1244 efficient use of resources.
1245 .It Sy snapdir Ns = Ns Cm hidden | visible
1246 Controls whether the
1248 directory is hidden or visible in the root of the file system as discussed in
1251 section. The default value is
1253 .It Sy sync Ns = Ns Cm standard | always | disabled
1254 Controls the behavior of synchronous requests (e.g.
1256 O_DSYNC). This property accepts the following values:
1257 .Bl -tag -offset 4n -width 8n
1259 This is the POSIX specified behavior of ensuring all synchronous requests are
1260 written to stable storage and all devices are flushed to ensure data is not
1261 cached by device controllers (this is the default).
1263 All file system transactions are written and flushed before their system calls
1264 return. This has a large performance penalty.
1266 Disables synchronous requests. File system transactions are only committed to
1267 stable storage periodically. This option will give the highest performance.
1268 However, it is very dangerous as
1270 would be ignoring the synchronous transaction demands of applications such as
1273 Administrators should only use this option when the risks are understood.
1275 .It Sy volsize Ns = Ns Ar size
1276 For volumes, specifies the logical size of the volume. By default, creating a
1277 volume establishes a reservation of equal size. For storage pools with a
1278 version number of 9 or higher, a
1280 is set instead. Any changes to
1282 are reflected in an equivalent change to the reservation (or
1283 .Sy refreservation ) .
1286 can only be set to a multiple of
1290 The reservation is kept equal to the volume's logical size to prevent
1291 unexpected behavior for consumers. Without the reservation, the volume could
1292 run out of space, resulting in undefined behavior or data corruption, depending
1293 on how the volume is used. These effects can also occur when the volume size is
1294 changed while it is in use (particularly when shrinking the size). Extreme care
1295 should be used when adjusting the volume size.
1297 Though not recommended, a "sparse volume" (also known as "thin provisioning")
1298 can be created by specifying the
1301 .Qq Nm Cm create Fl V
1302 command, or by changing the reservation after the volume has been created. A
1303 "sparse volume" is a volume where the reservation is less then the volume size.
1304 Consequently, writes to a sparse volume can fail with
1306 when the pool is low on space. For a sparse volume, changes to
1308 are not reflected in the reservation.
1309 .It Sy vscan Ns = Ns Cm off | on
1312 property is currently not supported on
1314 .It Sy xattr Ns = Ns Cm off | on
1317 property is currently not supported on
1319 .It Sy jailed Ns = Ns Cm off | on
1320 Controls whether the dataset is managed from a jail. See the
1322 section for more information. The default value is
1326 The following three properties cannot be changed after the file system is
1327 created, and therefore, should be set when the file system is created. If the
1328 properties are not set with the
1332 commands, these properties are inherited from the parent dataset. If the parent
1333 dataset lacks these properties due to having been created prior to these
1334 features being supported, the new file system will have the default values for
1337 .It Sy casesensitivity Ns = Ns Cm sensitive | insensitive | mixed
1338 Indicates whether the file name matching algorithm used by the file system
1339 should be case-sensitive, case-insensitive, or allow a combination of both
1340 styles of matching. The default value for the
1344 Traditionally, UNIX and POSIX file systems have case-sensitive file names.
1350 property indicates that the
1351 file system can support requests for both case-sensitive and case-insensitive
1353 .It Sy normalization Ns = Ns Cm none | formC | formD | formKC | formKD
1354 Indicates whether the file system should perform a
1356 normalization of file names whenever two file names are compared, and which
1357 normalization algorithm should be used. File names are always stored
1358 unmodified, names are normalized as part of any comparison process. If this
1359 property is set to a legal value other than
1363 property was left unspecified, the
1365 property is automatically set to
1367 The default value of the
1371 This property cannot be changed after the file system is created.
1372 .It Sy utf8only Ns = Ns Cm on | off
1373 Indicates whether the file system should reject file names that include
1374 characters that are not present in the
1376 character code set. If this property is explicitly set to
1378 the normalization property must either not be explicitly set or be set to
1380 The default value for the
1384 This property cannot be changed after the file system is created.
1388 .Sy casesensitivity , normalization , No and Sy utf8only
1389 properties are also new permissions that can be assigned to non-privileged
1392 delegated administration feature.
1393 .Ss Temporary Mount Point Properties
1394 When a file system is mounted, either through
1396 for legacy mounts or the
1398 command for normal file systems, its mount options are set according to its
1399 properties. The correlation between properties and mount options is as follows:
1400 .Bl -column -offset 4n "PROPERTY" "MOUNT OPTION"
1401 .It "PROPERTY MOUNT OPTION"
1402 .It "atime atime/noatime"
1403 .It "exec exec/noexec"
1404 .It "readonly ro/rw"
1405 .It "setuid suid/nosuid"
1408 In addition, these options can be set on a per-mount basis using the
1410 option, without affecting the property that is stored on disk. The values
1411 specified on the command line override the values stored in the dataset. These
1412 properties are reported as "temporary" by the
1414 command. If the properties are changed while the dataset is mounted, the new
1415 setting overrides any temporary settings.
1417 In addition to the standard native properties,
1419 supports arbitrary user properties. User properties have no effect on
1421 behavior, but applications or administrators can use them to annotate datasets
1422 (file systems, volumes, and snapshots).
1424 User property names must contain a colon
1426 character to distinguish them from native properties. They may contain
1427 lowercase letters, numbers, and the following punctuation characters: colon
1435 The expected convention is that the property name is divided into two portions
1437 .Em module Ns Sy \&: Ns Em property ,
1438 but this namespace is not enforced by
1440 User property names can be at most 256 characters, and cannot begin with a dash
1443 When making programmatic use of user properties, it is strongly suggested to
1448 component of property names to reduce the chance that two
1449 independently-developed packages use the same property name for different
1450 purposes. Property names beginning with
1452 are reserved for use by Sun Microsystems.
1454 The values of user properties are arbitrary strings, are always inherited, and
1455 are never validated. All of the commands that operate on properties
1462 can be used to manipulate both native properties and user properties. Use the
1464 command to clear a user property. If the property is not defined in any parent
1465 dataset, it is removed entirely. Property values are limited to 1024
1468 All subcommands that modify state are logged persistently to the pool in their
1476 Displays a help message.
1481 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1487 file system. The file system is automatically mounted according to the
1489 property inherited from the parent.
1490 .Bl -tag -width indent
1492 Creates all the non-existing parent datasets. Datasets created in this manner
1493 are automatically mounted according to the
1495 property inherited from their parent. Any property specified on the command
1498 option is ignored. If the target filesystem already exists, the operation
1499 completes successfully.
1501 Newly created file system is not mounted.
1502 .It Fl o Ar property Ns = Ns Ar value
1503 Sets the specified property as if the command
1504 .Qq Nm Cm set Ar property Ns = Ns Ar value
1505 was invoked at the same time the dataset was created. Any editable
1507 property can also be set at creation time. Multiple
1509 options can be specified. An error results if the same property is specified in
1518 .Op Fl b Ar blocksize
1519 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1524 Creates a volume of the given size. The volume is exported as a block device in
1525 .Pa /dev/zvol/path ,
1528 is the name of the volume in the
1530 namespace. The size represents the logical size as exported by the device. By
1531 default, a reservation of equal size is created.
1534 is automatically rounded up to the nearest 128 Kbytes to ensure that
1535 the volume has an integral number of blocks regardless of
1537 .Bl -tag -width indent
1539 Creates all the non-existing parent datasets. Datasets created in this manner
1540 are automatically mounted according to the
1542 property inherited from their parent. Any property specified on the command
1545 option is ignored. If the target filesystem already exists, the operation
1546 completes successfully.
1548 Creates a sparse volume with no reservation. See
1551 .Qq Sx Native Properties
1552 section for more information about sparse volumes.
1553 .It Fl b Ar blocksize
1555 .Fl o Cm volblocksize Ns = Ns Ar blocksize .
1556 If this option is specified in conjunction with
1557 .Fl o Cm volblocksize ,
1558 the resulting behavior is undefined.
1559 .It Fl o Ar property Ns = Ns Ar value
1560 Sets the specified property as if the
1561 .Qq Nm Cm set Ar property Ns = Ns Ar value
1562 command was invoked at the same time the dataset was created. Any editable
1564 property can also be set at creation time. Multiple
1566 options can be specified. An error results if the same property is specified in
1575 .Ar filesystem Ns | Ns Ar volume
1578 Destroys the given dataset. By default, the command unshares any file systems
1579 that are currently shared, unmounts any file systems that are currently
1580 mounted, and refuses to destroy a dataset that has active dependents (children
1582 .Bl -tag -width indent
1584 Recursively destroy all children.
1586 Recursively destroy all dependents, including cloned file systems outside the
1589 Force an unmount of any file systems using the
1590 .Qq Nm Cm unmount Fl f
1591 command. This option has no effect on non-file systems or unmounted file
1594 Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in
1595 conjunction with the
1599 flags to determine what data would be deleted.
1601 Print machine-parsable verbose information about the deleted data.
1603 Print verbose information about the deleted data.
1606 Extreme care should be taken when applying either the
1610 options, as they can destroy large portions of a pool and cause unexpected
1611 behavior for mounted file systems in use.
1618 .Op % Ns Ar snapname
1623 The given snapshots are destroyed immediately if and only if the
1627 option would have destroyed it. Such immediate destruction would occur, for
1628 example, if the snapshot had no clones and the user-initiated reference count
1631 If a snapshot does not qualify for immediate destruction, it is marked for
1632 deferred deletion. In this state, it exists as a usable, visible snapshot until
1633 both of the preconditions listed above are met, at which point it is destroyed.
1635 An inclusive range of snapshots may be specified by separating the
1636 first and last snapshots with a percent sign
1638 The first and/or last snapshots may be left blank, in which case the
1639 filesystem's oldest or newest snapshot will be implied.
1642 (or ranges of snapshots) of the same filesystem or volume may be specified
1643 in a comma-separated list of snapshots.
1644 Only the snapshot's short name (the
1647 should be specified when using a range or comma-separated list to identify
1649 .Bl -tag -width indent
1651 Destroy (or mark for deferred deletion) all snapshots with this name in
1652 descendent file systems.
1654 Recursively destroy all clones of these snapshots, including the clones,
1655 snapshots, and children.
1656 If this flag is specified, the
1658 flag will have no effect.
1660 Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in
1661 conjunction with the
1665 flags to determine what data would be deleted.
1667 Print machine-parsable verbose information about the deleted data.
1669 Print verbose information about the deleted data.
1671 Defer snapshot deletion.
1674 Extreme care should be taken when applying either the
1678 options, as they can destroy large portions of a pool and cause unexpected
1679 behavior for mounted file systems in use.
1683 .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
1686 The given bookmark is destroyed.
1689 .Cm snapshot Ns | Ns Cm snap
1691 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1692 .Ar filesystem@snapname Ns | Ns volume@snapname
1693 .Ar filesystem@snapname Ns | Ns volume@snapname Ns ...
1696 Creates snapshots with the given names. All previous modifications by
1697 successful system calls to the file system are part of the snapshots.
1698 Snapshots are taken atomically, so that all snapshots correspond to the same
1699 moment in time. See the
1701 section for details.
1702 .Bl -tag -width indent
1704 Recursively create snapshots of all descendent datasets
1705 .It Fl o Ar property Ns = Ns Ar value
1706 Sets the specified property; see
1717 Roll back the given dataset to a previous snapshot. When a dataset is rolled
1718 back, all data that has changed since the snapshot is discarded, and the
1719 dataset reverts to the state at the time of the snapshot. By default, the
1720 command refuses to roll back to a snapshot other than the most recent one. In
1721 order to do so, all intermediate snapshots and bookmarks must be destroyed
1728 options do not recursively destroy the child snapshots of a
1730 Only direct snapshots of the specified filesystem
1731 are destroyed by either of these options.
1732 To completely roll back a
1733 recursive snapshot, you must rollback the individual child snapshots.
1734 .Bl -tag -width indent
1736 Destroy any snapshots and bookmarks more recent than the one specified.
1738 Destroy any more recent snapshots and bookmarks, as well as any clones of those
1743 option to force an unmount of any clone file systems that are to be destroyed.
1749 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1750 .Ar snapshot filesystem Ns | Ns Ar volume
1753 Creates a clone of the given snapshot. See the
1755 section for details. The target dataset can be located anywhere in the
1757 hierarchy, and is created as the same type as the original.
1758 .Bl -tag -width indent
1760 Creates all the non-existing parent datasets. Datasets created in this manner
1761 are automatically mounted according to the
1763 property inherited from their parent. If the target filesystem or volume
1764 already exists, the operation completes successfully.
1765 .It Fl o Ar property Ns = Ns Ar value
1766 Sets the specified property; see
1773 .Ar clone-filesystem
1776 Promotes a clone file system to no longer be dependent on its "origin"
1777 snapshot. This makes it possible to destroy the file system that the clone was
1778 created from. The clone parent-child dependency relationship is reversed, so
1779 that the origin file system becomes a clone of the specified file system.
1781 The snapshot that was cloned, and any snapshots previous to this snapshot, are
1782 now owned by the promoted clone. The space they use moves from the origin file
1783 system to the promoted clone, so enough space must be available to accommodate
1784 these snapshots. No new space is consumed by this operation, but the space
1785 accounting is adjusted. The promoted clone must not have any conflicting
1786 snapshot names of its own. The
1788 subcommand can be used to rename any conflicting snapshots.
1793 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1794 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1801 .Ar filesystem Ns | Ns Ar volume
1802 .Ar filesystem Ns | Ns Ar volume
1809 .Ar filesystem filesystem
1812 Renames the given dataset. The new target can be located anywhere in the
1814 hierarchy, with the exception of snapshots. Snapshots can only be renamed
1815 within the parent file system or volume. When renaming a snapshot, the parent
1816 file system of the snapshot does not need to be specified as part of the second
1817 argument. Renamed file systems can inherit new mount points, in which case they
1818 are unmounted and remounted at the new mount point.
1819 .Bl -tag -width indent
1821 Creates all the nonexistent parent datasets. Datasets created in this manner
1822 are automatically mounted according to the
1824 property inherited from their parent.
1826 Do not remount file systems during rename. If a file system's
1832 file system is not unmounted even if this option is not given.
1834 Force unmount any filesystems that need to be unmounted in the process.
1835 This flag has no effect if used together with the
1843 .Ar snapshot snapshot
1846 Recursively rename the snapshots of all descendent datasets. Snapshots are the
1847 only dataset that can be renamed recursively.
1851 .Op Fl r Ns | Ns Fl d Ar depth
1853 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
1854 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
1855 .Oo Fl s Ar property Oc Ns ...
1856 .Oo Fl S Ar property Oc Ns ...
1857 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
1860 Lists the property information for the given datasets in tabular form. If
1861 specified, you can list property information by the absolute pathname or the
1862 relative pathname. By default, all file systems and volumes are displayed.
1863 Snapshots are displayed if the
1869 The following fields are displayed,
1870 .Sy name , used , available , referenced , mountpoint .
1871 .Bl -tag -width indent
1873 Recursively display any children of the dataset on the command line.
1875 Recursively display any children of the dataset, limiting the recursion to
1879 will display only the dataset and its direct children.
1881 Used for scripting mode. Do not print headers and separate fields by a single
1882 tab instead of arbitrary white space.
1884 Display numbers in parsable (exact) values.
1885 .It Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
1886 A comma-separated list of properties to display. The property must be:
1887 .Bl -bullet -offset 2n
1889 One of the properties described in the
1890 .Qq Sx Native Properties
1897 to display the dataset name
1901 to display space usage properties on file systems and volumes. This is a
1902 shortcut for specifying
1904 .Sy name,avail,used,usedsnap,usedds,usedrefreserv,usedchild
1906 .Sy filesystem,volume
1909 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
1910 A comma-separated list of types to display, where
1913 .Sy filesystem , snapshot , snap , volume , bookmark , No or Sy all .
1914 For example, specifying
1916 displays only snapshots.
1917 .It Fl s Ar property
1918 A property for sorting the output by column in ascending order based on the
1919 value of the property. The property must be one of the properties described in
1922 section, or the special value
1924 to sort by the dataset name. Multiple properties can be specified at one time
1927 property options. Multiple
1929 options are evaluated from left to right in decreasing order of importance.
1931 The following is a list of sorting criteria:
1932 .Bl -bullet -offset 2n
1934 Numeric types sort in numeric order.
1936 String types sort in alphabetical order.
1938 Types inappropriate for a row sort that row to the literal bottom, regardless
1939 of the specified ordering.
1941 If no sorting options are specified the existing behavior of
1945 .It Fl S Ar property
1948 option, but sorts by property in descending order.
1953 .Ar property Ns = Ns Ar value
1954 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1957 Sets the property to the given value for each dataset. Only some properties can
1958 be edited. See the "Properties" section for more information on what properties
1959 can be set and acceptable values. Numeric values can be specified as exact
1960 values, or in a human-readable form with a suffix of
1961 .Sy B , K , M , G , T , P , E , Z
1962 (for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes, or
1963 zettabytes, respectively). User properties can be set on snapshots. For more
1964 information, see the
1965 .Qq Sx User Properties
1970 .Op Fl r Ns | Ns Fl d Ar depth
1972 .Op Fl o Ar all | field Ns Oo , Ns Ar field Oc Ns ...
1973 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
1974 .Op Fl s Ar source Ns Oo , Ns Ar source Oc Ns ...
1975 .Ar all | property Ns Oo , Ns Ar property Oc Ns ...
1976 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
1979 Displays properties for the given datasets. If no datasets are specified, then
1980 the command displays properties for all datasets on the system. For each
1981 property, the following columns are displayed:
1983 .Bl -hang -width "property" -offset indent -compact
1991 Property source. Can either be local, default, temporary, inherited, or none
1995 All columns except the
1997 column are displayed by default. The columns to display can be specified
2000 option. This command takes a comma-separated list of properties as described in
2002 .Qq Sx Native Properties
2004 .Qq Sx User Properties
2009 can be used to display all properties that apply to the given dataset's type
2010 (filesystem, volume, snapshot, or bookmark).
2011 .Bl -tag -width indent
2013 Recursively display properties for any children.
2015 Recursively display any children of the dataset, limiting the recursion to
2019 will display only the dataset and its direct children.
2021 Display output in a form more easily parsed by scripts. Any headers are
2022 omitted, and fields are explicitly separated by a single tab instead of an
2023 arbitrary amount of space.
2025 Display numbers in parsable (exact) values.
2026 .It Fl o Cm all | Ar field Ns Oo , Ns Ar field Oc Ns ...
2027 A comma-separated list of columns to display. Supported values are
2028 .Sy name,property,value,received,source .
2030 .Sy name,property,value,source .
2033 specifies all columns.
2034 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2035 A comma-separated list of types to display, where
2038 .Sy filesystem , snapshot , volume , No or Sy all .
2039 For example, specifying
2041 displays only snapshots.
2042 .It Fl s Ar source Ns Oo , Ns Ar source Oc Ns ...
2043 A comma-separated list of sources to display. Those properties coming from a
2044 source other than those in this list are ignored. Each source must be one of
2046 .Sy local,default,inherited,temporary,received,none .
2047 The default value is all sources.
2054 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
2057 Clears the specified property, causing it to be inherited from an ancestor. If
2058 no ancestor has the property set, then the default value is used. See the
2060 section for a listing of default values, and details on which properties can be
2062 .Bl -tag -width indent
2064 Recursively inherit the given property for all children.
2066 For properties with a received value, revert to this value. This flag has no
2067 effect on properties that do not have a received value.
2075 Displays a list of file systems that are not the most recent version.
2076 .Bl -tag -width indent
2080 filesystem versions supported by the current software. The current
2082 filesystem version and all previous supported versions are displayed, along
2083 with an explanation of the features provided with each version.
2090 .Fl a | Ar filesystem
2093 Upgrades file systems to a new on-disk version. Once this is done, the file
2094 systems will no longer be accessible on systems running older versions of the
2097 streams generated from new snapshots of these file systems cannot be accessed
2098 on systems running older versions of the software.
2100 In general, the file system version is independent of the pool version. See
2102 for information on the
2103 .Nm zpool Cm upgrade
2106 In some cases, the file system version and the pool version are interrelated
2107 and the pool version must be upgraded before the file system version can be
2109 .Bl -tag -width indent
2111 Upgrade the specified file system and all descendent file systems.
2113 Upgrade to the specified
2117 flag is not specified, this command upgrades to the most recent version. This
2118 option can only be used to increase the version number, and only up to the most
2119 recent version supported by this software.
2121 Upgrade all file systems on all imported pools.
2123 Upgrade the specified file system.
2129 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2130 .Oo Fl s Ar field Oc Ns ...
2131 .Oo Fl S Ar field Oc Ns ...
2132 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2133 .Ar filesystem Ns | Ns Ar snapshot
2136 Displays space consumed by, and quotas on, each user in the specified
2137 filesystem or snapshot. This corresponds to the
2138 .Sy userused@ Ns Ar user
2140 .Sy userquota@ Ns Ar user
2142 .Bl -tag -width indent
2144 Print numeric ID instead of user/group name.
2146 Do not print headers, use tab-delimited output.
2148 Use exact (parsable) numeric output.
2149 .It Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2150 Display only the specified fields from the following set:
2151 .Sy type,name,used,quota .
2152 The default is to display all fields.
2154 Sort output by this field. The
2158 flags may be specified multiple times to sort first by one field, then by
2159 another. The default is
2160 .Fl s Cm type Fl s Cm name .
2162 Sort by this field in reverse order. See
2164 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2165 Print only the specified types from the following set:
2166 .Sy all,posixuser,smbuser,posixgroup,smbgroup .
2169 .Fl t Cm posixuser,smbuser .
2171 The default can be changed to include group types.
2173 Translate SID to POSIX ID. This flag currently has no effect on
2180 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2181 .Oo Fl s Ar field Oc Ns ...
2182 .Oo Fl S Ar field Oc Ns ...
2183 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2184 .Ar filesystem Ns | Ns Ar snapshot
2187 Displays space consumed by, and quotas on, each group in the specified
2188 filesystem or snapshot. This subcommand is identical to
2189 .Qq Nm Cm userspace ,
2190 except that the default types to display are
2191 .Fl t Sy posixgroup,smbgroup .
2199 file systems currently mounted.
2200 .Bl -tag -width indent
2207 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2208 .Fl a | Ar filesystem
2214 .Bl -tag -width indent
2216 Report mount progress.
2218 Perform an overlay mount. Overlay mounts are not supported on
2220 .It Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2221 An optional, comma-separated list of mount options to use temporarily for the
2222 duration of the mount. See the
2223 .Qq Sx Temporary Mount Point Properties
2224 section for details.
2229 This command may be executed on
2233 For more information, see variable
2238 Mount the specified filesystem.
2242 .Cm unmount Ns | Ns Cm umount
2244 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
2247 Unmounts currently mounted
2250 .Bl -tag -width indent
2252 Forcefully unmount the file system, even if it is currently in use.
2254 Unmount all available
2257 .It Ar filesystem | mountpoint
2258 Unmount the specified filesystem. The command can also be given a path to a
2260 file system mount point on the system.
2265 .Fl a | Ar filesystem
2270 file systems that have the
2273 .Bl -tag -width indent
2277 file systems that have the
2280 This command may be executed on
2284 For more information, see variable
2289 Share the specified filesystem according to the
2291 property. File systems are shared when the
2298 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
2303 file systems that have the
2306 .Bl -tag -width indent
2310 file systems that have the
2313 This command may be executed on
2317 For more information, see variable
2321 .It Ar filesystem | mountpoint
2322 Unshare the specified filesystem. The command can also be given a path to a
2324 file system shared on the system.
2333 Creates a bookmark of the given snapshot.
2334 Bookmarks mark the point in time
2335 when the snapshot was created, and can be used as the incremental source for
2340 This feature must be enabled to be used.
2342 .Xr zpool-features 7
2343 for details on ZFS feature flags and the
2350 .Op Fl i Ar snapshot | Fl I Ar snapshot
2354 Creates a stream representation of the last
2356 argument (not part of
2360 which is written to standard output. The output can be redirected to
2361 a file or to a different system (for example, using
2363 By default, a full stream is generated.
2364 .Bl -tag -width indent
2365 .It Fl i Ar snapshot
2366 Generate an incremental stream from the first
2367 .Ar snapshot Pq the incremental source
2369 .Ar snapshot Pq the incremental target .
2370 The incremental source can be specified as the last component of the
2372 .Pq the Em @ No character and following
2374 it is assumed to be from the same file system as the incremental target.
2376 If the destination is a clone, the source may be the origin snapshot, which
2377 must be fully specified (for example,
2378 .Cm pool/fs@origin ,
2381 .It Fl I Ar snapshot
2382 Generate a stream package that sends all intermediary snapshots from the first
2389 .Ic -i @a fs@b; -i @b fs@c; -i @c fs@d .
2391 source may be specified as with the
2395 Generate a replication stream package, which will replicate the specified
2396 filesystem, and all descendent file systems, up to the named snapshot. When
2397 received, all properties, snapshots, descendent file systems, and clones are
2404 flags are used in conjunction with the
2406 flag, an incremental replication stream is generated. The current values of
2407 properties, and current snapshot and file system names are set when the stream
2410 flag is specified when this stream is received, snapshots and file systems that
2411 do not exist on the sending side are destroyed.
2413 Generate a deduplicated stream. Blocks which would have been sent multiple
2414 times in the send stream will only be sent once. The receiving system must
2415 also support this feature to receive a deduplicated stream. This flag can
2416 be used regardless of the dataset's
2418 property, but performance will be much better if the filesystem uses a
2419 dedup-capable checksum (eg.
2422 Include the dataset's properties in the stream. This flag is implicit when
2424 is specified. The receiving system must also support this feature.
2426 Do a dry-run ("No-op") send. Do not generate any actual send data. This is
2427 useful in conjunction with the
2431 flags to determine what data will be sent.
2433 Print machine-parsable verbose information about the stream package generated.
2435 Print verbose information about the stream package generated.
2436 This information includes a per-second report of how much data has been sent.
2439 The format of the stream is committed. You will be able to receive your streams
2440 on future versions of
2445 .Op Fl i Ar snapshot Ns | Ns Ar bookmark
2446 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2449 Generate a send stream, which may be of a filesystem, and may be
2450 incremental from a bookmark.
2451 If the destination is a filesystem or volume,
2452 the pool must be read-only, or the filesystem must not be mounted.
2454 stream generated from a filesystem or volume is received, the default snapshot
2457 .Bl -tag -width indent
2458 .It Fl i Ar snapshot Ns | Ns bookmark
2459 Generate an incremental send stream.
2460 The incremental source must be an earlier
2461 snapshot in the destination's history.
2462 It will commonly be an earlier
2463 snapshot in the destination's filesystem, in which case it can be
2464 specified as the last component of the name
2465 .Pq the Em # No or Em @ No character and following .
2467 If the incremental target is a clone, the incremental source can
2468 be the origin snapshot, or an earlier snapshot in the origin's filesystem,
2469 or the origin's origin, etc.
2473 .Cm receive Ns | Ns Cm recv
2475 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2479 .Cm receive Ns | Ns Cm recv
2485 Creates a snapshot whose contents are as specified in the stream provided on
2486 standard input. If a full stream is received, then a new file system is created
2487 as well. Streams are created using the
2489 subcommand, which by default creates a full stream.
2491 can be used as an alias for
2494 If an incremental stream is received, then the destination file system must
2495 already exist, and its most recent snapshot must match the incremental stream's
2498 the destination device link is destroyed and recreated, which means the
2500 cannot be accessed during the
2504 When a snapshot replication package stream that is generated by using the
2506 command is received, any snapshots that do not exist on the sending location
2507 are destroyed by using the
2508 .Qq Nm Cm destroy Fl d
2511 The name of the snapshot (and file system, if a full stream is received) that
2512 this subcommand creates depends on the argument type and the
2518 If the argument is a snapshot name, the specified
2520 is created. If the argument is a file system or volume name, a snapshot with
2521 the same name as the sent snapshot is created within the specified
2529 option is specified, the snapshot name is determined by appending the sent
2530 snapshot's name to the specified
2534 option is specified, all but the pool name of the sent snapshot path is
2535 appended (for example,
2537 appended from sent snapshot
2541 option is specified, only the tail of the sent snapshot path is appended (for
2544 appended from sent snapshot
2548 any file systems needed to replicate the path of the sent snapshot are created
2549 within the specified file system.
2550 .Bl -tag -width indent
2552 Use the full sent snapshot path without the first element (without pool name)
2553 to determine the name of the new snapshot as described in the paragraph above.
2555 Use only the last element of the sent snapshot path to determine the name of
2556 the new snapshot as described in the paragraph above.
2558 File system that is associated with the received stream is not mounted.
2560 Print verbose information about the stream and the time required to perform the
2563 Do not actually receive the stream. This can be useful in conjunction with the
2565 option to verify the name the receive operation would use.
2567 Force a rollback of the file system to the most recent snapshot before
2568 performing the receive operation. If receiving an incremental replication
2569 stream (for example, one generated by
2570 .Qq Nm Cm send Fl R Bro Fl i | Fl I Brc ) ,
2571 destroy snapshots and file systems that do not exist on the sending side.
2576 .Ar filesystem Ns | Ns Ar volume
2579 Displays permissions that have been delegated on the specified filesystem or
2580 volume. See the other forms of
2582 for more information.
2587 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
2588 .Ar perm Ns | Ns Ar @setname Ns
2589 .Oo Ns , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
2590 .Ar filesystem Ns | Ns Ar volume
2596 .Fl e Ns | Ns Cm everyone
2597 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
2599 .Ar filesystem Ns | Ns Ar volume
2604 administration permission for the file systems to non-privileged users.
2605 .Bl -tag -width indent
2608 .Ar user Ns | Ns Ar group Ns Oo , Ar user Ns | Ns Ar group Oc Ns ...
2610 Specifies to whom the permissions are delegated. Multiple entities can be
2611 specified as a comma-separated list. If neither of the
2613 options are specified, then the argument is interpreted preferentially as the
2616 then as a user name, and lastly as a group name. To specify
2617 a user or group named
2623 options. To specify a group with the same name as a user, use the
2626 .It Op Fl e Ns | Ns Cm everyone
2627 Specifies that the permissions be delegated to
2630 .Ar perm Ns | Ns Ar @setname Ns Oo , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
2632 The permissions to delegate. Multiple permissions
2633 may be specified as a comma-separated list. Permission names are the same as
2635 subcommand and property names. See the property list below. Property set names,
2636 which begin with an at sign
2638 may be specified. See the
2640 form below for details.
2643 .Ar filesystem Ns | Ns Ar volume
2645 Specifies where the permissions are delegated. If neither of the
2647 options are specified, or both are, then the permissions are allowed for the
2648 file system or volume, and all of its descendents. If only the
2650 option is used, then is allowed "locally" only for the specified file system.
2653 option is used, then is allowed only for the descendent file systems.
2656 Permissions are generally the ability to use a
2658 subcommand or change a
2660 property. The following permissions are available:
2661 .Bl -column -offset 4n "secondarycache" "subcommand"
2662 .It NAME Ta TYPE Ta NOTES
2663 .It allow Ta subcommand Ta Must Xo
2664 also have the permission that is being allowed
2666 .It clone Ta subcommand Ta Must Xo
2667 also have the 'create' ability and 'mount' ability in the origin file system
2669 .It create Ta subcommand Ta Must also have the 'mount' ability
2670 .It destroy Ta subcommand Ta Must also have the 'mount' ability
2671 .It diff Ta subcommand Ta Allows lookup of paths within a dataset given an
2672 object number, and the ability to create snapshots necessary to 'zfs diff'
2673 .It hold Ta subcommand Ta Allows adding a user hold to a snapshot
2674 .It mount Ta subcommand Ta Allows mount/umount of Tn ZFS No datasets
2675 .It promote Ta subcommand Ta Must Xo
2676 also have the 'mount' and 'promote' ability in the origin file system
2678 .It receive Ta subcommand Ta Must also have the 'mount' and 'create' ability
2679 .It release Ta subcommand Ta Allows Xo
2680 releasing a user hold which might destroy the snapshot
2682 .It rename Ta subcommand Ta Must Xo
2683 also have the 'mount' and 'create' ability in the new parent
2685 .It rollback Ta subcommand Ta Must also have the 'mount' ability
2686 .It send Ta subcommand
2687 .It share Ta subcommand Ta Allows Xo
2688 sharing file systems over the
2692 .It snapshot Ta subcommand Ta Must also have the 'mount' ability
2693 .It groupquota Ta other Ta Allows accessing any groupquota@... property
2694 .It groupused Ta other Ta Allows reading any groupused@... property
2695 .It userprop Ta other Ta Allows changing any user property
2696 .It userquota Ta other Ta Allows accessing any userquota@... property
2697 .It userused Ta other Ta Allows reading any userused@... property
2698 .It aclinherit Ta property
2699 .It aclmode Ta property
2700 .It atime Ta property
2701 .It canmount Ta property
2702 .It casesensitivity Ta property
2703 .It checksum Ta property
2704 .It compression Ta property
2705 .It copies Ta property
2706 .It dedup Ta property
2707 .It devices Ta property
2708 .It exec Ta property
2709 .It logbias Ta property
2710 .It jailed Ta property
2711 .It mlslabel Ta property
2712 .It mountpoint Ta property
2713 .It nbmand Ta property
2714 .It normalization Ta property
2715 .It primarycache Ta property
2716 .It quota Ta property
2717 .It readonly Ta property
2718 .It recordsize Ta property
2719 .It refquota Ta property
2720 .It refreservation Ta property
2721 .It reservation Ta property
2722 .It secondarycache Ta property
2723 .It setuid Ta property
2724 .It sharenfs Ta property
2725 .It sharesmb Ta property
2726 .It snapdir Ta property
2727 .It sync Ta property
2728 .It utf8only Ta property
2729 .It version Ta property
2730 .It volblocksize Ta property
2731 .It volsize Ta property
2732 .It vscan Ta property
2733 .It xattr Ta property
2739 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
2741 .Ar filesystem Ns | Ns Ar volume
2744 Sets "create time" permissions. These permissions are granted (locally) to the
2745 creator of any newly-created descendent file system.
2751 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
2753 .Ar filesystem Ns | Ns Ar volume
2756 Defines or adds permissions to a permission set. The set can be used by other
2758 commands for the specified file system and its descendents. Sets are evaluated
2759 dynamically, so changes to a set are immediately reflected. Permission sets
2760 follow the same naming restrictions as ZFS file systems, but the name must
2761 begin with an "at sign"
2763 and can be no more than 64 characters long.
2768 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
2769 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
2771 .Ar filesystem Ns | Ns Ar volume
2777 .Fl e Ns | Ns Cm everyone
2778 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
2780 .Ar filesystem Ns | Ns Ar volume
2787 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
2789 .Ar filesystem Ns | Ns Ar volume
2792 Removes permissions that were granted with the
2794 command. No permissions are explicitly denied, so other permissions granted are
2795 still in effect. For example, if the permission is granted by an ancestor. If
2796 no permissions are specified, then all permissions for the specified
2797 .Ar user , group , No or everyone
2798 are removed. Specifying
2800 .Po or using the Fl e
2802 .Pc only removes the permissions that were granted to everyone ,
2803 not all permissions for every user and group. See the
2805 command for a description of the
2808 .Bl -tag -width indent
2810 Recursively remove the permissions from this file system and all descendents.
2818 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
2820 .Ar filesystem Ns | Ns Ar volume
2823 Removes permissions from a permission set. If no permissions are specified,
2824 then all permissions are removed, thus removing the set entirely.
2829 .Ar tag snapshot Ns ...
2832 Adds a single reference, named with the
2834 argument, to the specified snapshot or snapshots. Each snapshot has its own tag
2835 namespace, and tags must be unique within that space.
2837 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
2841 .Bl -tag -width indent
2843 Specifies that a hold with the given tag is applied recursively to the
2844 snapshots of all descendent file systems.
2853 Lists all existing user references for the given snapshot or snapshots.
2854 .Bl -tag -width indent
2856 Lists the holds that are set on the named descendent snapshots, in addition to
2857 listing the holds on the named snapshot.
2863 .Ar tag snapshot Ns ...
2866 Removes a single reference, named with the
2868 argument, from the specified snapshot or snapshots. The tag must already exist
2870 .Bl -tag -width indent
2872 Recursively releases a hold with the given tag on the snapshots of all
2873 descendent file systems.
2880 .Op Ar snapshot Ns | Ns Ar filesystem
2883 Display the difference between a snapshot of a given filesystem and another
2884 snapshot of that filesystem from a later time or the current contents of the
2885 filesystem. The first column is a character indicating the type of change,
2886 the other columns indicate pathname, new pathname
2887 .Pq in case of rename ,
2888 change in link count, and optionally file type and/or change time.
2890 The types of change are:
2891 .Bl -column -offset 2n indent
2892 .It \&- Ta path was removed
2893 .It \&+ Ta path was added
2894 .It \&M Ta path was modified
2895 .It \&R Ta path was renamed
2897 .Bl -tag -width indent
2899 Display an indication of the type of file, in a manner similar to the
2903 .Bl -column -offset 2n indent
2904 .It \&B Ta block device
2905 .It \&C Ta character device
2906 .It \&F Ta regular file
2907 .It \&/ Ta directory
2908 .It \&@ Ta symbolic link
2910 .It \&> Ta door (not supported on Fx )
2911 .It \&| Ta named pipe (not supported on Fx )
2912 .It \&P Ta event port (not supported on Fx )
2915 Give more parsable tab-separated output, without header lines and without
2918 Display the path's inode change time as the first column of output.
2923 .Ar jailid filesystem
2926 Attaches the specified
2928 to the jail identified by JID
2930 From now on this file system tree can be managed from within a jail if the
2932 property has been set. To use this functionality, the jail needs the
2936 parameters set to 1 and the
2938 parameter set to a value lower than 2.
2942 for more information on managing jails and configuring the parameters above.
2946 .Ar jailid filesystem
2949 Detaches the specified
2951 from the jail identified by JID
2955 The following exit values are returned:
2956 .Bl -tag -offset 2n -width 2n
2958 Successful completion.
2962 Invalid command line options were specified.
2966 .It Sy Example 1 No Creating a Tn ZFS No File System Hierarchy
2968 The following commands create a file system named
2970 and a file system named
2974 is set for the parent file system, and is automatically inherited by the child
2976 .Bd -literal -offset 2n
2977 .Li # Ic zfs create pool/home
2978 .Li # Ic zfs set mountpoint=/home pool/home
2979 .Li # Ic zfs create pool/home/bob
2981 .It Sy Example 2 No Creating a Tn ZFS No Snapshot
2983 The following command creates a snapshot named
2985 This snapshot is mounted on demand in the
2987 directory at the root of the
2990 .Bd -literal -offset 2n
2991 .Li # Ic zfs snapshot pool/home/bob@yesterday
2993 .It Sy Example 3 No Creating and Destroying Multiple Snapshots
2995 The following command creates snapshots named
2999 and all of its descendent file systems. Each snapshot is mounted on demand in
3002 directory at the root of its file system. The second command destroys the newly
3004 .Bd -literal -offset 2n
3005 .Li # Ic zfs snapshot -r pool/home@yesterday
3006 .Li # Ic zfs destroy -r pool/home@yesterday
3008 .It Sy Example 4 No Disabling and Enabling File System Compression
3010 The following command disables the
3012 property for all file systems under
3014 The next command explicitly enables
3017 .Em pool/home/anne .
3018 .Bd -literal -offset 2n
3019 .Li # Ic zfs set compression=off pool/home
3020 .Li # Ic zfs set compression=on pool/home/anne
3022 .It Sy Example 5 No Listing Tn ZFS No Datasets
3024 The following command lists all active file systems and volumes in the system.
3025 Snapshots are displayed if the
3033 for more information on pool properties.
3034 .Bd -literal -offset 2n
3036 NAME USED AVAIL REFER MOUNTPOINT
3037 pool 450K 457G 18K /pool
3038 pool/home 315K 457G 21K /home
3039 pool/home/anne 18K 457G 18K /home/anne
3040 pool/home/bob 276K 457G 276K /home/bob
3042 .It Sy Example 6 No Setting a Quota on a Tn ZFS No File System
3044 The following command sets a quota of 50 Gbytes for
3046 .Bd -literal -offset 2n
3047 .Li # Ic zfs set quota=50G pool/home/bob
3049 .It Sy Example 7 No Listing Tn ZFS No Properties
3051 The following command lists all properties for
3053 .Bd -literal -offset 2n
3054 .Li # Ic zfs get all pool/home/bob
3055 NAME PROPERTY VALUE SOURCE
3056 pool/home/bob type filesystem -
3057 pool/home/bob creation Tue Jul 21 15:53 2009 -
3058 pool/home/bob used 21K -
3059 pool/home/bob available 20.0G -
3060 pool/home/bob referenced 21K -
3061 pool/home/bob compressratio 1.00x -
3062 pool/home/bob mounted yes -
3063 pool/home/bob quota 20G local
3064 pool/home/bob reservation none default
3065 pool/home/bob recordsize 128K default
3066 pool/home/bob mountpoint /home/bob default
3067 pool/home/bob sharenfs off default
3068 pool/home/bob checksum on default
3069 pool/home/bob compression on local
3070 pool/home/bob atime on default
3071 pool/home/bob devices on default
3072 pool/home/bob exec on default
3073 pool/home/bob setuid on default
3074 pool/home/bob readonly off default
3075 pool/home/bob jailed off default
3076 pool/home/bob snapdir hidden default
3077 pool/home/bob aclmode discard default
3078 pool/home/bob aclinherit restricted default
3079 pool/home/bob canmount on default
3080 pool/home/bob xattr on default
3081 pool/home/bob copies 1 default
3082 pool/home/bob version 5 -
3083 pool/home/bob utf8only off -
3084 pool/home/bob normalization none -
3085 pool/home/bob casesensitivity sensitive -
3086 pool/home/bob vscan off default
3087 pool/home/bob nbmand off default
3088 pool/home/bob sharesmb off default
3089 pool/home/bob refquota none default
3090 pool/home/bob refreservation none default
3091 pool/home/bob primarycache all default
3092 pool/home/bob secondarycache all default
3093 pool/home/bob usedbysnapshots 0 -
3094 pool/home/bob usedbydataset 21K -
3095 pool/home/bob usedbychildren 0 -
3096 pool/home/bob usedbyrefreservation 0 -
3097 pool/home/bob logbias latency default
3098 pool/home/bob dedup off default
3099 pool/home/bob mlslabel -
3100 pool/home/bob sync standard default
3101 pool/home/bob refcompressratio 1.00x -
3104 The following command gets a single property value.
3105 .Bd -literal -offset 2n
3106 .Li # Ic zfs get -H -o value compression pool/home/bob
3110 The following command lists all properties with local settings for
3112 .Bd -literal -offset 2n
3113 .Li # Ic zfs get -s local -o name,property,value all pool/home/bob
3115 pool/home/bob quota 20G
3116 pool/home/bob compression on
3118 .It Sy Example 8 No Rolling Back a Tn ZFS No File System
3120 The following command reverts the contents of
3122 to the snapshot named
3124 deleting all intermediate snapshots.
3125 .Bd -literal -offset 2n
3126 .Li # Ic zfs rollback -r pool/home/anne@yesterday
3128 .It Sy Example 9 No Creating a Tn ZFS No Clone
3130 The following command creates a writable file system whose initial contents are
3132 .Em pool/home/bob@yesterday .
3133 .Bd -literal -offset 2n
3134 .Li # Ic zfs clone pool/home/bob@yesterday pool/clone
3136 .It Sy Example 10 No Promoting a Tn ZFS No Clone
3138 The following commands illustrate how to test out changes to a file system, and
3139 then replace the original file system with the changed one, using clones, clone
3140 promotion, and renaming:
3141 .Bd -literal -offset 2n
3142 .Li # Ic zfs create pool/project/production
3146 .Pa /pool/project/production
3147 with data and continue with the following commands:
3148 .Bd -literal -offset 2n
3149 .Li # Ic zfs snapshot pool/project/production@today
3150 .Li # Ic zfs clone pool/project/production@today pool/project/beta
3154 .Pa /pool/project/beta
3155 and continue with the following commands:
3156 .Bd -literal -offset 2n
3157 .Li # Ic zfs promote pool/project/beta
3158 .Li # Ic zfs rename pool/project/production pool/project/legacy
3159 .Li # Ic zfs rename pool/project/beta pool/project/production
3162 Once the legacy version is no longer needed, it can be destroyed.
3163 .Bd -literal -offset 2n
3164 .Li # Ic zfs destroy pool/project/legacy
3166 .It Sy Example 11 No Inheriting Tn ZFS No Properties
3168 The following command causes
3174 property from their parent.
3175 .Bd -literal -offset 2n
3176 .Li # Ic zfs inherit checksum pool/home/bob pool/home/anne
3178 .It Sy Example 12 No Remotely Replicating Tn ZFS No Data
3180 The following commands send a full stream and then an incremental stream to a
3181 remote machine, restoring them into
3182 .Sy poolB/received/fs@a
3184 .Sy poolB/received/fs@b ,
3187 must contain the file system
3188 .Sy poolB/received ,
3189 and must not initially contain
3190 .Sy poolB/received/fs .
3191 .Bd -literal -offset 2n
3192 .Li # Ic zfs send pool/fs@a | ssh host zfs receive poolB/received/fs@a
3193 .Li # Ic zfs send -i a pool/fs@b | ssh host zfs receive poolB/received/fs
3202 The following command sends a full stream of
3203 .Sy poolA/fsA/fsB@snap
3204 to a remote machine, receiving it into
3205 .Sy poolB/received/fsA/fsB@snap .
3208 portion of the received snapshot's name is determined from the name of the sent
3211 must contain the file system
3212 .Sy poolB/received .
3214 .Sy poolB/received/fsA
3215 does not exist, it is created as an empty file system.
3216 .Bd -literal -offset 2n
3217 .Li # Ic zfs send poolA/fsA/fsB@snap | ssh host zfs receive -d poolB/received
3219 .It Sy Example 14 No Setting User Properties
3221 The following example sets the user-defined
3222 .Sy com.example:department
3223 property for a dataset.
3224 .Bd -literal -offset 2n
3225 .Li # Ic zfs set com.example:department=12345 tank/accounting
3227 .It Sy Example 15 No Performing a Rolling Snapshot
3229 The following example shows how to maintain a history of snapshots with a
3230 consistent naming scheme. To keep a week's worth of snapshots, the user
3231 destroys the oldest snapshot, renames the remaining snapshots, and then creates
3232 a new snapshot, as follows:
3233 .Bd -literal -offset 2n
3234 .Li # Ic zfs destroy -r pool/users@7daysago
3235 .Li # Ic zfs rename -r pool/users@6daysago @7daysago
3236 .Li # Ic zfs rename -r pool/users@5daysago @6daysago
3237 .Li # Ic zfs rename -r pool/users@4daysago @5daysago
3238 .Li # Ic zfs rename -r pool/users@3daysago @4daysago
3239 .Li # Ic zfs rename -r pool/users@2daysago @3daysago
3240 .Li # Ic zfs rename -r pool/users@yesterday @2daysago
3241 .Li # Ic zfs rename -r pool/users@today @yesterday
3242 .Li # Ic zfs snapshot -r pool/users@today
3248 Property Options on a ZFS File System
3251 The following command shows how to set
3253 property options to enable root access for a specific network on the
3255 file system. The contents of the
3260 .Bd -literal -offset 2n
3261 .Li # Ic zfs set sharenfs="maproot=root,network 192.168.0.0/24" tank/home
3264 Another way to write this command with the same result is:
3265 .Bd -literal -offset 2n
3266 .Li # Ic set zfs sharenfs="-maproot=root -network 192.168.0.0/24" tank/home
3272 Administration Permissions on a
3277 The following example shows how to set permissions so that user
3279 can create, destroy, mount, and take snapshots on
3284 .Bd -literal -offset 2n
3285 .Li # Ic zfs allow cindys create,destroy,mount,snapshot tank/cindys
3286 .Li # Ic zfs allow tank/cindys
3287 -------------------------------------------------------------
3288 Local+Descendent permissions on (tank/cindys)
3289 user cindys create,destroy,mount,snapshot
3290 -------------------------------------------------------------
3292 .It Sy Example 18 No Delegating Create Time Permissions on a Tn ZFS No Dataset
3294 The following example shows how to grant anyone in the group
3296 to create file systems in
3298 This syntax also allows staff members to destroy their own file systems, but
3299 not destroy anyone else's file system. The permissions on
3302 .Bd -literal -offset 2n
3303 .Li # Ic zfs allow staff create,mount tank/users
3304 .Li # Ic zfs allow -c destroy tank/users
3305 .Li # Ic zfs allow tank/users
3306 -------------------------------------------------------------
3307 Create time permissions on (tank/users)
3309 Local+Descendent permissions on (tank/users)
3310 group staff create,mount
3311 -------------------------------------------------------------
3315 Defining and Granting a Permission Set on a
3320 The following example shows how to define and grant a permission set on the
3322 file system. The permissions on
3325 .Bd -literal -offset 2n
3326 .Li # Ic zfs allow -s @pset create,destroy,snapshot,mount tank/users
3327 .Li # Ic zfs allow staff @pset tank/users
3328 .Li # Ic zfs allow tank/users
3329 -------------------------------------------------------------
3330 Permission sets on (tank/users)
3331 @pset create,destroy,mount,snapshot
3332 Create time permissions on (tank/users)
3334 Local+Descendent permissions on (tank/users)
3335 group staff @pset,create,mount
3336 -------------------------------------------------------------
3338 .It Sy Example 20 No Delegating Property Permissions on a Tn ZFS No Dataset
3340 The following example shows to grant the ability to set quotas and reservations
3343 file system. The permissions on
3346 .Bd -literal -offset 2n
3347 .Li # Ic zfs allow cindys quota,reservation users/home
3348 .Li # Ic zfs allow cindys
3349 -------------------------------------------------------------
3350 Local+Descendent permissions on (users/home)
3351 user cindys quota,reservation
3352 -------------------------------------------------------------
3353 .Li # Ic su - cindys
3354 .Li cindys% Ic zfs set quota=10G users/home/marks
3355 .Li cindys% Ic zfs get quota users/home/marks
3356 NAME PROPERTY VALUE SOURCE
3357 users/home/marks quota 10G local
3359 .It Sy Example 21 No Removing ZFS Delegated Permissions on a Tn ZFS No Dataset
3361 The following example shows how to remove the snapshot permission from the
3365 file system. The permissions on
3368 .Bd -literal -offset 2n
3369 .Li # Ic zfs unallow staff snapshot tank/users
3370 .Li # Ic zfs allow tank/users
3371 -------------------------------------------------------------
3372 Permission sets on (tank/users)
3373 @pset create,destroy,mount,snapshot
3374 Create time permissions on (tank/users)
3376 Local+Descendent permissions on (tank/users)
3377 group staff @pset,create,mount
3378 -------------------------------------------------------------
3380 .It Sy Example 22 Showing the differences between a snapshot and a ZFS Dataset
3382 The following example shows how to see what has changed between a prior
3383 snapshot of a ZFS Dataset and its current state. The
3385 option is used to indicate type information for the files affected.
3386 .Bd -literal -offset 2n
3387 .Li # Ic zfs diff tank/test@before tank/test
3389 M F /tank/test/linked (+1)
3390 R F /tank/test/oldname -> /tank/test/newname
3391 - F /tank/test/deleted
3392 + F /tank/test/created
3393 M F /tank/test/modified
3407 This manual page is a
3409 reimplementation of the
3413 modified and customized for
3415 and licensed under the
3416 Common Development and Distribution License
3421 implementation of this manual page was initially written by
3422 .An Martin Matuska Aq mm@FreeBSD.org .
projects / FreeBSD / FreeBSD.git / blob