Deleted Added
full compact
zfs.8 (205659) zfs.8 (209962)
1'\" te
2.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
1'\" te
2.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
3.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6.TH zfs 1M "14 Feb 2009" "SunOS 5.11" "System Administration Commands"
3.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4.\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with
5.\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
7.\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with
8.\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
9.TH zfs 1M "5 May 2009" "SunOS 5.11" "System Administration Commands"
7.SH NAME
8zfs \- configures ZFS file systems
9.SH SYNOPSIS
10.LP
11.nf
12\fBzfs\fR [\fB-?\fR]
13.fi
14

--- 46 unchanged lines hidden (view full) ---

61
62.LP
63.nf
64\fBzfs\fR \fBrename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR
65.fi
66
67.LP
68.nf
10.SH NAME
11zfs \- configures ZFS file systems
12.SH SYNOPSIS
13.LP
14.nf
15\fBzfs\fR [\fB-?\fR]
16.fi
17

--- 46 unchanged lines hidden (view full) ---

64
65.LP
66.nf
67\fBzfs\fR \fBrename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR
68.fi
69
70.LP
71.nf
69\fBzfs\fR \fBlist\fR [\fB-rH\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fB-t\fR \fItype\fR[,...]]
72\fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-H\fR][\fB-o\fR \fIproperty\fR[,...]] [\fB-t\fR \fItype\fR[,...]]
70 [\fB-s\fR \fIproperty\fR] ... [\fB-S\fR \fIproperty\fR] ... [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR] ...
71.fi
72
73.LP
74.nf
75\fBzfs\fR \fBset\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR|snapshot ...
76.fi
77
78.LP
79.nf
73 [\fB-s\fR \fIproperty\fR] ... [\fB-S\fR \fIproperty\fR] ... [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR] ...
74.fi
75
76.LP
77.nf
78\fBzfs\fR \fBset\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR|snapshot ...
79.fi
80
81.LP
82.nf
80\fBzfs\fR \fBget\fR [\fB-rHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-s\fR \fIsource\fR[,...]] "\fIall\fR" | \fIproperty\fR[,...]
81 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...
83\fBzfs\fR \fBget\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-Hp\fR][\fB-o\fR \fIfield\fR[,...]] [\fB-s\fR \fIsource\fR[,...]]
84 "\fIall\fR" | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...
82.fi
83
84.LP
85.nf
86\fBzfs\fR \fBinherit\fR [\fB-r\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume|snapshot\fR ...
87.fi
88
89.LP
90.nf
91\fBzfs\fR \fBupgrade\fR [\fB-v\fR]
92.fi
93
94.LP
95.nf
96\fBzfs\fR \fBupgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIfilesystem\fR
97.fi
98
99.LP
100.nf
85.fi
86
87.LP
88.nf
89\fBzfs\fR \fBinherit\fR [\fB-r\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume|snapshot\fR ...
90.fi
91
92.LP
93.nf
94\fBzfs\fR \fBupgrade\fR [\fB-v\fR]
95.fi
96
97.LP
98.nf
99\fBzfs\fR \fBupgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIfilesystem\fR
100.fi
101
102.LP
103.nf
104\fBzfs\fR \fBuserspace\fR [\fB-niHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-sS\fR \fIfield\fR] ...
105 [\fB-t\fR \fItype\fR [,...]] \fIfilesystem\fR|\fIsnapshot\fR
106.fi
107
108.LP
109.nf
110\fBzfs\fR \fBgroupspace\fR [\fB-niHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-sS\fR \fIfield\fR] ...
111 [\fB-t\fR \fItype\fR [,...]] \fIfilesystem\fR|\fIsnapshot\fR
112.fi
113
114.LP
115.nf
101\fBzfs\fR \fBmount\fR
102.fi
103
104.LP
105.nf
106\fBzfs\fR \fBmount\fR [\fB-vO\fR] [\fB-o \fIoptions\fR\fR] \fB-a\fR | \fIfilesystem\fR
107.fi
108

--- 14 unchanged lines hidden (view full) ---

123
124.LP
125.nf
126\fBzfs\fR \fBsend\fR [\fB-vR\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
127.fi
128
129.LP
130.nf
116\fBzfs\fR \fBmount\fR
117.fi
118
119.LP
120.nf
121\fBzfs\fR \fBmount\fR [\fB-vO\fR] [\fB-o \fIoptions\fR\fR] \fB-a\fR | \fIfilesystem\fR
122.fi
123

--- 14 unchanged lines hidden (view full) ---

138
139.LP
140.nf
141\fBzfs\fR \fBsend\fR [\fB-vR\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
142.fi
143
144.LP
145.nf
131\fBzfs\fR \fBreceive\fR [\fB-vnF\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
146\fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
132.fi
133
134.LP
135.nf
147.fi
148
149.LP
150.nf
136\fBzfs\fR \fBreceive\fR [\fB-vnF\fR] \fB-d\fR \fIfilesystem\fR
151\fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] \fB-d\fR \fIfilesystem\fR
137.fi
138
139.LP
140.nf
152.fi
153
154.LP
155.nf
156\fBzfs\fR \fBallow\fR \fIfilesystem\fR|\fIvolume\fR
157.fi
158
159.LP
160.nf
141\fBzfs\fR \fBallow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|\fI@setname\fR[,...]
142 \fIfilesystem\fR|\fIvolume\fR
143.fi
144
145.LP
146.nf
147\fBzfs\fR \fBallow\fR [\fB-ld\fR] \fB-e\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR
148.fi

--- 38 unchanged lines hidden (view full) ---

187.nf
188pool/{filesystem,volume,snapshot}
189.fi
190.in -2
191.sp
192
193.sp
194.LP
161\fBzfs\fR \fBallow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|\fI@setname\fR[,...]
162 \fIfilesystem\fR|\fIvolume\fR
163.fi
164
165.LP
166.nf
167\fBzfs\fR \fBallow\fR [\fB-ld\fR] \fB-e\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR
168.fi

--- 38 unchanged lines hidden (view full) ---

207.nf
208pool/{filesystem,volume,snapshot}
209.fi
210.in -2
211.sp
212
213.sp
214.LP
195where the maximum length of a dataset name is \fBMAXNAMELEN\fR (256 bytes).
215\&...where the maximum length of a dataset name is \fBMAXNAMELEN\fR (256 bytes).
196.sp
197.LP
198A dataset can be one of the following:
199.sp
200.ne 2
201.mk
202.na
203\fB\fIfile system\fR\fR

--- 6 unchanged lines hidden (view full) ---

210.sp
211.ne 2
212.mk
213.na
214\fB\fIvolume\fR\fR
215.ad
216.sp .6
217.RS 4n
216.sp
217.LP
218A dataset can be one of the following:
219.sp
220.ne 2
221.mk
222.na
223\fB\fIfile system\fR\fR

--- 6 unchanged lines hidden (view full) ---

230.sp
231.ne 2
232.mk
233.na
234\fB\fIvolume\fR\fR
235.ad
236.sp .6
237.RS 4n
218A 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. Volumes cannot be used in a non-global zone.
238A 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.
219.RE
220
221.sp
222.ne 2
223.mk
224.na
225\fB\fIsnapshot\fR\fR
226.ad

--- 36 unchanged lines hidden (view full) ---

263.sp
264.LP
265Creating a \fBZFS\fR file system is a simple operation, so the number of file systems per system is likely to be numerous. To cope with this, \fBZFS\fR automatically manages mounting and unmounting file systems without the need to edit the \fB/etc/vfstab\fR file. All automatically managed file systems are mounted by \fBZFS\fR at boot time.
266.sp
267.LP
268By default, file systems are mounted under \fB/\fIpath\fR\fR, where \fIpath\fR is the name of the file system in the \fBZFS\fR namespace. Directories are created and destroyed as needed.
269.sp
270.LP
239.RE
240
241.sp
242.ne 2
243.mk
244.na
245\fB\fIsnapshot\fR\fR
246.ad

--- 36 unchanged lines hidden (view full) ---

283.sp
284.LP
285Creating a \fBZFS\fR file system is a simple operation, so the number of file systems per system is likely to be numerous. To cope with this, \fBZFS\fR automatically manages mounting and unmounting file systems without the need to edit the \fB/etc/vfstab\fR file. All automatically managed file systems are mounted by \fBZFS\fR at boot time.
286.sp
287.LP
288By default, file systems are mounted under \fB/\fIpath\fR\fR, where \fIpath\fR is the name of the file system in the \fBZFS\fR namespace. Directories are created and destroyed as needed.
289.sp
290.LP
271A file system can also have a mount point set in the "mountpoint" property. This directory is created as needed, and \fBZFS\fR automatically mounts the file system when the "\fBzfs mount -a\fR" command is invoked (without editing \fB/etc/vfstab\fR). The mountpoint property can be inherited, so if \fBpool/home\fR has a mount point of \fB/export/stuff\fR, then \fBpool/home/user\fR automatically inherits a mount point of \fB/export/stuff/user\fR.
291A file system can also have a mount point set in the \fBmountpoint\fR property. This directory is created as needed, and \fBZFS\fR automatically mounts the file system when the \fBzfs mount -a\fR command is invoked (without editing \fB/etc/vfstab\fR). The \fBmountpoint\fR property can be inherited, so if \fBpool/home\fR has a mount point of \fB/export/stuff\fR, then \fBpool/home/user\fR automatically inherits a mount point of \fB/export/stuff/user\fR.
272.sp
273.LP
292.sp
293.LP
274A file system mountpoint property of "none" prevents the file system from being mounted.
294A file system \fBmountpoint\fR property of \fBnone\fR prevents the file system from being mounted.
275.sp
276.LP
295.sp
296.LP
277If needed, \fBZFS\fR file systems can also be managed with traditional tools (\fBmount\fR, \fBumount\fR, \fB/etc/vfstab\fR). If a file system's mount point is set to "legacy", \fBZFS\fR makes no attempt to manage the file system, and the administrator is responsible for mounting and unmounting the file system.
297If needed, \fBZFS\fR file systems can also be managed with traditional tools (\fBmount\fR, \fBumount\fR, \fB/etc/vfstab\fR). If a file system's mount point is set to \fBlegacy\fR, \fBZFS\fR makes no attempt to manage the file system, and the administrator is responsible for mounting and unmounting the file system.
278.SS "Zones"
279.sp
280.LP
298.SS "Zones"
299.sp
300.LP
281A \fBZFS\fR file system can be added to a non-global zone by using zonecfg's "\fBadd fs\fR" subcommand. A \fBZFS\fR file system that is added to a non-global zone must have its mountpoint property set to legacy.
301A \fBZFS\fR file system can be added to a non-global zone by using the \fBzonecfg\fR \fBadd fs\fR subcommand. A \fBZFS\fR file system that is added to a non-global zone must have its \fBmountpoint\fR property set to \fBlegacy\fR.
282.sp
283.LP
284The 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.
285.sp
286.LP
302.sp
303.LP
304The 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.
305.sp
306.LP
287A dataset can also be delegated to a non-global zone by using zonecfg's "\fBadd dataset\fR" 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 "quota" property is controlled by the global administrator.
307A dataset can also be delegated to a non-global zone by using \fBzonecfg\fR \fBadd dataset\fR 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 \fBquota\fR property is controlled by the global administrator.
288.sp
289.LP
308.sp
309.LP
290A \fBZFS\fR volume can be added as a device to a non-global zone by using zonecfg's "\fBadd device\fR" subcommand. However, its physical properties can only be modified by the global administrator.
310A \fBZFS\fR volume can be added as a device to a non-global zone by using \fBzonecfg\fR \fBadd device\fR subcommand. However, its physical properties can be modified only by the global administrator.
291.sp
292.LP
293For more information about \fBzonecfg\fR syntax, see \fBzonecfg\fR(1M).
294.sp
295.LP
311.sp
312.LP
313For more information about \fBzonecfg\fR syntax, see \fBzonecfg\fR(1M).
314.sp
315.LP
296After a dataset is delegated to a non-global zone, the "zoned" 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.
316After a dataset is delegated to a non-global zone, the \fBzoned\fR 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.
297.sp
298.LP
317.sp
318.LP
299The global administrator can forcibly clear the "zoned" 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.
319The global administrator can forcibly clear the \fBzoned\fR 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.
300.SS "Native Properties"
301.sp
302.LP
320.SS "Native Properties"
321.sp
322.LP
303Properties are divided into two types, native properties and user defined properties. Native properties either export internal statistics or control \fBZFS\fR behavior. In addition, native properties are either editable or read-only. User properties have no effect on \fBZFS\fR 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 "User Properties" section.
323Properties are divided into two types, native and user-defined (or "user"). Native properties either export internal statistics or control \fBZFS\fR behavior. In addition, native properties are either editable or read-only. User properties have no effect on \fBZFS\fR 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 "User Properties" section, below.
304.sp
305.LP
324.sp
325.LP
306Every dataset has a set of properties that export statistics about the dataset as well as control various behavior. Properties are inherited from the parent unless overridden by the child. Some properties only apply to certain types of datasets (file systems, volumes or snapshots).
326Every 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).
307.sp
308.LP
327.sp
328.LP
309The values of numeric properties can be specified using human-readable suffixes (for example, "k", "KB", "M", "Gb", etc, up to Z for zettabyte). The following are all valid (and equal) specifications:
329The values of numeric properties can be specified using human-readable suffixes (for example, \fBk\fR, \fBKB\fR, \fBM\fR, \fBGb\fR, and so forth, up to \fBZ\fR for zettabyte). The following are all valid (and equal) specifications:
310.sp
311.in +2
312.nf
330.sp
331.in +2
332.nf
313"1536M", "1.5g", "1.50GB".
3331536M, 1.5g, 1.50GB
314.fi
315.in -2
316.sp
317
318.sp
319.LP
334.fi
335.in -2
336.sp
337
338.sp
339.LP
320The values of non-numeric properties are case sensitive and must be lowercase, except for "mountpoint", "sharenfs" and "sharesmb".
340The values of non-numeric properties are case sensitive and must be lowercase, except for \fBmountpoint\fR, \fBsharenfs\fR, and \fBsharesmb\fR.
321.sp
322.LP
341.sp
342.LP
323The following native properties consist of read-only statistics about the dataset. These properties cannot be set, nor are they inherited. Native properties apply to all dataset types unless otherwise noted.
343The 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.
324.sp
325.ne 2
326.mk
327.na
344.sp
345.ne 2
346.mk
347.na
328\fBavailable\fR
348\fB\fBavailable\fR\fR
329.ad
330.sp .6
331.RS 4n
332The 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.
333.sp
349.ad
350.sp .6
351.RS 4n
352The 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.
353.sp
334This property can also be referred to by its shortened column name, "avail".
354This property can also be referred to by its shortened column name, \fBavail\fR.
335.RE
336
337.sp
338.ne 2
339.mk
340.na
355.RE
356
357.sp
358.ne 2
359.mk
360.na
341\fBcompressratio\fR
361\fB\fBcompressratio\fR\fR
342.ad
343.sp .6
344.RS 4n
362.ad
363.sp .6
364.RS 4n
345The compression ratio achieved for this dataset, expressed as a multiplier. Compression can be turned on by running "zfs set compression=on \fIdataset\fR". The default value is "off".
365The compression ratio achieved for this dataset, expressed as a multiplier. Compression can be turned on by running: \fBzfs set compression=on \fIdataset\fR\fR. The default value is \fBoff\fR.
346.RE
347
348.sp
349.ne 2
350.mk
351.na
366.RE
367
368.sp
369.ne 2
370.mk
371.na
352\fBcreation\fR
372\fB\fBcreation\fR\fR
353.ad
354.sp .6
355.RS 4n
356The time this dataset was created.
357.RE
358
359.sp
360.ne 2
361.mk
362.na
373.ad
374.sp .6
375.RS 4n
376The time this dataset was created.
377.RE
378
379.sp
380.ne 2
381.mk
382.na
363\fBmounted\fR
383\fB\fBmounted\fR\fR
364.ad
365.sp .6
366.RS 4n
384.ad
385.sp .6
386.RS 4n
367For file systems, indicates whether the file system is currently mounted. This property can be either "yes" or "no".
387For file systems, indicates whether the file system is currently mounted. This property can be either \fByes\fR or \fBno\fR.
368.RE
369
370.sp
371.ne 2
372.mk
373.na
388.RE
389
390.sp
391.ne 2
392.mk
393.na
374\fBorigin\fR
394\fB\fBorigin\fR\fR
375.ad
376.sp .6
377.RS 4n
378For cloned file systems or volumes, the snapshot from which the clone was created. The origin cannot be destroyed (even with the \fB-r\fR or \fB-f\fR options) so long as a clone exists.
379.RE
380
381.sp
382.ne 2
383.mk
384.na
395.ad
396.sp .6
397.RS 4n
398For cloned file systems or volumes, the snapshot from which the clone was created. The origin cannot be destroyed (even with the \fB-r\fR or \fB-f\fR options) so long as a clone exists.
399.RE
400
401.sp
402.ne 2
403.mk
404.na
385\fBreferenced\fR
405\fB\fBreferenced\fR\fR
386.ad
387.sp .6
388.RS 4n
389The 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.
390.sp
406.ad
407.sp .6
408.RS 4n
409The 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.
410.sp
391This property can also be referred to by its shortened column name, "refer".
411This property can also be referred to by its shortened column name, \fBrefer\fR.
392.RE
393
394.sp
395.ne 2
396.mk
397.na
412.RE
413
414.sp
415.ne 2
416.mk
417.na
398\fBtype\fR
418\fB\fBtype\fR\fR
399.ad
400.sp .6
401.RS 4n
419.ad
420.sp .6
421.RS 4n
402The type of dataset: "filesystem", "volume", or "snapshot".
422The type of dataset: \fBfilesystem\fR, \fBvolume\fR, or \fBsnapshot\fR.
403.RE
404
405.sp
406.ne 2
407.mk
408.na
423.RE
424
425.sp
426.ne 2
427.mk
428.na
409\fBused\fR
429\fB\fBused\fR\fR
410.ad
411.sp .6
412.RS 4n
413The 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 are freed if this dataset is recursively destroyed, is the greater of its space used and its reservation.
414.sp
415When snapshots (see the "Snapshots" section) are created, their space is initially shared between the snapshot and the file system, and possibly with previous snapshots. As the file system changes, space that was previously shared becomes unique to the snapshot, and counted in the snapshot's space used. Additionally, deleting snapshots can increase the amount of space unique to (and used by) other snapshots.
416.sp
417The 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 \fBfsync\fR(3c) or \fBO_SYNC\fR does not necessarily guarantee that the space usage information is updated immediately.
418.RE
419
420.sp
421.ne 2
422.mk
423.na
430.ad
431.sp .6
432.RS 4n
433The 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 are freed if this dataset is recursively destroyed, is the greater of its space used and its reservation.
434.sp
435When snapshots (see the "Snapshots" section) are created, their space is initially shared between the snapshot and the file system, and possibly with previous snapshots. As the file system changes, space that was previously shared becomes unique to the snapshot, and counted in the snapshot's space used. Additionally, deleting snapshots can increase the amount of space unique to (and used by) other snapshots.
436.sp
437The 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 \fBfsync\fR(3c) or \fBO_SYNC\fR does not necessarily guarantee that the space usage information is updated immediately.
438.RE
439
440.sp
441.ne 2
442.mk
443.na
424\fBusedby*\fR
444\fB\fBusedby*\fR\fR
425.ad
426.sp .6
427.RS 4n
445.ad
446.sp .6
447.RS 4n
428The \fBusedby*\fR snapshots decompose the "used" properties into the various reasons that space is used. Specifically, \fBused\fR = \fBusedbychildren\fR + \fBusedbydataset\fR + \fBusedbyrefreservation\fR +, \fBusedbysnapshots\fR. These properties are only available for datasets created on zpool "version 13" pools.
448The \fBusedby*\fR properties decompose the \fBused\fR properties into the various reasons that space is used. Specifically, \fBused\fR = \fBusedbychildren\fR + \fBusedbydataset\fR + \fBusedbyrefreservation\fR +, \fBusedbysnapshots\fR. These properties are only available for datasets created on \fBzpool\fR "version 13" pools.
429.RE
430
431.sp
432.ne 2
433.mk
434.na
449.RE
450
451.sp
452.ne 2
453.mk
454.na
435\fBusedbychildren\fR
455\fB\fBusedbychildren\fR\fR
436.ad
437.sp .6
438.RS 4n
439The amount of space used by children of this dataset, which would be freed if all the dataset's children were destroyed.
440.RE
441
442.sp
443.ne 2
444.mk
445.na
456.ad
457.sp .6
458.RS 4n
459The amount of space used by children of this dataset, which would be freed if all the dataset's children were destroyed.
460.RE
461
462.sp
463.ne 2
464.mk
465.na
446\fBusedbydataset\fR
466\fB\fBusedbydataset\fR\fR
447.ad
448.sp .6
449.RS 4n
450The amount of space used by this dataset itself, which would be freed if the dataset were destroyed (after first removing any \fBrefreservation\fR and destroying any necessary snapshots or descendents).
451.RE
452
453.sp
454.ne 2
455.mk
456.na
467.ad
468.sp .6
469.RS 4n
470The amount of space used by this dataset itself, which would be freed if the dataset were destroyed (after first removing any \fBrefreservation\fR and destroying any necessary snapshots or descendents).
471.RE
472
473.sp
474.ne 2
475.mk
476.na
457\fBusedbyrefreservation\fR
477\fB\fBusedbyrefreservation\fR\fR
458.ad
459.sp .6
460.RS 4n
461The amount of space used by a \fBrefreservation\fR set on this dataset, which would be freed if the \fBrefreservation\fR was removed.
462.RE
463
464.sp
465.ne 2
466.mk
467.na
478.ad
479.sp .6
480.RS 4n
481The amount of space used by a \fBrefreservation\fR set on this dataset, which would be freed if the \fBrefreservation\fR was removed.
482.RE
483
484.sp
485.ne 2
486.mk
487.na
468\fBusedbysnapshots\fR
488\fB\fBusedbysnapshots\fR\fR
469.ad
470.sp .6
471.RS 4n
489.ad
490.sp .6
491.RS 4n
472The 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' "used" properties because space can be shared by multiple snapshots
492The 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' \fBused\fR properties because space can be shared by multiple snapshots
473.RE
474
475.sp
476.ne 2
477.mk
478.na
493.RE
494
495.sp
496.ne 2
497.mk
498.na
479\fBvolblocksize=\fIblocksize\fR\fR
499\fB\fBuserused@\fR\fIuser\fR\fR
480.ad
481.sp .6
482.RS 4n
500.ad
501.sp .6
502.RS 4n
503The amount of space referenced in this dataset by the specified user. Space is charged to the owner of each file, as displayed by \fBls\fR \fB-l\fR. The amount of space charged is displayed by \fBdu\fR and \fBls\fR \fB-s\fR. See the \fBzfs userspace\fR subcommand for more information.
504.sp
505Unprivileged users can access only their own space usage. The root user, or a user who has been granted the \fBuserused\fR privilege with \fBzfs allow\fR, can access everyone's usage.
506.sp
507This property cannot be set on volumes, or on pools before version 15. The \fBuserused@\fR... properties are not displayed by \fBzfs get all\fR. The user's name must be appended after the \fB@\fR symbol, using one of the following forms:
508.RS +4
509.TP
510.ie t \(bu
511.el o
512\fIposix name\fR (for example, \fBjoe\fR)
513.RE
514.RS +4
515.TP
516.ie t \(bu
517.el o
518\fIposix numeric id\fR (for example, \fB789\fR)
519.RE
520.RS +4
521.TP
522.ie t \(bu
523.el o
524\fIsid name\fR (for example, \fBjoe.smith@mydomain\fR)
525.RE
526.RS +4
527.TP
528.ie t \(bu
529.el o
530\fIsid numeric id\fR (for example, \fBS-1-123-456-789\fR)
531.RE
532.RE
533
534.sp
535.ne 2
536.mk
537.na
538\fB\fBgroupused@\fR\fIgroup\fR\fR
539.ad
540.sp .6
541.RS 4n
542The amount of space referenced in this dataset by the specified group. Space is charged to the group of each file, as displayed by \fBls\fR \fB-l\fR. See the \fBuserused@\fR\fIuser\fR property for more information.
543.sp
544Unprivileged users can only access the \fBgroupused@\fR... property for groups that they are a member of. The root user, or a user who has been granted the \fBgroupused\fR privilege with \fBzfs allow\fR, can access all groups' usage.
545.RE
546
547.sp
548.ne 2
549.mk
550.na
551\fB\fBvolblocksize\fR=\fIblocksize\fR\fR
552.ad
553.sp .6
554.RS 4n
483For volumes, specifies the block size of the volume. The \fBblocksize\fR cannot be changed once the volume has been written, so it should be set at volume creation time. The default \fBblocksize\fR for volumes is 8 Kbytes. Any power of 2 from 512 bytes to 128 Kbytes is valid.
484.sp
555For volumes, specifies the block size of the volume. The \fBblocksize\fR cannot be changed once the volume has been written, so it should be set at volume creation time. The default \fBblocksize\fR for volumes is 8 Kbytes. Any power of 2 from 512 bytes to 128 Kbytes is valid.
556.sp
485This property can also be referred to by its shortened column name, "volblock".
557This property can also be referred to by its shortened column name, \fBvolblock\fR.
486.RE
487
488.sp
489.LP
490The following native properties can be used to change the behavior of a \fBZFS\fR dataset.
491.sp
492.ne 2
493.mk
494.na
558.RE
559
560.sp
561.LP
562The following native properties can be used to change the behavior of a \fBZFS\fR dataset.
563.sp
564.ne 2
565.mk
566.na
495\fBaclinherit=\fBdiscard\fR | \fBnoallow\fR | \fBrestricted\fR | \fBpassthrough\fR | \fBpassthrough-x\fR\fR
567\fB\fBaclinherit\fR=\fBdiscard\fR | \fBnoallow\fR | \fBrestricted\fR | \fBpassthrough\fR | \fBpassthrough-x\fR\fR
496.ad
497.sp .6
498.RS 4n
568.ad
569.sp .6
570.RS 4n
499Controls how \fBACL\fR entries are inherited when files and directories are created. A file system with an "aclinherit" property of "\fBdiscard\fR" does not inherit any \fBACL\fR entries. A file system with an "aclinherit" property value of "\fBnoallow\fR" only inherits inheritable \fBACL\fR entries that specify "deny" permissions. The property value "\fBrestricted\fR" (the default) removes the "\fBwrite_acl\fR" and "\fBwrite_owner\fR" permissions when the \fBACL\fR entry is inherited. A file system with an "aclinherit" property value of "\fBpassthrough\fR" inherits all inheritable \fBACL\fR entries without any modifications made to the \fBACL\fR entries when they are inherited. A file system with an "aclinherit" property value of "\fBpassthrough-x\fR" has the same meaning as "\fBpassthrough\fR", except that the \fBowner@\fR, \fBgroup@\fR, and \fBeveryone@\fR \fBACE\fRs inherit the execute permission only if the file creation mode also requests the execute bit.
571Controls how \fBACL\fR entries are inherited when files and directories are created. A file system with an \fBaclinherit\fR property of \fBdiscard\fR does not inherit any \fBACL\fR entries. A file system with an \fBaclinherit\fR property value of \fBnoallow\fR only inherits inheritable \fBACL\fR entries that specify "deny" permissions. The property value \fBrestricted\fR (the default) removes the \fBwrite_acl\fR and \fBwrite_owner\fR permissions when the \fBACL\fR entry is inherited. A file system with an \fBaclinherit\fR property value of \fBpassthrough\fR inherits all inheritable \fBACL\fR entries without any modifications made to the \fBACL\fR entries when they are inherited. A file system with an \fBaclinherit\fR property value of \fBpassthrough-x\fR has the same meaning as \fBpassthrough\fR, except that the \fBowner@\fR, \fBgroup@\fR, and \fBeveryone@\fR \fBACE\fRs inherit the execute permission only if the file creation mode also requests the execute bit.
500.sp
572.sp
501When the property value is set to "\fBpassthrough\fR," files are created with a mode determined by the inheritable \fBACE\fRs. If no inheritable \fBACE\fRs exist that affect the mode, then the mode is set in accordance to the requested mode from the application.
573When the property value is set to \fBpassthrough\fR, files are created with a mode determined by the inheritable \fBACE\fRs. If no inheritable \fBACE\fRs exist that affect the mode, then the mode is set in accordance to the requested mode from the application.
502.RE
503
504.sp
505.ne 2
506.mk
507.na
574.RE
575
576.sp
577.ne 2
578.mk
579.na
508\fBaclmode=\fBdiscard\fR | \fBgroupmask\fR | \fBpassthrough\fR\fR
580\fB\fBaclmode\fR=\fBdiscard\fR | \fBgroupmask\fR | \fBpassthrough\fR\fR
509.ad
510.sp .6
511.RS 4n
581.ad
582.sp .6
583.RS 4n
512Controls how an \fBACL\fR is modified during \fBchmod\fR(2). A file system with an "aclmode" property of "\fBdiscard\fR" deletes all \fBACL\fR entries that do not represent the mode of the file. An "aclmode" property of "\fBgroupmask\fR" (the default) reduces user or group permissions. The permissions are reduced, such that they are no greater than the group permission bits, unless it is a user entry that has the same \fBUID\fR as the owner of the file or directory. In this case, the \fBACL\fR permissions are reduced so that they are no greater than owner permission bits. A file system with an "aclmode" property of "\fBpassthrough\fR" indicates that no changes are made to the \fBACL\fR other than generating the necessary \fBACL\fR entries to represent the new mode of the file or directory.
584Controls how an \fBACL\fR is modified during \fBchmod\fR(2). A file system with an \fBaclmode\fR property of \fBdiscard\fR deletes all \fBACL\fR entries that do not represent the mode of the file. An \fBaclmode\fR property of \fBgroupmask\fR (the default) reduces user or group permissions. The permissions are reduced, such that they are no greater than the group permission bits, unless it is a user entry that has the same \fBUID\fR as the owner of the file or directory. In this case, the \fBACL\fR permissions are reduced so that they are no greater than owner permission bits. A file system with an \fBaclmode\fR property of \fBpassthrough\fR indicates that no changes are made to the \fBACL\fR other than generating the necessary \fBACL\fR entries to represent the new mode of the file or directory.
513.RE
514
515.sp
516.ne 2
517.mk
518.na
585.RE
586
587.sp
588.ne 2
589.mk
590.na
519\fBatime=\fIon\fR | \fIoff\fR\fR
591\fB\fBatime\fR=\fBon\fR | \fBoff\fR\fR
520.ad
521.sp .6
522.RS 4n
592.ad
593.sp .6
594.RS 4n
523Controls 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 "on".
595Controls 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 \fBon\fR.
524.RE
525
526.sp
527.ne 2
528.mk
529.na
596.RE
597
598.sp
599.ne 2
600.mk
601.na
530\fBcanmount=\fBon\fR | \fBoff\fR | \fBnoauto\fR\fR
602\fB\fBcanmount\fR=\fBon\fR | \fBoff\fR | \fBnoauto\fR\fR
531.ad
532.sp .6
533.RS 4n
603.ad
604.sp .6
605.RS 4n
534If this property is set to "\fBoff\fR", the file system cannot be mounted, and is ignored by "\fBzfs mount -a\fR". Setting this property to "\fBoff\fR" is similar to setting the "mountpoint" property to "\fBnone\fR", except that the dataset still has a normal "mountpoint" property, which can be inherited. Setting this property to "\fBoff\fR" allows datasets to be used solely as a mechanism to inherit properties. One example of setting canmount=\fBoff\fR is to have two datasets with the same mountpoint, so that the children of both datasets appear in the same directory, but might have different inherited characteristics.
606If this property is set to \fBoff\fR, the file system cannot be mounted, and is ignored by \fBzfs mount -a\fR. Setting this property to \fBoff\fR is similar to setting the \fBmountpoint\fR property to \fBnone\fR, except that the dataset still has a normal \fBmountpoint\fR property, which can be inherited. Setting this property to \fBoff\fR allows datasets to be used solely as a mechanism to inherit properties. One example of setting \fBcanmount=\fR\fBoff\fR is to have two datasets with the same \fBmountpoint\fR, so that the children of both datasets appear in the same directory, but might have different inherited characteristics.
535.sp
607.sp
536When the "\fBnoauto\fR" option is set, 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 "\fBzfs mount -a\fR" command or unmounted by the "\fBzfs unmount -a\fR" command.
608When the \fBnoauto\fR option is set, 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 \fBzfs mount -a\fR command or unmounted by the \fBzfs unmount -a\fR command.
537.sp
538This property is not inherited.
539.RE
540
541.sp
542.ne 2
543.mk
544.na
609.sp
610This property is not inherited.
611.RE
612
613.sp
614.ne 2
615.mk
616.na
545\fBchecksum=\fIon\fR | \fIoff\fR | \fIfletcher2\fR, | \fIfletcher4\fR | \fIsha256\fR\fR
617\fB\fBchecksum\fR=\fBon\fR | \fBoff\fR | \fBfletcher2,\fR| \fBfletcher4\fR | \fBsha256\fR\fR
546.ad
547.sp .6
548.RS 4n
618.ad
619.sp .6
620.RS 4n
549Controls the checksum used to verify data integrity. The default value is "on", which automatically selects an appropriate algorithm (currently, \fIfletcher2\fR, but this may change in future releases). The value "off" disables integrity checking on user data. Disabling checksums is NOT a recommended practice.
621Controls the checksum used to verify data integrity. The default value is \fBon\fR, which automatically selects an appropriate algorithm (currently, \fBfletcher2\fR, but this may change in future releases). The value \fBoff\fR disables integrity checking on user data. Disabling checksums is \fBNOT\fR a recommended practice.
550.RE
551
552.sp
553.ne 2
554.mk
555.na
622.RE
623
624.sp
625.ne 2
626.mk
627.na
556\fBcompression=\fIon\fR | \fIoff\fR | \fIlzjb\fR | \fIgzip\fR | \fIgzip-N\fR\fR
628\fB\fBcompression\fR=\fBon\fR | \fBoff\fR | \fBlzjb\fR | \fBgzip\fR | \fBgzip-\fR\fIN\fR\fR
557.ad
558.sp .6
559.RS 4n
629.ad
630.sp .6
631.RS 4n
560Controls the compression algorithm used for this dataset. The "lzjb" compression algorithm is optimized for performance while providing decent data compression. Setting compression to "on" uses the "lzjb" compression algorithm. The "gzip" compression algorithm uses the same compression as the \fBgzip\fR(1) command. You can specify the "gzip" level by using the value "gzip-\fIN\fR" where \fIN\fR is an integer from 1 (fastest) to 9 (best compression ratio). Currently, "gzip" is equivalent to "gzip-6" (which is also the default for \fBgzip\fR(1)).
632Controls the compression algorithm used for this dataset. The \fBlzjb\fR compression algorithm is optimized for performance while providing decent data compression. Setting compression to "on" uses the "lzjb" compression algorithm. The "gzip" compression algorithm uses the same compression as the \fBgzip\fR(1) command. You can specify the "gzip" level by using the value "gzip-\fIN\fR" where \fIN\fR is an integer from 1 (fastest) to 9 (best compression ratio). Currently, "gzip" is equivalent to "gzip-6" (which is also the default for \fBgzip\fR(1)).
561.sp
562This property can also be referred to by its shortened column name "compress".
563.RE
564
565.sp
566.ne 2
567.mk
568.na
569\fBcopies=\fB1\fR | \fB2\fR | \fB3\fR\fR
570.ad
571.sp .6
572.RS 4n
633.sp
634This property can also be referred to by its shortened column name "compress".
635.RE
636
637.sp
638.ne 2
639.mk
640.na
641\fBcopies=\fB1\fR | \fB2\fR | \fB3\fR\fR
642.ad
643.sp .6
644.RS 4n
573Controls 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 "used" property and counting against quotas and reservations.
645Controls 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 \fBraid-z\fR. 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 \fBused\fR property and counting against quotas and reservations.
574.sp
646.sp
575Changing this property only affects newly-written data. Therefore, set this property at file system creation time by using the "\fB-o\fR copies=" option.
647Changing this property only affects newly-written data. Therefore, set this property at file system creation time by using the \fB-o\fR \fBcopies=\fR option.
576.RE
577
578.sp
579.ne 2
580.mk
581.na
648.RE
649
650.sp
651.ne 2
652.mk
653.na
582\fBdevices=\fIon\fR | \fIoff\fR\fR
654\fB\fBdevices\fR=\fBon\fR | \fBoff\fR\fR
583.ad
584.sp .6
585.RS 4n
655.ad
656.sp .6
657.RS 4n
586Controls whether device nodes can be opened on this file system. The default value is "on".
658Controls whether device nodes can be opened on this file system. The default value is \fBon\fR.
587.RE
588
589.sp
590.ne 2
591.mk
592.na
659.RE
660
661.sp
662.ne 2
663.mk
664.na
593\fBexec=\fIon\fR | \fIoff\fR\fR
665\fB\fBexec\fR=\fBon\fR | \fBoff\fR\fR
594.ad
595.sp .6
596.RS 4n
666.ad
667.sp .6
668.RS 4n
597Controls whether processes can be executed from within this file system. The default value is "on".
669Controls whether processes can be executed from within this file system. The default value is \fBon\fR.
598.RE
599
600.sp
601.ne 2
602.mk
603.na
670.RE
671
672.sp
673.ne 2
674.mk
675.na
604\fBmountpoint=\fIpath\fR | \fInone\fR | \fIlegacy\fR\fR
676\fB\fBmountpoint\fR=\fIpath\fR | \fBnone\fR | \fBlegacy\fR\fR
605.ad
606.sp .6
607.RS 4n
608Controls the mount point used for this file system. See the "Mount Points" section for more information on how this property is used.
609.sp
677.ad
678.sp .6
679.RS 4n
680Controls the mount point used for this file system. See the "Mount Points" section for more information on how this property is used.
681.sp
610When the mountpoint 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 "legacy", then they remain unmounted. Otherwise, they are automatically remounted in the new location if the property was previously "legacy" or "none", or if they were mounted before the property was changed. In addition, any shared file systems are unshared and shared in the new location.
682When the \fBmountpoint\fR 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 \fBlegacy\fR, then they remain unmounted. Otherwise, they are automatically remounted in the new location if the property was previously \fBlegacy\fR or \fBnone\fR, or if they were mounted before the property was changed. In addition, any shared file systems are unshared and shared in the new location.
611.RE
612
613.sp
614.ne 2
615.mk
616.na
683.RE
684
685.sp
686.ne 2
687.mk
688.na
617\fBnbmand=\fIon\fR | \fIoff\fR\fR
689\fB\fBnbmand\fR=\fBon\fR | \fBoff\fR\fR
618.ad
619.sp .6
620.RS 4n
690.ad
691.sp .6
692.RS 4n
621Controls whether the file system should be mounted with "\fBnbmand\fR" (Non Blocking mandatory locks). This is used for \fBCIFS\fR clients. Changes to this property only take effect when the file system is umounted and remounted. See \fBmount\fR(1M) for more information on "\fBnbmand\fR" mounts.
693Controls whether the file system should be mounted with \fBnbmand\fR (Non Blocking mandatory locks). This is used for \fBCIFS\fR clients. Changes to this property only take effect when the file system is umounted and remounted. See \fBmount\fR(1M) for more information on \fBnbmand\fR mounts.
622.RE
623
624.sp
625.ne 2
626.mk
627.na
694.RE
695
696.sp
697.ne 2
698.mk
699.na
628\fBprimarycache=\fIall\fR | \fInone\fR | \fImetadata\fR\fR
700\fB\fBprimarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR
629.ad
630.sp .6
631.RS 4n
701.ad
702.sp .6
703.RS 4n
632Controls what is cached in the primary cache (ARC). If this property is set to "all", then both user data and metadata is cached. If this property is set to "none", then neither user data nor metadata is cached. If this property is set to "metadata", then only metadata is cached. The default value is "all".
704Controls what is cached in the primary cache (ARC). If this property is set to \fBall\fR, then both user data and metadata is cached. If this property is set to \fBnone\fR, then neither user data nor metadata is cached. If this property is set to \fBmetadata\fR, then only metadata is cached. The default value is \fBall\fR.
633.RE
634
635.sp
636.ne 2
637.mk
638.na
705.RE
706
707.sp
708.ne 2
709.mk
710.na
639\fBquota=\fIsize\fR | \fInone\fR\fR
711\fB\fBquota\fR=\fIsize\fR | \fBnone\fR\fR
640.ad
641.sp .6
642.RS 4n
643Limits 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.
644.sp
712.ad
713.sp .6
714.RS 4n
715Limits 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.
716.sp
645Quotas cannot be set on volumes, as the "volsize" property acts as an implicit quota.
717Quotas cannot be set on volumes, as the \fBvolsize\fR property acts as an implicit quota.
646.RE
647
648.sp
649.ne 2
650.mk
651.na
718.RE
719
720.sp
721.ne 2
722.mk
723.na
652\fBreadonly=\fIon\fR | \fIoff\fR\fR
724\fB\fBuserquota@\fR\fIuser\fR=\fIsize\fR | \fBnone\fR\fR
653.ad
654.sp .6
655.RS 4n
725.ad
726.sp .6
727.RS 4n
656Controls whether this dataset can be modified. The default value is "off".
728Limits the amount of space referenced by the specified user, which is specified by the \fBuserspace@\fR\fIuser\fR property.
657.sp
729.sp
658This property can also be referred to by its shortened column name, "rdonly".
730Enforcement of user quotas may be delayed by several seconds. In other words, users may go a bit over their quota before the system notices that they are over quota and begins to refuse additional writes with \fBEDQUOT\fR. See the \fBzfs userspace\fR subcommand for more information.
731.sp
732Unprivileged users can get only their own quota. The root user, or a user who has been granted the \fBuserquota\fR privilege with \fBzfs allow\fR, can get and set everyone's quota.
733.sp
734This property cannot be set on volumes, on filesystems before version 4, or on pools before version 15. The \fBuserquota@\fR... properties are not displayed by \fBzfs get all\fR. The user's name must be appended after the \fB@\fR symbol, using one of the following forms:
735.RS +4
736.TP
737.ie t \(bu
738.el o
739\fIposix name\fR (for example, \fBjoe\fR)
659.RE
740.RE
741.RS +4
742.TP
743.ie t \(bu
744.el o
745\fIposix numeric id\fR (for example, \fB789\fR)
746.RE
747.RS +4
748.TP
749.ie t \(bu
750.el o
751\fIsid name\fR (for example, \fBjoe.smith@mydomain\fR)
752.RE
753.RS +4
754.TP
755.ie t \(bu
756.el o
757\fIsid numeric id\fR (for example, \fBS-1-123-456-789\fR)
758.RE
759.RE
660
661.sp
662.ne 2
663.mk
664.na
760
761.sp
762.ne 2
763.mk
764.na
665\fBrecordsize=\fIsize\fR\fR
765\fB\fBgroupquota@\fR\fIgroup\fR=\fIsize\fR | \fBnone\fR\fR
666.ad
667.sp .6
668.RS 4n
766.ad
767.sp .6
768.RS 4n
769Limits the amount of space referenced by the specified group. See the \fBuserquota@\fR\fIuser\fR property for more information.
770.sp
771Unprivileged users can only get the quota of groups they are a member of. The root user, or a user who has been granted the \fBgroupquota\fR privilege with \fBzfs allow\fR, can get and set all groups' quotas.
772.RE
773
774.sp
775.ne 2
776.mk
777.na
778\fB\fBreadonly\fR=\fBon\fR | \fBoff\fR\fR
779.ad
780.sp .6
781.RS 4n
782Controls whether this dataset can be modified. The default value is \fBoff\fR.
783.sp
784This property can also be referred to by its shortened column name, \fBrdonly\fR.
785.RE
786
787.sp
788.ne 2
789.mk
790.na
791\fB\fBrecordsize\fR=\fIsize\fR\fR
792.ad
793.sp .6
794.RS 4n
669Specifies 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. \fBZFS\fR automatically tunes block sizes according to internal algorithms optimized for typical access patterns.
670.sp
795Specifies 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. \fBZFS\fR automatically tunes block sizes according to internal algorithms optimized for typical access patterns.
796.sp
671For databases that create very large files but access them in small random chunks, these algorithms may be suboptimal. Specifying a "recordsize" 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.
797For databases that create very large files but access them in small random chunks, these algorithms may be suboptimal. Specifying a \fBrecordsize\fR 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.
672.sp
673The size specified must be a power of two greater than or equal to 512 and less than or equal to 128 Kbytes.
674.sp
798.sp
799The size specified must be a power of two greater than or equal to 512 and less than or equal to 128 Kbytes.
800.sp
675Changing the file system's \fBrecordsize\fR only affects files created afterward; existing files are unaffected.
801Changing the file system's \fBrecordsize\fR affects only files created afterward; existing files are unaffected.
676.sp
802.sp
677This property can also be referred to by its shortened column name, "recsize".
803This property can also be referred to by its shortened column name, \fBrecsize\fR.
678.RE
679
680.sp
681.ne 2
682.mk
683.na
804.RE
805
806.sp
807.ne 2
808.mk
809.na
684\fBrefquota=\fIsize\fR | \fInone\fR\fR
810\fB\fBrefquota\fR=\fIsize\fR | \fBnone\fR\fR
685.ad
686.sp .6
687.RS 4n
688Limits 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.
689.RE
690
691.sp
692.ne 2
693.mk
694.na
811.ad
812.sp .6
813.RS 4n
814Limits 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.
815.RE
816
817.sp
818.ne 2
819.mk
820.na
695\fBrefreservation=\fIsize\fR | \fInone\fR\fR
821\fB\fBrefreservation\fR=\fIsize\fR | \fBnone\fR\fR
696.ad
697.sp .6
698.RS 4n
699The 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 \fBrefreservation\fR. The \fBrefreservation\fR reservation is accounted for in the parent datasets' space used, and counts against the parent datasets' quotas and reservations.
700.sp
701If \fBrefreservation\fR 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.
702.sp
822.ad
823.sp .6
824.RS 4n
825The 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 \fBrefreservation\fR. The \fBrefreservation\fR reservation is accounted for in the parent datasets' space used, and counts against the parent datasets' quotas and reservations.
826.sp
827If \fBrefreservation\fR 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.
828.sp
703This property can also be referred to by its shortened column name, "refreserv".
829This property can also be referred to by its shortened column name, \fBrefreserv\fR.
704.RE
705
706.sp
707.ne 2
708.mk
709.na
830.RE
831
832.sp
833.ne 2
834.mk
835.na
710\fBreservation=\fIsize\fR | \fInone\fR\fR
836\fB\fBreservation\fR=\fIsize\fR | \fBnone\fR\fR
711.ad
712.sp .6
713.RS 4n
714The minimum amount of space guaranteed to a dataset and 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 its reservation. Reservations are accounted for in the parent datasets' space used, and count against the parent datasets' quotas and reservations.
715.sp
837.ad
838.sp .6
839.RS 4n
840The minimum amount of space guaranteed to a dataset and 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 its reservation. Reservations are accounted for in the parent datasets' space used, and count against the parent datasets' quotas and reservations.
841.sp
716This property can also be referred to by its shortened column name, "reserv".
842This property can also be referred to by its shortened column name, \fBreserv\fR.
717.RE
718
719.sp
720.ne 2
721.mk
722.na
843.RE
844
845.sp
846.ne 2
847.mk
848.na
723\fBsecondarycache=\fIall\fR | \fInone\fR | \fImetadata\fR\fR
849\fB\fBsecondarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR
724.ad
725.sp .6
726.RS 4n
850.ad
851.sp .6
852.RS 4n
727Controls what is cached in the secondary cache (L2ARC). If this property is set to "all", then both user data and metadata is cached. If this property is set to "none", then neither user data nor metadata is cached. If this property is set to "metadata", then only metadata is cached. The default value is "all".
853Controls what is cached in the secondary cache (L2ARC). If this property is set to \fBall\fR, then both user data and metadata is cached. If this property is set to \fBnone\fR, then neither user data nor metadata is cached. If this property is set to \fBmetadata\fR, then only metadata is cached. The default value is \fBall\fR.
728.RE
729
730.sp
731.ne 2
732.mk
733.na
854.RE
855
856.sp
857.ne 2
858.mk
859.na
734\fBsetuid=\fIon\fR | \fIoff\fR\fR
860\fB\fBsetuid\fR=\fBon\fR | \fBoff\fR\fR
735.ad
736.sp .6
737.RS 4n
861.ad
862.sp .6
863.RS 4n
738Controls whether the set-\fBUID\fR bit is respected for the file system. The default value is "on".
864Controls whether the set-\fBUID\fR bit is respected for the file system. The default value is \fBon\fR.
739.RE
740
741.sp
742.ne 2
743.mk
744.na
865.RE
866
867.sp
868.ne 2
869.mk
870.na
745\fBshareiscsi=\fIon\fR | \fIoff\fR\fR
871\fB\fBshareiscsi\fR=\fBon\fR | \fBoff\fR\fR
746.ad
747.sp .6
748.RS 4n
872.ad
873.sp .6
874.RS 4n
749Like the "sharenfs" property, "shareiscsi" indicates whether a \fBZFS\fR volume is exported as an \fBiSCSI\fR target. The acceptable values for this property are "on", "off", and "type=disk". The default value is "off". In the future, other target types might be supported. For example, "tape".
875Like the \fBsharenfs\fR property, \fBshareiscsi\fR indicates whether a \fBZFS\fR volume is exported as an \fBiSCSI\fR target. The acceptable values for this property are \fBon\fR, \fBoff\fR, and \fBtype=disk\fR. The default value is \fBoff\fR. In the future, other target types might be supported. For example, \fBtape\fR.
750.sp
876.sp
751You might want to set "shareiscsi=on" for a file system so that all \fBZFS\fR volumes within the file system are shared by default. Setting this property on a file system has no direct effect, however.
877You might want to set \fBshareiscsi=on\fR for a file system so that all \fBZFS\fR volumes within the file system are shared by default. However, setting this property on a file system has no direct effect.
752.RE
753
754.sp
755.ne 2
756.mk
757.na
878.RE
879
880.sp
881.ne 2
882.mk
883.na
758\fBsharesmb=\fIon\fR | \fIoff\fR | \fIopts\fR\fR
884\fB\fBsharesmb\fR=\fBon\fR | \fBoff\fR | \fIopts\fR\fR
759.ad
760.sp .6
761.RS 4n
885.ad
886.sp .6
887.RS 4n
762Controls whether the file system is shared by using the Solaris \fBCIFS\fR service, and what options are to be used. A file system with the "\fBsharesmb\fR" property set to "off" is managed through traditional tools such as \fBsharemgr\fR(1M). Otherwise, the file system is automatically shared and unshared with the \fBzfs share\fR and \fBzfs unshare\fR commands. If the property is set to \fBon\fR, the \fBsharemgr\fR(1M) command is invoked with no options. Otherwise, the \fBsharemgr\fR(1M) command is invoked with options equivalent to the contents of this property.
888Controls whether the file system is shared by using the Solaris \fBCIFS\fR service, and what options are to be used. A file system with the \fBsharesmb\fR property set to \fBoff\fR is managed through traditional tools such as \fBsharemgr\fR(1M). Otherwise, the file system is automatically shared and unshared with the \fBzfs share\fR and \fBzfs unshare\fR commands. If the property is set to \fBon\fR, the \fBsharemgr\fR(1M) command is invoked with no options. Otherwise, the \fBsharemgr\fR(1M) command is invoked with options equivalent to the contents of this property.
763.sp
764Because \fBSMB\fR 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 illegal in the resource name, are replaced with underscore (\fB_\fR) 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 \fBdata/home/john\fR is set to \fBname=john\fR, then \fBdata/home/john\fR has a resource name of \fBjohn\fR. If a child dataset of \fBdata/home/john/backups\fR, it has a resource name of \fBjohn_backups\fR.
765.sp
766When SMB shares are created, the SMB share name appears as an entry in the \fB\&.zfs/shares\fR directory. You can use the \fBls\fR or \fBchmod\fR command to display the share-level ACLs on the entries in this directory.
767.sp
768When the \fBsharesmb\fR 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 \fBoff\fR, or if they were shared before the property was changed. If the new property is set to \fBoff\fR, the file systems are unshared.
769.RE
770
771.sp
772.ne 2
773.mk
774.na
889.sp
890Because \fBSMB\fR 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 illegal in the resource name, are replaced with underscore (\fB_\fR) 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 \fBdata/home/john\fR is set to \fBname=john\fR, then \fBdata/home/john\fR has a resource name of \fBjohn\fR. If a child dataset of \fBdata/home/john/backups\fR, it has a resource name of \fBjohn_backups\fR.
891.sp
892When SMB shares are created, the SMB share name appears as an entry in the \fB\&.zfs/shares\fR directory. You can use the \fBls\fR or \fBchmod\fR command to display the share-level ACLs on the entries in this directory.
893.sp
894When the \fBsharesmb\fR 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 \fBoff\fR, or if they were shared before the property was changed. If the new property is set to \fBoff\fR, the file systems are unshared.
895.RE
896
897.sp
898.ne 2
899.mk
900.na
775\fBsharenfs=\fIon\fR | \fIoff\fR | \fIopts\fR\fR
901\fB\fBsharenfs\fR=\fBon\fR | \fBoff\fR | \fIopts\fR\fR
776.ad
777.sp .6
778.RS 4n
902.ad
903.sp .6
904.RS 4n
779Controls whether the file system is shared via \fBNFS\fR, and what options are used. A file system with a"\fBsharenfs\fR" property of "off" is managed through traditional tools such as \fBshare\fR(1M), \fBunshare\fR(1M), and \fBdfstab\fR(4). Otherwise, the file system is automatically shared and unshared with the "\fBzfs share\fR" and "\fBzfs unshare\fR" commands. If the property is set to "on", the \fBshare\fR(1M) command is invoked with no options. Otherwise, the \fBshare\fR(1M) command is invoked with options equivalent to the contents of this property.
905Controls whether the file system is shared via \fBNFS\fR, and what options are used. A file system with a \fBsharenfs\fR property of \fBoff\fR is managed through traditional tools such as \fBshare\fR(1M), \fBunshare\fR(1M), and \fBdfstab\fR(4). Otherwise, the file system is automatically shared and unshared with the \fBzfs share\fR and \fBzfs unshare\fR commands. If the property is set to \fBon\fR, the \fBshare\fR(1M) command is invoked with no options. Otherwise, the \fBshare\fR(1M) command is invoked with options equivalent to the contents of this property.
780.sp
906.sp
781When the "sharenfs" 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 "off", or if they were shared before the property was changed. If the new property is "off", the file systems are unshared.
907When the \fBsharenfs\fR 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 "off", or if they were shared before the property was changed. If the new property is \fBoff\fR, the file systems are unshared.
782.RE
783
784.sp
785.ne 2
786.mk
787.na
908.RE
909
910.sp
911.ne 2
912.mk
913.na
788\fBsnapdir=\fIhidden\fR | \fIvisible\fR\fR
914\fB\fBsnapdir\fR=\fBhidden\fR | \fBvisible\fR\fR
789.ad
790.sp .6
791.RS 4n
915.ad
916.sp .6
917.RS 4n
792Controls whether the ".zfs" directory is hidden or visible in the root of the file system as discussed in the "Snapshots" section. The default value is "hidden".
918Controls whether the \fB\&.zfs\fR directory is hidden or visible in the root of the file system as discussed in the "Snapshots" section. The default value is \fBhidden\fR.
793.RE
794
795.sp
796.ne 2
797.mk
798.na
919.RE
920
921.sp
922.ne 2
923.mk
924.na
799\fBversion=\fB1\fR|\fB2\fR|\fBcurrent\fR\fR
925\fB\fBversion\fR=\fB1\fR | \fB2\fR | \fBcurrent\fR\fR
800.ad
801.sp .6
802.RS 4n
926.ad
927.sp .6
928.RS 4n
803The 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 "\fBzfs upgrade\fR".
929The 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 \fBzfs upgrade\fR command.
804.RE
805
806.sp
807.ne 2
808.mk
809.na
930.RE
931
932.sp
933.ne 2
934.mk
935.na
810\fBvolsize=\fIsize\fR\fR
936\fB\fBvolsize\fR=\fIsize\fR\fR
811.ad
812.sp .6
813.RS 4n
814For 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 \fBrefreservation\fR is set instead. Any changes to \fBvolsize\fR are reflected in an equivalent change to the reservation (or \fBrefreservation\fR). The \fBvolsize\fR can only be set to a multiple of \fBvolblocksize\fR, and cannot be zero.
815.sp
816The 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.
817.sp
937.ad
938.sp .6
939.RS 4n
940For 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 \fBrefreservation\fR is set instead. Any changes to \fBvolsize\fR are reflected in an equivalent change to the reservation (or \fBrefreservation\fR). The \fBvolsize\fR can only be set to a multiple of \fBvolblocksize\fR, and cannot be zero.
941.sp
942The 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.
943.sp
818Though not recommended, a "sparse volume" (also known as "thin provisioning") can be created by specifying the \fB-s\fR option to the "\fBzfs create -V\fR" command, or by changing the reservation after the volume has been created. A "sparse volume" is a volume where the reservation is less then the volume size. Consequently, writes to a sparse volume can fail with \fBENOSPC\fR when the pool is low on space. For a sparse volume, changes to \fBvolsize\fR are not reflected in the reservation.
944Though not recommended, a "sparse volume" (also known as "thin provisioning") can be created by specifying the \fB-s\fR option to the \fBzfs create -V\fR command, or by changing the reservation after the volume has been created. A "sparse volume" is a volume where the reservation is less then the volume size. Consequently, writes to a sparse volume can fail with \fBENOSPC\fR when the pool is low on space. For a sparse volume, changes to \fBvolsize\fR are not reflected in the reservation.
819.RE
820
821.sp
822.ne 2
823.mk
824.na
945.RE
946
947.sp
948.ne 2
949.mk
950.na
825\fBvscan=\fBon\fR|\fBoff\fR\fR
951\fB\fBvscan\fR=\fBon\fR | \fBoff\fR\fR
826.ad
827.sp .6
828.RS 4n
952.ad
953.sp .6
954.RS 4n
829Controls 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 "off".
955Controls 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 \fBoff\fR.
830.RE
831
832.sp
833.ne 2
834.mk
835.na
836\fBxattr=\fBon\fR | \fBoff\fR\fR
837.ad
838.sp .6
839.RS 4n
956.RE
957
958.sp
959.ne 2
960.mk
961.na
962\fBxattr=\fBon\fR | \fBoff\fR\fR
963.ad
964.sp .6
965.RS 4n
840Controls whether extended attributes are enabled for this file system. The default value is "\fBon\fR".
966Controls whether extended attributes are enabled for this file system. The default value is \fBon\fR.
841.RE
842
843.sp
844.ne 2
845.mk
846.na
967.RE
968
969.sp
970.ne 2
971.mk
972.na
847\fBzoned=\fIon\fR | \fIoff\fR\fR
973\fB\fBzoned\fR=\fBon\fR | \fBoff\fR\fR
848.ad
849.sp .6
850.RS 4n
974.ad
975.sp .6
976.RS 4n
851Controls whether the dataset is managed from a non-global zone. See the "Zones" section for more information. The default value is "off".
977Controls whether the dataset is managed from a non-global zone. See the "Zones" section for more information. The default value is \fBoff\fR.
852.RE
853
854.sp
855.LP
978.RE
979
980.sp
981.LP
856The 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 "\fBzfs create\fR" or "\fBzpool create\fR" 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.
982The 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 \fBzfs create\fR or \fBzpool create\fR 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.
857.sp
858.ne 2
859.mk
860.na
983.sp
984.ne 2
985.mk
986.na
861\fBcasesensitivity = \fBsensitive\fR | \fBinsensitive\fR | \fBmixed\fR\fR
987\fB\fBcasesensitivity\fR=\fBsensitive\fR | \fBinsensitive\fR | \fBmixed\fR\fR
862.ad
863.sp .6
864.RS 4n
988.ad
989.sp .6
990.RS 4n
865Indicates 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 "\fBcasesensitivity\fR" property is "\fBsensitive\fR." Traditionally, UNIX and POSIX file systems have case-sensitive file names.
991Indicates 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 \fBcasesensitivity\fR property is \fBsensitive\fR. Traditionally, UNIX and POSIX file systems have case-sensitive file names.
866.sp
992.sp
867The "\fBmixed\fR" value for the "\fBcasesensitivity\fR" 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 Solaris CIFS server product. For more information about the "mixed" value behavior, see the \fIZFS Administration Guide\fR.
993The \fBmixed\fR value for the \fBcasesensitivity\fR 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 Solaris CIFS server product. For more information about the \fBmixed\fR value behavior, see the \fISolaris ZFS Administration Guide\fR.
868.RE
869
870.sp
871.ne 2
872.mk
873.na
994.RE
995
996.sp
997.ne 2
998.mk
999.na
874\fBnormalization =\fBnone\fR | \fBformD\fR | \fBformKCf\fR\fR
1000\fB\fBnormalization\fR=\fBnone\fR | \fBformD\fR | \fBformKCf\fR\fR
875.ad
876.sp .6
877.RS 4n
1001.ad
1002.sp .6
1003.RS 4n
878Indicates whether the file system should perform a \fBunicode\fR 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 "\fBnone\fR," and the "\fButf8only\fR" property was left unspecified, the "\fButf8only\fR" property is automatically set to "\fBon\fR." The default value of the "\fBnormalization\fR" property is "\fBnone\fR." This property cannot be changed after the file system is created.
1004Indicates whether the file system should perform a \fBunicode\fR 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 \fBnone\fR, and the \fButf8only\fR property was left unspecified, the \fButf8only\fR property is automatically set to \fBon\fR. The default value of the \fBnormalization\fR property is \fBnone\fR. This property cannot be changed after the file system is created.
879.RE
880
881.sp
882.ne 2
883.mk
884.na
1005.RE
1006
1007.sp
1008.ne 2
1009.mk
1010.na
885\fButf8only =\fBon\fR | \fBoff\fR\fR
1011\fB\fButf8only\fR=\fBon\fR | \fBoff\fR\fR
886.ad
887.sp .6
888.RS 4n
1012.ad
1013.sp .6
1014.RS 4n
889Indicates whether the file system should reject file names that include characters that are not present in the \fBUTF-8\fR character code set. If this property is explicitly set to "\fBoff\fR," the normalization property must either not be explicitly set or be set to "\fBnone\fR." The default value for the "\fButf8only\fR" property is "off." This property cannot be changed after the file system is created.
1015Indicates whether the file system should reject file names that include characters that are not present in the \fBUTF-8\fR character code set. If this property is explicitly set to \fBoff\fR, the normalization property must either not be explicitly set or be set to \fBnone\fR. The default value for the \fButf8only\fR property is \fBoff\fR. This property cannot be changed after the file system is created.
890.RE
891
892.sp
893.LP
1016.RE
1017
1018.sp
1019.LP
894The "\fBcasesensitivity\fR," "\fBnormalization\fR," and "\fButf8only\fR" properties are also new permissions that can be assigned to non-privileged users by using the \fBZFS\fR delegated administration feature.
1020The \fBcasesensitivity\fR, \fBnormalization\fR, and \fButf8only\fR properties are also new permissions that can be assigned to non-privileged users by using the \fBZFS\fR delegated administration feature.
895.SS "Temporary Mount Point Properties"
896.sp
897.LP
1021.SS "Temporary Mount Point Properties"
1022.sp
1023.LP
898When a file system is mounted, either through \fBmount\fR(1M) for legacy mounts or the "\fBzfs mount\fR" command for normal file systems, its mount options are set according to its properties. The correlation between properties and mount options is as follows:
1024When a file system is mounted, either through \fBmount\fR(1M) for legacy mounts or the \fBzfs mount\fR command for normal file systems, its mount options are set according to its properties. The correlation between properties and mount options is as follows:
899.sp
900.in +2
901.nf
902 PROPERTY MOUNT OPTION
903 devices devices/nodevices
904 exec exec/noexec
905 readonly ro/rw
906 setuid setuid/nosetuid
907 xattr xattr/noxattr
908.fi
909.in -2
910.sp
911
912.sp
913.LP
1025.sp
1026.in +2
1027.nf
1028 PROPERTY MOUNT OPTION
1029 devices devices/nodevices
1030 exec exec/noexec
1031 readonly ro/rw
1032 setuid setuid/nosetuid
1033 xattr xattr/noxattr
1034.fi
1035.in -2
1036.sp
1037
1038.sp
1039.LP
914In addition, these options can be set on a per-mount basis using the \fB-o\fR 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 \fB-nosuid\fR option is an alias for "nodevices,nosetuid". These properties are reported as "temporary" by the "\fBzfs get\fR" command. If the properties are changed while the dataset is mounted, the new setting overrides any temporary settings.
1040In addition, these options can be set on a per-mount basis using the \fB-o\fR 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 \fB-nosuid\fR option is an alias for \fBnodevices,nosetuid\fR. These properties are reported as "temporary" by the \fBzfs get\fR command. If the properties are changed while the dataset is mounted, the new setting overrides any temporary settings.
915.SS "User Properties"
916.sp
917.LP
918In addition to the standard native properties, \fBZFS\fR supports arbitrary user properties. User properties have no effect on \fBZFS\fR behavior, but applications or administrators can use them to annotate datasets (file systems, volumes, and snapshots).
919.sp
920.LP
1041.SS "User Properties"
1042.sp
1043.LP
1044In addition to the standard native properties, \fBZFS\fR supports arbitrary user properties. User properties have no effect on \fBZFS\fR behavior, but applications or administrators can use them to annotate datasets (file systems, volumes, and snapshots).
1045.sp
1046.LP
921User 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 "\fImodule\fR:\fIproperty\fR", but this namespace is not enforced by \fBZFS\fR. User property names can be at most 256 characters, and cannot begin with a dash ("-").
1047User property names must contain a colon (\fB:\fR) character to distinguish them from native properties. They may contain lowercase letters, numbers, and the following punctuation characters: colon (\fB:\fR), dash (\fB-\fR), period (\fB\&.\fR), and underscore (\fB_\fR). The expected convention is that the property name is divided into two portions such as \fImodule\fR\fB:\fR\fIproperty\fR, but this namespace is not enforced by \fBZFS\fR. User property names can be at most 256 characters, and cannot begin with a dash (\fB-\fR).
922.sp
923.LP
1048.sp
1049.LP
924When making programmatic use of user properties, it is strongly suggested to use a reversed \fBDNS\fR domain name for the \fImodule\fR component of property names to reduce the chance that two independently-developed packages use the same property name for different purposes. Property names beginning with "com.sun." are reserved for use by Sun Microsystems.
1050When making programmatic use of user properties, it is strongly suggested to use a reversed \fBDNS\fR domain name for the \fImodule\fR component of property names to reduce the chance that two independently-developed packages use the same property name for different purposes. Property names beginning with \fBcom.sun\fR. are reserved for use by Sun Microsystems.
925.sp
926.LP
1051.sp
1052.LP
927The values of user properties are arbitrary strings, are always inherited, and are never validated. All of the commands that operate on properties ("zfs list", "zfs get", "zfs set", etc.) can be used to manipulate both native properties and user properties. Use the "\fBzfs inherit\fR" 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 1024 characters.
1053The values of user properties are arbitrary strings, are always inherited, and are never validated. All of the commands that operate on properties (\fBzfs list\fR, \fBzfs get\fR, \fBzfs set\fR, and so forth) can be used to manipulate both native properties and user properties. Use the \fBzfs inherit\fR 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 1024 characters.
928.SS "ZFS Volumes as Swap or Dump Devices"
929.sp
930.LP
931During an initial installation or a live upgrade from a \fBUFS\fR file system, a swap device and dump device are created on \fBZFS\fR volumes in the \fBZFS\fR 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 \fBZFS\fR volumes must be used for the swap area and dump devices. Do not swap to a file on a \fBZFS\fR file system. A \fBZFS\fR swap file configuration is not supported.
932.sp
933.LP
934If you need to change your swap area or dump device after the system is installed or upgraded, use the \fBswap\fR(1M) and \fBdumpadm\fR(1M) commands. If you need to change the size of your swap area or dump device, see the \fISolaris ZFS Administration Guide\fR.
935.SH SUBCOMMANDS

--- 23 unchanged lines hidden (view full) ---

959.sp
960.ne 2
961.mk
962.na
963\fB\fB-p\fR\fR
964.ad
965.sp .6
966.RS 4n
1054.SS "ZFS Volumes as Swap or Dump Devices"
1055.sp
1056.LP
1057During an initial installation or a live upgrade from a \fBUFS\fR file system, a swap device and dump device are created on \fBZFS\fR volumes in the \fBZFS\fR 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 \fBZFS\fR volumes must be used for the swap area and dump devices. Do not swap to a file on a \fBZFS\fR file system. A \fBZFS\fR swap file configuration is not supported.
1058.sp
1059.LP
1060If you need to change your swap area or dump device after the system is installed or upgraded, use the \fBswap\fR(1M) and \fBdumpadm\fR(1M) commands. If you need to change the size of your swap area or dump device, see the \fISolaris ZFS Administration Guide\fR.
1061.SH SUBCOMMANDS

--- 23 unchanged lines hidden (view full) ---

1085.sp
1086.ne 2
1087.mk
1088.na
1089\fB\fB-p\fR\fR
1090.ad
1091.sp .6
1092.RS 4n
967Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the "mountpoint" property inherited from their parent. Any property specified on the command line using the \fB-o\fR option is ignored. If the target filesystem already exists, the operation completes successfully.
1093Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the \fBmountpoint\fR property inherited from their parent. Any property specified on the command line using the \fB-o\fR option is ignored. If the target filesystem already exists, the operation completes successfully.
968.RE
969
970.sp
971.ne 2
972.mk
973.na
974\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
975.ad
976.sp .6
977.RS 4n
1094.RE
1095
1096.sp
1097.ne 2
1098.mk
1099.na
1100\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1101.ad
1102.sp .6
1103.RS 4n
978Sets the specified property as if "\fBzfs set property=value\fR" was invoked at the same time the dataset was created. Any editable \fBZFS\fR property can also be set at creation time. Multiple \fB-o\fR options can be specified. An error results if the same property is specified in multiple \fB-o\fR options.
1104Sets the specified property as if the command \fBzfs set \fIproperty\fR=\fIvalue\fR\fR was invoked at the same time the dataset was created. Any editable \fBZFS\fR property can also be set at creation time. Multiple \fB-o\fR options can be specified. An error results if the same property is specified in multiple \fB-o\fR options.
979.RE
980
981.RE
982
983.sp
984.ne 2
985.mk
986.na

--- 7 unchanged lines hidden (view full) ---

994.sp
995.ne 2
996.mk
997.na
998\fB\fB-p\fR\fR
999.ad
1000.sp .6
1001.RS 4n
1105.RE
1106
1107.RE
1108
1109.sp
1110.ne 2
1111.mk
1112.na

--- 7 unchanged lines hidden (view full) ---

1120.sp
1121.ne 2
1122.mk
1123.na
1124\fB\fB-p\fR\fR
1125.ad
1126.sp .6
1127.RS 4n
1002Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the "mountpoint" property inherited from their parent. Any property specified on the command line using the \fB-o\fR option is ignored. If the target filesystem already exists, the operation completes successfully.
1128Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the \fBmountpoint\fR property inherited from their parent. Any property specified on the command line using the \fB-o\fR option is ignored. If the target filesystem already exists, the operation completes successfully.
1003.RE
1004
1005.sp
1006.ne 2
1007.mk
1008.na
1009\fB\fB-s\fR\fR
1010.ad
1011.sp .6
1012.RS 4n
1129.RE
1130
1131.sp
1132.ne 2
1133.mk
1134.na
1135\fB\fB-s\fR\fR
1136.ad
1137.sp .6
1138.RS 4n
1013Creates a sparse volume with no reservation. See "volsize" in the Native Properties section for more information about sparse volumes.
1139Creates a sparse volume with no reservation. See \fBvolsize\fR in the Native Properties section for more information about sparse volumes.
1014.RE
1015
1016.sp
1017.ne 2
1018.mk
1019.na
1020\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1021.ad
1022.sp .6
1023.RS 4n
1140.RE
1141
1142.sp
1143.ne 2
1144.mk
1145.na
1146\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1147.ad
1148.sp .6
1149.RS 4n
1024Sets the specified property as if "\fBzfs set property=value\fR" was invoked at the same time the dataset was created. Any editable \fBZFS\fR property can also be set at creation time. Multiple \fB-o\fR options can be specified. An error results if the same property is specified in multiple \fB-o\fR options.
1150Sets the specified property as if the \fBzfs set \fIproperty\fR=\fIvalue\fR\fR command was invoked at the same time the dataset was created. Any editable \fBZFS\fR property can also be set at creation time. Multiple \fB-o\fR options can be specified. An error results if the same property is specified in multiple \fB-o\fR options.
1025.RE
1026
1027.sp
1028.ne 2
1029.mk
1030.na
1031\fB\fB-b\fR \fIblocksize\fR\fR
1032.ad
1033.sp .6
1034.RS 4n
1151.RE
1152
1153.sp
1154.ne 2
1155.mk
1156.na
1157\fB\fB-b\fR \fIblocksize\fR\fR
1158.ad
1159.sp .6
1160.RS 4n
1035Equivalent to "\fB\fR\fB-o\fR \fBvolblocksize=\fIblocksize\fR\fR". If this option is specified in conjunction with "\fB\fR\fB-o\fR \fBvolblocksize\fR", the resulting behavior is undefined.
1161Equivalent to \fB\fR\fB-o\fR \fBvolblocksize=\fIblocksize\fR\fR. If this option is specified in conjunction with \fB-o\fR \fBvolblocksize\fR, the resulting behavior is undefined.
1036.RE
1037
1038.RE
1039
1040.sp
1041.ne 2
1042.mk
1043.na

--- 27 unchanged lines hidden (view full) ---

1071.sp
1072.ne 2
1073.mk
1074.na
1075\fB\fB-f\fR\fR
1076.ad
1077.sp .6
1078.RS 4n
1162.RE
1163
1164.RE
1165
1166.sp
1167.ne 2
1168.mk
1169.na

--- 27 unchanged lines hidden (view full) ---

1197.sp
1198.ne 2
1199.mk
1200.na
1201\fB\fB-f\fR\fR
1202.ad
1203.sp .6
1204.RS 4n
1079Force an unmount of any file systems using the "\fBunmount -f\fR" command. This option has no effect on non-file systems or unmounted file systems.
1205Force an unmount of any file systems using the \fBunmount -f\fR command. This option has no effect on non-file systems or unmounted file systems.
1080.RE
1081
1082Extreme care should be taken when applying either the \fB-r\fR or the \fB-f\fR options, as they can destroy large portions of a pool and cause unexpected behavior for mounted file systems in use.
1083.RE
1084
1085.sp
1086.ne 2
1087.mk
1088.na
1089\fB\fBzfs snapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem@snapname\fR|\fIvolume@snapname\fR\fR
1090.ad
1091.sp .6
1092.RS 4n
1206.RE
1207
1208Extreme care should be taken when applying either the \fB-r\fR or the \fB-f\fR options, as they can destroy large portions of a pool and cause unexpected behavior for mounted file systems in use.
1209.RE
1210
1211.sp
1212.ne 2
1213.mk
1214.na
1215\fB\fBzfs snapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem@snapname\fR|\fIvolume@snapname\fR\fR
1216.ad
1217.sp .6
1218.RS 4n
1093Creates a snapshot with the given name. See the "Snapshots" section for details.
1219Creates a snapshot with the given name. All previous modifications by successful system calls to the file system are part of the snapshot. See the "Snapshots" section for details.
1094.sp
1095.ne 2
1096.mk
1097.na
1098\fB\fB-r\fR\fR
1099.ad
1100.sp .6
1101.RS 4n
1102Recursively create snapshots of all descendent datasets. Snapshots are taken atomically, so that all recursive snapshots correspond to the same moment in time.
1103.RE
1104
1105.sp
1106.ne 2
1107.mk
1108.na
1109\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1110.ad
1111.sp .6
1112.RS 4n
1220.sp
1221.ne 2
1222.mk
1223.na
1224\fB\fB-r\fR\fR
1225.ad
1226.sp .6
1227.RS 4n
1228Recursively create snapshots of all descendent datasets. Snapshots are taken atomically, so that all recursive snapshots correspond to the same moment in time.
1229.RE
1230
1231.sp
1232.ne 2
1233.mk
1234.na
1235\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1236.ad
1237.sp .6
1238.RS 4n
1113Sets the specified property; see "\fBzfs create\fR" for details.
1239Sets the specified property; see \fBzfs create\fR for details.
1114.RE
1115
1116.RE
1117
1118.sp
1119.ne 2
1120.mk
1121.na

--- 49 unchanged lines hidden (view full) ---

1171.sp
1172.ne 2
1173.mk
1174.na
1175\fB\fB-p\fR\fR
1176.ad
1177.sp .6
1178.RS 4n
1240.RE
1241
1242.RE
1243
1244.sp
1245.ne 2
1246.mk
1247.na

--- 49 unchanged lines hidden (view full) ---

1297.sp
1298.ne 2
1299.mk
1300.na
1301\fB\fB-p\fR\fR
1302.ad
1303.sp .6
1304.RS 4n
1179Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the "mountpoint" property inherited from their parent. If the target filesystem or volume already exists, the operation completes successfully.
1305Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the \fBmountpoint\fR property inherited from their parent. If the target filesystem or volume already exists, the operation completes successfully.
1180.RE
1181
1182.sp
1183.ne 2
1184.mk
1185.na
1186\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1187.ad
1188.sp .6
1189.RS 4n
1306.RE
1307
1308.sp
1309.ne 2
1310.mk
1311.na
1312\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1313.ad
1314.sp .6
1315.RS 4n
1190Sets the specified property; see "\fBzfs create\fR" for details.
1316Sets the specified property; see \fBzfs create\fR for details.
1191.RE
1192
1193.RE
1194
1195.sp
1196.ne 2
1197.mk
1198.na
1199\fB\fBzfs promote\fR \fIclone-filesystem\fR\fR
1200.ad
1201.sp .6
1202.RS 4n
1317.RE
1318
1319.RE
1320
1321.sp
1322.ne 2
1323.mk
1324.na
1325\fB\fBzfs promote\fR \fIclone-filesystem\fR\fR
1326.ad
1327.sp .6
1328.RS 4n
1203Promotes 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.
1329Promotes 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.
1204.sp
1330.sp
1205The 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 "\fBrename\fR" subcommand can be used to rename any conflicting snapshots.
1331The 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 \fBrename\fR subcommand can be used to rename any conflicting snapshots.
1206.RE
1207
1208.sp
1209.ne 2
1210.mk
1211.na
1212\fB\fBzfs rename\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
1213.ad

--- 11 unchanged lines hidden (view full) ---

1225.sp
1226.ne 2
1227.mk
1228.na
1229\fB\fB-p\fR\fR
1230.ad
1231.sp .6
1232.RS 4n
1332.RE
1333
1334.sp
1335.ne 2
1336.mk
1337.na
1338\fB\fBzfs rename\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
1339.ad

--- 11 unchanged lines hidden (view full) ---

1351.sp
1352.ne 2
1353.mk
1354.na
1355\fB\fB-p\fR\fR
1356.ad
1357.sp .6
1358.RS 4n
1233Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the "mountpoint" property inherited from their parent.
1359Creates all the nonexistent parent datasets. Datasets created in this manner are automatically mounted according to the \fBmountpoint\fR property inherited from their parent.
1234.RE
1235
1236.RE
1237
1238.sp
1239.ne 2
1240.mk
1241.na
1242\fB\fBzfs rename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR\fR
1243.ad
1244.sp .6
1245.RS 4n
1246Recursively rename the snapshots of all descendent datasets. Snapshots are the only dataset that can be renamed recursively.
1247.RE
1248
1249.sp
1250.ne 2
1251.mk
1252.na
1360.RE
1361
1362.RE
1363
1364.sp
1365.ne 2
1366.mk
1367.na
1368\fB\fBzfs rename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR\fR
1369.ad
1370.sp .6
1371.RS 4n
1372Recursively rename the snapshots of all descendent datasets. Snapshots are the only dataset that can be renamed recursively.
1373.RE
1374
1375.sp
1376.ne 2
1377.mk
1378.na
1253\fB\fBzfs\fR \fBlist\fR [\fB-rH\fR] [\fB-o\fR \fIproperty\fR[,\fI\&...\fR]] [ \fB-t\fR \fItype\fR[,\fI\&...\fR]]\fR
1379\fB\fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-H\fR] [\fB-o\fR \fIproperty\fR[,\fI\&...\fR]] [ \fB-t\fR \fItype\fR[,\fI\&...\fR]] [ \fB-s\fR \fIproperty\fR ] ... [ \fB-S\fR \fIproperty\fR ] ... [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR] ...\fR
1254.ad
1380.ad
1255.br
1256.na
1257\fB[ \fB-s\fR \fIproperty\fR ] ... [ \fB-S\fR \fIproperty\fR ] ... [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR] ...\fR
1258.ad
1259.sp .6
1260.RS 4n
1381.sp .6
1382.RS 4n
1261Lists 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 "listsnaps" property is "on" (the default is "off") . The following fields are displayed:
1383Lists 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 \fBlistsnaps\fR property is \fBon\fR (the default is \fBoff\fR) . The following fields are displayed:
1262.sp
1263.in +2
1264.nf
1265name,used,available,referenced,mountpoint
1266.fi
1267.in -2
1268.sp
1269

--- 18 unchanged lines hidden (view full) ---

1288.RS 4n
1289Recursively display any children of the dataset on the command line.
1290.RE
1291
1292.sp
1293.ne 2
1294.mk
1295.na
1384.sp
1385.in +2
1386.nf
1387name,used,available,referenced,mountpoint
1388.fi
1389.in -2
1390.sp
1391

--- 18 unchanged lines hidden (view full) ---

1410.RS 4n
1411Recursively display any children of the dataset on the command line.
1412.RE
1413
1414.sp
1415.ne 2
1416.mk
1417.na
1418\fB\fB-d\fR \fIdepth\fR\fR
1419.ad
1420.sp .6
1421.RS 4n
1422Recursively display any children of the dataset, limiting the recursion to \fIdepth\fR. A depth of \fB1\fR will display only the dataset and its direct children.
1423.RE
1424
1425.sp
1426.ne 2
1427.mk
1428.na
1296\fB\fB-o\fR \fIproperty\fR\fR
1297.ad
1298.sp .6
1299.RS 4n
1300A comma-separated list of properties to display. The property must be:
1301.RS +4
1302.TP
1303.ie t \(bu
1304.el o
1429\fB\fB-o\fR \fIproperty\fR\fR
1430.ad
1431.sp .6
1432.RS 4n
1433A comma-separated list of properties to display. The property must be:
1434.RS +4
1435.TP
1436.ie t \(bu
1437.el o
1305one of the properties described in the "Native Properties" section.
1438one of the properties described in the "Native Properties" section
1306.RE
1307.RS +4
1308.TP
1309.ie t \(bu
1310.el o
1439.RE
1440.RS +4
1441.TP
1442.ie t \(bu
1443.el o
1311a user property.
1444a user property
1312.RE
1313.RS +4
1314.TP
1315.ie t \(bu
1316.el o
1445.RE
1446.RS +4
1447.TP
1448.ie t \(bu
1449.el o
1317the value "name" to display the dataset name.
1450the value \fBname\fR to display the dataset name
1318.RE
1319.RS +4
1320.TP
1321.ie t \(bu
1322.el o
1451.RE
1452.RS +4
1453.TP
1454.ie t \(bu
1455.el o
1323the value "space" to display space usage properties on file systems and volumes. This is a shortcut for "\fB-o name,avail,used,usedsnap,usedds, usedrefreserv,usedchild -t filesystem,volume\fR".
1456the value \fBspace\fR to display space usage properties on file systems and volumes. This is a shortcut for:
1457.sp
1458.in +2
1459.nf
1460-o name,avail,used,usedsnap,usedds,usedrefreserv,\e
1461usedchild -t filesystem,volume
1462.fi
1463.in -2
1464.sp
1465
1324.RE
1325.RE
1326
1327.sp
1328.ne 2
1329.mk
1330.na
1331\fB\fB-s\fR \fIproperty\fR\fR
1332.ad
1333.sp .6
1334.RS 4n
1466.RE
1467.RE
1468
1469.sp
1470.ne 2
1471.mk
1472.na
1473\fB\fB-s\fR \fIproperty\fR\fR
1474.ad
1475.sp .6
1476.RS 4n
1335A property to use 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 "Properties" section, or the special value "name" to sort by the dataset name. Multiple properties can be specified at one time using multiple \fB-s\fR property options. Multiple \fB-s\fR options are evaluated from left to right in decreasing order of importance.
1477A property to use 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 "Properties" section, or the special value \fBname\fR to sort by the dataset name. Multiple properties can be specified at one time using multiple \fB-s\fR property options. Multiple \fB-s\fR options are evaluated from left to right in decreasing order of importance.
1336.sp
1337The following is a list of sorting criteria:
1338.RS +4
1339.TP
1340.ie t \(bu
1341.el o
1342Numeric types sort in numeric order.
1343.RE

--- 8 unchanged lines hidden (view full) ---

1352.ie t \(bu
1353.el o
1354Types inappropriate for a row sort that row to the literal bottom, regardless of the specified ordering.
1355.RE
1356.RS +4
1357.TP
1358.ie t \(bu
1359.el o
1478.sp
1479The following is a list of sorting criteria:
1480.RS +4
1481.TP
1482.ie t \(bu
1483.el o
1484Numeric types sort in numeric order.
1485.RE

--- 8 unchanged lines hidden (view full) ---

1494.ie t \(bu
1495.el o
1496Types inappropriate for a row sort that row to the literal bottom, regardless of the specified ordering.
1497.RE
1498.RS +4
1499.TP
1500.ie t \(bu
1501.el o
1360If no sorting options are specified the existing behavior of "\fBzfs list\fR" is preserved.
1502If no sorting options are specified the existing behavior of \fBzfs list\fR is preserved.
1361.RE
1362.RE
1363
1364.sp
1365.ne 2
1366.mk
1367.na
1368\fB\fB-S\fR \fIproperty\fR\fR

--- 6 unchanged lines hidden (view full) ---

1375.sp
1376.ne 2
1377.mk
1378.na
1379\fB\fB-t\fR \fItype\fR\fR
1380.ad
1381.sp .6
1382.RS 4n
1503.RE
1504.RE
1505
1506.sp
1507.ne 2
1508.mk
1509.na
1510\fB\fB-S\fR \fIproperty\fR\fR

--- 6 unchanged lines hidden (view full) ---

1517.sp
1518.ne 2
1519.mk
1520.na
1521\fB\fB-t\fR \fItype\fR\fR
1522.ad
1523.sp .6
1524.RS 4n
1383A comma-separated list of types to display, where "type" is one of "filesystem", "snapshot" , "volume" or "all". For example, specifying "\fB-t snapshot\fR" displays only snapshots.
1525A comma-separated list of types to display, where \fItype\fR is one of \fBfilesystem\fR, \fBsnapshot\fR , \fBvolume\fR, or \fBall\fR. For example, specifying \fB-t snapshot\fR displays only snapshots.
1384.RE
1385
1386.RE
1387
1388.sp
1389.ne 2
1390.mk
1391.na
1392\fB\fBzfs set\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
1393.ad
1394.sp .6
1395.RS 4n
1526.RE
1527
1528.RE
1529
1530.sp
1531.ne 2
1532.mk
1533.na
1534\fB\fBzfs set\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
1535.ad
1536.sp .6
1537.RS 4n
1396Sets the property to the given value for each dataset. Only some properties can be edited. See the "Properties" 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 "B", "K", "M", "G", "T", "P", "E", "Z" (for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes, or zettabytes, respectively). Properties cannot be set on snapshots.
1538Sets the property to the given value for each dataset. Only some properties can be edited. See the "Properties" 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 \fBB\fR, \fBK\fR, \fBM\fR, \fBG\fR, \fBT\fR, \fBP\fR, \fBE\fR, \fBZ\fR (for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes, or zettabytes, respectively). Properties cannot be set on snapshots.
1397.RE
1398
1399.sp
1400.ne 2
1401.mk
1402.na
1539.RE
1540
1541.sp
1542.ne 2
1543.mk
1544.na
1403\fB\fBzfs get\fR [\fB-rHp\fR] [\fB-o\fR \fIfield\fR[,...] [\fB-s\fR \fIsource\fR[,...] "\fIall\fR" | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
1545\fB\fBzfs get\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-Hp\fR] [\fB-o\fR \fIfield\fR[,...] [\fB-s\fR \fIsource\fR[,...] "\fIall\fR" | \fIproperty\fR[,...] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
1404.ad
1405.sp .6
1406.RS 4n
1407Displays 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:
1408.sp
1409.in +2
1410.nf
1411 name Dataset name
1412 property Property name
1413 value Property value
1414 source Property source. Can either be local, default,
1415 temporary, inherited, or none (-).
1416.fi
1417.in -2
1418.sp
1419
1420All columns are displayed by default, though this can be controlled by using the \fB-o\fR option. This command takes a comma-separated list of properties as described in the "Native Properties" and "User Properties" sections.
1421.sp
1546.ad
1547.sp .6
1548.RS 4n
1549Displays 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:
1550.sp
1551.in +2
1552.nf
1553 name Dataset name
1554 property Property name
1555 value Property value
1556 source Property source. Can either be local, default,
1557 temporary, inherited, or none (-).
1558.fi
1559.in -2
1560.sp
1561
1562All columns are displayed by default, though this can be controlled by using the \fB-o\fR option. This command takes a comma-separated list of properties as described in the "Native Properties" and "User Properties" sections.
1563.sp
1422The special value "all" can be used to display all properties that apply to the given dataset's type (filesystem, volume or snapshot).
1564The special value \fBall\fR can be used to display all properties that apply to the given dataset's type (filesystem, volume, or snapshot).
1423.sp
1424.ne 2
1425.mk
1426.na
1427\fB\fB-r\fR\fR
1428.ad
1429.sp .6
1430.RS 4n
1431Recursively display properties for any children.
1432.RE
1433
1434.sp
1435.ne 2
1436.mk
1437.na
1565.sp
1566.ne 2
1567.mk
1568.na
1569\fB\fB-r\fR\fR
1570.ad
1571.sp .6
1572.RS 4n
1573Recursively display properties for any children.
1574.RE
1575
1576.sp
1577.ne 2
1578.mk
1579.na
1580\fB\fB-d\fR \fIdepth\fR\fR
1581.ad
1582.sp .6
1583.RS 4n
1584Recursively display any children of the dataset, limiting the recursion to \fIdepth\fR. A depth of \fB1\fR will display only the dataset and its direct children.
1585.RE
1586
1587.sp
1588.ne 2
1589.mk
1590.na
1438\fB\fB-H\fR\fR
1439.ad
1440.sp .6
1441.RS 4n
1442Display 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.
1443.RE
1444
1445.sp
1446.ne 2
1447.mk
1448.na
1449\fB\fB-o\fR \fIfield\fR\fR
1450.ad
1451.sp .6
1452.RS 4n
1591\fB\fB-H\fR\fR
1592.ad
1593.sp .6
1594.RS 4n
1595Display 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.
1596.RE
1597
1598.sp
1599.ne 2
1600.mk
1601.na
1602\fB\fB-o\fR \fIfield\fR\fR
1603.ad
1604.sp .6
1605.RS 4n
1453A comma-separated list of columns to display. "name,property,value,source" is the default value.
1606A comma-separated list of columns to display. \fBname,property,value,source\fR is the default value.
1454.RE
1455
1456.sp
1457.ne 2
1458.mk
1459.na
1460\fB\fB-s\fR \fIsource\fR\fR
1461.ad
1462.sp .6
1463.RS 4n
1607.RE
1608
1609.sp
1610.ne 2
1611.mk
1612.na
1613\fB\fB-s\fR \fIsource\fR\fR
1614.ad
1615.sp .6
1616.RS 4n
1464A 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: "local,default,inherited,temporary,none". The default value is all sources.
1617A 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: \fBlocal,default,inherited,temporary,none\fR. The default value is all sources.
1465.RE
1466
1467.sp
1468.ne 2
1469.mk
1470.na
1471\fB\fB-p\fR\fR
1472.ad
1473.sp .6
1474.RS 4n
1618.RE
1619
1620.sp
1621.ne 2
1622.mk
1623.na
1624\fB\fB-p\fR\fR
1625.ad
1626.sp .6
1627.RS 4n
1475Display numbers in parsable (exact) values.
1628Display numbers in parseable (exact) values.
1476.RE
1477
1478.RE
1479
1480.sp
1481.ne 2
1482.mk
1483.na

--- 29 unchanged lines hidden (view full) ---

1513.sp
1514.ne 2
1515.mk
1516.na
1517\fB\fBzfs upgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] [\fB-a\fR | \fIfilesystem\fR]\fR
1518.ad
1519.sp .6
1520.RS 4n
1629.RE
1630
1631.RE
1632
1633.sp
1634.ne 2
1635.mk
1636.na

--- 29 unchanged lines hidden (view full) ---

1666.sp
1667.ne 2
1668.mk
1669.na
1670\fB\fBzfs upgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] [\fB-a\fR | \fIfilesystem\fR]\fR
1671.ad
1672.sp .6
1673.RS 4n
1521Upgrades 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. "\fBzfs send\fR" streams generated from new snapshots of these file systems can not be accessed on systems running older versions of the software.
1674Upgrades 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. \fBzfs send\fR streams generated from new snapshots of these file systems can not be accessed on systems running older versions of the software.
1522.sp
1675.sp
1523The file system version is independent of the pool version (see \fBzpool\fR(1M) for information on the "\fBzpool upgrade\fR" command).
1676The file system version is independent of the pool version (see \fBzpool\fR(1M) for information on the \fBzpool upgrade\fR command).
1524.sp
1677.sp
1525The file system version does not have to be upgraded when the pool version is upgraded, and vice versa.
1678The file system version does not have to be upgraded when the pool version is upgraded, and vice-versa.
1526.sp
1527.ne 2
1528.mk
1529.na
1530\fB\fB-a\fR\fR
1531.ad
1532.sp .6
1533.RS 4n

--- 34 unchanged lines hidden (view full) ---

1568.RE
1569
1570.RE
1571
1572.sp
1573.ne 2
1574.mk
1575.na
1679.sp
1680.ne 2
1681.mk
1682.na
1683\fB\fB-a\fR\fR
1684.ad
1685.sp .6
1686.RS 4n

--- 34 unchanged lines hidden (view full) ---

1721.RE
1722
1723.RE
1724
1725.sp
1726.ne 2
1727.mk
1728.na
1729\fB\fBzfs userspace\fR [\fB-niHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-sS\fR \fIfield\fR]... [\fB-t\fR \fItype\fR [,...]] \fIfilesystem\fR | \fIsnapshot\fR\fR
1730.ad
1731.sp .6
1732.RS 4n
1733Displays space consumed by, and quotas on, each user in the specified filesystem or snapshot. This corresponds to the \fBuserused@\fR\fIuser\fR and \fBuserquota@\fR\fIuser\fR properties.
1734.sp
1735.ne 2
1736.mk
1737.na
1738\fB\fB-n\fR\fR
1739.ad
1740.sp .6
1741.RS 4n
1742Print numeric ID instead of user/group name.
1743.RE
1744
1745.sp
1746.ne 2
1747.mk
1748.na
1749\fB\fB-H\fR\fR
1750.ad
1751.sp .6
1752.RS 4n
1753Do not print headers, use tab-delimited output.
1754.RE
1755
1756.sp
1757.ne 2
1758.mk
1759.na
1760\fB\fB-p\fR\fR
1761.ad
1762.sp .6
1763.RS 4n
1764Use exact (parseable) numeric output.
1765.RE
1766
1767.sp
1768.ne 2
1769.mk
1770.na
1771\fB\fB-o\fR \fIfield\fR[,...]\fR
1772.ad
1773.sp .6
1774.RS 4n
1775Display only the specified fields, from the following set:
1776.sp
1777.in +2
1778.nf
1779type,name,used,quota
1780.fi
1781.in -2
1782.sp
1783
1784The default is to display all fields.
1785.RE
1786
1787.sp
1788.ne 2
1789.mk
1790.na
1791\fB\fB-s\fR \fIfield\fR\fR
1792.ad
1793.sp .6
1794.RS 4n
1795Sort output by this field. The \fIs\fR and \fIS\fR flags may be specified multiple times to sort first by one field, then by another. The default is:
1796.sp
1797.in +2
1798.nf
1799-s type -s name
1800.fi
1801.in -2
1802.sp
1803
1804.RE
1805
1806.sp
1807.ne 2
1808.mk
1809.na
1810\fB\fB-S\fR \fIfield\fR\fR
1811.ad
1812.sp .6
1813.RS 4n
1814Sort by this field in reverse order. See \fB-s\fR.
1815.RE
1816
1817.sp
1818.ne 2
1819.mk
1820.na
1821\fB\fB-t\fR \fItype\fR[,...]\fR
1822.ad
1823.sp .6
1824.RS 4n
1825Print only the specified types, from the following set:
1826.sp
1827.in +2
1828.nf
1829all,posixuser,smbuser,posixgroup,smbgroup
1830.fi
1831.in -2
1832.sp
1833
1834The default is:
1835.sp
1836.in +2
1837.nf
1838-t posixuser,smbuser
1839.fi
1840.in -2
1841.sp
1842
1843\&...but can be changed to include group types.
1844.RE
1845
1846.sp
1847.ne 2
1848.mk
1849.na
1850\fB\fB-i\fR\fR
1851.ad
1852.sp .6
1853.RS 4n
1854Translate SID to POSIX ID. The POSIX ID may be ephemeral if no mapping exists. Normal POSIX interfaces (for example, \fBstat\fR(2), \fBls\fR \fB-l\fR) perform this translation, so the \fB-i\fR option allows the output from \fBzfs userspace\fR to be compared directly with those utilities. However, \fB-i\fR 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 are owned by the SMB entity and some by the POSIX entity. However, he \fB-i\fR option will report that the POSIX entity has the total usage and quota for both.
1855.RE
1856
1857.RE
1858
1859.sp
1860.ne 2
1861.mk
1862.na
1863\fB\fBzfs groupspace\fR [\fB-niHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-sS\fR \fIfield\fR]... [\fB-t\fR \fItype\fR [,...]] \fIfilesystem\fR | \fIsnapshot\fR\fR
1864.ad
1865.sp .6
1866.RS 4n
1867Displays space consumed by, and quotas on, each group in the specified filesystem or snapshot. This subcommand is identical to \fBzfs userspace\fR, except that the default types to display are:
1868.sp
1869.in +2
1870.nf
1871-t posixgroup,smbgroup
1872.fi
1873.in -2
1874.sp
1875
1876.RE
1877
1878.sp
1879.ne 2
1880.mk
1881.na
1576\fB\fBzfs mount\fR\fR
1577.ad
1578.sp .6
1579.RS 4n
1580Displays all \fBZFS\fR file systems currently mounted.
1581.RE
1582
1583.sp

--- 8 unchanged lines hidden (view full) ---

1592.sp
1593.ne 2
1594.mk
1595.na
1596\fB\fB-o\fR \fIoptions\fR\fR
1597.ad
1598.sp .6
1599.RS 4n
1882\fB\fBzfs mount\fR\fR
1883.ad
1884.sp .6
1885.RS 4n
1886Displays all \fBZFS\fR file systems currently mounted.
1887.RE
1888
1889.sp

--- 8 unchanged lines hidden (view full) ---

1898.sp
1899.ne 2
1900.mk
1901.na
1902\fB\fB-o\fR \fIoptions\fR\fR
1903.ad
1904.sp .6
1905.RS 4n
1600An optional comma-separated list of mount options to use temporarily for the duration of the mount. See the "Temporary Mount Point Properties" section for details.
1906An optional, comma-separated list of mount options to use temporarily for the duration of the mount. See the "Temporary Mount Point Properties" section for details.
1601.RE
1602
1603.sp
1604.ne 2
1605.mk
1606.na
1607\fB\fB-O\fR\fR
1608.ad

--- 104 unchanged lines hidden (view full) ---

1713.sp
1714.ne 2
1715.mk
1716.na
1717\fB\fIfilesystem\fR\fR
1718.ad
1719.sp .6
1720.RS 4n
1907.RE
1908
1909.sp
1910.ne 2
1911.mk
1912.na
1913\fB\fB-O\fR\fR
1914.ad

--- 104 unchanged lines hidden (view full) ---

2019.sp
2020.ne 2
2021.mk
2022.na
2023\fB\fIfilesystem\fR\fR
2024.ad
2025.sp .6
2026.RS 4n
1721Share the specified filesystem according to the "sharenfs" and "sharesmb" properties. File systems are shared when the "sharenfs" or "sharesmb" property is set.
2027Share the specified filesystem according to the \fBsharenfs\fR and \fBsharesmb\fR properties. File systems are shared when the \fBsharenfs\fR or \fBsharesmb\fR property is set.
1722.RE
1723
1724.RE
1725
1726.sp
1727.ne 2
1728.mk
1729.na

--- 38 unchanged lines hidden (view full) ---

1768.sp
1769.ne 2
1770.mk
1771.na
1772\fB\fB-i\fR \fIsnapshot\fR\fR
1773.ad
1774.sp .6
1775.RS 4n
2028.RE
2029
2030.RE
2031
2032.sp
2033.ne 2
2034.mk
2035.na

--- 38 unchanged lines hidden (view full) ---

2074.sp
2075.ne 2
2076.mk
2077.na
2078\fB\fB-i\fR \fIsnapshot\fR\fR
2079.ad
2080.sp .6
2081.RS 4n
1776Generate an incremental stream from the first \fIsnapshot\fR to the second \fIsnapshot\fR. The incremental source (the first \fIsnapshot\fR) can be specified as the last component of the snapshot name (for example, the part after the "@"), and it is assumed to be from the same file system as the second \fIsnapshot\fR.
2082Generate an incremental stream from the first \fIsnapshot\fR to the second \fIsnapshot\fR. The incremental source (the first \fIsnapshot\fR) can be specified as the last component of the snapshot name (for example, the part after the \fB@\fR), and it is assumed to be from the same file system as the second \fIsnapshot\fR.
1777.sp
2083.sp
1778If the destination is a clone, the source may be the origin snapshot, which must be fully specified (for example, "pool/fs@origin", not just "@origin").
2084If the destination is a clone, the source may be the origin snapshot, which must be fully specified (for example, \fBpool/fs@origin\fR, not just \fB@origin\fR).
1779.RE
1780
1781.sp
1782.ne 2
1783.mk
1784.na
1785\fB\fB-I\fR \fIsnapshot\fR\fR
1786.ad
1787.sp .6
1788.RS 4n
2085.RE
2086
2087.sp
2088.ne 2
2089.mk
2090.na
2091\fB\fB-I\fR \fIsnapshot\fR\fR
2092.ad
2093.sp .6
2094.RS 4n
1789Generate a stream package that sends all intermediary snapshots from the first snapshot to the second snapshot. For example, "\fB-I @a fs@d\fR" is similar to "\fB-i @a fs@b; -i @b fs@c; -i @c fs@d\fR". The incremental source snapshot may be specified as with the \fB-i\fR option.
2095Generate a stream package that sends all intermediary snapshots from the first snapshot to the second snapshot. For example, \fB-I @a fs@d\fR is similar to \fB-i @a fs@b; -i @b fs@c; -i @c fs@d\fR. The incremental source snapshot may be specified as with the \fB-i\fR option.
1790.RE
1791
1792.sp
1793.ne 2
1794.mk
1795.na
1796\fB\fB-R\fR\fR
1797.ad
1798.sp .6
1799.RS 4n
2096.RE
2097
2098.sp
2099.ne 2
2100.mk
2101.na
2102\fB\fB-R\fR\fR
2103.ad
2104.sp .6
2105.RS 4n
1800Generate a replication stream package, which will replicate the specified filesystem, and all descendant file systems, up to the named snapshot. When received, all properties, snapshots, descendent file systems, and clones are preserved.
2106Generate a replication stream package, which will replicate the specified filesystem, and all descendent file systems, up to the named snapshot. When received, all properties, snapshots, descendent file systems, and clones are preserved.
1801.sp
2107.sp
1802If the \fB-i\fR or \fB-I\fR flags are used in conjunction with the \fB-R\fR 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 \fB-F\fR flag is specified when this stream is recieved, snapshots and file systems that do not exist on the sending side are destroyed.
2108If the \fB-i\fR or \fB-I\fR flags are used in conjunction with the \fB-R\fR 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 \fB-F\fR flag is specified when this stream is received, snapshots and file systems that do not exist on the sending side are destroyed.
1803.RE
1804
1805.sp
1806.ne 2
1807.mk
1808.na
1809\fB\fB-v\fR\fR
1810.ad

--- 4 unchanged lines hidden (view full) ---

1815
1816The format of the stream is evolving. No backwards compatibility is guaranteed. You may not be able to receive your streams on future versions of \fBZFS\fR.
1817.RE
1818
1819.sp
1820.ne 2
1821.mk
1822.na
2109.RE
2110
2111.sp
2112.ne 2
2113.mk
2114.na
2115\fB\fB-v\fR\fR
2116.ad

--- 4 unchanged lines hidden (view full) ---

2121
2122The format of the stream is evolving. No backwards compatibility is guaranteed. You may not be able to receive your streams on future versions of \fBZFS\fR.
2123.RE
2124
2125.sp
2126.ne 2
2127.mk
2128.na
1823\fB\fBzfs receive\fR [\fB-vnF\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
2129\fB\fBzfs receive\fR [\fB-vnFu\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
1824.ad
1825.br
1826.na
2130.ad
2131.br
2132.na
1827\fB\fBzfs receive\fR [\fB-vnF\fR] \fB-d\fR \fIfilesystem\fR\fR
2133\fB\fBzfs receive\fR [\fB-vnFu\fR] \fB-d\fR \fIfilesystem\fR\fR
1828.ad
1829.sp .6
1830.RS 4n
2134.ad
2135.sp .6
2136.RS 4n
1831Creates 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 "\fBzfs send\fR" subcommand, which by default creates a full stream. "\fBzfs recv\fR" can be used as an alias for "\fBzfs receive\fR".
2137Creates 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 \fBzfs send\fR subcommand, which by default creates a full stream. \fBzfs recv\fR can be used as an alias for \fBzfs receive\fR.
1832.sp
2138.sp
1833If 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 \fBzvols\fR, the destination device link is destroyed and re-created, which means the \fBzvol\fR cannot be accessed during the \fBreceive\fR operation.
2139If 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 \fBzvols\fR, the destination device link is destroyed and recreated, which means the \fBzvol\fR cannot be accessed during the \fBreceive\fR operation.
1834.sp
1835The name of the snapshot (and file system, if a full stream is received) that this subcommand creates depends on the argument type and the \fB-d\fR option.
1836.sp
1837If the argument is a snapshot name, the specified \fIsnapshot\fR 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 \fIfilesystem\fR or \fIvolume\fR. If the \fB-d\fR option is specified, the snapshot name is determined by appending the sent snapshot's name to the specified \fIfilesystem\fR. If the \fB-d\fR option is specified, any required file systems within the specified one are created.
1838.sp
1839.ne 2
1840.mk
1841.na
1842\fB\fB-d\fR\fR
1843.ad
1844.sp .6
1845.RS 4n
1846Use the name of the sent snapshot to determine the name of the new snapshot as described in the paragraph above.
1847.RE
1848
1849.sp
1850.ne 2
1851.mk
1852.na
2140.sp
2141The name of the snapshot (and file system, if a full stream is received) that this subcommand creates depends on the argument type and the \fB-d\fR option.
2142.sp
2143If the argument is a snapshot name, the specified \fIsnapshot\fR 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 \fIfilesystem\fR or \fIvolume\fR. If the \fB-d\fR option is specified, the snapshot name is determined by appending the sent snapshot's name to the specified \fIfilesystem\fR. If the \fB-d\fR option is specified, any required file systems within the specified one are created.
2144.sp
2145.ne 2
2146.mk
2147.na
2148\fB\fB-d\fR\fR
2149.ad
2150.sp .6
2151.RS 4n
2152Use the name of the sent snapshot to determine the name of the new snapshot as described in the paragraph above.
2153.RE
2154
2155.sp
2156.ne 2
2157.mk
2158.na
2159\fB\fB-u\fR\fR
2160.ad
2161.sp .6
2162.RS 4n
2163File system that is associated with the received stream is not mounted.
2164.RE
2165
2166.sp
2167.ne 2
2168.mk
2169.na
1853\fB\fB-v\fR\fR
1854.ad
1855.sp .6
1856.RS 4n
1857Print verbose information about the stream and the time required to perform the receive operation.
1858.RE
1859
1860.sp

--- 10 unchanged lines hidden (view full) ---

1871.sp
1872.ne 2
1873.mk
1874.na
1875\fB\fB-F\fR\fR
1876.ad
1877.sp .6
1878.RS 4n
2170\fB\fB-v\fR\fR
2171.ad
2172.sp .6
2173.RS 4n
2174Print verbose information about the stream and the time required to perform the receive operation.
2175.RE
2176
2177.sp

--- 10 unchanged lines hidden (view full) ---

2188.sp
2189.ne 2
2190.mk
2191.na
2192\fB\fB-F\fR\fR
2193.ad
2194.sp .6
2195.RS 4n
1879Force 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 "z\fBfs send -R -[iI]\fR"), destroy snapshots and file systems that do not exist on the sending side.
2196Force 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 \fBzfs send -R -[iI]\fR), destroy snapshots and file systems that do not exist on the sending side.
1880.RE
1881
1882.RE
1883
1884.sp
1885.ne 2
1886.mk
1887.na
2197.RE
2198
2199.RE
2200
2201.sp
2202.ne 2
2203.mk
2204.na
2205\fB\fBzfs allow\fR \fIfilesystem\fR | \fIvolume\fR\fR
2206.ad
2207.sp .6
2208.RS 4n
2209Displays permissions that have been delegated on the specified filesystem or volume. See the other forms of \fBzfs allow\fR for more information.
2210.RE
2211
2212.sp
2213.ne 2
2214.mk
2215.na
1888\fB\fBzfs allow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR| \fIvolume\fR\fR
1889.ad
1890.br
1891.na
2216\fB\fBzfs allow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR| \fIvolume\fR\fR
2217.ad
2218.br
2219.na
1892\fB\fBzfs allow\fR [\fB-ld\fR] \fB-e\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR\fR
2220\fB\fBzfs allow\fR [\fB-ld\fR] \fB-e\fR \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR | \fIvolume\fR\fR
1893.ad
1894.sp .6
1895.RS 4n
1896Delegates \fBZFS\fR administration permission for the file systems to non-privileged users.
1897.sp
1898.ne 2
1899.mk
1900.na

--- 55 unchanged lines hidden (view full) ---

1956share subcommand Allows share and unshare.
1957send subcommand
1958
1959
1960aclinherit property
1961aclmode property
1962atime property
1963canmount property
2221.ad
2222.sp .6
2223.RS 4n
2224Delegates \fBZFS\fR administration permission for the file systems to non-privileged users.
2225.sp
2226.ne 2
2227.mk
2228.na

--- 55 unchanged lines hidden (view full) ---

2284share subcommand Allows share and unshare.
2285send subcommand
2286
2287
2288aclinherit property
2289aclmode property
2290atime property
2291canmount property
2292casesensitivity property
1964checksum property
1965compression property
1966copies property
1967devices property
1968exec property
2293checksum property
2294compression property
2295copies property
2296devices property
2297exec property
2298groupquota other Allows accessing any groupquota@... property.
2299groupused other Allows reading any groupused@... property.
1969mountpoint property
2300mountpoint property
2301nbmand property
2302normalization property
1970primarycache property
1971quota property
1972readonly property
1973recordsize property
2303primarycache property
2304quota property
2305readonly property
2306recordsize property
2307refquota property
2308refreservation property
1974reservation property
1975secondarycache property
1976setuid property
1977shareiscsi property
1978sharenfs property
2309reservation property
2310secondarycache property
2311setuid property
2312shareiscsi property
2313sharenfs property
2314sharesmb property
1979snapdir property
2315snapdir property
2316utf8only property
2317userprop other Allows changing any user property.
2318userquota other Allows accessing any userquota@... property.
2319userused other Allows reading any userused@... property.
1980version property
2320version property
2321volblocksize property
1981volsize property
2322volsize property
2323vscan property
1982xattr property
1983zoned property
1984userprop other Allows changing any user property.
1985.fi
1986.in -2
1987.sp
1988
1989.sp

--- 10 unchanged lines hidden (view full) ---

2000.sp
2001.ne 2
2002.mk
2003.na
2004\fB\fBzfs allow\fR \fB-s\fR @setname \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR\fR
2005.ad
2006.sp .6
2007.RS 4n
2324xattr property
2325zoned property
2326userprop other Allows changing any user property.
2327.fi
2328.in -2
2329.sp
2330
2331.sp

--- 10 unchanged lines hidden (view full) ---

2342.sp
2343.ne 2
2344.mk
2345.na
2346\fB\fBzfs allow\fR \fB-s\fR @setname \fIperm\fR|@\fIsetname\fR[,...] \fIfilesystem\fR|\fIvolume\fR\fR
2347.ad
2348.sp .6
2349.RS 4n
2008Defines or adds permissions to a permission set. The set can be used by other \fBzfs allow\fR 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 an "at sign" ("@"), and can be no more than 64 characters long.
2350Defines or adds permissions to a permission set. The set can be used by other \fBzfs allow\fR 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 an "at sign" (\fB@\fR), and can be no more than 64 characters long.
2009.RE
2010
2011.sp
2012.ne 2
2013.mk
2014.na
2015\fB\fBzfs unallow\fR [\fB-rldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] [\fIperm\fR|@\fIsetname\fR[, ...]] \fIfilesystem\fR|\fIvolume\fR\fR
2016.ad

--- 6 unchanged lines hidden (view full) ---

2023\fB\fBzfs unallow\fR [\fB-r\fR] \fB-c\fR [\fIperm\fR|@\fIsetname\fR[,...]]\fR
2024.ad
2025.br
2026.na
2027\fB\fIfilesystem\fR|\fIvolume\fR\fR
2028.ad
2029.sp .6
2030.RS 4n
2351.RE
2352
2353.sp
2354.ne 2
2355.mk
2356.na
2357\fB\fBzfs unallow\fR [\fB-rldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] [\fIperm\fR|@\fIsetname\fR[, ...]] \fIfilesystem\fR|\fIvolume\fR\fR
2358.ad

--- 6 unchanged lines hidden (view full) ---

2365\fB\fBzfs unallow\fR [\fB-r\fR] \fB-c\fR [\fIperm\fR|@\fIsetname\fR[,...]]\fR
2366.ad
2367.br
2368.na
2369\fB\fIfilesystem\fR|\fIvolume\fR\fR
2370.ad
2371.sp .6
2372.RS 4n
2031Removes permissions that were granted with the "\fBzfs allow\fR" 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 \fIuser\fR, \fIgroup\fR, or \fIeveryone\fR are removed. Specifying "everyone" (or using the \fB-e\fR option) only removes the permissions that were granted to "everyone", not all permissions for every user and group. See the "\fBzfs allow\fR" command for a description of the \fB-ldugec\fR options.
2373Removes permissions that were granted with the \fBzfs allow\fR 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 \fIuser\fR, \fIgroup\fR, or \fIeveryone\fR are removed. Specifying "everyone" (or using the \fB-e\fR option) only removes the permissions that were granted to "everyone", not all permissions for every user and group. See the \fBzfs allow\fR command for a description of the \fB-ldugec\fR options.
2032.sp
2033.ne 2
2034.mk
2035.na
2036\fB\fB-r\fR\fR
2037.ad
2038.sp .6
2039.RS 4n

--- 17 unchanged lines hidden (view full) ---

2057Removes permissions from a permission set. If no permissions are specified, then all permissions are removed, thus removing the set entirely.
2058.RE
2059
2060.SH EXAMPLES
2061.LP
2062\fBExample 1 \fRCreating a ZFS File System Hierarchy
2063.sp
2064.LP
2374.sp
2375.ne 2
2376.mk
2377.na
2378\fB\fB-r\fR\fR
2379.ad
2380.sp .6
2381.RS 4n

--- 17 unchanged lines hidden (view full) ---

2399Removes permissions from a permission set. If no permissions are specified, then all permissions are removed, thus removing the set entirely.
2400.RE
2401
2402.SH EXAMPLES
2403.LP
2404\fBExample 1 \fRCreating a ZFS File System Hierarchy
2405.sp
2406.LP
2065The following commands create a file system named "\fBpool/home\fR" and a file system named "\fBpool/home/bob\fR". The mount point "\fB/export/home\fR" is set for the parent file system, and automatically inherited by the child file system.
2407The following commands create a file system named \fBpool/home\fR and a file system named \fBpool/home/bob\fR. The mount point \fB/export/home\fR is set for the parent file system, and automatically inherited by the child file system.
2066
2067.sp
2068.in +2
2069.nf
2408
2409.sp
2410.in +2
2411.nf
2070# zfs create pool/home
2071# zfs set mountpoint=/export/home pool/home
2072# zfs create pool/home/bob
2412# \fBzfs create pool/home\fR
2413# \fBzfs set mountpoint=/export/home pool/home\fR
2414# \fBzfs create pool/home/bob\fR
2073.fi
2074.in -2
2075.sp
2076
2077.LP
2078\fBExample 2 \fRCreating a ZFS Snapshot
2079.sp
2080.LP
2415.fi
2416.in -2
2417.sp
2418
2419.LP
2420\fBExample 2 \fRCreating a ZFS Snapshot
2421.sp
2422.LP
2081The following command creates a snapshot named "yesterday". This snapshot is mounted on demand in the ".zfs/snapshot" directory at the root of the "\fBpool/home/bob\fR" file system.
2423The following command creates a snapshot named \fByesterday\fR. This snapshot is mounted on demand in the \fB\&.zfs/snapshot\fR directory at the root of the \fBpool/home/bob\fR file system.
2082
2083.sp
2084.in +2
2085.nf
2424
2425.sp
2426.in +2
2427.nf
2086# zfs snapshot pool/home/bob@yesterday
2428# \fBzfs snapshot pool/home/bob@yesterday\fR
2087.fi
2088.in -2
2089.sp
2090
2091.LP
2429.fi
2430.in -2
2431.sp
2432
2433.LP
2092\fBExample 3 \fRTaking and destroying multiple snapshots
2434\fBExample 3 \fRTaking and Destroying Multiple Snapshots
2093.sp
2094.LP
2435.sp
2436.LP
2095The following command creates snapshots named "\fByesterday\fR" of "\fBpool/home\fR" and all of its descendent file systems. Each snapshot is mounted on demand in the ".zfs/snapshot" directory at the root of its file system. The second command destroys the newly created snapshots.
2437The following command creates snapshots named \fByesterday\fR of \fBpool/home\fR and all of its descendent file systems. Each snapshot is mounted on demand in the \fB\&.zfs/snapshot\fR directory at the root of its file system. The second command destroys the newly created snapshots.
2096
2097.sp
2098.in +2
2099.nf
2100# \fBzfs snapshot -r pool/home@yesterday\fR
2438
2439.sp
2440.in +2
2441.nf
2442# \fBzfs snapshot -r pool/home@yesterday\fR
2101\fB# zfs destroy -r pool/home@yesterday\fR
2443# \fBzfs destroy -r pool/home@yesterday\fR
2102.fi
2103.in -2
2104.sp
2105
2106.LP
2107\fBExample 4 \fRTurning Off Compression
2108.sp
2109.LP
2444.fi
2445.in -2
2446.sp
2447
2448.LP
2449\fBExample 4 \fRTurning Off Compression
2450.sp
2451.LP
2110The following commands turn compression off for all file systems under "\fBpool/home\fR", but explicitly turns it on for "\fBpool/home/anne\fR".
2452The following commands turn compression off for all file systems under \fBpool/home\fR, but explicitly turns it on for \fBpool/home/anne\fR.
2111
2112.sp
2113.in +2
2114.nf
2453
2454.sp
2455.in +2
2456.nf
2115\fB# zfs set compression=off pool/home
2116# zfs set compression=on pool/home/anne\fR
2457# \fBzfs set compression=off pool/home\fR
2458# \fBzfs set compression=on pool/home/anne\fR
2117.fi
2118.in -2
2119.sp
2120
2121.LP
2122\fBExample 5 \fRListing ZFS Datasets
2123.sp
2124.LP
2459.fi
2460.in -2
2461.sp
2462
2463.LP
2464\fBExample 5 \fRListing ZFS Datasets
2465.sp
2466.LP
2125The following command lists all active file systems and volumes in the system. Snapshots are displayed if the "listsnaps" property is "on" (the default is "off") . See \fBzpool\fR(1M) for more information on pool properties.
2467The following command lists all active file systems and volumes in the system. Snapshots are displayed if the \fBlistsnaps\fR property is \fBon\fR (the default is \fBoff\fR) . See \fBzpool\fR(1M) for more information on pool properties.
2126
2127.sp
2128.in +2
2129.nf
2468
2469.sp
2470.in +2
2471.nf
2130\fB# zfs list\fR
2472# \fBzfs list\fR
2131
2132
2133 NAME USED AVAIL REFER MOUNTPOINT
2134 pool 450K 457G 18K /pool
2135 pool/home 315K 457G 21K /export/home
2136 pool/home/anne 18K 457G 18K /export/home/anne
2137 pool/home/bob 276K 457G 276K /export/home/bob
2138.fi
2139.in -2
2140.sp
2141
2142.LP
2143\fBExample 6 \fRSetting a Quota on a ZFS File System
2144.sp
2145.LP
2473
2474
2475 NAME USED AVAIL REFER MOUNTPOINT
2476 pool 450K 457G 18K /pool
2477 pool/home 315K 457G 21K /export/home
2478 pool/home/anne 18K 457G 18K /export/home/anne
2479 pool/home/bob 276K 457G 276K /export/home/bob
2480.fi
2481.in -2
2482.sp
2483
2484.LP
2485\fBExample 6 \fRSetting a Quota on a ZFS File System
2486.sp
2487.LP
2146The following command sets a quota of 50 gbytes for "\fBpool/home/bob\fR".
2488The following command sets a quota of 50 Gbytes for \fBpool/home/bob\fR.
2147
2148.sp
2149.in +2
2150.nf
2489
2490.sp
2491.in +2
2492.nf
2151\fB# zfs set quota=50G pool/home/bob\fR
2493# \fBzfs set quota=50G pool/home/bob\fR
2152.fi
2153.in -2
2154.sp
2155
2156.LP
2157\fBExample 7 \fRListing ZFS Properties
2158.sp
2159.LP
2494.fi
2495.in -2
2496.sp
2497
2498.LP
2499\fBExample 7 \fRListing ZFS Properties
2500.sp
2501.LP
2160The following command lists all properties for "\fBpool/home/bob\fR".
2502The following command lists all properties for \fBpool/home/bob\fR.
2161
2162.sp
2163.in +2
2164.nf
2503
2504.sp
2505.in +2
2506.nf
2165\fB# zfs get all pool/home/bob\fR
2507# \fBzfs get all pool/home/bob\fR
2166
2167
2168NAME PROPERTY VALUE SOURCE
2169pool/home/bob type filesystem -
2170pool/home/bob creation Thu Jul 12 14:44 2007 -
2171pool/home/bob used 276K -
2172pool/home/bob available 50.0G -
2173pool/home/bob referenced 276K -

--- 43 unchanged lines hidden (view full) ---

2217
2218.sp
2219.LP
2220The following command gets a single property value.
2221
2222.sp
2223.in +2
2224.nf
2508
2509
2510NAME PROPERTY VALUE SOURCE
2511pool/home/bob type filesystem -
2512pool/home/bob creation Thu Jul 12 14:44 2007 -
2513pool/home/bob used 276K -
2514pool/home/bob available 50.0G -
2515pool/home/bob referenced 276K -

--- 43 unchanged lines hidden (view full) ---

2559
2560.sp
2561.LP
2562The following command gets a single property value.
2563
2564.sp
2565.in +2
2566.nf
2225\fB# zfs get -H -o value compression pool/home/bob\fR
2567# \fBzfs get -H -o value compression pool/home/bob\fR
2226on
2227.fi
2228.in -2
2229.sp
2230
2231.sp
2232.LP
2568on
2569.fi
2570.in -2
2571.sp
2572
2573.sp
2574.LP
2233The following command lists all properties with local settings for "\fBpool/home/bob\fR".
2575The following command lists all properties with local settings for \fBpool/home/bob\fR.
2234
2235.sp
2236.in +2
2237.nf
2576
2577.sp
2578.in +2
2579.nf
2238\fB# zfs get -r -s local -o name,property,value all pool/home/bob\fR
2580# \fBzfs get -r -s local -o name,property,value all pool/home/bob\fR
2239
2240 NAME PROPERTY VALUE
2241 pool compression on
2242 pool/home checksum off
2243.fi
2244.in -2
2245.sp
2246
2247.LP
2248\fBExample 8 \fRRolling Back a ZFS File System
2249.sp
2250.LP
2581
2582 NAME PROPERTY VALUE
2583 pool compression on
2584 pool/home checksum off
2585.fi
2586.in -2
2587.sp
2588
2589.LP
2590\fBExample 8 \fRRolling Back a ZFS File System
2591.sp
2592.LP
2251The following command reverts the contents of "\fBpool/home/anne\fR" to the snapshot named "\fByesterday\fR", deleting all intermediate snapshots.
2593The following command reverts the contents of \fBpool/home/anne\fR to the snapshot named \fByesterday\fR, deleting all intermediate snapshots.
2252
2253.sp
2254.in +2
2255.nf
2594
2595.sp
2596.in +2
2597.nf
2256\fB# zfs rollback -r pool/home/anne@yesterday\fR
2598# \fBzfs rollback -r pool/home/anne@yesterday\fR
2257.fi
2258.in -2
2259.sp
2260
2261.LP
2262\fBExample 9 \fRCreating a ZFS Clone
2263.sp
2264.LP
2599.fi
2600.in -2
2601.sp
2602
2603.LP
2604\fBExample 9 \fRCreating a ZFS Clone
2605.sp
2606.LP
2265The following command creates a writable file system whose initial contents are the same as "\fBpool/home/bob@yesterday\fR".
2607The following command creates a writable file system whose initial contents are the same as \fBpool/home/bob@yesterday\fR.
2266
2267.sp
2268.in +2
2269.nf
2608
2609.sp
2610.in +2
2611.nf
2270\fB# zfs clone pool/home/bob@yesterday pool/clone\fR
2612# \fBzfs clone pool/home/bob@yesterday pool/clone\fR
2271.fi
2272.in -2
2273.sp
2274
2275.LP
2276\fBExample 10 \fRPromoting a ZFS Clone
2277.sp
2278.LP
2279The 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:
2280
2281.sp
2282.in +2
2283.nf
2613.fi
2614.in -2
2615.sp
2616
2617.LP
2618\fBExample 10 \fRPromoting a ZFS Clone
2619.sp
2620.LP
2621The 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:
2622
2623.sp
2624.in +2
2625.nf
2284\fB# zfs create pool/project/production\fR
2626# \fBzfs create pool/project/production\fR
2285 populate /pool/project/production with data
2627 populate /pool/project/production with data
2286\fB# zfs snapshot pool/project/production@today
2287# zfs clone pool/project/production@today pool/project/beta\fR
2288 make changes to /pool/project/beta and test them
2289\fB# zfs promote pool/project/beta
2290# zfs rename pool/project/production pool/project/legacy
2291# zfs rename pool/project/beta pool/project/production\fR
2292 once the legacy version is no longer needed, it can be
2293 destroyed
2294\fB# zfs destroy pool/project/legacy\fR
2628# \fBzfs snapshot pool/project/production@today\fR
2629# \fBzfs clone pool/project/production@today pool/project/beta\fR
2630make changes to /pool/project/beta and test them
2631# \fBzfs promote pool/project/beta\fR
2632# \fBzfs rename pool/project/production pool/project/legacy\fR
2633# \fBzfs rename pool/project/beta pool/project/production\fR
2634once the legacy version is no longer needed, it can be destroyed
2635# \fBzfs destroy pool/project/legacy\fR
2295.fi
2296.in -2
2297.sp
2298
2299.LP
2300\fBExample 11 \fRInheriting ZFS Properties
2301.sp
2302.LP
2636.fi
2637.in -2
2638.sp
2639
2640.LP
2641\fBExample 11 \fRInheriting ZFS Properties
2642.sp
2643.LP
2303The following command causes "\fBpool/home/bob\fR" and "\fBpool/home/anne\fR" to inherit the "checksum" property from their parent.
2644The following command causes \fBpool/home/bob\fR and \fBpool/home/anne\fR to inherit the \fBchecksum\fR property from their parent.
2304
2305.sp
2306.in +2
2307.nf
2645
2646.sp
2647.in +2
2648.nf
2308\fB# zfs inherit checksum pool/home/bob pool/home/anne\fR
2649# \fBzfs inherit checksum pool/home/bob pool/home/anne\fR
2309.fi
2310.in -2
2311.sp
2312
2313.LP
2314\fBExample 12 \fRRemotely Replicating ZFS Data
2315.sp
2316.LP
2650.fi
2651.in -2
2652.sp
2653
2654.LP
2655\fBExample 12 \fRRemotely Replicating ZFS Data
2656.sp
2657.LP
2317The following commands send a full stream and then an incremental stream to a remote machine, restoring them into "\fBpoolB/received/fs\fR@a" and "\fBpoolB/received/fs@b\fR", respectively. "\fBpoolB\fR" must contain the file system "\fBpoolB/received\fR", and must not initially contain "\fBpoolB/received/fs\fR".
2658The following commands send a full stream and then an incremental stream to a remote machine, restoring them into \fBpoolB/received/fs@a\fRand \fBpoolB/received/fs@b\fR, respectively. \fBpoolB\fR must contain the file system \fBpoolB/received\fR, and must not initially contain \fBpoolB/received/fs\fR.
2318
2319.sp
2320.in +2
2321.nf
2659
2660.sp
2661.in +2
2662.nf
2322# zfs send pool/fs@a | \e
2323 ssh host zfs receive poolB/received/fs@a
2324# zfs send -i a pool/fs@b | ssh host \e
2325 zfs receive poolB/received/fs
2663# \fBzfs send pool/fs@a | \e\fR
2664 \fBssh host zfs receive poolB/received/fs@a\fR
2665# \fBzfs send -i a pool/fs@b | ssh host \e\fR
2666 \fBzfs receive poolB/received/fs\fR
2326.fi
2327.in -2
2328.sp
2329
2330.LP
2667.fi
2668.in -2
2669.sp
2670
2671.LP
2331\fBExample 13 \fRUsing the zfs receive -d Option
2672\fBExample 13 \fRUsing the \fBreceive\fR \fB-d\fR Option
2332.sp
2333.LP
2673.sp
2674.LP
2334The following command sends a full stream of "\fBpoolA/fsA/fsB@snap\fR" to a remote machine, receiving it into "\fBpoolB/received/fsA/fsB@snap\fR". The "\fBfsA/fsB@snap\fR" portion of the received snapshot's name is determined from the name of the sent snapshot. "\fBpoolB\fR" must contain the file system "\fBpoolB/received\fR". If "\fBpoolB/received/fsA\fR" does not exist, it is be created as an empty file system.
2675The following command sends a full stream of \fBpoolA/fsA/fsB@snap\fR to a remote machine, receiving it into \fBpoolB/received/fsA/fsB@snap\fR. The \fBfsA/fsB@snap\fR portion of the received snapshot's name is determined from the name of the sent snapshot. \fBpoolB\fR must contain the file system \fBpoolB/received\fR. If \fBpoolB/received/fsA\fR does not exist, it is created as an empty file system.
2335
2336.sp
2337.in +2
2338.nf
2676
2677.sp
2678.in +2
2679.nf
2339\fB# zfs send poolA/fsA/fsB@snap | \e
2680# \fBzfs send poolA/fsA/fsB@snap | \e
2340 ssh host zfs receive -d poolB/received\fR
2341.fi
2342.in -2
2343.sp
2344
2345.LP
2346\fBExample 14 \fRSetting User Properties
2347.sp
2348.LP
2681 ssh host zfs receive -d poolB/received\fR
2682.fi
2683.in -2
2684.sp
2685
2686.LP
2687\fBExample 14 \fRSetting User Properties
2688.sp
2689.LP
2349The following example sets the user defined "com.example:department" property for a dataset.
2690The following example sets the user-defined \fBcom.example:department\fR property for a dataset.
2350
2351.sp
2352.in +2
2353.nf
2691
2692.sp
2693.in +2
2694.nf
2354\fB# zfs set com.example:department=12345 tank/accounting\fR
2695# \fBzfs set com.example:department=12345 tank/accounting\fR
2355.fi
2356.in -2
2357.sp
2358
2359.LP
2696.fi
2697.in -2
2698.sp
2699
2700.LP
2360\fBExample 15 \fRCreating a ZFS Volume as a iSCSI Target Device
2701\fBExample 15 \fRCreating a ZFS Volume as an iSCSI Target Device
2361.sp
2362.LP
2363The following example shows how to create a \fBZFS\fR volume as an \fBiSCSI\fR target.
2364
2365.sp
2366.in +2
2367.nf
2702.sp
2703.LP
2704The following example shows how to create a \fBZFS\fR volume as an \fBiSCSI\fR target.
2705
2706.sp
2707.in +2
2708.nf
2368\fB# zfs create -V 2g pool/volumes/vol1
2369 # zfs set shareiscsi=on pool/volumes/vol1
2370 # iscsitadm list target\fR
2371 Target: pool/volumes/vol1
2709# \fBzfs create -V 2g pool/volumes/vol1\fR
2710# \fBzfs set shareiscsi=on pool/volumes/vol1\fR
2711# \fBiscsitadm list target\fR
2712Target: pool/volumes/vol1
2372 iSCSI Name:
2373 iqn.1986-03.com.sun:02:7b4b02a6-3277-eb1b-e686-a24762c52a8c
2374 Connections: 0
2375.fi
2376.in -2
2377.sp
2378
2379.sp
2380.LP
2713 iSCSI Name:
2714 iqn.1986-03.com.sun:02:7b4b02a6-3277-eb1b-e686-a24762c52a8c
2715 Connections: 0
2716.fi
2717.in -2
2718.sp
2719
2720.sp
2721.LP
2381After the \fBiSCSI\fR target is created, set up the \fBiSCSI\fR initiator. For more information about the Solaris \fBiSCSI\fR initiator, see the Solaris Administration Guide: Devices and File Systems.
2722After the \fBiSCSI\fR target is created, set up the \fBiSCSI\fR initiator. For more information about the Solaris \fBiSCSI\fR initiator, see \fBiscsitadm\fR(1M).
2382.LP
2383\fBExample 16 \fRPerforming a Rolling Snapshot
2384.sp
2385.LP
2386The 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:
2387
2388.sp
2389.in +2
2390.nf
2723.LP
2724\fBExample 16 \fRPerforming a Rolling Snapshot
2725.sp
2726.LP
2727The 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:
2728
2729.sp
2730.in +2
2731.nf
2391\fB# zfs destroy -r pool/users@7daysago
2392# zfs rename -r pool/users@6daysago @7daysago
2393# zfs rename -r pool/users@5daysago @6daysago
2394\&...
2395# zfs rename -r pool/users@yesterday @2daysago
2396# zfs rename -r pool/users@today @yesterday
2397# zfs snapshot -r pool/users@today\fR
2732# \fBzfs destroy -r pool/users@7daysago\fR
2733# \fBzfs rename -r pool/users@6daysago @7daysago\fR
2734# \fBzfs rename -r pool/users@5daysago @6daysago\fR
2735# \fBzfs rename -r pool/users@yesterday @5daysago\fR
2736# \fBzfs rename -r pool/users@yesterday @4daysago\fR
2737# \fBzfs rename -r pool/users@yesterday @3daysago\fR
2738# \fBzfs rename -r pool/users@yesterday @2daysago\fR
2739# \fBzfs rename -r pool/users@today @yesterday\fR
2740# \fBzfs snapshot -r pool/users@today\fR
2398.fi
2399.in -2
2400.sp
2401
2402.LP
2741.fi
2742.in -2
2743.sp
2744
2745.LP
2403\fBExample 17 \fRSetting sharenfs Property Options on a ZFS File System
2746\fBExample 17 \fRSetting \fBsharenfs\fR Property Options on a ZFS File System
2404.sp
2405.LP
2747.sp
2748.LP
2406The following commands show how to set "sharenfs" property options to enable \fBrw\fR access for a set of \fBIP\fR addresses and to enable root access for system \fBneo\fR on the \fBtank/home\fR file system.
2749The following commands show how to set \fBsharenfs\fR property options to enable \fBrw\fR access for a set of \fBIP\fR addresses and to enable root access for system \fBneo\fR on the \fBtank/home\fR file system.
2407
2408.sp
2409.in +2
2410.nf
2750
2751.sp
2752.in +2
2753.nf
2411\fB# zfs set sharenfs='rw=@123.123.0.0/16,root=neo' tank/home\fR
2754# \fB# zfs set sharenfs='rw=@123.123.0.0/16,root=neo' tank/home\fR
2412
2413.fi
2414.in -2
2415.sp
2416
2417.sp
2418.LP
2419If you are using \fBDNS\fR for host name resolution, specify the fully qualified hostname.
2420
2421.LP
2422\fBExample 18 \fRDelegating ZFS Administration Permissions on a ZFS Dataset
2423.sp
2424.LP
2755
2756.fi
2757.in -2
2758.sp
2759
2760.sp
2761.LP
2762If you are using \fBDNS\fR for host name resolution, specify the fully qualified hostname.
2763
2764.LP
2765\fBExample 18 \fRDelegating ZFS Administration Permissions on a ZFS Dataset
2766.sp
2767.LP
2425The following example shows how to set permissions so that user "\fBcindys\fR" can create, destroy, mount and take snapshots on \fBtank/cindys\fR. The permissions on \fBtank/cindys\fR are also displayed.
2768The following example shows how to set permissions so that user \fBcindys\fR can create, destroy, mount, and take snapshots on \fBtank/cindys\fR. The permissions on \fBtank/cindys\fR are also displayed.
2426
2427.sp
2428.in +2
2429.nf
2769
2770.sp
2771.in +2
2772.nf
2430\fB# zfs allow cindys create,destroy,mount,snapshot tank/cindys
2431# zfs allow tank/cindys\fR
2773# \fB# zfs allow cindys create,destroy,mount,snapshot tank/cindys\fR
2774# \fBzfs allow tank/cindys\fR
2432-------------------------------------------------------------
2433Local+Descendent permissions on (tank/cindys)
2434 user cindys create,destroy,mount,snapshot
2435-------------------------------------------------------------
2436
2437.fi
2438.in -2
2439.sp
2440
2441.sp
2442.LP
2443Because the \fBtank/cindys\fR mount point permission is set to 755 by default, user \fBcindys\fR will be unable to mount file systems under \fBtank/cindys\fR. Set an \fBACL\fR similar to the following syntax to provide mount point access:
2444.sp
2445.in +2
2446.nf
2775-------------------------------------------------------------
2776Local+Descendent permissions on (tank/cindys)
2777 user cindys create,destroy,mount,snapshot
2778-------------------------------------------------------------
2779
2780.fi
2781.in -2
2782.sp
2783
2784.sp
2785.LP
2786Because the \fBtank/cindys\fR mount point permission is set to 755 by default, user \fBcindys\fR will be unable to mount file systems under \fBtank/cindys\fR. Set an \fBACL\fR similar to the following syntax to provide mount point access:
2787.sp
2788.in +2
2789.nf
2447# chmod A+user:cindys:add_subdirectory:allow /tank/cindys
2790# \fBchmod A+user:cindys:add_subdirectory:allow /tank/cindys\fR
2448.fi
2449.in -2
2450.sp
2451
2452.LP
2453\fBExample 19 \fRDelegating Create Time Permissions on a ZFS Dataset
2454.sp
2455.LP
2456The following example shows how to grant anyone in the group \fBstaff\fR to create file systems in \fBtank/users\fR. This syntax also allows staff members to destroy their own file systems, but not destroy anyone else's file system. The permissions on \fBtank/users\fR are also displayed.
2457
2458.sp
2459.in +2
2460.nf
2791.fi
2792.in -2
2793.sp
2794
2795.LP
2796\fBExample 19 \fRDelegating Create Time Permissions on a ZFS Dataset
2797.sp
2798.LP
2799The following example shows how to grant anyone in the group \fBstaff\fR to create file systems in \fBtank/users\fR. This syntax also allows staff members to destroy their own file systems, but not destroy anyone else's file system. The permissions on \fBtank/users\fR are also displayed.
2800
2801.sp
2802.in +2
2803.nf
2461\fB# zfs allow staff create,mount tank/users
2462# zfs allow -c destroy tank/users
2463# zfs allow tank/users\fR
2804# \fB# zfs allow staff create,mount tank/users\fR
2805# \fBzfs allow -c destroy tank/users\fR
2806# \fBzfs allow tank/users\fR
2464-------------------------------------------------------------
2465Create time permissions on (tank/users)
2466 create,destroy
2467Local+Descendent permissions on (tank/users)
2468 group staff create,mount
2469-------------------------------------------------------------
2470.fi
2471.in -2
2472.sp
2473
2474.LP
2475\fBExample 20 \fRDefining and Granting a Permission Set on a ZFS Dataset
2476.sp
2477.LP
2478The following example shows how to define and grant a permission set on the \fBtank/users\fR file system. The permissions on \fBtank/users\fR are also displayed.
2479
2480.sp
2481.in +2
2482.nf
2807-------------------------------------------------------------
2808Create time permissions on (tank/users)
2809 create,destroy
2810Local+Descendent permissions on (tank/users)
2811 group staff create,mount
2812-------------------------------------------------------------
2813.fi
2814.in -2
2815.sp
2816
2817.LP
2818\fBExample 20 \fRDefining and Granting a Permission Set on a ZFS Dataset
2819.sp
2820.LP
2821The following example shows how to define and grant a permission set on the \fBtank/users\fR file system. The permissions on \fBtank/users\fR are also displayed.
2822
2823.sp
2824.in +2
2825.nf
2483\fB# zfs allow -s @pset create,destroy,snapshot,mount tank/users
2484# zfs allow staff @pset tank/users
2485# zfs allow tank/users
2826# \fBzfs allow -s @pset create,destroy,snapshot,mount tank/users\fR
2827# \fBzfs allow staff @pset tank/users\fR
2828# \fBzfs allow tank/users\fR
2486-------------------------------------------------------------
2487Permission sets on (tank/users)
2488 @pset create,destroy,mount,snapshot
2489Create time permissions on (tank/users)
2490 create,destroy
2491Local+Descendent permissions on (tank/users)
2492 group staff @pset,create,mount
2829-------------------------------------------------------------
2830Permission sets on (tank/users)
2831 @pset create,destroy,mount,snapshot
2832Create time permissions on (tank/users)
2833 create,destroy
2834Local+Descendent permissions on (tank/users)
2835 group staff @pset,create,mount
2493-------------------------------------------------------------\fR
2836-------------------------------------------------------------
2494.fi
2495.in -2
2496.sp
2497
2498.LP
2499\fBExample 21 \fRDelegating Property Permissions on a ZFS Dataset
2500.sp
2501.LP
2502The following example shows to grant the ability to set quotas and reservations on the \fBusers/home\fR file system. The permissions on \fBusers/home\fR are also displayed.
2503
2504.sp
2505.in +2
2506.nf
2837.fi
2838.in -2
2839.sp
2840
2841.LP
2842\fBExample 21 \fRDelegating Property Permissions on a ZFS Dataset
2843.sp
2844.LP
2845The following example shows to grant the ability to set quotas and reservations on the \fBusers/home\fR file system. The permissions on \fBusers/home\fR are also displayed.
2846
2847.sp
2848.in +2
2849.nf
2507\fB# zfs allow cindys quota,reservation users/home
2508# zfs allow users/home\fR
2850# \fBzfs allow cindys quota,reservation users/home\fR
2851# \fBzfs allow users/home\fR
2509-------------------------------------------------------------
2510Local+Descendent permissions on (users/home)
2511 user cindys quota,reservation
2512-------------------------------------------------------------
2513cindys% zfs set quota=10G users/home/marks
2514cindys% zfs get quota users/home/marks
2515NAME PROPERTY VALUE SOURCE
2516users/home/marks quota 10G local

--- 5 unchanged lines hidden (view full) ---

2522\fBExample 22 \fRRemoving ZFS Delegated Permissions on a ZFS Dataset
2523.sp
2524.LP
2525The following example shows how to remove the snapshot permission from the \fBstaff\fR group on the \fBtank/users\fR file system. The permissions on \fBtank/users\fR are also displayed.
2526
2527.sp
2528.in +2
2529.nf
2852-------------------------------------------------------------
2853Local+Descendent permissions on (users/home)
2854 user cindys quota,reservation
2855-------------------------------------------------------------
2856cindys% zfs set quota=10G users/home/marks
2857cindys% zfs get quota users/home/marks
2858NAME PROPERTY VALUE SOURCE
2859users/home/marks quota 10G local

--- 5 unchanged lines hidden (view full) ---

2865\fBExample 22 \fRRemoving ZFS Delegated Permissions on a ZFS Dataset
2866.sp
2867.LP
2868The following example shows how to remove the snapshot permission from the \fBstaff\fR group on the \fBtank/users\fR file system. The permissions on \fBtank/users\fR are also displayed.
2869
2870.sp
2871.in +2
2872.nf
2530\fB# zfs unallow staff snapshot tank/users
2531# zfs allow tank/users\fR
2873# \fBzfs unallow staff snapshot tank/users\fR
2874# \fBzfs allow tank/users\fR
2532-------------------------------------------------------------
2533Permission sets on (tank/users)
2534 @pset create,destroy,mount,snapshot
2535Create time permissions on (tank/users)
2536 create,destroy
2537Local+Descendent permissions on (tank/users)
2538 group staff @pset,create,mount
2539-------------------------------------------------------------

--- 55 unchanged lines hidden (view full) ---

2595AvailabilitySUNWzfsu
2596_
2597Interface StabilityCommitted
2598.TE
2599
2600.SH SEE ALSO
2601.sp
2602.LP
2875-------------------------------------------------------------
2876Permission sets on (tank/users)
2877 @pset create,destroy,mount,snapshot
2878Create time permissions on (tank/users)
2879 create,destroy
2880Local+Descendent permissions on (tank/users)
2881 group staff @pset,create,mount
2882-------------------------------------------------------------

--- 55 unchanged lines hidden (view full) ---

2938AvailabilitySUNWzfsu
2939_
2940Interface StabilityCommitted
2941.TE
2942
2943.SH SEE ALSO
2944.sp
2945.LP
2603\fBgzip\fR(1), \fBssh\fR(1), \fBmount\fR(1M), \fBshare\fR(1M), \fBsharemgr\fR(1M), \fBunshare\fR(1M), \fBzonecfg\fR(1M), \fBzpool\fR(1M), \fBchmod\fR(2), \fBstat\fR(2), \fBfsync\fR(3c), \fBdfstab\fR(4), \fBattributes\fR(5)
2946\fBssh\fR(1), \fBiscsitadm\fR(1M), \fBmount\fR(1M), \fBshare\fR(1M), \fBsharemgr\fR(1M), \fBunshare\fR(1M), \fBzonecfg\fR(1M), \fBzpool\fR(1M), \fBchmod\fR(2), \fBstat\fR(2), \fBwrite\fR(2), \fBfsync\fR(3C), \fBdfstab\fR(4), \fBattributes\fR(5)
2604.sp
2605.LP
2947.sp
2948.LP
2949See the \fBgzip\fR(1) man page, which is not part of the SunOS man page collection.
2950.sp
2951.LP
2606For information about using the \fBZFS\fR web-based management tool and other \fBZFS\fR features, see the \fISolaris ZFS Administration Guide\fR.
2952For information about using the \fBZFS\fR web-based management tool and other \fBZFS\fR features, see the \fISolaris ZFS Administration Guide\fR.