2 .\" Copyright (c) 2012, 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 Nexenta Systems, Inc. All Rights Reserved.
23 .\" Copyright (c) 2011, Pawel Jakub Dawidek <pjd@FreeBSD.org>
32 .Nd configures ZFS file systems
39 .Op Fl o Ar property Ns = Ns Ar value
45 .Op Fl o Ar property Ns = Ns Ar value
52 .Ar filesystem Ns | Ns Ar volume
58 .Ns Op % Ns Ar snapname
64 .Op Fl o Ar property Ns = Ns Ar value
65 .Ar ... filesystem@snapname Ns | Ns Ar volume@snapname
73 .Op Fl o Ar property Ns = Ns Ar value
74 .Ar ... snapshot filesystem Ns | Ns Ar volume
81 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
82 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
87 .Ar filesystem Ns | Ns Ar volume
88 .Ar filesystem Ns | Ns Ar volume
97 .Ar filesystem filesystem
100 .Op Fl r Ns | Ns Fl d Ar depth
102 .Op Fl o Ar property Ns Op , Ns Ar ...
103 .Op Fl t Ar type Ns Op , Ns Ar ...
108 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
111 .Ar property Ns = Ns Ar value
112 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
115 .Op Fl r Ns | Ns Fl d Ar depth
117 .Op Fl o Ar all | field Ns Op , Ns Ar ...
118 .Op Fl t Ar type Ns Op , Ns Ar ...
119 .Op Fl s Ar source Ns Op , Ns Ar ...
120 .Ar all | property Ns Op , Ns Ar ...
121 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
126 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
134 .Fl a | Ar filesystem
138 .Op Fl o Ar field Ns Op , Ns Ar ...
141 .Op Fl t Ar type Ns Op , Ns Ar ...
142 .Ar filesystem Ns | Ns Ar snapshot
146 .Op Fl o Ar field Ns Op , Ns Ar ...
149 .Op Fl t Ar type Ns Op , Ns Ar ...
150 .Ar filesystem Ns | Ns Ar snapshot
156 .Op Fl o Ar property Ns Op , Ns Ar ...
157 .Fl a | Ar filesystem
161 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
164 .Fl a | Ar filesystem
167 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
171 .Op Fl i Ar snapshot | Fl I Ar snapshot
176 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
184 .Ar filesystem Ns | Ns Ar volume
188 .Cm everyone Ns | Ns Ar user Ns | Ns Ar group Ns Op , Ns Ar ...
189 .Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
190 .Ar filesystem Ns | Ns Ar volume
195 .Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
196 .Ar filesystem Ns | Ns Ar volume
200 .Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
201 .Ar filesystem Ns | Ns Ar volume
206 .Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
207 .Ar filesystem Ns | Ns Ar volume
211 .Cm everyone Ns | Ns Ar user Ns | Ns Ar group Ns Op , Ns Ar ...
212 .Op Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
213 .Ar filesystem Ns | Ns Ar volume
218 .Op Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
219 .Ar filesystem Ns | Ns Ar volume
224 .Op Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
225 .Ar filesystem Ns | Ns Ar volume
231 .Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
232 .Ar filesystem Ns | Ns Ar volume
249 .Op Ar snapshot Ns | Ns Ar filesystem
252 .Ar jailid filesystem
255 .Ar jailid filesystem
263 storage pool, as described in
265 A dataset is identified by a unique path within the
267 namespace. For example:
268 .Bd -ragged -offset 4n
269 .No pool/ Ns Brq filesystem,volume,snapshot
272 where the maximum length of a dataset name is
276 A dataset can be one of the following:
283 can be mounted within the standard system namespace and behaves like other file
286 file systems are designed to be
288 compliant, known issues exist that prevent compliance in some cases.
289 Applications that depend on standards conformance might fail due to nonstandard
290 behavior when checking file system free space.
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
296 A read-only version of a file system or volume at a given point in time. It is
302 .Ss ZFS File System Hierarchy
305 storage pool is a logical collection of devices that provide space for
306 datasets. A storage pool is also the root of the
308 file system hierarchy.
310 The root of the pool can be accessed as a file system, such as mounting and
311 unmounting, taking snapshots, and setting properties. The physical storage
312 characteristics, however, are managed by the
318 for more information on creating and administering pools.
320 A snapshot is a read-only copy of a file system or volume. Snapshots can be
321 created extremely quickly, and initially consume no additional space within the
322 pool. As data within the active dataset changes, the snapshot consumes more
323 data than would otherwise be shared with the active dataset.
325 Snapshots can have arbitrary names. Snapshots of volumes can be cloned or
326 rolled back, but cannot be accessed independently.
328 File system snapshots can be accessed under the
330 directory in the root of the file system. Snapshots are automatically mounted
331 on demand and may be unmounted at regular intervals. The visibility of the
333 directory can be controlled by the
337 A clone is a writable volume or file system whose initial contents are the same
338 as another dataset. As with snapshots, creating a clone is nearly
339 instantaneous, and initially consumes no additional space.
341 Clones can only be created from a snapshot. When a snapshot is cloned, it
342 creates an implicit dependency between the parent and child. Even though the
343 clone is created somewhere else in the dataset hierarchy, the original snapshot
344 cannot be destroyed as long as a clone exists. The
346 property exposes this dependency, and the
348 command lists any such dependencies, if they exist.
350 The clone parent-child dependency relationship can be reversed by using the
352 subcommand. This causes the "origin" file system to become a clone of the
353 specified file system, which makes it possible to destroy the file system that
354 the clone was created from.
358 file system is a simple operation, so the number of file systems per system is
359 likely to be numerous. To cope with this,
361 automatically manages mounting and unmounting file systems without the need to
364 file. All automatically managed file systems are mounted by
368 By default, file systems are mounted under
372 is the name of the file system in the
374 namespace. Directories are created and destroyed as needed.
376 A file system can also have a mount point set in the
378 property. This directory is created as needed, and
380 automatically mounts the file system when the
382 command is invoked (without editing
386 property can be inherited, so if
392 automatically inherits a mount point of
399 prevents the file system from being mounted.
403 file systems can also be managed with traditional tools
404 .Pq Xr mount 8 , Xr umount 8 , Xr fstab 5 .
405 If a file system's mount point is set to
408 makes no attempt to manage the file system, and the administrator is
409 responsible for mounting and unmounting the file system.
412 dataset can be attached to a jail by using the
414 subcommand. You cannot attach a dataset to one jail and the children of the
415 same dataset to another jails. To allow management of the dataset from within
418 property has to be set. The
420 property cannot be changed from within a jail.
423 dataset can be detached from a jail using the
427 After a dataset is attached to a jail and the jailed property is set, a jailed
428 file system cannot be mounted outside the jail, since the jail administrator
429 might have set the mount point to an unacceptable value.
431 Deduplication is the process for removing redundant data at the block-level,
432 reducing the total amount of data stored. If a file system has the
434 property enabled, duplicate data blocks are removed synchronously. The result
435 is that only unique data is stored and common components are shared among
437 .Ss Native Properties
438 Properties are divided into two types, native properties and user-defined (or
439 "user") properties. Native properties either export internal statistics or
442 behavior. In addition, native properties are either editable or read-only. User
443 properties have no effect on
445 behavior, but you can use them to annotate datasets in a way that is meaningful
446 in your environment. For more information about user properties, see the
447 .Qq Sx User Properties
450 Every dataset has a set of properties that export statistics about the dataset
451 as well as control various behaviors. Properties are inherited from the parent
452 unless overridden by the child. Some properties apply only to certain types of
453 datasets (file systems, volumes, or snapshots).
455 The values of numeric properties can be specified using human-readable suffixes
457 .Sy k , KB , M , Gb ,
460 for zettabyte). The following are all valid (and equal) specifications:
461 .Bd -ragged -offset 4n
465 The values of non-numeric properties are case sensitive and must be lowercase,
467 .Sy mountpoint , sharenfs , No and Sy sharesmb .
469 The following native properties consist of read-only statistics about the
470 dataset. These properties can be neither set, nor inherited. Native properties
471 apply to all dataset types unless otherwise noted.
474 The amount of space available to the dataset and all its children, assuming
475 that there is no other activity in the pool. Because space is shared within a
476 pool, availability can be limited by any number of factors, including physical
477 pool size, quotas, reservations, or other datasets within the pool.
479 This property can also be referred to by its shortened column name,
482 For non-snapshots, the compression ratio achieved for the
484 space of this dataset, expressed as a multiplier. The
486 property includes descendant datasets, and, for clones, does not include
487 the space shared with the origin snapshot. For snapshots, the
491 property. Compression can be turned on by running:
492 .Qq Nm Cm set compression=on Ar dataset
496 The time this dataset was created.
498 For snapshots, this property is a comma-separated list of filesystems or
499 volumes which are clones of this snapshot. The clones'
501 property is this snapshot. If the
503 property is not empty, then this snapshot can not be destroyed (even with the
511 if the snapshot has been marked for deferred destroy by using the
513 command. Otherwise, the property is
516 For file systems, indicates whether the file system is currently mounted. This
517 property can be either
522 For cloned file systems or volumes, the snapshot from which the clone was
523 created. See also the
527 The amount of data that is accessible by this dataset, which may or may not be
528 shared with other datasets in the pool. When a snapshot or clone is created, it
529 initially references the same amount of space as the file system or snapshot it
530 was created from, since its contents are identical.
532 This property can also be referred to by its shortened column name,
534 .It Sy refcompressratio
535 The compression ratio achieved for the
537 space of this dataset, expressed as a multiplier. See also the
542 .Sy filesystem , volume , No or Sy snapshot .
544 The amount of space consumed by this dataset and all its descendents. This is
545 the value that is checked against this dataset's quota and reservation. The
546 space used does not include this dataset's reservation, but does take into
547 account the reservations of any descendent datasets. The amount of space that a
548 dataset consumes from its parent, as well as the amount of space that are freed
549 if this dataset is recursively destroyed, is the greater of its space used and
552 When snapshots (see the
554 section) are created, their space is
555 initially shared between the snapshot and the file system, and possibly with
556 previous snapshots. As the file system changes, space that was previously
557 shared becomes unique to the snapshot, and counted in the snapshot's space
558 used. Additionally, deleting snapshots can increase the amount of space unique
559 to (and used by) other snapshots.
561 The amount of space used, available, or referenced does not take into account
562 pending changes. Pending changes are generally accounted for within a few
563 seconds. Committing a change to a disk using
567 does not necessarily guarantee that the space usage information is updated
572 properties decompose the
574 properties into the various reasons that space is used. Specifically,
576 .Sy usedbysnapshots + usedbydataset + usedbychildren + usedbyrefreservation .
577 These properties are only available for datasets created
580 pool version 13 pools and higher.
581 .It Sy usedbysnapshots
582 The amount of space consumed by snapshots of this dataset. In particular, it is
583 the amount of space that would be freed if all of this dataset's snapshots were
584 destroyed. Note that this is not simply the sum of the snapshots'
586 properties because space can be shared by multiple snapshots.
588 The amount of space used by this dataset itself, which would be freed if the
589 dataset were destroyed (after first removing any
591 and destroying any necessary snapshots or descendents).
592 .It Sy usedbychildren
593 The amount of space used by children of this dataset, which would be freed if
594 all the dataset's children were destroyed.
595 .It Sy usedbyrefreservation
596 The amount of space used by a
598 set on this dataset, which would be freed if the
601 .It Sy userused@ Ns Ar user
602 The amount of space consumed by the specified user in this dataset. Space is
603 charged to the owner of each file, as displayed by
605 The amount of space charged is displayed by
611 subcommand for more information.
613 Unprivileged users can access only their own space usage. The root user, or a
614 user who has been granted the
618 can access everyone's usage.
622 properties are not displayed by
624 The user's name must be appended after the
626 symbol, using one of the following forms:
627 .Bl -bullet -offset 2n
629 POSIX name (for example,
632 POSIX numeric ID (for example,
636 This property is set to the number of user holds on this snapshot. User holds
640 .It Sy groupused@ Ns Ar group
641 The amount of space consumed by the specified group in this dataset. Space is
642 charged to the group of each file, as displayed by
645 .Sy userused@ Ns Ar user
646 property for more information.
648 Unprivileged users can only access their own groups' space usage. The root
649 user, or a user who has been granted the
653 can access all groups' usage.
654 .It Sy volblocksize Ns = Ns Ar blocksize
655 For volumes, specifies the block size of the volume. The
657 cannot be changed once the volume has been written, so it should be set at
658 volume creation time. The default
660 for volumes is 8 Kbytes. Any
661 power of 2 from 512 bytes to 128 Kbytes is valid.
663 This property can also be referred to by its shortened column name,
668 space written to this dataset since the previous snapshot.
669 .It Sy written@ Ns Ar snapshot
672 space written to this dataset since the specified snapshot. This is the space
673 that is referenced by this dataset but was not referenced by the specified
678 may be specified as a short snapshot name (just the part after the
680 in which case it will be interpreted as a snapshot in the same filesystem as
683 may be a full snapshot name
684 .Pq Em filesystem@snapshot ,
685 which for clones may be a snapshot in the origin's filesystem (or the origin of
686 the origin's filesystem, etc).
689 The following native properties can be used to change the behavior of a
694 .Sy aclinherit Ns = Ns Cm discard |
702 entries are inherited when files and directories are created. A file system
709 entries. A file system with an
713 only inherits inheritable
715 entries that specify "deny" permissions. The property value
717 (the default) removes the
723 entry is inherited. A file system with an
727 inherits all inheritable
729 entries without any modifications made to the
731 entries when they are inherited. A file system with an
735 has the same meaning as
738 .Em owner@ , group@ , No and Em everyone@ Tn ACE Ns s
739 inherit the execute permission only if the file creation mode also requests the
742 When the property value is set to
744 files are created with a mode determined by the inheritable
748 exist that affect the mode, then the mode is set in accordance to the requested
749 mode from the application.
750 .It Sy aclmode Ns = Ns Cm discard | groupmask | passthrough
755 A file system with an
759 (the default) deletes all
761 entries that do not represent the mode of the file. An
765 reduces permissions granted in all
769 such that they are no greater than the group permissions specified by
771 A file system with an
775 indicates that no changes are made to the
777 other than creating or updating the necessary
779 entries to represent the new mode of the file or directory.
780 .It Sy atime Ns = Ns Cm on | off
781 Controls whether the access time for files is updated when they are read.
782 Turning this property off avoids producing write traffic when reading files and
783 can result in significant performance gains, though it might confuse mailers
784 and other similar utilities. The default value is
786 .It Sy canmount Ns = Ns Cm on | off | noauto
787 If this property is set to
789 the file system cannot be mounted, and is ignored by
790 .Qq Nm Cm mount Fl a .
791 Setting this property to
793 is similar to setting the
797 except that the dataset still has a normal
799 property, which can be inherited. Setting this property to
801 allows datasets to be used solely as a mechanism to inherit properties. One
803 .Sy canmount Ns = Ns Cm off
804 is to have two datasets with the same
806 so that the children of both datasets appear in the same directory, but might
807 have different inherited characteristics.
811 value is set, a dataset can only be mounted and unmounted explicitly. The
812 dataset is not mounted automatically when the dataset is created or imported,
813 nor is it mounted by the
815 command or unmounted by the
816 .Qq Nm Cm umount Fl a
819 This property is not inherited.
820 .It Sy checksum Ns = Ns Cm on | off | fletcher2 | fletcher4
821 Controls the checksum used to verify data integrity. The default value is
823 which automatically selects an appropriate algorithm (currently,
825 but this may change in future releases). The value
827 disables integrity checking on user data. Disabling checksums is
829 a recommended practice.
830 .It Sy compression Ns = Ns Cm on | off | lzjb | gzip | gzip- Ns Ar N | Cm zle
831 Controls the compression algorithm used for this dataset. The
833 compression algorithm is optimized for performance while providing decent data
834 compression. Setting compression to
838 compression algorithm. The
840 compression algorithm uses the same compression as the
842 command. You can specify the
844 level by using the value
848 is an integer from 1 (fastest) to 9 (best compression ratio). Currently,
852 (which is also the default for
856 compression algorithm compresses runs of zeros.
858 This property can also be referred to by its shortened column name
860 Changing this property affects only newly-written data.
861 .It Sy copies Ns = Ns Cm 1 | 2 | 3
862 Controls the number of copies of data stored for this dataset. These copies are
863 in addition to any redundancy provided by the pool, for example, mirroring or
864 RAID-Z. The copies are stored on different disks, if possible. The space used
865 by multiple copies is charged to the associated file and dataset, changing the
867 property and counting against quotas and reservations.
869 Changing this property only affects newly-written data. Therefore, set this
870 property at file system creation time by using the
871 .Fl o Cm copies= Ns Ar N
873 .It Sy dedup Ns = Ns Cm on | off | verify | sha256 Ns Op Cm ,verify
874 Configures deduplication for a dataset. The default value is
876 The default deduplication checksum is
878 (this may change in the future).
881 is enabled, the checksum defined here overrides the
883 property. Setting the value to
885 has the same effect as the setting
891 will do a byte-to-byte comparsion in case of two blocks having the same
892 signature to make sure the block contents are identical.
893 .It Sy devices Ns = Ns Cm on | off
896 property is currently not supported on
898 .It Sy exec Ns = Ns Cm on | off
899 Controls whether processes can be executed from within this file system. The
902 .It Sy mlslabel Ns = Ns Ar label | Cm none
905 property is currently not supported on
907 .It Sy mountpoint Ns = Ns Ar path | Cm none | legacy
908 Controls the mount point used for this file system. See the
910 section for more information on how this property is used.
914 property is changed for a file system, the file system and any children that
915 inherit the mount point are unmounted. If the new value is
917 then they remain unmounted. Otherwise, they are automatically remounted in the
918 new location if the property was previously
922 or if they were mounted before the property was changed. In addition, any
923 shared file systems are unshared and shared in the new location.
924 .It Sy nbmand Ns = Ns Cm on | off
927 property is currently not supported on
929 .It Sy primarycache Ns = Ns Cm all | none | metadata
930 Controls what is cached in the primary cache (ARC). If this property is set to
932 then both user data and metadata is cached. If this property is set to
934 then neither user data nor metadata is cached. If this property is set to
936 then only metadata is cached. The default value is
938 .It Sy quota Ns = Ns Ar size | Cm none
939 Limits the amount of space a dataset and its descendents can consume. This
940 property enforces a hard limit on the amount of space used. This includes all
941 space consumed by descendents, including file systems and snapshots. Setting a
942 quota on a descendent of a dataset that already has a quota does not override
943 the ancestor's quota, but rather imposes an additional limit.
945 Quotas cannot be set on volumes, as the
947 property acts as an implicit quota.
948 .It Sy userquota@ Ns Ar user Ns = Ns Ar size | Cm none
949 Limits the amount of space consumed by the specified user.
954 space calculation does not include space that is used by descendent datasets,
955 such as snapshots and clones. User space consumption is identified by the
956 .Sy userspace@ Ns Ar user
959 Enforcement of user quotas may be delayed by several seconds. This delay means
960 that a user might exceed their quota before the system notices that they are
961 over quota and begins to refuse additional writes with the
963 error message. See the
965 subcommand for more information.
967 Unprivileged users can only access their own groups' space usage. The root
968 user, or a user who has been granted the
972 can get and set everyone's quota.
974 This property is not available on volumes, on file systems before version 4, or
975 on pools before version 15. The
976 .Sy userquota@ Ns ...
977 properties are not displayed by
979 The user's name must be appended after the
981 symbol, using one of the following forms:
982 .Bl -bullet -offset 2n
984 POSIX name (for example,
987 POSIX numeric ID (for example,
990 .It Sy groupquota@ Ns Ar group Ns = Ns Ar size | Cm none
991 Limits the amount of space consumed by the specified group. Group space
992 consumption is identified by the
993 .Sy userquota@ Ns Ar user
996 Unprivileged users can access only their own groups' space usage. The root
997 user, or a user who has been granted the
1001 can get and set all groups' quotas.
1002 .It Sy readonly Ns = Ns Cm on | off
1003 Controls whether this dataset can be modified. The default value is
1005 .It Sy recordsize Ns = Ns Ar size
1006 Specifies a suggested block size for files in the file system. This property is
1007 designed solely for use with database workloads that access files in fixed-size
1010 automatically tunes block sizes according to internal algorithms optimized for
1011 typical access patterns.
1013 For databases that create very large files but access them in small random
1014 chunks, these algorithms may be suboptimal. Specifying a
1016 greater than or equal to the record size of the database can result in
1017 significant performance gains. Use of this property for general purpose file
1018 systems is strongly discouraged, and may adversely affect performance.
1020 The size specified must be a power of two greater than or equal to 512 and less
1021 than or equal to 128 Kbytes.
1023 Changing the file system's
1025 affects only files created afterward; existing files are unaffected.
1027 This property can also be referred to by its shortened column name,
1029 .It Sy refquota Ns = Ns Ar size | Cm none
1030 Limits the amount of space a dataset can consume. This property enforces a hard
1031 limit on the amount of space used. This hard limit does not include space used
1032 by descendents, including file systems and snapshots.
1033 .It Sy refreservation Ns = Ns Ar size | Cm none
1034 The minimum amount of space guaranteed to a dataset, not including its
1035 descendents. When the amount of space used is below this value, the dataset is
1036 treated as if it were taking up the amount of space specified by
1037 .Sy refreservation .
1040 reservation is accounted for in the parent datasets' space used, and counts
1041 against the parent datasets' quotas and reservations.
1045 is set, a snapshot is only allowed if there is enough free pool space outside
1046 of this reservation to accommodate the current number of "referenced" bytes in
1049 This property can also be referred to by its shortened column name,
1051 .It Sy reservation Ns = Ns Ar size | Cm none
1052 The minimum amount of space guaranteed to a dataset and its descendents. When
1053 the amount of space used is below this value, the dataset is treated as if it
1054 were taking up the amount of space specified by its reservation. Reservations
1055 are accounted for in the parent datasets' space used, and count against the
1056 parent datasets' quotas and reservations.
1058 This property can also be referred to by its shortened column name,
1060 .It Sy secondarycache Ns = Ns Cm all | none | metadata
1061 Controls what is cached in the secondary cache (L2ARC). If this property is set
1064 then both user data and metadata is cached. If this property is set to
1066 then neither user data nor metadata is cached. If this property is set to
1068 then only metadata is cached. The default value is
1070 .It Sy setuid Ns = Ns Cm on | off
1071 Controls whether the
1073 bit is respected for the file system. The default value is
1075 .It Sy sharesmb Ns = Ns Cm on | off | Ar opts
1078 property has currently no effect o
1080 .It Sy sharenfs Ns = Ns Cm on | off | Ar opts
1081 Controls whether the file system is shared via
1083 and what options are used. A file system with a
1087 is managed the traditional way via
1089 Otherwise, the file system is automatically shared and unshared with the
1093 commands. If the property is set to
1097 export options are used. Otherwise,
1099 export options are equivalent to the contents of this property. The export
1100 options may be comma-separated. See
1102 for a list of valid options.
1106 property is changed for a dataset, the
1109 .It Sy logbias Ns = Ns Cm latency | throughput
1112 about handling of synchronous requests in this dataset.
1119 will use pool log devices (if configured) to handle the requests at low
1125 will not use configured pool log devices.
1127 will instead optimize synchronous operations for global pool throughput and
1128 efficient use of resources.
1129 .It Sy snapdir Ns = Ns Cm hidden | visible
1130 Controls whether the
1132 directory is hidden or visible in the root of the file system as discussed in
1135 section. The default value is
1137 .It Sy sync Ns = Ns Cm standard | always | disabled
1138 Controls the behavior of synchronous requests (e.g.
1140 O_DSYNC). This property accepts the following values:
1141 .Bl -tag -offset 4n -width 8n
1143 This is the POSIX specified behavior of ensuring all synchronous requests are
1144 written to stable storage and all devices are flushed to ensure data is not
1145 cached by device controllers (this is the default).
1147 All file system transactions are written and flushed before their system calls
1148 return. This has a large performance penalty.
1150 Disables synchronous requests. File system transactions are only committed to
1151 stable storage periodically. This option will give the highest performance.
1152 However, it is very dangerous as
1154 would be ignoring the synchronous transaction demands of applications such as
1157 Administrators should only use this option when the risks are understood.
1159 .It Sy volsize Ns = Ns Ar size
1160 For volumes, specifies the logical size of the volume. By default, creating a
1161 volume establishes a reservation of equal size. For storage pools with a
1162 version number of 9 or higher, a
1164 is set instead. Any changes to
1166 are reflected in an equivalent change to the reservation (or
1167 .Sy refreservation ) .
1170 can only be set to a multiple of
1174 The reservation is kept equal to the volume's logical size to prevent
1175 unexpected behavior for consumers. Without the reservation, the volume could
1176 run out of space, resulting in undefined behavior or data corruption, depending
1177 on how the volume is used. These effects can also occur when the volume size is
1178 changed while it is in use (particularly when shrinking the size). Extreme care
1179 should be used when adjusting the volume size.
1181 Though not recommended, a "sparse volume" (also known as "thin provisioning")
1182 can be created by specifying the
1185 .Qq Nm Cm create Fl V
1186 command, or by changing the reservation after the volume has been created. A
1187 "sparse volume" is a volume where the reservation is less then the volume size.
1188 Consequently, writes to a sparse volume can fail with
1190 when the pool is low on space. For a sparse volume, changes to
1192 are not reflected in the reservation.
1193 .It Sy vscan Ns = Ns Cm off | on
1196 property is currently not supported on
1198 .It Sy xattr Ns = Ns Cm off | on
1201 property is currently not supported on
1203 .It Sy jailed Ns = Ns Cm off | on
1204 Controls whether the dataset is managed from a jail. See the
1206 section for more information. The default value is
1210 The following three properties cannot be changed after the file system is
1211 created, and therefore, should be set when the file system is created. If the
1212 properties are not set with the
1216 commands, these properties are inherited from the parent dataset. If the parent
1217 dataset lacks these properties due to having been created prior to these
1218 features being supported, the new file system will have the default values for
1221 .It Sy casesensitivity Ns = Ns Cm sensitive | insensitive | mixed
1224 property is currently not supported on
1226 .It Sy normalization Ns = Ns Cm none | formC | formD | formKC | formKD
1227 Indicates whether the file system should perform a
1229 normalization of file names whenever two file names are compared, and which
1230 normalization algorithm should be used. File names are always stored
1231 unmodified, names are normalized as part of any comparison process. If this
1232 property is set to a legal value other than
1236 property was left unspecified, the
1238 property is automatically set to
1240 The default value of the
1244 This property cannot be changed after the file system is created.
1245 .It Sy utf8only Ns = Ns Cm on | off
1246 Indicates whether the file system should reject file names that include
1247 characters that are not present in the
1249 character code set. If this property is explicitly set to
1251 the normalization property must either not be explicitly set or be set to
1253 The default value for the
1257 This property cannot be changed after the file system is created.
1261 .Sy casesensitivity , normalization , No and Sy utf8only
1262 properties are also new permissions that can be assigned to non-privileged
1265 delegated administration feature.
1266 .Ss Temporary Mount Point Properties
1267 When a file system is mounted, either through
1269 for legacy mounts or the
1271 command for normal file systems, its mount options are set according to its
1272 properties. The correlation between properties and mount options is as follows:
1273 .Bl -column -offset 4n "PROPERTY" "MOUNT OPTION"
1274 .It PROPERTY MOUNT OPTION
1275 .It atime atime/noatime
1276 .It exec exec/noexec
1278 .It setuid suid/nosuid
1281 In addition, these options can be set on a per-mount basis using the
1283 option, without affecting the property that is stored on disk. The values
1284 specified on the command line override the values stored in the dataset. These
1285 properties are reported as "temporary" by the
1287 command. If the properties are changed while the dataset is mounted, the new
1288 setting overrides any temporary settings.
1290 In addition to the standard native properties,
1292 supports arbitrary user properties. User properties have no effect on
1294 behavior, but applications or administrators can use them to annotate datasets
1295 (file systems, volumes, and snapshots).
1297 User property names must contain a colon
1299 character to distinguish them from native properties. They may contain
1300 lowercase letters, numbers, and the following punctuation characters: colon
1308 The expected convention is that the property name is divided into two portions
1310 .Em module Ns Sy \&: Ns Em property ,
1311 but this namespace is not enforced by
1313 User property names can be at most 256 characters, and cannot begin with a dash
1316 When making programmatic use of user properties, it is strongly suggested to
1321 component of property names to reduce the chance that two
1322 independently-developed packages use the same property name for different
1323 purposes. Property names beginning with
1325 are reserved for use by Sun Microsystems.
1327 The values of user properties are arbitrary strings, are always inherited, and
1328 are never validated. All of the commands that operate on properties
1335 can be used to manipulate both native properties and user properties. Use the
1337 command to clear a user property. If the property is not defined in any parent
1338 dataset, it is removed entirely. Property values are limited to 1024
1341 All subcommands that modify state are logged persistently to the pool in their
1349 Displays a help message.
1354 .Op Fl o Ar property Ns = Ns Ar value
1360 file system. The file system is automatically mounted according to the
1362 property inherited from the parent.
1363 .Bl -tag -width indent
1365 Creates all the non-existing parent datasets. Datasets created in this manner
1366 are automatically mounted according to the
1368 property inherited from their parent. Any property specified on the command
1371 option is ignored. If the target filesystem already exists, the operation
1372 completes successfully.
1373 .It Fl o Ar property Ns = Ns Ar value
1374 Sets the specified property as if the command
1375 .Qq Nm Cm set Ar property Ns = Ns Ar value
1376 was invoked at the same time the dataset was created. Any editable
1378 property can also be set at creation time. Multiple
1380 options can be specified. An error results if the same property is specified in
1389 .Op Fl b Ar blocksize
1390 .Op Fl o Ar property Ns = Ns Ar value
1396 Creates a volume of the given size. The volume is exported as a block device in
1397 .Pa /dev/zvol/path ,
1400 is the name of the volume in the
1402 namespace. The size represents the logical size as exported by the device. By
1403 default, a reservation of equal size is created.
1406 is automatically rounded up to the nearest 128 Kbytes to ensure that
1407 the volume has an integral number of blocks regardless of
1409 .Bl -tag -width indent
1411 Creates all the non-existing parent datasets. Datasets created in this manner
1412 are automatically mounted according to the
1414 property inherited from their parent. Any property specified on the command
1417 option is ignored. If the target filesystem already exists, the operation
1418 completes successfully.
1420 Creates a sparse volume with no reservation. See
1423 .Qq Sx Native Properties
1424 section for more information about sparse volumes.
1425 .It Fl b Ar blocksize
1427 .Fl o Cm volblocksize Ns = Ns Ar blocksize .
1428 If this option is specified in conjunction with
1429 .Fl o Cm volblocksize ,
1430 the resulting behavior is undefined.
1431 .It Fl o Ar property Ns = Ns Ar value
1432 Sets the specified property as if the
1433 .Qq Nm Cm set Ar property Ns = Ns Ar value
1434 command was invoked at the same time the dataset was created. Any editable
1436 property can also be set at creation time. Multiple
1438 options can be specified. An error results if the same property is specified in
1447 .Ar filesystem Ns | Ns Ar volume
1450 Destroys the given dataset. By default, the command unshares any file systems
1451 that are currently shared, unmounts any file systems that are currently
1452 mounted, and refuses to destroy a dataset that has active dependents (children
1454 .Bl -tag -width indent
1456 Recursively destroy all children.
1458 Recursively destroy all dependents, including cloned file systems outside the
1461 Force an unmount of any file systems using the
1462 .Qq Nm Cm unmount Fl f
1463 command. This option has no effect on non-file systems or unmounted file
1466 Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in
1467 conjunction with the
1471 flags to determine what data would be deleted.
1473 Print machine-parsable verbose information about the deleted data.
1475 Print verbose information about the deleted data.
1478 Extreme care should be taken when applying either the
1482 options, as they can destroy large portions of a pool and cause unexpected
1483 behavior for mounted file systems in use.
1490 .Ns Op % Ns Ar snapname
1495 The given snapshots are destroyed immediately if and only if the
1499 option would have destroyed it. Such immediate destruction would occur, for
1500 example, if the snapshot had no clones and the user-initiated reference count
1503 If a snapshot does not qualify for immediate destruction, it is marked for
1504 deferred deletion. In this state, it exists as a usable, visible snapshot until
1505 both of the preconditions listed above are met, at which point it is destroyed.
1507 An inclusive range of snapshots may be specified by separating the
1508 first and last snapshots with a percent sign
1510 The first and/or last snapshots may be left blank, in which case the
1511 filesystem's oldest or newest snapshot will be implied.
1514 (or ranges of snapshots) of the same filesystem or volume may be specified
1515 in a comma-separated list of snapshots.
1516 Only the snapshot's short name (the
1519 should be specified when using a range or comma-separated list to identify
1521 .Bl -tag -width indent
1523 Destroy (or mark for deferred deletion) all snapshots with this name in
1524 descendent file systems.
1526 Recursively destroy all dependents.
1528 Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in
1529 conjunction with the
1533 flags to determine what data would be deleted.
1535 Print machine-parsable verbose information about the deleted data.
1537 Print verbose information about the deleted data.
1539 Defer snapshot deletion.
1542 Extreme care should be taken when applying either the
1546 options, as they can destroy large portions of a pool and cause unexpected
1547 behavior for mounted file systems in use.
1552 .Op Fl o Ar property Ns = Ns Ar value
1554 .Ar filesystem@snapname Ns | Ns volume@snapname
1557 Creates a snapshot with the given name. All previous modifications by
1558 successful system calls to the file system are part of the snapshot. See the
1560 section for details.
1561 .Bl -tag -width indent
1563 Recursively create snapshots of all descendent datasets. Snapshots are taken
1564 atomically, so that all recursive snapshots correspond to the same moment in
1566 .It Fl o Ar property Ns = Ns Ar value
1567 Sets the specified property; see
1578 Roll back the given dataset to a previous snapshot. When a dataset is rolled
1579 back, all data that has changed since the snapshot is discarded, and the
1580 dataset reverts to the state at the time of the snapshot. By default, the
1581 command refuses to roll back to a snapshot other than the most recent one. In
1582 order to do so, all intermediate snapshots must be destroyed by specifying the
1585 .Bl -tag -width indent
1587 Recursively destroy any snapshots more recent than the one specified.
1589 Recursively destroy any more recent snapshots, as well as any clones of those
1594 option to force an unmount of any clone file systems that are to be destroyed.
1600 .Op Fl o Ar property Ns = Ns Ar value
1601 .Ar ... snapshot filesystem Ns | Ns Ar volume
1604 Creates a clone of the given snapshot. See the
1606 section for details. The target dataset can be located anywhere in the
1608 hierarchy, and is created as the same type as the original.
1609 .Bl -tag -width indent
1611 Creates all the non-existing parent datasets. Datasets created in this manner
1612 are automatically mounted according to the
1614 property inherited from their parent. If the target filesystem or volume
1615 already exists, the operation completes successfully.
1616 .It Fl o Ar property Ns = Ns Ar value
1617 Sets the specified property; see
1624 .Ar clone-filesystem
1627 Promotes a clone file system to no longer be dependent on its "origin"
1628 snapshot. This makes it possible to destroy the file system that the clone was
1629 created from. The clone parent-child dependency relationship is reversed, so
1630 that the origin file system becomes a clone of the specified file system.
1632 The snapshot that was cloned, and any snapshots previous to this snapshot, are
1633 now owned by the promoted clone. The space they use moves from the origin file
1634 system to the promoted clone, so enough space must be available to accommodate
1635 these snapshots. No new space is consumed by this operation, but the space
1636 accounting is adjusted. The promoted clone must not have any conflicting
1637 snapshot names of its own. The
1639 subcommand can be used to rename any conflicting snapshots.
1644 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1645 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1652 .Ar filesystem Ns | Ns Ar volume
1653 .Ar filesystem Ns | Ns Ar volume
1660 .Ar filesystem filesystem
1663 Renames the given dataset. The new target can be located anywhere in the
1665 hierarchy, with the exception of snapshots. Snapshots can only be renamed
1666 within the parent file system or volume. When renaming a snapshot, the parent
1667 file system of the snapshot does not need to be specified as part of the second
1668 argument. Renamed file systems can inherit new mount points, in which case they
1669 are unmounted and remounted at the new mount point.
1670 .Bl -tag -width indent
1672 Creates all the nonexistent parent datasets. Datasets created in this manner
1673 are automatically mounted according to the
1675 property inherited from their parent.
1677 Do not remount file systems during rename. If a file system's
1683 file system is not unmounted even if this option is not given.
1685 Force unmount any filesystems that need to be unmounted in the process.
1686 This flag has no effect if used together with the
1694 .Ar snapshot snapshot
1697 Recursively rename the snapshots of all descendent datasets. Snapshots are the
1698 only dataset that can be renamed recursively.
1702 .Op Fl r Ns | Ns Fl d Ar depth
1704 .Op Fl o Ar property Ns Op , Ns Ar ...
1705 .Op Fl t Ar type Ns Op , Ns Ar ...
1706 .Op Fl s Ar property
1708 .Op Fl S Ar property
1710 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1713 Lists the property information for the given datasets in tabular form. If
1714 specified, you can list property information by the absolute pathname or the
1715 relative pathname. By default, all file systems and volumes are displayed.
1716 Snapshots are displayed if the
1722 The following fields are displayed,
1723 .Sy name , used , available , referenced , mountpoint .
1724 .Bl -tag -width indent
1726 Recursively display any children of the dataset on the command line.
1728 Recursively display any children of the dataset, limiting the recursion to
1732 will display only the dataset and its direct children.
1734 Used for scripting mode. Do not print headers and separate fields by a single
1735 tab instead of arbitrary white space.
1736 .It Fl o Ar property Ns Op , Ns Ar ...
1737 A comma-separated list of properties to display. The property must be:
1738 .Bl -bullet -offset 2n
1740 One of the properties described in the
1741 .Qq Sx Native Properties
1748 to display the dataset name
1752 to display space usage properties on file systems and volumes. This is a
1753 shortcut for specifying
1755 .Sy name,avail,used,usedsnap,usedds,usedrefreserv,usedchild
1757 .Sy filesystem,volume
1760 .It Fl t Ar type Ns Op , Ns Ar ...
1761 A comma-separated list of types to display, where
1764 .Sy filesystem , snapshot , volume , No or Sy all .
1765 For example, specifying
1767 displays only snapshots.
1768 .It Fl s Ar property
1769 A property for sorting the output by column in ascending order based on the
1770 value of the property. The property must be one of the properties described in
1773 section, or the special value
1775 to sort by the dataset name. Multiple properties can be specified at one time
1778 property options. Multiple
1780 options are evaluated from left to right in decreasing order of importance.
1782 The following is a list of sorting criteria:
1783 .Bl -bullet -offset 2n
1785 Numeric types sort in numeric order.
1787 String types sort in alphabetical order.
1789 Types inappropriate for a row sort that row to the literal bottom, regardless
1790 of the specified ordering.
1792 If no sorting options are specified the existing behavior of
1796 .It Fl S Ar property
1799 option, but sorts by property in descending order.
1804 .Ar property Ns = Ns Ar value
1805 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1808 Sets the property to the given value for each dataset. Only some properties can
1809 be edited. See the "Properties" section for more information on what properties
1810 can be set and acceptable values. Numeric values can be specified as exact
1811 values, or in a human-readable form with a suffix of
1812 .Sy B , K , M , G , T , P , E , Z
1813 (for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes, or
1814 zettabytes, respectively). User properties can be set on snapshots. For more
1815 information, see the
1816 .Qq Sx User Properties
1821 .Op Fl r Ns | Ns Fl d Ar depth
1823 .Op Fl o Ar all | field Ns Op , Ns Ar ...
1824 .Op Fl t Ar type Ns Op , Ns Ar ...
1825 .Op Fl s Ar source Ns Op , Ns Ar ...
1826 .Ar all | property Ns Op , Ns Ar ...
1827 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1830 Displays properties for the given datasets. If no datasets are specified, then
1831 the command displays properties for all datasets on the system. For each
1832 property, the following columns are displayed:
1834 .Bl -hang -width "property" -offset indent -compact
1842 Property source. Can either be local, default, temporary, inherited, or none
1846 All columns except the
1848 column are displayed by default. The columns to display can be specified
1851 option. This command takes a comma-separated list of properties as described in
1853 .Qq Sx Native Properties
1855 .Qq Sx User Properties
1860 can be used to display all properties that apply to the given dataset's type
1861 (filesystem, volume, or snapshot).
1862 .Bl -tag -width indent
1864 Recursively display properties for any children.
1866 Recursively display any children of the dataset, limiting the recursion to
1870 will display only the dataset and its direct children.
1872 Display output in a form more easily parsed by scripts. Any headers are
1873 omitted, and fields are explicitly separated by a single tab instead of an
1874 arbitrary amount of space.
1876 Display numbers in parseable (exact) values.
1877 .It Fl o Cm all | Ar field Ns Op , Ns Ar ...
1878 A comma-separated list of columns to display. Supported values are
1879 .Sy name,property,value,received,source .
1881 .Sy name,property,value,source .
1884 specifies all columns.
1885 .It Fl t Ar type Ns Op , Ns Ar ...
1886 A comma-separated list of types to display, where
1889 .Sy filesystem , snapshot , volume , No or Sy all .
1890 For example, specifying
1892 displays only snapshots.
1893 .It Fl s Ar source Ns Op , Ns Ar ...
1894 A comma-separated list of sources to display. Those properties coming from a
1895 source other than those in this list are ignored. Each source must be one of
1897 .Sy local,default,inherited,temporary,received,none .
1898 The default value is all sources.
1905 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
1908 Clears the specified property, causing it to be inherited from an ancestor. If
1909 no ancestor has the property set, then the default value is used. See the
1911 section for a listing of default values, and details on which properties can be
1913 .Bl -tag -width indent
1915 Recursively inherit the given property for all children.
1917 For properties with a received value, revert to this value. This flag has no
1918 effect on properties that do not have a received value.
1926 Displays a list of file systems that are not the most recent version.
1927 .Bl -tag -width indent
1931 filesystem versions supported by the current software. The current
1933 filesystem version and all previous supported versions are displayed, along
1934 with an explanation of the features provided with each version.
1941 .Fl a | Ar filesystem
1944 Upgrades file systems to a new on-disk version. Once this is done, the file
1945 systems will no longer be accessible on systems running older versions of the
1948 streams generated from new snapshots of these file systems cannot be accessed
1949 on systems running older versions of the software.
1951 In general, the file system version is independent of the pool version. See
1953 for information on the
1954 .Nm zpool Cm upgrade
1957 In some cases, the file system version and the pool version are interrelated
1958 and the pool version must be upgraded before the file system version can be
1960 .Bl -tag -width indent
1962 Upgrade the specified file system and all descendent file systems.
1964 Upgrade to the specified
1968 flag is not specified, this command upgrades to the most recent version. This
1969 option can only be used to increase the version number, and only up to the most
1970 recent version supported by this software.
1972 Upgrade all file systems on all imported pools.
1974 Upgrade the specified file system.
1980 .Op Fl o Ar field Ns Op , Ns Ar ...
1983 .Op Fl t Ar type Ns Op , Ns Ar ...
1984 .Ar filesystem Ns | Ns Ar snapshot
1987 Displays space consumed by, and quotas on, each user in the specified
1988 filesystem or snapshot. This corresponds to the
1989 .Sy userused@ Ns Ar user
1991 .Sy userquota@ Ns Ar user
1993 .Bl -tag -width indent
1995 Print numeric ID instead of user/group name.
1997 Do not print headers, use tab-delimited output.
1999 Use exact (parseable) numeric output.
2000 .It Fl o Ar field Ns Op , Ns Ar ...
2001 Display only the specified fields from the following set,
2002 .Sy type,name,used,quota .
2003 The default is to display all fields.
2005 Sort output by this field. The
2009 flags may be specified multiple times to sort first by one field, then by
2010 another. The default is
2011 .Fl s Cm type Fl s Cm name .
2013 Sort by this field in reverse order. See
2015 .It Fl t Ar type Ns Op , Ns Ar ...
2016 Print only the specified types from the following set,
2017 .Sy all,posixuser,smbuser,posixgroup,smbgroup .
2020 .Fl t Cm posixuser,smbuser .
2022 The default can be changed to include group types.
2024 Translate SID to POSIX ID. This flag has currently no effect on
2031 .Op Fl o Ar field Ns Op , Ns Ar ...
2034 .Op Fl t Ar type Ns Op , Ns Ar ...
2035 .Ar filesystem Ns | Ns Ar snapshot
2038 Displays space consumed by, and quotas on, each group in the specified
2039 filesystem or snapshot. This subcommand is identical to
2040 .Qq Nm Cm userspace ,
2041 except that the default types to display are
2042 .Fl t Sy posixgroup,smbgroup .
2050 file systems currently mounted.
2051 .Bl -tag -width indent
2058 .Op Fl o Ar property Ns Op , Ns Ar ...
2059 .Fl a | Ar filesystem
2065 .Bl -tag -width indent
2067 Report mount progress.
2069 Perform an overlay mount. Overlay mounts are not supported on
2071 .It Fl o Ar property Ns Op , Ns Ar ...
2072 An optional, comma-separated list of mount options to use temporarily for the
2073 duration of the mount. See the
2074 .Qq Sx Temporary Mount Point Properties
2075 section for details.
2080 This command may be executed on
2084 For more information, see variable
2089 Mount the specified filesystem.
2095 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
2098 Unmounts currently mounted
2101 .Bl -tag -width indent
2103 Forcefully unmount the file system, even if it is currently in use.
2105 Unmount all available
2108 .It Ar filesystem | mountpoint
2109 Unmount the specified filesystem. The command can also be given a path to a
2111 file system mount point on the system.
2116 .Fl a | Ar filesystem
2121 file systems that have the
2124 .Bl -tag -width indent
2128 file systems that have the
2131 This command may be executed on
2135 For more information, see variable
2140 Share the specified filesystem according to the
2142 property. File systems are shared when the
2149 .Fl a | Ar filesystem Ns | Ns Ar mountpoint
2154 file systems that have the
2157 .Bl -tag -width indent
2161 file systems that have the
2164 This command may be executed on
2168 For more information, see variable
2172 .It Ar filesystem | mountpoint
2173 Unshare the specified filesystem. The command can also be given a path to a
2175 file system shared on the system.
2181 .Op Fl i Ar snapshot | Fl I Ar snapshot
2185 Creates a stream representation of the last
2187 argument (not part of
2191 which is written to standard output. The output can be redirected to
2192 a file or to a different system (for example, using
2194 By default, a full stream is generated.
2195 .Bl -tag -width indent
2196 .It Fl i Ar snapshot
2197 Generate an incremental stream from the
2201 The incremental source (the
2203 can be specified as the last component of the snapshot name (for example, the
2206 and it is assumed to be from the same file system as the last
2209 If the destination is a clone, the source may be the origin snapshot, which
2210 must be fully specified (for example,
2211 .Cm pool/fs@origin ,
2214 .It Fl I Ar snapshot
2215 Generate a stream package that sends all intermediary snapshots from the
2222 .Ic -i @a fs@b; -i @b fs@c; -i @c fs@d .
2223 The incremental source snapshot may be specified as with the
2227 Generate a replication stream package, which will replicate the specified
2228 filesystem, and all descendent file systems, up to the named snapshot. When
2229 received, all properties, snapshots, descendent file systems, and clones are
2236 flags are used in conjunction with the
2238 flag, an incremental replication stream is generated. The current values of
2239 properties, and current snapshot and file system names are set when the stream
2242 flag is specified when this stream is received, snapshots and file systems that
2243 do not exist on the sending side are destroyed.
2245 Generate a deduplicated stream. Blocks which would have been sent multiple
2246 times in the send stream will only be sent once. The receiving system must
2247 also support this feature to receive a deduplicated stream. This flag can
2248 be used regardless of the dataset's
2250 property, but performance will be much better if the filesystem uses a
2251 dedup-capable checksum (eg.
2254 Recursively send all descendant snapshots. This is similar to the
2256 flag, but information about deleted and renamed datasets is not included, and
2257 property information is only included if the
2261 Include the dataset's properties in the stream. This flag is implicit when
2263 is specified. The receiving system must also support this feature.
2265 Do a dry-run ("No-op") send. Do not generate any actual send data. This is
2266 useful in conjunction with the
2270 flags to determine what data will be sent.
2272 Print machine-parsable verbose information about the stream package generated.
2274 Print verbose information about the stream package generated.
2277 The format of the stream is committed. You will be able to receive your streams
2278 on future versions of
2284 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot
2294 Creates a snapshot whose contents are as specified in the stream provided on
2295 standard input. If a full stream is received, then a new file system is created
2296 as well. Streams are created using the
2298 subcommand, which by default creates a full stream.
2300 can be used as an alias for
2303 If an incremental stream is received, then the destination file system must
2304 already exist, and its most recent snapshot must match the incremental stream's
2307 the destination device link is destroyed and recreated, which means the
2309 cannot be accessed during the
2313 When a snapshot replication package stream that is generated by using the
2315 command is received, any snapshots that do not exist on the sending location
2316 are destroyed by using the
2317 .Qq Nm Cm destroy Fl d
2320 The name of the snapshot (and file system, if a full stream is received) that
2321 this subcommand creates depends on the argument type and the
2327 If the argument is a snapshot name, the specified
2329 is created. If the argument is a file system or volume name, a snapshot with
2330 the same name as the sent snapshot is created within the specified
2338 option is specified, the snapshot name is determined by appending the sent
2339 snapshot's name to the specified
2343 option is specified, all but the pool name of the sent snapshot path is
2344 appended (for example,
2346 appended from sent snapshot
2350 option is specified, only the tail of the sent snapshot path is appended (for
2353 appended from sent snapshot
2357 any file systems needed to replicate the path of the sent snapshot are created
2358 within the specified file system.
2359 .Bl -tag -width indent
2361 Use the full sent snapshot path without the first element (without pool name)
2362 to determine the name of the new snapshot as described in the paragraph above.
2364 Use only the last element of the sent snapshot path to determine the name of
2365 the new snapshot as described in the paragraph above.
2367 File system that is associated with the received stream is not mounted.
2369 Print verbose information about the stream and the time required to perform the
2372 Do not actually receive the stream. This can be useful in conjunction with the
2374 option to verify the name the receive operation would use.
2376 Force a rollback of the file system to the most recent snapshot before
2377 performing the receive operation. If receiving an incremental replication
2378 stream (for example, one generated by
2379 .Qq Nm Cm send Fl R Fi iI ) ,
2380 destroy snapshots and file systems that do not exist on the sending side.
2385 .Ar filesystem Ns | Ns Ar volume
2388 Displays permissions that have been delegated on the specified filesystem or
2389 volume. See the other forms of
2391 for more information.
2396 .Cm everyone Ns | Ns Ar user Ns | Ns Ar group Ns Op , Ns Ar ...
2397 .Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
2398 .Ar filesystem Ns | Ns Ar volume
2405 .Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
2406 .Ar filesystem Ns | Ns Ar volume
2411 administration permission for the file systems to non-privileged users.
2412 .Bl -tag -width indent
2415 .Cm everyone Ns | Ns Ar user Ns | Ns Ar group Ns Op , Ns Ar ...
2417 Specifies to whom the permissions are delegated. Multiple entities can be
2418 specified as a comma-separated list. If neither of the
2420 options are specified, then the argument is interpreted preferentially as the
2421 keyword "everyone", then as a user name, and lastly as a group name. To specify
2422 a user or group named "everyone", use the
2426 options. To specify a group with the same name as a user, use the
2431 .Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
2433 Specifies that the permissions be delegated to "everyone".
2434 Multiple permissions
2435 may be specified as a comma-separated list. Permission names are the same as
2437 subcommand and property names. See the property list below. Property set names,
2438 which begin with an at sign
2440 may be specified. See the
2442 form below for details.
2445 .Ar filesystem Ns | Ns Ar volume
2447 Specifies where the permissions are delegated. If neither of the
2449 options are specified, or both are, then the permissions are allowed for the
2450 file system or volume, and all of its descendents. If only the
2452 option is used, then is allowed "locally" only for the specified file system.
2455 option is used, then is allowed only for the descendent file systems.
2458 Permissions are generally the ability to use a
2460 subcommand or change a
2462 property. The following permissions are available:
2463 .Bl -column -offset 4n "secondarycache" "subcommand"
2464 .It NAME Ta TYPE Ta NOTES
2465 .It Xo allow Ta subcommand Ta Must
2466 also have the permission that is being allowed
2468 .It Xo clone Ta subcommand Ta Must
2469 also have the 'create' ability and 'mount' ability in the origin file system
2471 .It create Ta subcommand Ta Must also have the 'mount' ability
2472 .It destroy Ta subcommand Ta Must also have the 'mount' ability
2473 .It hold Ta subcommand Ta Allows adding a user hold to a snapshot
2474 .It mount Ta subcommand Ta Allows mount/umount of Tn ZFS No datasets
2475 .It Xo promote Ta subcommand Ta Must
2476 also have the 'mount' and 'promote' ability in the origin file system
2478 .It receive Ta subcommand Ta Must also have the 'mount' and 'create' ability
2479 .It Xo release Ta subcommand Ta Allows
2480 releasing a user hold which might destroy the snapshot
2482 .It Xo rename Ta subcommand Ta Must
2483 also have the 'mount' and 'create' ability in the new parent
2485 .It rollback Ta subcommand Ta Must also have the 'mount' ability
2486 .It send Ta subcommand
2487 .It share Ta subcommand Ta Allows Xo
2488 sharing file systems over the
2492 .It snapshot Ta subcommand Ta Must also have the 'mount' ability
2493 .It groupquota Ta other Ta Allows accessing any groupquota@... property
2494 .It groupused Ta other Ta Allows reading any groupused@... property
2495 .It userprop Ta other Ta Allows changing any user property
2496 .It userquota Ta other Ta Allows accessing any userquota@... property
2497 .It userused Ta other Ta Allows reading any userused@... property
2499 .It aclinherit Ta property
2500 .It aclmode Ta property
2501 .It atime Ta property
2502 .It canmount Ta property
2503 .It casesensitivity Ta property
2504 .It checksum Ta property
2505 .It compression Ta property
2506 .It copies Ta property
2507 .It dedup Ta property
2508 .It devices Ta property
2509 .It exec Ta property
2510 .It logbias Ta property
2511 .It jailed Ta property
2512 .It mlslabel Ta property
2513 .It mountpoint Ta property
2514 .It nbmand Ta property
2515 .It normalization Ta property
2516 .It primarycache Ta property
2517 .It quota Ta property
2518 .It readonly Ta property
2519 .It recordsize Ta property
2520 .It refquota Ta property
2521 .It refreservation Ta property
2522 .It reservation Ta property
2523 .It secondarycache Ta property
2524 .It setuid Ta property
2525 .It sharenfs Ta property
2526 .It sharesmb Ta property
2527 .It snapdir Ta property
2528 .It sync Ta property
2529 .It utf8only Ta property
2530 .It version Ta property
2531 .It volblocksize Ta property
2532 .It volsize Ta property
2533 .It vscan Ta property
2534 .It xattr Ta property
2540 .Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
2541 .Ar filesystem Ns | Ns Ar volume
2544 Sets "create time" permissions. These permissions are granted (locally) to the
2545 creator of any newly-created descendent file system.
2551 .Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
2552 .Ar filesystem Ns | Ns Ar volume
2555 Defines or adds permissions to a permission set. The set can be used by other
2557 commands for the specified file system and its descendents. Sets are evaluated
2558 dynamically, so changes to a set are immediately reflected. Permission sets
2559 follow the same naming restrictions as ZFS file systems, but the name must
2560 begin with an "at sign"
2562 and can be no more than 64 characters long.
2567 .Cm everyone Ns | Ns Ar user Ns | Ns Ar group Ns Op , Ns Ar ...
2568 .Op Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
2569 .Ar filesystem Ns | Ns Ar volume
2576 .Op Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
2577 .Ar filesystem Ns | Ns Ar volume
2584 .Op Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
2585 .Ar filesystem Ns | Ns Ar volume
2588 Removes permissions that were granted with the
2590 command. No permissions are explicitly denied, so other permissions granted are
2591 still in effect. For example, if the permission is granted by an ancestor. If
2592 no permissions are specified, then all permissions for the specified
2593 .Ar user , group , No or Ar everyone
2594 are removed. Specifying "everyone" (or using the
2596 option) only removes the permissions that were granted to "everyone",
2597 not all permissions for every user and group. See the
2599 command for a description of the
2602 .Bl -tag -width indent
2604 Recursively remove the permissions from this file system and all descendents.
2612 .Ar perm Ns | Ns Ar @setname Ns Op , Ns Ar ...
2613 .Ar filesystem Ns | Ns Ar volume
2616 Removes permissions from a permission set. If no permissions are specified,
2617 then all permissions are removed, thus removing the set entirely.
2622 .Ar tag snapshot ...
2625 Adds a single reference, named with the
2627 argument, to the specified snapshot or snapshots. Each snapshot has its own tag
2628 namespace, and tags must be unique within that space.
2630 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
2634 .Bl -tag -width indent
2636 Specifies that a hold with the given tag is applied recursively to the
2637 snapshots of all descendent file systems.
2646 Lists all existing user references for the given snapshot or snapshots.
2647 .Bl -tag -width indent
2649 Lists the holds that are set on the named descendent snapshots, in addition to
2650 listing the holds on the named snapshot.
2656 .Ar tag snapshot ...
2659 Removes a single reference, named with the
2661 argument, from the specified snapshot or snapshots. The tag must already exist
2663 .Bl -tag -width indent
2665 Recursively releases a hold with the given tag on the snapshots of all
2666 descendent file systems.
2673 .Op Ar snapshot Ns | Ns Ar filesystem
2676 Describes differences between a snapshot and a successor dataset. The
2677 successor dataset can be a later snapshot or the current filesystem.
2679 The changed files are displayed including the change type. The change type
2680 is displayed useing a single character. If a file or directory was renamed,
2681 the old and the new names are displayed.
2683 The following change types can be displayed:
2685 .Bl -column -offset indent "CHARACTER" "CHANGE TYPE"
2686 .It CHARACTER Ta CHANGE TYPE
2687 .It \&+ Ta file was added
2688 .It \&- Ta file was removed
2689 .It \&M Ta file was modified
2690 .It \&R Ta file was renamed
2692 .Bl -tag -width indent
2694 Display a single letter for the file type in second to last column.
2696 The following file types can be displayed:
2698 .Bl -column -offset indent "CHARACTER" "FILE TYPE"
2699 .It CHARACTER Ta FILE TYPE
2701 .It \&/ Ta directory
2702 .It \&B Ta block device
2703 .It \&@ Ta symbolic link
2705 .It \&> Ta door (not supported on Fx )
2706 .It \&| Ta FIFO (not supported on Fx )
2707 .It \&P Ta event portal (not supported on Fx )
2710 Machine-parseable output, fields separated a tab character.
2712 Display a change timestamp in the first column.
2717 .Ar jailid filesystem
2720 Attaches the specified
2722 to the jail identified by JID
2724 From now on this file system tree can be managed from within a jail if the
2726 property has been set. To use this functionality, the jail needs the
2737 for more information on managing jails and configuring the parameters above.
2741 .Ar jailid filesystem
2744 Detaches the specified
2746 from the jail identified by JID
2751 .It Sy Example 1 No Creating a Tn ZFS No File System Hierarchy
2753 The following commands create a file system named
2755 and a file system named
2759 is set for the parent file system, and is automatically inherited by the child
2761 .Bd -literal -offset 2n
2762 .Li # Ic zfs create pool/home
2763 .Li # Ic zfs set mountpoint=/home pool/home
2764 .Li # Ic zfs create pool/home/bob
2766 .It Sy Example 2 No Creating a Tn ZFS No Snapshot
2768 The following command creates a snapshot named
2770 This snapshot is mounted on demand in the
2772 directory at the root of the
2775 .Bd -literal -offset 2n
2776 .Li # Ic zfs snapshot pool/home/bob@yesterday
2778 .It Sy Example 3 No Creating and Destroying Multiple Snapshots
2780 The following command creates snapshots named
2784 and all of its descendent file systems. Each snapshot is mounted on demand in
2787 directory at the root of its file system. The second command destroys the newly
2789 .Bd -literal -offset 2n
2790 .Li # Ic zfs snapshot -r pool/home@yesterday
2791 .Li # Ic zfs destroy -r pool/home@yesterday
2793 .It Sy Example 4 No Disabling and Enabling File System Compression
2795 The following command disables the
2797 property for all file systems under
2799 The next command explicitly enables
2802 .Em pool/home/anne .
2803 .Bd -literal -offset 2n
2804 .Li # Ic zfs set compression=off pool/home
2805 .Li # Ic zfs set compression=on pool/home/anne
2807 .It Sy Example 5 No Listing Tn ZFS No Datasets
2809 The following command lists all active file systems and volumes in the system.
2810 Snapshots are displayed if the
2818 for more information on pool properties.
2819 .Bd -literal -offset 2n
2821 NAME USED AVAIL REFER MOUNTPOINT
2822 pool 450K 457G 18K /pool
2823 pool/home 315K 457G 21K /home
2824 pool/home/anne 18K 457G 18K /home/anne
2825 pool/home/bob 276K 457G 276K /home/bob
2827 .It Sy Example 6 No Setting a Quota on a Tn ZFS No File System
2829 The following command sets a quota of 50 Gbytes for
2831 .Bd -literal -offset 2n
2832 .Li # Ic zfs set quota=50G pool/home/bob
2834 .It Sy Example 7 No Listing Tn ZFS No Properties
2836 The following command lists all properties for
2838 .Bd -literal -offset 2n
2839 .Li # Ic zfs get all pool/home/bob
2840 NAME PROPERTY VALUE SOURCE
2841 pool/home/bob type filesystem -
2842 pool/home/bob creation Tue Jul 21 15:53 2009 -
2843 pool/home/bob used 21K -
2844 pool/home/bob available 20.0G -
2845 pool/home/bob referenced 21K -
2846 pool/home/bob compressratio 1.00x -
2847 pool/home/bob mounted yes -
2848 pool/home/bob quota 20G local
2849 pool/home/bob reservation none default
2850 pool/home/bob recordsize 128K default
2851 pool/home/bob mountpoint /home/bob default
2852 pool/home/bob sharenfs off default
2853 pool/home/bob checksum on default
2854 pool/home/bob compression on local
2855 pool/home/bob atime on default
2856 pool/home/bob devices on default
2857 pool/home/bob exec on default
2858 pool/home/bob setuid on default
2859 pool/home/bob readonly off default
2860 pool/home/bob jailed off default
2861 pool/home/bob snapdir hidden default
2862 pool/home/bob aclmode discard default
2863 pool/home/bob aclinherit restricted default
2864 pool/home/bob canmount on default
2865 pool/home/bob xattr on default
2866 pool/home/bob copies 1 default
2867 pool/home/bob version 5 -
2868 pool/home/bob utf8only off -
2869 pool/home/bob normalization none -
2870 pool/home/bob casesensitivity sensitive -
2871 pool/home/bob vscan off default
2872 pool/home/bob nbmand off default
2873 pool/home/bob sharesmb off default
2874 pool/home/bob refquota none default
2875 pool/home/bob refreservation none default
2876 pool/home/bob primarycache all default
2877 pool/home/bob secondarycache all default
2878 pool/home/bob usedbysnapshots 0 -
2879 pool/home/bob usedbydataset 21K -
2880 pool/home/bob usedbychildren 0 -
2881 pool/home/bob usedbyrefreservation 0 -
2882 pool/home/bob logbias latency default
2883 pool/home/bob dedup off default
2884 pool/home/bob mlslabel -
2885 pool/home/bob sync standard default
2886 pool/home/bob refcompressratio 1.00x -
2889 The following command gets a single property value.
2890 .Bd -literal -offset 2n
2891 .Li # Ic zfs get -H -o value compression pool/home/bob
2895 The following command lists all properties with local settings for
2897 .Bd -literal -offset 2n
2898 .Li # Ic zfs get -s local -o name,property,value all pool/home/bob
2900 pool/home/bob quota 20G
2901 pool/home/bob compression on
2903 .It Sy Example 8 No Rolling Back a Tn ZFS No File System
2905 The following command reverts the contents of
2907 to the snapshot named
2909 deleting all intermediate snapshots.
2910 .Bd -literal -offset 2n
2911 .Li # Ic zfs rollback -r pool/home/anne@yesterday
2913 .It Sy Example 9 No Creating a Tn ZFS No Clone
2915 The following command creates a writable file system whose initial contents are
2917 .Em pool/home/bob@yesterday .
2918 .Bd -literal -offset 2n
2919 .Li # Ic zfs clone pool/home/bob@yesterday pool/clone
2921 .It Sy Example 10 No Promoting a Tn ZFS No Clone
2923 The following commands illustrate how to test out changes to a file system, and
2924 then replace the original file system with the changed one, using clones, clone
2925 promotion, and renaming:
2926 .Bd -literal -offset 2n
2927 .Li # Ic zfs create pool/project/production
2931 .Pa /pool/project/production
2932 with data and continue with the following commands:
2933 .Bd -literal -offset 2n
2934 .Li # Ic zfs snapshot pool/project/production@today
2935 .Li # Ic zfs clone pool/project/production@today pool/project/beta
2939 .Pa /pool/project/beta
2940 and continue with the following commands:
2941 .Bd -literal -offset 2n
2942 .Li # Ic zfs promote pool/project/beta
2943 .Li # Ic zfs rename pool/project/production pool/project/legacy
2944 .Li # Ic zfs rename pool/project/beta pool/project/production
2947 Once the legacy version is no longer needed, it can be destroyed.
2948 .Bd -literal -offset 2n
2949 .Li # Ic zfs destroy pool/project/legacy
2951 .It Sy Example 11 No Inheriting Tn ZFS No Properties
2953 The following command causes
2959 property from their parent.
2960 .Bd -literal -offset 2n
2961 .Li # Ic zfs inherit checksum pool/home/bob pool/home/anne
2963 .It Sy Example 12 No Remotely Replicating Tn ZFS No Data
2965 The following commands send a full stream and then an incremental stream to a
2966 remote machine, restoring them into
2967 .Sy poolB/received/fs@a
2969 .Sy poolB/received/fs@b ,
2972 must contain the file system
2973 .Sy poolB/received ,
2974 and must not initially contain
2975 .Sy poolB/received/fs .
2976 .Bd -literal -offset 2n
2977 .Li # Ic zfs send pool/fs@a | ssh host zfs receive poolB/received/fs@a
2978 .Li # Ic zfs send -i a pool/fs@b | ssh host zfs receive poolB/received/fs
2987 The following command sends a full stream of
2988 .Sy poolA/fsA/fsB@snap
2989 to a remote machine, receiving it into
2990 .Sy poolB/received/fsA/fsB@snap .
2993 portion of the received snapshot's name is determined from the name of the sent
2996 must contain the file system
2997 .Sy poolB/received .
2999 .Sy poolB/received/fsA
3000 does not exist, it is created as an empty file system.
3001 .Bd -literal -offset 2n
3002 .Li # Ic zfs send poolA/fsA/fsB@snap | ssh host zfs receive -d poolB/received
3004 .It Sy Example 14 No Setting User Properties
3006 The following example sets the user-defined
3007 .Sy com.example:department
3008 property for a dataset.
3009 .Bd -literal -offset 2n
3010 .Li # Ic zfs set com.example:department=12345 tank/accounting
3012 .It Sy Example 15 No Performing a Rolling Snapshot
3014 The following example shows how to maintain a history of snapshots with a
3015 consistent naming scheme. To keep a week's worth of snapshots, the user
3016 destroys the oldest snapshot, renames the remaining snapshots, and then creates
3017 a new snapshot, as follows:
3018 .Bd -literal -offset 2n
3019 .Li # Ic zfs destroy -r pool/users@7daysago
3020 .Li # Ic zfs rename -r pool/users@6daysago @7daysago
3021 .Li # Ic zfs rename -r pool/users@5daysago @6daysago
3022 .Li # Ic zfs rename -r pool/users@yesterday @5daysago
3023 .Li # Ic zfs rename -r pool/users@yesterday @4daysago
3024 .Li # Ic zfs rename -r pool/users@yesterday @3daysago
3025 .Li # Ic zfs rename -r pool/users@yesterday @2daysago
3026 .Li # Ic zfs rename -r pool/users@today @yesterday
3027 .Li # Ic zfs snapshot -r pool/users@today
3033 Property Options on a ZFS File System
3036 The following command shows how to set
3038 property options to enable root access for a specific network on the
3040 file system. The contents of the
3045 .Bd -literal -offset 2n
3046 .Li # Ic zfs set sharenfs="maproot=root,network 192.168.0.0/24" tank/home
3049 Another way to write this command with the same result is:
3050 .Bd -literal -offset 2n
3051 .Li # Ic set zfs sharenfs="-maproot=root -network 192.168.0.0/24" tank/home
3057 Administration Permissions on a
3062 The following example shows how to set permissions so that user
3064 can create, destroy, mount, and take snapshots on
3069 .Bd -literal -offset 2n
3070 .Li # Ic zfs allow cindys create,destroy,mount,snapshot tank/cindys
3071 .Li # Ic zfs allow tank/cindys
3072 -------------------------------------------------------------
3073 Local+Descendent permissions on (tank/cindys)
3074 user cindys create,destroy,mount,snapshot
3075 -------------------------------------------------------------
3077 .It Sy Example 18 No Delegating Create Time Permissions on a Tn ZFS No Dataset
3079 The following example shows how to grant anyone in the group
3081 to create file systems in
3083 This syntax also allows staff members to destroy their own file systems, but
3084 not destroy anyone else's file system. The permissions on
3087 .Bd -literal -offset 2n
3088 .Li # Ic zfs allow staff create,mount tank/users
3089 .Li # Ic zfs allow -c destroy tank/users
3090 .Li # Ic zfs allow tank/users
3091 -------------------------------------------------------------
3092 Create time permissions on (tank/users)
3094 Local+Descendent permissions on (tank/users)
3095 group staff create,mount
3096 -------------------------------------------------------------
3100 Defining and Granting a Permission Set on a
3105 The following example shows how to define and grant a permission set on the
3107 file system. The permissions on
3110 .Bd -literal -offset 2n
3111 .Li # Ic zfs allow -s @pset create,destroy,snapshot,mount tank/users
3112 .Li # Ic zfs allow staff @pset tank/users
3113 .Li # Ic zfs allow tank/users
3114 -------------------------------------------------------------
3115 Permission sets on (tank/users)
3116 @pset create,destroy,mount,snapshot
3117 Create time permissions on (tank/users)
3119 Local+Descendent permissions on (tank/users)
3120 group staff @pset,create,mount
3121 -------------------------------------------------------------
3123 .It Sy Example 20 No Delegating Property Permissions on a Tn ZFS No Dataset
3125 The following example shows to grant the ability to set quotas and reservations
3128 file system. The permissions on
3131 .Bd -literal -offset 2n
3132 .Li # Ic zfs allow cindys quota,reservation users/home
3133 .Li # Ic zfs allow cindys
3134 -------------------------------------------------------------
3135 Local+Descendent permissions on (users/home)
3136 user cindys quota,reservation
3137 -------------------------------------------------------------
3138 .Li # Ic su - cindys
3139 .Li cindys% Ic zfs set quota=10G users/home/marks
3140 .Li cindys% Ic zfs get quota users/home/marks
3141 NAME PROPERTY VALUE SOURCE
3142 users/home/marks quota 10G local
3144 .It Sy Example 21 No Removing ZFS Delegated Permissions on a Tn ZFS No Dataset
3146 The following example shows how to remove the snapshot permission from the
3150 file system. The permissions on
3153 .Bd -literal -offset 2n
3154 .Li # Ic zfs unallow staff snapshot tank/users
3155 .Li # Ic zfs allow tank/users
3156 -------------------------------------------------------------
3157 Permission sets on (tank/users)
3158 @pset create,destroy,mount,snapshot
3159 Create time permissions on (tank/users)
3161 Local+Descendent permissions on (tank/users)
3162 group staff @pset,create,mount
3163 -------------------------------------------------------------
3167 The following exit values are returned:
3168 .Bl -tag -offset 2n -width 2n
3170 Successful completion.
3174 Invalid command line options were specified.
3187 This manual page is a
3189 reimplementation of the
3193 modified and customized for
3195 and licensed under the
3196 Common Development and Distribution License
3201 implementation of this manual page was initially written by
3202 .An Martin Matuska Aq mm@FreeBSD.org .
projects / FreeBSD / stable / 8.git / blob