2 .\" Copyright (c) 2013, Martin Matuska <mm@FreeBSD.org>.
3 .\" All Rights Reserved.
5 .\" The contents of this file are subject to the terms of the
6 .\" Common Development and Distribution License (the "License").
7 .\" You may not use this file except in compliance with the License.
9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10 .\" or http://www.opensolaris.org/os/licensing.
11 .\" See the License for the specific language governing permissions
12 .\" and limitations under the License.
14 .\" When distributing Covered Code, include this CDDL HEADER in each
15 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16 .\" If applicable, add the following below this CDDL HEADER, with the
17 .\" fields enclosed by brackets "[]" replaced with your own identifying
18 .\" information: Portions Copyright [yyyy] [name of copyright owner]
20 .\" Copyright (c) 2010, Sun Microsystems, Inc. All Rights Reserved.
21 .\" Copyright (c) 2012 by Delphix. All rights reserved.
22 .\" Copyright (c) 2012, Joyent, Inc. All rights reserved.
23 .\" Copyright (c) 2011, Pawel Jakub Dawidek <pjd@FreeBSD.org>
24 .\" Copyright (c) 2012, Glen Barber <gjb@FreeBSD.org>
25 .\" Copyright (c) 2012, Bryan Drewery <bdrewery@FreeBSD.org>
26 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
27 .\" Copyright (c) 2013 Nexenta Systems, Inc. All Rights Reserved.
36 .Nd configures ZFS file systems
43 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ... Ar filesystem
48 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
54 .Ar filesystem Ns | Ns Ar volume
66 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
67 .Ar filesystem@snapname Ns | Ns Ar volume@snapname
68 .Ar filesystem@snapname Ns | Ns Ar volume@snapname Ns ...
76 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
77 .Ar snapshot filesystem Ns | Ns Ar volume
84 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
85 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
90 .Ar filesystem Ns | Ns Ar volume
91 .Ar filesystem Ns | Ns Ar volume
100 .Ar filesystem filesystem
103 .Op Fl r Ns | Ns Fl d Ar depth
105 .Op Fl o Ar property Ns Oo , Ns property Ns Oc Ns ...
106 .Op Fl t Ar type Ns Oo , Ns type Ns Oc Ns ...
107 .Oo Fl s Ar property Oc Ns ...
108 .Oo Fl S Ar property Oc Ns ...
109 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
112 .Ar property Ns = Ns Ar value
113 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
116 .Op Fl r Ns | Ns Fl d Ar depth
118 .Op Fl o Ar all | field Ns Oo , Ns Ar field Oc Ns ...
119 .Op Fl t Ar type Ns Oo Ns , Ar type Oc Ns ...
120 .Op Fl s Ar source Ns Oo Ns , Ns Ar source Oc Ns ...
121 .Ar all | property Ns Oo Ns , Ns Ar property Oc Ns ...
122 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
127 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
135 .Fl a | Ar filesystem
139 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
140 .Oo Fl s Ar field Oc Ns ...
141 .Oo Fl S Ar field Oc Ns ...
142 .Op Fl t Ar type Ns Oo Ns , Ns Ar type Oc Ns ...
143 .Ar filesystem Ns | Ns Ar snapshot
147 .Op Fl o Ar field Ns Oo , Ns field Oc Ns ...
148 .Oo Fl s Ar field Oc Ns ...
149 .Oo Fl S Ar field Oc Ns ...
150 .Op Fl t Ar type Ns Oo Ns , Ns Ar type Oc Ns ...
151 .Ar filesystem Ns | Ns Ar snapshot
157 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
158 .Fl a | Ar filesystem
162 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
165 .Fl a | Ar filesystem
168 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
172 .Op Fl i Ar snapshot | Fl I Ar snapshot
177 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
185 .Ar filesystem Ns | Ns Ar volume
189 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
190 .Ar perm Ns | Ns Ar @setname Ns
191 .Oo Ns , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
192 .Ar filesystem Ns | Ns Ar volume
196 .Fl e Ns | Ns Cm everyone
197 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
199 .Ar filesystem Ns | Ns Ar volume
203 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
205 .Ar filesystem Ns | Ns Ar volume
210 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
212 .Ar filesystem Ns | Ns Ar volume
216 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
217 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
219 .Ar filesystem Ns | Ns Ar volume
223 .Fl e Ns | Ns Cm everyone
224 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
226 .Ar filesystem Ns | Ns Ar volume
231 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
233 .Ar filesystem Ns | Ns Ar volume
239 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
241 .Ar filesystem Ns | Ns Ar volume
245 .Ar tag snapshot Ns ...
253 .Ar tag snapshot Ns ...
258 .Op Ar snapshot Ns | Ns Ar filesystem
261 .Ar jailid Ns | Ns Ar jailname filesystem
264 .Ar jailid Ns | Ns Ar jailname filesystem
272 storage pool, as described in
274 A dataset is identified by a unique path within the
276 namespace. For example:
277 .Bd -ragged -offset 4n
278 .No pool/ Ns Brq filesystem,volume,snapshot
281 where the maximum length of a dataset name is
285 A dataset can be one of the following:
292 can be mounted within the standard system namespace and behaves like other file
295 file systems are designed to be
297 compliant, known issues exist that prevent compliance in some cases.
298 Applications that depend on standards conformance might fail due to nonstandard
299 behavior when checking file system free space.
301 A logical volume exported as a raw or block device. This type of dataset should
302 only be used under special circumstances. File systems are typically used in
305 A read-only version of a file system or volume at a given point in time. It is
311 .Ss ZFS File System Hierarchy
314 storage pool is a logical collection of devices that provide space for
315 datasets. A storage pool is also the root of the
317 file system hierarchy.
319 The root of the pool can be accessed as a file system, such as mounting and
320 unmounting, taking snapshots, and setting properties. The physical storage
321 characteristics, however, are managed by the
327 for more information on creating and administering pools.
329 A snapshot is a read-only copy of a file system or volume. Snapshots can be
330 created extremely quickly, and initially consume no additional space within the
331 pool. As data within the active dataset changes, the snapshot consumes more
332 data than would otherwise be shared with the active dataset.
334 Snapshots can have arbitrary names. Snapshots of volumes can be cloned or
335 rolled back, but cannot be accessed independently.
337 File system snapshots can be accessed under the
339 directory in the root of the file system. Snapshots are automatically mounted
340 on demand and may be unmounted at regular intervals. The visibility of the
342 directory can be controlled by the
346 A clone is a writable volume or file system whose initial contents are the same
347 as another dataset. As with snapshots, creating a clone is nearly
348 instantaneous, and initially consumes no additional space.
350 Clones can only be created from a snapshot. When a snapshot is cloned, it
351 creates an implicit dependency between the parent and child. Even though the
352 clone is created somewhere else in the dataset hierarchy, the original snapshot
353 cannot be destroyed as long as a clone exists. The
355 property exposes this dependency, and the
357 command lists any such dependencies, if they exist.
359 The clone parent-child dependency relationship can be reversed by using the
361 subcommand. This causes the "origin" file system to become a clone of the
362 specified file system, which makes it possible to destroy the file system that
363 the clone was created from.
367 file system is a simple operation, so the number of file systems per system is
368 likely to be numerous. To cope with this,
370 automatically manages mounting and unmounting file systems without the need to
373 file. All automatically managed file systems are mounted by
377 By default, file systems are mounted under
381 is the name of the file system in the
383 namespace. Directories are created and destroyed as needed.
385 A file system can also have a mount point set in the
387 property. This directory is created as needed, and
389 automatically mounts the file system when the
391 command is invoked (without editing
395 property can be inherited, so if
401 automatically inherits a mount point of
408 prevents the file system from being mounted.
412 file systems can also be managed with traditional tools
413 .Pq Xr mount 8 , Xr umount 8 , Xr fstab 5 .
414 If a file system's mount point is set to
417 makes no attempt to manage the file system, and the administrator is
418 responsible for mounting and unmounting the file system.
421 dataset can be attached to a jail by using the
423 subcommand. You cannot attach a dataset to one jail and the children of the
424 same dataset to another jails. To allow management of the dataset from within
427 property has to be set and the jail needs access to the
431 property cannot be changed from within a jail. See
433 for information on how to allow mounting
435 datasets from within a jail.
438 dataset can be detached from a jail using the
442 After a dataset is attached to a jail and the jailed property is set, a jailed
443 file system cannot be mounted outside the jail, since the jail administrator
444 might have set the mount point to an unacceptable value.
446 Deduplication is the process for removing redundant data at the block-level,
447 reducing the total amount of data stored. If a file system has the
449 property enabled, duplicate data blocks are removed synchronously. The result
450 is that only unique data is stored and common components are shared among
452 .Ss Native Properties
453 Properties are divided into two types, native properties and user-defined (or
454 "user") properties. Native properties either export internal statistics or
457 behavior. In addition, native properties are either editable or read-only. User
458 properties have no effect on
460 behavior, but you can use them to annotate datasets in a way that is meaningful
461 in your environment. For more information about user properties, see the
462 .Qq Sx User Properties
465 Every dataset has a set of properties that export statistics about the dataset
466 as well as control various behaviors. Properties are inherited from the parent
467 unless overridden by the child. Some properties apply only to certain types of
468 datasets (file systems, volumes, or snapshots).
470 The values of numeric properties can be specified using human-readable suffixes
472 .Sy k , KB , M , Gb ,
475 for zettabyte). The following are all valid (and equal) specifications:
476 .Bd -ragged -offset 4n
480 The values of non-numeric properties are case sensitive and must be lowercase,
482 .Sy mountpoint , sharenfs , No and Sy sharesmb .
484 The following native properties consist of read-only statistics about the
485 dataset. These properties can be neither set, nor inherited. Native properties
486 apply to all dataset types unless otherwise noted.
489 The amount of space available to the dataset and all its children, assuming
490 that there is no other activity in the pool. Because space is shared within a
491 pool, availability can be limited by any number of factors, including physical
492 pool size, quotas, reservations, or other datasets within the pool.
494 This property can also be referred to by its shortened column name,
497 For non-snapshots, the compression ratio achieved for the
499 space of this dataset, expressed as a multiplier. The
501 property includes descendant datasets, and, for clones, does not include
502 the space shared with the origin snapshot. For snapshots, the
506 property. Compression can be turned on by running:
507 .Qq Nm Cm set compression=on Ar dataset
511 The time this dataset was created.
513 For snapshots, this property is a comma-separated list of filesystems or
514 volumes which are clones of this snapshot. The clones'
516 property is this snapshot. If the
518 property is not empty, then this snapshot can not be destroyed (even with the
526 if the snapshot has been marked for deferred destroy by using the
528 command. Otherwise, the property is
530 .It Sy logicalreferenced
531 The amount of space that is
533 accessible by this dataset.
537 The logical space ignores the effect of the
541 properties, giving a quantity closer to the amount of data that applications
543 However, it does include space consumed by metadata.
545 This property can also be referred to by its shortened column name,
548 The amount of space that is
550 consumed by this dataset and all its descendents.
554 The logical space ignores the effect of the
558 properties, giving a quantity closer to the amount of data that applications
561 This property can also be referred to by its shortened column name,
564 For file systems, indicates whether the file system is currently mounted. This
565 property can be either
570 For cloned file systems or volumes, the snapshot from which the clone was
571 created. See also the
575 The amount of data that is accessible by this dataset, which may or may not be
576 shared with other datasets in the pool. When a snapshot or clone is created, it
577 initially references the same amount of space as the file system or snapshot it
578 was created from, since its contents are identical.
580 This property can also be referred to by its shortened column name,
582 .It Sy refcompressratio
583 The compression ratio achieved for the
585 space of this dataset, expressed as a multiplier. See also the
590 .Sy filesystem , volume , No or Sy snapshot .
592 The amount of space consumed by this dataset and all its descendents. This is
593 the value that is checked against this dataset's quota and reservation. The
594 space used does not include this dataset's reservation, but does take into
595 account the reservations of any descendent datasets. The amount of space that a
596 dataset consumes from its parent, as well as the amount of space that are freed
597 if this dataset is recursively destroyed, is the greater of its space used and
600 When snapshots (see the
602 section) are created, their space is
603 initially shared between the snapshot and the file system, and possibly with
604 previous snapshots. As the file system changes, space that was previously
605 shared becomes unique to the snapshot, and counted in the snapshot's space
606 used. Additionally, deleting snapshots can increase the amount of space unique
607 to (and used by) other snapshots.
609 The amount of space used, available, or referenced does not take into account
610 pending changes. Pending changes are generally accounted for within a few
611 seconds. Committing a change to a disk using
615 does not necessarily guarantee that the space usage information is updated
620 properties decompose the
622 properties into the various reasons that space is used. Specifically,
624 .Sy usedbysnapshots + usedbydataset + usedbychildren + usedbyrefreservation .
625 These properties are only available for datasets created
628 pool version 13 pools and higher.
629 .It Sy usedbysnapshots
630 The amount of space consumed by snapshots of this dataset. In particular, it is
631 the amount of space that would be freed if all of this dataset's snapshots were
632 destroyed. Note that this is not simply the sum of the snapshots'
634 properties because space can be shared by multiple snapshots.
636 The amount of space used by this dataset itself, which would be freed if the
637 dataset were destroyed (after first removing any
639 and destroying any necessary snapshots or descendents).
640 .It Sy usedbychildren
641 The amount of space used by children of this dataset, which would be freed if
642 all the dataset's children were destroyed.
643 .It Sy usedbyrefreservation
644 The amount of space used by a
646 set on this dataset, which would be freed if the
649 .It Sy userused@ Ns Ar user
650 The amount of space consumed by the specified user in this dataset. Space is
651 charged to the owner of each file, as displayed by
653 The amount of space charged is displayed by
659 subcommand for more information.
661 Unprivileged users can access only their own space usage. The root user, or a
662 user who has been granted the
666 can access everyone's usage.
670 properties are not displayed by
672 The user's name must be appended after the
674 symbol, using one of the following forms:
675 .Bl -bullet -offset 2n
677 POSIX name (for example,
680 POSIX numeric ID (for example,
684 This property is set to the number of user holds on this snapshot. User holds
688 .It Sy groupused@ Ns Ar group
689 The amount of space consumed by the specified group in this dataset. Space is
690 charged to the group of each file, as displayed by
693 .Sy userused@ Ns Ar user
694 property for more information.
696 Unprivileged users can only access their own groups' space usage. The root
697 user, or a user who has been granted the
701 can access all groups' usage.
702 .It Sy volblocksize Ns = Ns Ar blocksize
703 For volumes, specifies the block size of the volume. The
705 cannot be changed once the volume has been written, so it should be set at
706 volume creation time. The default
708 for volumes is 8 Kbytes. Any
709 power of 2 from 512 bytes to 128 Kbytes is valid.
711 This property can also be referred to by its shortened column name,
716 space written to this dataset since the previous snapshot.
717 .It Sy written@ Ns Ar snapshot
720 space written to this dataset since the specified snapshot. This is the space
721 that is referenced by this dataset but was not referenced by the specified
726 may be specified as a short snapshot name (just the part after the
728 in which case it will be interpreted as a snapshot in the same filesystem as
731 may be a full snapshot name
732 .Pq Em filesystem@snapshot ,
733 which for clones may be a snapshot in the origin's filesystem (or the origin of
734 the origin's filesystem, etc).
737 The following native properties can be used to change the behavior of a
742 .Sy aclinherit Ns = Ns Cm discard |
750 entries are inherited when files and directories are created. A file system
757 entries. A file system with an
761 only inherits inheritable
763 entries that specify "deny" permissions. The property value
765 (the default) removes the
771 entry is inherited. A file system with an
775 inherits all inheritable
777 entries without any modifications made to the
779 entries when they are inherited. A file system with an
783 has the same meaning as
786 .Em owner@ , group@ , No and Em everyone@ Tn ACE Ns s
787 inherit the execute permission only if the file creation mode also requests the
790 When the property value is set to
792 files are created with a mode determined by the inheritable
796 exist that affect the mode, then the mode is set in accordance to the requested
797 mode from the application.
798 .It Sy aclmode Ns = Ns Cm discard | groupmask | passthrough | restricted
803 A file system with an
807 (the default) deletes all
809 entries that do not represent the mode of the file. An
813 reduces permissions granted in all
817 such that they are no greater than the group permissions specified by
819 A file system with an
823 indicates that no changes are made to the
825 other than creating or updating the necessary
827 entries to represent the new mode of the file or directory.
834 operation to return an error when used on any file or directory which has
837 whose entries can not be represented by a mode.
839 is required to change the set user ID, set group ID, or sticky bits on a file
840 or directory, as they do not have equivalent
845 on a file or directory with a non-trivial
851 you must first remove all
853 entries which do not represent the current mode.
854 .It Sy atime Ns = Ns Cm on | off
855 Controls whether the access time for files is updated when they are read.
856 Turning this property off avoids producing write traffic when reading files and
857 can result in significant performance gains, though it might confuse mailers
858 and other similar utilities. The default value is
860 .It Sy canmount Ns = Ns Cm on | off | noauto
861 If this property is set to
863 the file system cannot be mounted, and is ignored by
864 .Qq Nm Cm mount Fl a .
865 Setting this property to
867 is similar to setting the
871 except that the dataset still has a normal
873 property, which can be inherited. Setting this property to
875 allows datasets to be used solely as a mechanism to inherit properties. One
877 .Sy canmount Ns = Ns Cm off
878 is to have two datasets with the same
880 so that the children of both datasets appear in the same directory, but might
881 have different inherited characteristics.
885 value is set, a dataset can only be mounted and unmounted explicitly. The
886 dataset is not mounted automatically when the dataset is created or imported,
887 nor is it mounted by the
889 command or unmounted by the
890 .Qq Nm Cm umount Fl a
893 This property is not inherited.
894 .It Sy checksum Ns = Ns Cm on | off | fletcher2 | fletcher4 | sha256
895 Controls the checksum used to verify data integrity. The default value is
897 which automatically selects an appropriate algorithm (currently,
899 but this may change in future releases). The value
901 disables integrity checking on user data. Disabling checksums is
903 a recommended practice.
904 .It Sy compression Ns = Ns Cm on | off | lzjb | gzip | gzip- Ns Ar N | zle | Cm lz4
905 Controls the compression algorithm used for this dataset. The
907 compression algorithm is optimized for performance while providing decent data
908 compression. Setting compression to
912 compression algorithm. The
914 compression algorithm uses the same compression as the
916 command. You can specify the
918 level by using the value
922 is an integer from 1 (fastest) to 9 (best compression ratio). Currently,
926 (which is also the default for
930 compression algorithm compresses runs of zeros.
934 compression algorithm is a high-performance replacement
937 algorithm. It features significantly faster
938 compression and decompression, as well as a moderately higher
939 compression ratio than
941 but can only be used on pools with
948 for details on ZFS feature flags and the
952 This property can also be referred to by its shortened column name
954 Changing this property affects only newly-written data.
955 .It Sy copies Ns = Ns Cm 1 | 2 | 3
956 Controls the number of copies of data stored for this dataset. These copies are
957 in addition to any redundancy provided by the pool, for example, mirroring or
958 RAID-Z. The copies are stored on different disks, if possible. The space used
959 by multiple copies is charged to the associated file and dataset, changing the
961 property and counting against quotas and reservations.
963 Changing this property only affects newly-written data. Therefore, set this
964 property at file system creation time by using the
965 .Fl o Cm copies= Ns Ar N
967 .It Sy dedup Ns = Ns Cm on | off | verify | sha256 Ns Op Cm ,verify
968 Configures deduplication for a dataset. The default value is
970 The default deduplication checksum is
972 (this may change in the future).
975 is enabled, the checksum defined here overrides the
977 property. Setting the value to
979 has the same effect as the setting
985 will do a byte-to-byte comparsion in case of two blocks having the same
986 signature to make sure the block contents are identical.
987 .It Sy devices Ns = Ns Cm on | off
990 property is currently not supported on
992 .It Sy exec Ns = Ns Cm on | off
993 Controls whether processes can be executed from within this file system. The
996 .It Sy mlslabel Ns = Ns Ar label | Cm none
999 property is currently not supported on
1001 .It Sy mountpoint Ns = Ns Ar path | Cm none | legacy
1002 Controls the mount point used for this file system. See the
1004 section for more information on how this property is used.
1008 property is changed for a file system, the file system and any children that
1009 inherit the mount point are unmounted. If the new value is
1011 then they remain unmounted. Otherwise, they are automatically remounted in the
1012 new location if the property was previously
1016 or if they were mounted before the property was changed. In addition, any
1017 shared file systems are unshared and shared in the new location.
1018 .It Sy nbmand Ns = Ns Cm on | off
1021 property is currently not supported on
1023 .It Sy primarycache Ns = Ns Cm all | none | metadata
1024 Controls what is cached in the primary cache (ARC). If this property is set to
1026 then both user data and metadata is cached. If this property is set to
1028 then neither user data nor metadata is cached. If this property is set to
1030 then only metadata is cached. The default value is
1032 .It Sy quota Ns = Ns Ar size | Cm none
1033 Limits the amount of space a dataset and its descendents can consume. This
1034 property enforces a hard limit on the amount of space used. This includes all
1035 space consumed by descendents, including file systems and snapshots. Setting a
1036 quota on a descendent of a dataset that already has a quota does not override
1037 the ancestor's quota, but rather imposes an additional limit.
1039 Quotas cannot be set on volumes, as the
1041 property acts as an implicit quota.
1042 .It Sy userquota@ Ns Ar user Ns = Ns Ar size | Cm none
1043 Limits the amount of space consumed by the specified user.
1048 space calculation does not include space that is used by descendent datasets,
1049 such as snapshots and clones. User space consumption is identified by the
1050 .Sy userspace@ Ns Ar user
1053 Enforcement of user quotas may be delayed by several seconds. This delay means
1054 that a user might exceed their quota before the system notices that they are
1055 over quota and begins to refuse additional writes with the
1057 error message. See the
1059 subcommand for more information.
1061 Unprivileged users can only access their own groups' space usage. The root
1062 user, or a user who has been granted the
1066 can get and set everyone's quota.
1068 This property is not available on volumes, on file systems before version 4, or
1069 on pools before version 15. The
1070 .Sy userquota@ Ns ...
1071 properties are not displayed by
1073 The user's name must be appended after the
1075 symbol, using one of the following forms:
1076 .Bl -bullet -offset 2n
1078 POSIX name (for example,
1081 POSIX numeric ID (for example,
1084 .It Sy groupquota@ Ns Ar group Ns = Ns Ar size | Cm none
1085 Limits the amount of space consumed by the specified group. Group space
1086 consumption is identified by the
1087 .Sy userquota@ Ns Ar user
1090 Unprivileged users can access only their own groups' space usage. The root
1091 user, or a user who has been granted the
1095 can get and set all groups' quotas.
1096 .It Sy readonly Ns = Ns Cm on | off
1097 Controls whether this dataset can be modified. The default value is
1099 .It Sy recordsize Ns = Ns Ar size
1100 Specifies a suggested block size for files in the file system. This property is
1101 designed solely for use with database workloads that access files in fixed-size
1104 automatically tunes block sizes according to internal algorithms optimized for
1105 typical access patterns.
1107 For databases that create very large files but access them in small random
1108 chunks, these algorithms may be suboptimal. Specifying a
1110 greater than or equal to the record size of the database can result in
1111 significant performance gains. Use of this property for general purpose file
1112 systems is strongly discouraged, and may adversely affect performance.
1114 The size specified must be a power of two greater than or equal to 512 and less
1115 than or equal to 128 Kbytes.
1117 Changing the file system's
1119 affects only files created afterward; existing files are unaffected.
1121 This property can also be referred to by its shortened column name,
1123 .It Sy refquota Ns = Ns Ar size | Cm none
1124 Limits the amount of space a dataset can consume. This property enforces a hard
1125 limit on the amount of space used. This hard limit does not include space used
1126 by descendents, including file systems and snapshots.
1127 .It Sy refreservation Ns = Ns Ar size | Cm none
1128 The minimum amount of space guaranteed to a dataset, not including its
1129 descendents. When the amount of space used is below this value, the dataset is
1130 treated as if it were taking up the amount of space specified by
1131 .Sy refreservation .
1134 reservation is accounted for in the parent datasets' space used, and counts
1135 against the parent datasets' quotas and reservations.
1139 is set, a snapshot is only allowed if there is enough free pool space outside
1140 of this reservation to accommodate the current number of "referenced" bytes in
1143 This property can also be referred to by its shortened column name,
1145 .It Sy reservation Ns = Ns Ar size | Cm none
1146 The minimum amount of space guaranteed to a dataset and its descendents. When
1147 the amount of space used is below this value, the dataset is treated as if it
1148 were taking up the amount of space specified by its reservation. Reservations
1149 are accounted for in the parent datasets' space used, and count against the
1150 parent datasets' quotas and reservations.
1152 This property can also be referred to by its shortened column name,
1154 .It Sy secondarycache Ns = Ns Cm all | none | metadata
1155 Controls what is cached in the secondary cache (L2ARC). If this property is set
1158 then both user data and metadata is cached. If this property is set to
1160 then neither user data nor metadata is cached. If this property is set to
1162 then only metadata is cached. The default value is
1164 .It Sy setuid Ns = Ns Cm on | off
1165 Controls whether the
1167 bit is respected for the file system. The default value is
1169 .It Sy sharesmb Ns = Ns Cm on | off | Ar opts
1172 property currently has no effect on
1174 .It Sy sharenfs Ns = Ns Cm on | off | Ar opts
1175 Controls whether the file system is shared via
1177 and what options are used. A file system with a
1181 is managed the traditional way via
1183 Otherwise, the file system is automatically shared and unshared with the
1187 commands. If the property is set to
1191 export options are used. Otherwise,
1193 export options are equivalent to the contents of this property. The export
1194 options may be comma-separated. See
1196 for a list of valid options.
1200 property is changed for a dataset, the
1203 .It Sy logbias Ns = Ns Cm latency | throughput
1206 about handling of synchronous requests in this dataset.
1213 will use pool log devices (if configured) to handle the requests at low
1219 will not use configured pool log devices.
1221 will instead optimize synchronous operations for global pool throughput and
1222 efficient use of resources.
1223 .It Sy snapdir Ns = Ns Cm hidden | visible
1224 Controls whether the
1226 directory is hidden or visible in the root of the file system as discussed in
1229 section. The default value is
1231 .It Sy sync Ns = Ns Cm standard | always | disabled
1232 Controls the behavior of synchronous requests (e.g.
1234 O_DSYNC). This property accepts the following values:
1235 .Bl -tag -offset 4n -width 8n
1237 This is the POSIX specified behavior of ensuring all synchronous requests are
1238 written to stable storage and all devices are flushed to ensure data is not
1239 cached by device controllers (this is the default).
1241 All file system transactions are written and flushed before their system calls
1242 return. This has a large performance penalty.
1244 Disables synchronous requests. File system transactions are only committed to
1245 stable storage periodically. This option will give the highest performance.
1246 However, it is very dangerous as
1248 would be ignoring the synchronous transaction demands of applications such as
1251 Administrators should only use this option when the risks are understood.
1253 .It Sy volsize Ns = Ns Ar size
1254 For volumes, specifies the logical size of the volume. By default, creating a
1255 volume establishes a reservation of equal size. For storage pools with a
1256 version number of 9 or higher, a
1258 is set instead. Any changes to
1260 are reflected in an equivalent change to the reservation (or
1261 .Sy refreservation ) .
1264 can only be set to a multiple of
1268 The reservation is kept equal to the volume's logical size to prevent
1269 unexpected behavior for consumers. Without the reservation, the volume could
1270 run out of space, resulting in undefined behavior or data corruption, depending
1271 on how the volume is used. These effects can also occur when the volume size is
1272 changed while it is in use (particularly when shrinking the size). Extreme care
1273 should be used when adjusting the volume size.
1275 Though not recommended, a "sparse volume" (also known as "thin provisioning")
1276 can be created by specifying the
1279 .Qq Nm Cm create Fl V
1280 command, or by changing the reservation after the volume has been created. A
1281 "sparse volume" is a volume where the reservation is less then the volume size.
1282 Consequently, writes to a sparse volume can fail with
1284 when the pool is low on space. For a sparse volume, changes to
1286 are not reflected in the reservation.
1287 .It Sy vscan Ns = Ns Cm off | on
1290 property is currently not supported on
1292 .It Sy xattr Ns = Ns Cm off | on
1295 property is currently not supported on
1297 .It Sy jailed Ns = Ns Cm off | on
1298 Controls whether the dataset is managed from a jail. See the
1300 section for more information. The default value is
1304 The following three properties cannot be changed after the file system is
1305 created, and therefore, should be set when the file system is created. If the
1306 properties are not set with the
1310 commands, these properties are inherited from the parent dataset. If the parent
1311 dataset lacks these properties due to having been created prior to these
1312 features being supported, the new file system will have the default values for
1315 .It Sy casesensitivity Ns = Ns Cm sensitive | insensitive | mixed
1318 property is currently not supported on
1320 .It Sy normalization Ns = Ns Cm none | formC | formD | formKC | formKD
1321 Indicates whether the file system should perform a
1323 normalization of file names whenever two file names are compared, and which
1324 normalization algorithm should be used. File names are always stored
1325 unmodified, names are normalized as part of any comparison process. If this
1326 property is set to a legal value other than
1330 property was left unspecified, the
1332 property is automatically set to
1334 The default value of the
1338 This property cannot be changed after the file system is created.
1339 .It Sy utf8only Ns = Ns Cm on | off
1340 Indicates whether the file system should reject file names that include
1341 characters that are not present in the
1343 character code set. If this property is explicitly set to
1345 the normalization property must either not be explicitly set or be set to
1347 The default value for the
1351 This property cannot be changed after the file system is created.
1355 .Sy casesensitivity , normalization , No and Sy utf8only
1356 properties are also new permissions that can be assigned to non-privileged
1359 delegated administration feature.
1360 .Ss Temporary Mount Point Properties
1361 When a file system is mounted, either through
1363 for legacy mounts or the
1365 command for normal file systems, its mount options are set according to its
1366 properties. The correlation between properties and mount options is as follows:
1367 .Bl -column -offset 4n "PROPERTY" "MOUNT OPTION"
1368 .It "PROPERTY MOUNT OPTION"
1369 .It "atime atime/noatime"
1370 .It "exec exec/noexec"
1371 .It "readonly ro/rw"
1372 .It "setuid suid/nosuid"
1375 In addition, these options can be set on a per-mount basis using the
1377 option, without affecting the property that is stored on disk. The values
1378 specified on the command line override the values stored in the dataset. These
1379 properties are reported as "temporary" by the
1381 command. If the properties are changed while the dataset is mounted, the new
1382 setting overrides any temporary settings.
1384 In addition to the standard native properties,
1386 supports arbitrary user properties. User properties have no effect on
1388 behavior, but applications or administrators can use them to annotate datasets
1389 (file systems, volumes, and snapshots).
1391 User property names must contain a colon
1393 character to distinguish them from native properties. They may contain
1394 lowercase letters, numbers, and the following punctuation characters: colon
1402 The expected convention is that the property name is divided into two portions
1404 .Em module Ns Sy \&: Ns Em property ,
1405 but this namespace is not enforced by
1407 User property names can be at most 256 characters, and cannot begin with a dash
1410 When making programmatic use of user properties, it is strongly suggested to
1415 component of property names to reduce the chance that two
1416 independently-developed packages use the same property name for different
1417 purposes. Property names beginning with
1419 are reserved for use by Sun Microsystems.
1421 The values of user properties are arbitrary strings, are always inherited, and
1422 are never validated. All of the commands that operate on properties
1429 can be used to manipulate both native properties and user properties. Use the
1431 command to clear a user property. If the property is not defined in any parent
1432 dataset, it is removed entirely. Property values are limited to 1024
1435 All subcommands that modify state are logged persistently to the pool in their
1443 Displays a help message.
1448 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1454 file system. The file system is automatically mounted according to the
1456 property inherited from the parent.
1457 .Bl -tag -width indent
1459 Creates all the non-existing parent datasets. Datasets created in this manner
1460 are automatically mounted according to the
1462 property inherited from their parent. Any property specified on the command
1465 option is ignored. If the target filesystem already exists, the operation
1466 completes successfully.
1468 Newly created file system is not mounted.
1469 .It Fl o Ar property Ns = Ns Ar value
1470 Sets the specified property as if the command
1471 .Qq Nm Cm set Ar property Ns = Ns Ar value
1472 was invoked at the same time the dataset was created. Any editable
1474 property can also be set at creation time. Multiple
1476 options can be specified. An error results if the same property is specified in
1485 .Op Fl b Ar blocksize
1486 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1491 Creates a volume of the given size. The volume is exported as a block device in
1492 .Pa /dev/zvol/path ,
1495 is the name of the volume in the
1497 namespace. The size represents the logical size as exported by the device. By
1498 default, a reservation of equal size is created.
1501 is automatically rounded up to the nearest 128 Kbytes to ensure that
1502 the volume has an integral number of blocks regardless of
1504 .Bl -tag -width indent
1506 Creates all the non-existing parent datasets. Datasets created in this manner
1507 are automatically mounted according to the
1509 property inherited from their parent. Any property specified on the command
1512 option is ignored. If the target filesystem already exists, the operation
1513 completes successfully.
1515 Creates a sparse volume with no reservation. See
1518 .Qq Sx Native Properties
1519 section for more information about sparse volumes.
1520 .It Fl b Ar blocksize
1522 .Fl o Cm volblocksize Ns = Ns Ar blocksize .
1523 If this option is specified in conjunction with
1524 .Fl o Cm volblocksize ,
1525 the resulting behavior is undefined.
1526 .It Fl o Ar property Ns = Ns Ar value
1527 Sets the specified property as if the
1528 .Qq Nm Cm set Ar property Ns = Ns Ar value
1529 command was invoked at the same time the dataset was created. Any editable
1531 property can also be set at creation time. Multiple
1533 options can be specified. An error results if the same property is specified in
1542 .Ar filesystem Ns | Ns Ar volume
1545 Destroys the given dataset. By default, the command unshares any file systems
1546 that are currently shared, unmounts any file systems that are currently
1547 mounted, and refuses to destroy a dataset that has active dependents (children
1549 .Bl -tag -width indent
1551 Recursively destroy all children.
1553 Recursively destroy all dependents, including cloned file systems outside the
1556 Force an unmount of any file systems using the
1557 .Qq Nm Cm unmount Fl f
1558 command. This option has no effect on non-file systems or unmounted file
1561 Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in
1562 conjunction with the
1566 flags to determine what data would be deleted.
1568 Print machine-parsable verbose information about the deleted data.
1570 Print verbose information about the deleted data.
1573 Extreme care should be taken when applying either the
1577 options, as they can destroy large portions of a pool and cause unexpected
1578 behavior for mounted file systems in use.
1585 .Op % Ns Ar snapname
1590 The given snapshots are destroyed immediately if and only if the
1594 option would have destroyed it. Such immediate destruction would occur, for
1595 example, if the snapshot had no clones and the user-initiated reference count
1598 If a snapshot does not qualify for immediate destruction, it is marked for
1599 deferred deletion. In this state, it exists as a usable, visible snapshot until
1600 both of the preconditions listed above are met, at which point it is destroyed.
1602 An inclusive range of snapshots may be specified by separating the
1603 first and last snapshots with a percent sign
1605 The first and/or last snapshots may be left blank, in which case the
1606 filesystem's oldest or newest snapshot will be implied.
1609 (or ranges of snapshots) of the same filesystem or volume may be specified
1610 in a comma-separated list of snapshots.
1611 Only the snapshot's short name (the
1614 should be specified when using a range or comma-separated list to identify
1616 .Bl -tag -width indent
1618 Destroy (or mark for deferred deletion) all snapshots with this name in
1619 descendent file systems.
1621 Recursively destroy all clones of these snapshots, including the clones,
1622 snapshots, and children.
1623 If this flag is specified, the
1625 flag will have no effect.
1627 Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in
1628 conjunction with the
1632 flags to determine what data would be deleted.
1634 Print machine-parsable verbose information about the deleted data.
1636 Print verbose information about the deleted data.
1638 Defer snapshot deletion.
1641 Extreme care should be taken when applying either the
1645 options, as they can destroy large portions of a pool and cause unexpected
1646 behavior for mounted file systems in use.
1651 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1652 .Ar filesystem@snapname Ns | Ns volume@snapname
1653 .Ar filesystem@snapname Ns | Ns volume@snapname Ns ...
1656 Creates snapshots with the given names. All previous modifications by
1657 successful system calls to the file system are part of the snapshots.
1658 Snapshots are taken atomically, so that all snapshots correspond to the same
1659 moment in time. See the
1661 section for details.
1662 .Bl -tag -width indent
1664 Recursively create snapshots of all descendent datasets
1665 .It Fl o Ar property Ns = Ns Ar value
1666 Sets the specified property; see
1677 Roll back the given dataset to a previous snapshot. When a dataset is rolled
1678 back, all data that has changed since the snapshot is discarded, and the
1679 dataset reverts to the state at the time of the snapshot. By default, the
1680 command refuses to roll back to a snapshot other than the most recent one. In
1681 order to do so, all intermediate snapshots must be destroyed by specifying the
1684 .Bl -tag -width indent
1686 Recursively destroy any snapshots more recent than the one specified.
1688 Recursively destroy any more recent snapshots, as well as any clones of those
1693 option to force an unmount of any clone file systems that are to be destroyed.
1699 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1700 .Ar snapshot filesystem Ns | Ns Ar volume
1703 Creates a clone of the given snapshot. See the
1705 section for details. The target dataset can be located anywhere in the
1707 hierarchy, and is created as the same type as the original.
1708 .Bl -tag -width indent
1710 Creates all the non-existing parent datasets. Datasets created in this manner
1711 are automatically mounted according to the
1713 property inherited from their parent. If the target filesystem or volume
1714 already exists, the operation completes successfully.
1715 .It Fl o Ar property Ns = Ns Ar value
1716 Sets the specified property; see
1723 .Ar clone-filesystem
1726 Promotes a clone file system to no longer be dependent on its "origin"
1727 snapshot. This makes it possible to destroy the file system that the clone was
1728 created from. The clone parent-child dependency relationship is reversed, so
1729 that the origin file system becomes a clone of the specified file system.
1731 The snapshot that was cloned, and any snapshots previous to this snapshot, are
1732 now owned by the promoted clone. The space they use moves from the origin file
1733 system to the promoted clone, so enough space must be available to accommodate
1734 these snapshots. No new space is consumed by this operation, but the space
1735 accounting is adjusted. The promoted clone must not have any conflicting
1736 snapshot names of its own. The
1738 subcommand can be used to rename any conflicting snapshots.
1743 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1744 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1751 .Ar filesystem Ns | Ns Ar volume
1752 .Ar filesystem Ns | Ns Ar volume
1759 .Ar filesystem filesystem
1762 Renames the given dataset. The new target can be located anywhere in the
1764 hierarchy, with the exception of snapshots. Snapshots can only be renamed
1765 within the parent file system or volume. When renaming a snapshot, the parent
1766 file system of the snapshot does not need to be specified as part of the second
1767 argument. Renamed file systems can inherit new mount points, in which case they
1768 are unmounted and remounted at the new mount point.
1769 .Bl -tag -width indent
1771 Creates all the nonexistent parent datasets. Datasets created in this manner
1772 are automatically mounted according to the
1774 property inherited from their parent.
1776 Do not remount file systems during rename. If a file system's
1782 file system is not unmounted even if this option is not given.
1784 Force unmount any filesystems that need to be unmounted in the process.
1785 This flag has no effect if used together with the
1793 .Ar snapshot snapshot
1796 Recursively rename the snapshots of all descendent datasets. Snapshots are the
1797 only dataset that can be renamed recursively.
1801 .Op Fl r Ns | Ns Fl d Ar depth
1803 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
1804 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
1805 .Oo Fl s Ar property Oc Ns ...
1806 .Oo Fl S Ar property Oc Ns ...
1807 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
1810 Lists the property information for the given datasets in tabular form. If
1811 specified, you can list property information by the absolute pathname or the
1812 relative pathname. By default, all file systems and volumes are displayed.
1813 Snapshots are displayed if the
1819 The following fields are displayed,
1820 .Sy name , used , available , referenced , mountpoint .
1821 .Bl -tag -width indent
1823 Recursively display any children of the dataset on the command line.
1825 Recursively display any children of the dataset, limiting the recursion to
1829 will display only the dataset and its direct children.
1831 Used for scripting mode. Do not print headers and separate fields by a single
1832 tab instead of arbitrary white space.
1833 .It Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
1834 A comma-separated list of properties to display. The property must be:
1835 .Bl -bullet -offset 2n
1837 One of the properties described in the
1838 .Qq Sx Native Properties
1845 to display the dataset name
1849 to display space usage properties on file systems and volumes. This is a
1850 shortcut for specifying
1852 .Sy name,avail,used,usedsnap,usedds,usedrefreserv,usedchild
1854 .Sy filesystem,volume
1857 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
1858 A comma-separated list of types to display, where
1861 .Sy filesystem , snapshot , volume , No or Sy all .
1862 For example, specifying
1864 displays only snapshots.
1865 .It Fl s Ar property
1866 A property for sorting the output by column in ascending order based on the
1867 value of the property. The property must be one of the properties described in
1870 section, or the special value
1872 to sort by the dataset name. Multiple properties can be specified at one time
1875 property options. Multiple
1877 options are evaluated from left to right in decreasing order of importance.
1879 The following is a list of sorting criteria:
1880 .Bl -bullet -offset 2n
1882 Numeric types sort in numeric order.
1884 String types sort in alphabetical order.
1886 Types inappropriate for a row sort that row to the literal bottom, regardless
1887 of the specified ordering.
1889 If no sorting options are specified the existing behavior of
1893 .It Fl S Ar property
1896 option, but sorts by property in descending order.
1901 .Ar property Ns = Ns Ar value
1902 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1905 Sets the property to the given value for each dataset. Only some properties can
1906 be edited. See the "Properties" section for more information on what properties
1907 can be set and acceptable values. Numeric values can be specified as exact
1908 values, or in a human-readable form with a suffix of
1909 .Sy B , K , M , G , T , P , E , Z
1910 (for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes, or
1911 zettabytes, respectively). User properties can be set on snapshots. For more
1912 information, see the
1913 .Qq Sx User Properties
1918 .Op Fl r Ns | Ns Fl d Ar depth
1920 .Op Fl o Ar all | field Ns Oo , Ns Ar field Oc Ns ...
1921 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
1922 .Op Fl s Ar source Ns Oo , Ns Ar source Oc Ns ...
1923 .Ar all | property Ns Oo , Ns Ar property Oc Ns ...
1924 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
1927 Displays properties for the given datasets. If no datasets are specified, then
1928 the command displays properties for all datasets on the system. For each
1929 property, the following columns are displayed:
1931 .Bl -hang -width "property" -offset indent -compact
1939 Property source. Can either be local, default, temporary, inherited, or none
1943 All columns except the
1945 column are displayed by default. The columns to display can be specified
1948 option. This command takes a comma-separated list of properties as described in
1950 .Qq Sx Native Properties
1952 .Qq Sx User Properties
1957 can be used to display all properties that apply to the given dataset's type
1958 (filesystem, volume, or snapshot).
1959 .Bl -tag -width indent
1961 Recursively display properties for any children.
1963 Recursively display any children of the dataset, limiting the recursion to
1967 will display only the dataset and its direct children.
1969 Display output in a form more easily parsed by scripts. Any headers are
1970 omitted, and fields are explicitly separated by a single tab instead of an
1971 arbitrary amount of space.
1973 Display numbers in parseable (exact) values.
1974 .It Fl o Cm all | Ar field Ns Oo , Ns Ar field Oc Ns ...
1975 A comma-separated list of columns to display. Supported values are
1976 .Sy name,property,value,received,source .
1978 .Sy name,property,value,source .
1981 specifies all columns.
1982 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
1983 A comma-separated list of types to display, where
1986 .Sy filesystem , snapshot , volume , No or Sy all .
1987 For example, specifying
1989 displays only snapshots.
1990 .It Fl s Ar source Ns Oo , Ns Ar source Oc Ns ...
1991 A comma-separated list of sources to display. Those properties coming from a
1992 source other than those in this list are ignored. Each source must be one of
1994 .Sy local,default,inherited,temporary,received,none .
1995 The default value is all sources.
2002 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns ...
2005 Clears the specified property, causing it to be inherited from an ancestor. If
2006 no ancestor has the property set, then the default value is used. See the
2008 section for a listing of default values, and details on which properties can be
2010 .Bl -tag -width indent
2012 Recursively inherit the given property for all children.
2014 For properties with a received value, revert to this value. This flag has no
2015 effect on properties that do not have a received value.
2023 Displays a list of file systems that are not the most recent version.
2024 .Bl -tag -width indent
2028 filesystem versions supported by the current software. The current
2030 filesystem version and all previous supported versions are displayed, along
2031 with an explanation of the features provided with each version.
2038 .Fl a | Ar filesystem
2041 Upgrades file systems to a new on-disk version. Once this is done, the file
2042 systems will no longer be accessible on systems running older versions of the
2045 streams generated from new snapshots of these file systems cannot be accessed
2046 on systems running older versions of the software.
2048 In general, the file system version is independent of the pool version. See
2050 for information on the
2051 .Nm zpool Cm upgrade
2054 In some cases, the file system version and the pool version are interrelated
2055 and the pool version must be upgraded before the file system version can be
2057 .Bl -tag -width indent
2059 Upgrade the specified file system and all descendent file systems.
2061 Upgrade to the specified
2065 flag is not specified, this command upgrades to the most recent version. This
2066 option can only be used to increase the version number, and only up to the most
2067 recent version supported by this software.
2069 Upgrade all file systems on all imported pools.
2071 Upgrade the specified file system.
2077 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2078 .Oo Fl s Ar field Oc Ns ...
2079 .Oo Fl S Ar field Oc Ns ...
2080 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2081 .Ar filesystem Ns | Ns Ar snapshot
2084 Displays space consumed by, and quotas on, each user in the specified
2085 filesystem or snapshot. This corresponds to the
2086 .Sy userused@ Ns Ar user
2088 .Sy userquota@ Ns Ar user
2090 .Bl -tag -width indent
2092 Print numeric ID instead of user/group name.
2094 Do not print headers, use tab-delimited output.
2096 Use exact (parsable) numeric output.
2097 .It Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2098 Display only the specified fields from the following set:
2099 .Sy type,name,used,quota .
2100 The default is to display all fields.
2102 Sort output by this field. The
2106 flags may be specified multiple times to sort first by one field, then by
2107 another. The default is
2108 .Fl s Cm type Fl s Cm name .
2110 Sort by this field in reverse order. See
2112 .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2113 Print only the specified types from the following set:
2114 .Sy all,posixuser,smbuser,posixgroup,smbgroup .
2117 .Fl t Cm posixuser,smbuser .
2119 The default can be changed to include group types.
2121 Translate SID to POSIX ID. This flag currently has no effect on
2128 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
2129 .Oo Fl s Ar field Oc Ns ...
2130 .Oo Fl S Ar field Oc Ns ...
2131 .Op Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
2132 .Ar filesystem Ns | Ns Ar snapshot
2135 Displays space consumed by, and quotas on, each group in the specified
2136 filesystem or snapshot. This subcommand is identical to
2137 .Qq Nm Cm userspace ,
2138 except that the default types to display are
2139 .Fl t Sy posixgroup,smbgroup .
2147 file systems currently mounted.
2148 .Bl -tag -width indent
2155 .Op Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2156 .Fl a | Ar filesystem
2162 .Bl -tag -width indent
2164 Report mount progress.
2166 Perform an overlay mount. Overlay mounts are not supported on
2168 .It Fl o Ar property Ns Oo , Ns Ar property Oc Ns ...
2169 An optional, comma-separated list of mount options to use temporarily for the
2170 duration of the mount. See the
2171 .Qq Sx Temporary Mount Point Properties
2172 section for details.
2177 This command may be executed on
2181 For more information, see variable
2186 Mount the specified filesystem.
2192 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
2195 Unmounts currently mounted
2198 .Bl -tag -width indent
2200 Forcefully unmount the file system, even if it is currently in use.
2202 Unmount all available
2205 .It Ar filesystem | mountpoint
2206 Unmount the specified filesystem. The command can also be given a path to a
2208 file system mount point on the system.
2213 .Fl a | Ar filesystem
2218 file systems that have the
2221 .Bl -tag -width indent
2225 file systems that have the
2228 This command may be executed on
2232 For more information, see variable
2237 Share the specified filesystem according to the
2239 property. File systems are shared when the
2246 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
2251 file systems that have the
2254 .Bl -tag -width indent
2258 file systems that have the
2261 This command may be executed on
2265 For more information, see variable
2269 .It Ar filesystem | mountpoint
2270 Unshare the specified filesystem. The command can also be given a path to a
2272 file system shared on the system.
2278 .Op Fl i Ar snapshot | Fl I Ar snapshot
2282 Creates a stream representation of the last
2284 argument (not part of
2288 which is written to standard output. The output can be redirected to
2289 a file or to a different system (for example, using
2291 By default, a full stream is generated.
2292 .Bl -tag -width indent
2293 .It Fl i Ar snapshot
2294 Generate an incremental stream from the
2298 The incremental source (the
2300 can be specified as the last component of the snapshot name (for example, the
2303 and it is assumed to be from the same file system as the last
2306 If the destination is a clone, the source may be the origin snapshot, which
2307 must be fully specified (for example,
2308 .Cm pool/fs@origin ,
2311 .It Fl I Ar snapshot
2312 Generate a stream package that sends all intermediary snapshots from the
2319 .Ic -i @a fs@b; -i @b fs@c; -i @c fs@d .
2320 The incremental source snapshot may be specified as with the
2324 Generate a replication stream package, which will replicate the specified
2325 filesystem, and all descendent file systems, up to the named snapshot. When
2326 received, all properties, snapshots, descendent file systems, and clones are
2333 flags are used in conjunction with the
2335 flag, an incremental replication stream is generated. The current values of
2336 properties, and current snapshot and file system names are set when the stream
2339 flag is specified when this stream is received, snapshots and file systems that
2340 do not exist on the sending side are destroyed.
2342 Generate a deduplicated stream. Blocks which would have been sent multiple
2343 times in the send stream will only be sent once. The receiving system must
2344 also support this feature to receive a deduplicated stream. This flag can
2345 be used regardless of the dataset's
2347 property, but performance will be much better if the filesystem uses a
2348 dedup-capable checksum (eg.
2351 Include the dataset's properties in the stream. This flag is implicit when
2353 is specified. The receiving system must also support this feature.
2355 Do a dry-run ("No-op") send. Do not generate any actual send data. This is
2356 useful in conjunction with the
2360 flags to determine what data will be sent.
2362 Print machine-parsable verbose information about the stream package generated.
2364 Print verbose information about the stream package generated.
2365 This information includes a per-second report of how much data has been sent.
2368 The format of the stream is committed. You will be able to receive your streams
2369 on future versions of
2375 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2385 Creates a snapshot whose contents are as specified in the stream provided on
2386 standard input. If a full stream is received, then a new file system is created
2387 as well. Streams are created using the
2389 subcommand, which by default creates a full stream.
2391 can be used as an alias for
2394 If an incremental stream is received, then the destination file system must
2395 already exist, and its most recent snapshot must match the incremental stream's
2398 the destination device link is destroyed and recreated, which means the
2400 cannot be accessed during the
2404 When a snapshot replication package stream that is generated by using the
2406 command is received, any snapshots that do not exist on the sending location
2407 are destroyed by using the
2408 .Qq Nm Cm destroy Fl d
2411 The name of the snapshot (and file system, if a full stream is received) that
2412 this subcommand creates depends on the argument type and the
2418 If the argument is a snapshot name, the specified
2420 is created. If the argument is a file system or volume name, a snapshot with
2421 the same name as the sent snapshot is created within the specified
2429 option is specified, the snapshot name is determined by appending the sent
2430 snapshot's name to the specified
2434 option is specified, all but the pool name of the sent snapshot path is
2435 appended (for example,
2437 appended from sent snapshot
2441 option is specified, only the tail of the sent snapshot path is appended (for
2444 appended from sent snapshot
2448 any file systems needed to replicate the path of the sent snapshot are created
2449 within the specified file system.
2450 .Bl -tag -width indent
2452 Use the full sent snapshot path without the first element (without pool name)
2453 to determine the name of the new snapshot as described in the paragraph above.
2455 Use only the last element of the sent snapshot path to determine the name of
2456 the new snapshot as described in the paragraph above.
2458 File system that is associated with the received stream is not mounted.
2460 Print verbose information about the stream and the time required to perform the
2463 Do not actually receive the stream. This can be useful in conjunction with the
2465 option to verify the name the receive operation would use.
2467 Force a rollback of the file system to the most recent snapshot before
2468 performing the receive operation. If receiving an incremental replication
2469 stream (for example, one generated by
2470 .Qq Nm Cm send Fl R Fi iI ) ,
2471 destroy snapshots and file systems that do not exist on the sending side.
2476 .Ar filesystem Ns | Ns Ar volume
2479 Displays permissions that have been delegated on the specified filesystem or
2480 volume. See the other forms of
2482 for more information.
2487 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
2488 .Ar perm Ns | Ns Ar @setname Ns
2489 .Oo Ns , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
2490 .Ar filesystem Ns | Ns Ar volume
2496 .Fl e Ns | Ns Cm everyone
2497 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
2499 .Ar filesystem Ns | Ns Ar volume
2504 administration permission for the file systems to non-privileged users.
2505 .Bl -tag -width indent
2508 .Ar user Ns | Ns Ar group Ns Oo , Ar user Ns | Ns Ar group Oc Ns ...
2510 Specifies to whom the permissions are delegated. Multiple entities can be
2511 specified as a comma-separated list. If neither of the
2513 options are specified, then the argument is interpreted preferentially as the
2516 then as a user name, and lastly as a group name. To specify
2517 a user or group named
2523 options. To specify a group with the same name as a user, use the
2526 .It Op Fl e Ns | Ns Cm everyone
2527 Specifies that the permissions be delegated to
2530 .Ar perm Ns | Ns Ar @setname Ns Oo , Ns Ar perm Ns | Ns Ar @setname Oc Ns ...
2532 The permissions to delegate. Multiple permissions
2533 may be specified as a comma-separated list. Permission names are the same as
2535 subcommand and property names. See the property list below. Property set names,
2536 which begin with an at sign
2538 may be specified. See the
2540 form below for details.
2543 .Ar filesystem Ns | Ns Ar volume
2545 Specifies where the permissions are delegated. If neither of the
2547 options are specified, or both are, then the permissions are allowed for the
2548 file system or volume, and all of its descendents. If only the
2550 option is used, then is allowed "locally" only for the specified file system.
2553 option is used, then is allowed only for the descendent file systems.
2556 Permissions are generally the ability to use a
2558 subcommand or change a
2560 property. The following permissions are available:
2561 .Bl -column -offset 4n "secondarycache" "subcommand"
2562 .It NAME Ta TYPE Ta NOTES
2563 .It allow Ta subcommand Ta Must Xo
2564 also have the permission that is being allowed
2566 .It clone Ta subcommand Ta Must Xo
2567 also have the 'create' ability and 'mount' ability in the origin file system
2569 .It create Ta subcommand Ta Must also have the 'mount' ability
2570 .It destroy Ta subcommand Ta Must also have the 'mount' ability
2571 .It diff Ta subcommand Ta Allows lookup of paths within a dataset given an
2572 object number, and the ability to create snapshots necessary to 'zfs diff'
2573 .It hold Ta subcommand Ta Allows adding a user hold to a snapshot
2574 .It mount Ta subcommand Ta Allows mount/umount of Tn ZFS No datasets
2575 .It promote Ta subcommand Ta Must Xo
2576 also have the 'mount' and 'promote' ability in the origin file system
2578 .It receive Ta subcommand Ta Must also have the 'mount' and 'create' ability
2579 .It release Ta subcommand Ta Allows Xo
2580 releasing a user hold which might destroy the snapshot
2582 .It rename Ta subcommand Ta Must Xo
2583 also have the 'mount' and 'create' ability in the new parent
2585 .It rollback Ta subcommand Ta Must also have the 'mount' ability
2586 .It send Ta subcommand
2587 .It share Ta subcommand Ta Allows Xo
2588 sharing file systems over the
2592 .It snapshot Ta subcommand Ta Must also have the 'mount' ability
2593 .It groupquota Ta other Ta Allows accessing any groupquota@... property
2594 .It groupused Ta other Ta Allows reading any groupused@... property
2595 .It userprop Ta other Ta Allows changing any user property
2596 .It userquota Ta other Ta Allows accessing any userquota@... property
2597 .It userused Ta other Ta Allows reading any userused@... property
2598 .It aclinherit Ta property
2599 .It aclmode Ta property
2600 .It atime Ta property
2601 .It canmount Ta property
2602 .It casesensitivity Ta property
2603 .It checksum Ta property
2604 .It compression Ta property
2605 .It copies Ta property
2606 .It dedup Ta property
2607 .It devices Ta property
2608 .It exec Ta property
2609 .It logbias Ta property
2610 .It jailed Ta property
2611 .It mlslabel Ta property
2612 .It mountpoint Ta property
2613 .It nbmand Ta property
2614 .It normalization Ta property
2615 .It primarycache Ta property
2616 .It quota Ta property
2617 .It readonly Ta property
2618 .It recordsize Ta property
2619 .It refquota Ta property
2620 .It refreservation Ta property
2621 .It reservation Ta property
2622 .It secondarycache Ta property
2623 .It setuid Ta property
2624 .It sharenfs Ta property
2625 .It sharesmb Ta property
2626 .It snapdir Ta property
2627 .It sync Ta property
2628 .It utf8only Ta property
2629 .It version Ta property
2630 .It volblocksize Ta property
2631 .It volsize Ta property
2632 .It vscan Ta property
2633 .It xattr Ta property
2639 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
2641 .Ar filesystem Ns | Ns Ar volume
2644 Sets "create time" permissions. These permissions are granted (locally) to the
2645 creator of any newly-created descendent file system.
2651 .Ar perm Ns | Ns Ar @setname Ns Op Ns , Ns Ar perm Ns | Ns Ar @setname Ns
2653 .Ar filesystem Ns | Ns Ar volume
2656 Defines or adds permissions to a permission set. The set can be used by other
2658 commands for the specified file system and its descendents. Sets are evaluated
2659 dynamically, so changes to a set are immediately reflected. Permission sets
2660 follow the same naming restrictions as ZFS file systems, but the name must
2661 begin with an "at sign"
2663 and can be no more than 64 characters long.
2668 .Ar user Ns | Ns Ar group Ns Oo Ns , Ns Ar user Ns | Ns Ar group Oc Ns ...
2669 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
2671 .Ar filesystem Ns | Ns Ar volume
2677 .Fl e Ns | Ns Cm everyone
2678 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
2680 .Ar filesystem Ns | Ns Ar volume
2687 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
2689 .Ar filesystem Ns | Ns Ar volume
2692 Removes permissions that were granted with the
2694 command. No permissions are explicitly denied, so other permissions granted are
2695 still in effect. For example, if the permission is granted by an ancestor. If
2696 no permissions are specified, then all permissions for the specified
2697 .Ar user , group , No or everyone
2698 are removed. Specifying
2700 .Po or using the Fl e
2702 .Pc only removes the permissions that were granted to everyone ,
2703 not all permissions for every user and group. See the
2705 command for a description of the
2708 .Bl -tag -width indent
2710 Recursively remove the permissions from this file system and all descendents.
2718 .Oo Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar perm Ns | Ns Ar @setname Ns
2720 .Ar filesystem Ns | Ns Ar volume
2723 Removes permissions from a permission set. If no permissions are specified,
2724 then all permissions are removed, thus removing the set entirely.
2729 .Ar tag snapshot Ns ...
2732 Adds a single reference, named with the
2734 argument, to the specified snapshot or snapshots. Each snapshot has its own tag
2735 namespace, and tags must be unique within that space.
2737 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
2741 .Bl -tag -width indent
2743 Specifies that a hold with the given tag is applied recursively to the
2744 snapshots of all descendent file systems.
2753 Lists all existing user references for the given snapshot or snapshots.
2754 .Bl -tag -width indent
2756 Lists the holds that are set on the named descendent snapshots, in addition to
2757 listing the holds on the named snapshot.
2763 .Ar tag snapshot Ns ...
2766 Removes a single reference, named with the
2768 argument, from the specified snapshot or snapshots. The tag must already exist
2770 .Bl -tag -width indent
2772 Recursively releases a hold with the given tag on the snapshots of all
2773 descendent file systems.
2780 .Op Ar snapshot Ns | Ns Ar filesystem
2783 Display the difference between a snapshot of a given filesystem and another
2784 snapshot of that filesystem from a later time or the current contents of the
2785 filesystem. The first column is a character indicating the type of change,
2786 the other columns indicate pathname, new pathname
2787 .Pq in case of rename ,
2788 change in link count, and optionally file type and/or change time.
2790 The types of change are:
2791 .Bl -column -offset 2n indent
2792 .It \&- Ta path was removed
2793 .It \&+ Ta path was added
2794 .It \&M Ta path was modified
2795 .It \&R Ta path was renamed
2797 .Bl -tag -width indent
2799 Display an indication of the type of file, in a manner similar to the
2803 .Bl -column -offset 2n indent
2804 .It \&B Ta block device
2805 .It \&C Ta character device
2806 .It \&F Ta regular file
2807 .It \&/ Ta directory
2808 .It \&@ Ta symbolic link
2810 .It \&> Ta door (not supported on Fx )
2811 .It \&| Ta named pipe (not supported on Fx )
2812 .It \&P Ta event port (not supported on Fx )
2815 Give more parseable tab-separated output, without header lines and without
2818 Display the path's inode change time as the first column of output.
2823 .Ar jailid filesystem
2826 Attaches the specified
2828 to the jail identified by JID
2830 From now on this file system tree can be managed from within a jail if the
2832 property has been set. To use this functionality, the jail needs the
2836 parameters set to 1 and the
2838 parameter set to a value lower than 2.
2842 for more information on managing jails and configuring the parameters above.
2846 .Ar jailid filesystem
2849 Detaches the specified
2851 from the jail identified by JID
2855 The following exit values are returned:
2856 .Bl -tag -offset 2n -width 2n
2858 Successful completion.
2862 Invalid command line options were specified.
2866 .It Sy Example 1 No Creating a Tn ZFS No File System Hierarchy
2868 The following commands create a file system named
2870 and a file system named
2874 is set for the parent file system, and is automatically inherited by the child
2876 .Bd -literal -offset 2n
2877 .Li # Ic zfs create pool/home
2878 .Li # Ic zfs set mountpoint=/home pool/home
2879 .Li # Ic zfs create pool/home/bob
2881 .It Sy Example 2 No Creating a Tn ZFS No Snapshot
2883 The following command creates a snapshot named
2885 This snapshot is mounted on demand in the
2887 directory at the root of the
2890 .Bd -literal -offset 2n
2891 .Li # Ic zfs snapshot pool/home/bob@yesterday
2893 .It Sy Example 3 No Creating and Destroying Multiple Snapshots
2895 The following command creates snapshots named
2899 and all of its descendent file systems. Each snapshot is mounted on demand in
2902 directory at the root of its file system. The second command destroys the newly
2904 .Bd -literal -offset 2n
2905 .Li # Ic zfs snapshot -r pool/home@yesterday
2906 .Li # Ic zfs destroy -r pool/home@yesterday
2908 .It Sy Example 4 No Disabling and Enabling File System Compression
2910 The following command disables the
2912 property for all file systems under
2914 The next command explicitly enables
2917 .Em pool/home/anne .
2918 .Bd -literal -offset 2n
2919 .Li # Ic zfs set compression=off pool/home
2920 .Li # Ic zfs set compression=on pool/home/anne
2922 .It Sy Example 5 No Listing Tn ZFS No Datasets
2924 The following command lists all active file systems and volumes in the system.
2925 Snapshots are displayed if the
2933 for more information on pool properties.
2934 .Bd -literal -offset 2n
2936 NAME USED AVAIL REFER MOUNTPOINT
2937 pool 450K 457G 18K /pool
2938 pool/home 315K 457G 21K /home
2939 pool/home/anne 18K 457G 18K /home/anne
2940 pool/home/bob 276K 457G 276K /home/bob
2942 .It Sy Example 6 No Setting a Quota on a Tn ZFS No File System
2944 The following command sets a quota of 50 Gbytes for
2946 .Bd -literal -offset 2n
2947 .Li # Ic zfs set quota=50G pool/home/bob
2949 .It Sy Example 7 No Listing Tn ZFS No Properties
2951 The following command lists all properties for
2953 .Bd -literal -offset 2n
2954 .Li # Ic zfs get all pool/home/bob
2955 NAME PROPERTY VALUE SOURCE
2956 pool/home/bob type filesystem -
2957 pool/home/bob creation Tue Jul 21 15:53 2009 -
2958 pool/home/bob used 21K -
2959 pool/home/bob available 20.0G -
2960 pool/home/bob referenced 21K -
2961 pool/home/bob compressratio 1.00x -
2962 pool/home/bob mounted yes -
2963 pool/home/bob quota 20G local
2964 pool/home/bob reservation none default
2965 pool/home/bob recordsize 128K default
2966 pool/home/bob mountpoint /home/bob default
2967 pool/home/bob sharenfs off default
2968 pool/home/bob checksum on default
2969 pool/home/bob compression on local
2970 pool/home/bob atime on default
2971 pool/home/bob devices on default
2972 pool/home/bob exec on default
2973 pool/home/bob setuid on default
2974 pool/home/bob readonly off default
2975 pool/home/bob jailed off default
2976 pool/home/bob snapdir hidden default
2977 pool/home/bob aclmode discard default
2978 pool/home/bob aclinherit restricted default
2979 pool/home/bob canmount on default
2980 pool/home/bob xattr on default
2981 pool/home/bob copies 1 default
2982 pool/home/bob version 5 -
2983 pool/home/bob utf8only off -
2984 pool/home/bob normalization none -
2985 pool/home/bob casesensitivity sensitive -
2986 pool/home/bob vscan off default
2987 pool/home/bob nbmand off default
2988 pool/home/bob sharesmb off default
2989 pool/home/bob refquota none default
2990 pool/home/bob refreservation none default
2991 pool/home/bob primarycache all default
2992 pool/home/bob secondarycache all default
2993 pool/home/bob usedbysnapshots 0 -
2994 pool/home/bob usedbydataset 21K -
2995 pool/home/bob usedbychildren 0 -
2996 pool/home/bob usedbyrefreservation 0 -
2997 pool/home/bob logbias latency default
2998 pool/home/bob dedup off default
2999 pool/home/bob mlslabel -
3000 pool/home/bob sync standard default
3001 pool/home/bob refcompressratio 1.00x -
3004 The following command gets a single property value.
3005 .Bd -literal -offset 2n
3006 .Li # Ic zfs get -H -o value compression pool/home/bob
3010 The following command lists all properties with local settings for
3012 .Bd -literal -offset 2n
3013 .Li # Ic zfs get -s local -o name,property,value all pool/home/bob
3015 pool/home/bob quota 20G
3016 pool/home/bob compression on
3018 .It Sy Example 8 No Rolling Back a Tn ZFS No File System
3020 The following command reverts the contents of
3022 to the snapshot named
3024 deleting all intermediate snapshots.
3025 .Bd -literal -offset 2n
3026 .Li # Ic zfs rollback -r pool/home/anne@yesterday
3028 .It Sy Example 9 No Creating a Tn ZFS No Clone
3030 The following command creates a writable file system whose initial contents are
3032 .Em pool/home/bob@yesterday .
3033 .Bd -literal -offset 2n
3034 .Li # Ic zfs clone pool/home/bob@yesterday pool/clone
3036 .It Sy Example 10 No Promoting a Tn ZFS No Clone
3038 The following commands illustrate how to test out changes to a file system, and
3039 then replace the original file system with the changed one, using clones, clone
3040 promotion, and renaming:
3041 .Bd -literal -offset 2n
3042 .Li # Ic zfs create pool/project/production
3046 .Pa /pool/project/production
3047 with data and continue with the following commands:
3048 .Bd -literal -offset 2n
3049 .Li # Ic zfs snapshot pool/project/production@today
3050 .Li # Ic zfs clone pool/project/production@today pool/project/beta
3054 .Pa /pool/project/beta
3055 and continue with the following commands:
3056 .Bd -literal -offset 2n
3057 .Li # Ic zfs promote pool/project/beta
3058 .Li # Ic zfs rename pool/project/production pool/project/legacy
3059 .Li # Ic zfs rename pool/project/beta pool/project/production
3062 Once the legacy version is no longer needed, it can be destroyed.
3063 .Bd -literal -offset 2n
3064 .Li # Ic zfs destroy pool/project/legacy
3066 .It Sy Example 11 No Inheriting Tn ZFS No Properties
3068 The following command causes
3074 property from their parent.
3075 .Bd -literal -offset 2n
3076 .Li # Ic zfs inherit checksum pool/home/bob pool/home/anne
3078 .It Sy Example 12 No Remotely Replicating Tn ZFS No Data
3080 The following commands send a full stream and then an incremental stream to a
3081 remote machine, restoring them into
3082 .Sy poolB/received/fs@a
3084 .Sy poolB/received/fs@b ,
3087 must contain the file system
3088 .Sy poolB/received ,
3089 and must not initially contain
3090 .Sy poolB/received/fs .
3091 .Bd -literal -offset 2n
3092 .Li # Ic zfs send pool/fs@a | ssh host zfs receive poolB/received/fs@a
3093 .Li # Ic zfs send -i a pool/fs@b | ssh host zfs receive poolB/received/fs
3102 The following command sends a full stream of
3103 .Sy poolA/fsA/fsB@snap
3104 to a remote machine, receiving it into
3105 .Sy poolB/received/fsA/fsB@snap .
3108 portion of the received snapshot's name is determined from the name of the sent
3111 must contain the file system
3112 .Sy poolB/received .
3114 .Sy poolB/received/fsA
3115 does not exist, it is created as an empty file system.
3116 .Bd -literal -offset 2n
3117 .Li # Ic zfs send poolA/fsA/fsB@snap | ssh host zfs receive -d poolB/received
3119 .It Sy Example 14 No Setting User Properties
3121 The following example sets the user-defined
3122 .Sy com.example:department
3123 property for a dataset.
3124 .Bd -literal -offset 2n
3125 .Li # Ic zfs set com.example:department=12345 tank/accounting
3127 .It Sy Example 15 No Performing a Rolling Snapshot
3129 The following example shows how to maintain a history of snapshots with a
3130 consistent naming scheme. To keep a week's worth of snapshots, the user
3131 destroys the oldest snapshot, renames the remaining snapshots, and then creates
3132 a new snapshot, as follows:
3133 .Bd -literal -offset 2n
3134 .Li # Ic zfs destroy -r pool/users@7daysago
3135 .Li # Ic zfs rename -r pool/users@6daysago @7daysago
3136 .Li # Ic zfs rename -r pool/users@5daysago @6daysago
3137 .Li # Ic zfs rename -r pool/users@4daysago @5daysago
3138 .Li # Ic zfs rename -r pool/users@3daysago @4daysago
3139 .Li # Ic zfs rename -r pool/users@2daysago @3daysago
3140 .Li # Ic zfs rename -r pool/users@yesterday @2daysago
3141 .Li # Ic zfs rename -r pool/users@today @yesterday
3142 .Li # Ic zfs snapshot -r pool/users@today
3148 Property Options on a ZFS File System
3151 The following command shows how to set
3153 property options to enable root access for a specific network on the
3155 file system. The contents of the
3160 .Bd -literal -offset 2n
3161 .Li # Ic zfs set sharenfs="maproot=root,network 192.168.0.0/24" tank/home
3164 Another way to write this command with the same result is:
3165 .Bd -literal -offset 2n
3166 .Li # Ic set zfs sharenfs="-maproot=root -network 192.168.0.0/24" tank/home
3172 Administration Permissions on a
3177 The following example shows how to set permissions so that user
3179 can create, destroy, mount, and take snapshots on
3184 .Bd -literal -offset 2n
3185 .Li # Ic zfs allow cindys create,destroy,mount,snapshot tank/cindys
3186 .Li # Ic zfs allow tank/cindys
3187 -------------------------------------------------------------
3188 Local+Descendent permissions on (tank/cindys)
3189 user cindys create,destroy,mount,snapshot
3190 -------------------------------------------------------------
3192 .It Sy Example 18 No Delegating Create Time Permissions on a Tn ZFS No Dataset
3194 The following example shows how to grant anyone in the group
3196 to create file systems in
3198 This syntax also allows staff members to destroy their own file systems, but
3199 not destroy anyone else's file system. The permissions on
3202 .Bd -literal -offset 2n
3203 .Li # Ic zfs allow staff create,mount tank/users
3204 .Li # Ic zfs allow -c destroy tank/users
3205 .Li # Ic zfs allow tank/users
3206 -------------------------------------------------------------
3207 Create time permissions on (tank/users)
3209 Local+Descendent permissions on (tank/users)
3210 group staff create,mount
3211 -------------------------------------------------------------
3215 Defining and Granting a Permission Set on a
3220 The following example shows how to define and grant a permission set on the
3222 file system. The permissions on
3225 .Bd -literal -offset 2n
3226 .Li # Ic zfs allow -s @pset create,destroy,snapshot,mount tank/users
3227 .Li # Ic zfs allow staff @pset tank/users
3228 .Li # Ic zfs allow tank/users
3229 -------------------------------------------------------------
3230 Permission sets on (tank/users)
3231 @pset create,destroy,mount,snapshot
3232 Create time permissions on (tank/users)
3234 Local+Descendent permissions on (tank/users)
3235 group staff @pset,create,mount
3236 -------------------------------------------------------------
3238 .It Sy Example 20 No Delegating Property Permissions on a Tn ZFS No Dataset
3240 The following example shows to grant the ability to set quotas and reservations
3243 file system. The permissions on
3246 .Bd -literal -offset 2n
3247 .Li # Ic zfs allow cindys quota,reservation users/home
3248 .Li # Ic zfs allow cindys
3249 -------------------------------------------------------------
3250 Local+Descendent permissions on (users/home)
3251 user cindys quota,reservation
3252 -------------------------------------------------------------
3253 .Li # Ic su - cindys
3254 .Li cindys% Ic zfs set quota=10G users/home/marks
3255 .Li cindys% Ic zfs get quota users/home/marks
3256 NAME PROPERTY VALUE SOURCE
3257 users/home/marks quota 10G local
3259 .It Sy Example 21 No Removing ZFS Delegated Permissions on a Tn ZFS No Dataset
3261 The following example shows how to remove the snapshot permission from the
3265 file system. The permissions on
3268 .Bd -literal -offset 2n
3269 .Li # Ic zfs unallow staff snapshot tank/users
3270 .Li # Ic zfs allow tank/users
3271 -------------------------------------------------------------
3272 Permission sets on (tank/users)
3273 @pset create,destroy,mount,snapshot
3274 Create time permissions on (tank/users)
3276 Local+Descendent permissions on (tank/users)
3277 group staff @pset,create,mount
3278 -------------------------------------------------------------
3280 .It Sy Example 22 Showing the differences between a snapshot and a ZFS Dataset
3282 The following example shows how to see what has changed between a prior
3283 snapshot of a ZFS Dataset and its current state. The
3285 option is used to indicate type information for the files affected.
3286 .Bd -literal -offset 2n
3287 .Li # Ic zfs diff tank/test@before tank/test
3289 M F /tank/test/linked (+1)
3290 R F /tank/test/oldname -> /tank/test/newname
3291 - F /tank/test/deleted
3292 + F /tank/test/created
3293 M F /tank/test/modified
3307 This manual page is a
3309 reimplementation of the
3313 modified and customized for
3315 and licensed under the
3316 Common Development and Distribution License
3321 implementation of this manual page was initially written by
3322 .An Martin Matuska Aq mm@FreeBSD.org .
projects / FreeBSD / FreeBSD.git / blob