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
324 and the maximum amount of nesting allowed in a path is 50 levels deep.
326 A dataset can be one of the following:
333 can be mounted within the standard system namespace and behaves like other file
336 file systems are designed to be
338 compliant, known issues exist that prevent compliance in some cases.
339 Applications that depend on standards conformance might fail due to nonstandard
340 behavior when checking file system free space.
342 A logical volume exported as a raw or block device. This type of dataset should
343 only be used under special circumstances. File systems are typically used in
346 A read-only version of a file system or volume at a given point in time. It is
352 .Ss ZFS File System Hierarchy
355 storage pool is a logical collection of devices that provide space for
356 datasets. A storage pool is also the root of the
358 file system hierarchy.
360 The root of the pool can be accessed as a file system, such as mounting and
361 unmounting, taking snapshots, and setting properties. The physical storage
362 characteristics, however, are managed by the
368 for more information on creating and administering pools.
370 A snapshot is a read-only copy of a file system or volume. Snapshots can be
371 created extremely quickly, and initially consume no additional space within the
372 pool. As data within the active dataset changes, the snapshot consumes more
373 data than would otherwise be shared with the active dataset.
375 Snapshots can have arbitrary names. Snapshots of volumes can be cloned or
376 rolled back, but cannot be accessed independently.
378 File system snapshots can be accessed under the
380 directory in the root of the file system. Snapshots are automatically mounted
381 on demand and may be unmounted at regular intervals. The visibility of the
383 directory can be controlled by the
387 A clone is a writable volume or file system whose initial contents are the same
388 as another dataset. As with snapshots, creating a clone is nearly
389 instantaneous, and initially consumes no additional space.
391 Clones can only be created from a snapshot. When a snapshot is cloned, it
392 creates an implicit dependency between the parent and child. Even though the
393 clone is created somewhere else in the dataset hierarchy, the original snapshot
394 cannot be destroyed as long as a clone exists. The
396 property exposes this dependency, and the
398 command lists any such dependencies, if they exist.
400 The clone parent-child dependency relationship can be reversed by using the
402 subcommand. This causes the "origin" file system to become a clone of the
403 specified file system, which makes it possible to destroy the file system that
404 the clone was created from.
408 file system is a simple operation, so the number of file systems per system is
409 likely to be numerous. To cope with this,
411 automatically manages mounting and unmounting file systems without the need to
414 file. All automatically managed file systems are mounted by
418 By default, file systems are mounted under
422 is the name of the file system in the
424 namespace. Directories are created and destroyed as needed.
426 A file system can also have a mount point set in the
428 property. This directory is created as needed, and
430 automatically mounts the file system when the
432 command is invoked (without editing
436 property can be inherited, so if
442 automatically inherits a mount point of
449 prevents the file system from being mounted.
453 file systems can also be managed with traditional tools
454 .Pq Xr mount 8 , Xr umount 8 , Xr fstab 5 .
455 If a file system's mount point is set to
458 makes no attempt to manage the file system, and the administrator is
459 responsible for mounting and unmounting the file system.
462 dataset can be attached to a jail by using the
464 subcommand. You cannot attach a dataset to one jail and the children of the
465 same dataset to another jails. To allow management of the dataset from within
468 property has to be set and the jail needs access to the
472 property cannot be changed from within a jail. See
474 for information on how to allow mounting
476 datasets from within a jail.
479 dataset can be detached from a jail using the
483 After a dataset is attached to a jail and the jailed property is set, a jailed
484 file system cannot be mounted outside the jail, since the jail administrator
485 might have set the mount point to an unacceptable value.
487 Deduplication is the process for removing redundant data at the block-level,
488 reducing the total amount of data stored. If a file system has the
490 property enabled, duplicate data blocks are removed synchronously. The result
491 is that only unique data is stored and common components are shared among
493 .Ss Native Properties
494 Properties are divided into two types, native properties and user-defined (or
495 "user") properties. Native properties either export internal statistics or
498 behavior. In addition, native properties are either editable or read-only. User
499 properties have no effect on
501 behavior, but you can use them to annotate datasets in a way that is meaningful
502 in your environment. For more information about user properties, see the
503 .Qq Sx User Properties
506 Every dataset has a set of properties that export statistics about the dataset
507 as well as control various behaviors. Properties are inherited from the parent
508 unless overridden by the child. Some properties apply only to certain types of
509 datasets (file systems, volumes, or snapshots).
511 The values of numeric properties can be specified using human-readable suffixes
513 .Sy k , KB , M , Gb ,
516 for zettabyte). The following are all valid (and equal) specifications:
517 .Bd -ragged -offset 4n
521 The values of non-numeric properties are case sensitive and must be lowercase,
523 .Sy mountpoint , sharenfs , No and Sy sharesmb .
525 The following native properties consist of read-only statistics about the
526 dataset. These properties can be neither set, nor inherited. Native properties
527 apply to all dataset types unless otherwise noted.
530 The amount of space available to the dataset and all its children, assuming
531 that there is no other activity in the pool. Because space is shared within a
532 pool, availability can be limited by any number of factors, including physical
533 pool size, quotas, reservations, or other datasets within the pool.
535 This property can also be referred to by its shortened column name,
538 For non-snapshots, the compression ratio achieved for the
540 space of this dataset, expressed as a multiplier. The
542 property includes descendant datasets, and, for clones, does not include
543 the space shared with the origin snapshot. For snapshots, the
547 property. Compression can be turned on by running:
548 .Qq Nm Cm set compression=on Ar dataset
552 The time this dataset was created.
554 For snapshots, this property is a comma-separated list of filesystems or
555 volumes which are clones of this snapshot. The clones'
557 property is this snapshot. If the
559 property is not empty, then this snapshot can not be destroyed (even with the
567 if the snapshot has been marked for deferred destroy by using the
569 command. Otherwise, the property is
571 .It Sy filesystem_count
572 The total number of filesystems and volumes that exist under this location in the
574 This value is only available when a
577 been set somewhere in the tree under which the dataset resides.
578 .It Sy logicalreferenced
579 The amount of space that is
581 accessible by this dataset.
585 The logical space ignores the effect of the
589 properties, giving a quantity closer to the amount of data that applications
591 However, it does include space consumed by metadata.
593 This property can also be referred to by its shortened column name,
596 The amount of space that is
598 consumed by this dataset and all its descendents.
602 The logical space ignores the effect of the
606 properties, giving a quantity closer to the amount of data that applications
609 This property can also be referred to by its shortened column name,
612 For file systems, indicates whether the file system is currently mounted. This
613 property can be either
618 For cloned file systems or volumes, the snapshot from which the clone was
619 created. See also the
622 .It Sy receive_resume_token
623 For filesystems or volumes which have saved partially-completed state from
625 this opaque token can be provided to
627 to resume and complete the
630 The amount of data that is accessible by this dataset, which may or may not be
631 shared with other datasets in the pool. When a snapshot or clone is created, it
632 initially references the same amount of space as the file system or snapshot it
633 was created from, since its contents are identical.
635 This property can also be referred to by its shortened column name,
637 .It Sy refcompressratio
638 The compression ratio achieved for the
640 space of this dataset, expressed as a multiplier. See also the
643 .It Sy snapshot_count
644 The total number of snapshots that exist under this location in the dataset tree.
645 This value is only available when a
647 has been set somewhere
648 in the tree under which the dataset resides.
651 .Sy filesystem , volume , No or Sy snapshot .
653 The amount of space consumed by this dataset and all its descendents. This is
654 the value that is checked against this dataset's quota and reservation. The
655 space used does not include this dataset's reservation, but does take into
656 account the reservations of any descendent datasets. The amount of space that a
657 dataset consumes from its parent, as well as the amount of space that are freed
658 if this dataset is recursively destroyed, is the greater of its space used and
661 When snapshots (see the
663 section) are created, their space is
664 initially shared between the snapshot and the file system, and possibly with
665 previous snapshots. As the file system changes, space that was previously
666 shared becomes unique to the snapshot, and counted in the snapshot's space
667 used. Additionally, deleting snapshots can increase the amount of space unique
668 to (and used by) other snapshots.
670 The amount of space used, available, or referenced does not take into account
671 pending changes. Pending changes are generally accounted for within a few
672 seconds. Committing a change to a disk using
676 does not necessarily guarantee that the space usage information is updated
681 properties decompose the
683 properties into the various reasons that space is used. Specifically,
685 .Sy usedbysnapshots + usedbydataset + usedbychildren + usedbyrefreservation .
686 These properties are only available for datasets created
689 pool version 13 pools and higher.
690 .It Sy usedbysnapshots
691 The amount of space consumed by snapshots of this dataset. In particular, it is
692 the amount of space that would be freed if all of this dataset's snapshots were
693 destroyed. Note that this is not simply the sum of the snapshots'
695 properties because space can be shared by multiple snapshots.
697 The amount of space used by this dataset itself, which would be freed if the
698 dataset were destroyed (after first removing any
700 and destroying any necessary snapshots or descendents).
701 .It Sy usedbychildren
702 The amount of space used by children of this dataset, which would be freed if
703 all the dataset's children were destroyed.
704 .It Sy usedbyrefreservation
705 The amount of space used by a
707 set on this dataset, which would be freed if the
710 .It Sy userused@ Ns Ar user
711 The amount of space consumed by the specified user in this dataset. Space is
712 charged to the owner of each file, as displayed by
714 The amount of space charged is displayed by
720 subcommand for more information.
722 Unprivileged users can access only their own space usage. The root user, or a
723 user who has been granted the
727 can access everyone's usage.
731 properties are not displayed by
733 The user's name must be appended after the
735 symbol, using one of the following forms:
736 .Bl -bullet -offset 2n
738 POSIX name (for example,
741 POSIX numeric ID (for example,
745 This property is set to the number of user holds on this snapshot. User holds
749 .It Sy groupused@ Ns Ar group
750 The amount of space consumed by the specified group in this dataset. Space is
751 charged to the group of each file, as displayed by
754 .Sy userused@ Ns Ar user
755 property for more information.
757 Unprivileged users can only access their own groups' space usage. The root
758 user, or a user who has been granted the
762 can access all groups' usage.
763 .It Sy volblocksize Ns = Ns Ar blocksize
764 For volumes, specifies the block size of the volume. The
766 cannot be changed once the volume has been written, so it should be set at
767 volume creation time. The default
769 for volumes is 8 Kbytes. Any
770 power of 2 from 512 bytes to 128 Kbytes is valid.
772 This property can also be referred to by its shortened column name,
777 space written to this dataset since the previous snapshot.
778 .It Sy written@ Ns Ar snapshot
781 space written to this dataset since the specified snapshot. This is the space
782 that is referenced by this dataset but was not referenced by the specified
787 may be specified as a short snapshot name (just the part after the
789 in which case it will be interpreted as a snapshot in the same filesystem as
792 may be a full snapshot name
793 .Pq Em filesystem@snapshot ,
794 which for clones may be a snapshot in the origin's filesystem (or the origin of
795 the origin's filesystem, etc).
798 The following native properties can be used to change the behavior of a
803 .Sy aclinherit Ns = Ns Cm discard |
811 entries are inherited when files and directories are created. A file system
818 entries. A file system with an
822 only inherits inheritable
824 entries that specify "deny" permissions. The property value
826 (the default) removes the
832 entry is inherited. A file system with an
836 inherits all inheritable
838 entries without any modifications made to the
840 entries when they are inherited. A file system with an
844 has the same meaning as
847 .Em owner@ , group@ , No and Em everyone@ Tn ACE Ns s
848 inherit the execute permission only if the file creation mode also requests the
851 When the property value is set to
853 files are created with a mode determined by the inheritable
857 exist that affect the mode, then the mode is set in accordance to the requested
858 mode from the application.
859 .It Sy aclmode Ns = Ns Cm discard | groupmask | passthrough | restricted
864 A file system with an
868 (the default) deletes all
870 entries that do not represent the mode of the file. An
874 reduces permissions granted in all
878 such that they are no greater than the group permissions specified by
880 A file system with an
884 indicates that no changes are made to the
886 other than creating or updating the necessary
888 entries to represent the new mode of the file or directory.
895 operation to return an error when used on any file or directory which has
898 whose entries can not be represented by a mode.
900 is required to change the set user ID, set group ID, or sticky bits on a file
901 or directory, as they do not have equivalent
906 on a file or directory with a non-trivial
912 you must first remove all
914 entries which do not represent the current mode.
915 .It Sy atime Ns = Ns Cm on | off
916 Controls whether the access time for files is updated when they are read.
917 Turning this property off avoids producing write traffic when reading files and
918 can result in significant performance gains, though it might confuse mailers
919 and other similar utilities. The default value is
921 .It Sy canmount Ns = Ns Cm on | off | noauto
922 If this property is set to
924 the file system cannot be mounted, and is ignored by
925 .Qq Nm Cm mount Fl a .
926 Setting this property to
928 is similar to setting the
932 except that the dataset still has a normal
934 property, which can be inherited. Setting this property to
936 allows datasets to be used solely as a mechanism to inherit properties. One
938 .Sy canmount Ns = Ns Cm off
939 is to have two datasets with the same
941 so that the children of both datasets appear in the same directory, but might
942 have different inherited characteristics.
946 value is set, a dataset can only be mounted and unmounted explicitly. The
947 dataset is not mounted automatically when the dataset is created or imported,
948 nor is it mounted by the
950 command or unmounted by the
951 .Qq Nm Cm umount Fl a
954 This property is not inherited.
955 .It Sy checksum Ns = Ns Cm on | off | fletcher2 | fletcher4 | sha256 | noparity | sha512 | skein
956 Controls the checksum used to verify data integrity. The default value is
958 which automatically selects an appropriate algorithm (currently,
960 but this may change in future releases). The value
962 disables integrity checking on user data.
966 disables integrity but also disables maintaining parity for user data. This
967 setting is used internally by a dump device residing on a RAID-Z pool and should
968 not be used by any other dataset.
969 Disabling checksums is
971 a recommended practice.
976 checksum algorithms require enabling the appropriate features on the pool.
979 for more information on these algorithms.
981 Changing this property affects only newly-written data.
983 Salted checksum algorithms
985 are currently not supported for any filesystem on the boot pools.
986 .It Sy compression Ns = Ns Cm on | off | lzjb | gzip | gzip- Ns Ar N | Cm zle | Cm lz4
987 Controls the compression algorithm used for this dataset.
988 Setting compression to
990 indicates that the current default compression algorithm should be used.
991 The default balances compression and decompression speed, with compression
992 ratio and is expected to work well on a wide variety of workloads.
993 Unlike all other settings for this property, on does not select a fixed
995 As new compression algorithms are added to ZFS and enabled on a pool, the
996 default compression algorithm may change.
997 The current default compression algorthm is either
1005 compression algorithm is optimized for performance while providing decent data
1006 compression. Setting compression to
1010 compression algorithm. The
1012 compression algorithm uses the same compression as the
1014 command. You can specify the
1016 level by using the value
1020 is an integer from 1 (fastest) to 9 (best compression ratio). Currently,
1024 (which is also the default for
1028 compression algorithm compresses runs of zeros.
1032 compression algorithm is a high-performance replacement
1035 algorithm. It features significantly faster
1036 compression and decompression, as well as a moderately higher
1037 compression ratio than
1039 but can only be used on pools with
1045 .Xr zpool-features 7
1046 for details on ZFS feature flags and the
1050 This property can also be referred to by its shortened column name
1052 Changing this property affects only newly-written data.
1053 .It Sy copies Ns = Ns Cm 1 | 2 | 3
1054 Controls the number of copies of data stored for this dataset. These copies are
1055 in addition to any redundancy provided by the pool, for example, mirroring or
1056 RAID-Z. The copies are stored on different disks, if possible. The space used
1057 by multiple copies is charged to the associated file and dataset, changing the
1059 property and counting against quotas and reservations.
1061 Changing this property only affects newly-written data. Therefore, set this
1062 property at file system creation time by using the
1063 .Fl o Cm copies= Ns Ar N
1065 .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
1066 Configures deduplication for a dataset. The default value is
1068 The default deduplication checksum is
1070 (this may change in the future).
1073 is enabled, the checksum defined here overrides the
1075 property. Setting the value to
1077 has the same effect as the setting
1083 will do a byte-to-byte comparsion in case of two blocks having the same
1084 signature to make sure the block contents are identical.
1085 .It Sy devices Ns = Ns Cm on | off
1088 property is currently not supported on
1090 .It Sy exec Ns = Ns Cm on | off
1091 Controls whether processes can be executed from within this file system. The
1094 .It Sy mlslabel Ns = Ns Ar label | Cm none
1097 property is currently not supported on
1099 .It Sy filesystem_limit Ns = Ns Ar count | Cm none
1100 Limits the number of filesystems and volumes that can exist under this point in
1102 The limit is not enforced if the user is allowed to change
1105 .Sy filesystem_limit
1106 on a descendent of a filesystem that
1108 .Sy filesystem_limit
1109 does not override the ancestor's
1110 .Sy filesystem_limit ,
1111 but rather imposes an additional limit.
1112 This feature must be enabled to be used
1114 .Xr zpool-features 7
1116 .It Sy mountpoint Ns = Ns Ar path | Cm none | legacy
1117 Controls the mount point used for this file system. See the
1119 section for more information on how this property is used.
1123 property is changed for a file system, the file system and any children that
1124 inherit the mount point are unmounted. If the new value is
1126 then they remain unmounted. Otherwise, they are automatically remounted in the
1127 new location if the property was previously
1131 or if they were mounted before the property was changed. In addition, any
1132 shared file systems are unshared and shared in the new location.
1133 .It Sy nbmand Ns = Ns Cm on | off
1136 property is currently not supported on
1138 .It Sy primarycache Ns = Ns Cm all | none | metadata
1139 Controls what is cached in the primary cache (ARC). If this property is set to
1141 then both user data and metadata is cached. If this property is set to
1143 then neither user data nor metadata is cached. If this property is set to
1145 then only metadata is cached. The default value is
1147 .It Sy quota Ns = Ns Ar size | Cm none
1148 Limits the amount of space a dataset and its descendents can consume. This
1149 property enforces a hard limit on the amount of space used. This includes all
1150 space consumed by descendents, including file systems and snapshots. Setting a
1151 quota on a descendent of a dataset that already has a quota does not override
1152 the ancestor's quota, but rather imposes an additional limit.
1154 Quotas cannot be set on volumes, as the
1156 property acts as an implicit quota.
1157 .It Sy snapshot_limit Ns = Ns Ar count | Cm none
1158 Limits the number of snapshots that can be created on a dataset and its
1162 on a descendent of a dataset that already
1165 does not override the ancestor's
1166 .Sy snapshot_limit ,
1168 rather imposes an additional limit.
1169 The limit is not enforced if the user is
1170 allowed to change the limit.
1171 For example, this means that recursive snapshots
1172 taken from the global zone are counted against each delegated dataset within
1174 This feature must be enabled to be used
1176 .Xr zpool-features 7
1178 .It Sy userquota@ Ns Ar user Ns = Ns Ar size | Cm none
1179 Limits the amount of space consumed by the specified user.
1184 space calculation does not include space that is used by descendent datasets,
1185 such as snapshots and clones. User space consumption is identified by the
1186 .Sy userspace@ Ns Ar user
1189 Enforcement of user quotas may be delayed by several seconds. This delay means
1190 that a user might exceed their quota before the system notices that they are
1191 over quota and begins to refuse additional writes with the
1193 error message. See the
1195 subcommand for more information.
1197 Unprivileged users can only access their own groups' space usage. The root
1198 user, or a user who has been granted the
1202 can get and set everyone's quota.
1204 This property is not available on volumes, on file systems before version 4, or
1205 on pools before version 15. The
1206 .Sy userquota@ Ns ...
1207 properties are not displayed by
1209 The user's name must be appended after the
1211 symbol, using one of the following forms:
1212 .Bl -bullet -offset 2n
1214 POSIX name (for example,
1217 POSIX numeric ID (for example,
1220 .It Sy groupquota@ Ns Ar group Ns = Ns Ar size | Cm none
1221 Limits the amount of space consumed by the specified group. Group space
1222 consumption is identified by the
1223 .Sy userquota@ Ns Ar user
1226 Unprivileged users can access only their own groups' space usage. The root
1227 user, or a user who has been granted the
1231 can get and set all groups' quotas.
1232 .It Sy readonly Ns = Ns Cm on | off
1233 Controls whether this dataset can be modified. The default value is
1235 .It Sy recordsize Ns = Ns Ar size
1236 Specifies a suggested block size for files in the file system. This property is
1237 designed solely for use with database workloads that access files in fixed-size
1240 automatically tunes block sizes according to internal algorithms optimized for
1241 typical access patterns.
1243 For databases that create very large files but access them in small random
1244 chunks, these algorithms may be suboptimal. Specifying a
1246 greater than or equal to the record size of the database can result in
1247 significant performance gains. Use of this property for general purpose file
1248 systems is strongly discouraged, and may adversely affect performance.
1250 The size specified must be a power of two greater than or equal to 512 and less
1251 than or equal to 128 Kbytes.
1254 feature is enabled on the pool, the size may be up to 1 Mbyte.
1256 .Xr zpool-features 7
1257 for details on ZFS feature flags.
1259 Changing the file system's
1261 affects only files created afterward; existing files are unaffected.
1263 This property can also be referred to by its shortened column name,
1265 .It Sy redundant_metadata Ns = Ns Cm all | most
1266 Controls what types of metadata are stored redundantly.
1267 ZFS stores an extra copy of metadata, so that if a single block is corrupted,
1268 the amount of user data lost is limited.
1269 This extra copy is in addition to any redundancy provided at the pool level
1270 .Pq e.g. by mirroring or RAID-Z ,
1271 and is in addition to an extra copy specified by the
1274 .Pq up to a total of 3 copies .
1275 For example if the pool is mirrored,
1276 .Cm copies Ns = Ns Ar 2 ,
1278 .Cm redundant_metadata Ns = Ns Ar most ,
1280 stores 6 copies of most metadata, and 4 copies of data and some
1285 ZFS stores an extra copy of all metadata.
1287 single on-disk block is corrupt, at worst a single block of user data
1296 ZFS stores an extra copy of most types of
1298 This can improve performance of random writes, because less
1299 metadata must be written.
1300 In practice, at worst about 100 blocks
1305 of user data can be lost if a single
1306 on-disk block is corrupt.
1307 The exact behavior of which metadata blocks
1308 are stored redundantly may change in future releases.
1310 The default value is
1312 .It Sy refquota Ns = Ns Ar size | Cm none
1313 Limits the amount of space a dataset can consume. This property enforces a hard
1314 limit on the amount of space used. This hard limit does not include space used
1315 by descendents, including file systems and snapshots.
1316 .It Sy refreservation Ns = Ns Ar size | Cm none | Cm auto
1317 The minimum amount of space guaranteed to a dataset, not including its
1318 descendents. When the amount of space used is below this value, the dataset is
1319 treated as if it were taking up the amount of space specified by
1320 .Sy refreservation .
1323 reservation is accounted for in the parent datasets' space used, and counts
1324 against the parent datasets' quotas and reservations.
1328 is set, a snapshot is only allowed if there is enough free pool space outside
1329 of this reservation to accommodate the current number of "referenced" bytes in
1336 a volume is thick provisioned or not sparse.
1337 .Sy refreservation Ns = Cm auto
1338 is only supported on volumes.
1341 in the Native Properties
1342 section for more information about sparse volumes.
1344 This property can also be referred to by its shortened column name,
1346 .It Sy reservation Ns = Ns Ar size | Cm none
1347 The minimum amount of space guaranteed to a dataset and its descendents. When
1348 the amount of space used is below this value, the dataset is treated as if it
1349 were taking up the amount of space specified by its reservation. Reservations
1350 are accounted for in the parent datasets' space used, and count against the
1351 parent datasets' quotas and reservations.
1353 This property can also be referred to by its shortened column name,
1355 .It Sy secondarycache Ns = Ns Cm all | none | metadata
1356 Controls what is cached in the secondary cache (L2ARC). If this property is set
1359 then both user data and metadata is cached. If this property is set to
1361 then neither user data nor metadata is cached. If this property is set to
1363 then only metadata is cached. The default value is
1365 .It Sy setuid Ns = Ns Cm on | off
1366 Controls whether the
1368 bit is respected for the file system. The default value is
1370 .It Sy sharesmb Ns = Ns Cm on | off | Ar opts
1373 property currently has no effect on
1375 .It Sy sharenfs Ns = Ns Cm on | off | Ar opts
1376 Controls whether the file system is shared via
1378 and what options are used. A file system with a
1382 is managed the traditional way via
1384 Otherwise, the file system is automatically shared and unshared with the
1388 commands. If the property is set to
1392 export options are used. Otherwise,
1394 export options are equivalent to the contents of this property. The export
1395 options may be comma-separated. See
1397 for a list of valid options.
1401 property is changed for a dataset, the
1404 .It Sy logbias Ns = Ns Cm latency | throughput
1407 about handling of synchronous requests in this dataset.
1414 will use pool log devices (if configured) to handle the requests at low
1420 will not use configured pool log devices.
1422 will instead optimize synchronous operations for global pool throughput and
1423 efficient use of resources.
1424 .It Sy snapdir Ns = Ns Cm hidden | visible
1425 Controls whether the
1427 directory is hidden or visible in the root of the file system as discussed in
1430 section. The default value is
1432 .It Sy sync Ns = Ns Cm standard | always | disabled
1433 Controls the behavior of synchronous requests (e.g.
1435 O_DSYNC). This property accepts the following values:
1436 .Bl -tag -offset 4n -width 8n
1438 This is the POSIX specified behavior of ensuring all synchronous requests are
1439 written to stable storage and all devices are flushed to ensure data is not
1440 cached by device controllers (this is the default).
1442 All file system transactions are written and flushed before their system calls
1443 return. This has a large performance penalty.
1445 Disables synchronous requests. File system transactions are only committed to
1446 stable storage periodically. This option will give the highest performance.
1447 However, it is very dangerous as
1449 would be ignoring the synchronous transaction demands of applications such as
1452 Administrators should only use this option when the risks are understood.
1454 .It Sy volsize Ns = Ns Ar size
1455 For volumes, specifies the logical size of the volume. By default, creating a
1456 volume establishes a reservation of equal size. For storage pools with a
1457 version number of 9 or higher, a
1459 is set instead. Any changes to
1461 are reflected in an equivalent change to the reservation (or
1462 .Sy refreservation ) .
1465 can only be set to a multiple of
1469 The reservation is kept equal to the volume's logical size to prevent
1470 unexpected behavior for consumers. Without the reservation, the volume could
1471 run out of space, resulting in undefined behavior or data corruption, depending
1472 on how the volume is used. These effects can also occur when the volume size is
1473 changed while it is in use (particularly when shrinking the size). Extreme care
1474 should be used when adjusting the volume size.
1476 Though not recommended, a "sparse volume" (also known as "thin provisioned")
1477 can be created by specifying the
1480 .Qq Nm Cm create Fl V
1481 command, or by changing the value of the
1485 property on pool version 8 or earlier
1487 after the volume has been created.
1488 A "sparse volume" is a volume where the value of
1490 is less then the size of the volume plus the space required to store its
1492 Consequently, writes to a sparse volume can fail with
1494 when the pool is low on space. For a sparse volume, changes to
1496 are not reflected in the
1497 .Sy refreservation .
1498 A volume that is not sparse is said to be "thick provisioned".
1499 A sparse volume can become thick provisioned by setting
1503 .It Sy volmode Ns = Ns Cm default | geom | dev | none
1504 This property specifies how volumes should be exposed to the OS.
1509 providers, providing maximal functionality.
1512 exposes volumes only as cdev device in devfs.
1513 Such volumes can be accessed only as raw disk device files, i.e. they
1514 can not be partitioned, mounted, participate in RAIDs, etc, but they
1515 are faster, and in some use scenarios with untrusted consumer, such as
1516 NAS or VM storage, can be more safe.
1517 Volumes with property set to
1519 are not exposed outside ZFS, but can be snapshoted, cloned, replicated, etc,
1520 that can be suitable for backup purposes.
1523 means that volumes exposition is controlled by system-wide sysctl/tunable
1524 .Va vfs.zfs.vol.mode ,
1530 are encoded as 1, 2 and 3 respectively.
1531 The default values is
1533 This property can be changed any time, but so far it is processed only
1534 during volume creation and pool import.
1535 .It Sy vscan Ns = Ns Cm off | on
1538 property is currently not supported on
1540 .It Sy xattr Ns = Ns Cm off | on
1543 property is currently not supported on
1545 .It Sy jailed Ns = Ns Cm off | on
1546 Controls whether the dataset is managed from a jail. See the
1548 section for more information. The default value is
1552 The following three properties cannot be changed after the file system is
1553 created, and therefore, should be set when the file system is created. If the
1554 properties are not set with the
1558 commands, these properties are inherited from the parent dataset. If the parent
1559 dataset lacks these properties due to having been created prior to these
1560 features being supported, the new file system will have the default values for
1563 .It Sy casesensitivity Ns = Ns Cm sensitive | insensitive | mixed
1564 Indicates whether the file name matching algorithm used by the file system
1565 should be case-sensitive, case-insensitive, or allow a combination of both
1566 styles of matching. The default value for the
1570 Traditionally, UNIX and POSIX file systems have case-sensitive file names.
1576 property indicates that the
1577 file system can support requests for both case-sensitive and case-insensitive
1579 .It Sy normalization Ns = Ns Cm none | formC | formD | formKC | formKD
1580 Indicates whether the file system should perform a
1582 normalization of file names whenever two file names are compared, and which
1583 normalization algorithm should be used. File names are always stored
1584 unmodified, names are normalized as part of any comparison process. If this
1585 property is set to a legal value other than
1589 property was left unspecified, the
1591 property is automatically set to
1593 The default value of the
1597 This property cannot be changed after the file system is created.
1598 .It Sy utf8only Ns = Ns Cm on | off
1599 Indicates whether the file system should reject file names that include
1600 characters that are not present in the
1602 character code set. If this property is explicitly set to
1604 the normalization property must either not be explicitly set or be set to
1606 The default value for the
1610 This property cannot be changed after the file system is created.
1614 .Sy casesensitivity , normalization , No and Sy utf8only
1615 properties are also new permissions that can be assigned to non-privileged
1618 delegated administration feature.
1619 .Ss Temporary Mount Point Properties
1620 When a file system is mounted, either through
1622 for legacy mounts or the
1624 command for normal file systems, its mount options are set according to its
1625 properties. The correlation between properties and mount options is as follows:
1626 .Bl -column -offset 4n "PROPERTY" "MOUNT OPTION"
1627 .It "PROPERTY MOUNT OPTION"
1628 .It "atime atime/noatime"
1629 .It "exec exec/noexec"
1630 .It "readonly ro/rw"
1631 .It "setuid suid/nosuid"
1634 In addition, these options can be set on a per-mount basis using the
1636 option, without affecting the property that is stored on disk. The values
1637 specified on the command line override the values stored in the dataset. These
1638 properties are reported as "temporary" by the
1640 command. If the properties are changed while the dataset is mounted, the new
1641 setting overrides any temporary settings.
1643 In addition to the standard native properties,
1645 supports arbitrary user properties. User properties have no effect on
1647 behavior, but applications or administrators can use them to annotate datasets
1648 (file systems, volumes, and snapshots).
1650 User property names must contain a colon
1652 character to distinguish them from native properties. They may contain
1653 lowercase letters, numbers, and the following punctuation characters: colon
1661 The expected convention is that the property name is divided into two portions
1663 .Em module Ns Sy \&: Ns Em property ,
1664 but this namespace is not enforced by
1666 User property names can be at most 256 characters, and cannot begin with a dash
1669 When making programmatic use of user properties, it is strongly suggested to
1674 component of property names to reduce the chance that two
1675 independently-developed packages use the same property name for different
1676 purposes. Property names beginning with
1678 are reserved for use by Sun Microsystems.
1680 The values of user properties are arbitrary strings, are always inherited, and
1681 are never validated. All of the commands that operate on properties
1688 can be used to manipulate both native properties and user properties. Use the
1690 command to clear a user property. If the property is not defined in any parent
1691 dataset, it is removed entirely. Property values are limited to 1024
1694 All subcommands that modify state are logged persistently to the pool in their
1702 Displays a help message.
1707 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1713 file system. The file system is automatically mounted according to the
1715 property inherited from the parent.
1716 .Bl -tag -width indent
1718 Creates all the non-existing parent datasets. Datasets created in this manner
1719 are automatically mounted according to the
1721 property inherited from their parent. Any property specified on the command
1724 option is ignored. If the target filesystem already exists, the operation
1725 completes successfully.
1727 Newly created file system is not mounted.
1728 .It Fl o Ar property Ns = Ns Ar value
1729 Sets the specified property as if the command
1730 .Qq Nm Cm set Ar property Ns = Ns Ar value
1731 was invoked at the same time the dataset was created. Any editable
1733 property can also be set at creation time. Multiple
1735 options can be specified. An error results if the same property is specified in
1744 .Op Fl b Ar blocksize
1745 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1750 Creates a volume of the given size. The volume is exported as a block device in
1751 .Pa /dev/zvol/path ,
1754 is the name of the volume in the
1756 namespace. The size represents the logical size as exported by the device. By
1757 default, a reservation of equal size is created.
1760 is automatically rounded up to the nearest 128 Kbytes to ensure that
1761 the volume has an integral number of blocks regardless of
1763 .Bl -tag -width indent
1765 Creates all the non-existing parent datasets. Datasets created in this manner
1766 are automatically mounted according to the
1768 property inherited from their parent. Any property specified on the command
1771 option is ignored. If the target filesystem already exists, the operation
1772 completes successfully.
1774 Creates a sparse volume with no reservation. See
1777 .Qq Sx Native Properties
1778 section for more information about sparse volumes.
1779 .It Fl b Ar blocksize
1781 .Fl o Cm volblocksize Ns = Ns Ar blocksize .
1782 If this option is specified in conjunction with
1783 .Fl o Cm volblocksize ,
1784 the resulting behavior is undefined.
1785 .It Fl o Ar property Ns = Ns Ar value
1786 Sets the specified property as if the
1787 .Qq Nm Cm set Ar property Ns = Ns Ar value
1788 command was invoked at the same time the dataset was created. Any editable
1790 property can also be set at creation time. Multiple
1792 options can be specified. An error results if the same property is specified in
1801 .Ar filesystem Ns | Ns Ar volume
1804 Destroys the given dataset. By default, the command unshares any file systems
1805 that are currently shared, unmounts any file systems that are currently
1806 mounted, and refuses to destroy a dataset that has active dependents (children
1808 .Bl -tag -width indent
1810 Recursively destroy all children.
1812 Recursively destroy all dependents, including cloned file systems outside the
1815 Force an unmount of any file systems using the
1816 .Qq Nm Cm unmount Fl f
1817 command. This option has no effect on non-file systems or unmounted file
1820 Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in
1821 conjunction with the
1825 flags to determine what data would be deleted.
1827 Print machine-parsable verbose information about the deleted data.
1829 Print verbose information about the deleted data.
1832 Extreme care should be taken when applying either the
1836 options, as they can destroy large portions of a pool and cause unexpected
1837 behavior for mounted file systems in use.
1844 .Op % Ns Ar snapname
1849 The given snapshots are destroyed immediately if and only if the
1853 option would have destroyed it. Such immediate destruction would occur, for
1854 example, if the snapshot had no clones and the user-initiated reference count
1857 If a snapshot does not qualify for immediate destruction, it is marked for
1858 deferred deletion. In this state, it exists as a usable, visible snapshot until
1859 both of the preconditions listed above are met, at which point it is destroyed.
1861 An inclusive range of snapshots may be specified by separating the
1862 first and last snapshots with a percent sign
1864 The first and/or last snapshots may be left blank, in which case the
1865 filesystem's oldest or newest snapshot will be implied.
1868 (or ranges of snapshots) of the same filesystem or volume may be specified
1869 in a comma-separated list of snapshots.
1870 Only the snapshot's short name (the
1873 should be specified when using a range or comma-separated list to identify
1875 .Bl -tag -width indent
1877 Destroy (or mark for deferred deletion) all snapshots with this name in
1878 descendent file systems.
1880 Recursively destroy all clones of these snapshots, including the clones,
1881 snapshots, and children.
1882 If this flag is specified, the
1884 flag will have no effect.
1886 Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in
1887 conjunction with the
1891 flags to determine what data would be deleted.
1893 Print machine-parsable verbose information about the deleted data.
1895 Print verbose information about the deleted data.
1897 Defer snapshot deletion.
1900 Extreme care should be taken when applying either the
1904 options, as they can destroy large portions of a pool and cause unexpected
1905 behavior for mounted file systems in use.
1909 .Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
1912 The given bookmark is destroyed.
1915 .Cm snapshot Ns | Ns Cm snap
1917 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1918 .Ar filesystem@snapname Ns | Ns volume@snapname
1919 .Ar filesystem@snapname Ns | Ns volume@snapname Ns ...
1922 Creates snapshots with the given names. All previous modifications by
1923 successful system calls to the file system are part of the snapshots.
1924 Snapshots are taken atomically, so that all snapshots correspond to the same
1925 moment in time. See the
1927 section for details.
1928 .Bl -tag -width indent
1930 Recursively create snapshots of all descendent datasets
1931 .It Fl o Ar property Ns = Ns Ar value
1932 Sets the specified property; see
1943 Roll back the given dataset to a previous snapshot. When a dataset is rolled
1944 back, all data that has changed since the snapshot is discarded, and the
1945 dataset reverts to the state at the time of the snapshot. By default, the
1946 command refuses to roll back to a snapshot other than the most recent one. In
1947 order to do so, all intermediate snapshots and bookmarks must be destroyed
1954 options do not recursively destroy the child snapshots of a
1956 Only direct snapshots of the specified filesystem
1957 are destroyed by either of these options.
1958 To completely roll back a
1959 recursive snapshot, you must rollback the individual child snapshots.
1960 .Bl -tag -width indent
1962 Destroy any snapshots and bookmarks more recent than the one specified.
1964 Destroy any more recent snapshots and bookmarks, as well as any clones of those
1969 option to force an unmount of any clone file systems that are to be destroyed.
1975 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1976 .Ar snapshot filesystem Ns | Ns Ar volume
1979 Creates a clone of the given snapshot. See the
1981 section for details. The target dataset can be located anywhere in the
1983 hierarchy, and is created as the same type as the original.
1984 .Bl -tag -width indent
1986 Creates all the non-existing parent datasets. Datasets created in this manner
1987 are automatically mounted according to the
1989 property inherited from their parent. If the target filesystem or volume
1990 already exists, the operation completes successfully.
1991 .It Fl o Ar property Ns = Ns Ar value
1992 Sets the specified property; see
1999 .Ar clone-filesystem
2002 Promotes a clone file system to no longer be dependent on its "origin"
2003 snapshot. This makes it possible to destroy the file system that the clone was
2004 created from. The clone parent-child dependency relationship is reversed, so
2005 that the origin file system becomes a clone of the specified file system.
2007 The snapshot that was cloned, and any snapshots previous to this snapshot, are
2008 now owned by the promoted clone. The space they use moves from the origin file
2009 system to the promoted clone, so enough space must be available to accommodate
2010 these snapshots. No new space is consumed by this operation, but the space
2011 accounting is adjusted. The promoted clone must not have any conflicting
2012 snapshot names of its own. The
2014 subcommand can be used to rename any conflicting snapshots.
2019 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2020 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2027 .Ar filesystem Ns | Ns Ar volume
2028 .Ar filesystem Ns | Ns Ar volume
2035 .Ar filesystem filesystem
2038 Renames the given dataset. The new target can be located anywhere in the
2040 hierarchy, with the exception of snapshots. Snapshots can only be renamed
2041 within the parent file system or volume. When renaming a snapshot, the parent
2042 file system of the snapshot does not need to be specified as part of the second
2043 argument. Renamed file systems can inherit new mount points, in which case they
2044 are unmounted and remounted at the new mount point.
2045 .Bl -tag -width indent
2047 Creates all the nonexistent parent datasets. Datasets created in this manner
2048 are automatically mounted according to the
2050 property inherited from their parent.
2052 Do not remount file systems during rename. If a file system's
2058 file system is not unmounted even if this option is not given.
2060 Force unmount any filesystems that need to be unmounted in the process.
2061 This flag has no effect if used together with the
2069 .Ar snapshot snapshot
2072 Recursively rename the snapshots of all descendent datasets. Snapshots are the
2073 only dataset that can be renamed recursively.
2077 .Op Fl r Ns | Ns Fl d Ar depth
2079 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2080 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2081 .Oo Fl s Ar property Oc Ns ...
2082 .Oo Fl S Ar property Oc Ns ...
2083 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
2086 Lists the property information for the given datasets in tabular form. If
2087 specified, you can list property information by the absolute pathname or the
2088 relative pathname. By default, all file systems and volumes are displayed.
2089 Snapshots are displayed if the
2095 The following fields are displayed,
2096 .Sy name , used , available , referenced , mountpoint .
2097 .Bl -tag -width indent
2099 Recursively display any children of the dataset on the command line.
2101 Recursively display any children of the dataset, limiting the recursion to
2105 will display only the dataset and its direct children.
2107 Used for scripting mode. Do not print headers and separate fields by a single
2108 tab instead of arbitrary white space.
2110 Display numbers in parsable (exact) values.
2111 .It Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2112 A comma-separated list of properties to display. The property must be:
2113 .Bl -bullet -offset 2n
2115 One of the properties described in the
2116 .Qq Sx Native Properties
2123 to display the dataset name
2127 to display space usage properties on file systems and volumes. This is a
2128 shortcut for specifying
2130 .Sy name,avail,used,usedsnap,usedds,usedrefreserv,usedchild
2132 .Sy filesystem,volume
2135 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2136 A comma-separated list of types to display, where
2139 .Sy filesystem , snapshot , snap , volume , bookmark , No or Sy all .
2140 For example, specifying
2142 displays only snapshots.
2143 .It Fl s Ar property
2144 A property for sorting the output by column in ascending order based on the
2145 value of the property. The property must be one of the properties described in
2148 section, or the special value
2150 to sort by the dataset name. Multiple properties can be specified at one time
2153 property options. Multiple
2155 options are evaluated from left to right in decreasing order of importance.
2157 The following is a list of sorting criteria:
2158 .Bl -bullet -offset 2n
2160 Numeric types sort in numeric order.
2162 String types sort in alphabetical order.
2164 Types inappropriate for a row sort that row to the literal bottom, regardless
2165 of the specified ordering.
2167 If no sorting options are specified the existing behavior of
2171 .It Fl S Ar property
2174 option, but sorts by property in descending order.
2179 .Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns ...
2180 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2183 Sets the property or list of properties to the given value(s) for each dataset.
2184 Only some properties can be edited. See the "Properties" section for more
2185 information on what properties can be set and acceptable values. Numeric values
2186 can be specified as exact values, or in a human-readable form with a suffix of
2187 .Sy B , K , M , G , T , P , E , Z
2188 (for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes, or
2189 zettabytes, respectively). User properties can be set on snapshots. For more
2190 information, see the
2191 .Qq Sx User Properties
2196 .Op Fl r Ns | Ns Fl d Ar depth
2198 .Op Fl o Ar all | field Ns Oo , Ns Ar field Oc Ns ...
2199 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2200 .Op Fl s Ar source Ns Oo , Ns Ar source Oc Ns ...
2201 .Ar all | property Ns Oo , Ns Ar property Oc Ns ...
2202 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Ns ...
2205 Displays properties for the given datasets. If no datasets are specified, then
2206 the command displays properties for all datasets on the system. For each
2207 property, the following columns are displayed:
2209 .Bl -hang -width "property" -offset indent -compact
2217 Property source. Can either be local, default, temporary, inherited, received,
2222 All columns except the
2224 column are displayed by default. The columns to display can be specified
2227 option. This command takes a comma-separated list of properties as described in
2229 .Qq Sx Native Properties
2231 .Qq Sx User Properties
2236 can be used to display all properties that apply to the given dataset's type
2237 (filesystem, volume, snapshot, or bookmark).
2238 .Bl -tag -width indent
2240 Recursively display properties for any children.
2242 Recursively display any children of the dataset, limiting the recursion to
2246 will display only the dataset and its direct children.
2248 Display output in a form more easily parsed by scripts. Any headers are
2249 omitted, and fields are explicitly separated by a single tab instead of an
2250 arbitrary amount of space.
2252 Display numbers in parsable (exact) values.
2253 .It Fl o Cm all | Ar field Ns Oo , Ns Ar field Oc Ns ...
2254 A comma-separated list of columns to display. Supported values are
2255 .Sy name,property,value,received,source .
2257 .Sy name,property,value,source .
2260 specifies all columns.
2261 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2262 A comma-separated list of types to display, where
2265 .Sy filesystem , snapshot , volume , No or Sy all .
2266 For example, specifying
2268 displays only snapshots.
2269 .It Fl s Ar source Ns Oo , Ns Ar source Oc Ns ...
2270 A comma-separated list of sources to display. Those properties coming from a
2271 source other than those in this list are ignored. Each source must be one of
2273 .Sy local,default,inherited,temporary,received,none .
2274 The default value is all sources.
2281 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
2284 Clears the specified property, causing it to be inherited from an ancestor,
2285 restored to default if no ancestor has the property set, or with the
2287 option reverted to the received value if one exists.
2290 section for a listing of default values, and details on which properties can be
2292 .Bl -tag -width indent
2294 Recursively inherit the given property for all children.
2296 Revert the property to the received value if one exists; otherwise operate as
2299 option was not specified.
2304 .Ar filesystem Ns | Ns Ar volume
2307 Remap the indirect blocks in the given fileystem or volume so that they no
2308 longer reference blocks on previously removed vdevs and we can eventually
2309 shrink the size of the indirect mapping objects for the previously removed
2310 vdevs. Note that remapping all blocks might not be possible and that
2311 references from snapshots will still exist and cannot be remapped.
2318 Displays a list of file systems that are not the most recent version.
2319 .Bl -tag -width indent
2323 filesystem versions supported by the current software. The current
2325 filesystem version and all previous supported versions are displayed, along
2326 with an explanation of the features provided with each version.
2333 .Fl a | Ar filesystem
2336 Upgrades file systems to a new on-disk version. Once this is done, the file
2337 systems will no longer be accessible on systems running older versions of the
2340 streams generated from new snapshots of these file systems cannot be accessed
2341 on systems running older versions of the software.
2343 In general, the file system version is independent of the pool version. See
2345 for information on the
2346 .Nm zpool Cm upgrade
2349 In some cases, the file system version and the pool version are interrelated
2350 and the pool version must be upgraded before the file system version can be
2352 .Bl -tag -width indent
2354 Upgrade the specified file system and all descendent file systems.
2356 Upgrade to the specified
2360 flag is not specified, this command upgrades to the most recent version. This
2361 option can only be used to increase the version number, and only up to the most
2362 recent version supported by this software.
2364 Upgrade all file systems on all imported pools.
2366 Upgrade the specified file system.
2372 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2373 .Oo Fl s Ar field Oc Ns ...
2374 .Oo Fl S Ar field Oc Ns ...
2375 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2376 .Ar filesystem Ns | Ns Ar snapshot
2379 Displays space consumed by, and quotas on, each user in the specified
2380 filesystem or snapshot. This corresponds to the
2381 .Sy userused@ Ns Ar user
2383 .Sy userquota@ Ns Ar user
2385 .Bl -tag -width indent
2387 Print numeric ID instead of user/group name.
2389 Do not print headers, use tab-delimited output.
2391 Use exact (parsable) numeric output.
2392 .It Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2393 Display only the specified fields from the following set:
2394 .Sy type,name,used,quota .
2395 The default is to display all fields.
2397 Sort output by this field. The
2401 flags may be specified multiple times to sort first by one field, then by
2402 another. The default is
2403 .Fl s Cm type Fl s Cm name .
2405 Sort by this field in reverse order. See
2407 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2408 Print only the specified types from the following set:
2409 .Sy all,posixuser,smbuser,posixgroup,smbgroup .
2412 .Fl t Cm posixuser,smbuser .
2414 The default can be changed to include group types.
2416 Translate SID to POSIX ID. This flag currently has no effect on
2423 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2424 .Oo Fl s Ar field Oc Ns ...
2425 .Oo Fl S Ar field Oc Ns ...
2426 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2427 .Ar filesystem Ns | Ns Ar snapshot
2430 Displays space consumed by, and quotas on, each group in the specified
2431 filesystem or snapshot. This subcommand is identical to
2432 .Qq Nm Cm userspace ,
2433 except that the default types to display are
2434 .Fl t Sy posixgroup,smbgroup .
2442 file systems currently mounted.
2443 .Bl -tag -width indent
2450 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2451 .Fl a | Ar filesystem
2457 .Bl -tag -width indent
2459 Report mount progress.
2461 Perform an overlay mount. Overlay mounts are not supported on
2463 .It Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2464 An optional, comma-separated list of mount options to use temporarily for the
2465 duration of the mount. See the
2466 .Qq Sx Temporary Mount Point Properties
2467 section for details.
2472 This command may be executed on
2476 For more information, see variable
2481 Mount the specified filesystem.
2485 .Cm unmount Ns | Ns Cm umount
2487 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
2490 Unmounts currently mounted
2493 .Bl -tag -width indent
2495 Forcefully unmount the file system, even if it is currently in use.
2497 Unmount all available
2500 .It Ar filesystem | mountpoint
2501 Unmount the specified filesystem. The command can also be given a path to a
2503 file system mount point on the system.
2508 .Fl a | Ar filesystem
2513 file systems that have the
2516 .Bl -tag -width indent
2520 file systems that have the
2523 This command may be executed on
2527 For more information, see variable
2532 Share the specified filesystem according to the
2534 property. File systems are shared when the
2541 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
2546 file systems that have the
2549 .Bl -tag -width indent
2553 file systems that have the
2556 This command may be executed on
2560 For more information, see variable
2564 .It Ar filesystem | mountpoint
2565 Unshare the specified filesystem. The command can also be given a path to a
2567 file system shared on the system.
2576 Creates a bookmark of the given snapshot.
2577 Bookmarks mark the point in time
2578 when the snapshot was created, and can be used as the incremental source for
2583 This feature must be enabled to be used.
2585 .Xr zpool-features 7
2586 for details on ZFS feature flags and the
2593 .Op Fl i Ar snapshot | Fl I Ar snapshot
2597 Creates a stream representation of the last
2599 argument (not part of
2603 which is written to standard output. The output can be redirected to
2604 a file or to a different system (for example, using
2606 By default, a full stream is generated.
2607 .Bl -tag -width indent
2608 .It Fl i Ar snapshot
2609 Generate an incremental stream from the first
2610 .Ar snapshot Pq the incremental source
2612 .Ar snapshot Pq the incremental target .
2613 The incremental source can be specified as the last component of the
2615 .Pq the Em @ No character and following
2617 it is assumed to be from the same file system as the incremental target.
2619 If the destination is a clone, the source may be the origin snapshot, which
2620 must be fully specified (for example,
2621 .Cm pool/fs@origin ,
2624 .It Fl I Ar snapshot
2625 Generate a stream package that sends all intermediary snapshots from the first
2632 .Ic -i @a fs@b; -i @b fs@c; -i @c fs@d .
2634 source may be specified as with the
2637 .It Fl R, -replicate
2638 Generate a replication stream package, which will replicate the specified
2639 filesystem, and all descendent file systems, up to the named snapshot. When
2640 received, all properties, snapshots, descendent file systems, and clones are
2647 flags are used in conjunction with the
2649 flag, an incremental replication stream is generated. The current values of
2650 properties, and current snapshot and file system names are set when the stream
2653 flag is specified when this stream is received, snapshots and file systems that
2654 do not exist on the sending side are destroyed.
2656 Generate a deduplicated stream. Blocks which would have been sent multiple
2657 times in the send stream will only be sent once. The receiving system must
2658 also support this feature to receive a deduplicated stream. This flag can
2659 be used regardless of the dataset's
2661 property, but performance will be much better if the filesystem uses a
2662 dedup-capable checksum (eg.
2664 .It Fl L, -large-block
2665 Generate a stream which may contain blocks larger than 128KB.
2667 has no effect if the
2669 pool feature is disabled, or if the
2671 property of this filesystem has never been set above 128KB.
2672 The receiving system must have the
2674 pool feature enabled as well.
2676 .Xr zpool-features 7
2677 for details on ZFS feature flags and the
2681 Generate a more compact stream by using WRITE_EMBEDDED records for blocks
2682 which are stored more compactly on disk by the
2686 This flag has no effect if the
2690 The receiving system must have the
2696 feature is active on the sending system,
2697 then the receiving system must have that feature enabled as well.
2699 .Xr zpool-features 7
2700 for details on ZFS feature flags and the
2703 .It Fl c, -compressed
2704 Generate a more compact stream by using compressed WRITE records for blocks
2705 which are compressed on disk and in memory (see the
2706 .Sy compression property for details). If the
2708 feature is active on the sending system, then the receiving system must have that
2709 feature enabled as well. If the
2711 feature is enabled on the sending system but the
2713 option is not supplied in conjunction with
2715 then the data will be decompressed before sending so it can be split
2716 into smaller block sizes.
2718 Include the dataset's properties in the stream. This flag is implicit when
2720 is specified. The receiving system must also support this feature.
2722 Do a dry-run ("No-op") send. Do not generate any actual send data. This is
2723 useful in conjunction with the
2727 flags to determine what data will be sent.
2728 In this case, the verbose output will be written to
2729 standard output (contrast with a non-dry-run, where the stream is written
2730 to standard output and the verbose output goes to standard error).
2732 Print machine-parsable verbose information about the stream package generated.
2734 Print verbose information about the stream package generated.
2735 This information includes a per-second report of how much data has been sent.
2738 The format of the stream is committed. You will be able to receive your streams
2739 on future versions of
2745 .Op Fl i Ar snapshot Ns | Ns Ar bookmark
2746 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2749 Generate a send stream, which may be of a filesystem, and may be
2750 incremental from a bookmark.
2751 If the destination is a filesystem or volume,
2752 the pool must be read-only, or the filesystem must not be mounted.
2754 stream generated from a filesystem or volume is received, the default snapshot
2757 .Bl -tag -width indent
2758 .It Fl i Ar snapshot Ns | Ns bookmark
2759 Generate an incremental send stream.
2760 The incremental source must be an earlier
2761 snapshot in the destination's history.
2762 It will commonly be an earlier
2763 snapshot in the destination's filesystem, in which case it can be
2764 specified as the last component of the name
2765 .Pq the Em # No or Em @ No character and following .
2767 If the incremental target is a clone, the incremental source can
2768 be the origin snapshot, or an earlier snapshot in the origin's filesystem,
2769 or the origin's origin, etc.
2770 .It Fl L, -large-block
2771 Generate a stream which may contain blocks larger than 128KB.
2773 has no effect if the
2775 pool feature is disabled, or if the
2777 property of this filesystem has never been set above 128KB.
2778 The receiving system must have the
2780 pool feature enabled as well.
2782 .Xr zpool-features 7
2783 for details on ZFS feature flags and the
2786 .It Fl c, -compressed
2787 Generate a more compact stream by using compressed WRITE records for blocks
2788 which are compressed on disk and in memory (see the
2790 property for details). If the
2792 feature is active on the sending system, then the receiving system must have
2793 that feature enabled as well. If the
2795 feature is enabled on the sending system but the
2797 option is not supplied in conjunction with
2799 then the data will be decompressed before sending so it can be split
2800 into smaller block sizes.
2802 Generate a more compact stream by using WRITE_EMBEDDED records for blocks
2803 which are stored more compactly on disk by the
2807 This flag has no effect if the
2811 The receiving system must have the
2817 feature is active on the sending system,
2818 then the receiving system must have that feature enabled as well.
2820 .Xr zpool-features 7
2821 for details on ZFS feature flags and the
2830 .Ar receive_resume_token
2832 Creates a send stream which resumes an interrupted receive. The
2833 .Ar receive_resume_token
2834 is the value of this property on the filesystem
2835 or volume that was being received into. See the documentation for
2840 .Cm receive Ns | Ns Cm recv
2842 .Op Fl o Sy origin Ns = Ns Ar snapshot
2843 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2847 .Cm receive Ns | Ns Cm recv
2850 .Op Fl o Sy origin Ns = Ns Ar snapshot
2854 Creates a snapshot whose contents are as specified in the stream provided on
2855 standard input. If a full stream is received, then a new file system is created
2856 as well. Streams are created using the
2858 subcommand, which by default creates a full stream.
2860 can be used as an alias for
2863 If an incremental stream is received, then the destination file system must
2864 already exist, and its most recent snapshot must match the incremental stream's
2867 the destination device link is destroyed and recreated, which means the
2869 cannot be accessed during the
2873 When a snapshot replication package stream that is generated by using the
2875 command is received, any snapshots that do not exist on the sending location
2876 are destroyed by using the
2877 .Qq Nm Cm destroy Fl d
2880 The name of the snapshot (and file system, if a full stream is received) that
2881 this subcommand creates depends on the argument type and the
2887 If the argument is a snapshot name, the specified
2889 is created. If the argument is a file system or volume name, a snapshot with
2890 the same name as the sent snapshot is created within the specified
2898 option is specified, the snapshot name is determined by appending the sent
2899 snapshot's name to the specified
2903 option is specified, all but the pool name of the sent snapshot path is
2904 appended (for example,
2906 appended from sent snapshot
2910 option is specified, only the tail of the sent snapshot path is appended (for
2913 appended from sent snapshot
2917 any file systems needed to replicate the path of the sent snapshot are created
2918 within the specified file system.
2919 .Bl -tag -width indent
2921 Use the full sent snapshot path without the first element (without pool name)
2922 to determine the name of the new snapshot as described in the paragraph above.
2924 Use only the last element of the sent snapshot path to determine the name of
2925 the new snapshot as described in the paragraph above.
2927 File system that is associated with the received stream is not mounted.
2929 Print verbose information about the stream and the time required to perform the
2932 Do not actually receive the stream. This can be useful in conjunction with the
2934 option to verify the name the receive operation would use.
2935 .It Fl o Sy origin Ns = Ns Ar snapshot
2936 Forces the stream to be received as a clone of the given snapshot.
2937 If the stream is a full send stream, this will create the filesystem
2938 described by the stream as a clone of the specified snapshot. Which
2939 snapshot was specified will not affect the success or failure of the
2940 receive, as long as the snapshot does exist. If the stream is an
2941 incremental send stream, all the normal verification will be performed.
2943 Force a rollback of the file system to the most recent snapshot before
2944 performing the receive operation. If receiving an incremental replication
2945 stream (for example, one generated by
2946 .Qq Nm Cm send Fl R Bro Fl i | Fl I Brc ) ,
2947 destroy snapshots and file systems that do not exist on the sending side.
2949 If the receive is interrupted, save the partially received state, rather
2950 than deleting it. Interruption may be due to premature termination of
2952 .Po e.g. due to network failure or failure of the remote system
2953 if the stream is being read over a network connection
2955 a checksum error in the stream, termination of the
2957 process, or unclean shutdown of the system.
2959 The receive can be resumed with a stream generated by
2960 .Nm zfs Cm send Fl t Ar token ,
2964 .Sy receive_resume_token
2965 property of the filesystem or volume which is received into.
2967 To use this flag, the storage pool must have the
2968 .Sy extensible_dataset
2969 feature enabled. See
2970 .Xr zpool-features 5
2971 for details on ZFS feature flags.
2975 .Cm receive Ns | Ns Cm recv
2977 .Ar filesystem Ns | Ns Ar volume
2979 Abort an interrupted
2980 .Nm zfs Cm receive Fl s ,
2981 deleting its saved partially received state.
2985 .Ar filesystem Ns | Ns Ar volume
2988 Displays permissions that have been delegated on the specified filesystem or
2989 volume. See the other forms of
2991 for more information.
2996 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
2997 .Ar perm Ns | Ns Ar @setname Ns
2998 .Oo Ns , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
2999 .Ar filesystem Ns | Ns Ar volume
3005 .Fl e Ns | Ns Cm everyone
3006 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
3008 .Ar filesystem Ns | Ns Ar volume
3013 administration permission for the file systems to non-privileged users.
3014 .Bl -tag -width indent
3017 .Ar user Ns | Ns Ar group Ns Oo , Ar user Ns | Ns Ar group Oc Ns ...
3019 Specifies to whom the permissions are delegated. Multiple entities can be
3020 specified as a comma-separated list. If neither of the
3022 options are specified, then the argument is interpreted preferentially as the
3025 then as a user name, and lastly as a group name. To specify
3026 a user or group named
3032 options. To specify a group with the same name as a user, use the
3035 .It Op Fl e Ns | Ns Cm everyone
3036 Specifies that the permissions be delegated to
3039 .Ar perm Ns | Ns Ar @setname Ns Oo , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
3041 The permissions to delegate. Multiple permissions
3042 may be specified as a comma-separated list. Permission names are the same as
3044 subcommand and property names. See the property list below. Property set names,
3045 which begin with an at sign
3047 may be specified. See the
3049 form below for details.
3052 .Ar filesystem Ns | Ns Ar volume
3054 Specifies where the permissions are delegated. If neither of the
3056 options are specified, or both are, then the permissions are allowed for the
3057 file system or volume, and all of its descendents. If only the
3059 option is used, then is allowed "locally" only for the specified file system.
3062 option is used, then is allowed only for the descendent file systems.
3065 Permissions are generally the ability to use a
3067 subcommand or change a
3069 property. The following permissions are available:
3070 .Bl -column -offset 4n "secondarycache" "subcommand"
3071 .It NAME Ta TYPE Ta NOTES
3072 .It allow Ta subcommand Ta Must Xo
3073 also have the permission that is being allowed
3075 .It clone Ta subcommand Ta Must Xo
3076 also have the 'create' ability and 'mount' ability in the origin file system
3078 .It create Ta subcommand Ta Must also have the 'mount' ability
3079 .It destroy Ta subcommand Ta Must also have the 'mount' ability
3080 .It diff Ta subcommand Ta Allows lookup of paths within a dataset given an
3081 object number, and the ability to create snapshots necessary to 'zfs diff'
3082 .It hold Ta subcommand Ta Allows adding a user hold to a snapshot
3083 .It mount Ta subcommand Ta Allows mount/umount of Tn ZFS No datasets
3084 .It promote Ta subcommand Ta Must Xo
3085 also have the 'mount' and 'promote' ability in the origin file system
3087 .It receive Ta subcommand Ta Must also have the 'mount' and 'create' ability
3088 .It release Ta subcommand Ta Allows Xo
3089 releasing a user hold which might destroy the snapshot
3091 .It rename Ta subcommand Ta Must Xo
3092 also have the 'mount' and 'create' ability in the new parent
3094 .It rollback Ta subcommand Ta Must also have the 'mount' ability
3095 .It send Ta subcommand
3096 .It share Ta subcommand Ta Allows Xo
3097 sharing file systems over the
3101 .It snapshot Ta subcommand Ta Must also have the 'mount' ability
3102 .It groupquota Ta other Ta Allows accessing any groupquota@... property
3103 .It groupused Ta other Ta Allows reading any groupused@... property
3104 .It userprop Ta other Ta Allows changing any user property
3105 .It userquota Ta other Ta Allows accessing any userquota@... property
3106 .It userused Ta other Ta Allows reading any userused@... property
3107 .It aclinherit Ta property
3108 .It aclmode Ta property
3109 .It atime Ta property
3110 .It canmount Ta property
3111 .It casesensitivity Ta property
3112 .It checksum Ta property
3113 .It compression Ta property
3114 .It copies Ta property
3115 .It dedup Ta property
3116 .It devices Ta property
3117 .It exec Ta property
3118 .It filesystem_limit Ta property
3119 .It logbias Ta property
3120 .It jailed Ta property
3121 .It mlslabel Ta property
3122 .It mountpoint Ta property
3123 .It nbmand Ta property
3124 .It normalization Ta property
3125 .It primarycache Ta property
3126 .It quota Ta property
3127 .It readonly Ta property
3128 .It recordsize Ta property
3129 .It refquota Ta property
3130 .It refreservation Ta property
3131 .It reservation Ta property
3132 .It secondarycache Ta property
3133 .It setuid Ta property
3134 .It sharenfs Ta property
3135 .It sharesmb Ta property
3136 .It snapdir Ta property
3137 .It snapshot_limit Ta property
3138 .It sync Ta property
3139 .It utf8only Ta property
3140 .It version Ta property
3141 .It volblocksize Ta property
3142 .It volsize Ta property
3143 .It vscan Ta property
3144 .It xattr Ta property
3150 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
3152 .Ar filesystem Ns | Ns Ar volume
3155 Sets "create time" permissions. These permissions are granted (locally) to the
3156 creator of any newly-created descendent file system.
3162 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
3164 .Ar filesystem Ns | Ns Ar volume
3167 Defines or adds permissions to a permission set. The set can be used by other
3169 commands for the specified file system and its descendents. Sets are evaluated
3170 dynamically, so changes to a set are immediately reflected. Permission sets
3171 follow the same naming restrictions as ZFS file systems, but the name must
3172 begin with an "at sign"
3174 and can be no more than 64 characters long.
3179 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
3180 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
3182 .Ar filesystem Ns | Ns Ar volume
3188 .Fl e Ns | Ns Cm everyone
3189 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
3191 .Ar filesystem Ns | Ns Ar volume
3198 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
3200 .Ar filesystem Ns | Ns Ar volume
3203 Removes permissions that were granted with the
3205 command. No permissions are explicitly denied, so other permissions granted are
3206 still in effect. For example, if the permission is granted by an ancestor. If
3207 no permissions are specified, then all permissions for the specified
3208 .Ar user , group , No or everyone
3209 are removed. Specifying
3211 .Po or using the Fl e
3213 .Pc only removes the permissions that were granted to everyone ,
3214 not all permissions for every user and group. See the
3216 command for a description of the
3219 .Bl -tag -width indent
3221 Recursively remove the permissions from this file system and all descendents.
3229 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
3231 .Ar filesystem Ns | Ns Ar volume
3234 Removes permissions from a permission set. If no permissions are specified,
3235 then all permissions are removed, thus removing the set entirely.
3240 .Ar tag snapshot Ns ...
3243 Adds a single reference, named with the
3245 argument, to the specified snapshot or snapshots. Each snapshot has its own tag
3246 namespace, and tags must be unique within that space.
3248 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
3252 .Bl -tag -width indent
3254 Specifies that a hold with the given tag is applied recursively to the
3255 snapshots of all descendent file systems.
3261 .Op Fl r Ns | Ns Fl d Ar depth
3262 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns
3266 Lists all existing user references for the given dataset or datasets.
3267 .Bl -tag -width indent
3269 Used for scripting mode. Do not print headers and separate fields by a single
3270 tab instead of arbitrary white space.
3272 Display numbers in parsable (exact) values.
3274 Lists the holds that are set on the descendent snapshots of the named datasets
3275 or snapshots, in addition to listing the holds on the named snapshots, if any.
3277 Recursively display any holds on the named snapshots, or descendent snapshots of
3278 the named datasets or snapshots, limiting the recursion to
3285 .Ar tag snapshot Ns ...
3288 Removes a single reference, named with the
3290 argument, from the specified snapshot or snapshots. The tag must already exist
3292 .Bl -tag -width indent
3294 Recursively releases a hold with the given tag on the snapshots of all
3295 descendent file systems.
3302 .Op Ar snapshot Ns | Ns Ar filesystem
3305 Display the difference between a snapshot of a given filesystem and another
3306 snapshot of that filesystem from a later time or the current contents of the
3307 filesystem. The first column is a character indicating the type of change,
3308 the other columns indicate pathname, new pathname
3309 .Pq in case of rename ,
3310 change in link count, and optionally file type and/or change time.
3312 The types of change are:
3313 .Bl -column -offset 2n indent
3314 .It \&- Ta path was removed
3315 .It \&+ Ta path was added
3316 .It \&M Ta path was modified
3317 .It \&R Ta path was renamed
3319 .Bl -tag -width indent
3321 Display an indication of the type of file, in a manner similar to the
3325 .Bl -column -offset 2n indent
3326 .It \&B Ta block device
3327 .It \&C Ta character device
3328 .It \&F Ta regular file
3329 .It \&/ Ta directory
3330 .It \&@ Ta symbolic link
3332 .It \&> Ta door (not supported on Fx )
3333 .It \&| Ta named pipe (not supported on Fx )
3334 .It \&P Ta event port (not supported on Fx )
3337 Give more parsable tab-separated output, without header lines and without
3340 Display the path's inode change time as the first column of output.
3347 .Op Fl m Ar memory_limit
3354 as a ZFS channel program on
3357 program interface allows ZFS administrative operations to be run
3358 programmatically via a Lua script.
3359 The entire script is executed atomically, with no other administrative
3360 operations taking effect concurrently.
3361 A library of ZFS calls is made available to channel program scripts.
3362 Channel programs may only be run with root privileges.
3364 For full documentation of the ZFS channel program interface, see the manual
3367 .Bl -tag -width indent
3369 Executes a read-only channel program, which runs faster.
3370 The program cannot change on-disk state by calling functions from
3371 the zfs.sync submodule.
3372 The program can be used to gather information such as properties and
3373 determining if changes would succeed (zfs.check.*).
3374 Without this flag, all pending changes must be synced to disk before
3375 a channel program can complete.
3377 Execution time limit, in milliseconds.
3378 If a channel program executes for longer than the provided timeout, it will
3379 be stopped and an error will be returned.
3380 The default timeout is 1000 ms, and can be set to a maximum of 10000 ms.
3381 .It Fl m Ar memory-limit
3382 Memory limit, in bytes.
3383 If a channel program attempts to allocate more memory than the given limit,
3384 it will be stopped and an error returned.
3385 The default memory limit is 10 MB, and can be set to a maximum of 100 MB.
3387 All remaining argument strings are passed directly to the channel program as
3391 for more information.
3396 .Ar jailid filesystem
3399 Attaches the specified
3401 to the jail identified by JID
3403 From now on this file system tree can be managed from within a jail if the
3405 property has been set. To use this functionality, the jail needs the
3409 parameters set to 1 and the
3411 parameter set to a value lower than 2.
3415 for more information on managing jails and configuring the parameters above.
3419 .Ar jailid filesystem
3422 Detaches the specified
3424 from the jail identified by JID
3428 The following exit values are returned:
3429 .Bl -tag -offset 2n -width 2n
3431 Successful completion.
3435 Invalid command line options were specified.
3439 .It Sy Example 1 No Creating a Tn ZFS No File System Hierarchy
3441 The following commands create a file system named
3443 and a file system named
3447 is set for the parent file system, and is automatically inherited by the child
3449 .Bd -literal -offset 2n
3450 .Li # Ic zfs create pool/home
3451 .Li # Ic zfs set mountpoint=/home pool/home
3452 .Li # Ic zfs create pool/home/bob
3454 .It Sy Example 2 No Creating a Tn ZFS No Snapshot
3456 The following command creates a snapshot named
3458 This snapshot is mounted on demand in the
3460 directory at the root of the
3463 .Bd -literal -offset 2n
3464 .Li # Ic zfs snapshot pool/home/bob@yesterday
3466 .It Sy Example 3 No Creating and Destroying Multiple Snapshots
3468 The following command creates snapshots named
3472 and all of its descendent file systems. Each snapshot is mounted on demand in
3475 directory at the root of its file system. The second command destroys the newly
3477 .Bd -literal -offset 2n
3478 .Li # Ic zfs snapshot -r pool/home@yesterday
3479 .Li # Ic zfs destroy -r pool/home@yesterday
3481 .It Sy Example 4 No Disabling and Enabling File System Compression
3483 The following command disables the
3485 property for all file systems under
3487 The next command explicitly enables
3490 .Em pool/home/anne .
3491 .Bd -literal -offset 2n
3492 .Li # Ic zfs set compression=off pool/home
3493 .Li # Ic zfs set compression=on pool/home/anne
3495 .It Sy Example 5 No Listing Tn ZFS No Datasets
3497 The following command lists all active file systems and volumes in the system.
3498 Snapshots are displayed if the
3506 for more information on pool properties.
3507 .Bd -literal -offset 2n
3509 NAME USED AVAIL REFER MOUNTPOINT
3510 pool 450K 457G 18K /pool
3511 pool/home 315K 457G 21K /home
3512 pool/home/anne 18K 457G 18K /home/anne
3513 pool/home/bob 276K 457G 276K /home/bob
3515 .It Sy Example 6 No Setting a Quota on a Tn ZFS No File System
3517 The following command sets a quota of 50 Gbytes for
3519 .Bd -literal -offset 2n
3520 .Li # Ic zfs set quota=50G pool/home/bob
3522 .It Sy Example 7 No Listing Tn ZFS No Properties
3524 The following command lists all properties for
3526 .Bd -literal -offset 2n
3527 .Li # Ic zfs get all pool/home/bob
3528 NAME PROPERTY VALUE SOURCE
3529 pool/home/bob type filesystem -
3530 pool/home/bob creation Tue Jul 21 15:53 2009 -
3531 pool/home/bob used 21K -
3532 pool/home/bob available 20.0G -
3533 pool/home/bob referenced 21K -
3534 pool/home/bob compressratio 1.00x -
3535 pool/home/bob mounted yes -
3536 pool/home/bob quota 20G local
3537 pool/home/bob reservation none default
3538 pool/home/bob recordsize 128K default
3539 pool/home/bob mountpoint /home/bob default
3540 pool/home/bob sharenfs off default
3541 pool/home/bob checksum on default
3542 pool/home/bob compression on local
3543 pool/home/bob atime on default
3544 pool/home/bob devices on default
3545 pool/home/bob exec on default
3546 pool/home/bob filesystem_limit none default
3547 pool/home/bob setuid on default
3548 pool/home/bob readonly off default
3549 pool/home/bob jailed off default
3550 pool/home/bob snapdir hidden default
3551 pool/home/bob snapshot_limit none default
3552 pool/home/bob aclmode discard default
3553 pool/home/bob aclinherit restricted default
3554 pool/home/bob canmount on default
3555 pool/home/bob xattr on default
3556 pool/home/bob copies 1 default
3557 pool/home/bob version 5 -
3558 pool/home/bob utf8only off -
3559 pool/home/bob normalization none -
3560 pool/home/bob casesensitivity sensitive -
3561 pool/home/bob vscan off default
3562 pool/home/bob nbmand off default
3563 pool/home/bob sharesmb off default
3564 pool/home/bob refquota none default
3565 pool/home/bob refreservation none default
3566 pool/home/bob primarycache all default
3567 pool/home/bob secondarycache all default
3568 pool/home/bob usedbysnapshots 0 -
3569 pool/home/bob usedbydataset 21K -
3570 pool/home/bob usedbychildren 0 -
3571 pool/home/bob usedbyrefreservation 0 -
3572 pool/home/bob logbias latency default
3573 pool/home/bob dedup off default
3574 pool/home/bob mlslabel -
3575 pool/home/bob sync standard default
3576 pool/home/bob refcompressratio 1.00x -
3579 The following command gets a single property value.
3580 .Bd -literal -offset 2n
3581 .Li # Ic zfs get -H -o value compression pool/home/bob
3585 The following command lists all properties with local settings for
3587 .Bd -literal -offset 2n
3588 .Li # Ic zfs get -s local -o name,property,value all pool/home/bob
3590 pool/home/bob quota 20G
3591 pool/home/bob compression on
3593 .It Sy Example 8 No Rolling Back a Tn ZFS No File System
3595 The following command reverts the contents of
3597 to the snapshot named
3599 deleting all intermediate snapshots.
3600 .Bd -literal -offset 2n
3601 .Li # Ic zfs rollback -r pool/home/anne@yesterday
3603 .It Sy Example 9 No Creating a Tn ZFS No Clone
3605 The following command creates a writable file system whose initial contents are
3607 .Em pool/home/bob@yesterday .
3608 .Bd -literal -offset 2n
3609 .Li # Ic zfs clone pool/home/bob@yesterday pool/clone
3611 .It Sy Example 10 No Promoting a Tn ZFS No Clone
3613 The following commands illustrate how to test out changes to a file system, and
3614 then replace the original file system with the changed one, using clones, clone
3615 promotion, and renaming:
3616 .Bd -literal -offset 2n
3617 .Li # Ic zfs create pool/project/production
3621 .Pa /pool/project/production
3622 with data and continue with the following commands:
3623 .Bd -literal -offset 2n
3624 .Li # Ic zfs snapshot pool/project/production@today
3625 .Li # Ic zfs clone pool/project/production@today pool/project/beta
3629 .Pa /pool/project/beta
3630 and continue with the following commands:
3631 .Bd -literal -offset 2n
3632 .Li # Ic zfs promote pool/project/beta
3633 .Li # Ic zfs rename pool/project/production pool/project/legacy
3634 .Li # Ic zfs rename pool/project/beta pool/project/production
3637 Once the legacy version is no longer needed, it can be destroyed.
3638 .Bd -literal -offset 2n
3639 .Li # Ic zfs destroy pool/project/legacy
3641 .It Sy Example 11 No Inheriting Tn ZFS No Properties
3643 The following command causes
3649 property from their parent.
3650 .Bd -literal -offset 2n
3651 .Li # Ic zfs inherit checksum pool/home/bob pool/home/anne
3653 .It Sy Example 12 No Remotely Replicating Tn ZFS No Data
3655 The following commands send a full stream and then an incremental stream to a
3656 remote machine, restoring them into
3657 .Sy poolB/received/fs@a
3659 .Sy poolB/received/fs@b ,
3662 must contain the file system
3663 .Sy poolB/received ,
3664 and must not initially contain
3665 .Sy poolB/received/fs .
3666 .Bd -literal -offset 2n
3667 .Li # Ic zfs send pool/fs@a | ssh host zfs receive poolB/received/fs@a
3668 .Li # Ic zfs send -i a pool/fs@b | ssh host zfs receive poolB/received/fs
3677 The following command sends a full stream of
3678 .Sy poolA/fsA/fsB@snap
3679 to a remote machine, receiving it into
3680 .Sy poolB/received/fsA/fsB@snap .
3683 portion of the received snapshot's name is determined from the name of the sent
3686 must contain the file system
3687 .Sy poolB/received .
3689 .Sy poolB/received/fsA
3690 does not exist, it is created as an empty file system.
3691 .Bd -literal -offset 2n
3692 .Li # Ic zfs send poolA/fsA/fsB@snap | ssh host zfs receive -d poolB/received
3694 .It Sy Example 14 No Setting User Properties
3696 The following example sets the user-defined
3697 .Sy com.example:department
3698 property for a dataset.
3699 .Bd -literal -offset 2n
3700 .Li # Ic zfs set com.example:department=12345 tank/accounting
3702 .It Sy Example 15 No Performing a Rolling Snapshot
3704 The following example shows how to maintain a history of snapshots with a
3705 consistent naming scheme. To keep a week's worth of snapshots, the user
3706 destroys the oldest snapshot, renames the remaining snapshots, and then creates
3707 a new snapshot, as follows:
3708 .Bd -literal -offset 2n
3709 .Li # Ic zfs destroy -r pool/users@7daysago
3710 .Li # Ic zfs rename -r pool/users@6daysago @7daysago
3711 .Li # Ic zfs rename -r pool/users@5daysago @6daysago
3712 .Li # Ic zfs rename -r pool/users@4daysago @5daysago
3713 .Li # Ic zfs rename -r pool/users@3daysago @4daysago
3714 .Li # Ic zfs rename -r pool/users@2daysago @3daysago
3715 .Li # Ic zfs rename -r pool/users@yesterday @2daysago
3716 .Li # Ic zfs rename -r pool/users@today @yesterday
3717 .Li # Ic zfs snapshot -r pool/users@today
3723 Property Options on a ZFS File System
3726 The following command shows how to set
3728 property options to enable root access for a specific network on the
3730 file system. The contents of the
3735 .Bd -literal -offset 2n
3736 .Li # Ic zfs set sharenfs="maproot=root,network 192.168.0.0/24" tank/home
3739 Another way to write this command with the same result is:
3740 .Bd -literal -offset 2n
3741 .Li # Ic set zfs sharenfs="-maproot=root -network 192.168.0.0/24" tank/home
3747 Administration Permissions on a
3752 The following example shows how to set permissions so that user
3754 can create, destroy, mount, and take snapshots on
3759 .Bd -literal -offset 2n
3760 .Li # Ic zfs allow cindys create,destroy,mount,snapshot tank/cindys
3761 .Li # Ic zfs allow tank/cindys
3762 ---- Permissions on tank/cindys --------------------------------------
3763 Local+Descendent permissions:
3764 user cindys create,destroy,mount,snapshot
3766 .It Sy Example 18 No Delegating Create Time Permissions on a Tn ZFS No Dataset
3768 The following example shows how to grant anyone in the group
3770 to create file systems in
3772 This syntax also allows staff members to destroy their own file systems, but
3773 not destroy anyone else's file system. The permissions on
3776 .Bd -literal -offset 2n
3777 .Li # Ic zfs allow staff create,mount tank/users
3778 .Li # Ic zfs allow -c destroy tank/users
3779 .Li # Ic zfs allow tank/users
3780 ---- Permissions on tank/users ---------------------------------------
3783 Local+Descendent permissions:
3784 group staff create,mount
3788 Defining and Granting a Permission Set on a
3793 The following example shows how to define and grant a permission set on the
3795 file system. The permissions on
3798 .Bd -literal -offset 2n
3799 .Li # Ic zfs allow -s @pset create,destroy,snapshot,mount tank/users
3800 .Li # Ic zfs allow staff @pset tank/users
3801 .Li # Ic zfs allow tank/users
3802 ---- Permissions on tank/users ---------------------------------------
3804 @pset create,destroy,mount,snapshot
3805 Local+Descendent permissions:
3808 .It Sy Example 20 No Delegating Property Permissions on a Tn ZFS No Dataset
3810 The following example shows to grant the ability to set quotas and reservations
3813 file system. The permissions on
3816 .Bd -literal -offset 2n
3817 .Li # Ic zfs allow cindys quota,reservation users/home
3818 .Li # Ic zfs allow users/home
3819 ---- Permissions on users/home ---------------------------------------
3820 Local+Descendent permissions:
3821 user cindys quota,reservation
3822 .Li # Ic su - cindys
3823 .Li cindys% Ic zfs set quota=10G users/home/marks
3824 .Li cindys% Ic zfs get quota users/home/marks
3825 NAME PROPERTY VALUE SOURCE
3826 users/home/marks quota 10G local
3828 .It Sy Example 21 No Removing ZFS Delegated Permissions on a Tn ZFS No Dataset
3830 The following example shows how to remove the snapshot permission from the
3834 file system. The permissions on
3837 .Bd -literal -offset 2n
3838 .Li # Ic zfs unallow staff snapshot tank/users
3839 .Li # Ic zfs allow tank/users
3840 ---- Permissions on tank/users ---------------------------------------
3842 @pset create,destroy,mount,snapshot
3843 Local+Descendent permissions:
3846 .It Sy Example 22 Showing the differences between a snapshot and a ZFS Dataset
3848 The following example shows how to see what has changed between a prior
3849 snapshot of a ZFS Dataset and its current state. The
3851 option is used to indicate type information for the files affected.
3852 .Bd -literal -offset 2n
3853 .Li # Ic zfs diff tank/test@before tank/test
3855 M F /tank/test/linked (+1)
3856 R F /tank/test/oldname -> /tank/test/newname
3857 - F /tank/test/deleted
3858 + F /tank/test/created
3859 M F /tank/test/modified
3873 This manual page is a
3875 reimplementation of the
3879 modified and customized for
3881 and licensed under the
3882 Common Development and Distribution License
3887 implementation of this manual page was initially written by
3888 .An Martin Matuska Aq mm@FreeBSD.org .
projects / FreeBSD / FreeBSD.git / blob