ZFS(1M) Maintenance Commands ZFS(1M) NNAAMMEE zzffss - configures ZFS file systems SSYYNNOOPPSSIISS zzffss [--??] zzffss ccrreeaattee [--pp] [--oo _p_r_o_p_e_r_t_y=_v_a_l_u_e]... _f_i_l_e_s_y_s_t_e_m zzffss ccrreeaattee [--ppss] [--bb _b_l_o_c_k_s_i_z_e] [--oo _p_r_o_p_e_r_t_y=_v_a_l_u_e]... --VV _s_i_z_e _v_o_l_u_m_e zzffss ddeessttrrooyy [--RRffnnpprrvv] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss ddeessttrrooyy [--RRddnnpprrvv] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e@_s_n_a_p[%_s_n_a_p[,_s_n_a_p[%_s_n_a_p]]]... zzffss ddeessttrrooyy _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e#_b_o_o_k_m_a_r_k zzffss ssnnaappsshhoott [--rr] [--oo _p_r_o_p_e_r_t_y=value]... _f_i_l_e_s_y_s_t_e_m@_s_n_a_p_n_a_m_e|_v_o_l_u_m_e@_s_n_a_p_n_a_m_e... zzffss rroollllbbaacckk [--RRffrr] _s_n_a_p_s_h_o_t zzffss cclloonnee [--pp] [--oo _p_r_o_p_e_r_t_y=_v_a_l_u_e]... _s_n_a_p_s_h_o_t _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss pprroommoottee _c_l_o_n_e_-_f_i_l_e_s_y_s_t_e_m zzffss rreennaammee [--ff] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e|_s_n_a_p_s_h_o_t _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e|_s_n_a_p_s_h_o_t zzffss rreennaammee [--ffpp] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss rreennaammee --rr _s_n_a_p_s_h_o_t _s_n_a_p_s_h_o_t zzffss lliisstt [--rr|--dd _d_e_p_t_h] [--HHpp] [--oo _p_r_o_p_e_r_t_y[,_p_r_o_p_e_r_t_y]...] [--ss _p_r_o_p_e_r_t_y]... [--SS _p_r_o_p_e_r_t_y]... [--tt _t_y_p_e[,_t_y_p_e]...] [_f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e|_s_n_a_p_s_h_o_t]... zzffss rreemmaapp _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss sseett _p_r_o_p_e_r_t_y=_v_a_l_u_e [_p_r_o_p_e_r_t_y=_v_a_l_u_e]... _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e|_s_n_a_p_s_h_o_t... zzffss ggeett [--rr|--dd _d_e_p_t_h] [--HHpp] [--oo _f_i_e_l_d[,_f_i_e_l_d]...] [--ss _s_o_u_r_c_e[,_s_o_u_r_c_e]...] [--tt _t_y_p_e[,_t_y_p_e]...] aallll | _p_r_o_p_e_r_t_y[,_p_r_o_p_e_r_t_y]... _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e|_s_n_a_p_s_h_o_t|_b_o_o_k_m_a_r_k... zzffss iinnhheerriitt [--rrSS] _p_r_o_p_e_r_t_y _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e|_s_n_a_p_s_h_o_t... zzffss uuppggrraaddee zzffss uuppggrraaddee --vv zzffss uuppggrraaddee [--rr] [--VV _v_e_r_s_i_o_n] --aa | _f_i_l_e_s_y_s_t_e_m zzffss uusseerrssppaaccee [--HHiinnpp] [--oo _f_i_e_l_d[,_f_i_e_l_d]...] [--ss _f_i_e_l_d]... [--SS _f_i_e_l_d]... [--tt _t_y_p_e[,_t_y_p_e]...] _f_i_l_e_s_y_s_t_e_m|_s_n_a_p_s_h_o_t zzffss ggrroouuppssppaaccee [--HHiinnpp] [--oo _f_i_e_l_d[,_f_i_e_l_d]...] [--ss _f_i_e_l_d]... [--SS _f_i_e_l_d]... [--tt _t_y_p_e[,_t_y_p_e]...] _f_i_l_e_s_y_s_t_e_m|_s_n_a_p_s_h_o_t zzffss mmoouunntt zzffss mmoouunntt [--OOvv] [--oo _o_p_t_i_o_n_s] --aa | _f_i_l_e_s_y_s_t_e_m zzffss uunnmmoouunntt [--ff] --aa | _f_i_l_e_s_y_s_t_e_m|_m_o_u_n_t_p_o_i_n_t zzffss sshhaarree --aa | _f_i_l_e_s_y_s_t_e_m zzffss uunnsshhaarree --aa | _f_i_l_e_s_y_s_t_e_m|_m_o_u_n_t_p_o_i_n_t zzffss bbooookkmmaarrkk _s_n_a_p_s_h_o_t _b_o_o_k_m_a_r_k zzffss sseenndd [--DDLLPPRRcceennppvv] [[--II|--ii] _s_n_a_p_s_h_o_t] _s_n_a_p_s_h_o_t zzffss sseenndd [--LLccee] [--ii _s_n_a_p_s_h_o_t|_b_o_o_k_m_a_r_k] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e|_s_n_a_p_s_h_o_t zzffss sseenndd [--PPeennvv] --tt _r_e_c_e_i_v_e___r_e_s_u_m_e___t_o_k_e_n zzffss rreecceeiivvee [--FFnnssuuvv] [--oo oorriiggiinn=_s_n_a_p_s_h_o_t] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e|_s_n_a_p_s_h_o_t zzffss rreecceeiivvee [--FFnnssuuvv] [--dd|--ee] [--oo oorriiggiinn=_s_n_a_p_s_h_o_t] _f_i_l_e_s_y_s_t_e_m zzffss rreecceeiivvee --AA _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss aallllooww _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss aallllooww [--ddgglluu] _u_s_e_r|_g_r_o_u_p[,_u_s_e_r|_g_r_o_u_p]... _p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]... _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss aallllooww [--ddll] --ee|eevveerryyoonnee _p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]... _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss aallllooww --cc _p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]... _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss aallllooww --ss @_s_e_t_n_a_m_e _p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]... _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss uunnaallllooww [--ddggllrruu] _u_s_e_r|_g_r_o_u_p[,_u_s_e_r|_g_r_o_u_p]... [_p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]...] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss uunnaallllooww [--ddllrr] --ee|eevveerryyoonnee [_p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]...] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss uunnaallllooww [--rr] --cc [_p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]...] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss uunnaallllooww [--rr] --ss --@@_s_e_t_n_a_m_e [_p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]...] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss hhoolldd [--rr] _t_a_g _s_n_a_p_s_h_o_t... zzffss hhoollddss [--rr] _s_n_a_p_s_h_o_t... zzffss rreelleeaassee [--rr] _t_a_g _s_n_a_p_s_h_o_t... zzffss ddiiffff [--FFHHtt] _s_n_a_p_s_h_o_t _s_n_a_p_s_h_o_t|_f_i_l_e_s_y_s_t_e_m zzffss pprrooggrraamm [--jjnn] [--tt _t_i_m_e_o_u_t] [--mm _m_e_m_o_r_y___l_i_m_i_t] _p_o_o_l _s_c_r_i_p_t [_a_r_g_1 ...] DDEESSCCRRIIPPTTIIOONN The zzffss command configures ZFS datasets within a ZFS storage pool, as described in zpool(1M). A dataset is identified by a unique path within the ZFS namespace. For example: pool/{filesystem,volume,snapshot} where the maximum length of a dataset name is MAXNAMELEN (256 bytes) and the maximum amount of nesting allowed in a path is 50 levels deep. A dataset can be one of the following: ffiillee ssyysstteemm A ZFS dataset of type ffiilleessyysstteemm can be mounted within the standard system namespace and behaves like other file systems. While ZFS file systems are designed to be POSIX compliant, known issues exist that prevent compliance in some cases. Applications that depend on standards conformance might fail due to non-standard behavior when checking file system free space. vvoolluummee A logical volume exported as a raw or block device. This type of dataset should only be used under special circumstances. File systems are typically used in most environments. ssnnaappsshhoott A read-only version of a file system or volume at a given point in time. It is specified as _f_i_l_e_s_y_s_t_e_m@_n_a_m_e or _v_o_l_u_m_e@_n_a_m_e. ZZFFSS FFiillee SSyysstteemm HHiieerraarrcchhyy A ZFS storage pool is a logical collection of devices that provide space for datasets. A storage pool is also the root of the ZFS file system hierarchy. The root of the pool can be accessed as a file system, such as mounting and unmounting, taking snapshots, and setting properties. The physical storage characteristics, however, are managed by the zpool(1M) command. See zpool(1M) for more information on creating and administering pools. SSnnaappsshhoottss A snapshot is a read-only copy of a file system or volume. Snapshots can be created extremely quickly, and initially consume no additional space within the pool. As data within the active dataset changes, the snapshot consumes more data than would otherwise be shared with the active dataset. Snapshots can have arbitrary names. Snapshots of volumes can be cloned or rolled back, but cannot be accessed independently. File system snapshots can be accessed under the _._z_f_s_/_s_n_a_p_s_h_o_t directory in the root of the file system. Snapshots are automatically mounted on demand and may be unmounted at regular intervals. The visibility of the _._z_f_s directory can be controlled by the ssnnaappddiirr property. CClloonneess A clone is a writable volume or file system whose initial contents are the same as another dataset. As with snapshots, creating a clone is nearly instantaneous, and initially consumes no additional space. Clones can only be created from a snapshot. When a snapshot is cloned, it creates an implicit dependency between the parent and child. Even though the clone is created somewhere else in the dataset hierarchy, the original snapshot cannot be destroyed as long as a clone exists. The oorriiggiinn property exposes this dependency, and the ddeessttrrooyy command lists any such dependencies, if they exist. The clone parent-child dependency relationship can be reversed by using the pprroommoottee subcommand. This causes the "origin" file system to become a clone of the specified file system, which makes it possible to destroy the file system that the clone was created from. MMoouunntt PPooiinnttss Creating a ZFS file system is a simple operation, so the number of file systems per system is likely to be numerous. To cope with this, ZFS automatically manages mounting and unmounting file systems without the need to edit the _/_e_t_c_/_v_f_s_t_a_b file. All automatically managed file systems are mounted by ZFS at boot time. By default, file systems are mounted under _/_p_a_t_h, where _p_a_t_h is the name of the file system in the ZFS namespace. Directories are created and destroyed as needed. A file system can also have a mount point set in the mmoouunnttppooiinntt property. This directory is created as needed, and ZFS automatically mounts the file system when the zzffss mmoouunntt --aa command is invoked (without editing _/_e_t_c_/_v_f_s_t_a_b). The mmoouunnttppooiinntt property can be inherited, so if _p_o_o_l_/_h_o_m_e has a mount point of _/_e_x_p_o_r_t_/_s_t_u_f_f, then _p_o_o_l_/_h_o_m_e_/_u_s_e_r automatically inherits a mount point of _/_e_x_p_o_r_t_/_s_t_u_f_f_/_u_s_e_r. A file system mmoouunnttppooiinntt property of nnoonnee prevents the file system from being mounted. If needed, ZFS file systems can also be managed with traditional tools (mmoouunntt, uummoouunntt, _/_e_t_c_/_v_f_s_t_a_b). If a file system's mount point is set to lleeggaaccyy, ZFS makes no attempt to manage the file system, and the administrator is responsible for mounting and unmounting the file system. ZZoonneess A ZFS file system can be added to a non-global zone by using the zzoonneeccffgg aadddd ffss subcommand. A ZFS file system that is added to a non-global zone must have its mmoouunnttppooiinntt property set to lleeggaaccyy. The physical properties of an added file system are controlled by the global administrator. However, the zone administrator can create, modify, or destroy files within the added file system, depending on how the file system is mounted. A dataset can also be delegated to a non-global zone by using the zzoonneeccffgg aadddd ddaattaasseett subcommand. You cannot delegate a dataset to one zone and the children of the same dataset to another zone. The zone administrator can change properties of the dataset or any of its children. However, the qquuoottaa, ffiilleessyysstteemm__lliimmiitt and ssnnaappsshhoott__lliimmiitt properties of the delegated dataset can be modified only by the global administrator. A ZFS volume can be added as a device to a non-global zone by using the zzoonneeccffgg aadddd ddeevviiccee subcommand. However, its physical properties can be modified only by the global administrator. For more information about zzoonneeccffgg syntax, see zonecfg(1M). After a dataset is delegated to a non-global zone, the zzoonneedd property is automatically set. A zoned file system cannot be mounted in the global zone, since the zone administrator might have to set the mount point to an unacceptable value. The global administrator can forcibly clear the zzoonneedd property, though this should be done with extreme care. The global administrator should verify that all the mount points are acceptable before clearing the property. NNaattiivvee PPrrooppeerrttiieess Properties are divided into two types, native properties and user-defined (or "user") properties. Native properties either export internal statistics or control ZFS behavior. In addition, native properties are either editable or read-only. User properties have no effect on ZFS behavior, but you can use them to annotate datasets in a way that is meaningful in your environment. For more information about user properties, see the _U_s_e_r _P_r_o_p_e_r_t_i_e_s section, below. Every dataset has a set of properties that export statistics about the dataset as well as control various behaviors. Properties are inherited from the parent unless overridden by the child. Some properties apply only to certain types of datasets (file systems, volumes, or snapshots). The values of numeric properties can be specified using human-readable suffixes (for example, kk, KKBB, MM, GGbb, and so forth, up to ZZ for zettabyte). The following are all valid (and equal) specifications: 1536M, 1.5g, 1.50GB. The values of non-numeric properties are case sensitive and must be lowercase, except for mmoouunnttppooiinntt, sshhaarreennffss, and sshhaarreessmmbb. The following native properties consist of read-only statistics about the dataset. These properties can be neither set, nor inherited. Native properties apply to all dataset types unless otherwise noted. aavvaaiillaabbllee The amount of space available to the dataset and all its children, assuming that there is no other activity in the pool. Because space is shared within a pool, availability can be limited by any number of factors, including physical pool size, quotas, reservations, or other datasets within the pool. This property can also be referred to by its shortened column name, aavvaaiill. ccoommpprreessssrraattiioo For non-snapshots, the compression ratio achieved for the uusseedd space of this dataset, expressed as a multiplier. The uusseedd property includes descendant datasets, and, for clones, does not include the space shared with the origin snapshot. For snapshots, the ccoommpprreessssrraattiioo is the same as the rreeffccoommpprreessssrraattiioo property. Compression can be turned on by running: zzffss sseett ccoommpprreessssiioonn=oonn _d_a_t_a_s_e_t. The default value is ooffff. ccrreeaatteettxxgg The transaction group (txg) in which the dataset was created. Bookmarks have the same ccrreeaatteettxxgg as the snapshot they are initially tied to. This property is suitable for ordering a list of snapshots, e.g. for incremental send and receive. ccrreeaattiioonn The time this dataset was created. cclloonneess For snapshots, this property is a comma-separated list of filesystems or volumes which are clones of this snapshot. The clones' oorriiggiinn property is this snapshot. If the cclloonneess property is not empty, then this snapshot can not be destroyed (even with the --rr or --ff options). ddeeffeerr__ddeessttrrooyy This property is oonn if the snapshot has been marked for deferred destroy by using the zzffss ddeessttrrooyy --dd command. Otherwise, the property is ooffff. ffiilleessyysstteemm__ccoouunntt The total number of filesystems and volumes that exist under this location in the dataset tree. This value is only available when a ffiilleessyysstteemm__lliimmiitt has been set somewhere in the tree under which the dataset resides. gguuiidd The 64 bit GUID of this dataset or bookmark which does not change over its entire lifetime. When a snapshot is sent to another pool, the received snapshot has the same GUID. Thus, the gguuiidd is suitable to identify a snapshot across pools. llooggiiccaallrreeffeerreenncceedd The amount of space that is "logically" accessible by this dataset. See the rreeffeerreenncceedd property. The logical space ignores the effect of the ccoommpprreessssiioonn and ccooppiieess properties, giving a quantity closer to the amount of data that applications see. However, it does include space consumed by metadata. This property can also be referred to by its shortened column name, llrreeffeerr. llooggiiccaalluusseedd The amount of space that is "logically" consumed by this dataset and all its descendents. See the uusseedd property. The logical space ignores the effect of the ccoommpprreessssiioonn and ccooppiieess properties, giving a quantity closer to the amount of data that applications see. However, it does include space consumed by metadata. This property can also be referred to by its shortened column name, lluusseedd. mmoouunntteedd For file systems, indicates whether the file system is currently mounted. This property can be either yyeess or nnoo. oorriiggiinn For cloned file systems or volumes, the snapshot from which the clone was created. See also the cclloonneess property. rreecceeiivvee__rreessuummee__ttookkeenn For filesystems or volumes which have saved partially-completed state from zzffss rreecceeiivvee --ss, this opaque token can be provided to zzffss sseenndd --tt to resume and complete the zzffss rreecceeiivvee. rreeffeerreenncceedd The amount of data that is accessible by this dataset, which may or may not be shared with other datasets in the pool. When a snapshot or clone is created, it initially references the same amount of space as the file system or snapshot it was created from, since its contents are identical. This property can also be referred to by its shortened column name, rreeffeerr. rreeffccoommpprreessssrraattiioo The compression ratio achieved for the rreeffeerreenncceedd space of this dataset, expressed as a multiplier. See also the ccoommpprreessssrraattiioo property. ssnnaappsshhoott__ccoouunntt The total number of snapshots that exist under this location in the dataset tree. This value is only available when a ssnnaappsshhoott__lliimmiitt has been set somewhere in the tree under which the dataset resides. ttyyppee The type of dataset: ffiilleessyysstteemm, vvoolluummee, or ssnnaappsshhoott. uusseedd The amount of space consumed by this dataset and all its descendents. This is the value that is checked against this dataset's quota and reservation. The space used does not include this dataset's reservation, but does take into account the reservations of any descendent datasets. The amount of space that a dataset consumes from its parent, as well as the amount of space that is freed if this dataset is recursively destroyed, is the greater of its space used and its reservation. The used space of a snapshot (see the _S_n_a_p_s_h_o_t_s section) is space that is referenced exclusively by this snapshot. If this snapshot is destroyed, the amount of uusseedd space will be freed. Space that is shared by multiple snapshots isn't accounted for in this metric. When a snapshot is destroyed, space that was previously shared with this snapshot can become unique to snapshots adjacent to it, thus changing the used space of those snapshots. The used space of the latest snapshot can also be affected by changes in the file system. Note that the uusseedd space of a snapshot is a subset of the wwrriitttteenn space of the snapshot. The amount of space used, available, or referenced does not take into account pending changes. Pending changes are generally accounted for within a few seconds. Committing a change to a disk using fsync(3C) or O_SYNC does not necessarily guarantee that the space usage information is updated immediately. uusseeddbbyy** The uusseeddbbyy** properties decompose the uusseedd properties into the various reasons that space is used. Specifically, uusseedd = uusseeddbbyycchhiillddrreenn + uusseeddbbyyddaattaasseett + uusseeddbbyyrreeffrreesseerrvvaattiioonn + uusseeddbbyyssnnaappsshhoottss. These properties are only available for datasets created on zzppooooll "version 13" pools. uusseeddbbyycchhiillddrreenn The amount of space used by children of this dataset, which would be freed if all the dataset's children were destroyed. uusseeddbbyyddaattaasseett The amount of space used by this dataset itself, which would be freed if the dataset were destroyed (after first removing any rreeffrreesseerrvvaattiioonn and destroying any necessary snapshots or descendents). uusseeddbbyyrreeffrreesseerrvvaattiioonn The amount of space used by a rreeffrreesseerrvvaattiioonn set on this dataset, which would be freed if the rreeffrreesseerrvvaattiioonn was removed. uusseeddbbyyssnnaappsshhoottss The amount of space consumed by snapshots of this dataset. In particular, it is the amount of space that would be freed if all of this dataset's snapshots were destroyed. Note that this is not simply the sum of the snapshots' uusseedd properties because space can be shared by multiple snapshots. uusseerruusseedd@_u_s_e_r The amount of space consumed by the specified user in this dataset. Space is charged to the owner of each file, as displayed by llss --ll. The amount of space charged is displayed by dduu and llss --ss. See the zzffss uusseerrssppaaccee subcommand for more information. Unprivileged users can access only their own space usage. The root user, or a user who has been granted the uusseerruusseedd privilege with zzffss aallllooww, can access everyone's usage. The uusseerruusseedd@_._._. properties are not displayed by zzffss ggeett aallll. The user's name must be appended after the @ symbol, using one of the following forms: ++oo _P_O_S_I_X _n_a_m_e (for example, jjooee) ++oo _P_O_S_I_X _n_u_m_e_r_i_c _I_D (for example, 778899) ++oo _S_I_D _n_a_m_e (for example, jjooee..ssmmiitthh@@mmyyddoommaaiinn) ++oo _S_I_D _n_u_m_e_r_i_c _I_D (for example, SS--11--112233--445566--778899) uusseerrrreeffss This property is set to the number of user holds on this snapshot. User holds are set by using the zzffss hhoolldd command. ggrroouuppuusseedd@_g_r_o_u_p The amount of space consumed by the specified group in this dataset. Space is charged to the group of each file, as displayed by llss --ll. See the uusseerruusseedd@_u_s_e_r property for more information. Unprivileged users can only access their own groups' space usage. The root user, or a user who has been granted the ggrroouuppuusseedd privilege with zzffss aallllooww, can access all groups' usage. vvoollbblloocckkssiizzee For volumes, specifies the block size of the volume. The bblloocckkssiizzee cannot be changed once the volume has been written, so it should be set at volume creation time. The default bblloocckkssiizzee for volumes is 8 Kbytes. Any power of 2 from 512 bytes to 128 Kbytes is valid. This property can also be referred to by its shortened column name, vvoollbblloocckk. wwrriitttteenn The amount of space rreeffeerreenncceedd by this dataset, that was written since the previous snapshot (i.e. that is not referenced by the previous snapshot). wwrriitttteenn@_s_n_a_p_s_h_o_t The amount of rreeffeerreenncceedd space written to this dataset since the specified snapshot. This is the space that is referenced by this dataset but was not referenced by the specified snapshot. The _s_n_a_p_s_h_o_t may be specified as a short snapshot name (just the part after the @@), in which case it will be interpreted as a snapshot in the same filesystem as this dataset. The _s_n_a_p_s_h_o_t may be a full snapshot name (_f_i_l_e_s_y_s_t_e_m@_s_n_a_p_s_h_o_t), which for clones may be a snapshot in the origin's filesystem (or the origin of the origin's filesystem, etc.) The following native properties can be used to change the behavior of a ZFS dataset. aacclliinnhheerriitt=ddiissccaarrdd|nnooaallllooww|rreessttrriicctteedd|ppaasssstthhrroouugghh|ppaasssstthhrroouugghh--xx Controls how ACEs are inherited when files and directories are created. ddiissccaarrdd does not inherit any ACEs. nnooaallllooww only inherits inheritable ACEs that specify "deny" permissions. rreessttrriicctteedd default, removes the wwrriittee__aaccll and wwrriittee__oowwnneerr permissions when the ACE is inherited. ppaasssstthhrroouugghh inherits all inheritable ACEs without any modifications. ppaasssstthhrroouugghh--xx same meaning as ppaasssstthhrroouugghh, except that the oowwnneerr@@, ggrroouupp@@, and eevveerryyoonnee@@ ACEs inherit the execute permission only if the file creation mode also requests the execute bit. When the property value is set to ppaasssstthhrroouugghh, files are created with a mode determined by the inheritable ACEs. If no inheritable ACEs exist that affect the mode, then the mode is set in accordance to the requested mode from the application. aaccllmmooddee=ddiissccaarrdd|ggrroouuppmmaasskk|ppaasssstthhrroouugghh|rreessttrriicctteedd Controls how an ACL is modified during chmod(2) and how inherited ACEs are modified by the file creation mode. ddiissccaarrdd default, deletes all ACEs except for those representing the mode of the file or directory requested by chmod(2). ggrroouuppmmaasskk reduces permissions granted by all AALLLLOOWW entries found in the ACL such that they are no greater than the group permissions specified by the mode. ppaasssstthhrroouugghh indicates that no changes are made to the ACL other than creating or updating the necessary ACEs to represent the new mode of the file or directory. rreessttrriicctteedd causes the chmod(2) operation to return an error when used on any file or directory which has a non-trivial ACL, with entries in addition to those that represent the mode. chmod(2) is required to change the set user ID, set group ID, or sticky bit on a file or directory, as they do not have equivalent ACEs. In order to use chmod(2) on a file or directory with a non-trivial ACL when aaccllmmooddee is set to rreessttrriicctteedd, you must first remove all ACEs except for those that represent the current mode. aattiimmee=oonn|ooffff Controls whether the access time for files is updated when they are read. Turning this property off avoids producing write traffic when reading files and can result in significant performance gains, though it might confuse mailers and other similar utilities. The default value is oonn. ccaannmmoouunntt=oonn|ooffff|nnooaauuttoo If this property is set to ooffff, the file system cannot be mounted, and is ignored by zzffss mmoouunntt --aa. Setting this property to ooffff is similar to setting the mmoouunnttppooiinntt property to nnoonnee, except that the dataset still has a normal mmoouunnttppooiinntt property, which can be inherited. Setting this property to ooffff allows datasets to be used solely as a mechanism to inherit properties. One example of setting ccaannmmoouunntt=ooffff is to have two datasets with the same mmoouunnttppooiinntt, so that the children of both datasets appear in the same directory, but might have different inherited characteristics. When set to nnooaauuttoo, a dataset can only be mounted and unmounted explicitly. The dataset is not mounted automatically when the dataset is created or imported, nor is it mounted by the zzffss mmoouunntt --aa command or unmounted by the zzffss uunnmmoouunntt --aa command. This property is not inherited. cchheecckkssuumm=oonn|ooffff|fflleettcchheerr22|fflleettcchheerr44|sshhaa225566|nnooppaarriittyy|sshhaa551122|sskkeeiinn|eeddoonnrr Controls the checksum used to verify data integrity. The default value is oonn, which automatically selects an appropriate algorithm (currently, fflleettcchheerr44, but this may change in future releases). The value ooffff disables integrity checking on user data. The value nnooppaarriittyy not only disables integrity but also disables maintaining parity for user data. This setting is used internally by a dump device residing on a RAID-Z pool and should not be used by any other dataset. Disabling checksums is NNOOTT a recommended practice. The sshhaa551122, sskkeeiinn, and eeddoonnrr checksum algorithms require enabling the appropriate features on the pool. Please see zpool-features(5) for more information on these algorithms. Changing this property affects only newly-written data. ccoommpprreessssiioonn=oonn|ooffff|ggzziipp|ggzziipp--_N|llzz44|llzzjjbb|zzllee Controls the compression algorithm used for this dataset. Setting compression to oonn indicates that the current default compression algorithm should be used. The default balances compression and decompression speed, with compression ratio and is expected to work well on a wide variety of workloads. Unlike all other settings for this property, oonn does not select a fixed compression type. As new compression algorithms are added to ZFS and enabled on a pool, the default compression algorithm may change. The current default compression algorithm is either llzzjjbb or, if the llzz44__ccoommpprreessss feature is enabled, llzz44. The llzz44 compression algorithm is a high-performance replacement for the llzzjjbb algorithm. It features significantly faster compression and decompression, as well as a moderately higher compression ratio than llzzjjbb, but can only be used on pools with the llzz44__ccoommpprreessss feature set to eennaabblleedd. See zpool-features(5) for details on ZFS feature flags and the llzz44__ccoommpprreessss feature. The llzzjjbb compression algorithm is optimized for performance while providing decent data compression. The ggzziipp compression algorithm uses the same compression as the gzip(1) command. You can specify the ggzziipp level by using the value ggzziipp--_N, where _N is an integer from 1 (fastest) to 9 (best compression ratio). Currently, ggzziipp is equivalent to ggzziipp--66 (which is also the default for gzip(1)). The zzllee compression algorithm compresses runs of zeros. This property can also be referred to by its shortened column name ccoommpprreessss. Changing this property affects only newly-written data. ccooppiieess=11|22|33 Controls the number of copies of data stored for this dataset. These copies are in addition to any redundancy provided by the pool, for example, mirroring or RAID-Z. The copies are stored on different disks, if possible. The space used by multiple copies is charged to the associated file and dataset, changing the uusseedd property and counting against quotas and reservations. Changing this property only affects newly-written data. Therefore, set this property at file system creation time by using the --oo ccooppiieess=_N option. ddeevviicceess=oonn|ooffff Controls whether device nodes can be opened on this file system. The default value is oonn. eexxeecc=oonn|ooffff Controls whether processes can be executed from within this file system. The default value is oonn. ffiilleessyysstteemm__lliimmiitt=_c_o_u_n_t|nnoonnee Limits the number of filesystems and volumes that can exist under this point in the dataset tree. The limit is not enforced if the user is allowed to change the limit. Setting a ffiilleessyysstteemm__lliimmiitt to oonn a descendent of a filesystem that already has a ffiilleessyysstteemm__lliimmiitt does not override the ancestor's ffiilleessyysstteemm__lliimmiitt, but rather imposes an additional limit. This feature must be enabled to be used (see zpool-features(5)). mmoouunnttppooiinntt=_p_a_t_h|nnoonnee|lleeggaaccyy Controls the mount point used for this file system. See the _M_o_u_n_t _P_o_i_n_t_s section for more information on how this property is used. When the mmoouunnttppooiinntt property is changed for a file system, the file system and any children that inherit the mount point are unmounted. If the new value is lleeggaaccyy, then they remain unmounted. Otherwise, they are automatically remounted in the new location if the property was previously lleeggaaccyy or nnoonnee, or if they were mounted before the property was changed. In addition, any shared file systems are unshared and shared in the new location. nnbbmmaanndd=oonn|ooffff Controls whether the file system should be mounted with nnbbmmaanndd (Non Blocking mandatory locks). This is used for SMB clients. Changes to this property only take effect when the file system is umounted and remounted. See mount(1M) for more information on nnbbmmaanndd mounts. pprriimmaarryyccaacchhee=aallll|nnoonnee|mmeettaaddaattaa Controls what is cached in the primary cache (ARC). If this property is set to aallll, then both user data and metadata is cached. If this property is set to nnoonnee, then neither user data nor metadata is cached. If this property is set to mmeettaaddaattaa, then only metadata is cached. The default value is aallll. qquuoottaa=_s_i_z_e|nnoonnee Limits the amount of space a dataset and its descendents can consume. This property enforces a hard limit on the amount of space used. This includes all space consumed by descendents, including file systems and snapshots. Setting a quota on a descendent of a dataset that already has a quota does not override the ancestor's quota, but rather imposes an additional limit. Quotas cannot be set on volumes, as the vvoollssiizzee property acts as an implicit quota. ssnnaappsshhoott__lliimmiitt=_c_o_u_n_t|nnoonnee Limits the number of snapshots that can be created on a dataset and its descendents. Setting a ssnnaappsshhoott__lliimmiitt on a descendent of a dataset that already has a ssnnaappsshhoott__lliimmiitt does not override the ancestor's ssnnaappsshhoott__lliimmiitt, but rather imposes an additional limit. The limit is not enforced if the user is allowed to change the limit. For example, this means that recursive snapshots taken from the global zone are counted against each delegated dataset within a zone. This feature must be enabled to be used (see zpool-features(5)). uusseerrqquuoottaa@@_u_s_e_r=_s_i_z_e|nnoonnee Limits the amount of space consumed by the specified user. User space consumption is identified by the uusseerrssppaaccee@@_u_s_e_r property. Enforcement of user quotas may be delayed by several seconds. This delay means that a user might exceed their quota before the system notices that they are over quota and begins to refuse additional writes with the EDQUOT error message. See the zzffss uusseerrssppaaccee subcommand for more information. Unprivileged users can only access their own groups' space usage. The root user, or a user who has been granted the uusseerrqquuoottaa privilege with zzffss aallllooww, can get and set everyone's quota. This property is not available on volumes, on file systems before version 4, or on pools before version 15. The uusseerrqquuoottaa@@_._._. properties are not displayed by zzffss ggeett aallll. The user's name must be appended after the @@ symbol, using one of the following forms: ++oo _P_O_S_I_X _n_a_m_e (for example, jjooee) ++oo _P_O_S_I_X _n_u_m_e_r_i_c _I_D (for example, 778899) ++oo _S_I_D _n_a_m_e (for example, jjooee..ssmmiitthh@@mmyyddoommaaiinn) ++oo _S_I_D _n_u_m_e_r_i_c _I_D (for example, SS--11--112233--445566--778899) ggrroouuppqquuoottaa@@_g_r_o_u_p=_s_i_z_e|nnoonnee Limits the amount of space consumed by the specified group. Group space consumption is identified by the ggrroouuppuusseedd@@_g_r_o_u_p property. Unprivileged users can access only their own groups' space usage. The root user, or a user who has been granted the ggrroouuppqquuoottaa privilege with zzffss aallllooww, can get and set all groups' quotas. rreeaaddoonnllyy=oonn|ooffff Controls whether this dataset can be modified. The default value is ooffff. This property can also be referred to by its shortened column name, rrddoonnllyy. rreeccoorrddssiizzee=_s_i_z_e Specifies a suggested block size for files in the file system. This property is designed solely for use with database workloads that access files in fixed-size records. ZFS automatically tunes block sizes according to internal algorithms optimized for typical access patterns. For databases that create very large files but access them in small random chunks, these algorithms may be suboptimal. Specifying a rreeccoorrddssiizzee greater than or equal to the record size of the database can result in significant performance gains. Use of this property for general purpose file systems is strongly discouraged, and may adversely affect performance. The size specified must be a power of two greater than or equal to 512 and less than or equal to 128 Kbytes. If the llaarrggee__bblloocckkss feature is enabled on the pool, the size may be up to 1 Mbyte. See zpool-features(5) for details on ZFS feature flags. Changing the file system's rreeccoorrddssiizzee affects only files created afterward; existing files are unaffected. This property can also be referred to by its shortened column name, rreeccssiizzee. rreedduunnddaanntt__mmeettaaddaattaa=aallll|mmoosstt Controls what types of metadata are stored redundantly. ZFS stores an extra copy of metadata, so that if a single block is corrupted, the amount of user data lost is limited. This extra copy is in addition to any redundancy provided at the pool level (e.g. by mirroring or RAID-Z), and is in addition to an extra copy specified by the ccooppiieess property (up to a total of 3 copies). For example if the pool is mirrored, ccooppiieess=2, and rreedduunnddaanntt__mmeettaaddaattaa=mmoosstt, then ZFS stores 6 copies of most metadata, and 4 copies of data and some metadata. When set to aallll, ZFS stores an extra copy of all metadata. If a single on-disk block is corrupt, at worst a single block of user data (which is rreeccoorrddssiizzee bytes long) can be lost. When set to mmoosstt, ZFS stores an extra copy of most types of metadata. This can improve performance of random writes, because less metadata must be written. In practice, at worst about 100 blocks (of rreeccoorrddssiizzee bytes each) of user data can be lost if a single on-disk block is corrupt. The exact behavior of which metadata blocks are stored redundantly may change in future releases. The default value is aallll. rreeffqquuoottaa=_s_i_z_e|nnoonnee Limits the amount of space a dataset can consume. This property enforces a hard limit on the amount of space used. This hard limit does not include space used by descendents, including file systems and snapshots. rreeffrreesseerrvvaattiioonn=_s_i_z_e|nnoonnee|aauuttoo The minimum amount of space guaranteed to a dataset, not including its descendents. When the amount of space used is below this value, the dataset is treated as if it were taking up the amount of space specified by rreeffrreesseerrvvaattiioonn. The rreeffrreesseerrvvaattiioonn reservation is accounted for in the parent datasets' space used, and counts against the parent datasets' quotas and reservations. If rreeffrreesseerrvvaattiioonn is set, a snapshot is only allowed if there is enough free pool space outside of this reservation to accommodate the current number of "referenced" bytes in the dataset. If rreeffrreesseerrvvaattiioonn is set to aauuttoo, a volume is thick provisioned (or "not sparse"). rreeffrreesseerrvvaattiioonn=aauuttoo is only supported on volumes. See vvoollssiizzee in the _N_a_t_i_v_e _P_r_o_p_e_r_t_i_e_s section for more information about sparse volumes. This property can also be referred to by its shortened column name, rreeffrreesseerrvv. rreesseerrvvaattiioonn=_s_i_z_e|nnoonnee The minimum amount of space guaranteed to a dataset and its descendants. When the amount of space used is below this value, the dataset is treated as if it were taking up the amount of space specified by its reservation. Reservations are accounted for in the parent datasets' space used, and count against the parent datasets' quotas and reservations. This property can also be referred to by its shortened column name, rreesseerrvv. sseeccoonnddaarryyccaacchhee=aallll|nnoonnee|mmeettaaddaattaa Controls what is cached in the secondary cache (L2ARC). If this property is set to aallll, then both user data and metadata is cached. If this property is set to nnoonnee, then neither user data nor metadata is cached. If this property is set to mmeettaaddaattaa, then only metadata is cached. The default value is aallll. sseettuuiidd=oonn|ooffff Controls whether the setuid bit is respected for the file system. The default value is oonn. sshhaarreessmmbb=oonn|ooffff|_o_p_t_s Controls whether the file system is shared via SMB, and what options are to be used. A file system with the sshhaarreessmmbb property set to ooffff is managed through traditional tools such as sharemgr(1M). Otherwise, the file system is automatically shared and unshared with the zzffss sshhaarree and zzffss uunnsshhaarree commands. If the property is set to oonn, the sharemgr(1M) command is invoked with no options. Otherwise, the sharemgr(1M) command is invoked with options equivalent to the contents of this property. Because SMB shares requires a resource name, a unique resource name is constructed from the dataset name. The constructed name is a copy of the dataset name except that the characters in the dataset name, which would be invalid in the resource name, are replaced with underscore (__) characters. A pseudo property "name" is also supported that allows you to replace the data set name with a specified name. The specified name is then used to replace the prefix dataset in the case of inheritance. For example, if the dataset _d_a_t_a_/_h_o_m_e_/_j_o_h_n is set to nnaammee=jjoohhnn, then _d_a_t_a_/_h_o_m_e_/_j_o_h_n has a resource name of jjoohhnn. If a child dataset _d_a_t_a_/_h_o_m_e_/_j_o_h_n_/_b_a_c_k_u_p_s is shared, it has a resource name of jjoohhnn__bbaacckkuuppss. When SMB shares are created, the SMB share name appears as an entry in the _._z_f_s_/_s_h_a_r_e_s directory. You can use the llss or cchhmmoodd command to display the share-level ACLs on the entries in this directory. When the sshhaarreessmmbb property is changed for a dataset, the dataset and any children inheriting the property are re-shared with the new options, only if the property was previously set to ooffff, or if they were shared before the property was changed. If the new property is set to ooffff, the file systems are unshared. sshhaarreennffss=oonn|ooffff|_o_p_t_s Controls whether the file system is shared via NFS, and what options are to be used. A file system with a sshhaarreennffss property of ooffff is managed through traditional tools such as share(1M), unshare(1M), and dfstab(4). Otherwise, the file system is automatically shared and unshared with the zzffss sshhaarree and zzffss uunnsshhaarree commands. If the property is set to oonn, share(1M) command is invoked with no options. Otherwise, the share(1M) command is invoked with options equivalent to the contents of this property. When the sshhaarreennffss property is changed for a dataset, the dataset and any children inheriting the property are re-shared with the new options, only if the property was previously ooffff, or if they were shared before the property was changed. If the new property is ooffff, the file systems are unshared. llooggbbiiaass=llaatteennccyy|tthhrroouugghhppuutt Provide a hint to ZFS about handling of synchronous requests in this dataset. If llooggbbiiaass is set to llaatteennccyy (the default), ZFS will use pool log devices (if configured) to handle the requests at low latency. If llooggbbiiaass is set to tthhrroouugghhppuutt, ZFS will not use configured pool log devices. ZFS will instead optimize synchronous operations for global pool throughput and efficient use of resources. ssnnaappddiirr=hhiiddddeenn|vviissiibbllee Controls whether the _._z_f_s directory is hidden or visible in the root of the file system as discussed in the _S_n_a_p_s_h_o_t_s section. The default value is hhiiddddeenn. ssyynncc=ssttaannddaarrdd|aallwwaayyss|ddiissaabblleedd Controls the behavior of synchronous requests (e.g. fsync, O_DSYNC). ssttaannddaarrdd is the POSIX specified behavior of ensuring all synchronous requests are written to stable storage and all devices are flushed to ensure data is not cached by device controllers (this is the default). aallwwaayyss causes every file system transaction to be written and flushed before its system call returns. This has a large performance penalty. ddiissaabblleedd disables synchronous requests. File system transactions are only committed to stable storage periodically. This option will give the highest performance. However, it is very dangerous as ZFS would be ignoring the synchronous transaction demands of applications such as databases or NFS. Administrators should only use this option when the risks are understood. vveerrssiioonn=_N|ccuurrrreenntt The on-disk version of this file system, which is independent of the pool version. This property can only be set to later supported versions. See the zzffss uuppggrraaddee command. vvoollssiizzee=_s_i_z_e For volumes, specifies the logical size of the volume. By default, creating a volume establishes a reservation of equal size. For storage pools with a version number of 9 or higher, a rreeffrreesseerrvvaattiioonn is set instead. Any changes to vvoollssiizzee are reflected in an equivalent change to the reservation (or rreeffrreesseerrvvaattiioonn). The vvoollssiizzee can only be set to a multiple of vvoollbblloocckkssiizzee, and cannot be zero. The reservation is kept equal to the volume's logical size to prevent unexpected behavior for consumers. Without the reservation, the volume could run out of space, resulting in undefined behavior or data corruption, depending on how the volume is used. These effects can also occur when the volume size is changed while it is in use (particularly when shrinking the size). Extreme care should be used when adjusting the volume size. Though not recommended, a "sparse volume" (also known as "thin provisioned") can be created by specifying the --ss option to the zzffss ccrreeaattee --VV command, or by changing the value of the rreeffrreesseerrvvaattiioonn property (or rreesseerrvvaattiioonn property on pool version 8 or earlier) after the volume has been created. A "sparse volume" is a volume where the value of rreeffrreesseerrvvaattiioonn is less than the size of the volume plus the space required to store its metadata. Consequently, writes to a sparse volume can fail with ENOSPC when the pool is low on space. For a sparse volume, changes to vvoollssiizzee are not reflected in the rreeffrreesseerrvvaattiioonn.. A volume that is not sparse is said to be "thick provisioned". A sparse volume can become thick provisioned by setting rreeffrreesseerrvvaattiioonn to aauuttoo. vvssccaann=oonn|ooffff Controls whether regular files should be scanned for viruses when a file is opened and closed. In addition to enabling this property, the virus scan service must also be enabled for virus scanning to occur. The default value is ooffff. xxaattttrr=oonn|ooffff Controls whether extended attributes are enabled for this file system. The default value is oonn. zzoonneedd=oonn|ooffff Controls whether the dataset is managed from a non-global zone. See the _Z_o_n_e_s section for more information. The default value is ooffff. The following three properties cannot be changed after the file system is created, and therefore, should be set when the file system is created. If the properties are not set with the zzffss ccrreeaattee or zzppooooll ccrreeaattee commands, these properties are inherited from the parent dataset. If the parent dataset lacks these properties due to having been created prior to these features being supported, the new file system will have the default values for these properties. ccaasseesseennssiittiivviittyy=sseennssiittiivvee|iinnsseennssiittiivvee|mmiixxeedd Indicates whether the file name matching algorithm used by the file system should be case-sensitive, case-insensitive, or allow a combination of both styles of matching. The default value for the ccaasseesseennssiittiivviittyy property is sseennssiittiivvee. Traditionally, UNIX and POSIX file systems have case-sensitive file names. The mmiixxeedd value for the ccaasseesseennssiittiivviittyy property indicates that the file system can support requests for both case-sensitive and case- insensitive matching behavior. Currently, case-insensitive matching behavior on a file system that supports mixed behavior is limited to the SMB server product. For more information about the mmiixxeedd value behavior, see the "ZFS Administration Guide". nnoorrmmaalliizzaattiioonn=nnoonnee|ffoorrmmCC|ffoorrmmDD|ffoorrmmKKCC|ffoorrmmKKDD Indicates whether the file system should perform a uunniiccooddee normalization of file names whenever two file names are compared, and which normalization algorithm should be used. File names are always stored unmodified, names are normalized as part of any comparison process. If this property is set to a legal value other than nnoonnee, and the uuttff88oonnllyy property was left unspecified, the uuttff88oonnllyy property is automatically set to oonn. The default value of the nnoorrmmaalliizzaattiioonn property is nnoonnee. This property cannot be changed after the file system is created. uuttff88oonnllyy=oonn|ooffff Indicates whether the file system should reject file names that include characters that are not present in the UUTTFF--88 character code set. If this property is explicitly set to ooffff, the normalization property must either not be explicitly set or be set to nnoonnee. The default value for the uuttff88oonnllyy property is ooffff. This property cannot be changed after the file system is created. The ccaasseesseennssiittiivviittyy, nnoorrmmaalliizzaattiioonn, and uuttff88oonnllyy properties are also new permissions that can be assigned to non-privileged users by using the ZFS delegated administration feature. TTeemmppoorraarryy MMoouunntt PPooiinntt PPrrooppeerrttiieess When a file system is mounted, either through mount(1M) for legacy mounts or the zzffss mmoouunntt command for normal file systems, its mount options are set according to its properties. The correlation between properties and mount options is as follows: PROPERTY MOUNT OPTION devices devices/nodevices exec exec/noexec readonly ro/rw setuid setuid/nosetuid xattr xattr/noxattr In addition, these options can be set on a per-mount basis using the --oo option, without affecting the property that is stored on disk. The values specified on the command line override the values stored in the dataset. The nnoossuuiidd option is an alias for nnooddeevviicceess,nnoosseettuuiidd. These properties are reported as "temporary" by the zzffss ggeett command. If the properties are changed while the dataset is mounted, the new setting overrides any temporary settings. UUsseerr PPrrooppeerrttiieess In addition to the standard native properties, ZFS supports arbitrary user properties. User properties have no effect on ZFS behavior, but applications or administrators can use them to annotate datasets (file systems, volumes, and snapshots). User property names must contain a colon ("::") character to distinguish them from native properties. They may contain lowercase letters, numbers, and the following punctuation characters: colon ("::"), dash ("--"), period (".."), and underscore ("__"). The expected convention is that the property name is divided into two portions such as _m_o_d_u_l_e:_p_r_o_p_e_r_t_y, but this namespace is not enforced by ZFS. User property names can be at most 256 characters, and cannot begin with a dash ("--"). When making programmatic use of user properties, it is strongly suggested to use a reversed DDNNSS domain name for the _m_o_d_u_l_e component of property names to reduce the chance that two independently-developed packages use the same property name for different purposes. The values of user properties are arbitrary strings, are always inherited, and are never validated. All of the commands that operate on properties (zzffss lliisstt, zzffss ggeett, zzffss sseett, and so forth) can be used to manipulate both native properties and user properties. Use the zzffss iinnhheerriitt command to clear a user property. If the property is not defined in any parent dataset, it is removed entirely. Property values are limited to 8192 bytes. ZZFFSS VVoolluummeess aass SSwwaapp oorr DDuummpp DDeevviicceess During an initial installation a swap device and dump device are created on ZFS volumes in the ZFS root pool. By default, the swap area size is based on 1/2 the size of physical memory up to 2 Gbytes. The size of the dump device depends on the kernel's requirements at installation time. Separate ZFS volumes must be used for the swap area and dump devices. Do not swap to a file on a ZFS file system. A ZFS swap file configuration is not supported. If you need to change your swap area or dump device after the system is installed or upgraded, use the swap(1M) and dumpadm(1M) commands. SSUUBBCCOOMMMMAANNDDSS All subcommands that modify state are logged persistently to the pool in their original form. zzffss --?? Displays a help message. zzffss ccrreeaattee [--pp] [--oo _p_r_o_p_e_r_t_y=_v_a_l_u_e]... _f_i_l_e_s_y_s_t_e_m Creates a new ZFS file system. The file system is automatically mounted according to the mmoouunnttppooiinntt property inherited from the parent. --oo _p_r_o_p_e_r_t_y=_v_a_l_u_e Sets the specified property as if the command zzffss sseett _p_r_o_p_e_r_t_y=_v_a_l_u_e was invoked at the same time the dataset was created. Any editable ZFS property can also be set at creation time. Multiple --oo options can be specified. An error results if the same property is specified in multiple --oo options. --pp Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the mmoouunnttppooiinntt property inherited from their parent. Any property specified on the command line using the --oo option is ignored. If the target filesystem already exists, the operation completes successfully. zzffss ccrreeaattee [--ppss] [--bb _b_l_o_c_k_s_i_z_e] [--oo _p_r_o_p_e_r_t_y=_v_a_l_u_e]... --VV _s_i_z_e _v_o_l_u_m_e Creates a volume of the given size. The volume is exported as a block device in _/_d_e_v_/_z_v_o_l_/_{_d_s_k_,_r_d_s_k_}_/_p_a_t_h, where _p_a_t_h is the name of the volume in the ZFS namespace. The size represents the logical size as exported by the device. By default, a reservation of equal size is created. _s_i_z_e is automatically rounded up to the nearest 128 Kbytes to ensure that the volume has an integral number of blocks regardless of bblloocckkssiizzee. --bb _b_l_o_c_k_s_i_z_e Equivalent to --oo vvoollbblloocckkssiizzee=_b_l_o_c_k_s_i_z_e. If this option is specified in conjunction with --oo vvoollbblloocckkssiizzee, the resulting behavior is undefined. --oo _p_r_o_p_e_r_t_y=_v_a_l_u_e Sets the specified property as if the zzffss sseett _p_r_o_p_e_r_t_y=_v_a_l_u_e command was invoked at the same time the dataset was created. Any editable ZFS property can also be set at creation time. Multiple --oo options can be specified. An error results if the same property is specified in multiple --oo options. --pp Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the mmoouunnttppooiinntt property inherited from their parent. Any property specified on the command line using the --oo option is ignored. If the target filesystem already exists, the operation completes successfully. --ss Creates a sparse volume with no reservation. See vvoollssiizzee in the _N_a_t_i_v_e _P_r_o_p_e_r_t_i_e_s section for more information about sparse volumes. zzffss ddeessttrrooyy [--RRffnnpprrvv] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e Destroys the given dataset. By default, the command unshares any file systems that are currently shared, unmounts any file systems that are currently mounted, and refuses to destroy a dataset that has active dependents (children or clones). --RR Recursively destroy all dependents, including cloned file systems outside the target hierarchy. --ff Force an unmount of any file systems using the uunnmmoouunntt --ff command. This option has no effect on non-file systems or unmounted file systems. --nn Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in conjunction with the --vv or --pp flags to determine what data would be deleted. --pp Print machine-parsable verbose information about the deleted data. --rr Recursively destroy all children. --vv Print verbose information about the deleted data. Extreme care should be taken when applying either the --rr or the --RR options, as they can destroy large portions of a pool and cause unexpected behavior for mounted file systems in use. zzffss ddeessttrrooyy [--RRddnnpprrvv] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e@_s_n_a_p[%_s_n_a_p[,_s_n_a_p[%_s_n_a_p]]]... The given snapshots are destroyed immediately if and only if the zzffss ddeessttrrooyy command without the --dd option would have destroyed it. Such immediate destruction would occur, for example, if the snapshot had no clones and the user-initiated reference count were zero. If a snapshot does not qualify for immediate destruction, it is marked for deferred deletion. In this state, it exists as a usable, visible snapshot until both of the preconditions listed above are met, at which point it is destroyed. An inclusive range of snapshots may be specified by separating the first and last snapshots with a percent sign. The first and/or last snapshots may be left blank, in which case the filesystem's oldest or newest snapshot will be implied. Multiple snapshots (or ranges of snapshots) of the same filesystem or volume may be specified in a comma-separated list of snapshots. Only the snapshot's short name (the part after the @@) should be specified when using a range or comma-separated list to identify multiple snapshots. --RR Recursively destroy all clones of these snapshots, including the clones, snapshots, and children. If this flag is specified, the --dd flag will have no effect. --dd Defer snapshot deletion. --nn Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in conjunction with the --pp or --vv flags to determine what data would be deleted. --pp Print machine-parsable verbose information about the deleted data. --rr Destroy (or mark for deferred deletion) all snapshots with this name in descendent file systems. --vv Print verbose information about the deleted data. Extreme care should be taken when applying either the --rr or the --RR options, as they can destroy large portions of a pool and cause unexpected behavior for mounted file systems in use. zzffss ddeessttrrooyy _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e#_b_o_o_k_m_a_r_k The given bookmark is destroyed. zzffss ssnnaappsshhoott [--rr] [--oo _p_r_o_p_e_r_t_y=value]... _f_i_l_e_s_y_s_t_e_m@_s_n_a_p_n_a_m_e|_v_o_l_u_m_e@_s_n_a_p_n_a_m_e... Creates snapshots with the given names. All previous modifications by successful system calls to the file system are part of the snapshots. Snapshots are taken atomically, so that all snapshots correspond to the same moment in time. See the _S_n_a_p_s_h_o_t_s section for details. --oo _p_r_o_p_e_r_t_y=_v_a_l_u_e Sets the specified property; see zzffss ccrreeaattee for details. --rr Recursively create snapshots of all descendent datasets zzffss rroollllbbaacckk [--RRffrr] _s_n_a_p_s_h_o_t Roll back the given dataset to a previous snapshot. When a dataset is rolled back, all data that has changed since the snapshot is discarded, and the dataset reverts to the state at the time of the snapshot. By default, the command refuses to roll back to a snapshot other than the most recent one. In order to do so, all intermediate snapshots and bookmarks must be destroyed by specifying the --rr option. The --rrRR options do not recursively destroy the child snapshots of a recursive snapshot. Only direct snapshots of the specified filesystem are destroyed by either of these options. To completely roll back a recursive snapshot, you must rollback the individual child snapshots. --RR Destroy any more recent snapshots and bookmarks, as well as any clones of those snapshots. --ff Used with the --RR option to force an unmount of any clone file systems that are to be destroyed. --rr Destroy any snapshots and bookmarks more recent than the one specified. zzffss cclloonnee [--pp] [--oo _p_r_o_p_e_r_t_y=_v_a_l_u_e]... _s_n_a_p_s_h_o_t _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e Creates a clone of the given snapshot. See the _C_l_o_n_e_s section for details. The target dataset can be located anywhere in the ZFS hierarchy, and is created as the same type as the original. --oo _p_r_o_p_e_r_t_y=_v_a_l_u_e Sets the specified property; see zzffss ccrreeaattee for details. --pp Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the mmoouunnttppooiinntt property inherited from their parent. If the target filesystem or volume already exists, the operation completes successfully. zzffss pprroommoottee _c_l_o_n_e_-_f_i_l_e_s_y_s_t_e_m Promotes a clone file system to no longer be dependent on its "origin" snapshot. This makes it possible to destroy the file system that the clone was created from. The clone parent-child dependency relationship is reversed, so that the origin file system becomes a clone of the specified file system. The snapshot that was cloned, and any snapshots previous to this snapshot, are now owned by the promoted clone. The space they use moves from the origin file system to the promoted clone, so enough space must be available to accommodate these snapshots. No new space is consumed by this operation, but the space accounting is adjusted. The promoted clone must not have any conflicting snapshot names of its own. The rreennaammee subcommand can be used to rename any conflicting snapshots. zzffss rreennaammee [--ff] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e|_s_n_a_p_s_h_o_t _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e|_s_n_a_p_s_h_o_t zzffss rreennaammee [--ffpp] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e Renames the given dataset. The new target can be located anywhere in the ZFS hierarchy, with the exception of snapshots. Snapshots can only be renamed within the parent file system or volume. When renaming a snapshot, the parent file system of the snapshot does not need to be specified as part of the second argument. Renamed file systems can inherit new mount points, in which case they are unmounted and remounted at the new mount point. --ff Force unmount any filesystems that need to be unmounted in the process. --pp Creates all the nonexistent parent datasets. Datasets created in this manner are automatically mounted according to the mmoouunnttppooiinntt property inherited from their parent. zzffss rreennaammee --rr _s_n_a_p_s_h_o_t _s_n_a_p_s_h_o_t Recursively rename the snapshots of all descendent datasets. Snapshots are the only dataset that can be renamed recursively. zzffss lliisstt [--rr|--dd _d_e_p_t_h] [--HHpp] [--oo _p_r_o_p_e_r_t_y[,_p_r_o_p_e_r_t_y]...] [--ss _p_r_o_p_e_r_t_y]... [--SS _p_r_o_p_e_r_t_y]... [--tt _t_y_p_e[,_t_y_p_e]...] [_f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e|_s_n_a_p_s_h_o_t]... Lists the property information for the given datasets in tabular form. If specified, you can list property information by the absolute pathname or the relative pathname. By default, all file systems and volumes are displayed. Snapshots are displayed if the lliissttssnnaappss property is oonn (the default is ooffff). The following fields are displayed, nnaammee,uusseedd,aavvaaiillaabbllee,rreeffeerreenncceedd,mmoouunnttppooiinntt. --HH Used for scripting mode. Do not print headers and separate fields by a single tab instead of arbitrary white space. --SS _p_r_o_p_e_r_t_y Same as the --ss option, but sorts by property in descending order. --dd _d_e_p_t_h Recursively display any children of the dataset, limiting the recursion to _d_e_p_t_h. A _d_e_p_t_h of 11 will display only the dataset and its direct children. --oo _p_r_o_p_e_r_t_y A comma-separated list of properties to display. The property must be: ++oo One of the properties described in the _N_a_t_i_v_e _P_r_o_p_e_r_t_i_e_s section ++oo A user property ++oo The value nnaammee to display the dataset name ++oo The value ssppaaccee to display space usage properties on file systems and volumes. This is a shortcut for specifying --oo nnaammee,aavvaaiill,uusseedd,uusseeddssnnaapp,uusseeddddss,uusseeddrreeffrreesseerrvv,uusseeddcchhiilldd --tt ffiilleessyysstteemm,vvoolluummee syntax. --pp Display numbers in parsable (exact) values. --rr Recursively display any children of the dataset on the command line. --ss _p_r_o_p_e_r_t_y A property for sorting the output by column in ascending order based on the value of the property. The property must be one of the properties described in the _P_r_o_p_e_r_t_i_e_s section, or the special value nnaammee to sort by the dataset name. Multiple properties can be specified at one time using multiple --ss property options. Multiple --ss options are evaluated from left to right in decreasing order of importance. The following is a list of sorting criteria: ++oo Numeric types sort in numeric order. ++oo String types sort in alphabetical order. ++oo Types inappropriate for a row sort that row to the literal bottom, regardless of the specified ordering. If no sorting options are specified the existing behavior of zzffss lliisstt is preserved. --tt _t_y_p_e A comma-separated list of types to display, where _t_y_p_e is one of ffiilleessyysstteemm, ssnnaappsshhoott, vvoolluummee, bbooookkmmaarrkk, or aallll. For example, specifying --tt ssnnaappsshhoott displays only snapshots. zzffss sseett _p_r_o_p_e_r_t_y=_v_a_l_u_e [_p_r_o_p_e_r_t_y=_v_a_l_u_e]... _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e|_s_n_a_p_s_h_o_t... Sets the property or list of properties to the given value(s) for each dataset. Only some properties can be edited. See the _P_r_o_p_e_r_t_i_e_s section for more information on what properties can be set and acceptable values. Numeric values can be specified as exact values, or in a human-readable form with a suffix of BB, KK, MM, GG, TT, PP, EE, ZZ (for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes, or zettabytes, respectively). User properties can be set on snapshots. For more information, see the _U_s_e_r _P_r_o_p_e_r_t_i_e_s section. zzffss ggeett [--rr|--dd _d_e_p_t_h] [--HHpp] [--oo _f_i_e_l_d[,_f_i_e_l_d]...] [--ss _s_o_u_r_c_e[,_s_o_u_r_c_e]...] [--tt _t_y_p_e[,_t_y_p_e]...] aallll | _p_r_o_p_e_r_t_y[,_p_r_o_p_e_r_t_y]... _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e|_s_n_a_p_s_h_o_t|_b_o_o_k_m_a_r_k... Displays properties for the given datasets. If no datasets are specified, then the command displays properties for all datasets on the system. For each property, the following columns are displayed: name Dataset name property Property name value Property value source Property source. Can either be local, default, temporary, inherited, or none (-). All columns are displayed by default, though this can be controlled by using the --oo option. This command takes a comma-separated list of properties as described in the _N_a_t_i_v_e _P_r_o_p_e_r_t_i_e_s and _U_s_e_r _P_r_o_p_e_r_t_i_e_s sections. The special value aallll can be used to display all properties that apply to the given dataset's type (filesystem, volume, snapshot, or bookmark). --HH Display output in a form more easily parsed by scripts. Any headers are omitted, and fields are explicitly separated by a single tab instead of an arbitrary amount of space. --dd _d_e_p_t_h Recursively display any children of the dataset, limiting the recursion to _d_e_p_t_h. A depth of 11 will display only the dataset and its direct children. --oo _f_i_e_l_d A comma-separated list of columns to display. nnaammee,pprrooppeerrttyy,vvaalluuee,ssoouurrccee is the default value. --pp Display numbers in parsable (exact) values. --rr Recursively display properties for any children. --ss _s_o_u_r_c_e A comma-separated list of sources to display. Those properties coming from a source other than those in this list are ignored. Each source must be one of the following: llooccaall, ddeeffaauulltt, iinnhheerriitteedd, tteemmppoorraarryy, and nnoonnee. The default value is all sources. --tt _t_y_p_e A comma-separated list of types to display, where _t_y_p_e is one of ffiilleessyysstteemm, ssnnaappsshhoott, vvoolluummee, bbooookkmmaarrkk, or aallll. zzffss iinnhheerriitt [--rrSS] _p_r_o_p_e_r_t_y _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e|_s_n_a_p_s_h_o_t... Clears the specified property, causing it to be inherited from an ancestor, restored to default if no ancestor has the property set, or with the --SS option reverted to the received value if one exists. See the _P_r_o_p_e_r_t_i_e_s section for a listing of default values, and details on which properties can be inherited. --rr Recursively inherit the given property for all children. --SS Revert the property to the received value if one exists; otherwise operate as if the --SS option was not specified. zzffss rreemmaapp _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e Remap the indirect blocks in the given filesystem or volume so that they no longer reference blocks on previously removed vdevs and we can eventually shrink the size of the indirect mapping objects for the previously removed vdevs. Note that remapping all blocks might not be possible and that references from snapshots will still exist and cannot be remapped. zzffss uuppggrraaddee Displays a list of file systems that are not the most recent version. zzffss uuppggrraaddee --vv Displays a list of currently supported file system versions. zzffss uuppggrraaddee [--rr] [--VV _v_e_r_s_i_o_n] --aa | _f_i_l_e_s_y_s_t_e_m Upgrades file systems to a new on-disk version. Once this is done, the file systems will no longer be accessible on systems running older versions of the software. zzffss sseenndd streams generated from new snapshots of these file systems cannot be accessed on systems running older versions of the software. In general, the file system version is independent of the pool version. See zpool(1M) for information on the zzppooooll uuppggrraaddee command. In some cases, the file system version and the pool version are interrelated and the pool version must be upgraded before the file system version can be upgraded. --VV _v_e_r_s_i_o_n Upgrade to the specified _v_e_r_s_i_o_n. If the --VV flag is not specified, this command upgrades to the most recent version. This option can only be used to increase the version number, and only up to the most recent version supported by this software. --aa Upgrade all file systems on all imported pools. _f_i_l_e_s_y_s_t_e_m Upgrade the specified file system. --rr Upgrade the specified file system and all descendent file systems. zzffss uusseerrssppaaccee [--HHiinnpp] [--oo _f_i_e_l_d[,_f_i_e_l_d]...] [--ss _f_i_e_l_d]... [--SS _f_i_e_l_d]... [--tt _t_y_p_e[,_t_y_p_e]...] _f_i_l_e_s_y_s_t_e_m|_s_n_a_p_s_h_o_t Displays space consumed by, and quotas on, each user in the specified filesystem or snapshot. This corresponds to the uusseerruusseedd@@_u_s_e_r and uusseerrqquuoottaa@@_u_s_e_r properties. --HH Do not print headers, use tab-delimited output. --SS _f_i_e_l_d Sort by this field in reverse order. See --ss. --ii Translate SID to POSIX ID. The POSIX ID may be ephemeral if no mapping exists. Normal POSIX interfaces (for example, stat(2), llss --ll) perform this translation, so the --ii option allows the output from zzffss uusseerrssppaaccee to be compared directly with those utilities. However, --ii may lead to confusion if some files were created by an SMB user before a SMB-to-POSIX name mapping was established. In such a case, some files will be owned by the SMB entity and some by the POSIX entity. However, the --ii option will report that the POSIX entity has the total usage and quota for both. --nn Print numeric ID instead of user/group name. --oo _f_i_e_l_d[,_f_i_e_l_d]... Display only the specified fields from the following set: ttyyppee, nnaammee, uusseedd, qquuoottaa. The default is to display all fields. --pp Use exact (parsable) numeric output. --ss _f_i_e_l_d Sort output by this field. The --ss and --SS flags may be specified multiple times to sort first by one field, then by another. The default is --ss ttyyppee --ss nnaammee. --tt _t_y_p_e[,_t_y_p_e]... Print only the specified types from the following set: aallll, ppoossiixxuusseerr, ssmmbbuusseerr, ppoossiixxggrroouupp, ssmmbbggrroouupp. The default is --tt ppoossiixxuusseerr,ssmmbbuusseerr. The default can be changed to include group types. zzffss ggrroouuppssppaaccee [--HHiinnpp] [--oo _f_i_e_l_d[,_f_i_e_l_d]...] [--ss _f_i_e_l_d]... [--SS _f_i_e_l_d]... [--tt _t_y_p_e[,_t_y_p_e]...] _f_i_l_e_s_y_s_t_e_m|_s_n_a_p_s_h_o_t Displays space consumed by, and quotas on, each group in the specified filesystem or snapshot. This subcommand is identical to zzffss uusseerrssppaaccee, except that the default types to display are --tt ppoossiixxggrroouupp,ssmmbbggrroouupp. zzffss mmoouunntt Displays all ZFS file systems currently mounted. zzffss mmoouunntt [--OOvv] [--oo _o_p_t_i_o_n_s] --aa | _f_i_l_e_s_y_s_t_e_m Mounts ZFS file systems. --OO Perform an overlay mount. See mount(1M) for more information. --aa Mount all available ZFS file systems. Invoked automatically as part of the boot process. _f_i_l_e_s_y_s_t_e_m Mount the specified filesystem. --oo _o_p_t_i_o_n_s An optional, comma-separated list of mount options to use temporarily for the duration of the mount. See the _T_e_m_p_o_r_a_r_y _M_o_u_n_t _P_o_i_n_t _P_r_o_p_e_r_t_i_e_s section for details. --vv Report mount progress. zzffss uunnmmoouunntt [--ff] --aa | _f_i_l_e_s_y_s_t_e_m|_m_o_u_n_t_p_o_i_n_t Unmounts currently mounted ZFS file systems. --aa Unmount all available ZFS file systems. Invoked automatically as part of the shutdown process. _f_i_l_e_s_y_s_t_e_m|_m_o_u_n_t_p_o_i_n_t Unmount the specified filesystem. The command can also be given a path to a ZFS file system mount point on the system. --ff Forcefully unmount the file system, even if it is currently in use. zzffss sshhaarree --aa | _f_i_l_e_s_y_s_t_e_m Shares available ZFS file systems. --aa Share all available ZFS file systems. Invoked automatically as part of the boot process. _f_i_l_e_s_y_s_t_e_m Share the specified filesystem according to the sshhaarreennffss and sshhaarreessmmbb properties. File systems are shared when the sshhaarreennffss or sshhaarreessmmbb property is set. zzffss uunnsshhaarree --aa | _f_i_l_e_s_y_s_t_e_m|_m_o_u_n_t_p_o_i_n_t Unshares currently shared ZFS file systems. --aa Unshare all available ZFS file systems. Invoked automatically as part of the shutdown process. _f_i_l_e_s_y_s_t_e_m|_m_o_u_n_t_p_o_i_n_t Unshare the specified filesystem. The command can also be given a path to a ZFS file system shared on the system. zzffss bbooookkmmaarrkk _s_n_a_p_s_h_o_t _b_o_o_k_m_a_r_k Creates a bookmark of the given snapshot. Bookmarks mark the point in time when the snapshot was created, and can be used as the incremental source for a zzffss sseenndd command. This feature must be enabled to be used. See zpool-features(5) for details on ZFS feature flags and the bbooookkmmaarrkkss feature. zzffss sseenndd [--DDLLPPRRcceennppvv] [[--II|--ii] _s_n_a_p_s_h_o_t] _s_n_a_p_s_h_o_t Creates a stream representation of the second _s_n_a_p_s_h_o_t, which is written to standard output. The output can be redirected to a file or to a different system (for example, using ssh(1)). By default, a full stream is generated. --DD,, ----ddeedduupp Generate a deduplicated stream. Blocks which would have been sent multiple times in the send stream will only be sent once. The receiving system must also support this feature to receive a deduplicated stream. This flag can be used regardless of the dataset's ddeedduupp property, but performance will be much better if the filesystem uses a dedup-capable checksum (for example, sshhaa225566). --II _s_n_a_p_s_h_o_t Generate a stream package that sends all intermediary snapshots from the first snapshot to the second snapshot. For example, --II _@_a _f_s_@_d is similar to --ii _@_a _f_s_@_b; --ii _@_b _f_s_@_c; --ii _@_c _f_s_@_d. The incremental source may be specified as with the --ii option. --LL,, ----llaarrggee--bblloocckk Generate a stream which may contain blocks larger than 128KB. This flag has no effect if the llaarrggee__bblloocckkss pool feature is disabled, or if the rreeccoorrddssiizzee property of this filesystem has never been set above 128KB. The receiving system must have the llaarrggee__bblloocckkss pool feature enabled as well. See zpool-features(5) for details on ZFS feature flags and the llaarrggee__bblloocckkss feature. --PP,, ----ppaarrssaabbllee Print machine-parsable verbose information about the stream package generated. --RR,, ----rreepplliiccaattee Generate a replication stream package, which will replicate the specified file system, and all descendent file systems, up to the named snapshot. When received, all properties, snapshots, descendent file systems, and clones are preserved. If the --ii or --II flags are used in conjunction with the --RR flag, an incremental replication stream is generated. The current values of properties, and current snapshot and file system names are set when the stream is received. If the --FF flag is specified when this stream is received, snapshots and file systems that do not exist on the sending side are destroyed. --ee,, ----eemmbbeedd Generate a more compact stream by using WWRRIITTEE__EEMMBBEEDDDDEEDD records for blocks which are stored more compactly on disk by the eemmbbeeddddeedd__ddaattaa pool feature. This flag has no effect if the eemmbbeeddddeedd__ddaattaa feature is disabled. The receiving system must have the eemmbbeeddddeedd__ddaattaa feature enabled. If the llzz44__ccoommpprreessss feature is active on the sending system, then the receiving system must have that feature enabled as well. See zpool-features(5) for details on ZFS feature flags and the eemmbbeeddddeedd__ddaattaa feature. --cc,, ----ccoommpprreesssseedd Generate a more compact stream by using compressed WRITE records for blocks which are compressed on disk and in memory (see the ccoommpprreessssiioonn property for details). If the llzz44__ccoommpprreessss feature is active on the sending system, then the receiving system must have that feature enabled as well. If the llaarrggee__bblloocckkss feature is enabled on the sending system but the --LL option is not supplied in conjunction with --cc, then the data will be decompressed before sending so it can be split into smaller block sizes. --ii _s_n_a_p_s_h_o_t Generate an incremental stream from the first _s_n_a_p_s_h_o_t (the incremental source) to the second _s_n_a_p_s_h_o_t (the incremental target). The incremental source can be specified as the last component of the snapshot name (the @@ character and following) and it is assumed to be from the same file system as the incremental target. If the destination is a clone, the source may be the origin snapshot, which must be fully specified (for example, _p_o_o_l_/_f_s_@_o_r_i_g_i_n, not just _@_o_r_i_g_i_n). --nn,, ----ddrryyrruunn Do a dry-run ("No-op") send. Do not generate any actual send data. This is useful in conjunction with the --vv or --PP flags to determine what data will be sent. In this case, the verbose output will be written to standard output (contrast with a non-dry-run, where the stream is written to standard output and the verbose output goes to standard error). --pp,, ----pprrooppss Include the dataset's properties in the stream. This flag is implicit when --RR is specified. The receiving system must also support this feature. --vv,, ----vveerrbboossee Print verbose information about the stream package generated. This information includes a per-second report of how much data has been sent. The format of the stream is committed. You will be able to receive your streams on future versions of ZFS . zzffss sseenndd [--LLccee] [--ii _s_n_a_p_s_h_o_t|_b_o_o_k_m_a_r_k] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e|_s_n_a_p_s_h_o_t Generate a send stream, which may be of a filesystem, and may be incremental from a bookmark. If the destination is a filesystem or volume, the pool must be read-only, or the filesystem must not be mounted. When the stream generated from a filesystem or volume is received, the default snapshot name will be "--head--". --LL,, ----llaarrggee--bblloocckk Generate a stream which may contain blocks larger than 128KB. This flag has no effect if the llaarrggee__bblloocckkss pool feature is disabled, or if the rreeccoorrddssiizzee property of this filesystem has never been set above 128KB. The receiving system must have the llaarrggee__bblloocckkss pool feature enabled as well. See zpool-features(5) for details on ZFS feature flags and the llaarrggee__bblloocckkss feature. --cc,, ----ccoommpprreesssseedd Generate a more compact stream by using compressed WRITE records for blocks which are compressed on disk and in memory (see the ccoommpprreessssiioonn property for details). If the llzz44__ccoommpprreessss feature is active on the sending system, then the receiving system must have that feature enabled as well. If the llaarrggee__bblloocckkss feature is enabled on the sending system but the --LL option is not supplied in conjunction with --cc, then the data will be decompressed before sending so it can be split into smaller block sizes. --ee,, ----eemmbbeedd Generate a more compact stream by using WWRRIITTEE__EEMMBBEEDDDDEEDD records for blocks which are stored more compactly on disk by the eemmbbeeddddeedd__ddaattaa pool feature. This flag has no effect if the eemmbbeeddddeedd__ddaattaa feature is disabled. The receiving system must have the eemmbbeeddddeedd__ddaattaa feature enabled. If the llzz44__ccoommpprreessss feature is active on the sending system, then the receiving system must have that feature enabled as well. See zpool-features(5) for details on ZFS feature flags and the eemmbbeeddddeedd__ddaattaa feature. --ii _s_n_a_p_s_h_o_t|_b_o_o_k_m_a_r_k Generate an incremental send stream. The incremental source must be an earlier snapshot in the destination's history. It will commonly be an earlier snapshot in the destination's file system, in which case it can be specified as the last component of the name (the ## or @@ character and following). If the incremental target is a clone, the incremental source can be the origin snapshot, or an earlier snapshot in the origin's filesystem, or the origin's origin, etc. zzffss sseenndd [--PPeennvv] --tt _r_e_c_e_i_v_e___r_e_s_u_m_e___t_o_k_e_n Creates a send stream which resumes an interrupted receive. The _r_e_c_e_i_v_e___r_e_s_u_m_e___t_o_k_e_n is the value of this property on the filesystem or volume that was being received into. See the documentation for zzffss rreecceeiivvee --ss for more details. zzffss rreecceeiivvee [--FFnnssuuvv] [--oo oorriiggiinn=_s_n_a_p_s_h_o_t] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e|_s_n_a_p_s_h_o_t zzffss rreecceeiivvee [--FFnnssuuvv] [--dd|--ee] [--oo oorriiggiinn=_s_n_a_p_s_h_o_t] _f_i_l_e_s_y_s_t_e_m Creates a snapshot whose contents are as specified in the stream provided on standard input. If a full stream is received, then a new file system is created as well. Streams are created using the zzffss sseenndd subcommand, which by default creates a full stream. zzffss rreeccvv can be used as an alias for zzffss rreecceeiivvee.. If an incremental stream is received, then the destination file system must already exist, and its most recent snapshot must match the incremental stream's source. For zzvvoollss, the destination device link is destroyed and recreated, which means the zzvvooll cannot be accessed during the rreecceeiivvee operation. When a snapshot replication package stream that is generated by using the zzffss sseenndd --RR command is received, any snapshots that do not exist on the sending location are destroyed by using the zzffss ddeessttrrooyy --dd command. The name of the snapshot (and file system, if a full stream is received) that this subcommand creates depends on the argument type and the use of the --dd or --ee options. If the argument is a snapshot name, the specified _s_n_a_p_s_h_o_t is created. If the argument is a file system or volume name, a snapshot with the same name as the sent snapshot is created within the specified _f_i_l_e_s_y_s_t_e_m or _v_o_l_u_m_e. If neither of the --dd or --ee options are specified, the provided target snapshot name is used exactly as provided. The --dd and --ee options cause the file system name of the target snapshot to be determined by appending a portion of the sent snapshot's name to the specified target _f_i_l_e_s_y_s_t_e_m. If the --dd option is specified, all but the first element of the sent snapshot's file system path (usually the pool name) is used and any required intermediate file systems within the specified one are created. If the --ee option is specified, then only the last element of the sent snapshot's file system name (i.e. the name of the source file system itself) is used as the target file system name. --FF Force a rollback of the file system to the most recent snapshot before performing the receive operation. If receiving an incremental replication stream (for example, one generated by zzffss sseenndd --RR [--ii|--II]), destroy snapshots and file systems that do not exist on the sending side. --dd Discard the first element of the sent snapshot's file system name, using the remaining elements to determine the name of the target file system for the new snapshot as described in the paragraph above. --ee Discard all but the last element of the sent snapshot's file system name, using that element to determine the name of the target file system for the new snapshot as described in the paragraph above. --nn Do not actually receive the stream. This can be useful in conjunction with the --vv option to verify the name the receive operation would use. --oo oorriiggiinn=_s_n_a_p_s_h_o_t Forces the stream to be received as a clone of the given snapshot. If the stream is a full send stream, this will create the filesystem described by the stream as a clone of the specified snapshot. Which snapshot was specified will not affect the success or failure of the receive, as long as the snapshot does exist. If the stream is an incremental send stream, all the normal verification will be performed. --uu File system that is associated with the received stream is not mounted. --vv Print verbose information about the stream and the time required to perform the receive operation. --ss If the receive is interrupted, save the partially received state, rather than deleting it. Interruption may be due to premature termination of the stream (e.g. due to network failure or failure of the remote system if the stream is being read over a network connection), a checksum error in the stream, termination of the zzffss rreecceeiivvee process, or unclean shutdown of the system. The receive can be resumed with a stream generated by zzffss sseenndd --tt _t_o_k_e_n, where the _t_o_k_e_n is the value of the rreecceeiivvee__rreessuummee__ttookkeenn property of the filesystem or volume which is received into. To use this flag, the storage pool must have the eexxtteennssiibbllee__ddaattaasseett feature enabled. See zpool-features(5) for details on ZFS feature flags. zzffss rreecceeiivvee --AA _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e Abort an interrupted zzffss rreecceeiivvee --ss, deleting its saved partially received state. zzffss aallllooww _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e Displays permissions that have been delegated on the specified filesystem or volume. See the other forms of zzffss aallllooww for more information. zzffss aallllooww [--ddgglluu] _u_s_e_r|_g_r_o_u_p[,_u_s_e_r|_g_r_o_u_p]... _p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]... _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss aallllooww [--ddll] --ee|eevveerryyoonnee _p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]... _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e Delegates ZFS administration permission for the file systems to non- privileged users. --dd Allow only for the descendent file systems. --ee|eevveerryyoonnee Specifies that the permissions be delegated to everyone. --gg _g_r_o_u_p[,_g_r_o_u_p]... Explicitly specify that permissions are delegated to the group. --ll Allow "locally" only for the specified file system. --uu _u_s_e_r[,_u_s_e_r]... Explicitly specify that permissions are delegated to the user. _u_s_e_r|_g_r_o_u_p[,_u_s_e_r|_g_r_o_u_p]... Specifies to whom the permissions are delegated. Multiple entities can be specified as a comma-separated list. If neither of the --gguu options are specified, then the argument is interpreted preferentially as the keyword eevveerryyoonnee, then as a user name, and lastly as a group name. To specify a user or group named "everyone", use the --gg or --uu options. To specify a group with the same name as a user, use the --gg options. _p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]... The permissions to delegate. Multiple permissions may be specified as a comma-separated list. Permission names are the same as ZFS subcommand and property names. See the property list below. Property set names, which begin with @@, may be specified. See the --ss form below for details. If neither of the --ddll options are specified, or both are, then the permissions are allowed for the file system or volume, and all of its descendents. Permissions are generally the ability to use a ZFS subcommand or change a ZFS property. The following permissions are available: NAME TYPE NOTES allow subcommand Must also have the permission that is being allowed clone subcommand Must also have the 'create' ability and 'mount' ability in the origin file system create subcommand Must also have the 'mount' ability destroy subcommand Must also have the 'mount' ability diff subcommand Allows lookup of paths within a dataset given an object number, and the ability to create snapshots necessary to 'zfs diff'. mount subcommand Allows mount/umount of ZFS datasets promote subcommand Must also have the 'mount' and 'promote' ability in the origin file system receive subcommand Must also have the 'mount' and 'create' ability rename subcommand Must also have the 'mount' and 'create' ability in the new parent rollback subcommand Must also have the 'mount' ability send subcommand share subcommand Allows sharing file systems over NFS or SMB protocols snapshot subcommand Must also have the 'mount' ability groupquota other Allows accessing any groupquota@... property groupused other Allows reading any groupused@... property userprop other Allows changing any user property userquota other Allows accessing any userquota@... property userused other Allows reading any userused@... property aclinherit property aclmode property atime property canmount property casesensitivity property checksum property compression property copies property devices property exec property filesystem_limit property mountpoint property nbmand property normalization property primarycache property quota property readonly property recordsize property refquota property refreservation property reservation property secondarycache property setuid property sharenfs property sharesmb property snapdir property snapshot_limit property utf8only property version property volblocksize property volsize property vscan property xattr property zoned property zzffss aallllooww --cc _p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]... _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e Sets "create time" permissions. These permissions are granted (locally) to the creator of any newly-created descendent file system. zzffss aallllooww --ss @_s_e_t_n_a_m_e _p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]... _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e Defines or adds permissions to a permission set. The set can be used by other zzffss aallllooww commands for the specified file system and its descendents. Sets are evaluated dynamically, so changes to a set are immediately reflected. Permission sets follow the same naming restrictions as ZFS file systems, but the name must begin with @@, and can be no more than 64 characters long. zzffss uunnaallllooww [--ddggllrruu] _u_s_e_r|_g_r_o_u_p[,_u_s_e_r|_g_r_o_u_p]... [_p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]...] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss uunnaallllooww [--ddllrr] --ee|eevveerryyoonnee [_p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]...] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e zzffss uunnaallllooww [--rr] --cc [_p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]...] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e Removes permissions that were granted with the zzffss aallllooww command. No permissions are explicitly denied, so other permissions granted are still in effect. For example, if the permission is granted by an ancestor. If no permissions are specified, then all permissions for the specified _u_s_e_r, _g_r_o_u_p, or eevveerryyoonnee are removed. Specifying eevveerryyoonnee (or using the --ee option) only removes the permissions that were granted to everyone, not all permissions for every user and group. See the zzffss aallllooww command for a description of the --lldduuggeecc options. --rr Recursively remove the permissions from this file system and all descendents. zzffss uunnaallllooww [--rr] --ss @_s_e_t_n_a_m_e [_p_e_r_m|@_s_e_t_n_a_m_e[,_p_e_r_m|@_s_e_t_n_a_m_e]...] _f_i_l_e_s_y_s_t_e_m|_v_o_l_u_m_e Removes permissions from a permission set. If no permissions are specified, then all permissions are removed, thus removing the set entirely. zzffss hhoolldd [--rr] _t_a_g _s_n_a_p_s_h_o_t... Adds a single reference, named with the _t_a_g argument, to the specified snapshot or snapshots. Each snapshot has its own tag namespace, and tags must be unique within that space. If a hold exists on a snapshot, attempts to destroy that snapshot by using the zzffss ddeessttrrooyy command return EBUSY. --rr Specifies that a hold with the given tag is applied recursively to the snapshots of all descendent file systems. zzffss hhoollddss [--rr] _s_n_a_p_s_h_o_t... Lists all existing user references for the given snapshot or snapshots. --rr Lists the holds that are set on the named descendent snapshots, in addition to listing the holds on the named snapshot. zzffss rreelleeaassee [--rr] _t_a_g _s_n_a_p_s_h_o_t... Removes a single reference, named with the _t_a_g argument, from the specified snapshot or snapshots. The tag must already exist for each snapshot. If a hold exists on a snapshot, attempts to destroy that snapshot by using the zzffss ddeessttrrooyy command return EBUSY. --rr Recursively releases a hold with the given tag on the snapshots of all descendent file systems. zzffss ddiiffff [--FFHHtt] _s_n_a_p_s_h_o_t _s_n_a_p_s_h_o_t|_f_i_l_e_s_y_s_t_e_m Display the difference between a snapshot of a given filesystem and another snapshot of that filesystem from a later time or the current contents of the filesystem. The first column is a character indicating the type of change, the other columns indicate pathname, new pathname (in case of rename), change in link count, and optionally file type and/or change time. The types of change are: - The path has been removed + The path has been created M The path has been modified R The path has been renamed --FF Display an indication of the type of file, in a manner similar to the -- option of ls(1). B Block device C Character device / Directory > Door | Named pipe @ Symbolic link P Event port = Socket F Regular file --HH Give more parsable tab-separated output, without header lines and without arrows. --tt Display the path's inode change time as the first column of output. zzffss pprrooggrraamm [--jjnn] [--tt _t_i_m_e_o_u_t] [--mm _m_e_m_o_r_y___l_i_m_i_t] _p_o_o_l _s_c_r_i_p_t [_a_r_g_1 ...] Executes _s_c_r_i_p_t as a ZFS channel program on _p_o_o_l. The ZFS channel program interface allows ZFS administrative operations to be run programmatically via a Lua script. The entire script is executed atomically, with no other administrative operations taking effect concurrently. A library of ZFS calls is made available to channel program scripts. Channel programs may only be run with root privileges. For full documentation of the ZFS channel program interface, see the manual page for zfs-program(1M). --jj Display channel program output in JSON format. When this flag is specified and standard output is empty - channel program encountered an error. The details of such an error will be printed to standard error in plain text. --nn Executes a read-only channel program, which runs faster. The program cannot change on-disk state by calling functions from the zfs.sync submodule. The program can be used to gather information such as properties and determining if changes would succeed (zfs.check.*). Without this flag, all pending changes must be synced to disk before a channel program can complete. --tt _t_i_m_e_o_u_t Execution time limit, in milliseconds. If a channel program executes for longer than the provided timeout, it will be stopped and an error will be returned. The default timeout is 1000 ms, and can be set to a maximum of 10000 ms. --mm _m_e_m_o_r_y_-_l_i_m_i_t Memory limit, in bytes. If a channel program attempts to allocate more memory than the given limit, it will be stopped and an error returned. The default memory limit is 10 MB, and can be set to a maximum of 100 MB. All remaining argument strings are passed directly to the channel program as arguments. See zfs-program(1M) for more information. EEXXIITT SSTTAATTUUSS The zzffss utility exits 0 on success, 1 if an error occurs, and 2 if invalid command line options were specified. EEXXAAMMPPLLEESS EExxaammppllee 11 Creating a ZFS File System Hierarchy The following commands create a file system named _p_o_o_l_/_h_o_m_e and a file system named _p_o_o_l_/_h_o_m_e_/_b_o_b. The mount point _/_e_x_p_o_r_t_/_h_o_m_e is set for the parent file system, and is automatically inherited by the child file system. # zfs create pool/home # zfs set mountpoint=/export/home pool/home # zfs create pool/home/bob EExxaammppllee 22 Creating a ZFS Snapshot The following command creates a snapshot named yyeesstteerrddaayy. This snapshot is mounted on demand in the _._z_f_s_/_s_n_a_p_s_h_o_t directory at the root of the _p_o_o_l_/_h_o_m_e_/_b_o_b file system. # zfs snapshot pool/home/bob@yesterday EExxaammppllee 33 Creating and Destroying Multiple Snapshots The following command creates snapshots named yyeesstteerrddaayy of _p_o_o_l_/_h_o_m_e and all of its descendent file systems. Each snapshot is mounted on demand in the _._z_f_s_/_s_n_a_p_s_h_o_t directory at the root of its file system. The second command destroys the newly created snapshots. # zfs snapshot -r pool/home@yesterday # zfs destroy -r pool/home@yesterday EExxaammppllee 44 Disabling and Enabling File System Compression The following command disables the ccoommpprreessssiioonn property for all file systems under _p_o_o_l_/_h_o_m_e. The next command explicitly enables ccoommpprreessssiioonn for _p_o_o_l_/_h_o_m_e_/_a_n_n_e. # zfs set compression=off pool/home # zfs set compression=on pool/home/anne EExxaammppllee 55 Listing ZFS Datasets The following command lists all active file systems and volumes in the system. Snapshots are displayed if the lliissttssnnaappss property is oonn. The default is ooffff. See zpool(1M) for more information on pool properties. # zfs list NAME USED AVAIL REFER MOUNTPOINT pool 450K 457G 18K /pool pool/home 315K 457G 21K /export/home pool/home/anne 18K 457G 18K /export/home/anne pool/home/bob 276K 457G 276K /export/home/bob EExxaammppllee 66 Setting a Quota on a ZFS File System The following command sets a quota of 50 Gbytes for _p_o_o_l_/_h_o_m_e_/_b_o_b. # zfs set quota=50G pool/home/bob EExxaammppllee 77 Listing ZFS Properties The following command lists all properties for _p_o_o_l_/_h_o_m_e_/_b_o_b. # zfs get all pool/home/bob NAME PROPERTY VALUE SOURCE pool/home/bob type filesystem - pool/home/bob creation Tue Jul 21 15:53 2009 - pool/home/bob used 21K - pool/home/bob available 20.0G - pool/home/bob referenced 21K - pool/home/bob compressratio 1.00x - pool/home/bob mounted yes - pool/home/bob quota 20G local pool/home/bob reservation none default pool/home/bob recordsize 128K default pool/home/bob mountpoint /pool/home/bob default pool/home/bob sharenfs off default pool/home/bob checksum on default pool/home/bob compression on local pool/home/bob atime on default pool/home/bob devices on default pool/home/bob exec on default pool/home/bob setuid on default pool/home/bob readonly off default pool/home/bob zoned off default pool/home/bob snapdir hidden default pool/home/bob aclmode discard default pool/home/bob aclinherit restricted default pool/home/bob canmount on default pool/home/bob xattr on default pool/home/bob copies 1 default pool/home/bob version 4 - pool/home/bob utf8only off - pool/home/bob normalization none - pool/home/bob casesensitivity sensitive - pool/home/bob vscan off default pool/home/bob nbmand off default pool/home/bob sharesmb off default pool/home/bob refquota none default pool/home/bob refreservation none default pool/home/bob primarycache all default pool/home/bob secondarycache all default pool/home/bob usedbysnapshots 0 - pool/home/bob usedbydataset 21K - pool/home/bob usedbychildren 0 - pool/home/bob usedbyrefreservation 0 - The following command gets a single property value. # zfs get -H -o value compression pool/home/bob on The following command lists all properties with local settings for _p_o_o_l_/_h_o_m_e_/_b_o_b. # zfs get -r -s local -o name,property,value all pool/home/bob NAME PROPERTY VALUE pool/home/bob quota 20G pool/home/bob compression on EExxaammppllee 88 Rolling Back a ZFS File System The following command reverts the contents of _p_o_o_l_/_h_o_m_e_/_a_n_n_e to the snapshot named yyeesstteerrddaayy, deleting all intermediate snapshots. # zfs rollback -r pool/home/anne@yesterday EExxaammppllee 99 Creating a ZFS Clone The following command creates a writable file system whose initial contents are the same as _p_o_o_l_/_h_o_m_e_/_b_o_b_@_y_e_s_t_e_r_d_a_y. # zfs clone pool/home/bob@yesterday pool/clone EExxaammppllee 1100 Promoting a ZFS Clone The following commands illustrate how to test out changes to a file system, and then replace the original file system with the changed one, using clones, clone promotion, and renaming: # zfs create pool/project/production populate /pool/project/production with data # zfs snapshot pool/project/production@today # zfs clone pool/project/production@today pool/project/beta make changes to /pool/project/beta and test them # zfs promote pool/project/beta # zfs rename pool/project/production pool/project/legacy # zfs rename pool/project/beta pool/project/production once the legacy version is no longer needed, it can be destroyed # zfs destroy pool/project/legacy EExxaammppllee 1111 Inheriting ZFS Properties The following command causes _p_o_o_l_/_h_o_m_e_/_b_o_b and _p_o_o_l_/_h_o_m_e_/_a_n_n_e to inherit the cchheecckkssuumm property from their parent. # zfs inherit checksum pool/home/bob pool/home/anne EExxaammppllee 1122 Remotely Replicating ZFS Data The following commands send a full stream and then an incremental stream to a remote machine, restoring them into _p_o_o_l_B_/_r_e_c_e_i_v_e_d_/_f_s_@_a and _p_o_o_l_B_/_r_e_c_e_i_v_e_d_/_f_s_@_b, respectively. _p_o_o_l_B must contain the file system _p_o_o_l_B_/_r_e_c_e_i_v_e_d, and must not initially contain _p_o_o_l_B_/_r_e_c_e_i_v_e_d_/_f_s. # zfs send pool/fs@a | \ ssh host zfs receive poolB/received/fs@a # zfs send -i a pool/fs@b | \ ssh host zfs receive poolB/received/fs EExxaammppllee 1133 Using the zfs receive -d Option The following command sends a full stream of _p_o_o_l_A_/_f_s_A_/_f_s_B_@_s_n_a_p to a remote machine, receiving it into _p_o_o_l_B_/_r_e_c_e_i_v_e_d_/_f_s_A_/_f_s_B_@_s_n_a_p. The _f_s_A_/_f_s_B_@_s_n_a_p portion of the received snapshot's name is determined from the name of the sent snapshot. _p_o_o_l_B must contain the file system _p_o_o_l_B_/_r_e_c_e_i_v_e_d. If _p_o_o_l_B_/_r_e_c_e_i_v_e_d_/_f_s_A does not exist, it is created as an empty file system. # zfs send poolA/fsA/fsB@snap | \ ssh host zfs receive -d poolB/received EExxaammppllee 1144 Setting User Properties The following example sets the user-defined ccoomm..eexxaammppllee::ddeeppaarrttmmeenntt property for a dataset. # zfs set com.example:department=12345 tank/accounting EExxaammppllee 1155 Performing a Rolling Snapshot The following example shows how to maintain a history of snapshots with a consistent naming scheme. To keep a week's worth of snapshots, the user destroys the oldest snapshot, renames the remaining snapshots, and then creates a new snapshot, as follows: # zfs destroy -r pool/users@7daysago # zfs rename -r pool/users@6daysago @7daysago # zfs rename -r pool/users@5daysago @6daysago # zfs rename -r pool/users@4daysago @5daysago # zfs rename -r pool/users@3daysago @4daysago # zfs rename -r pool/users@2daysago @3daysago # zfs rename -r pool/users@yesterday @2daysago # zfs rename -r pool/users@today @yesterday # zfs snapshot -r pool/users@today EExxaammppllee 1166 Setting sharenfs Property Options on a ZFS File System The following commands show how to set sshhaarreennffss property options to enable rrww access for a set of IIPP addresses and to enable root access for system nneeoo on the _t_a_n_k_/_h_o_m_e file system. # zfs set sharenfs='rw=@123.123.0.0/16,root=neo' tank/home If you are using DDNNSS for host name resolution, specify the fully qualified hostname. EExxaammppllee 1177 Delegating ZFS Administration Permissions on a ZFS Dataset The following example shows how to set permissions so that user cciinnddyyss can create, destroy, mount, and take snapshots on _t_a_n_k_/_c_i_n_d_y_s. The permissions on _t_a_n_k_/_c_i_n_d_y_s are also displayed. # zfs allow cindys create,destroy,mount,snapshot tank/cindys # zfs allow tank/cindys ---- Permissions on tank/cindys -------------------------------------- Local+Descendent permissions: user cindys create,destroy,mount,snapshot Because the _t_a_n_k_/_c_i_n_d_y_s mount point permission is set to 755 by default, user cciinnddyyss will be unable to mount file systems under _t_a_n_k_/_c_i_n_d_y_s. Add an ACE similar to the following syntax to provide mount point access: # chmod A+user:cindys:add_subdirectory:allow /tank/cindys EExxaammppllee 1188 Delegating Create Time Permissions on a ZFS Dataset The following example shows how to grant anyone in the group ssttaaffff to create file systems in _t_a_n_k_/_u_s_e_r_s. This syntax also allows staff members to destroy their own file systems, but not destroy anyone else's file system. The permissions on _t_a_n_k_/_u_s_e_r_s are also displayed. # zfs allow staff create,mount tank/users # zfs allow -c destroy tank/users # zfs allow tank/users ---- Permissions on tank/users --------------------------------------- Permission sets: destroy Local+Descendent permissions: group staff create,mount EExxaammppllee 1199 Defining and Granting a Permission Set on a ZFS Dataset The following example shows how to define and grant a permission set on the _t_a_n_k_/_u_s_e_r_s file system. The permissions on _t_a_n_k_/_u_s_e_r_s are also displayed. # zfs allow -s @pset create,destroy,snapshot,mount tank/users # zfs allow staff @pset tank/users # zfs allow tank/users ---- Permissions on tank/users --------------------------------------- Permission sets: @pset create,destroy,mount,snapshot Local+Descendent permissions: group staff @pset EExxaammppllee 2200 Delegating Property Permissions on a ZFS Dataset The following example shows to grant the ability to set quotas and reservations on the _u_s_e_r_s_/_h_o_m_e file system. The permissions on _u_s_e_r_s_/_h_o_m_e are also displayed. # zfs allow cindys quota,reservation users/home # zfs allow users/home ---- Permissions on users/home --------------------------------------- Local+Descendent permissions: user cindys quota,reservation cindys% zfs set quota=10G users/home/marks cindys% zfs get quota users/home/marks NAME PROPERTY VALUE SOURCE users/home/marks quota 10G local EExxaammppllee 2211 Removing ZFS Delegated Permissions on a ZFS Dataset The following example shows how to remove the snapshot permission from the ssttaaffff group on the _t_a_n_k_/_u_s_e_r_s file system. The permissions on _t_a_n_k_/_u_s_e_r_s are also displayed. # zfs unallow staff snapshot tank/users # zfs allow tank/users ---- Permissions on tank/users --------------------------------------- Permission sets: @pset create,destroy,mount,snapshot Local+Descendent permissions: group staff @pset EExxaammppllee 2222 Showing the differences between a snapshot and a ZFS Dataset The following example shows how to see what has changed between a prior snapshot of a ZFS dataset and its current state. The --FF option is used to indicate type information for the files affected. # zfs diff -F tank/test@before tank/test M / /tank/test/ M F /tank/test/linked (+1) R F /tank/test/oldname -> /tank/test/newname - F /tank/test/deleted + F /tank/test/created M F /tank/test/modified IINNTTEERRFFAACCEE SSTTAABBIILLIITTYY CCoommmmiitttteedd. SSEEEE AALLSSOO gzip(1), ssh(1), mount(1M), share(1M), sharemgr(1M), unshare(1M), zfs-program(1M), zonecfg(1M), zpool(1M), chmod(2), stat(2), write(2), fsync(3C), dfstab(4), acl(5), attributes(5) illumos February 26, 2019 illumos