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) 2014 by Delphix. All rights reserved.
26 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
27 .\" Copyright 2013 Nexenta Systems, Inc. All Rights Reserved.
28 .\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
29 .\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
31 .TH ZFS 1M "March 6, 2014"
33 zfs \- configures ZFS file systems
42 \fBzfs\fR \fBcreate\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]... \fIfilesystem\fR
47 \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
52 \fBzfs\fR \fBdestroy\fR [\fB-fnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR
57 \fBzfs\fR \fBdestroy\fR [\fB-dnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR@\fIsnap\fR[%\fIsnap\fR][,\fIsnap\fR[%\fIsnap\fR]]...
62 \fBzfs\fR \fBdestroy\fR \fIfilesystem\fR|\fIvolume\fR#\fIbookmark\fR
67 \fBzfs\fR \fBsnapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]...
68 \fIfilesystem@snapname\fR|\fIvolume@snapname\fR...
73 \fBzfs\fR \fBrollback\fR [\fB-rRf\fR] \fIsnapshot\fR
78 \fBzfs\fR \fBclone\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]... \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR
83 \fBzfs\fR \fBpromote\fR \fIclone-filesystem\fR
88 \fBzfs\fR \fBrename\fR [\fB-f\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
89 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
94 \fBzfs\fR \fBrename\fR [\fB-fp\fR] \fIfilesystem\fR|\fIvolume\fR \fIfilesystem\fR|\fIvolume\fR
99 \fBzfs\fR \fBrename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR
104 \fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-Hp\fR][\fB-o\fR \fIproperty\fR[,\fIproperty\fR]...] [\fB-t\fR \fItype\fR[,\fItype\fR]...]
105 [\fB-s\fR \fIproperty\fR]... [\fB-S\fR \fIproperty\fR]... [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR]...
110 \fBzfs\fR \fBset\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR...
115 \fBzfs\fR \fBget\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-Hp\fR][\fB-o\fR \fIfield\fR[,\fIfield\fR]...] [\fB-t\fR \fItype\fR[,\fItype\fR]...]
116 [\fB-s\fR \fIsource\fR[,\fIsource\fR]...] \fBall\fR | \fIproperty\fR[,\fIproperty\fR]...
117 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR...
122 \fBzfs\fR \fBinherit\fR [\fB-r\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume|snapshot\fR...
127 \fBzfs\fR \fBupgrade\fR [\fB-v\fR]
132 \fBzfs\fR \fBupgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIfilesystem\fR
137 \fBzfs\fR \fBuserspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,\fIfield\fR]...] [\fB-s\fR \fIfield\fR]...
138 [\fB-S\fR \fIfield\fR]... [\fB-t\fR \fItype\fR[,\fItype\fR]...] \fIfilesystem\fR|\fIsnapshot\fR
143 \fBzfs\fR \fBgroupspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,\fIfield\fR]...] [\fB-s\fR \fIfield\fR]...
144 [\fB-S\fR \fIfield\fR]... [\fB-t\fR \fItype\fR[,\fItype\fR]...] \fIfilesystem\fR|\fIsnapshot\fR
149 \fBzfs\fR \fBmount\fR
154 \fBzfs\fR \fBmount\fR [\fB-vO\fR] [\fB-o \fIoptions\fR\fR] \fB-a\fR | \fIfilesystem\fR
159 \fBzfs\fR \fBunmount\fR [\fB-f\fR] \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR
164 \fBzfs\fR \fBshare\fR \fB-a\fR | \fIfilesystem\fR
169 \fBzfs\fR \fBunshare\fR \fB-a\fR \fIfilesystem\fR|\fImountpoint\fR
174 \fBzfs\fR \fBbookmark\fR \fIsnapshot\fR \fIbookmark\fR
179 \fBzfs\fR \fBsend\fR [\fB-DnPpRve\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
184 \fBzfs\fR \fBsend\fR [\fB-e\fR] [\fB-i \fIsnapshot\fR|\fIbookmark\fR]\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
189 \fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
194 \fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] [\fB-d\fR|\fB-e\fR] \fIfilesystem\fR
199 \fBzfs\fR \fBallow\fR \fIfilesystem\fR|\fIvolume\fR
204 \fBzfs\fR \fBallow\fR [\fB-ldug\fR] \fIuser\fR|\fIgroup\fR[,\fIuser\fR|\fIgroup\fR]...
205 \fIperm\fR|\fI@setname\fR[,\fIperm\fR|\fI@setname\fR]... \fIfilesystem\fR|\fIvolume\fR
210 \fBzfs\fR \fBallow\fR [\fB-ld\fR] \fB-e\fR|\fBeveryone\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]...
211 \fIfilesystem\fR|\fIvolume\fR
216 \fBzfs\fR \fBallow\fR \fB-c\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]... \fIfilesystem\fR|\fIvolume\fR
221 \fBzfs\fR \fBallow\fR \fB-s\fR @\fIsetname\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]... \fIfilesystem\fR|\fIvolume\fR
226 \fBzfs\fR \fBunallow\fR [\fB-rldug\fR] \fIuser\fR|\fIgroup\fR[,\fIuser\fR|\fIgroup\fR]...
227 [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]...] \fIfilesystem\fR|\fIvolume\fR
232 \fBzfs\fR \fBunallow\fR [\fB-rld\fR] \fB-e\fR|\fBeveryone\fR [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]...]
233 \fIfilesystem\fR|\fIvolume\fR
238 \fBzfs\fR \fBunallow\fR [\fB-r\fR] \fB-c\fR [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]...] \fIfilesystem\fR|\fIvolume\fR
243 \fBzfs\fR \fBunallow\fR [\fB-r\fR] \fB-s\fR @\fIsetname\fR [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]...]
244 \fIfilesystem\fR|\fIvolume\fR
249 \fBzfs\fR \fBhold\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...
254 \fBzfs\fR \fBholds\fR [\fB-r\fR] \fIsnapshot\fR...
259 \fBzfs\fR \fBrelease\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...
264 \fBzfs\fR \fBdiff\fR [\fB-FHt\fR] \fIsnapshot\fR \fIsnapshot|filesystem\fR
268 The \fBzfs\fR command configures \fBZFS\fR datasets within a \fBZFS\fR storage
269 pool, as described in \fBzpool\fR(1M). A dataset is identified by a unique path
270 within the \fBZFS\fR namespace. For example:
274 pool/{filesystem,volume,snapshot}
281 where the maximum length of a dataset name is \fBMAXNAMELEN\fR (256 bytes).
284 A dataset can be one of the following:
288 \fB\fIfile system\fR\fR
292 A \fBZFS\fR dataset of type \fBfilesystem\fR can be mounted within the standard
293 system namespace and behaves like other file systems. While \fBZFS\fR file
294 systems are designed to be \fBPOSIX\fR compliant, known issues exist that
295 prevent compliance in some cases. Applications that depend on standards
296 conformance might fail due to nonstandard behavior when checking file system
307 A logical volume exported as a raw or block device. This type of dataset should
308 only be used under special circumstances. File systems are typically used in
319 A read-only version of a file system or volume at a given point in time. It is
320 specified as \fIfilesystem@name\fR or \fIvolume@name\fR.
323 .SS "ZFS File System Hierarchy"
325 A \fBZFS\fR storage pool is a logical collection of devices that provide space
326 for datasets. A storage pool is also the root of the \fBZFS\fR file system
330 The root of the pool can be accessed as a file system, such as mounting and
331 unmounting, taking snapshots, and setting properties. The physical storage
332 characteristics, however, are managed by the \fBzpool\fR(1M) command.
335 See \fBzpool\fR(1M) for more information on creating and administering pools.
338 A snapshot is a read-only copy of a file system or volume. Snapshots can be
339 created extremely quickly, and initially consume no additional space within the
340 pool. As data within the active dataset changes, the snapshot consumes more
341 data than would otherwise be shared with the active dataset.
344 Snapshots can have arbitrary names. Snapshots of volumes can be cloned or
345 rolled back, but cannot be accessed independently.
348 File system snapshots can be accessed under the \fB\&.zfs/snapshot\fR directory
349 in the root of the file system. Snapshots are automatically mounted on demand
350 and may be unmounted at regular intervals. The visibility of the \fB\&.zfs\fR
351 directory can be controlled by the \fBsnapdir\fR property.
354 A clone is a writable volume or file system whose initial contents are the same
355 as another dataset. As with snapshots, creating a clone is nearly
356 instantaneous, and initially consumes no additional space.
359 Clones can only be created from a snapshot. When a snapshot is cloned, it
360 creates an implicit dependency between the parent and child. Even though the
361 clone is created somewhere else in the dataset hierarchy, the original snapshot
362 cannot be destroyed as long as a clone exists. The \fBorigin\fR property
363 exposes this dependency, and the \fBdestroy\fR command lists any such
364 dependencies, if they exist.
367 The clone parent-child dependency relationship can be reversed by using the
368 \fBpromote\fR subcommand. This causes the "origin" file system to become a
369 clone of the specified file system, which makes it possible to destroy the file
370 system that the clone was created from.
373 Creating a \fBZFS\fR file system is a simple operation, so the number of file
374 systems per system is likely to be numerous. To cope with this, \fBZFS\fR
375 automatically manages mounting and unmounting file systems without the need to
376 edit the \fB/etc/vfstab\fR file. All automatically managed file systems are
377 mounted by \fBZFS\fR at boot time.
380 By default, file systems are mounted under \fB/\fIpath\fR\fR, where \fIpath\fR
381 is the name of the file system in the \fBZFS\fR namespace. Directories are
382 created and destroyed as needed.
385 A file system can also have a mount point set in the \fBmountpoint\fR property.
386 This directory is created as needed, and \fBZFS\fR automatically mounts the
387 file system when the \fBzfs mount -a\fR command is invoked (without editing
388 \fB/etc/vfstab\fR). The \fBmountpoint\fR property can be inherited, so if
389 \fBpool/home\fR has a mount point of \fB/export/stuff\fR, then
390 \fBpool/home/user\fR automatically inherits a mount point of
391 \fB/export/stuff/user\fR.
394 A file system \fBmountpoint\fR property of \fBnone\fR prevents the file system
398 If needed, \fBZFS\fR file systems can also be managed with traditional tools
399 (\fBmount\fR, \fBumount\fR, \fB/etc/vfstab\fR). If a file system's mount point
400 is set to \fBlegacy\fR, \fBZFS\fR makes no attempt to manage the file system,
401 and the administrator is responsible for mounting and unmounting the file
405 A \fBZFS\fR file system can be added to a non-global zone by using the
406 \fBzonecfg\fR \fBadd fs\fR subcommand. A \fBZFS\fR file system that is added to
407 a non-global zone must have its \fBmountpoint\fR property set to \fBlegacy\fR.
410 The physical properties of an added file system are controlled by the global
411 administrator. However, the zone administrator can create, modify, or destroy
412 files within the added file system, depending on how the file system is
416 A dataset can also be delegated to a non-global zone by using the \fBzonecfg\fR
417 \fBadd dataset\fR subcommand. You cannot delegate a dataset to one zone and the
418 children of the same dataset to another zone. The zone administrator can change
419 properties of the dataset or any of its children. However, the \fBquota\fR,
420 \fBfilesystem_limit\fR and \fBsnapshot_limit\fR properties of the delegated
421 dataset can be modified only by the global administrator.
424 A \fBZFS\fR volume can be added as a device to a non-global zone by using the
425 \fBzonecfg\fR \fBadd device\fR subcommand. However, its physical properties can
426 be modified only by the global administrator.
429 For more information about \fBzonecfg\fR syntax, see \fBzonecfg\fR(1M).
432 After a dataset is delegated to a non-global zone, the \fBzoned\fR property is
433 automatically set. A zoned file system cannot be mounted in the global zone,
434 since the zone administrator might have to set the mount point to an
438 The global administrator can forcibly clear the \fBzoned\fR property, though
439 this should be done with extreme care. The global administrator should verify
440 that all the mount points are acceptable before clearing the property.
441 .SS "Native Properties"
443 Properties are divided into two types, native properties and user-defined (or
444 "user") properties. Native properties either export internal statistics or
445 control \fBZFS\fR behavior. In addition, native properties are either editable
446 or read-only. User properties have no effect on \fBZFS\fR behavior, but you can
447 use them to annotate datasets in a way that is meaningful in your environment.
448 For more information about user properties, see the "User Properties" section,
452 Every dataset has a set of properties that export statistics about the dataset
453 as well as control various behaviors. Properties are inherited from the parent
454 unless overridden by the child. Some properties apply only to certain types of
455 datasets (file systems, volumes, or snapshots).
458 The values of numeric properties can be specified using human-readable suffixes
459 (for example, \fBk\fR, \fBKB\fR, \fBM\fR, \fBGb\fR, and so forth, up to \fBZ\fR
460 for zettabyte). The following are all valid (and equal) specifications:
471 The values of non-numeric properties are case sensitive and must be lowercase,
472 except for \fBmountpoint\fR, \fBsharenfs\fR, and \fBsharesmb\fR.
475 The following native properties consist of read-only statistics about the
476 dataset. These properties can be neither set, nor inherited. Native properties
477 apply to all dataset types unless otherwise noted.
481 \fB\fBavailable\fR\fR
485 The amount of space available to the dataset and all its children, assuming
486 that there is no other activity in the pool. Because space is shared within a
487 pool, availability can be limited by any number of factors, including physical
488 pool size, quotas, reservations, or other datasets within the pool.
490 This property can also be referred to by its shortened column name,
497 \fB\fBcompressratio\fR\fR
501 For non-snapshots, the compression ratio achieved for the \fBused\fR
502 space of this dataset, expressed as a multiplier. The \fBused\fR
503 property includes descendant datasets, and, for clones, does not include
504 the space shared with the origin snapshot. For snapshots, the
505 \fBcompressratio\fR is the same as the \fBrefcompressratio\fR property.
506 Compression can be turned on by running: \fBzfs set compression=on
507 \fIdataset\fR\fR. The default value is \fBoff\fR.
517 The time this dataset was created.
527 For snapshots, this property is a comma-separated list of filesystems or
528 volumes which are clones of this snapshot. The clones' \fBorigin\fR property
529 is this snapshot. If the \fBclones\fR property is not empty, then this
530 snapshot can not be destroyed (even with the \fB-r\fR or \fB-f\fR options).
536 \fB\fBdefer_destroy\fR\fR
540 This property is \fBon\fR if the snapshot has been marked for deferred destroy
541 by using the \fBzfs destroy\fR \fB-d\fR command. Otherwise, the property is
548 \fB\fBfilesystem_count\fR
552 The total number of filesystems and volumes that exist under this location in the
553 dataset tree. This value is only available when a \fBfilesystem_limit\fR has
554 been set somewhere in the tree under which the dataset resides.
560 \fB\fBlogicalreferenced\fR\fR
564 The amount of space that is "logically" accessible by this dataset. See
565 the \fBreferenced\fR property. The logical space ignores the effect of
566 the \fBcompression\fR and \fBcopies\fR properties, giving a quantity
567 closer to the amount of data that applications see. However, it does
568 include space consumed by metadata.
570 This property can also be referred to by its shortened column name,
577 \fB\fBlogicalused\fR\fR
581 The amount of space that is "logically" consumed by this dataset and all
582 its descendents. See the \fBused\fR property. The logical space
583 ignores the effect of the \fBcompression\fR and \fBcopies\fR properties,
584 giving a quantity closer to the amount of data that applications see.
585 However, it does include space consumed by metadata.
587 This property can also be referred to by its shortened column name,
598 For file systems, indicates whether the file system is currently mounted. This
599 property can be either \fByes\fR or \fBno\fR.
609 For cloned file systems or volumes, the snapshot from which the clone was
610 created. See also the \fBclones\fR property.
616 \fB\fBreferenced\fR\fR
620 The amount of data that is accessible by this dataset, which may or may not be
621 shared with other datasets in the pool. When a snapshot or clone is created, it
622 initially references the same amount of space as the file system or snapshot it
623 was created from, since its contents are identical.
625 This property can also be referred to by its shortened column name,
632 \fB\fBrefcompressratio\fR\fR
636 The compression ratio achieved for the \fBreferenced\fR space of this
637 dataset, expressed as a multiplier. See also the \fBcompressratio\fR
644 \fB\fBsnapshot_count\fR
648 The total number of snapshots that exist under this location in the dataset tree.
649 This value is only available when a \fBsnapshot_limit\fR has been set somewhere
650 in the tree under which the dataset resides.
660 The type of dataset: \fBfilesystem\fR, \fBvolume\fR, or \fBsnapshot\fR.
670 The amount of space consumed by this dataset and all its descendents. This is
671 the value that is checked against this dataset's quota and reservation. The
672 space used does not include this dataset's reservation, but does take into
673 account the reservations of any descendent datasets. The amount of space that a
674 dataset consumes from its parent, as well as the amount of space that are freed
675 if this dataset is recursively destroyed, is the greater of its space used and
678 When snapshots (see the "Snapshots" section) are created, their space is
679 initially shared between the snapshot and the file system, and possibly with
680 previous snapshots. As the file system changes, space that was previously
681 shared becomes unique to the snapshot, and counted in the snapshot's space
682 used. Additionally, deleting snapshots can increase the amount of space unique
683 to (and used by) other snapshots.
685 The amount of space used, available, or referenced does not take into account
686 pending changes. Pending changes are generally accounted for within a few
687 seconds. Committing a change to a disk using \fBfsync\fR(3c) or \fBO_SYNC\fR
688 does not necessarily guarantee that the space usage information is updated
699 The \fBusedby*\fR properties decompose the \fBused\fR properties into the
700 various reasons that space is used. Specifically, \fBused\fR =
701 \fBusedbychildren\fR + \fBusedbydataset\fR + \fBusedbyrefreservation\fR +,
702 \fBusedbysnapshots\fR. These properties are only available for datasets created
703 on \fBzpool\fR "version 13" pools.
709 \fB\fBusedbychildren\fR\fR
713 The amount of space used by children of this dataset, which would be freed if
714 all the dataset's children were destroyed.
720 \fB\fBusedbydataset\fR\fR
724 The amount of space used by this dataset itself, which would be freed if the
725 dataset were destroyed (after first removing any \fBrefreservation\fR and
726 destroying any necessary snapshots or descendents).
732 \fB\fBusedbyrefreservation\fR\fR
736 The amount of space used by a \fBrefreservation\fR set on this dataset, which
737 would be freed if the \fBrefreservation\fR was removed.
743 \fB\fBusedbysnapshots\fR\fR
747 The amount of space consumed by snapshots of this dataset. In particular, it is
748 the amount of space that would be freed if all of this dataset's snapshots were
749 destroyed. Note that this is not simply the sum of the snapshots' \fBused\fR
750 properties because space can be shared by multiple snapshots.
756 \fB\fBuserused@\fR\fIuser\fR\fR
760 The amount of space consumed by the specified user in this dataset. Space is
761 charged to the owner of each file, as displayed by \fBls\fR \fB-l\fR. The
762 amount of space charged is displayed by \fBdu\fR and \fBls\fR \fB-s\fR. See the
763 \fBzfs userspace\fR subcommand for more information.
765 Unprivileged users can access only their own space usage. The root user, or a
766 user who has been granted the \fBuserused\fR privilege with \fBzfs allow\fR,
767 can access everyone's usage.
769 The \fBuserused@\fR... properties are not displayed by \fBzfs get all\fR. The
770 user's name must be appended after the \fB@\fR symbol, using one of the
776 \fIPOSIX name\fR (for example, \fBjoe\fR)
782 \fIPOSIX numeric ID\fR (for example, \fB789\fR)
788 \fISID name\fR (for example, \fBjoe.smith@mydomain\fR)
794 \fISID numeric ID\fR (for example, \fBS-1-123-456-789\fR)
805 This property is set to the number of user holds on this snapshot. User holds
806 are set by using the \fBzfs hold\fR command.
812 \fB\fBgroupused@\fR\fIgroup\fR\fR
816 The amount of space consumed by the specified group in this dataset. Space is
817 charged to the group of each file, as displayed by \fBls\fR \fB-l\fR. See the
818 \fBuserused@\fR\fIuser\fR property for more information.
820 Unprivileged users can only access their own groups' space usage. The root
821 user, or a user who has been granted the \fBgroupused\fR privilege with \fBzfs
822 allow\fR, can access all groups' usage.
828 \fB\fBvolblocksize\fR=\fIblocksize\fR\fR
832 For volumes, specifies the block size of the volume. The \fBblocksize\fR cannot
833 be changed once the volume has been written, so it should be set at volume
834 creation time. The default \fBblocksize\fR for volumes is 8 Kbytes. Any power
835 of 2 from 512 bytes to 128 Kbytes is valid.
837 This property can also be referred to by its shortened column name,
848 The amount of \fBreferenced\fR space written to this dataset since the
855 \fB\fBwritten@\fR\fIsnapshot\fR\fR
859 The amount of \fBreferenced\fR space written to this dataset since the
860 specified snapshot. This is the space that is referenced by this dataset
861 but was not referenced by the specified snapshot.
863 The \fIsnapshot\fR may be specified as a short snapshot name (just the part
864 after the \fB@\fR), in which case it will be interpreted as a snapshot in
865 the same filesystem as this dataset.
866 The \fIsnapshot\fR be a full snapshot name (\fIfilesystem\fR@\fIsnapshot\fR),
867 which for clones may be a snapshot in the origin's filesystem (or the origin
868 of the origin's filesystem, etc).
873 The following native properties can be used to change the behavior of a
878 \fB\fBaclinherit\fR=\fBdiscard\fR | \fBnoallow\fR | \fBrestricted\fR |
879 \fBpassthrough\fR | \fBpassthrough-x\fR\fR
883 Controls how \fBACL\fR entries are inherited when files and directories are
884 created. A file system with an \fBaclinherit\fR property of \fBdiscard\fR does
885 not inherit any \fBACL\fR entries. A file system with an \fBaclinherit\fR
886 property value of \fBnoallow\fR only inherits inheritable \fBACL\fR entries
887 that specify "deny" permissions. The property value \fBrestricted\fR (the
888 default) removes the \fBwrite_acl\fR and \fBwrite_owner\fR permissions when the
889 \fBACL\fR entry is inherited. A file system with an \fBaclinherit\fR property
890 value of \fBpassthrough\fR inherits all inheritable \fBACL\fR entries without
891 any modifications made to the \fBACL\fR entries when they are inherited. A file
892 system with an \fBaclinherit\fR property value of \fBpassthrough-x\fR has the
893 same meaning as \fBpassthrough\fR, except that the \fBowner@\fR, \fBgroup@\fR,
894 and \fBeveryone@\fR \fBACE\fRs inherit the execute permission only if the file
895 creation mode also requests the execute bit.
897 When the property value is set to \fBpassthrough\fR, files are created with a
898 mode determined by the inheritable \fBACE\fRs. If no inheritable \fBACE\fRs
899 exist that affect the mode, then the mode is set in accordance to the requested
900 mode from the application.
906 \fB\fBaclmode\fR=\fBdiscard\fR | \fBgroupmask\fR | \fBpassthrough\fR\fR | \fBrestricted\fR\fR
910 Controls how an \fBACL\fR is modified during \fBchmod\fR(2). A file system with
911 an \fBaclmode\fR property of \fBdiscard\fR (the default) deletes all \fBACL\fR
912 entries that do not represent the mode of the file. An \fBaclmode\fR property
913 of \fBgroupmask\fR reduces permissions granted in all \fBALLOW\fR entries found
914 in the \fBACL\fR such that they are no greater than the group permissions
915 specified by \fBchmod\fR(2). A file system with an \fBaclmode\fR property of
916 \fBpassthrough\fR indicates that no changes are made to the \fBACL\fR other
917 than creating or updating the necessary \fBACL\fR entries to represent the new
918 mode of the file or directory. An \fBaclmode\fR property of \fBrestricted\fR
919 will cause the \fBchmod\fR(2) operation to return an error when used on any
920 file or directory which has a non-trivial \fBACL\fR whose entries can not be
921 represented by a mode. \fBchmod\fR(2) is required to change the set user ID,
922 set group ID, or sticky bits on a file or directory, as they do not have
923 equivalent \fBACL\fR entries. In order to use \fBchmod\fR(2) on a file or
924 directory with a non-trivial \fBACL\fR when \fBaclmode\fR is set to
925 \fBrestricted\fR, you must first remove all \fBACL\fR entries which do not
926 represent the current mode.
932 \fB\fBatime\fR=\fBon\fR | \fBoff\fR\fR
936 Controls whether the access time for files is updated when they are read.
937 Turning this property off avoids producing write traffic when reading files and
938 can result in significant performance gains, though it might confuse mailers
939 and other similar utilities. The default value is \fBon\fR.
945 \fB\fBcanmount\fR=\fBon\fR | \fBoff\fR | \fBnoauto\fR\fR
949 If this property is set to \fBoff\fR, the file system cannot be mounted, and is
950 ignored by \fBzfs mount -a\fR. Setting this property to \fBoff\fR is similar to
951 setting the \fBmountpoint\fR property to \fBnone\fR, except that the dataset
952 still has a normal \fBmountpoint\fR property, which can be inherited. Setting
953 this property to \fBoff\fR allows datasets to be used solely as a mechanism to
954 inherit properties. One example of setting \fBcanmount=\fR\fBoff\fR is to have
955 two datasets with the same \fBmountpoint\fR, so that the children of both
956 datasets appear in the same directory, but might have different inherited
959 When the \fBnoauto\fR option is set, a dataset can only be mounted and
960 unmounted explicitly. The dataset is not mounted automatically when the dataset
961 is created or imported, nor is it mounted by the \fBzfs mount -a\fR command or
962 unmounted by the \fBzfs unmount -a\fR command.
964 This property is not inherited.
970 \fB\fBchecksum\fR=\fBon\fR | \fBoff\fR | \fBfletcher2\fR | \fBfletcher4\fR |
971 \fBsha256\fR | \fBnoparity\fR \fR
975 Controls the checksum used to verify data integrity. The default value is
976 \fBon\fR, which automatically selects an appropriate algorithm (currently,
977 \fBfletcher4\fR, but this may change in future releases). The value \fBoff\fR
978 disables integrity checking on user data. The value \fBnoparity\fR not only
979 disables integrity but also disables maintaining parity for user data. This
980 setting is used internally by a dump device residing on a RAID-Z pool and should
981 not be used by any other dataset. Disabling checksums is \fBNOT\fR a recommended
984 Changing this property affects only newly-written data.
990 \fB\fBcompression\fR=\fBon\fR | \fBoff\fR | \fBlzjb\fR | \fBgzip\fR |
991 \fBgzip-\fR\fIN\fR | \fBzle\fR\fR | \fBlz4\fR
995 Controls the compression algorithm used for this dataset. The \fBlzjb\fR
996 compression algorithm is optimized for performance while providing decent data
997 compression. Setting compression to \fBon\fR uses the \fBlzjb\fR compression
998 algorithm. The \fBgzip\fR compression algorithm uses the same compression as
999 the \fBgzip\fR(1) command. You can specify the \fBgzip\fR level by using the
1000 value \fBgzip-\fR\fIN\fR where \fIN\fR is an integer from 1 (fastest) to 9
1001 (best compression ratio). Currently, \fBgzip\fR is equivalent to \fBgzip-6\fR
1002 (which is also the default for \fBgzip\fR(1)). The \fBzle\fR compression
1003 algorithm compresses runs of zeros.
1005 The \fBlz4\fR compression algorithm is a high-performance replacement
1006 for the \fBlzjb\fR algorithm. It features significantly faster
1007 compression and decompression, as well as a moderately higher
1008 compression ratio than \fBlzjb\fR, but can only be used on pools with
1009 the \fBlz4_compress\fR feature set to \fIenabled\fR. See
1010 \fBzpool-features\fR(5) for details on ZFS feature flags and the
1011 \fBlz4_compress\fR feature.
1013 This property can also be referred to by its shortened column name
1014 \fBcompress\fR. Changing this property affects only newly-written data.
1020 \fB\fBcopies\fR=\fB1\fR | \fB2\fR | \fB3\fR\fR
1024 Controls the number of copies of data stored for this dataset. These copies are
1025 in addition to any redundancy provided by the pool, for example, mirroring or
1026 RAID-Z. The copies are stored on different disks, if possible. The space used
1027 by multiple copies is charged to the associated file and dataset, changing the
1028 \fBused\fR property and counting against quotas and reservations.
1030 Changing this property only affects newly-written data. Therefore, set this
1031 property at file system creation time by using the \fB-o\fR
1032 \fBcopies=\fR\fIN\fR option.
1038 \fB\fBdevices\fR=\fBon\fR | \fBoff\fR\fR
1042 Controls whether device nodes can be opened on this file system. The default
1049 \fB\fBexec\fR=\fBon\fR | \fBoff\fR\fR
1053 Controls whether processes can be executed from within this file system. The
1054 default value is \fBon\fR.
1060 \fB\fBfilesystem_limit\fR=\fIcount\fR | \fBnone\fR\fR
1064 Limits the number of filesystems and volumes that can exist under this point in
1065 the dataset tree. The limit is not enforced if the user is allowed to change
1066 the limit. Setting a filesystem_limit on a descendent of a filesystem that
1067 already has a filesystem_limit does not override the ancestor's filesystem_limit,
1068 but rather imposes an additional limit. This feature must be enabled to be used
1069 (see \fBzpool-features\fR(5)).
1075 \fB\fBmountpoint\fR=\fIpath\fR | \fBnone\fR | \fBlegacy\fR\fR
1079 Controls the mount point used for this file system. See the "Mount Points"
1080 section for more information on how this property is used.
1082 When the \fBmountpoint\fR property is changed for a file system, the file
1083 system and any children that inherit the mount point are unmounted. If the new
1084 value is \fBlegacy\fR, then they remain unmounted. Otherwise, they are
1085 automatically remounted in the new location if the property was previously
1086 \fBlegacy\fR or \fBnone\fR, or if they were mounted before the property was
1087 changed. In addition, any shared file systems are unshared and shared in the
1094 \fB\fBnbmand\fR=\fBon\fR | \fBoff\fR\fR
1098 Controls whether the file system should be mounted with \fBnbmand\fR (Non
1099 Blocking mandatory locks). This is used for \fBCIFS\fR clients. Changes to this
1100 property only take effect when the file system is umounted and remounted. See
1101 \fBmount\fR(1M) for more information on \fBnbmand\fR mounts.
1107 \fB\fBprimarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR
1111 Controls what is cached in the primary cache (ARC). If this property is set to
1112 \fBall\fR, then both user data and metadata is cached. If this property is set
1113 to \fBnone\fR, then neither user data nor metadata is cached. If this property
1114 is set to \fBmetadata\fR, then only metadata is cached. The default value is
1121 \fB\fBquota\fR=\fIsize\fR | \fBnone\fR\fR
1125 Limits the amount of space a dataset and its descendents can consume. This
1126 property enforces a hard limit on the amount of space used. This includes all
1127 space consumed by descendents, including file systems and snapshots. Setting a
1128 quota on a descendent of a dataset that already has a quota does not override
1129 the ancestor's quota, but rather imposes an additional limit.
1131 Quotas cannot be set on volumes, as the \fBvolsize\fR property acts as an
1138 \fB\fBsnapshot_limit\fR=\fIcount\fR | \fBnone\fR\fR
1142 Limits the number of snapshots that can be created on a dataset and its
1143 descendents. Setting a snapshot_limit on a descendent of a dataset that already
1144 has a snapshot_limit does not override the ancestor's snapshot_limit, but
1145 rather imposes an additional limit. The limit is not enforced if the user is
1146 allowed to change the limit. For example, this means that recursive snapshots
1147 taken from the global zone are counted against each delegated dataset within
1148 a zone. This feature must be enabled to be used (see \fBzpool-features\fR(5)).
1154 \fB\fBuserquota@\fR\fIuser\fR=\fIsize\fR | \fBnone\fR\fR
1158 Limits the amount of space consumed by the specified user. User space
1159 consumption is identified by the \fBuserspace@\fR\fIuser\fR property.
1161 Enforcement of user quotas may be delayed by several seconds. This delay means
1162 that a user might exceed their quota before the system notices that they are
1163 over quota and begins to refuse additional writes with the \fBEDQUOT\fR error
1164 message . See the \fBzfs userspace\fR subcommand for more information.
1166 Unprivileged users can only access their own groups' space usage. The root
1167 user, or a user who has been granted the \fBuserquota\fR privilege with \fBzfs
1168 allow\fR, can get and set everyone's quota.
1170 This property is not available on volumes, on file systems before version 4, or
1171 on pools before version 15. The \fBuserquota@\fR... properties are not
1172 displayed by \fBzfs get all\fR. The user's name must be appended after the
1173 \fB@\fR symbol, using one of the following forms:
1178 \fIPOSIX name\fR (for example, \fBjoe\fR)
1184 \fIPOSIX numeric ID\fR (for example, \fB789\fR)
1190 \fISID name\fR (for example, \fBjoe.smith@mydomain\fR)
1196 \fISID numeric ID\fR (for example, \fBS-1-123-456-789\fR)
1203 \fB\fBgroupquota@\fR\fIgroup\fR=\fIsize\fR | \fBnone\fR\fR
1207 Limits the amount of space consumed by the specified group. Group space
1208 consumption is identified by the \fBuserquota@\fR\fIuser\fR property.
1210 Unprivileged users can access only their own groups' space usage. The root
1211 user, or a user who has been granted the \fBgroupquota\fR privilege with \fBzfs
1212 allow\fR, can get and set all groups' quotas.
1218 \fB\fBreadonly\fR=\fBon\fR | \fBoff\fR\fR
1222 Controls whether this dataset can be modified. The default value is \fBoff\fR.
1224 This property can also be referred to by its shortened column name,
1231 \fB\fBrecordsize\fR=\fIsize\fR\fR
1235 Specifies a suggested block size for files in the file system. This property is
1236 designed solely for use with database workloads that access files in fixed-size
1237 records. \fBZFS\fR automatically tunes block sizes according to internal
1238 algorithms optimized for typical access patterns.
1240 For databases that create very large files but access them in small random
1241 chunks, these algorithms may be suboptimal. Specifying a \fBrecordsize\fR
1242 greater than or equal to the record size of the database can result in
1243 significant performance gains. Use of this property for general purpose file
1244 systems is strongly discouraged, and may adversely affect performance.
1246 The size specified must be a power of two greater than or equal to 512 and less
1247 than or equal to 128 Kbytes.
1249 Changing the file system's \fBrecordsize\fR affects only files created
1250 afterward; existing files are unaffected.
1252 This property can also be referred to by its shortened column name,
1259 \fB\fBredundant_metadata\fR=\fBall\fR | \fBmost\fR\fR
1263 Controls what types of metadata are stored redundantly. ZFS stores an
1264 extra copy of metadata, so that if a single block is corrupted, the
1265 amount of user data lost is limited. This extra copy is in addition to
1266 any redundancy provided at the pool level (e.g. by mirroring or RAID-Z),
1267 and is in addition to an extra copy specified by the \fBcopies\fR
1268 property (up to a total of 3 copies). For example if the pool is
1269 mirrored, \fBcopies\fR=2, and \fBredundant_metadata\fR=most, then ZFS
1270 stores 6 copies of most metadata, and 4 copies of data and some
1273 When set to \fBall\fR, ZFS stores an extra copy of all metadata. If a
1274 single on-disk block is corrupt, at worst a single block of user data
1275 (which is \fBrecordsize\fR bytes long) can be lost.
1277 When set to \fBmost\fR, ZFS stores an extra copy of most types of
1278 metadata. This can improve performance of random writes, because less
1279 metadata must be written. In practice, at worst about 100 blocks (of
1280 \fBrecordsize\fR bytes each) of user data can be lost if a single
1281 on-disk block is corrupt. The exact behavior of which metadata blocks
1282 are stored redundantly may change in future releases.
1284 The default value is \fBall\fR.
1290 \fB\fBrefquota\fR=\fIsize\fR | \fBnone\fR\fR
1294 Limits the amount of space a dataset can consume. This property enforces a hard
1295 limit on the amount of space used. This hard limit does not include space used
1296 by descendents, including file systems and snapshots.
1302 \fB\fBrefreservation\fR=\fIsize\fR | \fBnone\fR\fR
1306 The minimum amount of space guaranteed to a dataset, not including its
1307 descendents. When the amount of space used is below this value, the dataset is
1308 treated as if it were taking up the amount of space specified by
1309 \fBrefreservation\fR. The \fBrefreservation\fR reservation is accounted for in
1310 the parent datasets' space used, and counts against the parent datasets' quotas
1313 If \fBrefreservation\fR is set, a snapshot is only allowed if there is enough
1314 free pool space outside of this reservation to accommodate the current number
1315 of "referenced" bytes in the dataset.
1317 This property can also be referred to by its shortened column name,
1324 \fB\fBreservation\fR=\fIsize\fR | \fBnone\fR\fR
1328 The minimum amount of space guaranteed to a dataset and its descendents. When
1329 the amount of space used is below this value, the dataset is treated as if it
1330 were taking up the amount of space specified by its reservation. Reservations
1331 are accounted for in the parent datasets' space used, and count against the
1332 parent datasets' quotas and reservations.
1334 This property can also be referred to by its shortened column name,
1341 \fB\fBsecondarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR
1345 Controls what is cached in the secondary cache (L2ARC). If this property is set
1346 to \fBall\fR, then both user data and metadata is cached. If this property is
1347 set to \fBnone\fR, then neither user data nor metadata is cached. If this
1348 property is set to \fBmetadata\fR, then only metadata is cached. The default
1355 \fB\fBsetuid\fR=\fBon\fR | \fBoff\fR\fR
1359 Controls whether the set-\fBUID\fR bit is respected for the file system. The
1360 default value is \fBon\fR.
1366 \fB\fBshareiscsi\fR=\fBon\fR | \fBoff\fR\fR
1370 Like the \fBsharenfs\fR property, \fBshareiscsi\fR indicates whether a
1371 \fBZFS\fR volume is exported as an \fBiSCSI\fR target. The acceptable values
1372 for this property are \fBon\fR, \fBoff\fR, and \fBtype=disk\fR. The default
1373 value is \fBoff\fR. In the future, other target types might be supported. For
1374 example, \fBtape\fR.
1376 You might want to set \fBshareiscsi=on\fR for a file system so that all
1377 \fBZFS\fR volumes within the file system are shared by default. However,
1378 setting this property on a file system has no direct effect.
1384 \fB\fBsharesmb\fR=\fBon\fR | \fBoff\fR | \fIopts\fR\fR
1388 Controls whether the file system is shared by using the Solaris \fBCIFS\fR
1389 service, and what options are to be used. A file system with the \fBsharesmb\fR
1390 property set to \fBoff\fR is managed through traditional tools such as
1391 \fBsharemgr\fR(1M). Otherwise, the file system is automatically shared and
1392 unshared with the \fBzfs share\fR and \fBzfs unshare\fR commands. If the
1393 property is set to \fBon\fR, the \fBsharemgr\fR(1M) command is invoked with no
1394 options. Otherwise, the \fBsharemgr\fR(1M) command is invoked with options
1395 equivalent to the contents of this property.
1397 Because \fBSMB\fR shares requires a resource name, a unique resource name is
1398 constructed from the dataset name. The constructed name is a copy of the
1399 dataset name except that the characters in the dataset name, which would be
1400 illegal in the resource name, are replaced with underscore (\fB_\fR)
1401 characters. A pseudo property "name" is also supported that allows you to
1402 replace the data set name with a specified name. The specified name is then
1403 used to replace the prefix dataset in the case of inheritance. For example, if
1404 the dataset \fBdata/home/john\fR is set to \fBname=john\fR, then
1405 \fBdata/home/john\fR has a resource name of \fBjohn\fR. If a child dataset of
1406 \fBdata/home/john/backups\fR, it has a resource name of \fBjohn_backups\fR.
1408 When SMB shares are created, the SMB share name appears as an entry in the
1409 \fB\&.zfs/shares\fR directory. You can use the \fBls\fR or \fBchmod\fR command
1410 to display the share-level ACLs on the entries in this directory.
1412 When the \fBsharesmb\fR property is changed for a dataset, the dataset and any
1413 children inheriting the property are re-shared with the new options, only if
1414 the property was previously set to \fBoff\fR, or if they were shared before the
1415 property was changed. If the new property is set to \fBoff\fR, the file systems
1422 \fB\fBsharenfs\fR=\fBon\fR | \fBoff\fR | \fIopts\fR\fR
1426 Controls whether the file system is shared via \fBNFS\fR, and what options are
1427 used. A file system with a \fBsharenfs\fR property of \fBoff\fR is managed
1428 through traditional tools such as \fBshare\fR(1M), \fBunshare\fR(1M), and
1429 \fBdfstab\fR(4). Otherwise, the file system is automatically shared and
1430 unshared with the \fBzfs share\fR and \fBzfs unshare\fR commands. If the
1431 property is set to \fBon\fR, the \fBshare\fR(1M) command is invoked with no
1432 options. Otherwise, the \fBshare\fR(1M) command is invoked with options
1433 equivalent to the contents of this property.
1435 When the \fBsharenfs\fR property is changed for a dataset, the dataset and any
1436 children inheriting the property are re-shared with the new options, only if
1437 the property was previously \fBoff\fR, or if they were shared before the
1438 property was changed. If the new property is \fBoff\fR, the file systems are
1445 \fB\fBlogbias\fR = \fBlatency\fR | \fBthroughput\fR\fR
1449 Provide a hint to ZFS about handling of synchronous requests in this dataset.
1450 If \fBlogbias\fR is set to \fBlatency\fR (the default), ZFS will use pool log
1451 devices (if configured) to handle the requests at low latency. If \fBlogbias\fR
1452 is set to \fBthroughput\fR, ZFS will not use configured pool log devices. ZFS
1453 will instead optimize synchronous operations for global pool throughput and
1454 efficient use of resources.
1460 \fB\fBsnapdir\fR=\fBhidden\fR | \fBvisible\fR\fR
1464 Controls whether the \fB\&.zfs\fR directory is hidden or visible in the root of
1465 the file system as discussed in the "Snapshots" section. The default value is
1472 \fB\fBsync\fR=\fBstandard\fR | \fBalways\fR | \fBdisabled\fR\fR
1476 Controls the behavior of synchronous requests (e.g. fsync, O_DSYNC).
1477 \fBstandard\fR is the POSIX specified behavior of ensuring all synchronous
1478 requests are written to stable storage and all devices are flushed to ensure
1479 data is not cached by device controllers (this is the default). \fBalways\fR
1480 causes every file system transaction to be written and flushed before its
1481 system call returns. This has a large performance penalty. \fBdisabled\fR
1482 disables synchronous requests. File system transactions are only committed to
1483 stable storage periodically. This option will give the highest performance.
1484 However, it is very dangerous as ZFS would be ignoring the synchronous
1485 transaction demands of applications such as databases or NFS. Administrators
1486 should only use this option when the risks are understood.
1492 \fB\fBversion\fR=\fB1\fR | \fB2\fR | \fBcurrent\fR\fR
1496 The on-disk version of this file system, which is independent of the pool
1497 version. This property can only be set to later supported versions. See the
1498 \fBzfs upgrade\fR command.
1504 \fB\fBvolsize\fR=\fIsize\fR\fR
1508 For volumes, specifies the logical size of the volume. By default, creating a
1509 volume establishes a reservation of equal size. For storage pools with a
1510 version number of 9 or higher, a \fBrefreservation\fR is set instead. Any
1511 changes to \fBvolsize\fR are reflected in an equivalent change to the
1512 reservation (or \fBrefreservation\fR). The \fBvolsize\fR can only be set to a
1513 multiple of \fBvolblocksize\fR, and cannot be zero.
1515 The reservation is kept equal to the volume's logical size to prevent
1516 unexpected behavior for consumers. Without the reservation, the volume could
1517 run out of space, resulting in undefined behavior or data corruption, depending
1518 on how the volume is used. These effects can also occur when the volume size is
1519 changed while it is in use (particularly when shrinking the size). Extreme care
1520 should be used when adjusting the volume size.
1522 Though not recommended, a "sparse volume" (also known as "thin provisioning")
1523 can be created by specifying the \fB-s\fR option to the \fBzfs create -V\fR
1524 command, or by changing the reservation after the volume has been created. A
1525 "sparse volume" is a volume where the reservation is less then the volume size.
1526 Consequently, writes to a sparse volume can fail with \fBENOSPC\fR when the
1527 pool is low on space. For a sparse volume, changes to \fBvolsize\fR are not
1528 reflected in the reservation.
1534 \fB\fBvscan\fR=\fBon\fR | \fBoff\fR\fR
1538 Controls whether regular files should be scanned for viruses when a file is
1539 opened and closed. In addition to enabling this property, the virus scan
1540 service must also be enabled for virus scanning to occur. The default value is
1547 \fB\fBxattr\fR=\fBon\fR | \fBoff\fR\fR
1551 Controls whether extended attributes are enabled for this file system. The
1552 default value is \fBon\fR.
1558 \fB\fBzoned\fR=\fBon\fR | \fBoff\fR\fR
1562 Controls whether the dataset is managed from a non-global zone. See the "Zones"
1563 section for more information. The default value is \fBoff\fR.
1568 The following three properties cannot be changed after the file system is
1569 created, and therefore, should be set when the file system is created. If the
1570 properties are not set with the \fBzfs create\fR or \fBzpool create\fR
1571 commands, these properties are inherited from the parent dataset. If the parent
1572 dataset lacks these properties due to having been created prior to these
1573 features being supported, the new file system will have the default values for
1578 \fB\fBcasesensitivity\fR=\fBsensitive\fR | \fBinsensitive\fR | \fBmixed\fR\fR
1582 Indicates whether the file name matching algorithm used by the file system
1583 should be case-sensitive, case-insensitive, or allow a combination of both
1584 styles of matching. The default value for the \fBcasesensitivity\fR property is
1585 \fBsensitive\fR. Traditionally, UNIX and POSIX file systems have case-sensitive
1588 The \fBmixed\fR value for the \fBcasesensitivity\fR property indicates that the
1589 file system can support requests for both case-sensitive and case-insensitive
1590 matching behavior. Currently, case-insensitive matching behavior on a file
1591 system that supports mixed behavior is limited to the Solaris CIFS server
1592 product. For more information about the \fBmixed\fR value behavior, see the
1593 \fISolaris ZFS Administration Guide\fR.
1599 \fB\fBnormalization\fR = \fBnone\fR | \fBformC\fR | \fBformD\fR | \fBformKC\fR
1604 Indicates whether the file system should perform a \fBunicode\fR normalization
1605 of file names whenever two file names are compared, and which normalization
1606 algorithm should be used. File names are always stored unmodified, names are
1607 normalized as part of any comparison process. If this property is set to a
1608 legal value other than \fBnone\fR, and the \fButf8only\fR property was left
1609 unspecified, the \fButf8only\fR property is automatically set to \fBon\fR. The
1610 default value of the \fBnormalization\fR property is \fBnone\fR. This property
1611 cannot be changed after the file system is created.
1617 \fB\fButf8only\fR=\fBon\fR | \fBoff\fR\fR
1621 Indicates whether the file system should reject file names that include
1622 characters that are not present in the \fBUTF-8\fR character code set. If this
1623 property is explicitly set to \fBoff\fR, the normalization property must either
1624 not be explicitly set or be set to \fBnone\fR. The default value for the
1625 \fButf8only\fR property is \fBoff\fR. This property cannot be changed after the
1626 file system is created.
1631 The \fBcasesensitivity\fR, \fBnormalization\fR, and \fButf8only\fR properties
1632 are also new permissions that can be assigned to non-privileged users by using
1633 the \fBZFS\fR delegated administration feature.
1634 .SS "Temporary Mount Point Properties"
1636 When a file system is mounted, either through \fBmount\fR(1M) for legacy mounts
1637 or the \fBzfs mount\fR command for normal file systems, its mount options are
1638 set according to its properties. The correlation between properties and mount
1639 options is as follows:
1643 PROPERTY MOUNT OPTION
1644 devices devices/nodevices
1647 setuid setuid/nosetuid
1655 In addition, these options can be set on a per-mount basis using the \fB-o\fR
1656 option, without affecting the property that is stored on disk. The values
1657 specified on the command line override the values stored in the dataset. The
1658 \fB-nosuid\fR option is an alias for \fBnodevices,nosetuid\fR. These properties
1659 are reported as "temporary" by the \fBzfs get\fR command. If the properties are
1660 changed while the dataset is mounted, the new setting overrides any temporary
1662 .SS "User Properties"
1664 In addition to the standard native properties, \fBZFS\fR supports arbitrary
1665 user properties. User properties have no effect on \fBZFS\fR behavior, but
1666 applications or administrators can use them to annotate datasets (file systems,
1667 volumes, and snapshots).
1670 User property names must contain a colon (\fB:\fR) character to distinguish
1671 them from native properties. They may contain lowercase letters, numbers, and
1672 the following punctuation characters: colon (\fB:\fR), dash (\fB-\fR), period
1673 (\fB\&.\fR), and underscore (\fB_\fR). The expected convention is that the
1674 property name is divided into two portions such as
1675 \fImodule\fR\fB:\fR\fIproperty\fR, but this namespace is not enforced by
1676 \fBZFS\fR. User property names can be at most 256 characters, and cannot begin
1677 with a dash (\fB-\fR).
1680 When making programmatic use of user properties, it is strongly suggested to
1681 use a reversed \fBDNS\fR domain name for the \fImodule\fR component of property
1682 names to reduce the chance that two independently-developed packages use the
1683 same property name for different purposes. Property names beginning with
1684 \fBcom.sun\fR. are reserved for use by Sun Microsystems.
1687 The values of user properties are arbitrary strings, are always inherited, and
1688 are never validated. All of the commands that operate on properties (\fBzfs
1689 list\fR, \fBzfs get\fR, \fBzfs set\fR, and so forth) can be used to manipulate
1690 both native properties and user properties. Use the \fBzfs inherit\fR command
1691 to clear a user property . If the property is not defined in any parent
1692 dataset, it is removed entirely. Property values are limited to 1024
1694 .SS "ZFS Volumes as Swap or Dump Devices"
1696 During an initial installation a swap device and dump device are created on
1697 \fBZFS\fR volumes in the \fBZFS\fR root pool. By default, the swap area size is
1698 based on 1/2 the size of physical memory up to 2 Gbytes. The size of the dump
1699 device depends on the kernel's requirements at installation time. Separate
1700 \fBZFS\fR volumes must be used for the swap area and dump devices. Do not swap
1701 to a file on a \fBZFS\fR file system. A \fBZFS\fR swap file configuration is
1705 If you need to change your swap area or dump device after the system is
1706 installed or upgraded, use the \fBswap\fR(1M) and \fBdumpadm\fR(1M) commands.
1707 If you need to change the size of your swap area or dump device, see the
1708 \fISolaris ZFS Administration Guide\fR.
1711 All subcommands that modify state are logged persistently to the pool in their
1720 Displays a help message.
1726 \fB\fBzfs create\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]...
1731 Creates a new \fBZFS\fR file system. The file system is automatically mounted
1732 according to the \fBmountpoint\fR property inherited from the parent.
1740 Creates all the non-existing parent datasets. Datasets created in this manner
1741 are automatically mounted according to the \fBmountpoint\fR property inherited
1742 from their parent. Any property specified on the command line using the
1743 \fB-o\fR option is ignored. If the target filesystem already exists, the
1744 operation completes successfully.
1750 \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1754 Sets the specified property as if the command \fBzfs set\fR
1755 \fIproperty\fR=\fIvalue\fR was invoked at the same time the dataset was
1756 created. Any editable \fBZFS\fR property can also be set at creation time.
1757 Multiple \fB-o\fR options can be specified. An error results if the same
1758 property is specified in multiple \fB-o\fR options.
1766 \fB\fBzfs create\fR [\fB-ps\fR] [\fB-b\fR \fIblocksize\fR] [\fB-o\fR
1767 \fIproperty\fR=\fIvalue\fR]... \fB-V\fR \fIsize\fR \fIvolume\fR\fR
1771 Creates a volume of the given size. The volume is exported as a block device in
1772 \fB/dev/zvol/{dsk,rdsk}/\fR\fIpath\fR, where \fIpath\fR is the name of the
1773 volume in the \fBZFS\fR namespace. The size represents the logical size as
1774 exported by the device. By default, a reservation of equal size is created.
1776 \fIsize\fR is automatically rounded up to the nearest 128 Kbytes to ensure that
1777 the volume has an integral number of blocks regardless of \fIblocksize\fR.
1785 Creates all the non-existing parent datasets. Datasets created in this manner
1786 are automatically mounted according to the \fBmountpoint\fR property inherited
1787 from their parent. Any property specified on the command line using the
1788 \fB-o\fR option is ignored. If the target filesystem already exists, the
1789 operation completes successfully.
1799 Creates a sparse volume with no reservation. See \fBvolsize\fR in the Native
1800 Properties section for more information about sparse volumes.
1806 \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1810 Sets the specified property as if the \fBzfs set\fR \fIproperty\fR=\fIvalue\fR
1811 command was invoked at the same time the dataset was created. Any editable
1812 \fBZFS\fR property can also be set at creation time. Multiple \fB-o\fR options
1813 can be specified. An error results if the same property is specified in
1814 multiple \fB-o\fR options.
1820 \fB\fB-b\fR \fIblocksize\fR\fR
1824 Equivalent to \fB-o\fR \fBvolblocksize\fR=\fIblocksize\fR. If this option is
1825 specified in conjunction with \fB-o\fR \fBvolblocksize\fR, the resulting
1826 behavior is undefined.
1834 \fBzfs destroy\fR [\fB-fnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR
1838 Destroys the given dataset. By default, the command unshares any file systems
1839 that are currently shared, unmounts any file systems that are currently
1840 mounted, and refuses to destroy a dataset that has active dependents (children
1849 Recursively destroy all children.
1859 Recursively destroy all dependents, including cloned file systems outside the
1870 Force an unmount of any file systems using the \fBunmount -f\fR command. This
1871 option has no effect on non-file systems or unmounted file systems.
1881 Do a dry-run ("No-op") deletion. No data will be deleted. This is
1882 useful in conjunction with the \fB-v\fR or \fB-p\fR flags to determine what
1883 data would be deleted.
1893 Print machine-parsable verbose information about the deleted data.
1903 Print verbose information about the deleted data.
1906 Extreme care should be taken when applying either the \fB-r\fR or the \fB-R\fR
1907 options, as they can destroy large portions of a pool and cause unexpected
1908 behavior for mounted file systems in use.
1914 \fBzfs destroy\fR [\fB-dnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR@\fIsnap\fR[%\fIsnap\fR][,\fIsnap\fR[%\fIsnap\fR]]...
1918 The given snapshots are destroyed immediately if and only if the \fBzfs
1919 destroy\fR command without the \fB-d\fR option would have destroyed it. Such
1920 immediate destruction would occur, for example, if the snapshot had no clones
1921 and the user-initiated reference count were zero.
1923 If a snapshot does not qualify for immediate destruction, it is marked for
1924 deferred deletion. In this state, it exists as a usable, visible snapshot until
1925 both of the preconditions listed above are met, at which point it is destroyed.
1927 An inclusive range of snapshots may be specified by separating the
1928 first and last snapshots with a percent sign.
1929 The first and/or last snapshots may be left blank, in which case the
1930 filesystem's oldest or newest snapshot will be implied.
1933 (or ranges of snapshots) of the same filesystem or volume may be specified
1934 in a comma-separated list of snapshots.
1935 Only the snapshot's short name (the
1936 part after the \fB@\fR) should be specified when using a range or
1937 comma-separated list to identify multiple snapshots.
1945 Defer snapshot deletion.
1955 Destroy (or mark for deferred deletion) all snapshots with this name in
1956 descendent file systems.
1966 Recursively destroy all clones of these snapshots, including the clones,
1967 snapshots, and children. If this flag is specified, the \fB-d\fR flag will
1978 Do a dry-run ("No-op") deletion. No data will be deleted. This is
1979 useful in conjunction with the \fB-v\fR or \fB-p\fR flags to determine what
1980 data would be deleted.
1990 Print machine-parsable verbose information about the deleted data.
2000 Print verbose information about the deleted data.
2004 Extreme care should be taken when applying either the \fB-r\fR or the \fB-R\fR
2005 options, as they can destroy large portions of a pool and cause unexpected
2006 behavior for mounted file systems in use.
2012 \fBzfs destroy\fR \fIfilesystem\fR|\fIvolume\fR#\fIbookmark\fR
2016 The given bookmark is destroyed.
2023 \fB\fBzfs snapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]...
2024 \fIfilesystem@snapname\fR|\fIvolume@snapname\fR\fR...
2028 Creates snapshots with the given names. All previous modifications by
2029 successful system calls to the file system are part of the snapshots.
2030 Snapshots are taken atomically, so that all snapshots correspond to the same
2031 moment in time. See the "Snapshots" section for details.
2039 Recursively create snapshots of all descendent datasets
2045 \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
2049 Sets the specified property; see \fBzfs create\fR for details.
2057 \fB\fBzfs rollback\fR [\fB-rRf\fR] \fIsnapshot\fR\fR
2061 Roll back the given dataset to a previous snapshot. When a dataset is rolled
2062 back, all data that has changed since the snapshot is discarded, and the
2063 dataset reverts to the state at the time of the snapshot. By default, the
2064 command refuses to roll back to a snapshot other than the most recent one. In
2065 order to do so, all intermediate snapshots and bookmarks must be destroyed
2066 by specifying the \fB-r\fR option.
2068 The \fB-rR\fR options do not recursively destroy the child snapshots of a
2069 recursive snapshot. Only direct snapshots of the specified filesystem
2070 are destroyed by either of these options. To completely roll back a
2071 recursive snapshot, you must rollback the individual child snapshots.
2079 Destroy any snapshots and bookmarks more recent than the one specified.
2089 Destroy any more recent snapshots and bookmarks, as well as any clones of those
2100 Used with the \fB-R\fR option to force an unmount of any clone file systems
2101 that are to be destroyed.
2109 \fB\fBzfs clone\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]...
2110 \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR\fR
2114 Creates a clone of the given snapshot. See the "Clones" section for details.
2115 The target dataset can be located anywhere in the \fBZFS\fR hierarchy, and is
2116 created as the same type as the original.
2124 Creates all the non-existing parent datasets. Datasets created in this manner
2125 are automatically mounted according to the \fBmountpoint\fR property inherited
2126 from their parent. If the target filesystem or volume already exists, the
2127 operation completes successfully.
2133 \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
2137 Sets the specified property; see \fBzfs create\fR for details.
2145 \fB\fBzfs promote\fR \fIclone-filesystem\fR\fR
2149 Promotes a clone file system to no longer be dependent on its "origin"
2150 snapshot. This makes it possible to destroy the file system that the clone was
2151 created from. The clone parent-child dependency relationship is reversed, so
2152 that the origin file system becomes a clone of the specified file system.
2154 The snapshot that was cloned, and any snapshots previous to this snapshot, are
2155 now owned by the promoted clone. The space they use moves from the origin file
2156 system to the promoted clone, so enough space must be available to accommodate
2157 these snapshots. No new space is consumed by this operation, but the space
2158 accounting is adjusted. The promoted clone must not have any conflicting
2159 snapshot names of its own. The \fBrename\fR subcommand can be used to rename
2160 any conflicting snapshots.
2166 \fB\fBzfs rename\fR [\fB-f\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
2170 \fB\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
2174 \fB\fBzfs rename\fR [\fB-fp\fR] \fIfilesystem\fR|\fIvolume\fR
2175 \fIfilesystem\fR|\fIvolume\fR\fR
2179 Renames the given dataset. The new target can be located anywhere in the
2180 \fBZFS\fR hierarchy, with the exception of snapshots. Snapshots can only be
2181 renamed within the parent file system or volume. When renaming a snapshot, the
2182 parent file system of the snapshot does not need to be specified as part of the
2183 second argument. Renamed file systems can inherit new mount points, in which
2184 case they are unmounted and remounted at the new mount point.
2192 Creates all the nonexistent parent datasets. Datasets created in this manner
2193 are automatically mounted according to the \fBmountpoint\fR property inherited
2204 Force unmount any filesystems that need to be unmounted in the process.
2212 \fB\fBzfs rename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR\fR
2216 Recursively rename the snapshots of all descendent datasets. Snapshots are the
2217 only dataset that can be renamed recursively.
2223 \fB\fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-Hp\fR] [\fB-o\fR
2224 \fIproperty\fR[,\fIproperty\fR]...] [ \fB-t\fR \fItype\fR[,\fItype\fR]...] [ \fB-s\fR
2225 \fIproperty\fR ]... [ \fB-S\fR \fIproperty\fR ]...
2226 [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR]...\fR
2230 Lists the property information for the given datasets in tabular form. If
2231 specified, you can list property information by the absolute pathname or the
2232 relative pathname. By default, all file systems and volumes are displayed.
2233 Snapshots are displayed if the \fBlistsnaps\fR property is \fBon\fR (the
2234 default is \fBoff\fR) . The following fields are displayed,
2235 \fBname,used,available,referenced,mountpoint\fR.
2243 Used for scripting mode. Do not print headers and separate fields by a single
2244 tab instead of arbitrary white space.
2254 Display numbers in parsable (exact) values.
2264 Recursively display any children of the dataset on the command line.
2270 \fB\fB-d\fR \fIdepth\fR\fR
2274 Recursively display any children of the dataset, limiting the recursion to
2275 \fIdepth\fR. A depth of \fB1\fR will display only the dataset and its direct
2282 \fB\fB-o\fR \fIproperty\fR\fR
2286 A comma-separated list of properties to display. The property must be:
2291 One of the properties described in the "Native Properties" section
2303 The value \fBname\fR to display the dataset name
2309 The value \fBspace\fR to display space usage properties on file systems and
2310 volumes. This is a shortcut for specifying \fB-o
2311 name,avail,used,usedsnap,usedds,usedrefreserv,usedchild\fR \fB-t
2312 filesystem,volume\fR syntax.
2319 \fB\fB-s\fR \fIproperty\fR\fR
2323 A property for sorting the output by column in ascending order based on the
2324 value of the property. The property must be one of the properties described in
2325 the "Properties" section, or the special value \fBname\fR to sort by the
2326 dataset name. Multiple properties can be specified at one time using multiple
2327 \fB-s\fR property options. Multiple \fB-s\fR options are evaluated from left to
2328 right in decreasing order of importance.
2330 The following is a list of sorting criteria:
2335 Numeric types sort in numeric order.
2341 String types sort in alphabetical order.
2347 Types inappropriate for a row sort that row to the literal bottom, regardless
2348 of the specified ordering.
2354 If no sorting options are specified the existing behavior of \fBzfs list\fR is
2362 \fB\fB-S\fR \fIproperty\fR\fR
2366 Same as the \fB-s\fR option, but sorts by property in descending order.
2372 \fB\fB-t\fR \fItype\fR\fR
2376 A comma-separated list of types to display, where \fItype\fR is one of
2377 \fBfilesystem\fR, \fBsnapshot\fR , \fBvolume\fR, \fBbookmark\fR, or \fBall\fR.
2378 For example, specifying \fB-t snapshot\fR displays only snapshots.
2386 \fB\fBzfs set\fR \fIproperty\fR=\fIvalue\fR
2387 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR...\fR
2391 Sets the property to the given value for each dataset. Only some properties can
2392 be edited. See the "Properties" section for more information on what properties
2393 can be set and acceptable values. Numeric values can be specified as exact
2394 values, or in a human-readable form with a suffix of \fBB\fR, \fBK\fR, \fBM\fR,
2395 \fBG\fR, \fBT\fR, \fBP\fR, \fBE\fR, \fBZ\fR (for bytes, kilobytes, megabytes,
2396 gigabytes, terabytes, petabytes, exabytes, or zettabytes, respectively). User
2397 properties can be set on snapshots. For more information, see the "User
2398 Properties" section.
2404 \fB\fBzfs get\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-Hp\fR] [\fB-o\fR
2405 \fIfield\fR[,\fIfield\fR]... [\fB-t\fR \fItype\fR[,\fItype\fR]...] [\fB-s\fR \fIsource\fR[,\fIsource\fR]... \fBall\fR |
2406 \fIproperty\fR[,\fIproperty\fR]... \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR...\fR
2410 Displays properties for the given datasets. If no datasets are specified, then
2411 the command displays properties for all datasets on the system. For each
2412 property, the following columns are displayed:
2417 property Property name
2418 value Property value
2419 source Property source. Can either be local, default,
2420 temporary, inherited, or none (-).
2425 All columns are displayed by default, though this can be controlled by using
2426 the \fB-o\fR option. This command takes a comma-separated list of properties as
2427 described in the "Native Properties" and "User Properties" sections.
2429 The special value \fBall\fR can be used to display all properties that apply to
2430 the given dataset's type (filesystem, volume, snapshot, or bookmark).
2438 Recursively display properties for any children.
2444 \fB\fB-d\fR \fIdepth\fR\fR
2448 Recursively display any children of the dataset, limiting the recursion to
2449 \fIdepth\fR. A depth of \fB1\fR will display only the dataset and its direct
2460 Display output in a form more easily parsed by scripts. Any headers are
2461 omitted, and fields are explicitly separated by a single tab instead of an
2462 arbitrary amount of space.
2468 \fB\fB-o\fR \fIfield\fR\fR
2472 A comma-separated list of columns to display. \fBname,property,value,source\fR
2473 is the default value.
2479 \fB\fB-s\fR \fIsource\fR\fR
2483 A comma-separated list of sources to display. Those properties coming from a
2484 source other than those in this list are ignored. Each source must be one of
2485 the following: \fBlocal,default,inherited,temporary,none\fR. The default value
2496 Display numbers in parsable (exact) values.
2504 \fB\fBzfs inherit\fR [\fB-r\fR] \fIproperty\fR
2505 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR...\fR
2509 Clears the specified property, causing it to be inherited from an ancestor. If
2510 no ancestor has the property set, then the default value is used. See the
2511 "Properties" section for a listing of default values, and details on which
2512 properties can be inherited.
2520 Recursively inherit the given property for all children.
2528 \fB\fBzfs upgrade\fR [\fB-v\fR]\fR
2532 Displays a list of file systems that are not the most recent version.
2538 \fB\fBzfs upgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] [\fB-a\fR |
2539 \fIfilesystem\fR]\fR
2543 Upgrades file systems to a new on-disk version. Once this is done, the file
2544 systems will no longer be accessible on systems running older versions of the
2545 software. \fBzfs send\fR streams generated from new snapshots of these file
2546 systems cannot be accessed on systems running older versions of the software.
2548 In general, the file system version is independent of the pool version. See
2549 \fBzpool\fR(1M) for information on the \fBzpool upgrade\fR command.
2551 In some cases, the file system version and the pool version are interrelated
2552 and the pool version must be upgraded before the file system version can be
2561 Upgrade all file systems on all imported pools.
2567 \fB\fIfilesystem\fR\fR
2571 Upgrade the specified file system.
2581 Upgrade the specified file system and all descendent file systems
2587 \fB\fB-V\fR \fIversion\fR\fR
2591 Upgrade to the specified \fIversion\fR. If the \fB-V\fR flag is not specified,
2592 this command upgrades to the most recent version. This option can only be used
2593 to increase the version number, and only up to the most recent version
2594 supported by this software.
2602 \fBzfs\fR \fBuserspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,\fIfield\fR]...]
2603 [\fB-s\fR \fIfield\fR]...
2604 [\fB-S\fR \fIfield\fR]...
2605 [\fB-t\fR \fItype\fR[,\fItype\fR]...] \fIfilesystem\fR|\fIsnapshot\fR
2609 Displays space consumed by, and quotas on, each user in the specified
2610 filesystem or snapshot. This corresponds to the \fBuserused@\fR\fIuser\fR and
2611 \fBuserquota@\fR\fIuser\fR properties.
2619 Print numeric ID instead of user/group name.
2629 Do not print headers, use tab-delimited output.
2639 Use exact (parsable) numeric output.
2645 \fB\fB-o\fR \fIfield\fR[,\fIfield\fR]...\fR
2649 Display only the specified fields from the following
2650 set: \fBtype, name, used, quota\fR. The default is to display all fields.
2656 \fB\fB-s\fR \fIfield\fR\fR
2660 Sort output by this field. The \fIs\fR and \fIS\fR flags may be specified
2661 multiple times to sort first by one field, then by another. The default is
2662 \fB-s type\fR \fB-s name\fR.
2668 \fB\fB-S\fR \fIfield\fR\fR
2672 Sort by this field in reverse order. See \fB-s\fR.
2678 \fB\fB-t\fR \fItype\fR[,\fItype\fR]...\fR
2682 Print only the specified types from the following
2683 set: \fBall, posixuser, smbuser, posixgroup, smbgroup\fR. The default
2684 is \fB-t posixuser,smbuser\fR. The default can be changed to include group
2695 Translate SID to POSIX ID. The POSIX ID may be ephemeral if no mapping exists.
2696 Normal POSIX interfaces (for example, \fBstat\fR(2), \fBls\fR \fB-l\fR) perform
2697 this translation, so the \fB-i\fR option allows the output from \fBzfs
2698 userspace\fR to be compared directly with those utilities. However, \fB-i\fR
2699 may lead to confusion if some files were created by an SMB user before a
2700 SMB-to-POSIX name mapping was established. In such a case, some files will be owned
2701 by the SMB entity and some by the POSIX entity. However, the \fB-i\fR option
2702 will report that the POSIX entity has the total usage and quota for both.
2710 \fBzfs\fR \fBgroupspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,\fIfield\fR]...]
2711 [\fB-s\fR \fIfield\fR]...
2712 [\fB-S\fR \fIfield\fR]...
2713 [\fB-t\fR \fItype\fR[,\fItype\fR]...] \fIfilesystem\fR|\fIsnapshot\fR
2717 Displays space consumed by, and quotas on, each group in the specified
2718 filesystem or snapshot. This subcommand is identical to \fBzfs userspace\fR,
2719 except that the default types to display are \fB-t posixgroup,smbgroup\fR.
2725 \fB\fBzfs mount\fR\fR
2729 Displays all \fBZFS\fR file systems currently mounted.
2735 \fB\fBzfs mount\fR [\fB-vO\fR] [\fB-o\fR \fIoptions\fR] \fB-a\fR |
2740 Mounts \fBZFS\fR file systems. Invoked automatically as part of the boot
2745 \fB\fB-o\fR \fIoptions\fR\fR
2749 An optional, comma-separated list of mount options to use temporarily for the
2750 duration of the mount. See the "Temporary Mount Point Properties" section for
2761 Perform an overlay mount. See \fBmount\fR(1M) for more information.
2771 Report mount progress.
2781 Mount all available \fBZFS\fR file systems. Invoked automatically as part of
2788 \fB\fIfilesystem\fR\fR
2792 Mount the specified filesystem.
2800 \fB\fBzfs unmount\fR [\fB-f\fR] \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR
2804 Unmounts currently mounted \fBZFS\fR file systems. Invoked automatically as
2805 part of the shutdown process.
2813 Forcefully unmount the file system, even if it is currently in use.
2823 Unmount all available \fBZFS\fR file systems. Invoked automatically as part of
2830 \fB\fIfilesystem\fR|\fImountpoint\fR\fR
2834 Unmount the specified filesystem. The command can also be given a path to a
2835 \fBZFS\fR file system mount point on the system.
2843 \fB\fBzfs share\fR \fB-a\fR | \fIfilesystem\fR\fR
2847 Shares available \fBZFS\fR file systems.
2855 Share all available \fBZFS\fR file systems. Invoked automatically as part of
2862 \fB\fIfilesystem\fR\fR
2866 Share the specified filesystem according to the \fBsharenfs\fR and
2867 \fBsharesmb\fR properties. File systems are shared when the \fBsharenfs\fR or
2868 \fBsharesmb\fR property is set.
2876 \fB\fBzfs unshare\fR \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR
2880 Unshares currently shared \fBZFS\fR file systems. This is invoked automatically
2881 as part of the shutdown process.
2889 Unshare all available \fBZFS\fR file systems. Invoked automatically as part of
2896 \fB\fIfilesystem\fR|\fImountpoint\fR\fR
2900 Unshare the specified filesystem. The command can also be given a path to a
2901 \fBZFS\fR file system shared on the system.
2909 \fB\fBzfs bookmark\fR \fIsnapshot\fR \fIbookmark\fR\fR
2913 Creates a bookmark of the given snapshot. Bookmarks mark the point in time
2914 when the snapshot was created, and can be used as the incremental source for
2915 a \fBzfs send\fR command.
2917 This feature must be enabled to be used.
2918 See \fBzpool-features\fR(5) for details on ZFS feature flags and the
2919 \fBbookmarks\fR feature.
2926 \fBzfs send\fR [\fB-DnPpRve\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
2930 Creates a stream representation of the second \fIsnapshot\fR, which is written
2931 to standard output. The output can be redirected to a file or to a different
2932 system (for example, using \fBssh\fR(1). By default, a full stream is
2937 \fB\fB-i\fR \fIsnapshot\fR\fR
2941 Generate an incremental stream from the first \fIsnapshot\fR
2942 (the incremental source) to the second \fIsnapshot\fR (the incremental target).
2943 The incremental source can be specified as the last component of the
2944 snapshot name (the \fB@\fR character and following) and
2945 it is assumed to be from the same file system as the incremental target.
2947 If the destination is a clone, the source may be the origin snapshot, which
2948 must be fully specified (for example, \fBpool/fs@origin\fR, not just
2955 \fB\fB-I\fR \fIsnapshot\fR\fR
2959 Generate a stream package that sends all intermediary snapshots from the first
2960 snapshot to the second snapshot. For example, \fB-I @a fs@d\fR is
2961 similar to \fB-i @a fs@b; -i @b fs@c; -i @c fs@d\fR. The incremental
2962 source may be specified as with the \fB-i\fR option.
2972 Generate a replication stream package, which will replicate the specified
2973 filesystem, and all descendent file systems, up to the named snapshot. When
2974 received, all properties, snapshots, descendent file systems, and clones are
2977 If the \fB-i\fR or \fB-I\fR flags are used in conjunction with the \fB-R\fR
2978 flag, an incremental replication stream is generated. The current values of
2979 properties, and current snapshot and file system names are set when the stream
2980 is received. If the \fB-F\fR flag is specified when this stream is received,
2981 snapshots and file systems that do not exist on the sending side are destroyed.
2991 Generate a deduplicated stream. Blocks which would have been sent multiple
2992 times in the send stream will only be sent once. The receiving system must
2993 also support this feature to recieve a deduplicated stream. This flag can
2994 be used regardless of the dataset's \fBdedup\fR property, but performance
2995 will be much better if the filesystem uses a dedup-capable checksum (eg.
3006 Generate a more compact stream by using WRITE_EMBEDDED records for blocks
3007 which are stored more compactly on disk by the \fBembedded_data\fR pool
3008 feature. This flag has no effect if the \fBembedded_data\fR feature is
3009 disabled. The receiving system must have the \fBembedded_data\fR feature
3010 enabled. If the \fBlz4_compress\fR feature is active on the sending system,
3011 then the receiving system must have that feature enabled as well. See
3012 \fBzpool-features\fR(5) for details on ZFS feature flags and the
3013 \fBembedded_data\fR feature.
3023 Include the dataset's properties in the stream. This flag is implicit when
3024 \fB-R\fR is specified. The receiving system must also support this feature.
3034 Do a dry-run ("No-op") send. Do not generate any actual send data. This is
3035 useful in conjunction with the \fB-v\fR or \fB-P\fR flags to determine what
3046 Print machine-parsable verbose information about the stream package generated.
3056 Print verbose information about the stream package generated. This information
3057 includes a per-second report of how much data has been sent.
3060 The format of the stream is committed. You will be able to receive your streams
3061 on future versions of \fBZFS\fR.
3067 \fBzfs send\fR [\fB-e\fR] [\fB-i\fR \fIsnapshot\fR|\fIbookmark\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
3071 Generate a send stream, which may be of a filesystem, and may be
3072 incremental from a bookmark. If the destination is a filesystem or volume,
3073 the pool must be read-only, or the filesystem must not be mounted. When the
3074 stream generated from a filesystem or volume is received, the default snapshot
3075 name will be "--head--".
3080 \fB-i\fR \fIsnapshot\fR|\fIbookmark\fR
3084 Generate an incremental send stream. The incremental source must be an earlier
3085 snapshot in the destination's history. It will commonly be an earlier
3086 snapshot in the destination's filesystem, in which case it can be
3087 specified as the last component of the name (the \fB#\fR or \fB@\fR character
3090 If the incremental target is a clone, the incremental source can
3091 be the origin snapshot, or an earlier snapshot in the origin's filesystem,
3092 or the origin's origin, etc.
3102 Generate a more compact stream by using WRITE_EMBEDDED records for blocks
3103 which are stored more compactly on disk by the \fBembedded_data\fR pool
3104 feature. This flag has no effect if the \fBembedded_data\fR feature is
3105 disabled. The receiving system must have the \fBembedded_data\fR feature
3106 enabled. If the \fBlz4_compress\fR feature is active on the sending system,
3107 then the receiving system must have that feature enabled as well. See
3108 \fBzpool-features\fR(5) for details on ZFS feature flags and the
3109 \fBembedded_data\fR feature.
3116 \fB\fBzfs receive\fR [\fB-vnFu\fR]
3117 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
3121 \fB\fBzfs receive\fR [\fB-vnFu\fR] [\fB-d\fR|\fB-e\fR] \fIfilesystem\fR\fR
3125 Creates a snapshot whose contents are as specified in the stream provided on
3126 standard input. If a full stream is received, then a new file system is created
3127 as well. Streams are created using the \fBzfs send\fR subcommand, which by
3128 default creates a full stream. \fBzfs recv\fR can be used as an alias for
3131 If an incremental stream is received, then the destination file system must
3132 already exist, and its most recent snapshot must match the incremental stream's
3133 source. For \fBzvols\fR, the destination device link is destroyed and
3134 recreated, which means the \fBzvol\fR cannot be accessed during the
3135 \fBreceive\fR operation.
3137 When a snapshot replication package stream that is generated by using the
3138 \fBzfs send\fR \fB-R\fR command is received, any snapshots that do not exist
3139 on the sending location are destroyed by using the \fBzfs destroy\fR \fB-d\fR
3142 The name of the snapshot (and file system, if a full stream is received) that
3143 this subcommand creates depends on the argument type and the use of the
3144 \fB-d\fR or \fB-e\fR options.
3146 If the argument is a snapshot name, the specified \fIsnapshot\fR is created. If
3147 the argument is a file system or volume name, a snapshot with the same name as
3148 the sent snapshot is created within the specified \fIfilesystem\fR or
3149 \fIvolume\fR. If neither of the \fB-d\fR or \fB-e\fR options are specified,
3150 the provided target snapshot name is used exactly as provided.
3152 The \fB-d\fR and \fB-e\fR options cause the file system name of the target
3153 snapshot to be determined by appending a portion of the sent snapshot's name to
3154 the specified target \fIfilesystem\fR. If the \fB-d\fR option is specified, all
3155 but the first element of the sent snapshot's file system path (usually the
3156 pool name) is used and any required intermediate file systems within the
3157 specified one are created. If the \fB-e\fR option is specified, then only the
3158 last element of the sent snapshot's file system name (i.e. the name of the
3159 source file system itself) is used as the target file system name.
3167 Discard the first element of the sent snapshot's file system name, using
3168 the remaining elements to determine the name of the target file system for
3169 the new snapshot as described in the paragraph above.
3179 Discard all but the last element of the sent snapshot's file system name,
3180 using that element to determine the name of the target file system for
3181 the new snapshot as described in the paragraph above.
3191 File system that is associated with the received stream is not mounted.
3201 Print verbose information about the stream and the time required to perform the
3212 Do not actually receive the stream. This can be useful in conjunction with the
3213 \fB-v\fR option to verify the name the receive operation would use.
3223 Force a rollback of the file system to the most recent snapshot before
3224 performing the receive operation. If receiving an incremental replication
3225 stream (for example, one generated by \fBzfs send -R -[iI]\fR), destroy
3226 snapshots and file systems that do not exist on the sending side.
3234 \fB\fBzfs allow\fR \fIfilesystem\fR | \fIvolume\fR\fR
3238 Displays permissions that have been delegated on the specified filesystem or
3239 volume. See the other forms of \fBzfs allow\fR for more information.
3245 \fB\fBzfs allow\fR [\fB-ldug\fR] \fIuser\fR|\fIgroup\fR[,\fIuser\fR|\fIgroup\fR]...
3246 \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]... \fIfilesystem\fR|\fIvolume\fR\fR
3250 \fB\fBzfs allow\fR [\fB-ld\fR] \fB-e\fR|\fBeveryone\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...
3251 \fIfilesystem\fR|\fIvolume\fR\fR
3255 Delegates \fBZFS\fR administration permission for the file systems to
3256 non-privileged users.
3260 [\fB-ug\fR] \fIuser\fR|\fIgroup\fR[,\fIuser\fR|\fIgroup\fR]...
3264 Specifies to whom the permissions are delegated. Multiple entities can be
3265 specified as a comma-separated list. If neither of the \fB-ug\fR options are
3266 specified, then the argument is interpreted preferentially as the keyword
3267 \fBeveryone,\fR then as a user name, and lastly as a group name. To specify a user
3268 or group named "everyone", use the \fB-u\fR or \fB-g\fR options. To specify a
3269 group with the same name as a user, use the \fB-g\fR options.
3275 \fB-e\fR|\fBeveryone\fR
3279 Specifies that the permissions be delegated to everyone.
3285 \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...
3289 The permissions to delegate. Multiple permissions
3290 may be specified as a comma-separated list. Permission names are the same as
3291 \fBZFS\fR subcommand and property names. See the property list below. Property
3292 set names, which begin with an at sign (\fB@\fR) , may be specified. See the
3293 \fB-s\fR form below for details.
3299 [\fB-ld\fR] \fIfilesystem\fR|\fIvolume\fR
3303 Specifies where the permissions are delegated. If neither of the \fB-ld\fR
3304 options are specified, or both are, then the permissions are allowed for the
3305 file system or volume, and all of its descendents. If only the \fB-l\fR option
3306 is used, then is allowed "locally" only for the specified file system. If only
3307 the \fB-d\fR option is used, then is allowed only for the descendent file
3315 Permissions are generally the ability to use a \fBZFS\fR subcommand or change a
3316 \fBZFS\fR property. The following permissions are available:
3321 allow subcommand Must also have the permission that is being
3323 clone subcommand Must also have the 'create' ability and 'mount'
3324 ability in the origin file system
3325 create subcommand Must also have the 'mount' ability
3326 destroy subcommand Must also have the 'mount' ability
3327 diff subcommand Allows lookup of paths within a dataset
3328 given an object number, and the ability to
3329 create snapshots necessary to 'zfs diff'.
3330 mount subcommand Allows mount/umount of ZFS datasets
3331 promote subcommand Must also have the 'mount'
3332 and 'promote' ability in the origin file system
3333 receive subcommand Must also have the 'mount' and 'create' ability
3334 rename subcommand Must also have the 'mount' and 'create'
3335 ability in the new parent
3336 rollback subcommand Must also have the 'mount' ability
3338 share subcommand Allows sharing file systems over NFS or SMB
3340 snapshot subcommand Must also have the 'mount' ability
3341 groupquota other Allows accessing any groupquota@... property
3342 groupused other Allows reading any groupused@... property
3343 userprop other Allows changing any user property
3344 userquota other Allows accessing any userquota@... property
3345 userused other Allows reading any userused@... property
3351 casesensitivity property
3353 compression property
3357 filesystem_limit property
3360 normalization property
3361 primarycache property
3366 refreservation property
3367 reservation property
3368 secondarycache property
3374 snapshot_limit property
3377 volblocksize property
3389 \fB\fBzfs allow\fR \fB-c\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...
3390 \fIfilesystem\fR|\fIvolume\fR\fR
3394 Sets "create time" permissions. These permissions are granted (locally) to the
3395 creator of any newly-created descendent file system.
3401 \fB\fBzfs allow\fR \fB-s\fR @\fIsetname\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...
3402 \fIfilesystem\fR|\fIvolume\fR\fR
3406 Defines or adds permissions to a permission set. The set can be used by other
3407 \fBzfs allow\fR commands for the specified file system and its descendents.
3408 Sets are evaluated dynamically, so changes to a set are immediately reflected.
3409 Permission sets follow the same naming restrictions as ZFS file systems, but
3410 the name must begin with an "at sign" (\fB@\fR), and can be no more than 64
3417 \fB\fBzfs unallow\fR [\fB-rldug\fR] \fIuser\fR|\fIgroup\fR[,\fIuser\fR|\fIgroup\fR]...
3418 [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...] \fIfilesystem\fR|\fIvolume\fR\fR
3422 \fB\fBzfs unallow\fR [\fB-rld\fR] \fB-e\fR|\fBeveryone\fR [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...]
3423 \fIfilesystem\fR|\fIvolume\fR\fR
3427 \fB\fBzfs unallow\fR [\fB-r\fR] \fB-c\fR [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...]\fR
3431 \fB\fIfilesystem\fR|\fIvolume\fR\fR
3435 Removes permissions that were granted with the \fBzfs allow\fR command. No
3436 permissions are explicitly denied, so other permissions granted are still in
3437 effect. For example, if the permission is granted by an ancestor. If no
3438 permissions are specified, then all permissions for the specified \fIuser\fR,
3439 \fIgroup\fR, or everyone are removed. Specifying \fBeveryone\fR (or using the
3440 \fB-e\fR option) only removes the permissions that were granted to everyone,
3441 not all permissions for every user and group. See the \fBzfs allow\fR command
3442 for a description of the \fB-ldugec\fR options.
3450 Recursively remove the permissions from this file system and all descendents.
3458 \fB\fBzfs unallow\fR [\fB-r\fR] \fB-s\fR @\fIsetname\fR
3459 [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...]\fR
3463 \fB\fIfilesystem\fR|\fIvolume\fR\fR
3467 Removes permissions from a permission set. If no permissions are specified,
3468 then all permissions are removed, thus removing the set entirely.
3474 \fB\fBzfs hold\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR
3478 Adds a single reference, named with the \fItag\fR argument, to the specified
3479 snapshot or snapshots. Each snapshot has its own tag namespace, and tags must
3480 be unique within that space.
3482 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
3483 \fBzfs destroy\fR command return \fBEBUSY\fR.
3491 Specifies that a hold with the given tag is applied recursively to the
3492 snapshots of all descendent file systems.
3500 \fB\fBzfs holds\fR [\fB-r\fR] \fIsnapshot\fR...\fR
3504 Lists all existing user references for the given snapshot or snapshots.
3512 Lists the holds that are set on the named descendent snapshots, in addition to
3513 listing the holds on the named snapshot.
3521 \fB\fBzfs release\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR
3525 Removes a single reference, named with the \fItag\fR argument, from the
3526 specified snapshot or snapshots. The tag must already exist for each snapshot.
3528 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
3529 \fBzfs destroy\fR command return \fBEBUSY\fR.
3537 Recursively releases a hold with the given tag on the snapshots of all
3538 descendent file systems.
3544 \fBzfs diff\fR [\fB-FHt\fR] \fIsnapshot\fR \fIsnapshot|filesystem\fR
3548 Display the difference between a snapshot of a given filesystem and another
3549 snapshot of that filesystem from a later time or the current contents of the
3550 filesystem. The first column is a character indicating the type of change,
3551 the other columns indicate pathname, new pathname (in case of rename), change
3552 in link count, and optionally file type and/or change time.
3554 The types of change are:
3557 - The path has been removed
3558 + The path has been created
3559 M The path has been modified
3560 R The path has been renamed
3570 Display an indication of the type of file, in a manner similar to the \fB-F\fR
3571 option of \fBls\fR(1).
3593 Give more parsable tab-separated output, without header lines and without arrows.
3602 Display the path's inode change time as the first column of output.
3607 \fBExample 1 \fRCreating a ZFS File System Hierarchy
3610 The following commands create a file system named \fBpool/home\fR and a file
3611 system named \fBpool/home/bob\fR. The mount point \fB/export/home\fR is set for
3612 the parent file system, and is automatically inherited by the child file
3618 # \fBzfs create pool/home\fR
3619 # \fBzfs set mountpoint=/export/home pool/home\fR
3620 # \fBzfs create pool/home/bob\fR
3626 \fBExample 2 \fRCreating a ZFS Snapshot
3629 The following command creates a snapshot named \fByesterday\fR. This snapshot
3630 is mounted on demand in the \fB\&.zfs/snapshot\fR directory at the root of the
3631 \fBpool/home/bob\fR file system.
3636 # \fBzfs snapshot pool/home/bob@yesterday\fR
3642 \fBExample 3 \fRCreating and Destroying Multiple Snapshots
3645 The following command creates snapshots named \fByesterday\fR of
3646 \fBpool/home\fR and all of its descendent file systems. Each snapshot is
3647 mounted on demand in the \fB\&.zfs/snapshot\fR directory at the root of its
3648 file system. The second command destroys the newly created snapshots.
3653 # \fBzfs snapshot -r pool/home@yesterday\fR
3654 # \fBzfs destroy -r pool/home@yesterday\fR
3660 \fBExample 4 \fRDisabling and Enabling File System Compression
3663 The following command disables the \fBcompression\fR property for all file
3664 systems under \fBpool/home\fR. The next command explicitly enables
3665 \fBcompression\fR for \fBpool/home/anne\fR.
3670 # \fBzfs set compression=off pool/home\fR
3671 # \fBzfs set compression=on pool/home/anne\fR
3677 \fBExample 5 \fRListing ZFS Datasets
3680 The following command lists all active file systems and volumes in the system.
3681 Snapshots are displayed if the \fBlistsnaps\fR property is \fBon\fR. The
3682 default is \fBoff\fR. See \fBzpool\fR(1M) for more information on pool
3689 NAME USED AVAIL REFER MOUNTPOINT
3690 pool 450K 457G 18K /pool
3691 pool/home 315K 457G 21K /export/home
3692 pool/home/anne 18K 457G 18K /export/home/anne
3693 pool/home/bob 276K 457G 276K /export/home/bob
3699 \fBExample 6 \fRSetting a Quota on a ZFS File System
3702 The following command sets a quota of 50 Gbytes for \fBpool/home/bob\fR.
3707 # \fBzfs set quota=50G pool/home/bob\fR
3713 \fBExample 7 \fRListing ZFS Properties
3716 The following command lists all properties for \fBpool/home/bob\fR.
3721 # \fBzfs get all pool/home/bob\fR
3722 NAME PROPERTY VALUE SOURCE
3723 pool/home/bob type filesystem -
3724 pool/home/bob creation Tue Jul 21 15:53 2009 -
3725 pool/home/bob used 21K -
3726 pool/home/bob available 20.0G -
3727 pool/home/bob referenced 21K -
3728 pool/home/bob compressratio 1.00x -
3729 pool/home/bob mounted yes -
3730 pool/home/bob quota 20G local
3731 pool/home/bob reservation none default
3732 pool/home/bob recordsize 128K default
3733 pool/home/bob mountpoint /pool/home/bob default
3734 pool/home/bob sharenfs off default
3735 pool/home/bob checksum on default
3736 pool/home/bob compression on local
3737 pool/home/bob atime on default
3738 pool/home/bob devices on default
3739 pool/home/bob exec on default
3740 pool/home/bob setuid on default
3741 pool/home/bob readonly off default
3742 pool/home/bob zoned off default
3743 pool/home/bob snapdir hidden default
3744 pool/home/bob aclmode discard default
3745 pool/home/bob aclinherit restricted default
3746 pool/home/bob canmount on default
3747 pool/home/bob shareiscsi off default
3748 pool/home/bob xattr on default
3749 pool/home/bob copies 1 default
3750 pool/home/bob version 4 -
3751 pool/home/bob utf8only off -
3752 pool/home/bob normalization none -
3753 pool/home/bob casesensitivity sensitive -
3754 pool/home/bob vscan off default
3755 pool/home/bob nbmand off default
3756 pool/home/bob sharesmb off default
3757 pool/home/bob refquota none default
3758 pool/home/bob refreservation none default
3759 pool/home/bob primarycache all default
3760 pool/home/bob secondarycache all default
3761 pool/home/bob usedbysnapshots 0 -
3762 pool/home/bob usedbydataset 21K -
3763 pool/home/bob usedbychildren 0 -
3764 pool/home/bob usedbyrefreservation 0 -
3771 The following command gets a single property value.
3776 # \fBzfs get -H -o value compression pool/home/bob\fR
3784 The following command lists all properties with local settings for
3785 \fBpool/home/bob\fR.
3790 # \fBzfs get -r -s local -o name,property,value all pool/home/bob\fR
3792 pool/home/bob quota 20G
3793 pool/home/bob compression on
3799 \fBExample 8 \fRRolling Back a ZFS File System
3802 The following command reverts the contents of \fBpool/home/anne\fR to the
3803 snapshot named \fByesterday\fR, deleting all intermediate snapshots.
3808 # \fBzfs rollback -r pool/home/anne@yesterday\fR
3814 \fBExample 9 \fRCreating a ZFS Clone
3817 The following command creates a writable file system whose initial contents are
3818 the same as \fBpool/home/bob@yesterday\fR.
3823 # \fBzfs clone pool/home/bob@yesterday pool/clone\fR
3829 \fBExample 10 \fRPromoting a ZFS Clone
3832 The following commands illustrate how to test out changes to a file system, and
3833 then replace the original file system with the changed one, using clones, clone
3834 promotion, and renaming:
3839 # \fBzfs create pool/project/production\fR
3840 populate /pool/project/production with data
3841 # \fBzfs snapshot pool/project/production@today\fR
3842 # \fBzfs clone pool/project/production@today pool/project/beta\fR
3843 make changes to /pool/project/beta and test them
3844 # \fBzfs promote pool/project/beta\fR
3845 # \fBzfs rename pool/project/production pool/project/legacy\fR
3846 # \fBzfs rename pool/project/beta pool/project/production\fR
3847 once the legacy version is no longer needed, it can be destroyed
3848 # \fBzfs destroy pool/project/legacy\fR
3854 \fBExample 11 \fRInheriting ZFS Properties
3857 The following command causes \fBpool/home/bob\fR and \fBpool/home/anne\fR to
3858 inherit the \fBchecksum\fR property from their parent.
3863 # \fBzfs inherit checksum pool/home/bob pool/home/anne\fR
3869 \fBExample 12 \fRRemotely Replicating ZFS Data
3872 The following commands send a full stream and then an incremental stream to a
3873 remote machine, restoring them into \fBpoolB/received/fs@a\fRand
3874 \fBpoolB/received/fs@b\fR, respectively. \fBpoolB\fR must contain the file
3875 system \fBpoolB/received\fR, and must not initially contain
3876 \fBpoolB/received/fs\fR.
3881 # \fBzfs send pool/fs@a | \e\fR
3882 \fBssh host zfs receive poolB/received/fs@a\fR
3883 # \fBzfs send -i a pool/fs@b | ssh host \e\fR
3884 \fBzfs receive poolB/received/fs\fR
3890 \fBExample 13 \fRUsing the \fBzfs receive\fR \fB-d\fR Option
3893 The following command sends a full stream of \fBpoolA/fsA/fsB@snap\fR to a
3894 remote machine, receiving it into \fBpoolB/received/fsA/fsB@snap\fR. The
3895 \fBfsA/fsB@snap\fR portion of the received snapshot's name is determined from
3896 the name of the sent snapshot. \fBpoolB\fR must contain the file system
3897 \fBpoolB/received\fR. If \fBpoolB/received/fsA\fR does not exist, it is created
3898 as an empty file system.
3903 # \fBzfs send poolA/fsA/fsB@snap | \e
3904 ssh host zfs receive -d poolB/received\fR
3910 \fBExample 14 \fRSetting User Properties
3913 The following example sets the user-defined \fBcom.example:department\fR
3914 property for a dataset.
3919 # \fBzfs set com.example:department=12345 tank/accounting\fR
3925 \fBExample 15 \fRCreating a ZFS Volume as an iSCSI Target Device
3928 The following example shows how to create a \fBZFS\fR volume as an \fBiSCSI\fR
3934 # \fBzfs create -V 2g pool/volumes/vol1\fR
3935 # \fBzfs set shareiscsi=on pool/volumes/vol1\fR
3936 # \fBiscsitadm list target\fR
3937 Target: pool/volumes/vol1
3939 iqn.1986-03.com.sun:02:7b4b02a6-3277-eb1b-e686-a24762c52a8c
3947 After the \fBiSCSI\fR target is created, set up the \fBiSCSI\fR initiator. For
3948 more information about the Solaris \fBiSCSI\fR initiator, see
3949 \fBiscsitadm\fR(1M).
3951 \fBExample 16 \fRPerforming a Rolling Snapshot
3954 The following example shows how to maintain a history of snapshots with a
3955 consistent naming scheme. To keep a week's worth of snapshots, the user
3956 destroys the oldest snapshot, renames the remaining snapshots, and then creates
3957 a new snapshot, as follows:
3962 # \fBzfs destroy -r pool/users@7daysago\fR
3963 # \fBzfs rename -r pool/users@6daysago @7daysago\fR
3964 # \fBzfs rename -r pool/users@5daysago @6daysago\fR
3965 # \fBzfs rename -r pool/users@yesterday @5daysago\fR
3966 # \fBzfs rename -r pool/users@yesterday @4daysago\fR
3967 # \fBzfs rename -r pool/users@yesterday @3daysago\fR
3968 # \fBzfs rename -r pool/users@yesterday @2daysago\fR
3969 # \fBzfs rename -r pool/users@today @yesterday\fR
3970 # \fBzfs snapshot -r pool/users@today\fR
3976 \fBExample 17 \fRSetting \fBsharenfs\fR Property Options on a ZFS File System
3979 The following commands show how to set \fBsharenfs\fR property options to
3980 enable \fBrw\fR access for a set of \fBIP\fR addresses and to enable root
3981 access for system \fBneo\fR on the \fBtank/home\fR file system.
3986 # \fBzfs set sharenfs='rw=@123.123.0.0/16,root=neo' tank/home\fR
3993 If you are using \fBDNS\fR for host name resolution, specify the fully
3997 \fBExample 18 \fRDelegating ZFS Administration Permissions on a ZFS Dataset
4000 The following example shows how to set permissions so that user \fBcindys\fR
4001 can create, destroy, mount, and take snapshots on \fBtank/cindys\fR. The
4002 permissions on \fBtank/cindys\fR are also displayed.
4007 # \fBzfs allow cindys create,destroy,mount,snapshot tank/cindys\fR
4008 # \fBzfs allow tank/cindys\fR
4009 -------------------------------------------------------------
4010 Local+Descendent permissions on (tank/cindys)
4011 user cindys create,destroy,mount,snapshot
4012 -------------------------------------------------------------
4019 Because the \fBtank/cindys\fR mount point permission is set to 755 by default,
4020 user \fBcindys\fR will be unable to mount file systems under \fBtank/cindys\fR.
4021 Set an \fBACL\fR similar to the following syntax to provide mount point access:
4025 # \fBchmod A+user:cindys:add_subdirectory:allow /tank/cindys\fR
4031 \fBExample 19 \fRDelegating Create Time Permissions on a ZFS Dataset
4034 The following example shows how to grant anyone in the group \fBstaff\fR to
4035 create file systems in \fBtank/users\fR. This syntax also allows staff members
4036 to destroy their own file systems, but not destroy anyone else's file system.
4037 The permissions on \fBtank/users\fR are also displayed.
4042 # \fBzfs allow staff create,mount tank/users\fR
4043 # \fBzfs allow -c destroy tank/users\fR
4044 # \fBzfs allow tank/users\fR
4045 -------------------------------------------------------------
4046 Create time permissions on (tank/users)
4048 Local+Descendent permissions on (tank/users)
4049 group staff create,mount
4050 -------------------------------------------------------------
4056 \fBExample 20 \fRDefining and Granting a Permission Set on a ZFS Dataset
4059 The following example shows how to define and grant a permission set on the
4060 \fBtank/users\fR file system. The permissions on \fBtank/users\fR are also
4066 # \fBzfs allow -s @pset create,destroy,snapshot,mount tank/users\fR
4067 # \fBzfs allow staff @pset tank/users\fR
4068 # \fBzfs allow tank/users\fR
4069 -------------------------------------------------------------
4070 Permission sets on (tank/users)
4071 @pset create,destroy,mount,snapshot
4072 Create time permissions on (tank/users)
4074 Local+Descendent permissions on (tank/users)
4075 group staff @pset,create,mount
4076 -------------------------------------------------------------
4082 \fBExample 21 \fRDelegating Property Permissions on a ZFS Dataset
4085 The following example shows to grant the ability to set quotas and reservations
4086 on the \fBusers/home\fR file system. The permissions on \fBusers/home\fR are
4092 # \fBzfs allow cindys quota,reservation users/home\fR
4093 # \fBzfs allow users/home\fR
4094 -------------------------------------------------------------
4095 Local+Descendent permissions on (users/home)
4096 user cindys quota,reservation
4097 -------------------------------------------------------------
4098 cindys% \fBzfs set quota=10G users/home/marks\fR
4099 cindys% \fBzfs get quota users/home/marks\fR
4100 NAME PROPERTY VALUE SOURCE
4101 users/home/marks quota 10G local
4107 \fBExample 22 \fRRemoving ZFS Delegated Permissions on a ZFS Dataset
4110 The following example shows how to remove the snapshot permission from the
4111 \fBstaff\fR group on the \fBtank/users\fR file system. The permissions on
4112 \fBtank/users\fR are also displayed.
4117 # \fBzfs unallow staff snapshot tank/users\fR
4118 # \fBzfs allow tank/users\fR
4119 -------------------------------------------------------------
4120 Permission sets on (tank/users)
4121 @pset create,destroy,mount,snapshot
4122 Create time permissions on (tank/users)
4124 Local+Descendent permissions on (tank/users)
4125 group staff @pset,create,mount
4126 -------------------------------------------------------------
4132 \fBExample 23\fR Showing the differences between a snapshot and a ZFS Dataset
4135 The following example shows how to see what has changed between a prior
4136 snapshot of a ZFS Dataset and its current state. The \fB-F\fR option is used
4137 to indicate type information for the files affected.
4142 # zfs diff -F tank/test@before tank/test
4144 M F /tank/test/linked (+1)
4145 R F /tank/test/oldname -> /tank/test/newname
4146 - F /tank/test/deleted
4147 + F /tank/test/created
4148 M F /tank/test/modified
4155 The following exit values are returned:
4163 Successful completion.
4183 Invalid command line options were specified.
4188 See \fBattributes\fR(5) for descriptions of the following attributes:
4196 ATTRIBUTE TYPE ATTRIBUTE VALUE
4198 Interface Stability Committed
4203 \fBssh\fR(1), \fBiscsitadm\fR(1M), \fBmount\fR(1M), \fBshare\fR(1M),
4204 \fBsharemgr\fR(1M), \fBunshare\fR(1M), \fBzonecfg\fR(1M), \fBzpool\fR(1M),
4205 \fBchmod\fR(2), \fBstat\fR(2), \fBwrite\fR(2), \fBfsync\fR(3C),
4206 \fBdfstab\fR(4), \fBacl\fR(5), \fBattributes\fR(5)
4209 See the \fBgzip\fR(1) man page, which is not part of the SunOS man page
4213 For information about using the \fBZFS\fR web-based management tool and other
4214 \fBZFS\fR features, see the \fISolaris ZFS Administration Guide\fR.
projects / FreeBSD / FreeBSD.git / blob