5 .\" The contents of this file are subject to the terms of the
6 .\" Common Development and Distribution License (the "License").
7 .\" You may not use this file except in compliance with the License.
9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10 .\" or http://www.opensolaris.org/os/licensing.
11 .\" See the License for the specific language governing permissions
12 .\" and limitations under the License.
14 .\" When distributing Covered Code, include this CDDL HEADER in each
15 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16 .\" If applicable, add the following below this CDDL HEADER, with the
17 .\" fields enclosed by brackets "[]" replaced with your own identifying
18 .\" information: Portions Copyright [yyyy] [name of copyright owner]
23 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
24 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
25 .\" Copyright (c) 2012 by Delphix. All rights reserved.
26 .\" Copyright (c) 2012, Joyent, Inc. All rights reserved.
27 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
28 .\" Copyright 2013 Nexenta Systems, Inc. All Rights Reserved.
30 .TH ZFS 1M "Jan 26, 2013"
32 zfs \- configures ZFS file systems
41 \fBzfs\fR \fBcreate\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]... \fIfilesystem\fR
46 \fBzfs\fR \fBcreate\fR [\fB-ps\fR] [\fB-b\fR \fIblocksize\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]... \fB-V\fR \fIsize\fR \fIvolume\fR
51 \fBzfs\fR \fBdestroy\fR [\fB-fnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR
56 \fBzfs\fR \fBdestroy\fR [\fB-dnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR@\fIsnap\fR[%\fIsnap\fR][,\fIsnap\fR[%\fIsnap\fR]]...
61 \fBzfs\fR \fBsnapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]...
62 \fIfilesystem@snapname\fR|\fIvolume@snapname\fR...
67 \fBzfs\fR \fBrollback\fR [\fB-rRf\fR] \fIsnapshot\fR
72 \fBzfs\fR \fBclone\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]... \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR
77 \fBzfs\fR \fBpromote\fR \fIclone-filesystem\fR
82 \fBzfs\fR \fBrename\fR [\fB-f\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
83 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
88 \fBzfs\fR \fBrename\fR [\fB-fp\fR] \fIfilesystem\fR|\fIvolume\fR \fIfilesystem\fR|\fIvolume\fR
93 \fBzfs\fR \fBrename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR
98 \fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-H\fR][\fB-o\fR \fIproperty\fR[,\fIproperty\fR]...] [\fB-t\fR \fItype\fR[,\fItype\fR]...]
99 [\fB-s\fR \fIproperty\fR]... [\fB-S\fR \fIproperty\fR]... [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR]...
104 \fBzfs\fR \fBset\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR...
109 \fBzfs\fR \fBget\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-Hp\fR][\fB-o\fR \fIfield\fR[,\fIfield\fR]...] [\fB-t\fR \fItype\fR[,\fItype\fR]...]
110 [\fB-s\fR \fIsource\fR[,\fIsource\fR]...] \fBall\fR | \fIproperty\fR[,\fIproperty\fR]...
111 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR...
116 \fBzfs\fR \fBinherit\fR [\fB-r\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume|snapshot\fR...
121 \fBzfs\fR \fBupgrade\fR [\fB-v\fR]
126 \fBzfs\fR \fBupgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIfilesystem\fR
131 \fBzfs\fR \fBuserspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,\fIfield\fR]...] [\fB-s\fR \fIfield\fR]...
132 [\fB-S\fR \fIfield\fR]... [\fB-t\fR \fItype\fR[,\fItype\fR]...] \fIfilesystem\fR|\fIsnapshot\fR
137 \fBzfs\fR \fBgroupspace\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 \fBmount\fR
148 \fBzfs\fR \fBmount\fR [\fB-vO\fR] [\fB-o \fIoptions\fR\fR] \fB-a\fR | \fIfilesystem\fR
153 \fBzfs\fR \fBunmount\fR [\fB-f\fR] \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR
158 \fBzfs\fR \fBshare\fR \fB-a\fR | \fIfilesystem\fR
163 \fBzfs\fR \fBunshare\fR \fB-a\fR \fIfilesystem\fR|\fImountpoint\fR
168 \fBzfs\fR \fBsend\fR [\fB-DnPpRrv\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
173 \fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
178 \fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] [\fB-d\fR|\fB-e\fR] \fIfilesystem\fR
183 \fBzfs\fR \fBallow\fR \fIfilesystem\fR|\fIvolume\fR
188 \fBzfs\fR \fBallow\fR [\fB-ldug\fR] \fIuser\fR|\fIgroup\fR[,\fIuser\fR|\fIgroup\fR]...
189 \fIperm\fR|\fI@setname\fR[,\fIperm\fR|\fI@setname\fR]... \fIfilesystem\fR|\fIvolume\fR
194 \fBzfs\fR \fBallow\fR [\fB-ld\fR] \fB-e\fR|\fBeveryone\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]...
195 \fIfilesystem\fR|\fIvolume\fR
200 \fBzfs\fR \fBallow\fR \fB-c\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]... \fIfilesystem\fR|\fIvolume\fR
205 \fBzfs\fR \fBallow\fR \fB-s\fR @\fIsetname\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]... \fIfilesystem\fR|\fIvolume\fR
210 \fBzfs\fR \fBunallow\fR [\fB-rldug\fR] \fIuser\fR|\fIgroup\fR[,\fIuser\fR|\fIgroup\fR]...
211 [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]...] \fIfilesystem\fR|\fIvolume\fR
216 \fBzfs\fR \fBunallow\fR [\fB-rld\fR] \fB-e\fR|\fBeveryone\fR [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]...]
217 \fIfilesystem\fR|\fIvolume\fR
222 \fBzfs\fR \fBunallow\fR [\fB-r\fR] \fB-c\fR [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]...] \fIfilesystem\fR|\fIvolume\fR
227 \fBzfs\fR \fBunallow\fR [\fB-r\fR] \fB-s\fR @\fIsetname\fR [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]...]
228 \fIfilesystem\fR|\fIvolume\fR
233 \fBzfs\fR \fBhold\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...
238 \fBzfs\fR \fBholds\fR [\fB-r\fR] \fIsnapshot\fR...
243 \fBzfs\fR \fBrelease\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...
248 \fBzfs\fR \fBdiff\fR [\fB-FHt\fR] \fIsnapshot\fR \fIsnapshot|filesystem\fR
253 The \fBzfs\fR command configures \fBZFS\fR datasets within a \fBZFS\fR storage
254 pool, as described in \fBzpool\fR(1M). A dataset is identified by a unique path
255 within the \fBZFS\fR namespace. For example:
259 pool/{filesystem,volume,snapshot}
266 where the maximum length of a dataset name is \fBMAXNAMELEN\fR (256 bytes).
269 A dataset can be one of the following:
273 \fB\fIfile system\fR\fR
277 A \fBZFS\fR dataset of type \fBfilesystem\fR can be mounted within the standard
278 system namespace and behaves like other file systems. While \fBZFS\fR file
279 systems are designed to be \fBPOSIX\fR compliant, known issues exist that
280 prevent compliance in some cases. Applications that depend on standards
281 conformance might fail due to nonstandard behavior when checking file system
292 A logical volume exported as a raw or block device. This type of dataset should
293 only be used under special circumstances. File systems are typically used in
304 A read-only version of a file system or volume at a given point in time. It is
305 specified as \fIfilesystem@name\fR or \fIvolume@name\fR.
308 .SS "ZFS File System Hierarchy"
311 A \fBZFS\fR storage pool is a logical collection of devices that provide space
312 for datasets. A storage pool is also the root of the \fBZFS\fR file system
316 The root of the pool can be accessed as a file system, such as mounting and
317 unmounting, taking snapshots, and setting properties. The physical storage
318 characteristics, however, are managed by the \fBzpool\fR(1M) command.
321 See \fBzpool\fR(1M) for more information on creating and administering pools.
325 A snapshot is a read-only copy of a file system or volume. Snapshots can be
326 created extremely quickly, and initially consume no additional space within the
327 pool. As data within the active dataset changes, the snapshot consumes more
328 data than would otherwise be shared with the active dataset.
331 Snapshots can have arbitrary names. Snapshots of volumes can be cloned or
332 rolled back, but cannot be accessed independently.
335 File system snapshots can be accessed under the \fB\&.zfs/snapshot\fR directory
336 in the root of the file system. Snapshots are automatically mounted on demand
337 and may be unmounted at regular intervals. The visibility of the \fB\&.zfs\fR
338 directory can be controlled by the \fBsnapdir\fR property.
342 A clone is a writable volume or file system whose initial contents are the same
343 as another dataset. As with snapshots, creating a clone is nearly
344 instantaneous, and initially consumes no additional space.
347 Clones can only be created from a snapshot. When a snapshot is cloned, it
348 creates an implicit dependency between the parent and child. Even though the
349 clone is created somewhere else in the dataset hierarchy, the original snapshot
350 cannot be destroyed as long as a clone exists. The \fBorigin\fR property
351 exposes this dependency, and the \fBdestroy\fR command lists any such
352 dependencies, if they exist.
355 The clone parent-child dependency relationship can be reversed by using the
356 \fBpromote\fR subcommand. This causes the "origin" file system to become a
357 clone of the specified file system, which makes it possible to destroy the file
358 system that the clone was created from.
362 Creating a \fBZFS\fR file system is a simple operation, so the number of file
363 systems per system is likely to be numerous. To cope with this, \fBZFS\fR
364 automatically manages mounting and unmounting file systems without the need to
365 edit the \fB/etc/vfstab\fR file. All automatically managed file systems are
366 mounted by \fBZFS\fR at boot time.
369 By default, file systems are mounted under \fB/\fIpath\fR\fR, where \fIpath\fR
370 is the name of the file system in the \fBZFS\fR namespace. Directories are
371 created and destroyed as needed.
374 A file system can also have a mount point set in the \fBmountpoint\fR property.
375 This directory is created as needed, and \fBZFS\fR automatically mounts the
376 file system when the \fBzfs mount -a\fR command is invoked (without editing
377 \fB/etc/vfstab\fR). The \fBmountpoint\fR property can be inherited, so if
378 \fBpool/home\fR has a mount point of \fB/export/stuff\fR, then
379 \fBpool/home/user\fR automatically inherits a mount point of
380 \fB/export/stuff/user\fR.
383 A file system \fBmountpoint\fR property of \fBnone\fR prevents the file system
387 If needed, \fBZFS\fR file systems can also be managed with traditional tools
388 (\fBmount\fR, \fBumount\fR, \fB/etc/vfstab\fR). If a file system's mount point
389 is set to \fBlegacy\fR, \fBZFS\fR makes no attempt to manage the file system,
390 and the administrator is responsible for mounting and unmounting the file
395 A \fBZFS\fR file system can be added to a non-global zone by using the
396 \fBzonecfg\fR \fBadd fs\fR subcommand. A \fBZFS\fR file system that is added to
397 a non-global zone must have its \fBmountpoint\fR property set to \fBlegacy\fR.
400 The physical properties of an added file system are controlled by the global
401 administrator. However, the zone administrator can create, modify, or destroy
402 files within the added file system, depending on how the file system is
406 A dataset can also be delegated to a non-global zone by using the \fBzonecfg\fR
407 \fBadd dataset\fR subcommand. You cannot delegate a dataset to one zone and the
408 children of the same dataset to another zone. The zone administrator can change
409 properties of the dataset or any of its children. However, the \fBquota\fR
410 property is controlled by the global administrator.
413 A \fBZFS\fR volume can be added as a device to a non-global zone by using the
414 \fBzonecfg\fR \fBadd device\fR subcommand. However, its physical properties can
415 be modified only by the global administrator.
418 For more information about \fBzonecfg\fR syntax, see \fBzonecfg\fR(1M).
421 After a dataset is delegated to a non-global zone, the \fBzoned\fR property is
422 automatically set. A zoned file system cannot be mounted in the global zone,
423 since the zone administrator might have to set the mount point to an
427 The global administrator can forcibly clear the \fBzoned\fR property, though
428 this should be done with extreme care. The global administrator should verify
429 that all the mount points are acceptable before clearing the property.
430 .SS "Native Properties"
433 Properties are divided into two types, native properties and user-defined (or
434 "user") properties. Native properties either export internal statistics or
435 control \fBZFS\fR behavior. In addition, native properties are either editable
436 or read-only. User properties have no effect on \fBZFS\fR behavior, but you can
437 use them to annotate datasets in a way that is meaningful in your environment.
438 For more information about user properties, see the "User Properties" section,
442 Every dataset has a set of properties that export statistics about the dataset
443 as well as control various behaviors. Properties are inherited from the parent
444 unless overridden by the child. Some properties apply only to certain types of
445 datasets (file systems, volumes, or snapshots).
448 The values of numeric properties can be specified using human-readable suffixes
449 (for example, \fBk\fR, \fBKB\fR, \fBM\fR, \fBGb\fR, and so forth, up to \fBZ\fR
450 for zettabyte). The following are all valid (and equal) specifications:
461 The values of non-numeric properties are case sensitive and must be lowercase,
462 except for \fBmountpoint\fR, \fBsharenfs\fR, and \fBsharesmb\fR.
465 The following native properties consist of read-only statistics about the
466 dataset. These properties can be neither set, nor inherited. Native properties
467 apply to all dataset types unless otherwise noted.
471 \fB\fBavailable\fR\fR
475 The amount of space available to the dataset and all its children, assuming
476 that there is no other activity in the pool. Because space is shared within a
477 pool, availability can be limited by any number of factors, including physical
478 pool size, quotas, reservations, or other datasets within the pool.
480 This property can also be referred to by its shortened column name,
487 \fB\fBcompressratio\fR\fR
491 For non-snapshots, the compression ratio achieved for the \fBused\fR
492 space of this dataset, expressed as a multiplier. The \fBused\fR
493 property includes descendant datasets, and, for clones, does not include
494 the space shared with the origin snapshot. For snapshots, the
495 \fBcompressratio\fR is the same as the \fBrefcompressratio\fR property.
496 Compression can be turned on by running: \fBzfs set compression=on
497 \fIdataset\fR\fR. The default value is \fBoff\fR.
507 The time this dataset was created.
517 For snapshots, this property is a comma-separated list of filesystems or
518 volumes which are clones of this snapshot. The clones' \fBorigin\fR property
519 is this snapshot. If the \fBclones\fR property is not empty, then this
520 snapshot can not be destroyed (even with the \fB-r\fR or \fB-f\fR options).
526 \fB\fBdefer_destroy\fR\fR
530 This property is \fBon\fR if the snapshot has been marked for deferred destroy
531 by using the \fBzfs destroy\fR \fB-d\fR command. Otherwise, the property is
538 \fB\fBlogicalreferenced\fR\fR
542 The amount of space that is "logically" accessible by this dataset. See
543 the \fBreferenced\fR property. The logical space ignores the effect of
544 the \fBcompression\fR and \fBcopies\fR properties, giving a quantity
545 closer to the amount of data that applications see. However, it does
546 include space consumed by metadata.
548 This property can also be referred to by its shortened column name,
555 \fB\fBlogicalused\fR\fR
559 The amount of space that is "logically" consumed by this dataset and all
560 its descendents. See the \fBused\fR property. The logical space
561 ignores the effect of the \fBcompression\fR and \fBcopies\fR properties,
562 giving a quantity closer to the amount of data that applications see.
563 However, it does include space consumed by metadata.
565 This property can also be referred to by its shortened column name,
576 For file systems, indicates whether the file system is currently mounted. This
577 property can be either \fByes\fR or \fBno\fR.
587 For cloned file systems or volumes, the snapshot from which the clone was
588 created. See also the \fBclones\fR property.
594 \fB\fBreferenced\fR\fR
598 The amount of data that is accessible by this dataset, which may or may not be
599 shared with other datasets in the pool. When a snapshot or clone is created, it
600 initially references the same amount of space as the file system or snapshot it
601 was created from, since its contents are identical.
603 This property can also be referred to by its shortened column name,
610 \fB\fBrefcompressratio\fR\fR
614 The compression ratio achieved for the \fBreferenced\fR space of this
615 dataset, expressed as a multiplier. See also the \fBcompressratio\fR
626 The type of dataset: \fBfilesystem\fR, \fBvolume\fR, or \fBsnapshot\fR.
636 The amount of space consumed by this dataset and all its descendents. This is
637 the value that is checked against this dataset's quota and reservation. The
638 space used does not include this dataset's reservation, but does take into
639 account the reservations of any descendent datasets. The amount of space that a
640 dataset consumes from its parent, as well as the amount of space that are freed
641 if this dataset is recursively destroyed, is the greater of its space used and
644 When snapshots (see the "Snapshots" section) are created, their space is
645 initially shared between the snapshot and the file system, and possibly with
646 previous snapshots. As the file system changes, space that was previously
647 shared becomes unique to the snapshot, and counted in the snapshot's space
648 used. Additionally, deleting snapshots can increase the amount of space unique
649 to (and used by) other snapshots.
651 The amount of space used, available, or referenced does not take into account
652 pending changes. Pending changes are generally accounted for within a few
653 seconds. Committing a change to a disk using \fBfsync\fR(3c) or \fBO_SYNC\fR
654 does not necessarily guarantee that the space usage information is updated
665 The \fBusedby*\fR properties decompose the \fBused\fR properties into the
666 various reasons that space is used. Specifically, \fBused\fR =
667 \fBusedbychildren\fR + \fBusedbydataset\fR + \fBusedbyrefreservation\fR +,
668 \fBusedbysnapshots\fR. These properties are only available for datasets created
669 on \fBzpool\fR "version 13" pools.
675 \fB\fBusedbychildren\fR\fR
679 The amount of space used by children of this dataset, which would be freed if
680 all the dataset's children were destroyed.
686 \fB\fBusedbydataset\fR\fR
690 The amount of space used by this dataset itself, which would be freed if the
691 dataset were destroyed (after first removing any \fBrefreservation\fR and
692 destroying any necessary snapshots or descendents).
698 \fB\fBusedbyrefreservation\fR\fR
702 The amount of space used by a \fBrefreservation\fR set on this dataset, which
703 would be freed if the \fBrefreservation\fR was removed.
709 \fB\fBusedbysnapshots\fR\fR
713 The amount of space consumed by snapshots of this dataset. In particular, it is
714 the amount of space that would be freed if all of this dataset's snapshots were
715 destroyed. Note that this is not simply the sum of the snapshots' \fBused\fR
716 properties because space can be shared by multiple snapshots.
722 \fB\fBuserused@\fR\fIuser\fR\fR
726 The amount of space consumed by the specified user in this dataset. Space is
727 charged to the owner of each file, as displayed by \fBls\fR \fB-l\fR. The
728 amount of space charged is displayed by \fBdu\fR and \fBls\fR \fB-s\fR. See the
729 \fBzfs userspace\fR subcommand for more information.
731 Unprivileged users can access only their own space usage. The root user, or a
732 user who has been granted the \fBuserused\fR privilege with \fBzfs allow\fR,
733 can access everyone's usage.
735 The \fBuserused@\fR... properties are not displayed by \fBzfs get all\fR. The
736 user's name must be appended after the \fB@\fR symbol, using one of the
742 \fIPOSIX name\fR (for example, \fBjoe\fR)
748 \fIPOSIX numeric ID\fR (for example, \fB789\fR)
754 \fISID name\fR (for example, \fBjoe.smith@mydomain\fR)
760 \fISID numeric ID\fR (for example, \fBS-1-123-456-789\fR)
771 This property is set to the number of user holds on this snapshot. User holds
772 are set by using the \fBzfs hold\fR command.
778 \fB\fBgroupused@\fR\fIgroup\fR\fR
782 The amount of space consumed by the specified group in this dataset. Space is
783 charged to the group of each file, as displayed by \fBls\fR \fB-l\fR. See the
784 \fBuserused@\fR\fIuser\fR property for more information.
786 Unprivileged users can only access their own groups' space usage. The root
787 user, or a user who has been granted the \fBgroupused\fR privilege with \fBzfs
788 allow\fR, can access all groups' usage.
794 \fB\fBvolblocksize\fR=\fIblocksize\fR\fR
798 For volumes, specifies the block size of the volume. The \fBblocksize\fR cannot
799 be changed once the volume has been written, so it should be set at volume
800 creation time. The default \fBblocksize\fR for volumes is 8 Kbytes. Any power
801 of 2 from 512 bytes to 128 Kbytes is valid.
803 This property can also be referred to by its shortened column name,
814 The amount of \fBreferenced\fR space written to this dataset since the
821 \fB\fBwritten@\fR\fIsnapshot\fR\fR
825 The amount of \fBreferenced\fR space written to this dataset since the
826 specified snapshot. This is the space that is referenced by this dataset
827 but was not referenced by the specified snapshot.
829 The \fIsnapshot\fR may be specified as a short snapshot name (just the part
830 after the \fB@\fR), in which case it will be interpreted as a snapshot in
831 the same filesystem as this dataset.
832 The \fIsnapshot\fR be a full snapshot name (\fIfilesystem\fR@\fIsnapshot\fR),
833 which for clones may be a snapshot in the origin's filesystem (or the origin
834 of the origin's filesystem, etc).
839 The following native properties can be used to change the behavior of a
844 \fB\fBaclinherit\fR=\fBdiscard\fR | \fBnoallow\fR | \fBrestricted\fR |
845 \fBpassthrough\fR | \fBpassthrough-x\fR\fR
849 Controls how \fBACL\fR entries are inherited when files and directories are
850 created. A file system with an \fBaclinherit\fR property of \fBdiscard\fR does
851 not inherit any \fBACL\fR entries. A file system with an \fBaclinherit\fR
852 property value of \fBnoallow\fR only inherits inheritable \fBACL\fR entries
853 that specify "deny" permissions. The property value \fBrestricted\fR (the
854 default) removes the \fBwrite_acl\fR and \fBwrite_owner\fR permissions when the
855 \fBACL\fR entry is inherited. A file system with an \fBaclinherit\fR property
856 value of \fBpassthrough\fR inherits all inheritable \fBACL\fR entries without
857 any modifications made to the \fBACL\fR entries when they are inherited. A file
858 system with an \fBaclinherit\fR property value of \fBpassthrough-x\fR has the
859 same meaning as \fBpassthrough\fR, except that the \fBowner@\fR, \fBgroup@\fR,
860 and \fBeveryone@\fR \fBACE\fRs inherit the execute permission only if the file
861 creation mode also requests the execute bit.
863 When the property value is set to \fBpassthrough\fR, files are created with a
864 mode determined by the inheritable \fBACE\fRs. If no inheritable \fBACE\fRs
865 exist that affect the mode, then the mode is set in accordance to the requested
866 mode from the application.
872 \fB\fBaclmode\fR=\fBdiscard\fR | \fBgroupmask\fR | \fBpassthrough\fR\fR | \fBrestricted\fR\fR
876 Controls how an \fBACL\fR is modified during \fBchmod\fR(2). A file system with
877 an \fBaclmode\fR property of \fBdiscard\fR (the default) deletes all \fBACL\fR
878 entries that do not represent the mode of the file. An \fBaclmode\fR property
879 of \fBgroupmask\fR reduces permissions granted in all \fBALLOW\fR entries found
880 in the \fBACL\fR such that they are no greater than the group permissions
881 specified by \fBchmod\fR(2). A file system with an \fBaclmode\fR property of
882 \fBpassthrough\fR indicates that no changes are made to the \fBACL\fR other
883 than creating or updating the necessary \fBACL\fR entries to represent the new
884 mode of the file or directory. An \fBaclmode\fR property of \fBrestricted\fR
885 will cause the \fBchmod\fR(2) operation to return an error when used on any
886 file or directory which has a non-trivial \fBACL\fR whose entries can not be
887 represented by a mode. \fBchmod\fR(2) is required to change the set user ID,
888 set group ID, or sticky bits on a file or directory, as they do not have
889 equivalent \fBACL\fR entries. In order to use \fBchmod\fR(2) on a file or
890 directory with a non-trivial \fBACL\fR when \fBaclmode\fR is set to
891 \fBrestricted\fR, you must first remove all \fBACL\fR entries which do not
892 represent the current mode.
898 \fB\fBatime\fR=\fBon\fR | \fBoff\fR\fR
902 Controls whether the access time for files is updated when they are read.
903 Turning this property off avoids producing write traffic when reading files and
904 can result in significant performance gains, though it might confuse mailers
905 and other similar utilities. The default value is \fBon\fR.
911 \fB\fBcanmount\fR=\fBon\fR | \fBoff\fR | \fBnoauto\fR\fR
915 If this property is set to \fBoff\fR, the file system cannot be mounted, and is
916 ignored by \fBzfs mount -a\fR. Setting this property to \fBoff\fR is similar to
917 setting the \fBmountpoint\fR property to \fBnone\fR, except that the dataset
918 still has a normal \fBmountpoint\fR property, which can be inherited. Setting
919 this property to \fBoff\fR allows datasets to be used solely as a mechanism to
920 inherit properties. One example of setting \fBcanmount=\fR\fBoff\fR is to have
921 two datasets with the same \fBmountpoint\fR, so that the children of both
922 datasets appear in the same directory, but might have different inherited
925 When the \fBnoauto\fR option is set, a dataset can only be mounted and
926 unmounted explicitly. The dataset is not mounted automatically when the dataset
927 is created or imported, nor is it mounted by the \fBzfs mount -a\fR command or
928 unmounted by the \fBzfs unmount -a\fR command.
930 This property is not inherited.
936 \fB\fBchecksum\fR=\fBon\fR | \fBoff\fR | \fBfletcher2\fR | \fBfletcher4\fR |
941 Controls the checksum used to verify data integrity. The default value is
942 \fBon\fR, which automatically selects an appropriate algorithm (currently,
943 \fBfletcher4\fR, but this may change in future releases). The value \fBoff\fR
944 disables integrity checking on user data. Disabling checksums is \fBNOT\fR a
945 recommended practice.
947 Changing this property affects only newly-written data.
953 \fB\fBcompression\fR=\fBon\fR | \fBoff\fR | \fBlzjb\fR | \fBgzip\fR |
954 \fBgzip-\fR\fIN\fR | \fBzle\fR\fR | \fBlz4\fR
958 Controls the compression algorithm used for this dataset. The \fBlzjb\fR
959 compression algorithm is optimized for performance while providing decent data
960 compression. Setting compression to \fBon\fR uses the \fBlzjb\fR compression
961 algorithm. The \fBgzip\fR compression algorithm uses the same compression as
962 the \fBgzip\fR(1) command. You can specify the \fBgzip\fR level by using the
963 value \fBgzip-\fR\fIN\fR where \fIN\fR is an integer from 1 (fastest) to 9
964 (best compression ratio). Currently, \fBgzip\fR is equivalent to \fBgzip-6\fR
965 (which is also the default for \fBgzip\fR(1)). The \fBzle\fR compression
966 algorithm compresses runs of zeros.
968 The \fBlz4\fR compression algorithm is a high-performance replacement
969 for the \fBlzjb\fR algorithm. It features significantly faster
970 compression and decompression, as well as a moderately higher
971 compression ratio than \fBlzjb\fR, but can only be used on pools with
972 the \fBlz4_compress\fR feature set to \fIenabled\fR. See
973 \fBzpool-features\fR(5) for details on ZFS feature flags and the
974 \fBlz4_compress\fR feature.
976 This property can also be referred to by its shortened column name
977 \fBcompress\fR. Changing this property affects only newly-written data.
983 \fB\fBcopies\fR=\fB1\fR | \fB2\fR | \fB3\fR\fR
987 Controls the number of copies of data stored for this dataset. These copies are
988 in addition to any redundancy provided by the pool, for example, mirroring or
989 RAID-Z. The copies are stored on different disks, if possible. The space used
990 by multiple copies is charged to the associated file and dataset, changing the
991 \fBused\fR property and counting against quotas and reservations.
993 Changing this property only affects newly-written data. Therefore, set this
994 property at file system creation time by using the \fB-o\fR
995 \fBcopies=\fR\fIN\fR option.
1001 \fB\fBdevices\fR=\fBon\fR | \fBoff\fR\fR
1005 Controls whether device nodes can be opened on this file system. The default
1012 \fB\fBexec\fR=\fBon\fR | \fBoff\fR\fR
1016 Controls whether processes can be executed from within this file system. The
1017 default value is \fBon\fR.
1023 \fB\fBmountpoint\fR=\fIpath\fR | \fBnone\fR | \fBlegacy\fR\fR
1027 Controls the mount point used for this file system. See the "Mount Points"
1028 section for more information on how this property is used.
1030 When the \fBmountpoint\fR property is changed for a file system, the file
1031 system and any children that inherit the mount point are unmounted. If the new
1032 value is \fBlegacy\fR, then they remain unmounted. Otherwise, they are
1033 automatically remounted in the new location if the property was previously
1034 \fBlegacy\fR or \fBnone\fR, or if they were mounted before the property was
1035 changed. In addition, any shared file systems are unshared and shared in the
1042 \fB\fBnbmand\fR=\fBon\fR | \fBoff\fR\fR
1046 Controls whether the file system should be mounted with \fBnbmand\fR (Non
1047 Blocking mandatory locks). This is used for \fBCIFS\fR clients. Changes to this
1048 property only take effect when the file system is umounted and remounted. See
1049 \fBmount\fR(1M) for more information on \fBnbmand\fR mounts.
1055 \fB\fBprimarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR
1059 Controls what is cached in the primary cache (ARC). If this property is set to
1060 \fBall\fR, then both user data and metadata is cached. If this property is set
1061 to \fBnone\fR, then neither user data nor metadata is cached. If this property
1062 is set to \fBmetadata\fR, then only metadata is cached. The default value is
1069 \fB\fBquota\fR=\fIsize\fR | \fBnone\fR\fR
1073 Limits the amount of space a dataset and its descendents can consume. This
1074 property enforces a hard limit on the amount of space used. This includes all
1075 space consumed by descendents, including file systems and snapshots. Setting a
1076 quota on a descendent of a dataset that already has a quota does not override
1077 the ancestor's quota, but rather imposes an additional limit.
1079 Quotas cannot be set on volumes, as the \fBvolsize\fR property acts as an
1086 \fB\fBuserquota@\fR\fIuser\fR=\fIsize\fR | \fBnone\fR\fR
1090 Limits the amount of space consumed by the specified user. User space
1091 consumption is identified by the \fBuserspace@\fR\fIuser\fR property.
1093 Enforcement of user quotas may be delayed by several seconds. This delay means
1094 that a user might exceed their quota before the system notices that they are
1095 over quota and begins to refuse additional writes with the \fBEDQUOT\fR error
1096 message . See the \fBzfs userspace\fR subcommand for more information.
1098 Unprivileged users can only access their own groups' space usage. The root
1099 user, or a user who has been granted the \fBuserquota\fR privilege with \fBzfs
1100 allow\fR, can get and set everyone's quota.
1102 This property is not available on volumes, on file systems before version 4, or
1103 on pools before version 15. The \fBuserquota@\fR... properties are not
1104 displayed by \fBzfs get all\fR. The user's name must be appended after the
1105 \fB@\fR symbol, using one of the following forms:
1110 \fIPOSIX name\fR (for example, \fBjoe\fR)
1116 \fIPOSIX numeric ID\fR (for example, \fB789\fR)
1122 \fISID name\fR (for example, \fBjoe.smith@mydomain\fR)
1128 \fISID numeric ID\fR (for example, \fBS-1-123-456-789\fR)
1135 \fB\fBgroupquota@\fR\fIgroup\fR=\fIsize\fR | \fBnone\fR\fR
1139 Limits the amount of space consumed by the specified group. Group space
1140 consumption is identified by the \fBuserquota@\fR\fIuser\fR property.
1142 Unprivileged users can access only their own groups' space usage. The root
1143 user, or a user who has been granted the \fBgroupquota\fR privilege with \fBzfs
1144 allow\fR, can get and set all groups' quotas.
1150 \fB\fBreadonly\fR=\fBon\fR | \fBoff\fR\fR
1154 Controls whether this dataset can be modified. The default value is \fBoff\fR.
1156 This property can also be referred to by its shortened column name,
1163 \fB\fBrecordsize\fR=\fIsize\fR\fR
1167 Specifies a suggested block size for files in the file system. This property is
1168 designed solely for use with database workloads that access files in fixed-size
1169 records. \fBZFS\fR automatically tunes block sizes according to internal
1170 algorithms optimized for typical access patterns.
1172 For databases that create very large files but access them in small random
1173 chunks, these algorithms may be suboptimal. Specifying a \fBrecordsize\fR
1174 greater than or equal to the record size of the database can result in
1175 significant performance gains. Use of this property for general purpose file
1176 systems is strongly discouraged, and may adversely affect performance.
1178 The size specified must be a power of two greater than or equal to 512 and less
1179 than or equal to 128 Kbytes.
1181 Changing the file system's \fBrecordsize\fR affects only files created
1182 afterward; existing files are unaffected.
1184 This property can also be referred to by its shortened column name,
1191 \fB\fBrefquota\fR=\fIsize\fR | \fBnone\fR\fR
1195 Limits the amount of space a dataset can consume. This property enforces a hard
1196 limit on the amount of space used. This hard limit does not include space used
1197 by descendents, including file systems and snapshots.
1203 \fB\fBrefreservation\fR=\fIsize\fR | \fBnone\fR\fR
1207 The minimum amount of space guaranteed to a dataset, not including its
1208 descendents. When the amount of space used is below this value, the dataset is
1209 treated as if it were taking up the amount of space specified by
1210 \fBrefreservation\fR. The \fBrefreservation\fR reservation is accounted for in
1211 the parent datasets' space used, and counts against the parent datasets' quotas
1214 If \fBrefreservation\fR is set, a snapshot is only allowed if there is enough
1215 free pool space outside of this reservation to accommodate the current number
1216 of "referenced" bytes in the dataset.
1218 This property can also be referred to by its shortened column name,
1225 \fB\fBreservation\fR=\fIsize\fR | \fBnone\fR\fR
1229 The minimum amount of space guaranteed to a dataset and its descendents. When
1230 the amount of space used is below this value, the dataset is treated as if it
1231 were taking up the amount of space specified by its reservation. Reservations
1232 are accounted for in the parent datasets' space used, and count against the
1233 parent datasets' quotas and reservations.
1235 This property can also be referred to by its shortened column name,
1242 \fB\fBsecondarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR
1246 Controls what is cached in the secondary cache (L2ARC). If this property is set
1247 to \fBall\fR, then both user data and metadata is cached. If this property is
1248 set to \fBnone\fR, then neither user data nor metadata is cached. If this
1249 property is set to \fBmetadata\fR, then only metadata is cached. The default
1256 \fB\fBsetuid\fR=\fBon\fR | \fBoff\fR\fR
1260 Controls whether the set-\fBUID\fR bit is respected for the file system. The
1261 default value is \fBon\fR.
1267 \fB\fBshareiscsi\fR=\fBon\fR | \fBoff\fR\fR
1271 Like the \fBsharenfs\fR property, \fBshareiscsi\fR indicates whether a
1272 \fBZFS\fR volume is exported as an \fBiSCSI\fR target. The acceptable values
1273 for this property are \fBon\fR, \fBoff\fR, and \fBtype=disk\fR. The default
1274 value is \fBoff\fR. In the future, other target types might be supported. For
1275 example, \fBtape\fR.
1277 You might want to set \fBshareiscsi=on\fR for a file system so that all
1278 \fBZFS\fR volumes within the file system are shared by default. However,
1279 setting this property on a file system has no direct effect.
1285 \fB\fBsharesmb\fR=\fBon\fR | \fBoff\fR | \fIopts\fR\fR
1289 Controls whether the file system is shared by using the Solaris \fBCIFS\fR
1290 service, and what options are to be used. A file system with the \fBsharesmb\fR
1291 property set to \fBoff\fR is managed through traditional tools such as
1292 \fBsharemgr\fR(1M). Otherwise, the file system is automatically shared and
1293 unshared with the \fBzfs share\fR and \fBzfs unshare\fR commands. If the
1294 property is set to \fBon\fR, the \fBsharemgr\fR(1M) command is invoked with no
1295 options. Otherwise, the \fBsharemgr\fR(1M) command is invoked with options
1296 equivalent to the contents of this property.
1298 Because \fBSMB\fR shares requires a resource name, a unique resource name is
1299 constructed from the dataset name. The constructed name is a copy of the
1300 dataset name except that the characters in the dataset name, which would be
1301 illegal in the resource name, are replaced with underscore (\fB_\fR)
1302 characters. A pseudo property "name" is also supported that allows you to
1303 replace the data set name with a specified name. The specified name is then
1304 used to replace the prefix dataset in the case of inheritance. For example, if
1305 the dataset \fBdata/home/john\fR is set to \fBname=john\fR, then
1306 \fBdata/home/john\fR has a resource name of \fBjohn\fR. If a child dataset of
1307 \fBdata/home/john/backups\fR, it has a resource name of \fBjohn_backups\fR.
1309 When SMB shares are created, the SMB share name appears as an entry in the
1310 \fB\&.zfs/shares\fR directory. You can use the \fBls\fR or \fBchmod\fR command
1311 to display the share-level ACLs on the entries in this directory.
1313 When the \fBsharesmb\fR property is changed for a dataset, the dataset and any
1314 children inheriting the property are re-shared with the new options, only if
1315 the property was previously set to \fBoff\fR, or if they were shared before the
1316 property was changed. If the new property is set to \fBoff\fR, the file systems
1323 \fB\fBsharenfs\fR=\fBon\fR | \fBoff\fR | \fIopts\fR\fR
1327 Controls whether the file system is shared via \fBNFS\fR, and what options are
1328 used. A file system with a \fBsharenfs\fR property of \fBoff\fR is managed
1329 through traditional tools such as \fBshare\fR(1M), \fBunshare\fR(1M), and
1330 \fBdfstab\fR(4). Otherwise, the file system is automatically shared and
1331 unshared with the \fBzfs share\fR and \fBzfs unshare\fR commands. If the
1332 property is set to \fBon\fR, the \fBshare\fR(1M) command is invoked with no
1333 options. Otherwise, the \fBshare\fR(1M) command is invoked with options
1334 equivalent to the contents of this property.
1336 When the \fBsharenfs\fR property is changed for a dataset, the dataset and any
1337 children inheriting the property are re-shared with the new options, only if
1338 the property was previously \fBoff\fR, or if they were shared before the
1339 property was changed. If the new property is \fBoff\fR, the file systems are
1346 \fB\fBlogbias\fR = \fBlatency\fR | \fBthroughput\fR\fR
1350 Provide a hint to ZFS about handling of synchronous requests in this dataset.
1351 If \fBlogbias\fR is set to \fBlatency\fR (the default), ZFS will use pool log
1352 devices (if configured) to handle the requests at low latency. If \fBlogbias\fR
1353 is set to \fBthroughput\fR, ZFS will not use configured pool log devices. ZFS
1354 will instead optimize synchronous operations for global pool throughput and
1355 efficient use of resources.
1361 \fB\fBsnapdir\fR=\fBhidden\fR | \fBvisible\fR\fR
1365 Controls whether the \fB\&.zfs\fR directory is hidden or visible in the root of
1366 the file system as discussed in the "Snapshots" section. The default value is
1373 \fB\fBsync\fR=\fBdefault\fR | \fBalways\fR | \fBdisabled\fR\fR
1377 Controls the behavior of synchronous requests (e.g. fsync, O_DSYNC).
1378 \fBdefault\fR is the POSIX specified behavior of ensuring all synchronous
1379 requests are written to stable storage and all devices are flushed to ensure
1380 data is not cached by device controllers (this is the default). \fBalways\fR
1381 causes every file system transaction to be written and flushed before its
1382 system call returns. This has a large performance penalty. \fBdisabled\fR
1383 disables synchronous requests. File system transactions are only committed to
1384 stable storage periodically. This option will give the highest performance.
1385 However, it is very dangerous as ZFS would be ignoring the synchronous
1386 transaction demands of applications such as databases or NFS. Administrators
1387 should only use this option when the risks are understood.
1393 \fB\fBversion\fR=\fB1\fR | \fB2\fR | \fBcurrent\fR\fR
1397 The on-disk version of this file system, which is independent of the pool
1398 version. This property can only be set to later supported versions. See the
1399 \fBzfs upgrade\fR command.
1405 \fB\fBvolsize\fR=\fIsize\fR\fR
1409 For volumes, specifies the logical size of the volume. By default, creating a
1410 volume establishes a reservation of equal size. For storage pools with a
1411 version number of 9 or higher, a \fBrefreservation\fR is set instead. Any
1412 changes to \fBvolsize\fR are reflected in an equivalent change to the
1413 reservation (or \fBrefreservation\fR). The \fBvolsize\fR can only be set to a
1414 multiple of \fBvolblocksize\fR, and cannot be zero.
1416 The reservation is kept equal to the volume's logical size to prevent
1417 unexpected behavior for consumers. Without the reservation, the volume could
1418 run out of space, resulting in undefined behavior or data corruption, depending
1419 on how the volume is used. These effects can also occur when the volume size is
1420 changed while it is in use (particularly when shrinking the size). Extreme care
1421 should be used when adjusting the volume size.
1423 Though not recommended, a "sparse volume" (also known as "thin provisioning")
1424 can be created by specifying the \fB-s\fR option to the \fBzfs create -V\fR
1425 command, or by changing the reservation after the volume has been created. A
1426 "sparse volume" is a volume where the reservation is less then the volume size.
1427 Consequently, writes to a sparse volume can fail with \fBENOSPC\fR when the
1428 pool is low on space. For a sparse volume, changes to \fBvolsize\fR are not
1429 reflected in the reservation.
1435 \fB\fBvscan\fR=\fBon\fR | \fBoff\fR\fR
1439 Controls whether regular files should be scanned for viruses when a file is
1440 opened and closed. In addition to enabling this property, the virus scan
1441 service must also be enabled for virus scanning to occur. The default value is
1448 \fB\fBxattr\fR=\fBon\fR | \fBoff\fR\fR
1452 Controls whether extended attributes are enabled for this file system. The
1453 default value is \fBon\fR.
1459 \fB\fBzoned\fR=\fBon\fR | \fBoff\fR\fR
1463 Controls whether the dataset is managed from a non-global zone. See the "Zones"
1464 section for more information. The default value is \fBoff\fR.
1469 The following three properties cannot be changed after the file system is
1470 created, and therefore, should be set when the file system is created. If the
1471 properties are not set with the \fBzfs create\fR or \fBzpool create\fR
1472 commands, these properties are inherited from the parent dataset. If the parent
1473 dataset lacks these properties due to having been created prior to these
1474 features being supported, the new file system will have the default values for
1479 \fB\fBcasesensitivity\fR=\fBsensitive\fR | \fBinsensitive\fR | \fBmixed\fR\fR
1483 Indicates whether the file name matching algorithm used by the file system
1484 should be case-sensitive, case-insensitive, or allow a combination of both
1485 styles of matching. The default value for the \fBcasesensitivity\fR property is
1486 \fBsensitive\fR. Traditionally, UNIX and POSIX file systems have case-sensitive
1489 The \fBmixed\fR value for the \fBcasesensitivity\fR property indicates that the
1490 file system can support requests for both case-sensitive and case-insensitive
1491 matching behavior. Currently, case-insensitive matching behavior on a file
1492 system that supports mixed behavior is limited to the Solaris CIFS server
1493 product. For more information about the \fBmixed\fR value behavior, see the
1494 \fISolaris ZFS Administration Guide\fR.
1500 \fB\fBnormalization\fR = \fBnone\fR | \fBformC\fR | \fBformD\fR | \fBformKC\fR
1505 Indicates whether the file system should perform a \fBunicode\fR normalization
1506 of file names whenever two file names are compared, and which normalization
1507 algorithm should be used. File names are always stored unmodified, names are
1508 normalized as part of any comparison process. If this property is set to a
1509 legal value other than \fBnone\fR, and the \fButf8only\fR property was left
1510 unspecified, the \fButf8only\fR property is automatically set to \fBon\fR. The
1511 default value of the \fBnormalization\fR property is \fBnone\fR. This property
1512 cannot be changed after the file system is created.
1518 \fB\fButf8only\fR=\fBon\fR | \fBoff\fR\fR
1522 Indicates whether the file system should reject file names that include
1523 characters that are not present in the \fBUTF-8\fR character code set. If this
1524 property is explicitly set to \fBoff\fR, the normalization property must either
1525 not be explicitly set or be set to \fBnone\fR. The default value for the
1526 \fButf8only\fR property is \fBoff\fR. This property cannot be changed after the
1527 file system is created.
1532 The \fBcasesensitivity\fR, \fBnormalization\fR, and \fButf8only\fR properties
1533 are also new permissions that can be assigned to non-privileged users by using
1534 the \fBZFS\fR delegated administration feature.
1535 .SS "Temporary Mount Point Properties"
1538 When a file system is mounted, either through \fBmount\fR(1M) for legacy mounts
1539 or the \fBzfs mount\fR command for normal file systems, its mount options are
1540 set according to its properties. The correlation between properties and mount
1541 options is as follows:
1545 PROPERTY MOUNT OPTION
1546 devices devices/nodevices
1549 setuid setuid/nosetuid
1557 In addition, these options can be set on a per-mount basis using the \fB-o\fR
1558 option, without affecting the property that is stored on disk. The values
1559 specified on the command line override the values stored in the dataset. The
1560 \fB-nosuid\fR option is an alias for \fBnodevices,nosetuid\fR. These properties
1561 are reported as "temporary" by the \fBzfs get\fR command. If the properties are
1562 changed while the dataset is mounted, the new setting overrides any temporary
1564 .SS "User Properties"
1567 In addition to the standard native properties, \fBZFS\fR supports arbitrary
1568 user properties. User properties have no effect on \fBZFS\fR behavior, but
1569 applications or administrators can use them to annotate datasets (file systems,
1570 volumes, and snapshots).
1573 User property names must contain a colon (\fB:\fR) character to distinguish
1574 them from native properties. They may contain lowercase letters, numbers, and
1575 the following punctuation characters: colon (\fB:\fR), dash (\fB-\fR), period
1576 (\fB\&.\fR), and underscore (\fB_\fR). The expected convention is that the
1577 property name is divided into two portions such as
1578 \fImodule\fR\fB:\fR\fIproperty\fR, but this namespace is not enforced by
1579 \fBZFS\fR. User property names can be at most 256 characters, and cannot begin
1580 with a dash (\fB-\fR).
1583 When making programmatic use of user properties, it is strongly suggested to
1584 use a reversed \fBDNS\fR domain name for the \fImodule\fR component of property
1585 names to reduce the chance that two independently-developed packages use the
1586 same property name for different purposes. Property names beginning with
1587 \fBcom.sun\fR. are reserved for use by Sun Microsystems.
1590 The values of user properties are arbitrary strings, are always inherited, and
1591 are never validated. All of the commands that operate on properties (\fBzfs
1592 list\fR, \fBzfs get\fR, \fBzfs set\fR, and so forth) can be used to manipulate
1593 both native properties and user properties. Use the \fBzfs inherit\fR command
1594 to clear a user property . If the property is not defined in any parent
1595 dataset, it is removed entirely. Property values are limited to 1024
1597 .SS "ZFS Volumes as Swap or Dump Devices"
1600 During an initial installation a swap device and dump device are created on
1601 \fBZFS\fR volumes in the \fBZFS\fR root pool. By default, the swap area size is
1602 based on 1/2 the size of physical memory up to 2 Gbytes. The size of the dump
1603 device depends on the kernel's requirements at installation time. Separate
1604 \fBZFS\fR volumes must be used for the swap area and dump devices. Do not swap
1605 to a file on a \fBZFS\fR file system. A \fBZFS\fR swap file configuration is
1609 If you need to change your swap area or dump device after the system is
1610 installed or upgraded, use the \fBswap\fR(1M) and \fBdumpadm\fR(1M) commands.
1611 If you need to change the size of your swap area or dump device, see the
1612 \fISolaris ZFS Administration Guide\fR.
1616 All subcommands that modify state are logged persistently to the pool in their
1625 Displays a help message.
1631 \fB\fBzfs create\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]...
1636 Creates a new \fBZFS\fR file system. The file system is automatically mounted
1637 according to the \fBmountpoint\fR property inherited from the parent.
1645 Creates all the non-existing parent datasets. Datasets created in this manner
1646 are automatically mounted according to the \fBmountpoint\fR property inherited
1647 from their parent. Any property specified on the command line using the
1648 \fB-o\fR option is ignored. If the target filesystem already exists, the
1649 operation completes successfully.
1655 \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1659 Sets the specified property as if the command \fBzfs set\fR
1660 \fIproperty\fR=\fIvalue\fR was invoked at the same time the dataset was
1661 created. Any editable \fBZFS\fR property can also be set at creation time.
1662 Multiple \fB-o\fR options can be specified. An error results if the same
1663 property is specified in multiple \fB-o\fR options.
1671 \fB\fBzfs create\fR [\fB-ps\fR] [\fB-b\fR \fIblocksize\fR] [\fB-o\fR
1672 \fIproperty\fR=\fIvalue\fR]... \fB-V\fR \fIsize\fR \fIvolume\fR\fR
1676 Creates a volume of the given size. The volume is exported as a block device in
1677 \fB/dev/zvol/{dsk,rdsk}/\fR\fIpath\fR, where \fIpath\fR is the name of the
1678 volume in the \fBZFS\fR namespace. The size represents the logical size as
1679 exported by the device. By default, a reservation of equal size is created.
1681 \fIsize\fR is automatically rounded up to the nearest 128 Kbytes to ensure that
1682 the volume has an integral number of blocks regardless of \fIblocksize\fR.
1690 Creates all the non-existing parent datasets. Datasets created in this manner
1691 are automatically mounted according to the \fBmountpoint\fR property inherited
1692 from their parent. Any property specified on the command line using the
1693 \fB-o\fR option is ignored. If the target filesystem already exists, the
1694 operation completes successfully.
1704 Creates a sparse volume with no reservation. See \fBvolsize\fR in the Native
1705 Properties section for more information about sparse volumes.
1711 \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1715 Sets the specified property as if the \fBzfs set\fR \fIproperty\fR=\fIvalue\fR
1716 command was invoked at the same time the dataset was created. Any editable
1717 \fBZFS\fR property can also be set at creation time. Multiple \fB-o\fR options
1718 can be specified. An error results if the same property is specified in
1719 multiple \fB-o\fR options.
1725 \fB\fB-b\fR \fIblocksize\fR\fR
1729 Equivalent to \fB-o\fR \fBvolblocksize\fR=\fIblocksize\fR. If this option is
1730 specified in conjunction with \fB-o\fR \fBvolblocksize\fR, the resulting
1731 behavior is undefined.
1739 \fBzfs destroy\fR [\fB-fnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR
1743 Destroys the given dataset. By default, the command unshares any file systems
1744 that are currently shared, unmounts any file systems that are currently
1745 mounted, and refuses to destroy a dataset that has active dependents (children
1754 Recursively destroy all children.
1764 Recursively destroy all dependents, including cloned file systems outside the
1775 Force an unmount of any file systems using the \fBunmount -f\fR command. This
1776 option has no effect on non-file systems or unmounted file systems.
1786 Do a dry-run ("No-op") deletion. No data will be deleted. This is
1787 useful in conjunction with the \fB-v\fR or \fB-p\fR flags to determine what
1788 data would be deleted.
1798 Print machine-parsable verbose information about the deleted data.
1808 Print verbose information about the deleted data.
1811 Extreme care should be taken when applying either the \fB-r\fR or the \fB-R\fR
1812 options, as they can destroy large portions of a pool and cause unexpected
1813 behavior for mounted file systems in use.
1819 \fBzfs destroy\fR [\fB-dnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR@\fIsnap\fR[%\fIsnap\fR][,\fIsnap\fR[%\fIsnap\fR]]...
1823 The given snapshots are destroyed immediately if and only if the \fBzfs
1824 destroy\fR command without the \fB-d\fR option would have destroyed it. Such
1825 immediate destruction would occur, for example, if the snapshot had no clones
1826 and the user-initiated reference count were zero.
1828 If a snapshot does not qualify for immediate destruction, it is marked for
1829 deferred deletion. In this state, it exists as a usable, visible snapshot until
1830 both of the preconditions listed above are met, at which point it is destroyed.
1832 An inclusive range of snapshots may be specified by separating the
1833 first and last snapshots with a percent sign.
1834 The first and/or last snapshots may be left blank, in which case the
1835 filesystem's oldest or newest snapshot will be implied.
1838 (or ranges of snapshots) of the same filesystem or volume may be specified
1839 in a comma-separated list of snapshots.
1840 Only the snapshot's short name (the
1841 part after the \fB@\fR) should be specified when using a range or
1842 comma-separated list to identify multiple snapshots.
1850 Defer snapshot deletion.
1860 Destroy (or mark for deferred deletion) all snapshots with this name in
1861 descendent file systems.
1871 Recursively destroy all clones of these snapshots, including the clones,
1872 snapshots, and children. If this flag is specified, the \fB-d\fR flag will
1883 Do a dry-run ("No-op") deletion. No data will be deleted. This is
1884 useful in conjunction with the \fB-v\fR or \fB-p\fR flags to determine what
1885 data would be deleted.
1895 Print machine-parsable verbose information about the deleted data.
1905 Print verbose information about the deleted data.
1909 Extreme care should be taken when applying either the \fB-r\fR or the \fB-R\fR
1910 options, as they can destroy large portions of a pool and cause unexpected
1911 behavior for mounted file systems in use.
1917 \fB\fBzfs snapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]...
1918 \fIfilesystem@snapname\fR|\fIvolume@snapname\fR\fR...
1922 Creates snapshots with the given names. All previous modifications by
1923 successful system calls to the file system are part of the snapshots.
1924 Snapshots are taken atomically, so that all snapshots correspond to the same
1925 moment in time. See the "Snapshots" section for details.
1933 Recursively create snapshots of all descendent datasets
1939 \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1943 Sets the specified property; see \fBzfs create\fR for details.
1951 \fB\fBzfs rollback\fR [\fB-rRf\fR] \fIsnapshot\fR\fR
1955 Roll back the given dataset to a previous snapshot. When a dataset is rolled
1956 back, all data that has changed since the snapshot is discarded, and the
1957 dataset reverts to the state at the time of the snapshot. By default, the
1958 command refuses to roll back to a snapshot other than the most recent one. In
1959 order to do so, all intermediate snapshots must be destroyed by specifying the
1962 The \fB-rR\fR options do not recursively destroy the child snapshots of a
1963 recursive snapshot. Only the top-level recursive snapshot is destroyed by
1964 either of these options. To completely roll back a recursive snapshot, you must
1965 rollback the individual child snapshots.
1973 Recursively destroy any snapshots more recent than the one specified.
1983 Recursively destroy any more recent snapshots, as well as any clones of those
1994 Used with the \fB-R\fR option to force an unmount of any clone file systems
1995 that are to be destroyed.
2003 \fB\fBzfs clone\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]...
2004 \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR\fR
2008 Creates a clone of the given snapshot. See the "Clones" section for details.
2009 The target dataset can be located anywhere in the \fBZFS\fR hierarchy, and is
2010 created as the same type as the original.
2018 Creates all the non-existing parent datasets. Datasets created in this manner
2019 are automatically mounted according to the \fBmountpoint\fR property inherited
2020 from their parent. If the target filesystem or volume already exists, the
2021 operation completes successfully.
2027 \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
2031 Sets the specified property; see \fBzfs create\fR for details.
2039 \fB\fBzfs promote\fR \fIclone-filesystem\fR\fR
2043 Promotes a clone file system to no longer be dependent on its "origin"
2044 snapshot. This makes it possible to destroy the file system that the clone was
2045 created from. The clone parent-child dependency relationship is reversed, so
2046 that the origin file system becomes a clone of the specified file system.
2048 The snapshot that was cloned, and any snapshots previous to this snapshot, are
2049 now owned by the promoted clone. The space they use moves from the origin file
2050 system to the promoted clone, so enough space must be available to accommodate
2051 these snapshots. No new space is consumed by this operation, but the space
2052 accounting is adjusted. The promoted clone must not have any conflicting
2053 snapshot names of its own. The \fBrename\fR subcommand can be used to rename
2054 any conflicting snapshots.
2060 \fB\fBzfs rename\fR [\fB-f\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
2064 \fB\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
2068 \fB\fBzfs rename\fR [\fB-fp\fR] \fIfilesystem\fR|\fIvolume\fR
2069 \fIfilesystem\fR|\fIvolume\fR\fR
2073 Renames the given dataset. The new target can be located anywhere in the
2074 \fBZFS\fR hierarchy, with the exception of snapshots. Snapshots can only be
2075 renamed within the parent file system or volume. When renaming a snapshot, the
2076 parent file system of the snapshot does not need to be specified as part of the
2077 second argument. Renamed file systems can inherit new mount points, in which
2078 case they are unmounted and remounted at the new mount point.
2086 Creates all the nonexistent parent datasets. Datasets created in this manner
2087 are automatically mounted according to the \fBmountpoint\fR property inherited
2098 Force unmount any filesystems that need to be unmounted in the process.
2106 \fB\fBzfs rename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR\fR
2110 Recursively rename the snapshots of all descendent datasets. Snapshots are the
2111 only dataset that can be renamed recursively.
2117 \fB\fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-H\fR] [\fB-o\fR
2118 \fIproperty\fR[,\fIproperty\fR]...] [ \fB-t\fR \fItype\fR[,\fItype\fR]...] [ \fB-s\fR
2119 \fIproperty\fR ]... [ \fB-S\fR \fIproperty\fR ]...
2120 [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR]...\fR
2124 Lists the property information for the given datasets in tabular form. If
2125 specified, you can list property information by the absolute pathname or the
2126 relative pathname. By default, all file systems and volumes are displayed.
2127 Snapshots are displayed if the \fBlistsnaps\fR property is \fBon\fR (the
2128 default is \fBoff\fR) . The following fields are displayed,
2129 \fBname,used,available,referenced,mountpoint\fR.
2137 Used for scripting mode. Do not print headers and separate fields by a single
2138 tab instead of arbitrary white space.
2148 Recursively display any children of the dataset on the command line.
2154 \fB\fB-d\fR \fIdepth\fR\fR
2158 Recursively display any children of the dataset, limiting the recursion to
2159 \fIdepth\fR. A depth of \fB1\fR will display only the dataset and its direct
2166 \fB\fB-o\fR \fIproperty\fR\fR
2170 A comma-separated list of properties to display. The property must be:
2175 One of the properties described in the "Native Properties" section
2187 The value \fBname\fR to display the dataset name
2193 The value \fBspace\fR to display space usage properties on file systems and
2194 volumes. This is a shortcut for specifying \fB-o
2195 name,avail,used,usedsnap,usedds,usedrefreserv,usedchild\fR \fB-t
2196 filesystem,volume\fR syntax.
2203 \fB\fB-s\fR \fIproperty\fR\fR
2207 A property for sorting the output by column in ascending order based on the
2208 value of the property. The property must be one of the properties described in
2209 the "Properties" section, or the special value \fBname\fR to sort by the
2210 dataset name. Multiple properties can be specified at one time using multiple
2211 \fB-s\fR property options. Multiple \fB-s\fR options are evaluated from left to
2212 right in decreasing order of importance.
2214 The following is a list of sorting criteria:
2219 Numeric types sort in numeric order.
2225 String types sort in alphabetical order.
2231 Types inappropriate for a row sort that row to the literal bottom, regardless
2232 of the specified ordering.
2238 If no sorting options are specified the existing behavior of \fBzfs list\fR is
2246 \fB\fB-S\fR \fIproperty\fR\fR
2250 Same as the \fB-s\fR option, but sorts by property in descending order.
2256 \fB\fB-t\fR \fItype\fR\fR
2260 A comma-separated list of types to display, where \fItype\fR is one of
2261 \fBfilesystem\fR, \fBsnapshot\fR , \fBvolume\fR, or \fBall\fR. For example,
2262 specifying \fB-t snapshot\fR displays only snapshots.
2270 \fB\fBzfs set\fR \fIproperty\fR=\fIvalue\fR
2271 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR...\fR
2275 Sets the property to the given value for each dataset. Only some properties can
2276 be edited. See the "Properties" section for more information on what properties
2277 can be set and acceptable values. Numeric values can be specified as exact
2278 values, or in a human-readable form with a suffix of \fBB\fR, \fBK\fR, \fBM\fR,
2279 \fBG\fR, \fBT\fR, \fBP\fR, \fBE\fR, \fBZ\fR (for bytes, kilobytes, megabytes,
2280 gigabytes, terabytes, petabytes, exabytes, or zettabytes, respectively). User
2281 properties can be set on snapshots. For more information, see the "User
2282 Properties" section.
2288 \fB\fBzfs get\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-Hp\fR] [\fB-o\fR
2289 \fIfield\fR[,\fIfield\fR]... [\fB-t\fR \fItype\fR[,\fItype\fR]...] [\fB-s\fR \fIsource\fR[,\fIsource\fR]... \fBall\fR |
2290 \fIproperty\fR[,\fIproperty\fR]... \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR...\fR
2294 Displays properties for the given datasets. If no datasets are specified, then
2295 the command displays properties for all datasets on the system. For each
2296 property, the following columns are displayed:
2301 property Property name
2302 value Property value
2303 source Property source. Can either be local, default,
2304 temporary, inherited, or none (-).
2309 All columns are displayed by default, though this can be controlled by using
2310 the \fB-o\fR option. This command takes a comma-separated list of properties as
2311 described in the "Native Properties" and "User Properties" sections.
2313 The special value \fBall\fR can be used to display all properties that apply to
2314 the given dataset's type (filesystem, volume, or snapshot).
2322 Recursively display properties for any children.
2328 \fB\fB-d\fR \fIdepth\fR\fR
2332 Recursively display any children of the dataset, limiting the recursion to
2333 \fIdepth\fR. A depth of \fB1\fR will display only the dataset and its direct
2344 Display output in a form more easily parsed by scripts. Any headers are
2345 omitted, and fields are explicitly separated by a single tab instead of an
2346 arbitrary amount of space.
2352 \fB\fB-o\fR \fIfield\fR\fR
2356 A comma-separated list of columns to display. \fBname,property,value,source\fR
2357 is the default value.
2363 \fB\fB-s\fR \fIsource\fR\fR
2367 A comma-separated list of sources to display. Those properties coming from a
2368 source other than those in this list are ignored. Each source must be one of
2369 the following: \fBlocal,default,inherited,temporary,none\fR. The default value
2380 Display numbers in parseable (exact) values.
2388 \fB\fBzfs inherit\fR [\fB-r\fR] \fIproperty\fR
2389 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR...\fR
2393 Clears the specified property, causing it to be inherited from an ancestor. If
2394 no ancestor has the property set, then the default value is used. See the
2395 "Properties" section for a listing of default values, and details on which
2396 properties can be inherited.
2404 Recursively inherit the given property for all children.
2412 \fB\fBzfs upgrade\fR [\fB-v\fR]\fR
2416 Displays a list of file systems that are not the most recent version.
2422 \fB\fBzfs upgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] [\fB-a\fR |
2423 \fIfilesystem\fR]\fR
2427 Upgrades file systems to a new on-disk version. Once this is done, the file
2428 systems will no longer be accessible on systems running older versions of the
2429 software. \fBzfs send\fR streams generated from new snapshots of these file
2430 systems cannot be accessed on systems running older versions of the software.
2432 In general, the file system version is independent of the pool version. See
2433 \fBzpool\fR(1M) for information on the \fBzpool upgrade\fR command.
2435 In some cases, the file system version and the pool version are interrelated
2436 and the pool version must be upgraded before the file system version can be
2445 Upgrade all file systems on all imported pools.
2451 \fB\fIfilesystem\fR\fR
2455 Upgrade the specified file system.
2465 Upgrade the specified file system and all descendent file systems
2471 \fB\fB-V\fR \fIversion\fR\fR
2475 Upgrade to the specified \fIversion\fR. If the \fB-V\fR flag is not specified,
2476 this command upgrades to the most recent version. This option can only be used
2477 to increase the version number, and only up to the most recent version
2478 supported by this software.
2486 \fBzfs\fR \fBuserspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,\fIfield\fR]...]
2487 [\fB-s\fR \fIfield\fR]...
2488 [\fB-S\fR \fIfield\fR]...
2489 [\fB-t\fR \fItype\fR[,\fItype\fR]...] \fIfilesystem\fR|\fIsnapshot\fR
2493 Displays space consumed by, and quotas on, each user in the specified
2494 filesystem or snapshot. This corresponds to the \fBuserused@\fR\fIuser\fR and
2495 \fBuserquota@\fR\fIuser\fR properties.
2503 Print numeric ID instead of user/group name.
2513 Do not print headers, use tab-delimited output.
2523 Use exact (parsable) numeric output.
2529 \fB\fB-o\fR \fIfield\fR[,\fIfield\fR]...\fR
2533 Display only the specified fields from the following
2534 set: \fBtype, name, used, quota\fR. The default is to display all fields.
2540 \fB\fB-s\fR \fIfield\fR\fR
2544 Sort output by this field. The \fIs\fR and \fIS\fR flags may be specified
2545 multiple times to sort first by one field, then by another. The default is
2546 \fB-s type\fR \fB-s name\fR.
2552 \fB\fB-S\fR \fIfield\fR\fR
2556 Sort by this field in reverse order. See \fB-s\fR.
2562 \fB\fB-t\fR \fItype\fR[,\fItype\fR]...\fR
2566 Print only the specified types from the following
2567 set: \fBall, posixuser, smbuser, posixgroup, smbgroup\fR. The default
2568 is \fB-t posixuser,smbuser\fR. The default can be changed to include group
2579 Translate SID to POSIX ID. The POSIX ID may be ephemeral if no mapping exists.
2580 Normal POSIX interfaces (for example, \fBstat\fR(2), \fBls\fR \fB-l\fR) perform
2581 this translation, so the \fB-i\fR option allows the output from \fBzfs
2582 userspace\fR to be compared directly with those utilities. However, \fB-i\fR
2583 may lead to confusion if some files were created by an SMB user before a
2584 SMB-to-POSIX name mapping was established. In such a case, some files will be owned
2585 by the SMB entity and some by the POSIX entity. However, the \fB-i\fR option
2586 will report that the POSIX entity has the total usage and quota for both.
2594 \fBzfs\fR \fBgroupspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,\fIfield\fR]...]
2595 [\fB-s\fR \fIfield\fR]...
2596 [\fB-S\fR \fIfield\fR]...
2597 [\fB-t\fR \fItype\fR[,\fItype\fR]...] \fIfilesystem\fR|\fIsnapshot\fR
2601 Displays space consumed by, and quotas on, each group in the specified
2602 filesystem or snapshot. This subcommand is identical to \fBzfs userspace\fR,
2603 except that the default types to display are \fB-t posixgroup,smbgroup\fR.
2609 \fB\fBzfs mount\fR\fR
2613 Displays all \fBZFS\fR file systems currently mounted.
2619 \fB\fBzfs mount\fR [\fB-vO\fR] [\fB-o\fR \fIoptions\fR] \fB-a\fR |
2624 Mounts \fBZFS\fR file systems. Invoked automatically as part of the boot
2629 \fB\fB-o\fR \fIoptions\fR\fR
2633 An optional, comma-separated list of mount options to use temporarily for the
2634 duration of the mount. See the "Temporary Mount Point Properties" section for
2645 Perform an overlay mount. See \fBmount\fR(1M) for more information.
2655 Report mount progress.
2665 Mount all available \fBZFS\fR file systems. Invoked automatically as part of
2672 \fB\fIfilesystem\fR\fR
2676 Mount the specified filesystem.
2684 \fB\fBzfs unmount\fR [\fB-f\fR] \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR
2688 Unmounts currently mounted \fBZFS\fR file systems. Invoked automatically as
2689 part of the shutdown process.
2697 Forcefully unmount the file system, even if it is currently in use.
2707 Unmount all available \fBZFS\fR file systems. Invoked automatically as part of
2714 \fB\fIfilesystem\fR|\fImountpoint\fR\fR
2718 Unmount the specified filesystem. The command can also be given a path to a
2719 \fBZFS\fR file system mount point on the system.
2727 \fB\fBzfs share\fR \fB-a\fR | \fIfilesystem\fR\fR
2731 Shares available \fBZFS\fR file systems.
2739 Share all available \fBZFS\fR file systems. Invoked automatically as part of
2746 \fB\fIfilesystem\fR\fR
2750 Share the specified filesystem according to the \fBsharenfs\fR and
2751 \fBsharesmb\fR properties. File systems are shared when the \fBsharenfs\fR or
2752 \fBsharesmb\fR property is set.
2760 \fB\fBzfs unshare\fR \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR
2764 Unshares currently shared \fBZFS\fR file systems. This is invoked automatically
2765 as part of the shutdown process.
2773 Unshare all available \fBZFS\fR file systems. Invoked automatically as part of
2780 \fB\fIfilesystem\fR|\fImountpoint\fR\fR
2784 Unshare the specified filesystem. The command can also be given a path to a
2785 \fBZFS\fR file system shared on the system.
2793 \fBzfs send\fR [\fB-DnPpRv\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
2797 Creates a stream representation of the second \fIsnapshot\fR, which is written
2798 to standard output. The output can be redirected to a file or to a different
2799 system (for example, using \fBssh\fR(1). By default, a full stream is
2804 \fB\fB-i\fR \fIsnapshot\fR\fR
2808 Generate an incremental stream from the first \fIsnapshot\fR to the second
2809 \fIsnapshot\fR. The incremental source (the first \fIsnapshot\fR) can be
2810 specified as the last component of the snapshot name (for example, the part
2811 after the \fB@\fR), and it is assumed to be from the same file system as the
2812 second \fIsnapshot\fR.
2814 If the destination is a clone, the source may be the origin snapshot, which
2815 must be fully specified (for example, \fBpool/fs@origin\fR, not just
2822 \fB\fB-I\fR \fIsnapshot\fR\fR
2826 Generate a stream package that sends all intermediary snapshots from the first
2827 snapshot to the second snapshot. For example, \fB-I @a fs@d\fR is similar to
2828 \fB-i @a fs@b; -i @b fs@c; -i @c fs@d\fR. The incremental source snapshot may
2829 be specified as with the \fB-i\fR option.
2839 Generate a replication stream package, which will replicate the specified
2840 filesystem, and all descendent file systems, up to the named snapshot. When
2841 received, all properties, snapshots, descendent file systems, and clones are
2844 If the \fB-i\fR or \fB-I\fR flags are used in conjunction with the \fB-R\fR
2845 flag, an incremental replication stream is generated. The current values of
2846 properties, and current snapshot and file system names are set when the stream
2847 is received. If the \fB-F\fR flag is specified when this stream is received,
2848 snapshots and file systems that do not exist on the sending side are destroyed.
2858 Generate a deduplicated stream. Blocks which would have been sent multiple
2859 times in the send stream will only be sent once. The receiving system must
2860 also support this feature to recieve a deduplicated stream. This flag can
2861 be used regardless of the dataset's \fBdedup\fR property, but performance
2862 will be much better if the filesystem uses a dedup-capable checksum (eg.
2873 Include the dataset's properties in the stream. This flag is implicit when
2874 \fB-R\fR is specified. The receiving system must also support this feature.
2884 Do a dry-run ("No-op") send. Do not generate any actual send data. This is
2885 useful in conjunction with the \fB-v\fR or \fB-P\fR flags to determine what
2896 Print machine-parsable verbose information about the stream package generated.
2906 Print verbose information about the stream package generated. This information
2907 includes a per-second report of how much data has been sent.
2910 The format of the stream is committed. You will be able to receive your streams
2911 on future versions of \fBZFS\fR.
2917 \fB\fBzfs receive\fR [\fB-vnFu\fR]
2918 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
2922 \fB\fBzfs receive\fR [\fB-vnFu\fR] [\fB-d\fR|\fB-e\fR] \fIfilesystem\fR\fR
2926 Creates a snapshot whose contents are as specified in the stream provided on
2927 standard input. If a full stream is received, then a new file system is created
2928 as well. Streams are created using the \fBzfs send\fR subcommand, which by
2929 default creates a full stream. \fBzfs recv\fR can be used as an alias for
2932 If an incremental stream is received, then the destination file system must
2933 already exist, and its most recent snapshot must match the incremental stream's
2934 source. For \fBzvols\fR, the destination device link is destroyed and
2935 recreated, which means the \fBzvol\fR cannot be accessed during the
2936 \fBreceive\fR operation.
2938 When a snapshot replication package stream that is generated by using the
2939 \fBzfs send\fR \fB-R\fR command is received, any snapshots that do not exist
2940 on the sending location are destroyed by using the \fBzfs destroy\fR \fB-d\fR
2943 The name of the snapshot (and file system, if a full stream is received) that
2944 this subcommand creates depends on the argument type and the use of the
2945 \fB-d\fR or \fB-e\fR options.
2947 If the argument is a snapshot name, the specified \fIsnapshot\fR is created. If
2948 the argument is a file system or volume name, a snapshot with the same name as
2949 the sent snapshot is created within the specified \fIfilesystem\fR or
2950 \fIvolume\fR. If neither of the \fB-d\fR or \fB-e\fR options are specified,
2951 the provided target snapshot name is used exactly as provided.
2953 The \fB-d\fR and \fB-e\fR options cause the file system name of the target
2954 snapshot to be determined by appending a portion of the sent snapshot's name to
2955 the specified target \fIfilesystem\fR. If the \fB-d\fR option is specified, all
2956 but the first element of the sent snapshot's file system path (usually the
2957 pool name) is used and any required intermediate file systems within the
2958 specified one are created. If the \fB-e\fR option is specified, then only the
2959 last element of the sent snapshot's file system name (i.e. the name of the
2960 source file system itself) is used as the target file system name.
2968 Discard the first element of the sent snapshot's file system name, using
2969 the remaining elements to determine the name of the target file system for
2970 the new snapshot as described in the paragraph above.
2980 Discard all but the last element of the sent snapshot's file system name,
2981 using that element to determine the name of the target file system for
2982 the new snapshot as described in the paragraph above.
2992 File system that is associated with the received stream is not mounted.
3002 Print verbose information about the stream and the time required to perform the
3013 Do not actually receive the stream. This can be useful in conjunction with the
3014 \fB-v\fR option to verify the name the receive operation would use.
3024 Force a rollback of the file system to the most recent snapshot before
3025 performing the receive operation. If receiving an incremental replication
3026 stream (for example, one generated by \fBzfs send -R -[iI]\fR), destroy
3027 snapshots and file systems that do not exist on the sending side.
3035 \fB\fBzfs allow\fR \fIfilesystem\fR | \fIvolume\fR\fR
3039 Displays permissions that have been delegated on the specified filesystem or
3040 volume. See the other forms of \fBzfs allow\fR for more information.
3046 \fB\fBzfs allow\fR [\fB-ldug\fR] \fIuser\fR|\fIgroup\fR[,\fIuser\fR|\fIgroup\fR]...
3047 \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]... \fIfilesystem\fR|\fIvolume\fR\fR
3051 \fB\fBzfs allow\fR [\fB-ld\fR] \fB-e\fR|\fBeveryone\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...
3052 \fIfilesystem\fR|\fIvolume\fR\fR
3056 Delegates \fBZFS\fR administration permission for the file systems to
3057 non-privileged users.
3061 [\fB-ug\fR] \fIuser\fR|\fIgroup\fR[,\fIuser\fR|\fIgroup\fR]...
3065 Specifies to whom the permissions are delegated. Multiple entities can be
3066 specified as a comma-separated list. If neither of the \fB-ug\fR options are
3067 specified, then the argument is interpreted preferentially as the keyword
3068 \fBeveryone,\fR then as a user name, and lastly as a group name. To specify a user
3069 or group named "everyone", use the \fB-u\fR or \fB-g\fR options. To specify a
3070 group with the same name as a user, use the \fB-g\fR options.
3076 \fB-e\fR|\fBeveryone\fR
3080 Specifies that the permissions be delegated to everyone.
3086 \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...
3090 The permissions to delegate. Multiple permissions
3091 may be specified as a comma-separated list. Permission names are the same as
3092 \fBZFS\fR subcommand and property names. See the property list below. Property
3093 set names, which begin with an at sign (\fB@\fR) , may be specified. See the
3094 \fB-s\fR form below for details.
3100 [\fB-ld\fR] \fIfilesystem\fR|\fIvolume\fR
3104 Specifies where the permissions are delegated. If neither of the \fB-ld\fR
3105 options are specified, or both are, then the permissions are allowed for the
3106 file system or volume, and all of its descendents. If only the \fB-l\fR option
3107 is used, then is allowed "locally" only for the specified file system. If only
3108 the \fB-d\fR option is used, then is allowed only for the descendent file
3116 Permissions are generally the ability to use a \fBZFS\fR subcommand or change a
3117 \fBZFS\fR property. The following permissions are available:
3122 allow subcommand Must also have the permission that is being
3124 clone subcommand Must also have the 'create' ability and 'mount'
3125 ability in the origin file system
3126 create subcommand Must also have the 'mount' ability
3127 destroy subcommand Must also have the 'mount' ability
3128 diff subcommand Allows lookup of paths within a dataset
3129 given an object number, and the ability to
3130 create snapshots necessary to 'zfs diff'.
3131 mount subcommand Allows mount/umount of ZFS datasets
3132 promote subcommand Must also have the 'mount'
3133 and 'promote' ability in the origin file system
3134 receive subcommand Must also have the 'mount' and 'create' ability
3135 rename subcommand Must also have the 'mount' and 'create'
3136 ability in the new parent
3137 rollback subcommand Must also have the 'mount' ability
3139 share subcommand Allows sharing file systems over NFS or SMB
3141 snapshot subcommand Must also have the 'mount' ability
3142 groupquota other Allows accessing any groupquota@... property
3143 groupused other Allows reading any groupused@... property
3144 userprop other Allows changing any user property
3145 userquota other Allows accessing any userquota@... property
3146 userused other Allows reading any userused@... property
3152 casesensitivity property
3154 compression property
3160 normalization property
3161 primarycache property
3166 refreservation property
3167 reservation property
3168 secondarycache property
3176 volblocksize property
3188 \fB\fBzfs allow\fR \fB-c\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...
3189 \fIfilesystem\fR|\fIvolume\fR\fR
3193 Sets "create time" permissions. These permissions are granted (locally) to the
3194 creator of any newly-created descendent file system.
3200 \fB\fBzfs allow\fR \fB-s\fR @\fIsetname\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...
3201 \fIfilesystem\fR|\fIvolume\fR\fR
3205 Defines or adds permissions to a permission set. The set can be used by other
3206 \fBzfs allow\fR commands for the specified file system and its descendents.
3207 Sets are evaluated dynamically, so changes to a set are immediately reflected.
3208 Permission sets follow the same naming restrictions as ZFS file systems, but
3209 the name must begin with an "at sign" (\fB@\fR), and can be no more than 64
3216 \fB\fBzfs unallow\fR [\fB-rldug\fR] \fIuser\fR|\fIgroup\fR[,\fIuser\fR|\fIgroup\fR]...
3217 [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...] \fIfilesystem\fR|\fIvolume\fR\fR
3221 \fB\fBzfs unallow\fR [\fB-rld\fR] \fB-e\fR|\fBeveryone\fR [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...]
3222 \fIfilesystem\fR|\fIvolume\fR\fR
3226 \fB\fBzfs unallow\fR [\fB-r\fR] \fB-c\fR [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...]\fR
3230 \fB\fIfilesystem\fR|\fIvolume\fR\fR
3234 Removes permissions that were granted with the \fBzfs allow\fR command. No
3235 permissions are explicitly denied, so other permissions granted are still in
3236 effect. For example, if the permission is granted by an ancestor. If no
3237 permissions are specified, then all permissions for the specified \fIuser\fR,
3238 \fIgroup\fR, or everyone are removed. Specifying \fBeveryone\fR (or using the
3239 \fB-e\fR option) only removes the permissions that were granted to everyone,
3240 not all permissions for every user and group. See the \fBzfs allow\fR command
3241 for a description of the \fB-ldugec\fR options.
3249 Recursively remove the permissions from this file system and all descendents.
3257 \fB\fBzfs unallow\fR [\fB-r\fR] \fB-s\fR @\fIsetname\fR
3258 [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...]\fR
3262 \fB\fIfilesystem\fR|\fIvolume\fR\fR
3266 Removes permissions from a permission set. If no permissions are specified,
3267 then all permissions are removed, thus removing the set entirely.
3273 \fB\fBzfs hold\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR
3277 Adds a single reference, named with the \fItag\fR argument, to the specified
3278 snapshot or snapshots. Each snapshot has its own tag namespace, and tags must
3279 be unique within that space.
3281 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
3282 \fBzfs destroy\fR command return \fBEBUSY\fR.
3290 Specifies that a hold with the given tag is applied recursively to the
3291 snapshots of all descendent file systems.
3299 \fB\fBzfs holds\fR [\fB-r\fR] \fIsnapshot\fR...\fR
3303 Lists all existing user references for the given snapshot or snapshots.
3311 Lists the holds that are set on the named descendent snapshots, in addition to
3312 listing the holds on the named snapshot.
3320 \fB\fBzfs release\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR
3324 Removes a single reference, named with the \fItag\fR argument, from the
3325 specified snapshot or snapshots. The tag must already exist for each snapshot.
3327 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
3328 \fBzfs destroy\fR command return \fBEBUSY\fR.
3336 Recursively releases a hold with the given tag on the snapshots of all
3337 descendent file systems.
3343 \fBzfs diff\fR [\fB-FHt\fR] \fIsnapshot\fR \fIsnapshot|filesystem\fR
3347 Display the difference between a snapshot of a given filesystem and another
3348 snapshot of that filesystem from a later time or the current contents of the
3349 filesystem. The first column is a character indicating the type of change,
3350 the other columns indicate pathname, new pathname (in case of rename), change
3351 in link count, and optionally file type and/or change time.
3353 The types of change are:
3356 - The path has been removed
3357 + The path has been created
3358 M The path has been modified
3359 R The path has been renamed
3369 Display an indication of the type of file, in a manner similar to the \fB-F\fR
3370 option of \fBls\fR(1).
3392 Give more parseable tab-separated output, without header lines and without arrows.
3401 Display the path's inode change time as the first column of output.
3406 \fBExample 1 \fRCreating a ZFS File System Hierarchy
3409 The following commands create a file system named \fBpool/home\fR and a file
3410 system named \fBpool/home/bob\fR. The mount point \fB/export/home\fR is set for
3411 the parent file system, and is automatically inherited by the child file
3417 # \fBzfs create pool/home\fR
3418 # \fBzfs set mountpoint=/export/home pool/home\fR
3419 # \fBzfs create pool/home/bob\fR
3425 \fBExample 2 \fRCreating a ZFS Snapshot
3428 The following command creates a snapshot named \fByesterday\fR. This snapshot
3429 is mounted on demand in the \fB\&.zfs/snapshot\fR directory at the root of the
3430 \fBpool/home/bob\fR file system.
3435 # \fBzfs snapshot pool/home/bob@yesterday\fR
3441 \fBExample 3 \fRCreating and Destroying Multiple Snapshots
3444 The following command creates snapshots named \fByesterday\fR of
3445 \fBpool/home\fR and all of its descendent file systems. Each snapshot is
3446 mounted on demand in the \fB\&.zfs/snapshot\fR directory at the root of its
3447 file system. The second command destroys the newly created snapshots.
3452 # \fBzfs snapshot -r pool/home@yesterday\fR
3453 # \fBzfs destroy -r pool/home@yesterday\fR
3459 \fBExample 4 \fRDisabling and Enabling File System Compression
3462 The following command disables the \fBcompression\fR property for all file
3463 systems under \fBpool/home\fR. The next command explicitly enables
3464 \fBcompression\fR for \fBpool/home/anne\fR.
3469 # \fBzfs set compression=off pool/home\fR
3470 # \fBzfs set compression=on pool/home/anne\fR
3476 \fBExample 5 \fRListing ZFS Datasets
3479 The following command lists all active file systems and volumes in the system.
3480 Snapshots are displayed if the \fBlistsnaps\fR property is \fBon\fR. The
3481 default is \fBoff\fR. See \fBzpool\fR(1M) for more information on pool
3488 NAME USED AVAIL REFER MOUNTPOINT
3489 pool 450K 457G 18K /pool
3490 pool/home 315K 457G 21K /export/home
3491 pool/home/anne 18K 457G 18K /export/home/anne
3492 pool/home/bob 276K 457G 276K /export/home/bob
3498 \fBExample 6 \fRSetting a Quota on a ZFS File System
3501 The following command sets a quota of 50 Gbytes for \fBpool/home/bob\fR.
3506 # \fBzfs set quota=50G pool/home/bob\fR
3512 \fBExample 7 \fRListing ZFS Properties
3515 The following command lists all properties for \fBpool/home/bob\fR.
3520 # \fBzfs get all pool/home/bob\fR
3521 NAME PROPERTY VALUE SOURCE
3522 pool/home/bob type filesystem -
3523 pool/home/bob creation Tue Jul 21 15:53 2009 -
3524 pool/home/bob used 21K -
3525 pool/home/bob available 20.0G -
3526 pool/home/bob referenced 21K -
3527 pool/home/bob compressratio 1.00x -
3528 pool/home/bob mounted yes -
3529 pool/home/bob quota 20G local
3530 pool/home/bob reservation none default
3531 pool/home/bob recordsize 128K default
3532 pool/home/bob mountpoint /pool/home/bob default
3533 pool/home/bob sharenfs off default
3534 pool/home/bob checksum on default
3535 pool/home/bob compression on local
3536 pool/home/bob atime on default
3537 pool/home/bob devices on default
3538 pool/home/bob exec on default
3539 pool/home/bob setuid on default
3540 pool/home/bob readonly off default
3541 pool/home/bob zoned off default
3542 pool/home/bob snapdir hidden default
3543 pool/home/bob aclmode discard default
3544 pool/home/bob aclinherit restricted default
3545 pool/home/bob canmount on default
3546 pool/home/bob shareiscsi off default
3547 pool/home/bob xattr on default
3548 pool/home/bob copies 1 default
3549 pool/home/bob version 4 -
3550 pool/home/bob utf8only off -
3551 pool/home/bob normalization none -
3552 pool/home/bob casesensitivity sensitive -
3553 pool/home/bob vscan off default
3554 pool/home/bob nbmand off default
3555 pool/home/bob sharesmb off default
3556 pool/home/bob refquota none default
3557 pool/home/bob refreservation none default
3558 pool/home/bob primarycache all default
3559 pool/home/bob secondarycache all default
3560 pool/home/bob usedbysnapshots 0 -
3561 pool/home/bob usedbydataset 21K -
3562 pool/home/bob usedbychildren 0 -
3563 pool/home/bob usedbyrefreservation 0 -
3570 The following command gets a single property value.
3575 # \fBzfs get -H -o value compression pool/home/bob\fR
3583 The following command lists all properties with local settings for
3584 \fBpool/home/bob\fR.
3589 # \fBzfs get -r -s local -o name,property,value all pool/home/bob\fR
3591 pool/home/bob quota 20G
3592 pool/home/bob compression on
3598 \fBExample 8 \fRRolling Back a ZFS File System
3601 The following command reverts the contents of \fBpool/home/anne\fR to the
3602 snapshot named \fByesterday\fR, deleting all intermediate snapshots.
3607 # \fBzfs rollback -r pool/home/anne@yesterday\fR
3613 \fBExample 9 \fRCreating a ZFS Clone
3616 The following command creates a writable file system whose initial contents are
3617 the same as \fBpool/home/bob@yesterday\fR.
3622 # \fBzfs clone pool/home/bob@yesterday pool/clone\fR
3628 \fBExample 10 \fRPromoting a ZFS Clone
3631 The following commands illustrate how to test out changes to a file system, and
3632 then replace the original file system with the changed one, using clones, clone
3633 promotion, and renaming:
3638 # \fBzfs create pool/project/production\fR
3639 populate /pool/project/production with data
3640 # \fBzfs snapshot pool/project/production@today\fR
3641 # \fBzfs clone pool/project/production@today pool/project/beta\fR
3642 make changes to /pool/project/beta and test them
3643 # \fBzfs promote pool/project/beta\fR
3644 # \fBzfs rename pool/project/production pool/project/legacy\fR
3645 # \fBzfs rename pool/project/beta pool/project/production\fR
3646 once the legacy version is no longer needed, it can be destroyed
3647 # \fBzfs destroy pool/project/legacy\fR
3653 \fBExample 11 \fRInheriting ZFS Properties
3656 The following command causes \fBpool/home/bob\fR and \fBpool/home/anne\fR to
3657 inherit the \fBchecksum\fR property from their parent.
3662 # \fBzfs inherit checksum pool/home/bob pool/home/anne\fR
3668 \fBExample 12 \fRRemotely Replicating ZFS Data
3671 The following commands send a full stream and then an incremental stream to a
3672 remote machine, restoring them into \fBpoolB/received/fs@a\fRand
3673 \fBpoolB/received/fs@b\fR, respectively. \fBpoolB\fR must contain the file
3674 system \fBpoolB/received\fR, and must not initially contain
3675 \fBpoolB/received/fs\fR.
3680 # \fBzfs send pool/fs@a | \e\fR
3681 \fBssh host zfs receive poolB/received/fs@a\fR
3682 # \fBzfs send -i a pool/fs@b | ssh host \e\fR
3683 \fBzfs receive poolB/received/fs\fR
3689 \fBExample 13 \fRUsing the \fBzfs receive\fR \fB-d\fR Option
3692 The following command sends a full stream of \fBpoolA/fsA/fsB@snap\fR to a
3693 remote machine, receiving it into \fBpoolB/received/fsA/fsB@snap\fR. The
3694 \fBfsA/fsB@snap\fR portion of the received snapshot's name is determined from
3695 the name of the sent snapshot. \fBpoolB\fR must contain the file system
3696 \fBpoolB/received\fR. If \fBpoolB/received/fsA\fR does not exist, it is created
3697 as an empty file system.
3702 # \fBzfs send poolA/fsA/fsB@snap | \e
3703 ssh host zfs receive -d poolB/received\fR
3709 \fBExample 14 \fRSetting User Properties
3712 The following example sets the user-defined \fBcom.example:department\fR
3713 property for a dataset.
3718 # \fBzfs set com.example:department=12345 tank/accounting\fR
3724 \fBExample 15 \fRCreating a ZFS Volume as an iSCSI Target Device
3727 The following example shows how to create a \fBZFS\fR volume as an \fBiSCSI\fR
3733 # \fBzfs create -V 2g pool/volumes/vol1\fR
3734 # \fBzfs set shareiscsi=on pool/volumes/vol1\fR
3735 # \fBiscsitadm list target\fR
3736 Target: pool/volumes/vol1
3738 iqn.1986-03.com.sun:02:7b4b02a6-3277-eb1b-e686-a24762c52a8c
3746 After the \fBiSCSI\fR target is created, set up the \fBiSCSI\fR initiator. For
3747 more information about the Solaris \fBiSCSI\fR initiator, see
3748 \fBiscsitadm\fR(1M).
3750 \fBExample 16 \fRPerforming a Rolling Snapshot
3753 The following example shows how to maintain a history of snapshots with a
3754 consistent naming scheme. To keep a week's worth of snapshots, the user
3755 destroys the oldest snapshot, renames the remaining snapshots, and then creates
3756 a new snapshot, as follows:
3761 # \fBzfs destroy -r pool/users@7daysago\fR
3762 # \fBzfs rename -r pool/users@6daysago @7daysago\fR
3763 # \fBzfs rename -r pool/users@5daysago @6daysago\fR
3764 # \fBzfs rename -r pool/users@yesterday @5daysago\fR
3765 # \fBzfs rename -r pool/users@yesterday @4daysago\fR
3766 # \fBzfs rename -r pool/users@yesterday @3daysago\fR
3767 # \fBzfs rename -r pool/users@yesterday @2daysago\fR
3768 # \fBzfs rename -r pool/users@today @yesterday\fR
3769 # \fBzfs snapshot -r pool/users@today\fR
3775 \fBExample 17 \fRSetting \fBsharenfs\fR Property Options on a ZFS File System
3778 The following commands show how to set \fBsharenfs\fR property options to
3779 enable \fBrw\fR access for a set of \fBIP\fR addresses and to enable root
3780 access for system \fBneo\fR on the \fBtank/home\fR file system.
3785 # \fBzfs set sharenfs='rw=@123.123.0.0/16,root=neo' tank/home\fR
3792 If you are using \fBDNS\fR for host name resolution, specify the fully
3796 \fBExample 18 \fRDelegating ZFS Administration Permissions on a ZFS Dataset
3799 The following example shows how to set permissions so that user \fBcindys\fR
3800 can create, destroy, mount, and take snapshots on \fBtank/cindys\fR. The
3801 permissions on \fBtank/cindys\fR are also displayed.
3806 # \fBzfs allow cindys create,destroy,mount,snapshot tank/cindys\fR
3807 # \fBzfs allow tank/cindys\fR
3808 -------------------------------------------------------------
3809 Local+Descendent permissions on (tank/cindys)
3810 user cindys create,destroy,mount,snapshot
3811 -------------------------------------------------------------
3818 Because the \fBtank/cindys\fR mount point permission is set to 755 by default,
3819 user \fBcindys\fR will be unable to mount file systems under \fBtank/cindys\fR.
3820 Set an \fBACL\fR similar to the following syntax to provide mount point access:
3824 # \fBchmod A+user:cindys:add_subdirectory:allow /tank/cindys\fR
3830 \fBExample 19 \fRDelegating Create Time Permissions on a ZFS Dataset
3833 The following example shows how to grant anyone in the group \fBstaff\fR to
3834 create file systems in \fBtank/users\fR. This syntax also allows staff members
3835 to destroy their own file systems, but not destroy anyone else's file system.
3836 The permissions on \fBtank/users\fR are also displayed.
3841 # \fBzfs allow staff create,mount tank/users\fR
3842 # \fBzfs allow -c destroy tank/users\fR
3843 # \fBzfs allow tank/users\fR
3844 -------------------------------------------------------------
3845 Create time permissions on (tank/users)
3847 Local+Descendent permissions on (tank/users)
3848 group staff create,mount
3849 -------------------------------------------------------------
3855 \fBExample 20 \fRDefining and Granting a Permission Set on a ZFS Dataset
3858 The following example shows how to define and grant a permission set on the
3859 \fBtank/users\fR file system. The permissions on \fBtank/users\fR are also
3865 # \fBzfs allow -s @pset create,destroy,snapshot,mount tank/users\fR
3866 # \fBzfs allow staff @pset tank/users\fR
3867 # \fBzfs allow tank/users\fR
3868 -------------------------------------------------------------
3869 Permission sets on (tank/users)
3870 @pset create,destroy,mount,snapshot
3871 Create time permissions on (tank/users)
3873 Local+Descendent permissions on (tank/users)
3874 group staff @pset,create,mount
3875 -------------------------------------------------------------
3881 \fBExample 21 \fRDelegating Property Permissions on a ZFS Dataset
3884 The following example shows to grant the ability to set quotas and reservations
3885 on the \fBusers/home\fR file system. The permissions on \fBusers/home\fR are
3891 # \fBzfs allow cindys quota,reservation users/home\fR
3892 # \fBzfs allow users/home\fR
3893 -------------------------------------------------------------
3894 Local+Descendent permissions on (users/home)
3895 user cindys quota,reservation
3896 -------------------------------------------------------------
3897 cindys% \fBzfs set quota=10G users/home/marks\fR
3898 cindys% \fBzfs get quota users/home/marks\fR
3899 NAME PROPERTY VALUE SOURCE
3900 users/home/marks quota 10G local
3906 \fBExample 22 \fRRemoving ZFS Delegated Permissions on a ZFS Dataset
3909 The following example shows how to remove the snapshot permission from the
3910 \fBstaff\fR group on the \fBtank/users\fR file system. The permissions on
3911 \fBtank/users\fR are also displayed.
3916 # \fBzfs unallow staff snapshot tank/users\fR
3917 # \fBzfs allow tank/users\fR
3918 -------------------------------------------------------------
3919 Permission sets on (tank/users)
3920 @pset create,destroy,mount,snapshot
3921 Create time permissions on (tank/users)
3923 Local+Descendent permissions on (tank/users)
3924 group staff @pset,create,mount
3925 -------------------------------------------------------------
3931 \fBExample 23\fR Showing the differences between a snapshot and a ZFS Dataset
3934 The following example shows how to see what has changed between a prior
3935 snapshot of a ZFS Dataset and its current state. The \fB-F\fR option is used
3936 to indicate type information for the files affected.
3941 # zfs diff -F tank/test@before tank/test
3943 M F /tank/test/linked (+1)
3944 R F /tank/test/oldname -> /tank/test/newname
3945 - F /tank/test/deleted
3946 + F /tank/test/created
3947 M F /tank/test/modified
3955 The following exit values are returned:
3963 Successful completion.
3983 Invalid command line options were specified.
3989 See \fBattributes\fR(5) for descriptions of the following attributes:
3997 ATTRIBUTE TYPE ATTRIBUTE VALUE
3999 Interface Stability Committed
4005 \fBssh\fR(1), \fBiscsitadm\fR(1M), \fBmount\fR(1M), \fBshare\fR(1M),
4006 \fBsharemgr\fR(1M), \fBunshare\fR(1M), \fBzonecfg\fR(1M), \fBzpool\fR(1M),
4007 \fBchmod\fR(2), \fBstat\fR(2), \fBwrite\fR(2), \fBfsync\fR(3C),
4008 \fBdfstab\fR(4), \fBacl\fR(5), \fBattributes\fR(5)
4011 See the \fBgzip\fR(1) man page, which is not part of the SunOS man page
4015 For information about using the \fBZFS\fR web-based management tool and other
4016 \fBZFS\fR features, see the \fISolaris ZFS Administration Guide\fR.
projects / FreeBSD / FreeBSD.git / blob