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) 2011, 2014 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) 2014, Joyent, Inc. All rights reserved.
27 .\" Copyright (c) 2013, Steven Hartland <smh@FreeBSD.org>
28 .\" Copyright (c) 2016 Nexenta Systems, Inc. All Rights Reserved.
29 .\" Copyright (c) 2014, Xin LI <delphij@FreeBSD.org>
30 .\" Copyright (c) 2014-2015, The FreeBSD Foundation, All Rights Reserved.
31 .\" Copyright 2018 Joyent, Inc.
40 .Nd configures ZFS file systems
47 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... Ar filesystem
52 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
58 .Ar filesystem Ns | Ns Ar volume
63 .Ar filesystem Ns | Ns volume
66 .Op , Ns Ar snap Op % Ns Ar snap
71 .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
73 .Cm snapshot Ns | Ns Cm snap
75 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
76 .Ar filesystem@snapname Ns | Ns Ar volume@snapname
77 .Ar filesystem@snapname Ns | Ns Ar volume@snapname Ns ...
85 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
86 .Ar snapshot filesystem Ns | Ns Ar volume
93 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
94 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
99 .Ar filesystem Ns | Ns Ar volume
100 .Ar filesystem Ns | Ns Ar volume
104 .Ar snapshot snapshot
109 .Ar filesystem filesystem
112 .Op Fl r Ns | Ns Fl d Ar depth
114 .Op Fl o Ar property Ns Oo , Ns property Ns Oc Ns ...
115 .Op Fl t Ar type Ns Oo , Ns type Ns Oc Ns ...
116 .Oo Fl s Ar property Oc Ns ...
117 .Oo Fl S Ar property Oc Ns ...
118 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot | Ns Ar bookmark Ns ...
121 .Ar filesystem Ns | Ns Ar volume
124 .Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ...
125 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
128 .Op Fl r Ns | Ns Fl d Ar depth
130 .Op Fl o Ar all | field Ns Oo , Ns Ar field Oc Ns ...
131 .Op Fl t Ar type Ns Oo Ns , Ar type Oc Ns ...
132 .Op Fl s Ar source Ns Oo Ns , Ns Ar source Oc Ns ...
133 .Ar all | property Ns Oo Ns , Ns Ar property Oc Ns ...
134 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
139 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
147 .Fl a | Ar filesystem
151 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
152 .Oo Fl s Ar field Oc Ns ...
153 .Oo Fl S Ar field Oc Ns ...
154 .Op Fl t Ar type Ns Oo Ns , Ns Ar type Oc Ns ...
155 .Ar filesystem Ns | Ns Ar snapshot
159 .Op Fl o Ar field Ns Oo , Ns field Oc Ns ...
160 .Oo Fl s Ar field Oc Ns ...
161 .Oo Fl S Ar field Oc Ns ...
162 .Op Fl t Ar type Ns Oo Ns , Ns Ar type Oc Ns ...
163 .Ar filesystem Ns | Ns Ar snapshot
169 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
170 .Fl a | Ar filesystem
172 .Cm unmount Ns | Ns Cm umount
174 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
177 .Fl a | Ar filesystem
180 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
188 .Op Fl i Ar snapshot | Fl I Ar snapshot
193 .Op Fl i Ar snapshot Ns | Ns bookmark
194 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
198 .Fl t Ar receive_resume_token
200 .Cm receive Ns | Ns Cm recv
202 .Op Fl o Sy origin Ns = Ns Ar snapshot
203 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
205 .Cm receive Ns | Ns Cm recv
208 .Op Fl o Sy origin Ns = Ns Ar snapshot
211 .Cm receive Ns | Ns Cm recv
213 .Ar filesystem Ns | Ns Ar volume
216 .Ar filesystem Ns | Ns Ar volume
220 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
221 .Ar perm Ns | Ns Ar @setname Ns
222 .Oo Ns , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
223 .Ar filesystem Ns | Ns Ar volume
227 .Fl e Ns | Ns Cm everyone
228 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
230 .Ar filesystem Ns | Ns Ar volume
234 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
236 .Ar filesystem Ns | Ns Ar volume
241 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
243 .Ar filesystem Ns | Ns Ar volume
247 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
248 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
250 .Ar filesystem Ns | Ns Ar volume
254 .Fl e Ns | Ns Cm everyone
255 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
257 .Ar filesystem Ns | Ns Ar volume
262 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
264 .Ar filesystem Ns | Ns Ar volume
270 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
272 .Ar filesystem Ns | Ns Ar volume
276 .Ar tag snapshot Ns ...
280 .Op Fl r Ns | Ns Fl d Ar depth
281 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns
286 .Ar tag snapshot Ns ...
291 .Op Ar snapshot Ns | Ns Ar filesystem
296 .Op Fl m Ar memory_limit
301 .Ar jailid Ns | Ns Ar jailname filesystem
304 .Ar jailid Ns | Ns Ar jailname filesystem
312 storage pool, as described in
314 A dataset is identified by a unique path within the
316 namespace. For example:
317 .Bd -ragged -offset 4n
318 .No pool/ Ns Brq filesystem,volume,snapshot
321 where the maximum length of a dataset name is
325 A dataset can be one of the following:
332 can be mounted within the standard system namespace and behaves like other file
335 file systems are designed to be
337 compliant, known issues exist that prevent compliance in some cases.
338 Applications that depend on standards conformance might fail due to nonstandard
339 behavior when checking file system free space.
341 A logical volume exported as a raw or block device. This type of dataset should
342 only be used under special circumstances. File systems are typically used in
345 A read-only version of a file system or volume at a given point in time. It is
351 .Ss ZFS File System Hierarchy
354 storage pool is a logical collection of devices that provide space for
355 datasets. A storage pool is also the root of the
357 file system hierarchy.
359 The root of the pool can be accessed as a file system, such as mounting and
360 unmounting, taking snapshots, and setting properties. The physical storage
361 characteristics, however, are managed by the
367 for more information on creating and administering pools.
369 A snapshot is a read-only copy of a file system or volume. Snapshots can be
370 created extremely quickly, and initially consume no additional space within the
371 pool. As data within the active dataset changes, the snapshot consumes more
372 data than would otherwise be shared with the active dataset.
374 Snapshots can have arbitrary names. Snapshots of volumes can be cloned or
375 rolled back, but cannot be accessed independently.
377 File system snapshots can be accessed under the
379 directory in the root of the file system. Snapshots are automatically mounted
380 on demand and may be unmounted at regular intervals. The visibility of the
382 directory can be controlled by the
386 A clone is a writable volume or file system whose initial contents are the same
387 as another dataset. As with snapshots, creating a clone is nearly
388 instantaneous, and initially consumes no additional space.
390 Clones can only be created from a snapshot. When a snapshot is cloned, it
391 creates an implicit dependency between the parent and child. Even though the
392 clone is created somewhere else in the dataset hierarchy, the original snapshot
393 cannot be destroyed as long as a clone exists. The
395 property exposes this dependency, and the
397 command lists any such dependencies, if they exist.
399 The clone parent-child dependency relationship can be reversed by using the
401 subcommand. This causes the "origin" file system to become a clone of the
402 specified file system, which makes it possible to destroy the file system that
403 the clone was created from.
407 file system is a simple operation, so the number of file systems per system is
408 likely to be numerous. To cope with this,
410 automatically manages mounting and unmounting file systems without the need to
413 file. All automatically managed file systems are mounted by
417 By default, file systems are mounted under
421 is the name of the file system in the
423 namespace. Directories are created and destroyed as needed.
425 A file system can also have a mount point set in the
427 property. This directory is created as needed, and
429 automatically mounts the file system when the
431 command is invoked (without editing
435 property can be inherited, so if
441 automatically inherits a mount point of
448 prevents the file system from being mounted.
452 file systems can also be managed with traditional tools
453 .Pq Xr mount 8 , Xr umount 8 , Xr fstab 5 .
454 If a file system's mount point is set to
457 makes no attempt to manage the file system, and the administrator is
458 responsible for mounting and unmounting the file system.
461 dataset can be attached to a jail by using the
463 subcommand. You cannot attach a dataset to one jail and the children of the
464 same dataset to another jails. To allow management of the dataset from within
467 property has to be set and the jail needs access to the
471 property cannot be changed from within a jail. See
473 for information on how to allow mounting
475 datasets from within a jail.
478 dataset can be detached from a jail using the
482 After a dataset is attached to a jail and the jailed property is set, a jailed
483 file system cannot be mounted outside the jail, since the jail administrator
484 might have set the mount point to an unacceptable value.
486 Deduplication is the process for removing redundant data at the block-level,
487 reducing the total amount of data stored. If a file system has the
489 property enabled, duplicate data blocks are removed synchronously. The result
490 is that only unique data is stored and common components are shared among
492 .Ss Native Properties
493 Properties are divided into two types, native properties and user-defined (or
494 "user") properties. Native properties either export internal statistics or
497 behavior. In addition, native properties are either editable or read-only. User
498 properties have no effect on
500 behavior, but you can use them to annotate datasets in a way that is meaningful
501 in your environment. For more information about user properties, see the
502 .Qq Sx User Properties
505 Every dataset has a set of properties that export statistics about the dataset
506 as well as control various behaviors. Properties are inherited from the parent
507 unless overridden by the child. Some properties apply only to certain types of
508 datasets (file systems, volumes, or snapshots).
510 The values of numeric properties can be specified using human-readable suffixes
512 .Sy k , KB , M , Gb ,
515 for zettabyte). The following are all valid (and equal) specifications:
516 .Bd -ragged -offset 4n
520 The values of non-numeric properties are case sensitive and must be lowercase,
522 .Sy mountpoint , sharenfs , No and Sy sharesmb .
524 The following native properties consist of read-only statistics about the
525 dataset. These properties can be neither set, nor inherited. Native properties
526 apply to all dataset types unless otherwise noted.
529 The amount of space available to the dataset and all its children, assuming
530 that there is no other activity in the pool. Because space is shared within a
531 pool, availability can be limited by any number of factors, including physical
532 pool size, quotas, reservations, or other datasets within the pool.
534 This property can also be referred to by its shortened column name,
537 For non-snapshots, the compression ratio achieved for the
539 space of this dataset, expressed as a multiplier. The
541 property includes descendant datasets, and, for clones, does not include
542 the space shared with the origin snapshot. For snapshots, the
546 property. Compression can be turned on by running:
547 .Qq Nm Cm set compression=on Ar dataset
551 The time this dataset was created.
553 For snapshots, this property is a comma-separated list of filesystems or
554 volumes which are clones of this snapshot. The clones'
556 property is this snapshot. If the
558 property is not empty, then this snapshot can not be destroyed (even with the
566 if the snapshot has been marked for deferred destroy by using the
568 command. Otherwise, the property is
570 .It Sy filesystem_count
571 The total number of filesystems and volumes that exist under this location in the
573 This value is only available when a
576 been set somewhere in the tree under which the dataset resides.
577 .It Sy logicalreferenced
578 The amount of space that is
580 accessible by this dataset.
584 The logical space ignores the effect of the
588 properties, giving a quantity closer to the amount of data that applications
590 However, it does include space consumed by metadata.
592 This property can also be referred to by its shortened column name,
595 The amount of space that is
597 consumed by this dataset and all its descendents.
601 The logical space ignores the effect of the
605 properties, giving a quantity closer to the amount of data that applications
608 This property can also be referred to by its shortened column name,
611 For file systems, indicates whether the file system is currently mounted. This
612 property can be either
617 For cloned file systems or volumes, the snapshot from which the clone was
618 created. See also the
621 .It Sy receive_resume_token
622 For filesystems or volumes which have saved partially-completed state from
624 this opaque token can be provided to
626 to resume and complete the
629 The amount of data that is accessible by this dataset, which may or may not be
630 shared with other datasets in the pool. When a snapshot or clone is created, it
631 initially references the same amount of space as the file system or snapshot it
632 was created from, since its contents are identical.
634 This property can also be referred to by its shortened column name,
636 .It Sy refcompressratio
637 The compression ratio achieved for the
639 space of this dataset, expressed as a multiplier. See also the
642 .It Sy snapshot_count
643 The total number of snapshots that exist under this location in the dataset tree.
644 This value is only available when a
646 has been set somewhere
647 in the tree under which the dataset resides.
650 .Sy filesystem , volume , No or Sy snapshot .
652 The amount of space consumed by this dataset and all its descendents. This is
653 the value that is checked against this dataset's quota and reservation. The
654 space used does not include this dataset's reservation, but does take into
655 account the reservations of any descendent datasets. The amount of space that a
656 dataset consumes from its parent, as well as the amount of space that are freed
657 if this dataset is recursively destroyed, is the greater of its space used and
660 When snapshots (see the
662 section) are created, their space is
663 initially shared between the snapshot and the file system, and possibly with
664 previous snapshots. As the file system changes, space that was previously
665 shared becomes unique to the snapshot, and counted in the snapshot's space
666 used. Additionally, deleting snapshots can increase the amount of space unique
667 to (and used by) other snapshots.
669 The amount of space used, available, or referenced does not take into account
670 pending changes. Pending changes are generally accounted for within a few
671 seconds. Committing a change to a disk using
675 does not necessarily guarantee that the space usage information is updated
680 properties decompose the
682 properties into the various reasons that space is used. Specifically,
684 .Sy usedbysnapshots + usedbydataset + usedbychildren + usedbyrefreservation .
685 These properties are only available for datasets created
688 pool version 13 pools and higher.
689 .It Sy usedbysnapshots
690 The amount of space consumed by snapshots of this dataset. In particular, it is
691 the amount of space that would be freed if all of this dataset's snapshots were
692 destroyed. Note that this is not simply the sum of the snapshots'
694 properties because space can be shared by multiple snapshots.
696 The amount of space used by this dataset itself, which would be freed if the
697 dataset were destroyed (after first removing any
699 and destroying any necessary snapshots or descendents).
700 .It Sy usedbychildren
701 The amount of space used by children of this dataset, which would be freed if
702 all the dataset's children were destroyed.
703 .It Sy usedbyrefreservation
704 The amount of space used by a
706 set on this dataset, which would be freed if the
709 .It Sy userused@ Ns Ar user
710 The amount of space consumed by the specified user in this dataset. Space is
711 charged to the owner of each file, as displayed by
713 The amount of space charged is displayed by
719 subcommand for more information.
721 Unprivileged users can access only their own space usage. The root user, or a
722 user who has been granted the
726 can access everyone's usage.
730 properties are not displayed by
732 The user's name must be appended after the
734 symbol, using one of the following forms:
735 .Bl -bullet -offset 2n
737 POSIX name (for example,
740 POSIX numeric ID (for example,
744 This property is set to the number of user holds on this snapshot. User holds
748 .It Sy groupused@ Ns Ar group
749 The amount of space consumed by the specified group in this dataset. Space is
750 charged to the group of each file, as displayed by
753 .Sy userused@ Ns Ar user
754 property for more information.
756 Unprivileged users can only access their own groups' space usage. The root
757 user, or a user who has been granted the
761 can access all groups' usage.
762 .It Sy volblocksize Ns = Ns Ar blocksize
763 For volumes, specifies the block size of the volume. The
765 cannot be changed once the volume has been written, so it should be set at
766 volume creation time. The default
768 for volumes is 8 Kbytes. Any
769 power of 2 from 512 bytes to 128 Kbytes is valid.
771 This property can also be referred to by its shortened column name,
776 space written to this dataset since the previous snapshot.
777 .It Sy written@ Ns Ar snapshot
780 space written to this dataset since the specified snapshot. This is the space
781 that is referenced by this dataset but was not referenced by the specified
786 may be specified as a short snapshot name (just the part after the
788 in which case it will be interpreted as a snapshot in the same filesystem as
791 may be a full snapshot name
792 .Pq Em filesystem@snapshot ,
793 which for clones may be a snapshot in the origin's filesystem (or the origin of
794 the origin's filesystem, etc).
797 The following native properties can be used to change the behavior of a
802 .Sy aclinherit Ns = Ns Cm discard |
810 entries are inherited when files and directories are created. A file system
817 entries. A file system with an
821 only inherits inheritable
823 entries that specify "deny" permissions. The property value
825 (the default) removes the
831 entry is inherited. A file system with an
835 inherits all inheritable
837 entries without any modifications made to the
839 entries when they are inherited. A file system with an
843 has the same meaning as
846 .Em owner@ , group@ , No and Em everyone@ Tn ACE Ns s
847 inherit the execute permission only if the file creation mode also requests the
850 When the property value is set to
852 files are created with a mode determined by the inheritable
856 exist that affect the mode, then the mode is set in accordance to the requested
857 mode from the application.
858 .It Sy aclmode Ns = Ns Cm discard | groupmask | passthrough | restricted
863 A file system with an
867 (the default) deletes all
869 entries that do not represent the mode of the file. An
873 reduces permissions granted in all
877 such that they are no greater than the group permissions specified by
879 A file system with an
883 indicates that no changes are made to the
885 other than creating or updating the necessary
887 entries to represent the new mode of the file or directory.
894 operation to return an error when used on any file or directory which has
897 whose entries can not be represented by a mode.
899 is required to change the set user ID, set group ID, or sticky bits on a file
900 or directory, as they do not have equivalent
905 on a file or directory with a non-trivial
911 you must first remove all
913 entries which do not represent the current mode.
914 .It Sy atime Ns = Ns Cm on | off
915 Controls whether the access time for files is updated when they are read.
916 Turning this property off avoids producing write traffic when reading files and
917 can result in significant performance gains, though it might confuse mailers
918 and other similar utilities. The default value is
920 .It Sy canmount Ns = Ns Cm on | off | noauto
921 If this property is set to
923 the file system cannot be mounted, and is ignored by
924 .Qq Nm Cm mount Fl a .
925 Setting this property to
927 is similar to setting the
931 except that the dataset still has a normal
933 property, which can be inherited. Setting this property to
935 allows datasets to be used solely as a mechanism to inherit properties. One
937 .Sy canmount Ns = Ns Cm off
938 is to have two datasets with the same
940 so that the children of both datasets appear in the same directory, but might
941 have different inherited characteristics.
945 value is set, a dataset can only be mounted and unmounted explicitly. The
946 dataset is not mounted automatically when the dataset is created or imported,
947 nor is it mounted by the
949 command or unmounted by the
950 .Qq Nm Cm umount Fl a
953 This property is not inherited.
954 .It Sy checksum Ns = Ns Cm on | off | fletcher2 | fletcher4 | sha256 | noparity | sha512 | skein
955 Controls the checksum used to verify data integrity. The default value is
957 which automatically selects an appropriate algorithm (currently,
959 but this may change in future releases). The value
961 disables integrity checking on user data.
965 disables integrity but also disables maintaining parity for user data. This
966 setting is used internally by a dump device residing on a RAID-Z pool and should
967 not be used by any other dataset.
968 Disabling checksums is
970 a recommended practice.
975 checksum algorithms require enabling the appropriate features on the pool.
978 for more information on these algorithms.
980 Changing this property affects only newly-written data.
982 Salted checksum algorithms
984 are currently not supported for any filesystem on the boot pools.
985 .It Sy compression Ns = Ns Cm on | off | lzjb | gzip | gzip- Ns Ar N | Cm zle | Cm lz4
986 Controls the compression algorithm used for this dataset.
987 Setting compression to
989 indicates that the current default compression algorithm should be used.
990 The default balances compression and decompression speed, with compression
991 ratio and is expected to work well on a wide variety of workloads.
992 Unlike all other settings for this property, on does not select a fixed
994 As new compression algorithms are added to ZFS and enabled on a pool, the
995 default compression algorithm may change.
996 The current default compression algorthm is either
1004 compression algorithm is optimized for performance while providing decent data
1005 compression. Setting compression to
1009 compression algorithm. The
1011 compression algorithm uses the same compression as the
1013 command. You can specify the
1015 level by using the value
1019 is an integer from 1 (fastest) to 9 (best compression ratio). Currently,
1023 (which is also the default for
1027 compression algorithm compresses runs of zeros.
1031 compression algorithm is a high-performance replacement
1034 algorithm. It features significantly faster
1035 compression and decompression, as well as a moderately higher
1036 compression ratio than
1038 but can only be used on pools with
1044 .Xr zpool-features 7
1045 for details on ZFS feature flags and the
1049 This property can also be referred to by its shortened column name
1051 Changing this property affects only newly-written data.
1052 .It Sy copies Ns = Ns Cm 1 | 2 | 3
1053 Controls the number of copies of data stored for this dataset. These copies are
1054 in addition to any redundancy provided by the pool, for example, mirroring or
1055 RAID-Z. The copies are stored on different disks, if possible. The space used
1056 by multiple copies is charged to the associated file and dataset, changing the
1058 property and counting against quotas and reservations.
1060 Changing this property only affects newly-written data. Therefore, set this
1061 property at file system creation time by using the
1062 .Fl o Cm copies= Ns Ar N
1064 .It Sy dedup Ns = Ns Cm on | off | verify | sha256 Ns Oo Cm ,verify Oc | Sy sha512 Ns Oo Cm ,verify Oc | Sy skein Ns Oo Cm ,verify Oc
1065 Configures deduplication for a dataset. The default value is
1067 The default deduplication checksum is
1069 (this may change in the future).
1072 is enabled, the checksum defined here overrides the
1074 property. Setting the value to
1076 has the same effect as the setting
1082 will do a byte-to-byte comparsion in case of two blocks having the same
1083 signature to make sure the block contents are identical.
1084 .It Sy devices Ns = Ns Cm on | off
1087 property is currently not supported on
1089 .It Sy exec Ns = Ns Cm on | off
1090 Controls whether processes can be executed from within this file system. The
1093 .It Sy mlslabel Ns = Ns Ar label | Cm none
1096 property is currently not supported on
1098 .It Sy filesystem_limit Ns = Ns Ar count | Cm none
1099 Limits the number of filesystems and volumes that can exist under this point in
1101 The limit is not enforced if the user is allowed to change
1104 .Sy filesystem_limit
1105 on a descendent of a filesystem that
1107 .Sy filesystem_limit
1108 does not override the ancestor's
1109 .Sy filesystem_limit ,
1110 but rather imposes an additional limit.
1111 This feature must be enabled to be used
1113 .Xr zpool-features 7
1115 .It Sy mountpoint Ns = Ns Ar path | Cm none | legacy
1116 Controls the mount point used for this file system. See the
1118 section for more information on how this property is used.
1122 property is changed for a file system, the file system and any children that
1123 inherit the mount point are unmounted. If the new value is
1125 then they remain unmounted. Otherwise, they are automatically remounted in the
1126 new location if the property was previously
1130 or if they were mounted before the property was changed. In addition, any
1131 shared file systems are unshared and shared in the new location.
1132 .It Sy nbmand Ns = Ns Cm on | off
1135 property is currently not supported on
1137 .It Sy primarycache Ns = Ns Cm all | none | metadata
1138 Controls what is cached in the primary cache (ARC). If this property is set to
1140 then both user data and metadata is cached. If this property is set to
1142 then neither user data nor metadata is cached. If this property is set to
1144 then only metadata is cached. The default value is
1146 .It Sy quota Ns = Ns Ar size | Cm none
1147 Limits the amount of space a dataset and its descendents can consume. This
1148 property enforces a hard limit on the amount of space used. This includes all
1149 space consumed by descendents, including file systems and snapshots. Setting a
1150 quota on a descendent of a dataset that already has a quota does not override
1151 the ancestor's quota, but rather imposes an additional limit.
1153 Quotas cannot be set on volumes, as the
1155 property acts as an implicit quota.
1156 .It Sy snapshot_limit Ns = Ns Ar count | Cm none
1157 Limits the number of snapshots that can be created on a dataset and its
1161 on a descendent of a dataset that already
1164 does not override the ancestor's
1165 .Sy snapshot_limit ,
1167 rather imposes an additional limit.
1168 The limit is not enforced if the user is
1169 allowed to change the limit.
1170 For example, this means that recursive snapshots
1171 taken from the global zone are counted against each delegated dataset within
1173 This feature must be enabled to be used
1175 .Xr zpool-features 7
1177 .It Sy userquota@ Ns Ar user Ns = Ns Ar size | Cm none
1178 Limits the amount of space consumed by the specified user.
1183 space calculation does not include space that is used by descendent datasets,
1184 such as snapshots and clones. User space consumption is identified by the
1185 .Sy userspace@ Ns Ar user
1188 Enforcement of user quotas may be delayed by several seconds. This delay means
1189 that a user might exceed their quota before the system notices that they are
1190 over quota and begins to refuse additional writes with the
1192 error message. See the
1194 subcommand for more information.
1196 Unprivileged users can only access their own groups' space usage. The root
1197 user, or a user who has been granted the
1201 can get and set everyone's quota.
1203 This property is not available on volumes, on file systems before version 4, or
1204 on pools before version 15. The
1205 .Sy userquota@ Ns ...
1206 properties are not displayed by
1208 The user's name must be appended after the
1210 symbol, using one of the following forms:
1211 .Bl -bullet -offset 2n
1213 POSIX name (for example,
1216 POSIX numeric ID (for example,
1219 .It Sy groupquota@ Ns Ar group Ns = Ns Ar size | Cm none
1220 Limits the amount of space consumed by the specified group. Group space
1221 consumption is identified by the
1222 .Sy userquota@ Ns Ar user
1225 Unprivileged users can access only their own groups' space usage. The root
1226 user, or a user who has been granted the
1230 can get and set all groups' quotas.
1231 .It Sy readonly Ns = Ns Cm on | off
1232 Controls whether this dataset can be modified. The default value is
1234 .It Sy recordsize Ns = Ns Ar size
1235 Specifies a suggested block size for files in the file system. This property is
1236 designed solely for use with database workloads that access files in fixed-size
1239 automatically tunes block sizes according to internal algorithms optimized for
1240 typical access patterns.
1242 For databases that create very large files but access them in small random
1243 chunks, these algorithms may be suboptimal. Specifying a
1245 greater than or equal to the record size of the database can result in
1246 significant performance gains. Use of this property for general purpose file
1247 systems is strongly discouraged, and may adversely affect performance.
1249 The size specified must be a power of two greater than or equal to 512 and less
1250 than or equal to 128 Kbytes.
1253 feature is enabled on the pool, the size may be up to 1 Mbyte.
1255 .Xr zpool-features 7
1256 for details on ZFS feature flags.
1258 Changing the file system's
1260 affects only files created afterward; existing files are unaffected.
1262 This property can also be referred to by its shortened column name,
1264 .It Sy redundant_metadata Ns = Ns Cm all | most
1265 Controls what types of metadata are stored redundantly.
1266 ZFS stores an extra copy of metadata, so that if a single block is corrupted,
1267 the amount of user data lost is limited.
1268 This extra copy is in addition to any redundancy provided at the pool level
1269 .Pq e.g. by mirroring or RAID-Z ,
1270 and is in addition to an extra copy specified by the
1273 .Pq up to a total of 3 copies .
1274 For example if the pool is mirrored,
1275 .Cm copies Ns = Ns Ar 2 ,
1277 .Cm redundant_metadata Ns = Ns Ar most ,
1279 stores 6 copies of most metadata, and 4 copies of data and some
1284 ZFS stores an extra copy of all metadata.
1286 single on-disk block is corrupt, at worst a single block of user data
1295 ZFS stores an extra copy of most types of
1297 This can improve performance of random writes, because less
1298 metadata must be written.
1299 In practice, at worst about 100 blocks
1304 of user data can be lost if a single
1305 on-disk block is corrupt.
1306 The exact behavior of which metadata blocks
1307 are stored redundantly may change in future releases.
1309 The default value is
1311 .It Sy refquota Ns = Ns Ar size | Cm none
1312 Limits the amount of space a dataset can consume. This property enforces a hard
1313 limit on the amount of space used. This hard limit does not include space used
1314 by descendents, including file systems and snapshots.
1315 .It Sy refreservation Ns = Ns Ar size | Cm none | Cm auto
1316 The minimum amount of space guaranteed to a dataset, not including its
1317 descendents. When the amount of space used is below this value, the dataset is
1318 treated as if it were taking up the amount of space specified by
1319 .Sy refreservation .
1322 reservation is accounted for in the parent datasets' space used, and counts
1323 against the parent datasets' quotas and reservations.
1327 is set, a snapshot is only allowed if there is enough free pool space outside
1328 of this reservation to accommodate the current number of "referenced" bytes in
1335 a volume is thick provisioned or not sparse.
1336 .Sy refreservation Ns = Cm auto
1337 is only supported on volumes.
1340 in the Native Properties
1341 section for more information about sparse volumes.
1343 This property can also be referred to by its shortened column name,
1345 .It Sy reservation Ns = Ns Ar size | Cm none
1346 The minimum amount of space guaranteed to a dataset and its descendents. When
1347 the amount of space used is below this value, the dataset is treated as if it
1348 were taking up the amount of space specified by its reservation. Reservations
1349 are accounted for in the parent datasets' space used, and count against the
1350 parent datasets' quotas and reservations.
1352 This property can also be referred to by its shortened column name,
1354 .It Sy secondarycache Ns = Ns Cm all | none | metadata
1355 Controls what is cached in the secondary cache (L2ARC). If this property is set
1358 then both user data and metadata is cached. If this property is set to
1360 then neither user data nor metadata is cached. If this property is set to
1362 then only metadata is cached. The default value is
1364 .It Sy setuid Ns = Ns Cm on | off
1365 Controls whether the
1367 bit is respected for the file system. The default value is
1369 .It Sy sharesmb Ns = Ns Cm on | off | Ar opts
1372 property currently has no effect on
1374 .It Sy sharenfs Ns = Ns Cm on | off | Ar opts
1375 Controls whether the file system is shared via
1377 and what options are used. A file system with a
1381 is managed the traditional way via
1383 Otherwise, the file system is automatically shared and unshared with the
1387 commands. If the property is set to
1391 export options are used. Otherwise,
1393 export options are equivalent to the contents of this property. The export
1394 options may be comma-separated. See
1396 for a list of valid options.
1400 property is changed for a dataset, the
1403 .It Sy logbias Ns = Ns Cm latency | throughput
1406 about handling of synchronous requests in this dataset.
1413 will use pool log devices (if configured) to handle the requests at low
1419 will not use configured pool log devices.
1421 will instead optimize synchronous operations for global pool throughput and
1422 efficient use of resources.
1423 .It Sy snapdir Ns = Ns Cm hidden | visible
1424 Controls whether the
1426 directory is hidden or visible in the root of the file system as discussed in
1429 section. The default value is
1431 .It Sy sync Ns = Ns Cm standard | always | disabled
1432 Controls the behavior of synchronous requests (e.g.
1434 O_DSYNC). This property accepts the following values:
1435 .Bl -tag -offset 4n -width 8n
1437 This is the POSIX specified behavior of ensuring all synchronous requests are
1438 written to stable storage and all devices are flushed to ensure data is not
1439 cached by device controllers (this is the default).
1441 All file system transactions are written and flushed before their system calls
1442 return. This has a large performance penalty.
1444 Disables synchronous requests. File system transactions are only committed to
1445 stable storage periodically. This option will give the highest performance.
1446 However, it is very dangerous as
1448 would be ignoring the synchronous transaction demands of applications such as
1451 Administrators should only use this option when the risks are understood.
1453 .It Sy volsize Ns = Ns Ar size
1454 For volumes, specifies the logical size of the volume. By default, creating a
1455 volume establishes a reservation of equal size. For storage pools with a
1456 version number of 9 or higher, a
1458 is set instead. Any changes to
1460 are reflected in an equivalent change to the reservation (or
1461 .Sy refreservation ) .
1464 can only be set to a multiple of
1468 The reservation is kept equal to the volume's logical size to prevent
1469 unexpected behavior for consumers. Without the reservation, the volume could
1470 run out of space, resulting in undefined behavior or data corruption, depending
1471 on how the volume is used. These effects can also occur when the volume size is
1472 changed while it is in use (particularly when shrinking the size). Extreme care
1473 should be used when adjusting the volume size.
1475 Though not recommended, a "sparse volume" (also known as "thin provisioned")
1476 can be created by specifying the
1479 .Qq Nm Cm create Fl V
1480 command, or by changing the value of the
1484 property on pool version 8 or earlier
1486 after the volume has been created.
1487 A "sparse volume" is a volume where the value of
1489 is less then the size of the volume plus the space required to store its
1491 Consequently, writes to a sparse volume can fail with
1493 when the pool is low on space. For a sparse volume, changes to
1495 are not reflected in the
1496 .Sy refreservation .
1497 A volume that is not sparse is said to be "thick provisioned".
1498 A sparse volume can become thick provisioned by setting
1502 .It Sy volmode Ns = Ns Cm default | geom | dev | none
1503 This property specifies how volumes should be exposed to the OS.
1508 providers, providing maximal functionality.
1511 exposes volumes only as cdev device in devfs.
1512 Such volumes can be accessed only as raw disk device files, i.e. they
1513 can not be partitioned, mounted, participate in RAIDs, etc, but they
1514 are faster, and in some use scenarios with untrusted consumer, such as
1515 NAS or VM storage, can be more safe.
1516 Volumes with property set to
1518 are not exposed outside ZFS, but can be snapshoted, cloned, replicated, etc,
1519 that can be suitable for backup purposes.
1522 means that volumes exposition is controlled by system-wide sysctl/tunable
1523 .Va vfs.zfs.vol.mode ,
1529 are encoded as 1, 2 and 3 respectively.
1530 The default values is
1532 This property can be changed any time, but so far it is processed only
1533 during volume creation and pool import.
1534 .It Sy vscan Ns = Ns Cm off | on
1537 property is currently not supported on
1539 .It Sy xattr Ns = Ns Cm off | on
1542 property is currently not supported on
1544 .It Sy jailed Ns = Ns Cm off | on
1545 Controls whether the dataset is managed from a jail. See the
1547 section for more information. The default value is
1551 The following three properties cannot be changed after the file system is
1552 created, and therefore, should be set when the file system is created. If the
1553 properties are not set with the
1557 commands, these properties are inherited from the parent dataset. If the parent
1558 dataset lacks these properties due to having been created prior to these
1559 features being supported, the new file system will have the default values for
1562 .It Sy casesensitivity Ns = Ns Cm sensitive | insensitive | mixed
1563 Indicates whether the file name matching algorithm used by the file system
1564 should be case-sensitive, case-insensitive, or allow a combination of both
1565 styles of matching. The default value for the
1569 Traditionally, UNIX and POSIX file systems have case-sensitive file names.
1575 property indicates that the
1576 file system can support requests for both case-sensitive and case-insensitive
1578 .It Sy normalization Ns = Ns Cm none | formC | formD | formKC | formKD
1579 Indicates whether the file system should perform a
1581 normalization of file names whenever two file names are compared, and which
1582 normalization algorithm should be used. File names are always stored
1583 unmodified, names are normalized as part of any comparison process. If this
1584 property is set to a legal value other than
1588 property was left unspecified, the
1590 property is automatically set to
1592 The default value of the
1596 This property cannot be changed after the file system is created.
1597 .It Sy utf8only Ns = Ns Cm on | off
1598 Indicates whether the file system should reject file names that include
1599 characters that are not present in the
1601 character code set. If this property is explicitly set to
1603 the normalization property must either not be explicitly set or be set to
1605 The default value for the
1609 This property cannot be changed after the file system is created.
1613 .Sy casesensitivity , normalization , No and Sy utf8only
1614 properties are also new permissions that can be assigned to non-privileged
1617 delegated administration feature.
1618 .Ss Temporary Mount Point Properties
1619 When a file system is mounted, either through
1621 for legacy mounts or the
1623 command for normal file systems, its mount options are set according to its
1624 properties. The correlation between properties and mount options is as follows:
1625 .Bl -column -offset 4n "PROPERTY" "MOUNT OPTION"
1626 .It "PROPERTY MOUNT OPTION"
1627 .It "atime atime/noatime"
1628 .It "exec exec/noexec"
1629 .It "readonly ro/rw"
1630 .It "setuid suid/nosuid"
1633 In addition, these options can be set on a per-mount basis using the
1635 option, without affecting the property that is stored on disk. The values
1636 specified on the command line override the values stored in the dataset. These
1637 properties are reported as "temporary" by the
1639 command. If the properties are changed while the dataset is mounted, the new
1640 setting overrides any temporary settings.
1642 In addition to the standard native properties,
1644 supports arbitrary user properties. User properties have no effect on
1646 behavior, but applications or administrators can use them to annotate datasets
1647 (file systems, volumes, and snapshots).
1649 User property names must contain a colon
1651 character to distinguish them from native properties. They may contain
1652 lowercase letters, numbers, and the following punctuation characters: colon
1660 The expected convention is that the property name is divided into two portions
1662 .Em module Ns Sy \&: Ns Em property ,
1663 but this namespace is not enforced by
1665 User property names can be at most 256 characters, and cannot begin with a dash
1668 When making programmatic use of user properties, it is strongly suggested to
1673 component of property names to reduce the chance that two
1674 independently-developed packages use the same property name for different
1675 purposes. Property names beginning with
1677 are reserved for use by Sun Microsystems.
1679 The values of user properties are arbitrary strings, are always inherited, and
1680 are never validated. All of the commands that operate on properties
1687 can be used to manipulate both native properties and user properties. Use the
1689 command to clear a user property. If the property is not defined in any parent
1690 dataset, it is removed entirely. Property values are limited to 1024
1693 All subcommands that modify state are logged persistently to the pool in their
1701 Displays a help message.
1706 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1712 file system. The file system is automatically mounted according to the
1714 property inherited from the parent.
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. Any property specified on the command
1723 option is ignored. If the target filesystem already exists, the operation
1724 completes successfully.
1726 Newly created file system is not mounted.
1727 .It Fl o Ar property Ns = Ns Ar value
1728 Sets the specified property as if the command
1729 .Qq Nm Cm set Ar property Ns = Ns Ar value
1730 was invoked at the same time the dataset was created. Any editable
1732 property can also be set at creation time. Multiple
1734 options can be specified. An error results if the same property is specified in
1743 .Op Fl b Ar blocksize
1744 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1749 Creates a volume of the given size. The volume is exported as a block device in
1750 .Pa /dev/zvol/path ,
1753 is the name of the volume in the
1755 namespace. The size represents the logical size as exported by the device. By
1756 default, a reservation of equal size is created.
1759 is automatically rounded up to the nearest 128 Kbytes to ensure that
1760 the volume has an integral number of blocks regardless of
1762 .Bl -tag -width indent
1764 Creates all the non-existing parent datasets. Datasets created in this manner
1765 are automatically mounted according to the
1767 property inherited from their parent. Any property specified on the command
1770 option is ignored. If the target filesystem already exists, the operation
1771 completes successfully.
1773 Creates a sparse volume with no reservation. See
1776 .Qq Sx Native Properties
1777 section for more information about sparse volumes.
1778 .It Fl b Ar blocksize
1780 .Fl o Cm volblocksize Ns = Ns Ar blocksize .
1781 If this option is specified in conjunction with
1782 .Fl o Cm volblocksize ,
1783 the resulting behavior is undefined.
1784 .It Fl o Ar property Ns = Ns Ar value
1785 Sets the specified property as if the
1786 .Qq Nm Cm set Ar property Ns = Ns Ar value
1787 command was invoked at the same time the dataset was created. Any editable
1789 property can also be set at creation time. Multiple
1791 options can be specified. An error results if the same property is specified in
1800 .Ar filesystem Ns | Ns Ar volume
1803 Destroys the given dataset. By default, the command unshares any file systems
1804 that are currently shared, unmounts any file systems that are currently
1805 mounted, and refuses to destroy a dataset that has active dependents (children
1807 .Bl -tag -width indent
1809 Recursively destroy all children.
1811 Recursively destroy all dependents, including cloned file systems outside the
1814 Force an unmount of any file systems using the
1815 .Qq Nm Cm unmount Fl f
1816 command. This option has no effect on non-file systems or unmounted file
1819 Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in
1820 conjunction with the
1824 flags to determine what data would be deleted.
1826 Print machine-parsable verbose information about the deleted data.
1828 Print verbose information about the deleted data.
1831 Extreme care should be taken when applying either the
1835 options, as they can destroy large portions of a pool and cause unexpected
1836 behavior for mounted file systems in use.
1843 .Op % Ns Ar snapname
1848 The given snapshots are destroyed immediately if and only if the
1852 option would have destroyed it. Such immediate destruction would occur, for
1853 example, if the snapshot had no clones and the user-initiated reference count
1856 If a snapshot does not qualify for immediate destruction, it is marked for
1857 deferred deletion. In this state, it exists as a usable, visible snapshot until
1858 both of the preconditions listed above are met, at which point it is destroyed.
1860 An inclusive range of snapshots may be specified by separating the
1861 first and last snapshots with a percent sign
1863 The first and/or last snapshots may be left blank, in which case the
1864 filesystem's oldest or newest snapshot will be implied.
1867 (or ranges of snapshots) of the same filesystem or volume may be specified
1868 in a comma-separated list of snapshots.
1869 Only the snapshot's short name (the
1872 should be specified when using a range or comma-separated list to identify
1874 .Bl -tag -width indent
1876 Destroy (or mark for deferred deletion) all snapshots with this name in
1877 descendent file systems.
1879 Recursively destroy all clones of these snapshots, including the clones,
1880 snapshots, and children.
1881 If this flag is specified, the
1883 flag will have no effect.
1885 Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in
1886 conjunction with the
1890 flags to determine what data would be deleted.
1892 Print machine-parsable verbose information about the deleted data.
1894 Print verbose information about the deleted data.
1896 Defer snapshot deletion.
1899 Extreme care should be taken when applying either the
1903 options, as they can destroy large portions of a pool and cause unexpected
1904 behavior for mounted file systems in use.
1908 .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
1911 The given bookmark is destroyed.
1914 .Cm snapshot Ns | Ns Cm snap
1916 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1917 .Ar filesystem@snapname Ns | Ns volume@snapname
1918 .Ar filesystem@snapname Ns | Ns volume@snapname Ns ...
1921 Creates snapshots with the given names. All previous modifications by
1922 successful system calls to the file system are part of the snapshots.
1923 Snapshots are taken atomically, so that all snapshots correspond to the same
1924 moment in time. See the
1926 section for details.
1927 .Bl -tag -width indent
1929 Recursively create snapshots of all descendent datasets
1930 .It Fl o Ar property Ns = Ns Ar value
1931 Sets the specified property; see
1942 Roll back the given dataset to a previous snapshot. When a dataset is rolled
1943 back, all data that has changed since the snapshot is discarded, and the
1944 dataset reverts to the state at the time of the snapshot. By default, the
1945 command refuses to roll back to a snapshot other than the most recent one. In
1946 order to do so, all intermediate snapshots and bookmarks must be destroyed
1953 options do not recursively destroy the child snapshots of a
1955 Only direct snapshots of the specified filesystem
1956 are destroyed by either of these options.
1957 To completely roll back a
1958 recursive snapshot, you must rollback the individual child snapshots.
1959 .Bl -tag -width indent
1961 Destroy any snapshots and bookmarks more recent than the one specified.
1963 Destroy any more recent snapshots and bookmarks, as well as any clones of those
1968 option to force an unmount of any clone file systems that are to be destroyed.
1974 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1975 .Ar snapshot filesystem Ns | Ns Ar volume
1978 Creates a clone of the given snapshot. See the
1980 section for details. The target dataset can be located anywhere in the
1982 hierarchy, and is created as the same type as the original.
1983 .Bl -tag -width indent
1985 Creates all the non-existing parent datasets. Datasets created in this manner
1986 are automatically mounted according to the
1988 property inherited from their parent. If the target filesystem or volume
1989 already exists, the operation completes successfully.
1990 .It Fl o Ar property Ns = Ns Ar value
1991 Sets the specified property; see
1998 .Ar clone-filesystem
2001 Promotes a clone file system to no longer be dependent on its "origin"
2002 snapshot. This makes it possible to destroy the file system that the clone was
2003 created from. The clone parent-child dependency relationship is reversed, so
2004 that the origin file system becomes a clone of the specified file system.
2006 The snapshot that was cloned, and any snapshots previous to this snapshot, are
2007 now owned by the promoted clone. The space they use moves from the origin file
2008 system to the promoted clone, so enough space must be available to accommodate
2009 these snapshots. No new space is consumed by this operation, but the space
2010 accounting is adjusted. The promoted clone must not have any conflicting
2011 snapshot names of its own. The
2013 subcommand can be used to rename any conflicting snapshots.
2018 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2019 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2026 .Ar filesystem Ns | Ns Ar volume
2027 .Ar filesystem Ns | Ns Ar volume
2034 .Ar filesystem filesystem
2037 Renames the given dataset. The new target can be located anywhere in the
2039 hierarchy, with the exception of snapshots. Snapshots can only be renamed
2040 within the parent file system or volume. When renaming a snapshot, the parent
2041 file system of the snapshot does not need to be specified as part of the second
2042 argument. Renamed file systems can inherit new mount points, in which case they
2043 are unmounted and remounted at the new mount point.
2044 .Bl -tag -width indent
2046 Creates all the nonexistent parent datasets. Datasets created in this manner
2047 are automatically mounted according to the
2049 property inherited from their parent.
2051 Do not remount file systems during rename. If a file system's
2057 file system is not unmounted even if this option is not given.
2059 Force unmount any filesystems that need to be unmounted in the process.
2060 This flag has no effect if used together with the
2068 .Ar snapshot snapshot
2071 Recursively rename the snapshots of all descendent datasets. Snapshots are the
2072 only dataset that can be renamed recursively.
2076 .Op Fl r Ns | Ns Fl d Ar depth
2078 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2079 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2080 .Oo Fl s Ar property Oc Ns ...
2081 .Oo Fl S Ar property Oc Ns ...
2082 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
2085 Lists the property information for the given datasets in tabular form. If
2086 specified, you can list property information by the absolute pathname or the
2087 relative pathname. By default, all file systems and volumes are displayed.
2088 Snapshots are displayed if the
2094 The following fields are displayed,
2095 .Sy name , used , available , referenced , mountpoint .
2096 .Bl -tag -width indent
2098 Recursively display any children of the dataset on the command line.
2100 Recursively display any children of the dataset, limiting the recursion to
2104 will display only the dataset and its direct children.
2106 Used for scripting mode. Do not print headers and separate fields by a single
2107 tab instead of arbitrary white space.
2109 Display numbers in parsable (exact) values.
2110 .It Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2111 A comma-separated list of properties to display. The property must be:
2112 .Bl -bullet -offset 2n
2114 One of the properties described in the
2115 .Qq Sx Native Properties
2122 to display the dataset name
2126 to display space usage properties on file systems and volumes. This is a
2127 shortcut for specifying
2129 .Sy name,avail,used,usedsnap,usedds,usedrefreserv,usedchild
2131 .Sy filesystem,volume
2134 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2135 A comma-separated list of types to display, where
2138 .Sy filesystem , snapshot , snap , volume , bookmark , No or Sy all .
2139 For example, specifying
2141 displays only snapshots.
2142 .It Fl s Ar property
2143 A property for sorting the output by column in ascending order based on the
2144 value of the property. The property must be one of the properties described in
2147 section, or the special value
2149 to sort by the dataset name. Multiple properties can be specified at one time
2152 property options. Multiple
2154 options are evaluated from left to right in decreasing order of importance.
2156 The following is a list of sorting criteria:
2157 .Bl -bullet -offset 2n
2159 Numeric types sort in numeric order.
2161 String types sort in alphabetical order.
2163 Types inappropriate for a row sort that row to the literal bottom, regardless
2164 of the specified ordering.
2166 If no sorting options are specified the existing behavior of
2170 .It Fl S Ar property
2173 option, but sorts by property in descending order.
2178 .Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ...
2179 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2182 Sets the property or list of properties to the given value(s) for each dataset.
2183 Only some properties can be edited. See the "Properties" section for more
2184 information on what properties can be set and acceptable values. Numeric values
2185 can be specified as exact values, or in a human-readable form with a suffix of
2186 .Sy B , K , M , G , T , P , E , Z
2187 (for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes, or
2188 zettabytes, respectively). User properties can be set on snapshots. For more
2189 information, see the
2190 .Qq Sx User Properties
2195 .Op Fl r Ns | Ns Fl d Ar depth
2197 .Op Fl o Ar all | field Ns Oo , Ns Ar field Oc Ns ...
2198 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2199 .Op Fl s Ar source Ns Oo , Ns Ar source Oc Ns ...
2200 .Ar all | property Ns Oo , Ns Ar property Oc Ns ...
2201 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Ns ...
2204 Displays properties for the given datasets. If no datasets are specified, then
2205 the command displays properties for all datasets on the system. For each
2206 property, the following columns are displayed:
2208 .Bl -hang -width "property" -offset indent -compact
2216 Property source. Can either be local, default, temporary, inherited, received,
2221 All columns except the
2223 column are displayed by default. The columns to display can be specified
2226 option. This command takes a comma-separated list of properties as described in
2228 .Qq Sx Native Properties
2230 .Qq Sx User Properties
2235 can be used to display all properties that apply to the given dataset's type
2236 (filesystem, volume, snapshot, or bookmark).
2237 .Bl -tag -width indent
2239 Recursively display properties for any children.
2241 Recursively display any children of the dataset, limiting the recursion to
2245 will display only the dataset and its direct children.
2247 Display output in a form more easily parsed by scripts. Any headers are
2248 omitted, and fields are explicitly separated by a single tab instead of an
2249 arbitrary amount of space.
2251 Display numbers in parsable (exact) values.
2252 .It Fl o Cm all | Ar field Ns Oo , Ns Ar field Oc Ns ...
2253 A comma-separated list of columns to display. Supported values are
2254 .Sy name,property,value,received,source .
2256 .Sy name,property,value,source .
2259 specifies all columns.
2260 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2261 A comma-separated list of types to display, where
2264 .Sy filesystem , snapshot , volume , No or Sy all .
2265 For example, specifying
2267 displays only snapshots.
2268 .It Fl s Ar source Ns Oo , Ns Ar source Oc Ns ...
2269 A comma-separated list of sources to display. Those properties coming from a
2270 source other than those in this list are ignored. Each source must be one of
2272 .Sy local,default,inherited,temporary,received,none .
2273 The default value is all sources.
2280 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
2283 Clears the specified property, causing it to be inherited from an ancestor,
2284 restored to default if no ancestor has the property set, or with the
2286 option reverted to the received value if one exists.
2289 section for a listing of default values, and details on which properties can be
2291 .Bl -tag -width indent
2293 Recursively inherit the given property for all children.
2295 Revert the property to the received value if one exists; otherwise operate as
2298 option was not specified.
2303 .Ar filesystem Ns | Ns Ar volume
2306 Remap the indirect blocks in the given fileystem or volume so that they no
2307 longer reference blocks on previously removed vdevs and we can eventually
2308 shrink the size of the indirect mapping objects for the previously removed
2309 vdevs. Note that remapping all blocks might not be possible and that
2310 references from snapshots will still exist and cannot be remapped.
2317 Displays a list of file systems that are not the most recent version.
2318 .Bl -tag -width indent
2322 filesystem versions supported by the current software. The current
2324 filesystem version and all previous supported versions are displayed, along
2325 with an explanation of the features provided with each version.
2332 .Fl a | Ar filesystem
2335 Upgrades file systems to a new on-disk version. Once this is done, the file
2336 systems will no longer be accessible on systems running older versions of the
2339 streams generated from new snapshots of these file systems cannot be accessed
2340 on systems running older versions of the software.
2342 In general, the file system version is independent of the pool version. See
2344 for information on the
2345 .Nm zpool Cm upgrade
2348 In some cases, the file system version and the pool version are interrelated
2349 and the pool version must be upgraded before the file system version can be
2351 .Bl -tag -width indent
2353 Upgrade the specified file system and all descendent file systems.
2355 Upgrade to the specified
2359 flag is not specified, this command upgrades to the most recent version. This
2360 option can only be used to increase the version number, and only up to the most
2361 recent version supported by this software.
2363 Upgrade all file systems on all imported pools.
2365 Upgrade the specified file system.
2371 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2372 .Oo Fl s Ar field Oc Ns ...
2373 .Oo Fl S Ar field Oc Ns ...
2374 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2375 .Ar filesystem Ns | Ns Ar snapshot
2378 Displays space consumed by, and quotas on, each user in the specified
2379 filesystem or snapshot. This corresponds to the
2380 .Sy userused@ Ns Ar user
2382 .Sy userquota@ Ns Ar user
2384 .Bl -tag -width indent
2386 Print numeric ID instead of user/group name.
2388 Do not print headers, use tab-delimited output.
2390 Use exact (parsable) numeric output.
2391 .It Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2392 Display only the specified fields from the following set:
2393 .Sy type,name,used,quota .
2394 The default is to display all fields.
2396 Sort output by this field. The
2400 flags may be specified multiple times to sort first by one field, then by
2401 another. The default is
2402 .Fl s Cm type Fl s Cm name .
2404 Sort by this field in reverse order. See
2406 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2407 Print only the specified types from the following set:
2408 .Sy all,posixuser,smbuser,posixgroup,smbgroup .
2411 .Fl t Cm posixuser,smbuser .
2413 The default can be changed to include group types.
2415 Translate SID to POSIX ID. This flag currently has no effect on
2422 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2423 .Oo Fl s Ar field Oc Ns ...
2424 .Oo Fl S Ar field Oc Ns ...
2425 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2426 .Ar filesystem Ns | Ns Ar snapshot
2429 Displays space consumed by, and quotas on, each group in the specified
2430 filesystem or snapshot. This subcommand is identical to
2431 .Qq Nm Cm userspace ,
2432 except that the default types to display are
2433 .Fl t Sy posixgroup,smbgroup .
2441 file systems currently mounted.
2442 .Bl -tag -width indent
2449 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2450 .Fl a | Ar filesystem
2456 .Bl -tag -width indent
2458 Report mount progress.
2460 Perform an overlay mount. Overlay mounts are not supported on
2462 .It Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2463 An optional, comma-separated list of mount options to use temporarily for the
2464 duration of the mount. See the
2465 .Qq Sx Temporary Mount Point Properties
2466 section for details.
2471 This command may be executed on
2475 For more information, see variable
2480 Mount the specified filesystem.
2484 .Cm unmount Ns | Ns Cm umount
2486 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
2489 Unmounts currently mounted
2492 .Bl -tag -width indent
2494 Forcefully unmount the file system, even if it is currently in use.
2496 Unmount all available
2499 .It Ar filesystem | mountpoint
2500 Unmount the specified filesystem. The command can also be given a path to a
2502 file system mount point on the system.
2507 .Fl a | Ar filesystem
2512 file systems that have the
2515 .Bl -tag -width indent
2519 file systems that have the
2522 This command may be executed on
2526 For more information, see variable
2531 Share the specified filesystem according to the
2533 property. File systems are shared when the
2540 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
2545 file systems that have the
2548 .Bl -tag -width indent
2552 file systems that have the
2555 This command may be executed on
2559 For more information, see variable
2563 .It Ar filesystem | mountpoint
2564 Unshare the specified filesystem. The command can also be given a path to a
2566 file system shared on the system.
2575 Creates a bookmark of the given snapshot.
2576 Bookmarks mark the point in time
2577 when the snapshot was created, and can be used as the incremental source for
2582 This feature must be enabled to be used.
2584 .Xr zpool-features 7
2585 for details on ZFS feature flags and the
2592 .Op Fl i Ar snapshot | Fl I Ar snapshot
2596 Creates a stream representation of the last
2598 argument (not part of
2602 which is written to standard output. The output can be redirected to
2603 a file or to a different system (for example, using
2605 By default, a full stream is generated.
2606 .Bl -tag -width indent
2607 .It Fl i Ar snapshot
2608 Generate an incremental stream from the first
2609 .Ar snapshot Pq the incremental source
2611 .Ar snapshot Pq the incremental target .
2612 The incremental source can be specified as the last component of the
2614 .Pq the Em @ No character and following
2616 it is assumed to be from the same file system as the incremental target.
2618 If the destination is a clone, the source may be the origin snapshot, which
2619 must be fully specified (for example,
2620 .Cm pool/fs@origin ,
2623 .It Fl I Ar snapshot
2624 Generate a stream package that sends all intermediary snapshots from the first
2631 .Ic -i @a fs@b; -i @b fs@c; -i @c fs@d .
2633 source may be specified as with the
2636 .It Fl R, -replicate
2637 Generate a replication stream package, which will replicate the specified
2638 filesystem, and all descendent file systems, up to the named snapshot. When
2639 received, all properties, snapshots, descendent file systems, and clones are
2646 flags are used in conjunction with the
2648 flag, an incremental replication stream is generated. The current values of
2649 properties, and current snapshot and file system names are set when the stream
2652 flag is specified when this stream is received, snapshots and file systems that
2653 do not exist on the sending side are destroyed.
2655 Generate a deduplicated stream. Blocks which would have been sent multiple
2656 times in the send stream will only be sent once. The receiving system must
2657 also support this feature to receive a deduplicated stream. This flag can
2658 be used regardless of the dataset's
2660 property, but performance will be much better if the filesystem uses a
2661 dedup-capable checksum (eg.
2663 .It Fl L, -large-block
2664 Generate a stream which may contain blocks larger than 128KB.
2666 has no effect if the
2668 pool feature is disabled, or if the
2670 property of this filesystem has never been set above 128KB.
2671 The receiving system must have the
2673 pool feature enabled as well.
2675 .Xr zpool-features 7
2676 for details on ZFS feature flags and the
2680 Generate a more compact stream by using WRITE_EMBEDDED records for blocks
2681 which are stored more compactly on disk by the
2685 This flag has no effect if the
2689 The receiving system must have the
2695 feature is active on the sending system,
2696 then the receiving system must have that feature enabled as well.
2698 .Xr zpool-features 7
2699 for details on ZFS feature flags and the
2702 .It Fl c, -compressed
2703 Generate a more compact stream by using compressed WRITE records for blocks
2704 which are compressed on disk and in memory (see the
2706 property for details).
2709 feature is active on the sending system, then the receiving system must have that
2710 feature enabled as well. If the
2712 feature is enabled on the sending system but the
2714 option is not supplied in conjunction with
2716 then the data will be decompressed before sending so it can be split
2717 into smaller block sizes.
2719 Include the dataset's properties in the stream. This flag is implicit when
2721 is specified. The receiving system must also support this feature.
2723 Do a dry-run ("No-op") send. Do not generate any actual send data. This is
2724 useful in conjunction with the
2728 flags to determine what data will be sent.
2729 In this case, the verbose output will be written to
2730 standard output (contrast with a non-dry-run, where the stream is written
2731 to standard output and the verbose output goes to standard error).
2733 Print machine-parsable verbose information about the stream package generated.
2735 Print verbose information about the stream package generated.
2736 This information includes a per-second report of how much data has been sent.
2739 The format of the stream is committed. You will be able to receive your streams
2740 on future versions of
2746 .Op Fl i Ar snapshot Ns | Ns Ar bookmark
2747 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2750 Generate a send stream, which may be of a filesystem, and may be
2751 incremental from a bookmark.
2752 If the destination is a filesystem or volume,
2753 the pool must be read-only, or the filesystem must not be mounted.
2755 stream generated from a filesystem or volume is received, the default snapshot
2758 .Bl -tag -width indent
2759 .It Fl i Ar snapshot Ns | Ns bookmark
2760 Generate an incremental send stream.
2761 The incremental source must be an earlier
2762 snapshot in the destination's history.
2763 It will commonly be an earlier
2764 snapshot in the destination's filesystem, in which case it can be
2765 specified as the last component of the name
2766 .Pq the Em # No or Em @ No character and following .
2768 If the incremental target is a clone, the incremental source can
2769 be the origin snapshot, or an earlier snapshot in the origin's filesystem,
2770 or the origin's origin, etc.
2771 .It Fl L, -large-block
2772 Generate a stream which may contain blocks larger than 128KB.
2774 has no effect if the
2776 pool feature is disabled, or if the
2778 property of this filesystem has never been set above 128KB.
2779 The receiving system must have the
2781 pool feature enabled as well.
2783 .Xr zpool-features 7
2784 for details on ZFS feature flags and the
2787 .It Fl c, -compressed
2788 Generate a more compact stream by using compressed WRITE records for blocks
2789 which are compressed on disk and in memory (see the
2791 property for details). If the
2793 feature is active on the sending system, then the receiving system must have
2794 that feature enabled as well. If the
2796 feature is enabled on the sending system but the
2798 option is not supplied in conjunction with
2800 then the data will be decompressed before sending so it can be split
2801 into smaller block sizes.
2803 Generate a more compact stream by using WRITE_EMBEDDED records for blocks
2804 which are stored more compactly on disk by the
2808 This flag has no effect if the
2812 The receiving system must have the
2818 feature is active on the sending system,
2819 then the receiving system must have that feature enabled as well.
2821 .Xr zpool-features 7
2822 for details on ZFS feature flags and the
2831 .Ar receive_resume_token
2833 Creates a send stream which resumes an interrupted receive. The
2834 .Ar receive_resume_token
2835 is the value of this property on the filesystem
2836 or volume that was being received into. See the documentation for
2841 .Cm receive Ns | Ns Cm recv
2843 .Op Fl o Sy origin Ns = Ns Ar snapshot
2844 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2848 .Cm receive Ns | Ns Cm recv
2851 .Op Fl o Sy origin Ns = Ns Ar snapshot
2855 Creates a snapshot whose contents are as specified in the stream provided on
2856 standard input. If a full stream is received, then a new file system is created
2857 as well. Streams are created using the
2859 subcommand, which by default creates a full stream.
2861 can be used as an alias for
2864 If an incremental stream is received, then the destination file system must
2865 already exist, and its most recent snapshot must match the incremental stream's
2868 the destination device link is destroyed and recreated, which means the
2870 cannot be accessed during the
2874 When a snapshot replication package stream that is generated by using the
2876 command is received, any snapshots that do not exist on the sending location
2877 are destroyed by using the
2878 .Qq Nm Cm destroy Fl d
2881 The name of the snapshot (and file system, if a full stream is received) that
2882 this subcommand creates depends on the argument type and the
2888 If the argument is a snapshot name, the specified
2890 is created. If the argument is a file system or volume name, a snapshot with
2891 the same name as the sent snapshot is created within the specified
2899 option is specified, the snapshot name is determined by appending the sent
2900 snapshot's name to the specified
2904 option is specified, all but the pool name of the sent snapshot path is
2905 appended (for example,
2907 appended from sent snapshot
2911 option is specified, only the tail of the sent snapshot path is appended (for
2914 appended from sent snapshot
2918 any file systems needed to replicate the path of the sent snapshot are created
2919 within the specified file system.
2920 .Bl -tag -width indent
2922 Use the full sent snapshot path without the first element (without pool name)
2923 to determine the name of the new snapshot as described in the paragraph above.
2925 Use only the last element of the sent snapshot path to determine the name of
2926 the new snapshot as described in the paragraph above.
2928 File system that is associated with the received stream is not mounted.
2930 Print verbose information about the stream and the time required to perform the
2933 Do not actually receive the stream. This can be useful in conjunction with the
2935 option to verify the name the receive operation would use.
2936 .It Fl o Sy origin Ns = Ns Ar snapshot
2937 Forces the stream to be received as a clone of the given snapshot.
2938 If the stream is a full send stream, this will create the filesystem
2939 described by the stream as a clone of the specified snapshot. Which
2940 snapshot was specified will not affect the success or failure of the
2941 receive, as long as the snapshot does exist. If the stream is an
2942 incremental send stream, all the normal verification will be performed.
2944 Force a rollback of the file system to the most recent snapshot before
2945 performing the receive operation. If receiving an incremental replication
2946 stream (for example, one generated by
2947 .Qq Nm Cm send Fl R Bro Fl i | Fl I Brc ) ,
2948 destroy snapshots and file systems that do not exist on the sending side.
2950 If the receive is interrupted, save the partially received state, rather
2951 than deleting it. Interruption may be due to premature termination of
2953 .Po e.g. due to network failure or failure of the remote system
2954 if the stream is being read over a network connection
2956 a checksum error in the stream, termination of the
2958 process, or unclean shutdown of the system.
2960 The receive can be resumed with a stream generated by
2961 .Nm zfs Cm send Fl t Ar token ,
2965 .Sy receive_resume_token
2966 property of the filesystem or volume which is received into.
2968 To use this flag, the storage pool must have the
2969 .Sy extensible_dataset
2970 feature enabled. See
2971 .Xr zpool-features 5
2972 for details on ZFS feature flags.
2976 .Cm receive Ns | Ns Cm recv
2978 .Ar filesystem Ns | Ns Ar volume
2980 Abort an interrupted
2981 .Nm zfs Cm receive Fl s ,
2982 deleting its saved partially received state.
2986 .Ar filesystem Ns | Ns Ar volume
2989 Displays permissions that have been delegated on the specified filesystem or
2990 volume. See the other forms of
2992 for more information.
2997 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
2998 .Ar perm Ns | Ns Ar @setname Ns
2999 .Oo Ns , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
3000 .Ar filesystem Ns | Ns Ar volume
3006 .Fl e Ns | Ns Cm everyone
3007 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
3009 .Ar filesystem Ns | Ns Ar volume
3014 administration permission for the file systems to non-privileged users.
3015 .Bl -tag -width indent
3018 .Ar user Ns | Ns Ar group Ns Oo , Ar user Ns | Ns Ar group Oc Ns ...
3020 Specifies to whom the permissions are delegated. Multiple entities can be
3021 specified as a comma-separated list. If neither of the
3023 options are specified, then the argument is interpreted preferentially as the
3026 then as a user name, and lastly as a group name. To specify
3027 a user or group named
3033 options. To specify a group with the same name as a user, use the
3036 .It Op Fl e Ns | Ns Cm everyone
3037 Specifies that the permissions be delegated to
3040 .Ar perm Ns | Ns Ar @setname Ns Oo , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
3042 The permissions to delegate. Multiple permissions
3043 may be specified as a comma-separated list. Permission names are the same as
3045 subcommand and property names. See the property list below. Property set names,
3046 which begin with an at sign
3048 may be specified. See the
3050 form below for details.
3053 .Ar filesystem Ns | Ns Ar volume
3055 Specifies where the permissions are delegated. If neither of the
3057 options are specified, or both are, then the permissions are allowed for the
3058 file system or volume, and all of its descendents. If only the
3060 option is used, then is allowed "locally" only for the specified file system.
3063 option is used, then is allowed only for the descendent file systems.
3066 Permissions are generally the ability to use a
3068 subcommand or change a
3070 property. The following permissions are available:
3071 .Bl -column -offset 4n "secondarycache" "subcommand"
3072 .It NAME Ta TYPE Ta NOTES
3073 .It allow Ta subcommand Ta Must Xo
3074 also have the permission that is being allowed
3076 .It clone Ta subcommand Ta Must Xo
3077 also have the 'create' ability and 'mount' ability in the origin file system
3079 .It create Ta subcommand Ta Must also have the 'mount' ability
3080 .It destroy Ta subcommand Ta Must also have the 'mount' ability
3081 .It diff Ta subcommand Ta Allows lookup of paths within a dataset given an
3082 object number, and the ability to create snapshots necessary to 'zfs diff'
3083 .It hold Ta subcommand Ta Allows adding a user hold to a snapshot
3084 .It mount Ta subcommand Ta Allows mount/umount of Tn ZFS No datasets
3085 .It promote Ta subcommand Ta Must Xo
3086 also have the 'mount' and 'promote' ability in the origin file system
3088 .It receive Ta subcommand Ta Must also have the 'mount' and 'create' ability
3089 .It release Ta subcommand Ta Allows Xo
3090 releasing a user hold which might destroy the snapshot
3092 .It rename Ta subcommand Ta Must Xo
3093 also have the 'mount' and 'create' ability in the new parent
3095 .It rollback Ta subcommand Ta Must also have the 'mount' ability
3096 .It send Ta subcommand
3097 .It share Ta subcommand Ta Allows Xo
3098 sharing file systems over the
3102 .It snapshot Ta subcommand Ta Must also have the 'mount' ability
3103 .It groupquota Ta other Ta Allows accessing any groupquota@... property
3104 .It groupused Ta other Ta Allows reading any groupused@... property
3105 .It userprop Ta other Ta Allows changing any user property
3106 .It userquota Ta other Ta Allows accessing any userquota@... property
3107 .It userused Ta other Ta Allows reading any userused@... property
3108 .It aclinherit Ta property
3109 .It aclmode Ta property
3110 .It atime Ta property
3111 .It canmount Ta property
3112 .It casesensitivity Ta property
3113 .It checksum Ta property
3114 .It compression Ta property
3115 .It copies Ta property
3116 .It dedup Ta property
3117 .It devices Ta property
3118 .It exec Ta property
3119 .It filesystem_limit Ta property
3120 .It logbias Ta property
3121 .It jailed Ta property
3122 .It mlslabel Ta property
3123 .It mountpoint Ta property
3124 .It nbmand Ta property
3125 .It normalization Ta property
3126 .It primarycache Ta property
3127 .It quota Ta property
3128 .It readonly Ta property
3129 .It recordsize Ta property
3130 .It refquota Ta property
3131 .It refreservation Ta property
3132 .It reservation Ta property
3133 .It secondarycache Ta property
3134 .It setuid Ta property
3135 .It sharenfs Ta property
3136 .It sharesmb Ta property
3137 .It snapdir Ta property
3138 .It snapshot_limit Ta property
3139 .It sync Ta property
3140 .It utf8only Ta property
3141 .It version Ta property
3142 .It volblocksize Ta property
3143 .It volsize Ta property
3144 .It vscan Ta property
3145 .It xattr Ta property
3151 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
3153 .Ar filesystem Ns | Ns Ar volume
3156 Sets "create time" permissions. These permissions are granted (locally) to the
3157 creator of any newly-created descendent file system.
3163 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
3165 .Ar filesystem Ns | Ns Ar volume
3168 Defines or adds permissions to a permission set. The set can be used by other
3170 commands for the specified file system and its descendents. Sets are evaluated
3171 dynamically, so changes to a set are immediately reflected. Permission sets
3172 follow the same naming restrictions as ZFS file systems, but the name must
3173 begin with an "at sign"
3175 and can be no more than 64 characters long.
3180 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
3181 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
3183 .Ar filesystem Ns | Ns Ar volume
3189 .Fl e Ns | Ns Cm everyone
3190 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
3192 .Ar filesystem Ns | Ns Ar volume
3199 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
3201 .Ar filesystem Ns | Ns Ar volume
3204 Removes permissions that were granted with the
3206 command. No permissions are explicitly denied, so other permissions granted are
3207 still in effect. For example, if the permission is granted by an ancestor. If
3208 no permissions are specified, then all permissions for the specified
3209 .Ar user , group , No or everyone
3210 are removed. Specifying
3212 .Po or using the Fl e
3214 .Pc only removes the permissions that were granted to everyone ,
3215 not all permissions for every user and group. See the
3217 command for a description of the
3220 .Bl -tag -width indent
3222 Recursively remove the permissions from this file system and all descendents.
3230 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
3232 .Ar filesystem Ns | Ns Ar volume
3235 Removes permissions from a permission set. If no permissions are specified,
3236 then all permissions are removed, thus removing the set entirely.
3241 .Ar tag snapshot Ns ...
3244 Adds a single reference, named with the
3246 argument, to the specified snapshot or snapshots. Each snapshot has its own tag
3247 namespace, and tags must be unique within that space.
3249 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
3253 .Bl -tag -width indent
3255 Specifies that a hold with the given tag is applied recursively to the
3256 snapshots of all descendent file systems.
3262 .Op Fl r Ns | Ns Fl d Ar depth
3263 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns
3267 Lists all existing user references for the given dataset or datasets.
3268 .Bl -tag -width indent
3270 Used for scripting mode. Do not print headers and separate fields by a single
3271 tab instead of arbitrary white space.
3273 Display numbers in parsable (exact) values.
3275 Lists the holds that are set on the descendent snapshots of the named datasets
3276 or snapshots, in addition to listing the holds on the named snapshots, if any.
3278 Recursively display any holds on the named snapshots, or descendent snapshots of
3279 the named datasets or snapshots, limiting the recursion to
3286 .Ar tag snapshot Ns ...
3289 Removes a single reference, named with the
3291 argument, from the specified snapshot or snapshots. The tag must already exist
3293 .Bl -tag -width indent
3295 Recursively releases a hold with the given tag on the snapshots of all
3296 descendent file systems.
3303 .Op Ar snapshot Ns | Ns Ar filesystem
3306 Display the difference between a snapshot of a given filesystem and another
3307 snapshot of that filesystem from a later time or the current contents of the
3308 filesystem. The first column is a character indicating the type of change,
3309 the other columns indicate pathname, new pathname
3310 .Pq in case of rename ,
3311 change in link count, and optionally file type and/or change time.
3313 The types of change are:
3314 .Bl -column -offset 2n indent
3315 .It \&- Ta path was removed
3316 .It \&+ Ta path was added
3317 .It \&M Ta path was modified
3318 .It \&R Ta path was renamed
3320 .Bl -tag -width indent
3322 Display an indication of the type of file, in a manner similar to the
3326 .Bl -column -offset 2n indent
3327 .It \&B Ta block device
3328 .It \&C Ta character device
3329 .It \&F Ta regular file
3330 .It \&/ Ta directory
3331 .It \&@ Ta symbolic link
3333 .It \&> Ta door (not supported on Fx )
3334 .It \&| Ta named pipe (not supported on Fx )
3335 .It \&P Ta event port (not supported on Fx )
3338 Give more parsable tab-separated output, without header lines and without
3341 Display the path's inode change time as the first column of output.
3348 .Op Fl m Ar memory_limit
3355 as a ZFS channel program on
3358 program interface allows ZFS administrative operations to be run
3359 programmatically via a Lua script.
3360 The entire script is executed atomically, with no other administrative
3361 operations taking effect concurrently.
3362 A library of ZFS calls is made available to channel program scripts.
3363 Channel programs may only be run with root privileges.
3365 For full documentation of the ZFS channel program interface, see the manual
3368 .Bl -tag -width indent
3370 Executes a read-only channel program, which runs faster.
3371 The program cannot change on-disk state by calling functions from
3372 the zfs.sync submodule.
3373 The program can be used to gather information such as properties and
3374 determining if changes would succeed (zfs.check.*).
3375 Without this flag, all pending changes must be synced to disk before
3376 a channel program can complete.
3378 Execution time limit, in milliseconds.
3379 If a channel program executes for longer than the provided timeout, it will
3380 be stopped and an error will be returned.
3381 The default timeout is 1000 ms, and can be set to a maximum of 10000 ms.
3382 .It Fl m Ar memory-limit
3383 Memory limit, in bytes.
3384 If a channel program attempts to allocate more memory than the given limit,
3385 it will be stopped and an error returned.
3386 The default memory limit is 10 MB, and can be set to a maximum of 100 MB.
3388 All remaining argument strings are passed directly to the channel program as
3392 for more information.
3397 .Ar jailid filesystem
3400 Attaches the specified
3402 to the jail identified by JID
3404 From now on this file system tree can be managed from within a jail if the
3406 property has been set. To use this functionality, the jail needs the
3410 parameters set to 1 and the
3412 parameter set to a value lower than 2.
3416 for more information on managing jails and configuring the parameters above.
3420 .Ar jailid filesystem
3423 Detaches the specified
3425 from the jail identified by JID
3429 The following exit values are returned:
3430 .Bl -tag -offset 2n -width 2n
3432 Successful completion.
3436 Invalid command line options were specified.
3440 .It Sy Example 1 No Creating a Tn ZFS No File System Hierarchy
3442 The following commands create a file system named
3444 and a file system named
3448 is set for the parent file system, and is automatically inherited by the child
3450 .Bd -literal -offset 2n
3451 .Li # Ic zfs create pool/home
3452 .Li # Ic zfs set mountpoint=/home pool/home
3453 .Li # Ic zfs create pool/home/bob
3455 .It Sy Example 2 No Creating a Tn ZFS No Snapshot
3457 The following command creates a snapshot named
3459 This snapshot is mounted on demand in the
3461 directory at the root of the
3464 .Bd -literal -offset 2n
3465 .Li # Ic zfs snapshot pool/home/bob@yesterday
3467 .It Sy Example 3 No Creating and Destroying Multiple Snapshots
3469 The following command creates snapshots named
3473 and all of its descendent file systems. Each snapshot is mounted on demand in
3476 directory at the root of its file system. The second command destroys the newly
3478 .Bd -literal -offset 2n
3479 .Li # Ic zfs snapshot -r pool/home@yesterday
3480 .Li # Ic zfs destroy -r pool/home@yesterday
3482 .It Sy Example 4 No Disabling and Enabling File System Compression
3484 The following command disables the
3486 property for all file systems under
3488 The next command explicitly enables
3491 .Em pool/home/anne .
3492 .Bd -literal -offset 2n
3493 .Li # Ic zfs set compression=off pool/home
3494 .Li # Ic zfs set compression=on pool/home/anne
3496 .It Sy Example 5 No Listing Tn ZFS No Datasets
3498 The following command lists all active file systems and volumes in the system.
3499 Snapshots are displayed if the
3507 for more information on pool properties.
3508 .Bd -literal -offset 2n
3510 NAME USED AVAIL REFER MOUNTPOINT
3511 pool 450K 457G 18K /pool
3512 pool/home 315K 457G 21K /home
3513 pool/home/anne 18K 457G 18K /home/anne
3514 pool/home/bob 276K 457G 276K /home/bob
3516 .It Sy Example 6 No Setting a Quota on a Tn ZFS No File System
3518 The following command sets a quota of 50 Gbytes for
3520 .Bd -literal -offset 2n
3521 .Li # Ic zfs set quota=50G pool/home/bob
3523 .It Sy Example 7 No Listing Tn ZFS No Properties
3525 The following command lists all properties for
3527 .Bd -literal -offset 2n
3528 .Li # Ic zfs get all pool/home/bob
3529 NAME PROPERTY VALUE SOURCE
3530 pool/home/bob type filesystem -
3531 pool/home/bob creation Tue Jul 21 15:53 2009 -
3532 pool/home/bob used 21K -
3533 pool/home/bob available 20.0G -
3534 pool/home/bob referenced 21K -
3535 pool/home/bob compressratio 1.00x -
3536 pool/home/bob mounted yes -
3537 pool/home/bob quota 20G local
3538 pool/home/bob reservation none default
3539 pool/home/bob recordsize 128K default
3540 pool/home/bob mountpoint /home/bob default
3541 pool/home/bob sharenfs off default
3542 pool/home/bob checksum on default
3543 pool/home/bob compression on local
3544 pool/home/bob atime on default
3545 pool/home/bob devices on default
3546 pool/home/bob exec on default
3547 pool/home/bob filesystem_limit none default
3548 pool/home/bob setuid on default
3549 pool/home/bob readonly off default
3550 pool/home/bob jailed off default
3551 pool/home/bob snapdir hidden default
3552 pool/home/bob snapshot_limit none default
3553 pool/home/bob aclmode discard default
3554 pool/home/bob aclinherit restricted default
3555 pool/home/bob canmount on default
3556 pool/home/bob xattr on default
3557 pool/home/bob copies 1 default
3558 pool/home/bob version 5 -
3559 pool/home/bob utf8only off -
3560 pool/home/bob normalization none -
3561 pool/home/bob casesensitivity sensitive -
3562 pool/home/bob vscan off default
3563 pool/home/bob nbmand off default
3564 pool/home/bob sharesmb off default
3565 pool/home/bob refquota none default
3566 pool/home/bob refreservation none default
3567 pool/home/bob primarycache all default
3568 pool/home/bob secondarycache all default
3569 pool/home/bob usedbysnapshots 0 -
3570 pool/home/bob usedbydataset 21K -
3571 pool/home/bob usedbychildren 0 -
3572 pool/home/bob usedbyrefreservation 0 -
3573 pool/home/bob logbias latency default
3574 pool/home/bob dedup off default
3575 pool/home/bob mlslabel -
3576 pool/home/bob sync standard default
3577 pool/home/bob refcompressratio 1.00x -
3580 The following command gets a single property value.
3581 .Bd -literal -offset 2n
3582 .Li # Ic zfs get -H -o value compression pool/home/bob
3586 The following command lists all properties with local settings for
3588 .Bd -literal -offset 2n
3589 .Li # Ic zfs get -s local -o name,property,value all pool/home/bob
3591 pool/home/bob quota 20G
3592 pool/home/bob compression on
3594 .It Sy Example 8 No Rolling Back a Tn ZFS No File System
3596 The following command reverts the contents of
3598 to the snapshot named
3600 deleting all intermediate snapshots.
3601 .Bd -literal -offset 2n
3602 .Li # Ic zfs rollback -r pool/home/anne@yesterday
3604 .It Sy Example 9 No Creating a Tn ZFS No Clone
3606 The following command creates a writable file system whose initial contents are
3608 .Em pool/home/bob@yesterday .
3609 .Bd -literal -offset 2n
3610 .Li # Ic zfs clone pool/home/bob@yesterday pool/clone
3612 .It Sy Example 10 No Promoting a Tn ZFS No Clone
3614 The following commands illustrate how to test out changes to a file system, and
3615 then replace the original file system with the changed one, using clones, clone
3616 promotion, and renaming:
3617 .Bd -literal -offset 2n
3618 .Li # Ic zfs create pool/project/production
3622 .Pa /pool/project/production
3623 with data and continue with the following commands:
3624 .Bd -literal -offset 2n
3625 .Li # Ic zfs snapshot pool/project/production@today
3626 .Li # Ic zfs clone pool/project/production@today pool/project/beta
3630 .Pa /pool/project/beta
3631 and continue with the following commands:
3632 .Bd -literal -offset 2n
3633 .Li # Ic zfs promote pool/project/beta
3634 .Li # Ic zfs rename pool/project/production pool/project/legacy
3635 .Li # Ic zfs rename pool/project/beta pool/project/production
3638 Once the legacy version is no longer needed, it can be destroyed.
3639 .Bd -literal -offset 2n
3640 .Li # Ic zfs destroy pool/project/legacy
3642 .It Sy Example 11 No Inheriting Tn ZFS No Properties
3644 The following command causes
3650 property from their parent.
3651 .Bd -literal -offset 2n
3652 .Li # Ic zfs inherit checksum pool/home/bob pool/home/anne
3654 .It Sy Example 12 No Remotely Replicating Tn ZFS No Data
3656 The following commands send a full stream and then an incremental stream to a
3657 remote machine, restoring them into
3658 .Sy poolB/received/fs@a
3660 .Sy poolB/received/fs@b ,
3663 must contain the file system
3664 .Sy poolB/received ,
3665 and must not initially contain
3666 .Sy poolB/received/fs .
3667 .Bd -literal -offset 2n
3668 .Li # Ic zfs send pool/fs@a | ssh host zfs receive poolB/received/fs@a
3669 .Li # Ic zfs send -i a pool/fs@b | ssh host zfs receive poolB/received/fs
3678 The following command sends a full stream of
3679 .Sy poolA/fsA/fsB@snap
3680 to a remote machine, receiving it into
3681 .Sy poolB/received/fsA/fsB@snap .
3684 portion of the received snapshot's name is determined from the name of the sent
3687 must contain the file system
3688 .Sy poolB/received .
3690 .Sy poolB/received/fsA
3691 does not exist, it is created as an empty file system.
3692 .Bd -literal -offset 2n
3693 .Li # Ic zfs send poolA/fsA/fsB@snap | ssh host zfs receive -d poolB/received
3695 .It Sy Example 14 No Setting User Properties
3697 The following example sets the user-defined
3698 .Sy com.example:department
3699 property for a dataset.
3700 .Bd -literal -offset 2n
3701 .Li # Ic zfs set com.example:department=12345 tank/accounting
3703 .It Sy Example 15 No Performing a Rolling Snapshot
3705 The following example shows how to maintain a history of snapshots with a
3706 consistent naming scheme. To keep a week's worth of snapshots, the user
3707 destroys the oldest snapshot, renames the remaining snapshots, and then creates
3708 a new snapshot, as follows:
3709 .Bd -literal -offset 2n
3710 .Li # Ic zfs destroy -r pool/users@7daysago
3711 .Li # Ic zfs rename -r pool/users@6daysago @7daysago
3712 .Li # Ic zfs rename -r pool/users@5daysago @6daysago
3713 .Li # Ic zfs rename -r pool/users@4daysago @5daysago
3714 .Li # Ic zfs rename -r pool/users@3daysago @4daysago
3715 .Li # Ic zfs rename -r pool/users@2daysago @3daysago
3716 .Li # Ic zfs rename -r pool/users@yesterday @2daysago
3717 .Li # Ic zfs rename -r pool/users@today @yesterday
3718 .Li # Ic zfs snapshot -r pool/users@today
3724 Property Options on a ZFS File System
3727 The following command shows how to set
3729 property options to enable root access for a specific network on the
3731 file system. The contents of the
3736 .Bd -literal -offset 2n
3737 .Li # Ic zfs set sharenfs="maproot=root,network 192.168.0.0/24" tank/home
3740 Another way to write this command with the same result is:
3741 .Bd -literal -offset 2n
3742 .Li # Ic set zfs sharenfs="-maproot=root -network 192.168.0.0/24" tank/home
3748 Administration Permissions on a
3753 The following example shows how to set permissions so that user
3755 can create, destroy, mount, and take snapshots on
3760 .Bd -literal -offset 2n
3761 .Li # Ic zfs allow cindys create,destroy,mount,snapshot tank/cindys
3762 .Li # Ic zfs allow tank/cindys
3763 ---- Permissions on tank/cindys --------------------------------------
3764 Local+Descendent permissions:
3765 user cindys create,destroy,mount,snapshot
3767 .It Sy Example 18 No Delegating Create Time Permissions on a Tn ZFS No Dataset
3769 The following example shows how to grant anyone in the group
3771 to create file systems in
3773 This syntax also allows staff members to destroy their own file systems, but
3774 not destroy anyone else's file system. The permissions on
3777 .Bd -literal -offset 2n
3778 .Li # Ic zfs allow staff create,mount tank/users
3779 .Li # Ic zfs allow -c destroy tank/users
3780 .Li # Ic zfs allow tank/users
3781 ---- Permissions on tank/users ---------------------------------------
3784 Local+Descendent permissions:
3785 group staff create,mount
3789 Defining and Granting a Permission Set on a
3794 The following example shows how to define and grant a permission set on the
3796 file system. The permissions on
3799 .Bd -literal -offset 2n
3800 .Li # Ic zfs allow -s @pset create,destroy,snapshot,mount tank/users
3801 .Li # Ic zfs allow staff @pset tank/users
3802 .Li # Ic zfs allow tank/users
3803 ---- Permissions on tank/users ---------------------------------------
3805 @pset create,destroy,mount,snapshot
3806 Local+Descendent permissions:
3809 .It Sy Example 20 No Delegating Property Permissions on a Tn ZFS No Dataset
3811 The following example shows to grant the ability to set quotas and reservations
3814 file system. The permissions on
3817 .Bd -literal -offset 2n
3818 .Li # Ic zfs allow cindys quota,reservation users/home
3819 .Li # Ic zfs allow users/home
3820 ---- Permissions on users/home ---------------------------------------
3821 Local+Descendent permissions:
3822 user cindys quota,reservation
3823 .Li # Ic su - cindys
3824 .Li cindys% Ic zfs set quota=10G users/home/marks
3825 .Li cindys% Ic zfs get quota users/home/marks
3826 NAME PROPERTY VALUE SOURCE
3827 users/home/marks quota 10G local
3829 .It Sy Example 21 No Removing ZFS Delegated Permissions on a Tn ZFS No Dataset
3831 The following example shows how to remove the snapshot permission from the
3835 file system. The permissions on
3838 .Bd -literal -offset 2n
3839 .Li # Ic zfs unallow staff snapshot tank/users
3840 .Li # Ic zfs allow tank/users
3841 ---- Permissions on tank/users ---------------------------------------
3843 @pset create,destroy,mount,snapshot
3844 Local+Descendent permissions:
3847 .It Sy Example 22 Showing the differences between a snapshot and a ZFS Dataset
3849 The following example shows how to see what has changed between a prior
3850 snapshot of a ZFS Dataset and its current state. The
3852 option is used to indicate type information for the files affected.
3853 .Bd -literal -offset 2n
3854 .Li # Ic zfs diff tank/test@before tank/test
3856 M F /tank/test/linked (+1)
3857 R F /tank/test/oldname -> /tank/test/newname
3858 - F /tank/test/deleted
3859 + F /tank/test/created
3860 M F /tank/test/modified
3874 This manual page is a
3876 reimplementation of the
3880 modified and customized for
3882 and licensed under the
3883 Common Development and Distribution License
3888 implementation of this manual page was initially written by
3889 .An Martin Matuska Aq mm@FreeBSD.org .
projects / FreeBSD / FreeBSD.git / blob