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]
23 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
24 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
25 .\" Copyright (c) 2012 by Delphix. All rights reserved.
26 .\" Copyright (c) 2012, Joyent, Inc. All rights reserved.
27 .\" Copyright 2012 Nexenta Systems, Inc. All Rights Reserved.
28 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
30 .TH zfs 8 "Jan 10, 2013" "ZFS pool 28, filesystem 5" "System Administration Commands"
32 zfs \- configures ZFS file systems
41 \fBzfs\fR \fBcreate\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem\fR
46 \fBzfs\fR \fBcreate\fR [\fB-ps\fR] [\fB-b\fR \fIblocksize\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fB-V\fR \fIsize\fR \fIvolume\fR
51 \fBzfs\fR \fBdestroy\fR [\fB-fnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR
56 \fBzfs\fR \fBdestroy\fR [\fB-dnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR@\fIsnap\fR[%\fIsnap\fR][,...]
61 \fBzfs\fR \fBsnapshot | snap\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]...
62 \fIfilesystem@snapname\fR|\fIvolume@snapname\fR
67 \fBzfs\fR \fBrollback\fR [\fB-rRf\fR] \fIsnapshot\fR
72 \fBzfs\fR \fBclone\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR
77 \fBzfs\fR \fBpromote\fR \fIclone-filesystem\fR
82 \fBzfs\fR \fBrename\fR [\fB-f\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
83 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
88 \fBzfs\fR \fBrename\fR [\fB-fp\fR] \fIfilesystem\fR|\fIvolume\fR \fIfilesystem\fR|\fIvolume\fR
93 \fBzfs\fR \fBrename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR
98 \fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-H\fR][\fB-o\fR \fIproperty\fR[,...]] [\fB-t\fR \fItype\fR[,...]]
99 [\fB-s\fR \fIproperty\fR] ... [\fB-S\fR \fIproperty\fR] ... [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR|\fIsnap\fR] ...
104 \fBzfs\fR \fBset\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...
109 \fBzfs\fR \fBget\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-Hp\fR][\fB-o\fR \fIfield\fR[,...]] [\fB-t\fR \fItype\fR[,...]]
110 [\fB-s\fR \fIsource\fR[,...]] "\fIall\fR" | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...
115 \fBzfs\fR \fBinherit\fR [\fB-r\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume|snapshot\fR ...
120 \fBzfs\fR \fBupgrade\fR [\fB-v\fR]
125 \fBzfs\fR \fBupgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIfilesystem\fR
130 \fBzfs\fR \fBuserspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-s\fR \fIfield\fR] ...
131 [\fB-S\fR \fIfield\fR] ... [\fB-t\fR \fItype\fR[,...]] \fIfilesystem\fR|\fIsnapshot\fR
136 \fBzfs\fR \fBgroupspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-s\fR \fIfield\fR] ...
137 [\fB-S\fR \fIfield\fR] ... [\fB-t\fR \fItype\fR[,...]] \fIfilesystem\fR|\fIsnapshot\fR
142 \fBzfs\fR \fBmount\fR
147 \fBzfs\fR \fBmount\fR [\fB-vO\fR] [\fB-o \fIoptions\fR\fR] \fB-a\fR | \fIfilesystem\fR
152 \fBzfs\fR \fBunmount | umount\fR [\fB-f\fR] \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR
157 \fBzfs\fR \fBshare\fR \fB-a\fR | \fIfilesystem\fR
162 \fBzfs\fR \fBunshare\fR \fB-a\fR \fIfilesystem\fR|\fImountpoint\fR
167 \fBzfs\fR \fBsend\fR [\fB-DnPpRv\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
172 \fBzfs\fR \fBreceive | recv\fR [\fB-vnFu\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
177 \fBzfs\fR \fBreceive | recv\fR [\fB-vnFu\fR] [\fB-d\fR|\fB-e\fR] \fIfilesystem\fR
182 \fBzfs\fR \fBallow\fR \fIfilesystem\fR|\fIvolume\fR
187 \fBzfs\fR \fBallow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|\fI@setname\fR[,...]
188 \fIfilesystem\fR|\fIvolume\fR
193 \fBzfs\fR \fBallow\fR [\fB-ld\fR] \fB-e\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR
198 \fBzfs\fR \fBallow\fR \fB-c\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR
203 \fBzfs\fR \fBallow\fR \fB-s\fR @\fIsetname\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR
208 \fBzfs\fR \fBunallow\fR [\fB-rldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] [\fIperm\fR|@\fIsetname\fR[,... ]]
209 \fIfilesystem\fR|\fIvolume\fR
214 \fBzfs\fR \fBunallow\fR [\fB-rld\fR] \fB-e\fR [\fIperm\fR|@\fIsetname\fR[,... ]] \fIfilesystem\fR|\fIvolume\fR
219 \fBzfs\fR \fBunallow\fR [\fB-r\fR] \fB-c\fR [\fIperm\fR|@\fIsetname\fR[ ... ]] \fIfilesystem\fR|\fIvolume\fR
224 \fBzfs\fR \fBunallow\fR [\fB-r\fR] \fB-s\fR @\fIsetname\fR [\fIperm\fR|@\fIsetname\fR[,... ]] \fIfilesystem\fR|\fIvolume\fR
229 \fBzfs\fR \fBhold\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...
234 \fBzfs\fR \fBholds\fR [\fB-r\fR] \fIsnapshot\fR...
239 \fBzfs\fR \fBrelease\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...
244 \fBzfs\fR \fBdiff\fR [\fB-FHt\fR] \fIsnapshot\fR \fIsnapshot|filesystem\fR
249 The \fBzfs\fR command configures \fBZFS\fR datasets within a \fBZFS\fR storage pool, as described in \fBzpool\fR(8). A dataset is identified by a unique path within the \fBZFS\fR namespace. For example:
253 pool/{filesystem,volume,snapshot}
260 where the maximum length of a dataset name is \fBMAXNAMELEN\fR (256 bytes).
263 A dataset can be one of the following:
268 \fB\fIfile system\fR\fR
272 A \fBZFS\fR dataset of type \fBfilesystem\fR can be mounted within the standard system namespace and behaves like other file systems. While \fBZFS\fR file systems are designed to be \fBPOSIX\fR compliant, known issues exist that prevent compliance in some cases. Applications that depend on standards conformance might fail due to nonstandard behavior when checking file system free space.
283 A logical volume exported as a raw or block device. This type of dataset should only be used under special circumstances. File systems are typically used in most environments.
294 A read-only version of a file system or volume at a given point in time. It is specified as \fIfilesystem@name\fR or \fIvolume@name\fR.
297 .SS "ZFS File System Hierarchy"
300 A \fBZFS\fR storage pool is a logical collection of devices that provide space for datasets. A storage pool is also the root of the \fBZFS\fR file system hierarchy.
303 The root of the pool can be accessed as a file system, such as mounting and unmounting, taking snapshots, and setting properties. The physical storage characteristics, however, are managed by the \fBzpool\fR(8) command.
306 See \fBzpool\fR(8) for more information on creating and administering pools.
310 A snapshot is a read-only copy of a file system or volume. Snapshots can be created extremely quickly, and initially consume no additional space within the pool. As data within the active dataset changes, the snapshot consumes more data than would otherwise be shared with the active dataset.
313 Snapshots can have arbitrary names. Snapshots of volumes can be cloned or rolled back, but cannot be accessed independently.
316 File system snapshots can be accessed under the \fB\&.zfs/snapshot\fR directory in the root of the file system. Snapshots are automatically mounted on demand and may be unmounted at regular intervals. The visibility of the \fB\&.zfs\fR directory can be controlled by the \fBsnapdir\fR property.
320 A clone is a writable volume or file system whose initial contents are the same as another dataset. As with snapshots, creating a clone is nearly instantaneous, and initially consumes no additional space.
323 Clones can only be created from a snapshot. When a snapshot is cloned, it creates an implicit dependency between the parent and child. Even though the clone is created somewhere else in the dataset hierarchy, the original snapshot cannot be destroyed as long as a clone exists. The \fBorigin\fR property exposes this dependency, and the \fBdestroy\fR command lists any such dependencies, if they exist.
326 The clone parent-child dependency relationship can be reversed by using the \fBpromote\fR subcommand. This causes the "origin" file system to become a clone of the specified file system, which makes it possible to destroy the file system that the clone was created from.
330 Creating a \fBZFS\fR file system is a simple operation, so the number of file systems per system is likely to be numerous. To cope with this, \fBZFS\fR automatically manages mounting and unmounting file systems without the need to edit the \fB/etc/fstab\fR file. All automatically managed file systems are mounted by \fBZFS\fR at boot time.
333 By default, file systems are mounted under \fB/\fIpath\fR\fR, where \fIpath\fR is the name of the file system in the \fBZFS\fR namespace. Directories are created and destroyed as needed.
336 A file system can also have a mount point set in the \fBmountpoint\fR property. This directory is created as needed, and \fBZFS\fR automatically mounts the file system when the \fBzfs mount -a\fR command is invoked (without editing \fB/etc/fstab\fR). The \fBmountpoint\fR property can be inherited, so if \fBpool/home\fR has a mount point of \fB/export/stuff\fR, then \fBpool/home/user\fR automatically inherits a mount point of \fB/export/stuff/user\fR.
339 A file system \fBmountpoint\fR property of \fBnone\fR prevents the file system from being mounted.
342 If needed, \fBZFS\fR file systems can also be managed with traditional tools (\fBmount\fR, \fBumount\fR, \fB/etc/fstab\fR). If a file system's mount point is set to \fBlegacy\fR, \fBZFS\fR makes no attempt to manage the file system, and the administrator is responsible for mounting and unmounting the file system.
346 Deduplication is the process for removing redundant data at the block-level, reducing the total amount of data stored. If a file system has the \fBdedup\fR property enabled, duplicate data blocks are removed synchronously. The result is that only unique data is stored and common components are shared among files.
347 .SS "Native Properties"
350 Properties are divided into two types, native properties and user-defined (or "user") properties. Native properties either export internal statistics or control \fBZFS\fR behavior. In addition, native properties are either editable or read-only. User properties have no effect on \fBZFS\fR behavior, but you can use them to annotate datasets in a way that is meaningful in your environment. For more information about user properties, see the "User Properties" section, below.
353 Every dataset has a set of properties that export statistics about the dataset as well as control various behaviors. Properties are inherited from the parent unless overridden by the child. Some properties apply only to certain types of datasets (file systems, volumes, or snapshots).
356 The values of numeric properties can be specified using human-readable suffixes (for example, \fBk\fR, \fBKB\fR, \fBM\fR, \fBGb\fR, and so forth, up to \fBZ\fR for zettabyte). The following are all valid (and equal) specifications:
367 The values of non-numeric properties are case sensitive and must be lowercase, except for \fBmountpoint\fR, \fBsharenfs\fR, and \fBsharesmb\fR.
370 The following native properties consist of read-only statistics about the dataset. These properties can be neither set, nor inherited. Native properties apply to all dataset types unless otherwise noted.
375 \fB\fBavailable\fR\fR
379 The amount of space available to the dataset and all its children, assuming that there is no other activity in the pool. Because space is shared within a pool, availability can be limited by any number of factors, including physical pool size, quotas, reservations, or other datasets within the pool.
381 This property can also be referred to by its shortened column name, \fBavail\fR.
388 \fB\fBcompressratio\fR\fR
392 For non-snapshots, the compression ratio achieved for the \fBused\fR space of this dataset, expressed as a multiplier. The \fBused\fR property includes descendant datasets, and, for clones, does not include the space shared with the origin snapshot. For snapshots, the \fBcompressratio\fR is the same as the \fBrefcompressratio\fR property. Compression can be turned on by running: \fBzfs set compression=on \fIdataset\fR\fR. The default value is \fBoff\fR.
403 The time this dataset was created.
414 For snapshots, this property is a comma-separated list of filesystems or
415 volumes which are clones of this snapshot. The clones' \fBorigin\fR property
416 is this snapshot. If the \fBclones\fR property is not empty, then this
417 snapshot can not be destroyed (even with the \fB-r\fR or \fB-f\fR options).
423 \fB\fBdefer_destroy\fR\fR
427 This property is \fBon\fR if the snapshot has been marked for deferred destruction by using the \fBzfs destroy\fR \fB-d\fR command. Otherwise, the property is \fBoff\fR.
438 For file systems, indicates whether the file system is currently mounted. This property can be either \fByes\fR or \fBno\fR.
449 For cloned file systems or volumes, the snapshot from which the clone was created. See also the \fBclones\fR property.
456 \fB\fBreferenced\fR\fR
460 The amount of data that is accessible by this dataset, which may or may not be shared with other datasets in the pool. When a snapshot or clone is created, it initially references the same amount of space as the file system or snapshot it was created from, since its contents are identical.
462 This property can also be referred to by its shortened column name, \fBrefer\fR.
469 \fB\fBrefcompressratio\fR\fR
473 The compression ratio achieved for the \fBreferenced\fR space of this
474 dataset, expressed as a multiplier. See also the \fBcompressratio\fR
486 The type of dataset: \fBfilesystem\fR, \fBvolume\fR, or \fBsnapshot\fR.
497 The amount of space consumed by this dataset and all its descendents. This is the value that is checked against this dataset's quota and reservation. The space used does not include this dataset's reservation, but does take into account the reservations of any descendent datasets. The amount of space that a dataset consumes from its parent, as well as the amount of space that are freed if this dataset is recursively destroyed, is the greater of its space used and its reservation.
499 When snapshots (see the "Snapshots" section) are created, their space is initially shared between the snapshot and the file system, and possibly with previous snapshots. As the file system changes, space that was previously shared becomes unique to the snapshot, and counted in the snapshot's space used. Additionally, deleting snapshots can increase the amount of space unique to (and used by) other snapshots.
501 The amount of space used, available, or referenced does not take into account pending changes. Pending changes are generally accounted for within a few seconds. Committing a change to a disk using \fBfsync\fR(2) or \fBO_SYNC\fR does not necessarily guarantee that the space usage information is updated immediately.
512 The \fBusedby*\fR properties decompose the \fBused\fR properties into the various reasons that space is used. Specifically, \fBused\fR = \fBusedbychildren\fR + \fBusedbydataset\fR + \fBusedbyrefreservation\fR +, \fBusedbysnapshots\fR. These properties are only available for datasets created on \fBzpool\fR "version 13" pools.
519 \fB\fBusedbychildren\fR\fR
523 The amount of space used by children of this dataset, which would be freed if all the dataset's children were destroyed.
530 \fB\fBusedbydataset\fR\fR
534 The amount of space used by this dataset itself, which would be freed if the dataset were destroyed (after first removing any \fBrefreservation\fR and destroying any necessary snapshots or descendents).
541 \fB\fBusedbyrefreservation\fR\fR
545 The amount of space used by a \fBrefreservation\fR set on this dataset, which would be freed if the \fBrefreservation\fR was removed.
552 \fB\fBusedbysnapshots\fR\fR
556 The amount of space consumed by snapshots of this dataset. In particular, it is the amount of space that would be freed if all of this dataset's snapshots were destroyed. Note that this is not simply the sum of the snapshots' \fBused\fR properties because space can be shared by multiple snapshots.
563 \fB\fBuserused@\fR\fIuser\fR\fR
567 The amount of space consumed by the specified user in this dataset. Space is charged to the owner of each file, as displayed by \fBls\fR \fB-l\fR. The amount of space charged is displayed by \fBdu\fR and \fBls\fR \fB-s\fR. See the \fBzfs userspace\fR subcommand for more information.
569 Unprivileged users can access only their own space usage. The root user, or a user who has been granted the \fBuserused\fR privilege with \fBzfs allow\fR, can access everyone's usage.
571 The \fBuserused@\fR... properties are not displayed by \fBzfs get all\fR. The user's name must be appended after the \fB@\fR symbol, using one of the following forms:
576 \fIPOSIX name\fR (for example, \fBjoe\fR)
582 \fIPOSIX numeric ID\fR (for example, \fB789\fR)
588 \fISID name\fR (for example, \fBjoe.smith@mydomain\fR)
594 \fISID numeric ID\fR (for example, \fBS-1-123-456-789\fR)
606 This property is set to the number of user holds on this snapshot. User holds are set by using the \fBzfs hold\fR command.
613 \fB\fBgroupused@\fR\fIgroup\fR\fR
617 The amount of space consumed by the specified group in this dataset. Space is charged to the group of each file, as displayed by \fBls\fR \fB-l\fR. See the \fBuserused@\fR\fIuser\fR property for more information.
619 Unprivileged users can only access their own groups' space usage. The root user, or a user who has been granted the \fBgroupused\fR privilege with \fBzfs allow\fR, can access all groups' usage.
626 \fB\fBvolblocksize\fR=\fIblocksize\fR\fR
630 For volumes, specifies the block size of the volume. The \fBblocksize\fR cannot be changed once the volume has been written, so it should be set at volume creation time. The default \fBblocksize\fR for volumes is 8 Kbytes. Any power of 2 from 512 bytes to 128 Kbytes is valid.
632 This property can also be referred to by its shortened column name, \fBvolblock\fR.
642 The amount of \fBreferenced\fR space written to this dataset since the
649 \fB\fBwritten@\fR\fIsnapshot\fR\fR
653 The amount of \fBreferenced\fR space written to this dataset since the
654 specified snapshot. This is the space that is referenced by this dataset
655 but was not referenced by the specified snapshot.
657 The \fIsnapshot\fR may be specified as a short snapshot name (just the part
658 after the \fB@\fR), in which case it will be interpreted as a snapshot in
659 the same filesystem as this dataset.
660 The \fIsnapshot\fR be a full snapshot name (\fIfilesystem\fR@\fIsnapshot\fR),
661 which for clones may be a snapshot in the origin's filesystem (or the origin
662 of the origin's filesystem, etc).
667 The following native properties can be used to change the behavior of a \fBZFS\fR dataset.
672 \fB\fBaclinherit\fR=\fBdiscard\fR | \fBnoallow\fR | \fBrestricted\fR | \fBpassthrough\fR | \fBpassthrough-x\fR\fR
676 Controls how \fBACL\fR entries are inherited when files and directories are created. A file system with an \fBaclinherit\fR property of \fBdiscard\fR does not inherit any \fBACL\fR entries. A file system with an \fBaclinherit\fR property value of \fBnoallow\fR only inherits inheritable \fBACL\fR entries that specify "deny" permissions. The property value \fBrestricted\fR (the default) removes the \fBwrite_acl\fR and \fBwrite_owner\fR permissions when the \fBACL\fR entry is inherited. A file system with an \fBaclinherit\fR property value of \fBpassthrough\fR inherits all inheritable \fBACL\fR entries without any modifications made to the \fBACL\fR entries when they are inherited. A file system with an \fBaclinherit\fR property value of \fBpassthrough-x\fR has the same meaning as \fBpassthrough\fR, except that the \fBowner@\fR, \fBgroup@\fR, and \fBeveryone@\fR \fBACE\fRs inherit the execute permission only if the file creation mode also requests the execute bit.
678 When the property value is set to \fBpassthrough\fR, files are created with a mode determined by the inheritable \fBACE\fRs. If no inheritable \fBACE\fRs exist that affect the mode, then the mode is set in accordance to the requested mode from the application.
685 \fB\fBaclmode\fR=\fBdiscard\fR | \fBgroupmask\fR | \fBpassthrough\fR\fR
689 Controls how an \fBACL\fR is modified during \fBchmod\fR(2). A file system with an \fBaclmode\fR property of \fBdiscard\fR deletes all \fBACL\fR entries that do not represent the mode of the file. An \fBaclmode\fR property of \fBgroupmask\fR (the default) reduces user or group permissions. The permissions are reduced, such that they are no greater than the group permission bits, unless it is a user entry that has the same \fBUID\fR as the owner of the file or directory. In this case, the \fBACL\fR permissions are reduced so that they are no greater than owner permission bits. A file system with an \fBaclmode\fR property of \fBpassthrough\fR indicates that no changes are made to the \fBACL\fR other than generating the necessary \fBACL\fR entries to represent the new mode of the file or directory.
696 \fB\fBatime\fR=\fBon\fR | \fBoff\fR\fR
700 Controls whether the access time for files is updated when they are read. Turning this property off avoids producing write traffic when reading files and can result in significant performance gains, though it might confuse mailers and other similar utilities. The default value is \fBon\fR.
707 \fB\fBcanmount\fR=\fBon\fR | \fBoff\fR | \fBnoauto\fR\fR
711 If this property is set to \fBoff\fR, the file system cannot be mounted, and is ignored by \fBzfs mount -a\fR. Setting this property to \fBoff\fR is similar to setting the \fBmountpoint\fR property to \fBnone\fR, except that the dataset still has a normal \fBmountpoint\fR property, which can be inherited. Setting this property to \fBoff\fR allows datasets to be used solely as a mechanism to inherit properties. One example of setting \fBcanmount=\fR\fBoff\fR is to have two datasets with the same \fBmountpoint\fR, so that the children of both datasets appear in the same directory, but might have different inherited characteristics.
713 When the \fBnoauto\fR option is set, a dataset can only be mounted and unmounted explicitly. The dataset is not mounted automatically when the dataset is created or imported, nor is it mounted by the \fBzfs mount -a\fR command or unmounted by the \fBzfs unmount -a\fR command.
715 This property is not inherited.
722 \fB\fBchecksum\fR=\fBon\fR | \fBoff\fR | \fBfletcher2,\fR| \fBfletcher4\fR | \fBsha256\fR\fR
726 Controls the checksum used to verify data integrity. The default value is \fBon\fR, which automatically selects an appropriate algorithm (currently, \fBfletcher2\fR, but this may change in future releases). The value \fBoff\fR disables integrity checking on user data. Disabling checksums is \fBNOT\fR a recommended practice.
728 Changing this property affects only newly-written data.
735 \fBcompression\fR=\fBon\fR | \fBoff\fR | \fBlzjb\fR | \fBgzip\fR | \fBgzip-\fR\fIN\fR | \fBzle\fR | \fBlz4\fR
739 Controls the compression algorithm used for this dataset. The \fBlzjb\fR compression algorithm is optimized for performance while providing decent data compression. Setting compression to \fBon\fR uses the \fBlzjb\fR compression algorithm.
741 The \fBgzip\fR compression algorithm uses the same compression as the \fBgzip\fR(1) command. You can specify the \fBgzip\fR level by using the value \fBgzip-\fR\fIN\fR where \fIN\fR is an integer from 1 (fastest) to 9 (best compression ratio). Currently, \fBgzip\fR is equivalent to \fBgzip-6\fR (which is also the default for \fBgzip\fR(1)).
743 The \fBzle\fR (zero-length encoding) compression algorithm is a fast and simple algorithm to eliminate runs of zeroes.
745 The \fBlz4\fR compression algorithm is a high-performance replacement
746 for the \fBlzjb\fR algorithm. It features significantly faster
747 compression and decompression, as well as a moderately higher
748 compression ratio than \fBlzjb\fR, but can only be used on pools with
749 the \fBlz4_compress\fR feature set to \fIenabled\fR. See
750 \fBzpool-features\fR(5) for details on ZFS feature flags and the
751 \fBlz4_compress\fR feature.
753 This property can also be referred to by its shortened column name \fBcompress\fR. Changing this property affects only newly-written data.
760 \fB\fBcopies\fR=\fB1\fR | \fB2\fR | \fB3\fR\fR
764 Controls the number of copies of data stored for this dataset. These copies are in addition to any redundancy provided by the pool, for example, mirroring or RAID-Z. The copies are stored on different disks, if possible. The space used by multiple copies is charged to the associated file and dataset, changing the \fBused\fR property and counting against quotas and reservations.
766 Changing this property only affects newly-written data. Therefore, set this property at file system creation time by using the \fB-o\fR \fBcopies=\fR\fIN\fR option.
773 \fB\fBdedup\fR=\fBon\fR | \fBoff\fR | \fBverify\fR | \fBsha256\fR[,\fBverify\fR]\fR
777 Controls whether deduplication is in effect for a dataset. The default value is \fBoff\fR. The default checksum used for deduplication is \fBsha256\fR (subject to change). When \fBdedup\fR is enabled, the \fBdedup\fR checksum algorithm overrides the \fBchecksum\fR property. Setting the value to \fBverify\fR is equivalent to specifying \fBsha256,verify\fR.
779 If the property is set to \fBverify\fR, then, whenever two blocks have the same signature, ZFS will do a byte-for-byte comparison with the existing block to ensure that the contents are identical.
786 \fB\fBdevices\fR=\fBon\fR | \fBoff\fR\fR
790 Controls whether device nodes can be opened on this file system. The default value is \fBon\fR.
797 \fB\fBexec\fR=\fBon\fR | \fBoff\fR\fR
801 Controls whether processes can be executed from within this file system. The default value is \fBon\fR.
808 \fB\fBmlslabel\fR=\fIlabel\fR | \fBnone\fR\fR
812 The \fBmlslabel\fR property is a sensitivity label that determines if a dataset can be mounted in a zone on a system with Trusted Extensions enabled. If the labeled dataset matches the labeled zone, the dataset can be mounted and accessed from the labeled zone.
814 When the \fBmlslabel\fR property is not set, the default value is \fBnone\fR. Setting the \fBmlslabel\fR property to \fBnone\fR is equivalent to removing the property.
816 The \fBmlslabel\fR property can be modified only when Trusted Extensions is enabled and only with appropriate privilege. Rights to modify it cannot be delegated. When changing a label to a higher label or setting the initial dataset label, the \fB{PRIV_FILE_UPGRADE_SL}\fR privilege is required. When changing a label to a lower label or the default (\fBnone\fR), the \fB{PRIV_FILE_DOWNGRADE_SL}\fR privilege is required. Changing the dataset to labels other than the default can be done only when the dataset is not mounted. When a dataset with the default label is mounted into a labeled-zone, the mount operation automatically sets the \fBmlslabel\fR property to the label of that zone.
818 When Trusted Extensions is \fBnot\fR enabled, only datasets with the default label (\fBnone\fR) can be mounted.
820 Zones are a Solaris feature and are not relevant on Linux.
827 \fB\fBmountpoint\fR=\fIpath\fR | \fBnone\fR | \fBlegacy\fR\fR
831 Controls the mount point used for this file system. See the "Mount Points" section for more information on how this property is used.
833 When the \fBmountpoint\fR property is changed for a file system, the file system and any children that inherit the mount point are unmounted. If the new value is \fBlegacy\fR, then they remain unmounted. Otherwise, they are automatically remounted in the new location if the property was previously \fBlegacy\fR or \fBnone\fR, or if they were mounted before the property was changed. In addition, any shared file systems are unshared and shared in the new location.
840 \fB\fBnbmand\fR=\fBon\fR | \fBoff\fR\fR
844 Controls whether the file system should be mounted with \fBnbmand\fR (Non Blocking mandatory locks). This is used for \fBCIFS\fR clients. Changes to this property only take effect when the file system is umounted and remounted. See \fBmount\fR(8) for more information on \fBnbmand\fR mounts.
851 \fB\fBprimarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR
855 Controls what is cached in the primary cache (ARC). If this property is set to \fBall\fR, then both user data and metadata is cached. If this property is set to \fBnone\fR, then neither user data nor metadata is cached. If this property is set to \fBmetadata\fR, then only metadata is cached. The default value is \fBall\fR.
862 \fB\fBquota\fR=\fIsize\fR | \fBnone\fR\fR
866 Limits the amount of space a dataset and its descendents can consume. This property enforces a hard limit on the amount of space used. This includes all space consumed by descendents, including file systems and snapshots. Setting a quota on a descendent of a dataset that already has a quota does not override the ancestor's quota, but rather imposes an additional limit.
868 Quotas cannot be set on volumes, as the \fBvolsize\fR property acts as an implicit quota.
875 \fB\fBuserquota@\fR\fIuser\fR=\fIsize\fR | \fBnone\fR\fR
879 Limits the amount of space consumed by the specified user. Similar to the \fBrefquota\fR property, the \fBuserquota\fR space calculation does not include space that is used by descendent datasets, such as snapshots and clones. User space consumption is identified by the \fBuserspace@\fR\fIuser\fR property.
881 Enforcement of user quotas may be delayed by several seconds. This delay means that a user might exceed their quota before the system notices that they are over quota and begins to refuse additional writes with the \fBEDQUOT\fR error message . See the \fBzfs userspace\fR subcommand for more information.
883 Unprivileged users can only access their own groups' space usage. The root user, or a user who has been granted the \fBuserquota\fR privilege with \fBzfs allow\fR, can get and set everyone's quota.
885 This property is not available on volumes, on file systems before version 4, or on pools before version 15. The \fBuserquota@\fR... properties are not displayed by \fBzfs get all\fR. The user's name must be appended after the \fB@\fR symbol, using one of the following forms:
890 \fIPOSIX name\fR (for example, \fBjoe\fR)
896 \fIPOSIX numeric ID\fR (for example, \fB789\fR)
902 \fISID name\fR (for example, \fBjoe.smith@mydomain\fR)
908 \fISID numeric ID\fR (for example, \fBS-1-123-456-789\fR)
916 \fB\fBgroupquota@\fR\fIgroup\fR=\fIsize\fR | \fBnone\fR\fR
920 Limits the amount of space consumed by the specified group. Group space consumption is identified by the \fBuserquota@\fR\fIuser\fR property.
922 Unprivileged users can access only their own groups' space usage. The root user, or a user who has been granted the \fBgroupquota\fR privilege with \fBzfs allow\fR, can get and set all groups' quotas.
929 \fB\fBreadonly\fR=\fBon\fR | \fBoff\fR\fR
933 Controls whether this dataset can be modified. The default value is \fBoff\fR.
935 This property can also be referred to by its shortened column name, \fBrdonly\fR.
942 \fB\fBrecordsize\fR=\fIsize\fR\fR
946 Specifies a suggested block size for files in the file system. This property is designed solely for use with database workloads that access files in fixed-size records. \fBZFS\fR automatically tunes block sizes according to internal algorithms optimized for typical access patterns.
948 For databases that create very large files but access them in small random chunks, these algorithms may be suboptimal. Specifying a \fBrecordsize\fR greater than or equal to the record size of the database can result in significant performance gains. Use of this property for general purpose file systems is strongly discouraged, and may adversely affect performance.
950 The size specified must be a power of two greater than or equal to 512 and less than or equal to 128 Kbytes.
952 Changing the file system's \fBrecordsize\fR affects only files created afterward; existing files are unaffected.
954 This property can also be referred to by its shortened column name, \fBrecsize\fR.
961 \fB\fBrefquota\fR=\fIsize\fR | \fBnone\fR\fR
965 Limits the amount of space a dataset can consume. This property enforces a hard limit on the amount of space used. This hard limit does not include space used by descendents, including file systems and snapshots.
972 \fB\fBrefreservation\fR=\fIsize\fR | \fBnone\fR\fR
976 The minimum amount of space guaranteed to a dataset, not including its descendents. When the amount of space used is below this value, the dataset is treated as if it were taking up the amount of space specified by \fBrefreservation\fR. The \fBrefreservation\fR reservation is accounted for in the parent datasets' space used, and counts against the parent datasets' quotas and reservations.
978 If \fBrefreservation\fR is set, a snapshot is only allowed if there is enough free pool space outside of this reservation to accommodate the current number of "referenced" bytes in the dataset.
980 This property can also be referred to by its shortened column name, \fBrefreserv\fR.
987 \fB\fBreservation\fR=\fIsize\fR | \fBnone\fR\fR
991 The minimum amount of space guaranteed to a dataset and its descendents. When the amount of space used is below this value, the dataset is treated as if it were taking up the amount of space specified by its reservation. Reservations are accounted for in the parent datasets' space used, and count against the parent datasets' quotas and reservations.
993 This property can also be referred to by its shortened column name, \fBreserv\fR.
1000 \fB\fBsecondarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR
1004 Controls what is cached in the secondary cache (L2ARC). If this property is set to \fBall\fR, then both user data and metadata is cached. If this property is set to \fBnone\fR, then neither user data nor metadata is cached. If this property is set to \fBmetadata\fR, then only metadata is cached. The default value is \fBall\fR.
1011 \fB\fBsetuid\fR=\fBon\fR | \fBoff\fR\fR
1015 Controls whether the set-\fBUID\fR bit is respected for the file system. The default value is \fBon\fR.
1022 \fB\fBshareiscsi\fR=\fBon\fR | \fBoff\fR\fR
1026 Like the \fBsharenfs\fR property, \fBshareiscsi\fR indicates whether a \fBZFS\fR volume is exported as an \fBiSCSI\fR target. The acceptable values for this property are \fBon\fR, \fBoff\fR, and \fBtype=disk\fR. The default value is \fBoff\fR. In the future, other target types might be supported. For example, \fBtape\fR.
1028 You might want to set \fBshareiscsi=on\fR for a file system so that all \fBZFS\fR volumes within the file system are shared by default. However, setting this property on a file system has no direct effect.
1035 \fB\fBsharesmb\fR=\fBon\fR | \fBoff\fR
1039 Controls whether the file system is shared by using \fBSamba USERSHARES\fR, and what options are to be used. Otherwise, the file system is automatically shared and unshared with the \fBzfs share\fR and \fBzfs unshare\fR commands. If the property is set to \fBon\fR, the \fBnet\fR(8) command is invoked to create a \fBUSERSHARE\fR.
1041 Because \fBSMB\fR shares requires a resource name, a unique resource name is constructed from the dataset name. The constructed name is a copy of the dataset name except that the characters in the dataset name, which would be illegal in the resource name, are replaced with underscore (\fB_\fR) characters. The ZFS On Linux driver does not (yet) support additional options which might be availible in the Solaris version.
1043 If the \fBsharesmb\fR property is set to \fBoff\fR, the file systems are unshared.
1045 In Linux, the share is created with the ACL (Access Control List) "Everyone:F" ("F" stands for "full permissions", ie. read and write permissions) and no guest access (which means samba must be able to authenticate a real user, system passwd/shadow, ldap or smbpasswd based) by default. This means that any additional access control (dissalow specific user specific access etc) must be done on the underlaying filesystem.
1048 Example to mount a SMB filesystem shared through ZFS (share/tmp):
1050 Note that a user and his/her password \fBmust\fR be given!
1053 smbmount //127.0.0.1/share_tmp /mnt/tmp -o user=workgroup/turbo,password=obrut,uid=1000
1060 \fBMinimal /etc/samba/smb.conf configuration\fR
1063 * Samba will need to listen to 'localhost' (127.0.0.1) for the zfs utilities to communitate with samba. This is the default behavior for most Linux distributions.
1065 * Samba must be able to authenticate a user. This can be done in a number of ways, depending on if using the system password file, LDAP or the Samba specific smbpasswd file. How to do this is outside the scope of this manual. Please refer to the smb.conf(5) manpage for more information.
1067 * See the \fBUSERSHARE\fR section of the \fBsmb.conf\fR(5) man page for all configuration options in case you need to modify any options to the share afterwards. Do note that any changes done with the 'net' command will be undone if the share is every unshared (such as at a reboot etc). In the future, ZoL will be able to set specific options directly using sharesmb=<option>.
1076 \fB\fBsharenfs\fR=\fBon\fR | \fBoff\fR | \fIopts\fR\fR
1080 Controls whether the file system is shared via \fBNFS\fR, and what options are used. A file system with a \fBsharenfs\fR property of \fBoff\fR is managed through traditional tools such as \fBshare\fR(1M), \fBunshare\fR(1M), and \fBdfstab\fR(4). Otherwise, the file system is automatically shared and unshared with the \fBzfs share\fR and \fBzfs unshare\fR commands. If the property is set to \fBon\fR, the \fBshare\fR(1M) command is invoked with no options. Otherwise, the \fBshare\fR(1M) command is invoked with options equivalent to the contents of this property.
1082 When the \fBsharenfs\fR property is changed for a dataset, the dataset and any children inheriting the property are re-shared with the new options, only if the property was previously \fBoff\fR, or if they were shared before the property was changed. If the new property is \fBoff\fR, the file systems are unshared.
1089 \fB\fBlogbias\fR = \fBlatency\fR | \fBthroughput\fR\fR
1093 Provide a hint to ZFS about handling of synchronous requests in this dataset. If \fBlogbias\fR is set to \fBlatency\fR (the default), ZFS will use pool log devices (if configured) to handle the requests at low latency. If \fBlogbias\fR is set to \fBthroughput\fR, ZFS will not use configured pool log devices. ZFS will instead optimize synchronous operations for global pool throughput and efficient use of resources.
1100 \fB\fBsnapdev\fR=\fBhidden\fR | \fBvisible\fR\fR
1104 Controls whether the snapshots devices of zvol's are hidden or visible. The default value is \fBhidden\fR.
1111 \fB\fBsnapdir\fR=\fBhidden\fR | \fBvisible\fR\fR
1115 Controls whether the \fB\&.zfs\fR directory is hidden or visible in the root of the file system as discussed in the "Snapshots" section. The default value is \fBhidden\fR.
1122 \fB\fBsync\fR=\fBdefault\fR | \fBalways\fR | \fBdisabled\fR\fR
1126 Controls the behavior of synchronous requests (e.g. fsync, O_DSYNC).
1127 \fBdefault\fR is the POSIX specified behavior of ensuring all synchronous
1128 requests are written to stable storage and all devices are flushed to ensure
1129 data is not cached by device controllers (this is the default). \fBalways\fR
1130 causes every file system transaction to be written and flushed before its
1131 system call returns. This has a large performance penalty. \fBdisabled\fR
1132 disables synchronous requests. File system transactions are only committed to
1133 stable storage periodically. This option will give the highest performance.
1134 However, it is very dangerous as ZFS would be ignoring the synchronous
1135 transaction demands of applications such as databases or NFS. Administrators
1136 should only use this option when the risks are understood.
1142 \fB\fBversion\fR=\fB1\fR | \fB2\fR | \fBcurrent\fR\fR
1146 The on-disk version of this file system, which is independent of the pool version. This property can only be set to later supported versions. See the \fBzfs upgrade\fR command.
1153 \fB\fBvolsize\fR=\fIsize\fR\fR
1157 For volumes, specifies the logical size of the volume. By default, creating a volume establishes a reservation of equal size. For storage pools with a version number of 9 or higher, a \fBrefreservation\fR is set instead. Any changes to \fBvolsize\fR are reflected in an equivalent change to the reservation (or \fBrefreservation\fR). The \fBvolsize\fR can only be set to a multiple of \fBvolblocksize\fR, and cannot be zero.
1159 The reservation is kept equal to the volume's logical size to prevent unexpected behavior for consumers. Without the reservation, the volume could run out of space, resulting in undefined behavior or data corruption, depending on how the volume is used. These effects can also occur when the volume size is changed while it is in use (particularly when shrinking the size). Extreme care should be used when adjusting the volume size.
1161 Though not recommended, a "sparse volume" (also known as "thin provisioning") can be created by specifying the \fB-s\fR option to the \fBzfs create -V\fR command, or by changing the reservation after the volume has been created. A "sparse volume" is a volume where the reservation is less then the volume size. Consequently, writes to a sparse volume can fail with \fBENOSPC\fR when the pool is low on space. For a sparse volume, changes to \fBvolsize\fR are not reflected in the reservation.
1168 \fB\fBvscan\fR=\fBon\fR | \fBoff\fR\fR
1172 Controls whether regular files should be scanned for viruses when a file is opened and closed. In addition to enabling this property, the virus scan service must also be enabled for virus scanning to occur. The default value is \fBoff\fR.
1179 \fB\fBxattr\fR=\fBon\fR | \fBoff\fR\fR
1183 Controls whether extended attributes are enabled for this file system. The default value is \fBon\fR.
1190 \fB\fBzoned\fR=\fBon\fR | \fBoff\fR\fR
1194 Controls whether the dataset is managed from a non-global zone. Zones are a Solaris feature and are not relevant on Linux. The default value is \fBoff\fR.
1199 The following three properties cannot be changed after the file system is created, and therefore, should be set when the file system is created. If the properties are not set with the \fBzfs create\fR or \fBzpool create\fR commands, these properties are inherited from the parent dataset. If the parent dataset lacks these properties due to having been created prior to these features being supported, the new file system will have the default values for these properties.
1204 \fB\fBcasesensitivity\fR=\fBsensitive\fR | \fBinsensitive\fR | \fBmixed\fR\fR
1208 Indicates whether the file name matching algorithm used by the file system should be case-sensitive, case-insensitive, or allow a combination of both styles of matching. The default value for the \fBcasesensitivity\fR property is \fBsensitive\fR. Traditionally, UNIX and POSIX file systems have case-sensitive file names.
1210 The \fBmixed\fR value for the \fBcasesensitivity\fR property indicates that the file system can support requests for both case-sensitive and case-insensitive matching behavior. Currently, case-insensitive matching behavior on a file system that supports mixed behavior is limited to the Solaris CIFS server product. For more information about the \fBmixed\fR value behavior, see the \fISolaris ZFS Administration Guide\fR.
1217 \fB\fBnormalization\fR = \fBnone\fR | \fBformC\fR | \fBformD\fR | \fBformKC\fR | \fBformKD\fR\fR
1221 Indicates whether the file system should perform a \fBunicode\fR normalization of file names whenever two file names are compared, and which normalization algorithm should be used. File names are always stored unmodified, names are normalized as part of any comparison process. If this property is set to a legal value other than \fBnone\fR, and the \fButf8only\fR property was left unspecified, the \fButf8only\fR property is automatically set to \fBon\fR. The default value of the \fBnormalization\fR property is \fBnone\fR. This property cannot be changed after the file system is created.
1228 \fB\fButf8only\fR=\fBon\fR | \fBoff\fR\fR
1232 Indicates whether the file system should reject file names that include characters that are not present in the \fBUTF-8\fR character code set. If this property is explicitly set to \fBoff\fR, the normalization property must either not be explicitly set or be set to \fBnone\fR. The default value for the \fButf8only\fR property is \fBoff\fR. This property cannot be changed after the file system is created.
1237 The \fBcasesensitivity\fR, \fBnormalization\fR, and \fButf8only\fR properties are also new permissions that can be assigned to non-privileged users by using the \fBZFS\fR delegated administration feature.
1238 .SS "Temporary Mount Point Properties"
1241 When a file system is mounted, either through \fBmount\fR(8) for legacy mounts or the \fBzfs mount\fR command for normal file systems, its mount options are set according to its properties. The correlation between properties and mount options is as follows:
1245 PROPERTY MOUNT OPTION
1246 devices devices/nodevices
1249 setuid setuid/nosetuid
1257 In addition, these options can be set on a per-mount basis using the \fB-o\fR option, without affecting the property that is stored on disk. The values specified on the command line override the values stored in the dataset. The \fB-nosuid\fR option is an alias for \fBnodevices,nosetuid\fR. These properties are reported as "temporary" by the \fBzfs get\fR command. If the properties are changed while the dataset is mounted, the new setting overrides any temporary settings.
1258 .SS "User Properties"
1261 In addition to the standard native properties, \fBZFS\fR supports arbitrary user properties. User properties have no effect on \fBZFS\fR behavior, but applications or administrators can use them to annotate datasets (file systems, volumes, and snapshots).
1264 User property names must contain a colon (\fB:\fR) character to distinguish them from native properties. They may contain lowercase letters, numbers, and the following punctuation characters: colon (\fB:\fR), dash (\fB-\fR), period (\fB\&.\fR), and underscore (\fB_\fR). The expected convention is that the property name is divided into two portions such as \fImodule\fR\fB:\fR\fIproperty\fR, but this namespace is not enforced by \fBZFS\fR. User property names can be at most 256 characters, and cannot begin with a dash (\fB-\fR).
1267 When making programmatic use of user properties, it is strongly suggested to use a reversed \fBDNS\fR domain name for the \fImodule\fR component of property names to reduce the chance that two independently-developed packages use the same property name for different purposes. For example, property names beginning with \fBcom.sun\fR. are reserved for use by Oracle Corporation (which acquired Sun Microsystems).
1270 The values of user properties are arbitrary strings, are always inherited, and are never validated. All of the commands that operate on properties (\fBzfs list\fR, \fBzfs get\fR, \fBzfs set\fR, and so forth) can be used to manipulate both native properties and user properties. Use the \fBzfs inherit\fR command to clear a user property . If the property is not defined in any parent dataset, it is removed entirely. Property values are limited to 1024 characters.
1271 .SS "ZFS Volumes as Swap"
1274 \fBZFS\fR volumes may be used as Linux swap devices. After creating the volume
1275 with the \fBzfs create\fR command set up and enable the swap area using the
1276 \fBmkswap\fR(8) and \fBswapon\fR(8) commands. Do not swap to a file on a
1277 \fBZFS\fR file system. A \fBZFS\fR swap file configuration is not supported.
1281 All subcommands that modify state are logged persistently to the pool in their original form.
1290 Displays a help message.
1297 \fB\fBzfs create\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem\fR\fR
1301 Creates a new \fBZFS\fR file system. The file system is automatically mounted according to the \fBmountpoint\fR property inherited from the parent.
1310 Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the \fBmountpoint\fR property inherited from their parent. Any property specified on the command line using the \fB-o\fR option is ignored. If the target filesystem already exists, the operation completes successfully.
1317 \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1321 Sets the specified property as if the command \fBzfs set\fR \fIproperty\fR=\fIvalue\fR was invoked at the same time the dataset was created. Any editable \fBZFS\fR property can also be set at creation time. Multiple \fB-o\fR options can be specified. An error results if the same property is specified in multiple \fB-o\fR options.
1330 \fB\fBzfs create\fR [\fB-ps\fR] [\fB-b\fR \fIblocksize\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fB-V\fR \fIsize\fR \fIvolume\fR\fR
1334 Creates a volume of the given size. The volume is exported as a block device in \fB/dev/zvol/\fR\fIpath\fR, where \fIpath\fR is the name of the volume in the \fBZFS\fR namespace. The size represents the logical size as exported by the device. By default, a reservation of equal size is created.
1336 \fIsize\fR is automatically rounded up to the nearest 128 Kbytes to ensure that the volume has an integral number of blocks regardless of \fIblocksize\fR.
1345 Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the \fBmountpoint\fR property inherited from their parent. Any property specified on the command line using the \fB-o\fR option is ignored. If the target filesystem already exists, the operation completes successfully.
1356 Creates a sparse volume with no reservation. See \fBvolsize\fR in the Native Properties section for more information about sparse volumes.
1363 \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1367 Sets the specified property as if the \fBzfs set\fR \fIproperty\fR=\fIvalue\fR command was invoked at the same time the dataset was created. Any editable \fBZFS\fR property can also be set at creation time. Multiple \fB-o\fR options can be specified. An error results if the same property is specified in multiple \fB-o\fR options.
1374 \fB\fB-b\fR \fIblocksize\fR\fR
1378 Equivalent to \fB-o\fR \fBvolblocksize\fR=\fIblocksize\fR. If this option is specified in conjunction with \fB-o\fR \fBvolblocksize\fR, the resulting behavior is undefined.
1387 \fBzfs destroy\fR [\fB-fnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR
1391 Destroys the given dataset. By default, the command unshares any file systems that are currently shared, unmounts any file systems that are currently mounted, and refuses to destroy a dataset that has active dependents (children or clones).
1400 Recursively destroy all children.
1411 Recursively destroy all dependents, including cloned file systems outside the target hierarchy.
1422 Force an unmount of any file systems using the \fBunmount -f\fR command. This option has no effect on non-file systems or unmounted file systems.
1432 Do a dry-run ("No-op") deletion. No data will be deleted. This is
1433 useful in conjunction with the \fB-v\fR or \fB-p\fR flags to determine what
1434 data would be deleted.
1444 Print machine-parsable verbose information about the deleted data.
1454 Print verbose information about the deleted data.
1458 Extreme care should be taken when applying either the \fB-r\fR or the \fB-R\fR options, as they can destroy large portions of a pool and cause unexpected behavior for mounted file systems in use.
1465 \fBzfs destroy\fR [\fB-dnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR@\fIsnap\fR[%\fIsnap\fR][,...]
1469 The given snapshots are destroyed immediately if and only if the \fBzfs destroy\fR command without the \fB-d\fR option would have destroyed it. Such immediate destruction would occur, for example, if the snapshot had no clones and the user-initiated reference count were zero.
1471 If a snapshot does not qualify for immediate destruction, it is marked for deferred destruction. In this state, it exists as a usable, visible snapshot until both of the preconditions listed above are met, at which point it is destroyed.
1473 An inclusive range of snapshots may be specified by separating the
1474 first and last snapshots with a percent sign.
1475 The first and/or last snapshots may be left blank, in which case the
1476 filesystem's oldest or newest snapshot will be implied.
1479 (or ranges of snapshots) of the same filesystem or volume may be specified
1480 in a comma-separated list of snapshots.
1481 Only the snapshot's short name (the
1482 part after the \fB@\fR) should be specified when using a range or
1483 comma-separated list to identify multiple snapshots.
1492 Defer snapshot deletion.
1503 Destroy (or mark for deferred destruction) all snapshots with this name in descendent file systems.
1514 Recursively destroy all dependents.
1524 Do a dry-run ("No-op") deletion. No data will be deleted. This is
1525 useful in conjunction with the \fB-v\fR or \fB-p\fR flags to determine what
1526 data would be deleted.
1536 Print machine-parsable verbose information about the deleted data.
1546 Print verbose information about the deleted data.
1550 Extreme care should be taken when applying either the \fB-r\fR or the \fB-f\fR
1551 options, as they can destroy large portions of a pool and cause unexpected
1552 behavior for mounted file systems in use.
1561 \fB\fBzfs snapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem@snapname\fR|\fIvolume@snapname\fR\fR
1565 Creates a snapshot with the given name. All previous modifications by successful system calls to the file system are part of the snapshot. See the "Snapshots" section for details.
1574 Recursively create snapshots of all descendent datasets. Snapshots are taken atomically, so that all recursive snapshots correspond to the same moment in time.
1581 \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1585 Sets the specified property; see \fBzfs create\fR for details.
1594 \fB\fBzfs rollback\fR [\fB-rRf\fR] \fIsnapshot\fR\fR
1598 Roll back the given dataset to a previous snapshot. When a dataset is rolled back, all data that has changed since the snapshot is discarded, and the dataset reverts to the state at the time of the snapshot. By default, the command refuses to roll back to a snapshot other than the most recent one. In order to do so, all intermediate snapshots must be destroyed by specifying the \fB-r\fR option.
1600 The \fB-rR\fR options do not recursively destroy the child snapshots of a recursive snapshot. Only the top-level recursive snapshot is destroyed by either of these options. To completely roll back a recursive snapshot, you must rollback the individual child snapshots.
1609 Recursively destroy any snapshots more recent than the one specified.
1620 Recursively destroy any more recent snapshots, as well as any clones of those snapshots.
1631 Used with the \fB-R\fR option to force an unmount of any clone file systems that are to be destroyed.
1640 \fB\fBzfs clone\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR\fR
1644 Creates a clone of the given snapshot. See the "Clones" section for details. The target dataset can be located anywhere in the \fBZFS\fR hierarchy, and is created as the same type as the original.
1653 Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the \fBmountpoint\fR property inherited from their parent. If the target filesystem or volume already exists, the operation completes successfully.
1660 \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1664 Sets the specified property; see \fBzfs create\fR for details.
1673 \fB\fBzfs promote\fR \fIclone-filesystem\fR\fR
1677 Promotes a clone file system to no longer be dependent on its "origin" snapshot. This makes it possible to destroy the file system that the clone was created from. The clone parent-child dependency relationship is reversed, so that the origin file system becomes a clone of the specified file system.
1679 The snapshot that was cloned, and any snapshots previous to this snapshot, are now owned by the promoted clone. The space they use moves from the origin file system to the promoted clone, so enough space must be available to accommodate these snapshots. No new space is consumed by this operation, but the space accounting is adjusted. The promoted clone must not have any conflicting snapshot names of its own. The \fBrename\fR subcommand can be used to rename any conflicting snapshots.
1686 \fB\fBzfs rename\fR [\fB-f\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
1690 \fB\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
1694 \fB\fBzfs rename\fR [\fB-fp\fR] \fIfilesystem\fR|\fIvolume\fR \fIfilesystem\fR|\fIvolume\fR\fR
1698 Renames the given dataset. The new target can be located anywhere in the \fBZFS\fR hierarchy, with the exception of snapshots. Snapshots can only be renamed within the parent file system or volume. When renaming a snapshot, the parent file system of the snapshot does not need to be specified as part of the second argument. Renamed file systems can inherit new mount points, in which case they are unmounted and remounted at the new mount point.
1707 Creates all the nonexistent parent datasets. Datasets created in this manner are automatically mounted according to the \fBmountpoint\fR property inherited from their parent.
1717 Force unmount any filesystems that need to be unmounted in the process.
1726 \fB\fBzfs rename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR\fR
1730 Recursively rename the snapshots of all descendent datasets. Snapshots are the only dataset that can be renamed recursively.
1737 \fB\fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-H\fR] [\fB-o\fR \fIproperty\fR[,\fI\&...\fR]] [ \fB-t\fR \fItype\fR[,\fI\&...\fR]] [ \fB-s\fR \fIproperty\fR ] ... [ \fB-S\fR \fIproperty\fR ] ... [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR|\fIsnap\fR] ...\fR
1741 Lists the property information for the given datasets in tabular form. If specified, you can list property information by the absolute pathname or the relative pathname. By default, all file systems and volumes are displayed. Snapshots are displayed if the \fBlistsnaps\fR property is \fBon\fR (the default is \fBoff\fR) . The following fields are displayed, \fBname,used,available,referenced,mountpoint\fR.
1750 Used for scripting mode. Do not print headers and separate fields by a single tab instead of arbitrary white space.
1761 Recursively display any children of the dataset on the command line.
1768 \fB\fB-d\fR \fIdepth\fR\fR
1772 Recursively display any children of the dataset, limiting the recursion to \fIdepth\fR. A depth of \fB1\fR will display only the dataset and its direct children.
1779 \fB\fB-o\fR \fIproperty\fR\fR
1783 A comma-separated list of properties to display. The property must be:
1788 One of the properties described in the "Native Properties" section
1800 The value \fBname\fR to display the dataset name
1806 The value \fBspace\fR to display space usage properties on file systems and volumes. This is a shortcut for specifying \fB-o name,avail,used,usedsnap,usedds,usedrefreserv,usedchild\fR \fB-t filesystem,volume\fR syntax.
1814 \fB\fB-s\fR \fIproperty\fR\fR
1818 A property for sorting the output by column in ascending order based on the value of the property. The property must be one of the properties described in the "Properties" section, or the special value \fBname\fR to sort by the dataset name. Multiple properties can be specified at one time using multiple \fB-s\fR property options. Multiple \fB-s\fR options are evaluated from left to right in decreasing order of importance.
1820 The following is a list of sorting criteria:
1825 Numeric types sort in numeric order.
1831 String types sort in alphabetical order.
1837 Types inappropriate for a row sort that row to the literal bottom, regardless of the specified ordering.
1843 If no sorting options are specified the existing behavior of \fBzfs list\fR is preserved.
1851 \fB\fB-S\fR \fIproperty\fR\fR
1855 Same as the \fB-s\fR option, but sorts by property in descending order.
1862 \fB\fB-t\fR \fItype\fR\fR
1866 A comma-separated list of types to display, where \fItype\fR is one of \fBfilesystem\fR, \fBsnapshot\fR , \fBvolume\fR, or \fBall\fR. For example, specifying \fB-t snapshot\fR displays only snapshots.
1875 \fB\fBzfs set\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
1879 Sets the property to the given value for each dataset. Only some properties can be edited. See the "Properties" section for more information on what properties can be set and acceptable values. Numeric values can be specified as exact values, or in a human-readable form with a suffix of \fBB\fR, \fBK\fR, \fBM\fR, \fBG\fR, \fBT\fR, \fBP\fR, \fBE\fR, \fBZ\fR (for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes, or zettabytes, respectively). User properties can be set on snapshots. For more information, see the "User Properties" section.
1886 \fB\fBzfs get\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-Hp\fR] [\fB-o\fR \fIfield\fR[,...] [\fB-t\fR \fItype\fR[,...]] [\fB-s\fR \fIsource\fR[,...] "\fIall\fR" | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
1890 Displays properties for the given datasets. If no datasets are specified, then the command displays properties for all datasets on the system. For each property, the following columns are displayed:
1895 property Property name
1896 value Property value
1897 source Property source. Can either be local, default,
1898 temporary, inherited, or none (-).
1903 All columns are displayed by default, though this can be controlled by using the \fB-o\fR option. This command takes a comma-separated list of properties as described in the "Native Properties" and "User Properties" sections.
1905 The special value \fBall\fR can be used to display all properties that apply to the given dataset's type (filesystem, volume, or snapshot).
1914 Recursively display properties for any children.
1921 \fB\fB-d\fR \fIdepth\fR\fR
1925 Recursively display any children of the dataset, limiting the recursion to \fIdepth\fR. A depth of \fB1\fR will display only the dataset and its direct children.
1936 Display output in a form more easily parsed by scripts. Any headers are omitted, and fields are explicitly separated by a single tab instead of an arbitrary amount of space.
1943 \fB\fB-o\fR \fIfield\fR\fR
1947 A comma-separated list of columns to display. \fBname,property,value,source\fR is the default value.
1954 \fB\fB-s\fR \fIsource\fR\fR
1958 A comma-separated list of sources to display. Those properties coming from a source other than those in this list are ignored. Each source must be one of the following: \fBlocal,default,inherited,temporary,none\fR. The default value is all sources.
1969 Display numbers in parseable (exact) values.
1978 \fB\fBzfs inherit\fR [\fB-r\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
1982 Clears the specified property, causing it to be inherited from an ancestor. If no ancestor has the property set, then the default value is used. See the "Properties" section for a listing of default values, and details on which properties can be inherited.
1991 Recursively inherit the given property for all children.
2000 \fB\fBzfs upgrade\fR [\fB-v\fR]\fR
2004 Displays a list of file systems that are not the most recent version.
2011 \fB\fBzfs upgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] [\fB-a\fR | \fIfilesystem\fR]\fR
2015 Upgrades file systems to a new on-disk version. Once this is done, the file systems will no longer be accessible on systems running older versions of the software. \fBzfs send\fR streams generated from new snapshots of these file systems cannot be accessed on systems running older versions of the software.
2017 In general, the file system version is independent of the pool version. See \fBzpool\fR(8) for information on the \fBzpool upgrade\fR command.
2019 In some cases, the file system version and the pool version are interrelated and the pool version must be upgraded before the file system version can be upgraded.
2028 Upgrade all file systems on all imported pools.
2035 \fB\fIfilesystem\fR\fR
2039 Upgrade the specified file system.
2050 Upgrade the specified file system and all descendent file systems
2057 \fB\fB-V\fR \fIversion\fR\fR
2061 Upgrade to the specified \fIversion\fR. If the \fB-V\fR flag is not specified, this command upgrades to the most recent version. This option can only be used to increase the version number, and only up to the most recent version supported by this software.
2070 \fBzfs\fR \fBuserspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,...]]
2071 [\fB-s\fR \fIfield\fR] ...
2072 [\fB-S\fR \fIfield\fR] ...
2073 [\fB-t\fR \fItype\fR[,...]] \fIfilesystem\fR|\fIsnapshot\fR
2077 Displays space consumed by, and quotas on, each user in the specified
2078 filesystem or snapshot. This corresponds to the \fBuserused@\fR\fIuser\fR and
2079 \fBuserquota@\fR\fIuser\fR properties.
2088 Print numeric ID instead of user/group name.
2099 Do not print headers, use tab-delimited output.
2110 Use exact (parsable) numeric output.
2117 \fB\fB-o\fR \fIfield\fR[,...]\fR
2121 Display only the specified fields from the following
2122 set: \fBtype, name, used, quota\fR. The default is to display all fields.
2129 \fB\fB-s\fR \fIfield\fR\fR
2133 Sort output by this field. The \fIs\fR and \fIS\fR flags may be specified
2134 multiple times to sort first by one field, then by another. The default is
2135 \fB-s type\fR \fB-s name\fR.
2142 \fB\fB-S\fR \fIfield\fR\fR
2146 Sort by this field in reverse order. See \fB-s\fR.
2153 \fB\fB-t\fR \fItype\fR[,...]\fR
2157 Print only the specified types from the following
2158 set: \fBall, posixuser, smbuser, posixgroup, smbgroup\fR. The default
2159 is \fB-t posixuser,smbuser\fR. The default can be changed to include group
2171 Translate SID to POSIX ID. The POSIX ID may be ephemeral if no mapping exists.
2172 Normal POSIX interfaces (for example, \fBstat\fR(2), \fBls\fR \fB-l\fR) perform
2173 this translation, so the \fB-i\fR option allows the output from \fBzfs
2174 userspace\fR to be compared directly with those utilities. However, \fB-i\fR
2175 may lead to confusion if some files were created by an SMB user before a
2176 SMB-to-POSIX name mapping was established. In such a case, some files will be owned
2177 by the SMB entity and some by the POSIX entity. However, the \fB-i\fR option
2178 will report that the POSIX entity has the total usage and quota for both.
2187 \fBzfs\fR \fBgroupspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,...]]
2188 [\fB-s\fR \fIfield\fR] ...
2189 [\fB-S\fR \fIfield\fR] ...
2190 [\fB-t\fR \fItype\fR[,...]] \fIfilesystem\fR|\fIsnapshot\fR
2194 Displays space consumed by, and quotas on, each group in the specified
2195 filesystem or snapshot. This subcommand is identical to \fBzfs userspace\fR,
2196 except that the default types to display are \fB-t posixgroup,smbgroup\fR.
2203 \fB\fBzfs mount\fR\fR
2207 Displays all \fBZFS\fR file systems currently mounted.
2214 \fB\fBzfs mount\fR [\fB-vO\fR] [\fB-o\fR \fIoptions\fR] \fB-a\fR | \fIfilesystem\fR\fR
2218 Mounts \fBZFS\fR file systems. Invoked automatically as part of the boot process.
2223 \fB\fB-o\fR \fIoptions\fR\fR
2227 An optional, comma-separated list of mount options to use temporarily for the
2228 duration of the mount. See the "Temporary Mount Point Properties" section for
2240 Perform an overlay mount. See \fBmount\fR(8) for more information.
2251 Report mount progress.
2262 Mount all available \fBZFS\fR file systems. Invoked automatically as part of
2270 \fB\fIfilesystem\fR\fR
2274 Mount the specified filesystem.
2283 \fB\fBzfs unmount\fR [\fB-f\fR] \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR
2287 Unmounts currently mounted \fBZFS\fR file systems. Invoked automatically as part of the shutdown process.
2296 Forcefully unmount the file system, even if it is currently in use.
2307 Unmount all available \fBZFS\fR file systems. Invoked automatically as part of the boot process.
2314 \fB\fIfilesystem\fR|\fImountpoint\fR\fR
2318 Unmount the specified filesystem. The command can also be given a path to a \fBZFS\fR file system mount point on the system.
2327 \fB\fBzfs share\fR \fB-a\fR | \fIfilesystem\fR\fR
2331 Shares available \fBZFS\fR file systems.
2340 Share all available \fBZFS\fR file systems. Invoked automatically as part of the boot process.
2347 \fB\fIfilesystem\fR\fR
2351 Share the specified filesystem according to the \fBsharenfs\fR and \fBsharesmb\fR properties. File systems are shared when the \fBsharenfs\fR or \fBsharesmb\fR property is set.
2360 \fB\fBzfs unshare\fR \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR
2364 Unshares currently shared \fBZFS\fR file systems. This is invoked automatically as part of the shutdown process.
2373 Unshare all available \fBZFS\fR file systems. Invoked automatically as part of the boot process.
2380 \fB\fIfilesystem\fR|\fImountpoint\fR\fR
2384 Unshare the specified filesystem. The command can also be given a path to a \fBZFS\fR file system shared on the system.
2393 \fBzfs send\fR [\fB-DnPpRv\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
2397 Creates a stream representation of the second \fIsnapshot\fR, which is written to standard output. The output can be redirected to a file or to a different system (for example, using \fBssh\fR(1). By default, a full stream is generated.
2402 \fB\fB-i\fR \fIsnapshot\fR\fR
2406 Generate an incremental stream from the first \fIsnapshot\fR to the second \fIsnapshot\fR. The incremental source (the first \fIsnapshot\fR) can be specified as the last component of the snapshot name (for example, the part after the \fB@\fR), and it is assumed to be from the same file system as the second \fIsnapshot\fR.
2408 If the destination is a clone, the source may be the origin snapshot, which must be fully specified (for example, \fBpool/fs@origin\fR, not just \fB@origin\fR).
2415 \fB\fB-I\fR \fIsnapshot\fR\fR
2419 Generate a stream package that sends all intermediary snapshots from the first snapshot to the second snapshot. For example, \fB-I @a fs@d\fR is similar to \fB-i @a fs@b; -i @b fs@c; -i @c fs@d\fR. The incremental source snapshot may be specified as with the \fB-i\fR option.
2430 Generate a replication stream package, which will replicate the specified filesystem, and all descendent file systems, up to the named snapshot. When received, all properties, snapshots, descendent file systems, and clones are preserved.
2432 If the \fB-i\fR or \fB-I\fR flags are used in conjunction with the \fB-R\fR flag, an incremental replication stream is generated. The current values of properties, and current snapshot and file system names are set when the stream is received. If the \fB-F\fR flag is specified when this stream is received, snapshots and file systems that do not exist on the sending side are destroyed.
2443 Generate a deduplicated stream. Blocks which would have been sent multiple times in the send stream will only be sent once. The receiving system must also support this feature to recieve a deduplicated stream. This flag can be used regardless of the dataset's dedup property, but performance will be much better if the filesystem uses a dedup-capable checksum (eg. sha256).
2454 Include the dataset's properties in the stream. This flag is implicit when -R is specified. The receiving system must also support this feature.
2464 Do a dry-run ("No-op") send. Do not generate any actual send data. This is
2465 useful in conjunction with the \fB-v\fR or \fB-P\fR flags to determine what
2476 Print machine-parsable verbose information about the stream package generated.
2487 Print verbose information about the stream package generated. This information
2488 includes a per-second report of how much data has been sent.
2491 The format of the stream is committed. You will be able to receive your streams on future versions of \fBZFS\fR.
2498 \fB\fBzfs receive\fR [\fB-vnFu\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
2502 \fB\fBzfs receive\fR [\fB-vnFu\fR] [\fB-d\fR|\fB-e\fR] \fIfilesystem\fR\fR
2506 Creates a snapshot whose contents are as specified in the stream provided on standard input. If a full stream is received, then a new file system is created as well. Streams are created using the \fBzfs send\fR subcommand, which by default creates a full stream. \fBzfs recv\fR can be used as an alias for \fBzfs receive\fR.
2508 If an incremental stream is received, then the destination file system must already exist, and its most recent snapshot must match the incremental stream's source. For \fBzvols\fR, the destination device link is destroyed and recreated, which means the \fBzvol\fR cannot be accessed during the \fBreceive\fR operation.
2510 When a snapshot replication package stream that is generated by using the \fBzfs send\fR \fB-R\fR command is received, any snapshots that do not exist on the sending location are destroyed by using the \fBzfs destroy\fR \fB-d\fR command.
2512 The name of the snapshot (and file system, if a full stream is received) that this subcommand creates depends on the argument type and the use of the \fB-d\fR or \fB-e\fR options.
2514 If the argument is a snapshot name, the specified \fIsnapshot\fR is created. If the argument is a file system or volume name, a snapshot with the same name as the sent snapshot is created within the specified \fIfilesystem\fR or \fIvolume\fR. If neither of the \fB-d\fR or \fB-e\fR options are specified, the provided target snapshot name is used exactly as provided.
2516 The \fB-d\fR and \fB-e\fR options cause the file system name of the target snapshot to be determined by appending a portion of the sent snapshot's name to the specified target \fIfilesystem\fR. If the \fB-d\fR option is specified, all but the first element of the sent snapshot's file system path (usually the pool name) is used and any required intermediate file systems within the specified one are created. If the \fB-e\fR option is specified, then only the last element of the sent snapshot's file system name (i.e. the name of the source file system itself) is used as the target file system name.
2525 Discard the first element of the sent snapshot's file system name, using the remaining elements to determine the name of the target file system for the new snapshot as described in the paragraph above.
2535 Discard all but the last element of the sent snapshot's file system name, using that element to determine the name of the target file system for the new snapshot as described in the paragraph above.
2546 File system that is associated with the received stream is not mounted.
2556 Print verbose information about the stream and the time required to perform the receive operation.
2567 Do not actually receive the stream. This can be useful in conjunction with the \fB-v\fR option to verify the name the receive operation would use.
2578 Force a rollback of the file system to the most recent snapshot before performing the receive operation. If receiving an incremental replication stream (for example, one generated by \fBzfs send -R -[iI]\fR), destroy snapshots and file systems that do not exist on the sending side.
2587 \fB\fBzfs allow\fR \fIfilesystem\fR | \fIvolume\fR\fR
2591 Displays permissions that have been delegated on the specified filesystem or volume. See the other forms of \fBzfs allow\fR for more information.
2598 \fB\fBzfs allow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR| \fIvolume\fR\fR
2602 \fB\fBzfs allow\fR [\fB-ld\fR] \fB-e\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR | \fIvolume\fR\fR
2606 Delegates \fBZFS\fR administration permission for the file systems to non-privileged users.
2611 \fB[\fB-ug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...]\fR
2615 Specifies to whom the permissions are delegated. Multiple entities can be specified as a comma-separated list. If neither of the \fB-ug\fR options are specified, then the argument is interpreted preferentially as the keyword "everyone", then as a user name, and lastly as a group name. To specify a user or group named "everyone", use the \fB-u\fR or \fB-g\fR options. To specify a group with the same name as a user, use the \fB-g\fR options.
2622 \fB[\fB-e\fR] \fIperm\fR|@\fIsetname\fR[,...]\fR
2626 Specifies that the permissions be delegated to "everyone." Multiple permissions may be specified as a comma-separated list. Permission names are the same as \fBZFS\fR subcommand and property names. See the property list below. Property set names, which begin with an at sign (\fB@\fR) , may be specified. See the \fB-s\fR form below for details.
2633 \fB[\fB-ld\fR] \fIfilesystem\fR|\fIvolume\fR\fR
2637 Specifies where the permissions are delegated. If neither of the \fB-ld\fR options are specified, or both are, then the permissions are allowed for the file system or volume, and all of its descendents. If only the \fB-l\fR option is used, then is allowed "locally" only for the specified file system. If only the \fB-d\fR option is used, then is allowed only for the descendent file systems.
2644 Permissions are generally the ability to use a \fBZFS\fR subcommand or change a \fBZFS\fR property. The following permissions are available:
2649 allow subcommand Must also have the permission that is being
2651 clone subcommand Must also have the 'create' ability and 'mount'
2652 ability in the origin file system
2653 create subcommand Must also have the 'mount' ability
2654 destroy subcommand Must also have the 'mount' ability
2655 diff subcommand Allows lookup of paths within a dataset
2656 given an object number, and the ability to
2657 create snapshots necessary to 'zfs diff'.
2658 mount subcommand Allows mount/umount of ZFS datasets
2659 promote subcommand Must also have the 'mount'
2660 and 'promote' ability in the origin file system
2661 receive subcommand Must also have the 'mount' and 'create' ability
2662 rename subcommand Must also have the 'mount' and 'create'
2663 ability in the new parent
2664 rollback subcommand Must also have the 'mount' ability
2666 share subcommand Allows sharing file systems over NFS or SMB
2668 snapshot subcommand Must also have the 'mount' ability
2669 groupquota other Allows accessing any groupquota@... property
2670 groupused other Allows reading any groupused@... property
2671 userprop other Allows changing any user property
2672 userquota other Allows accessing any userquota@... property
2673 userused other Allows reading any userused@... property
2679 casesensitivity property
2681 compression property
2690 normalization property
2691 primarycache property
2696 refreservation property
2697 reservation property
2698 secondarycache property
2706 volblocksize property
2719 \fB\fBzfs allow\fR \fB-c\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR\fR
2723 Sets "create time" permissions. These permissions are granted (locally) to the creator of any newly-created descendent file system.
2730 \fB\fBzfs allow\fR \fB-s\fR @\fIsetname\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR\fR
2734 Defines or adds permissions to a permission set. The set can be used by other \fBzfs allow\fR commands for the specified file system and its descendents. Sets are evaluated dynamically, so changes to a set are immediately reflected. Permission sets follow the same naming restrictions as ZFS file systems, but the name must begin with an "at sign" (\fB@\fR), and can be no more than 64 characters long.
2741 \fB\fBzfs unallow\fR [\fB-rldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] [\fIperm\fR|@\fIsetname\fR[, ...]] \fIfilesystem\fR|\fIvolume\fR\fR
2745 \fB\fBzfs unallow\fR [\fB-rld\fR] \fB-e\fR [\fIperm\fR|@\fIsetname\fR [,...]] \fIfilesystem\fR|\fIvolume\fR\fR
2749 \fB\fBzfs unallow\fR [\fB-r\fR] \fB-c\fR [\fIperm\fR|@\fIsetname\fR[,...]]\fR
2753 \fB\fIfilesystem\fR|\fIvolume\fR\fR
2757 Removes permissions that were granted with the \fBzfs allow\fR command. No permissions are explicitly denied, so other permissions granted are still in effect. For example, if the permission is granted by an ancestor. If no permissions are specified, then all permissions for the specified \fIuser\fR, \fIgroup\fR, or \fIeveryone\fR are removed. Specifying "everyone" (or using the \fB-e\fR option) only removes the permissions that were granted to "everyone", not all permissions for every user and group. See the \fBzfs allow\fR command for a description of the \fB-ldugec\fR options.
2766 Recursively remove the permissions from this file system and all descendents.
2775 \fB\fBzfs unallow\fR [\fB-r\fR] \fB-s\fR @\fIsetname\fR [\fIperm\fR|@\fIsetname\fR[,...]]\fR
2779 \fB\fIfilesystem\fR|\fIvolume\fR\fR
2783 Removes permissions from a permission set. If no permissions are specified, then all permissions are removed, thus removing the set entirely.
2790 \fB\fBzfs hold\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR
2794 Adds a single reference, named with the \fItag\fR argument, to the specified snapshot or snapshots. Each snapshot has its own tag namespace, and tags must be unique within that space.
2796 If a hold exists on a snapshot, attempts to destroy that snapshot by using the \fBzfs destroy\fR command return \fBEBUSY\fR.
2805 Specifies that a hold with the given tag is applied recursively to the snapshots of all descendent file systems.
2814 \fB\fBzfs holds\fR [\fB-r\fR] \fIsnapshot\fR...\fR
2818 Lists all existing user references for the given snapshot or snapshots.
2827 Lists the holds that are set on the named descendent snapshots, in addition to listing the holds on the named snapshot.
2836 \fB\fBzfs release\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR
2840 Removes a single reference, named with the \fItag\fR argument, from the specified snapshot or snapshots. The tag must already exist for each snapshot.
2842 If a hold exists on a snapshot, attempts to destroy that snapshot by using the \fBzfs destroy\fR command return \fBEBUSY\fR.
2851 Recursively releases a hold with the given tag on the snapshots of all descendent file systems.
2860 \fB\fBzfs diff\fR [\fB-FHt\fR] \fIsnapshot\fR \fIsnapshot|filesystem\fR
2864 Display the difference between a snapshot of a given filesystem and another
2865 snapshot of that filesystem from a later time or the current contents of the
2866 filesystem. The first column is a character indicating the type of change,
2867 the other columns indicate pathname, new pathname (in case of rename), change
2868 in link count, and optionally file type and/or change time.
2870 The types of change are:
2873 - The path has been removed
2874 + The path has been created
2875 M The path has been modified
2876 R The path has been renamed
2886 Display an indication of the type of file, in a manner similar to the \fB-F\fR
2887 option of \fBls\fR(1).
2909 Give more parseable tab-separated output, without header lines and without arrows.
2918 Display the path's inode change time as the first column of output.
2923 \fBExample 1 \fRCreating a ZFS File System Hierarchy
2926 The following commands create a file system named \fBpool/home\fR and a file system named \fBpool/home/bob\fR. The mount point \fB/export/home\fR is set for the parent file system, and is automatically inherited by the child file system.
2931 # \fBzfs create pool/home\fR
2932 # \fBzfs set mountpoint=/export/home pool/home\fR
2933 # \fBzfs create pool/home/bob\fR
2939 \fBExample 2 \fRCreating a ZFS Snapshot
2942 The following command creates a snapshot named \fByesterday\fR. This snapshot is mounted on demand in the \fB\&.zfs/snapshot\fR directory at the root of the \fBpool/home/bob\fR file system.
2947 # \fBzfs snapshot pool/home/bob@yesterday\fR
2953 \fBExample 3 \fRCreating and Destroying Multiple Snapshots
2956 The following command creates snapshots named \fByesterday\fR of \fBpool/home\fR and all of its descendent file systems. Each snapshot is mounted on demand in the \fB\&.zfs/snapshot\fR directory at the root of its file system. The second command destroys the newly created snapshots.
2961 # \fBzfs snapshot -r pool/home@yesterday\fR
2962 # \fBzfs destroy -r pool/home@yesterday\fR
2968 \fBExample 4 \fRDisabling and Enabling File System Compression
2971 The following command disables the \fBcompression\fR property for all file systems under \fBpool/home\fR. The next command explicitly enables \fBcompression\fR for \fBpool/home/anne\fR.
2976 # \fBzfs set compression=off pool/home\fR
2977 # \fBzfs set compression=on pool/home/anne\fR
2983 \fBExample 5 \fRListing ZFS Datasets
2986 The following command lists all active file systems and volumes in the system. Snapshots are displayed if the \fBlistsnaps\fR property is \fBon\fR. The default is \fBoff\fR. See \fBzpool\fR(8) for more information on pool properties.
2992 NAME USED AVAIL REFER MOUNTPOINT
2993 pool 450K 457G 18K /pool
2994 pool/home 315K 457G 21K /export/home
2995 pool/home/anne 18K 457G 18K /export/home/anne
2996 pool/home/bob 276K 457G 276K /export/home/bob
3002 \fBExample 6 \fRSetting a Quota on a ZFS File System
3005 The following command sets a quota of 50 Gbytes for \fBpool/home/bob\fR.
3010 # \fBzfs set quota=50G pool/home/bob\fR
3016 \fBExample 7 \fRListing ZFS Properties
3019 The following command lists all properties for \fBpool/home/bob\fR.
3024 # \fBzfs get all pool/home/bob\fR
3025 NAME PROPERTY VALUE SOURCE
3026 pool/home/bob type filesystem -
3027 pool/home/bob creation Tue Jul 21 15:53 2009 -
3028 pool/home/bob used 21K -
3029 pool/home/bob available 20.0G -
3030 pool/home/bob referenced 21K -
3031 pool/home/bob compressratio 1.00x -
3032 pool/home/bob mounted yes -
3033 pool/home/bob quota 20G local
3034 pool/home/bob reservation none default
3035 pool/home/bob recordsize 128K default
3036 pool/home/bob mountpoint /pool/home/bob default
3037 pool/home/bob sharenfs off default
3038 pool/home/bob checksum on default
3039 pool/home/bob compression on local
3040 pool/home/bob atime on default
3041 pool/home/bob devices on default
3042 pool/home/bob exec on default
3043 pool/home/bob setuid on default
3044 pool/home/bob readonly off default
3045 pool/home/bob zoned off default
3046 pool/home/bob snapdir hidden default
3047 pool/home/bob aclmode groupmask default
3048 pool/home/bob aclinherit restricted default
3049 pool/home/bob canmount on default
3050 pool/home/bob shareiscsi off default
3051 pool/home/bob xattr on default
3052 pool/home/bob copies 1 default
3053 pool/home/bob version 4 -
3054 pool/home/bob utf8only off -
3055 pool/home/bob normalization none -
3056 pool/home/bob casesensitivity sensitive -
3057 pool/home/bob vscan off default
3058 pool/home/bob nbmand off default
3059 pool/home/bob sharesmb off default
3060 pool/home/bob refquota none default
3061 pool/home/bob refreservation none default
3062 pool/home/bob primarycache all default
3063 pool/home/bob secondarycache all default
3064 pool/home/bob usedbysnapshots 0 -
3065 pool/home/bob usedbydataset 21K -
3066 pool/home/bob usedbychildren 0 -
3067 pool/home/bob usedbyrefreservation 0 -
3068 pool/home/bob logbias latency default
3069 pool/home/bob dedup off default
3070 pool/home/bob mlslabel none default
3077 The following command gets a single property value.
3082 # \fBzfs get -H -o value compression pool/home/bob\fR
3090 The following command lists all properties with local settings for \fBpool/home/bob\fR.
3095 # \fBzfs get -r -s local -o name,property,value all pool/home/bob\fR
3097 pool/home/bob quota 20G
3098 pool/home/bob compression on
3104 \fBExample 8 \fRRolling Back a ZFS File System
3107 The following command reverts the contents of \fBpool/home/anne\fR to the snapshot named \fByesterday\fR, deleting all intermediate snapshots.
3112 # \fBzfs rollback -r pool/home/anne@yesterday\fR
3118 \fBExample 9 \fRCreating a ZFS Clone
3121 The following command creates a writable file system whose initial contents are the same as \fBpool/home/bob@yesterday\fR.
3126 # \fBzfs clone pool/home/bob@yesterday pool/clone\fR
3132 \fBExample 10 \fRPromoting a ZFS Clone
3135 The following commands illustrate how to test out changes to a file system, and then replace the original file system with the changed one, using clones, clone promotion, and renaming:
3140 # \fBzfs create pool/project/production\fR
3141 populate /pool/project/production with data
3142 # \fBzfs snapshot pool/project/production@today\fR
3143 # \fBzfs clone pool/project/production@today pool/project/beta\fR
3144 make changes to /pool/project/beta and test them
3145 # \fBzfs promote pool/project/beta\fR
3146 # \fBzfs rename pool/project/production pool/project/legacy\fR
3147 # \fBzfs rename pool/project/beta pool/project/production\fR
3148 once the legacy version is no longer needed, it can be destroyed
3149 # \fBzfs destroy pool/project/legacy\fR
3155 \fBExample 11 \fRInheriting ZFS Properties
3158 The following command causes \fBpool/home/bob\fR and \fBpool/home/anne\fR to inherit the \fBchecksum\fR property from their parent.
3163 # \fBzfs inherit checksum pool/home/bob pool/home/anne\fR
3169 \fBExample 12 \fRRemotely Replicating ZFS Data
3172 The following commands send a full stream and then an incremental stream to a remote machine, restoring them into \fBpoolB/received/fs@a\fRand \fBpoolB/received/fs@b\fR, respectively. \fBpoolB\fR must contain the file system \fBpoolB/received\fR, and must not initially contain \fBpoolB/received/fs\fR.
3177 # \fBzfs send pool/fs@a | \e\fR
3178 \fBssh host zfs receive poolB/received/fs@a\fR
3179 # \fBzfs send -i a pool/fs@b | ssh host \e\fR
3180 \fBzfs receive poolB/received/fs\fR
3186 \fBExample 13 \fRUsing the \fBzfs receive\fR \fB-d\fR Option
3189 The following command sends a full stream of \fBpoolA/fsA/fsB@snap\fR to a remote machine, receiving it into \fBpoolB/received/fsA/fsB@snap\fR. The \fBfsA/fsB@snap\fR portion of the received snapshot's name is determined from the name of the sent snapshot. \fBpoolB\fR must contain the file system \fBpoolB/received\fR. If \fBpoolB/received/fsA\fR does not exist, it is created as an empty file system.
3194 # \fBzfs send poolA/fsA/fsB@snap | \e
3195 ssh host zfs receive -d poolB/received\fR
3201 \fBExample 14 \fRSetting User Properties
3204 The following example sets the user-defined \fBcom.example:department\fR property for a dataset.
3209 # \fBzfs set com.example:department=12345 tank/accounting\fR
3215 \fBExample 15 \fRCreating a ZFS Volume as an iSCSI Target Device
3218 The following example shows how to create a \fBZFS\fR volume as an \fBiSCSI\fR target.
3223 # \fBzfs create -V 2g pool/volumes/vol1\fR
3224 # \fBzfs set shareiscsi=on pool/volumes/vol1\fR
3225 # \fBiscsitadm list target\fR
3226 Target: pool/volumes/vol1
3228 iqn.1986-03.com.sun:02:7b4b02a6-3277-eb1b-e686-a24762c52a8c
3236 After the \fBiSCSI\fR target is created, set up the \fBiSCSI\fR initiator. For more information about the Solaris \fBiSCSI\fR initiator, see \fBiscsitadm\fR(1M).
3238 \fBExample 16 \fRPerforming a Rolling Snapshot
3241 The following example shows how to maintain a history of snapshots with a consistent naming scheme. To keep a week's worth of snapshots, the user destroys the oldest snapshot, renames the remaining snapshots, and then creates a new snapshot, as follows:
3246 # \fBzfs destroy -r pool/users@7daysago\fR
3247 # \fBzfs rename -r pool/users@6daysago @7daysago\fR
3248 # \fBzfs rename -r pool/users@5daysago @6daysago\fR
3249 # \fBzfs rename -r pool/users@4daysago @5daysago\fR
3250 # \fBzfs rename -r pool/users@3daysago @4daysago\fR
3251 # \fBzfs rename -r pool/users@2daysago @3daysago\fR
3252 # \fBzfs rename -r pool/users@yesterday @2daysago\fR
3253 # \fBzfs rename -r pool/users@today @yesterday\fR
3254 # \fBzfs snapshot -r pool/users@today\fR
3260 \fBExample 17 \fRSetting \fBsharenfs\fR Property Options on a ZFS File System
3263 The following commands show how to set \fBsharenfs\fR property options to enable \fBrw\fR access for a set of \fBIP\fR addresses and to enable root access for system \fBneo\fR on the \fBtank/home\fR file system.
3268 # \fBzfs set sharenfs='rw=@123.123.0.0/16,root=neo' tank/home\fR
3275 If you are using \fBDNS\fR for host name resolution, specify the fully qualified hostname.
3278 \fBExample 18 \fRDelegating ZFS Administration Permissions on a ZFS Dataset
3281 The following example shows how to set permissions so that user \fBcindys\fR can create, destroy, mount, and take snapshots on \fBtank/cindys\fR. The permissions on \fBtank/cindys\fR are also displayed.
3286 # \fBzfs allow cindys create,destroy,mount,snapshot tank/cindys\fR
3287 # \fBzfs allow tank/cindys\fR
3288 -------------------------------------------------------------
3289 Local+Descendent permissions on (tank/cindys)
3290 user cindys create,destroy,mount,snapshot
3291 -------------------------------------------------------------
3298 Because the \fBtank/cindys\fR mount point permission is set to 755 by default, user \fBcindys\fR will be unable to mount file systems under \fBtank/cindys\fR. Set an \fBACL\fR similar to the following syntax to provide mount point access:
3302 # \fBchmod A+user:cindys:add_subdirectory:allow /tank/cindys\fR
3308 \fBExample 19 \fRDelegating Create Time Permissions on a ZFS Dataset
3311 The following example shows how to grant anyone in the group \fBstaff\fR to create file systems in \fBtank/users\fR. This syntax also allows staff members to destroy their own file systems, but not destroy anyone else's file system. The permissions on \fBtank/users\fR are also displayed.
3316 # \fBzfs allow staff create,mount tank/users\fR
3317 # \fBzfs allow -c destroy tank/users\fR
3318 # \fBzfs allow tank/users\fR
3319 -------------------------------------------------------------
3320 Create time permissions on (tank/users)
3322 Local+Descendent permissions on (tank/users)
3323 group staff create,mount
3324 -------------------------------------------------------------
3330 \fBExample 20 \fRDefining and Granting a Permission Set on a ZFS Dataset
3333 The following example shows how to define and grant a permission set on the \fBtank/users\fR file system. The permissions on \fBtank/users\fR are also displayed.
3338 # \fBzfs allow -s @pset create,destroy,snapshot,mount tank/users\fR
3339 # \fBzfs allow staff @pset tank/users\fR
3340 # \fBzfs allow tank/users\fR
3341 -------------------------------------------------------------
3342 Permission sets on (tank/users)
3343 @pset create,destroy,mount,snapshot
3344 Create time permissions on (tank/users)
3346 Local+Descendent permissions on (tank/users)
3347 group staff @pset,create,mount
3348 -------------------------------------------------------------
3354 \fBExample 21 \fRDelegating Property Permissions on a ZFS Dataset
3357 The following example shows to grant the ability to set quotas and reservations on the \fBusers/home\fR file system. The permissions on \fBusers/home\fR are also displayed.
3362 # \fBzfs allow cindys quota,reservation users/home\fR
3363 # \fBzfs allow users/home\fR
3364 -------------------------------------------------------------
3365 Local+Descendent permissions on (users/home)
3366 user cindys quota,reservation
3367 -------------------------------------------------------------
3368 cindys% \fBzfs set quota=10G users/home/marks\fR
3369 cindys% \fBzfs get quota users/home/marks\fR
3370 NAME PROPERTY VALUE SOURCE
3371 users/home/marks quota 10G local
3377 \fBExample 22 \fRRemoving ZFS Delegated Permissions on a ZFS Dataset
3380 The following example shows how to remove the snapshot permission from the \fBstaff\fR group on the \fBtank/users\fR file system. The permissions on \fBtank/users\fR are also displayed.
3385 # \fBzfs unallow staff snapshot tank/users\fR
3386 # \fBzfs allow tank/users\fR
3387 -------------------------------------------------------------
3388 Permission sets on (tank/users)
3389 @pset create,destroy,mount,snapshot
3390 Create time permissions on (tank/users)
3392 Local+Descendent permissions on (tank/users)
3393 group staff @pset,create,mount
3394 -------------------------------------------------------------
3400 \fBExample 23\fR Showing the differences between a snapshot and a ZFS Dataset
3403 The following example shows how to see what has changed between a prior
3404 snapshot of a ZFS Dataset and its current state. The \fB-F\fR option is used
3405 to indicate type information for the files affected.
3410 # zfs diff -F tank/test@before tank/test
3412 M F /tank/test/linked (+1)
3413 R F /tank/test/oldname -> /tank/test/newname
3414 - F /tank/test/deleted
3415 + F /tank/test/created
3416 M F /tank/test/modified
3424 The following exit values are returned:
3433 Successful completion.
3455 Invalid command line options were specified.
3461 \fBchmod\fR(2), \fBfsync\fR(2), \fBgzip\fR(1), \fBmount\fR(8), \fBssh\fR(1), \fBstat\fR(2), \fBwrite\fR(2), \fBzpool\fR(8)
git://git.camperquake.de / zfs.git / blob