1 '\" t
2 .\"
3 .\" CDDL HEADER START
4 .\"
5 .\" The contents of this file are subject to the terms of the
6 .\" Common Development and Distribution License (the "License").
7 .\" You may not use this file except in compliance with the License.
8 .\"
9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10 .\" or http://www.opensolaris.org/os/licensing.
11 .\" See the License for the specific language governing permissions
12 .\" and limitations under the License.
13 .\"
14 .\" When distributing Covered Code, include this CDDL HEADER in each
15 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16 .\" If applicable, add the following below this CDDL HEADER, with the
17 .\" fields enclosed by brackets "[]" replaced with your own identifying
18 .\" information: Portions Copyright [yyyy] [name of copyright owner]
19 .\"
20 .\" CDDL HEADER END
21 .\"
22 .\"
23 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
24 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
25 .\" Copyright (c) 2012 by Delphix. All rights reserved.
26 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
27 .\" Copyright 2013 Nexenta Systems, Inc. All Rights Reserved.
28 .\" Copyright (c) 2013, Joyent, Inc. All rights reserved.
29 .\"
30 .TH ZFS 1M "Jan 26, 2013"
31 .SH NAME
32 zfs \- configures ZFS file systems
33 .SH SYNOPSIS
34 .LP
35 .nf
36 \fBzfs\fR [\fB-?\fR]
37 .fi
38
39 .LP
40 .nf
41 \fBzfs\fR \fBcreate\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]... \fIfilesystem\fR
42 .fi
43
44 .LP
45 .nf
46 \fBzfs\fR \fBcreate\fR [\fB-ps\fR] [\fB-b\fR \fIblocksize\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]... \fB-V\fR \fIsize\fR \fIvolume\fR
47 .fi
48
49 .LP
50 .nf
51 \fBzfs\fR \fBdestroy\fR [\fB-fnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR
52 .fi
53
54 .LP
55 .nf
56 \fBzfs\fR \fBdestroy\fR [\fB-dnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR@\fIsnap\fR[%\fIsnap\fR][,\fIsnap\fR[%\fIsnap\fR]]...
57 .fi
58
59 .LP
60 .nf
61 \fBzfs\fR \fBsnapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]...
62 \fIfilesystem@snapname\fR|\fIvolume@snapname\fR...
63 .fi
64
65 .LP
66 .nf
67 \fBzfs\fR \fBrollback\fR [\fB-rRf\fR] \fIsnapshot\fR
68 .fi
69
70 .LP
71 .nf
72 \fBzfs\fR \fBclone\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]... \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR
73 .fi
74
75 .LP
76 .nf
77 \fBzfs\fR \fBpromote\fR \fIclone-filesystem\fR
78 .fi
79
80 .LP
81 .nf
82 \fBzfs\fR \fBrename\fR [\fB-f\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
83 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
84 .fi
85
86 .LP
87 .nf
88 \fBzfs\fR \fBrename\fR [\fB-fp\fR] \fIfilesystem\fR|\fIvolume\fR \fIfilesystem\fR|\fIvolume\fR
89 .fi
90
91 .LP
92 .nf
93 \fBzfs\fR \fBrename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR
94 .fi
95
96 .LP
97 .nf
98 \fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-H\fR][\fB-o\fR \fIproperty\fR[,\fIproperty\fR]...] [\fB-t\fR \fItype\fR[,\fItype\fR]...]
99 [\fB-s\fR \fIproperty\fR]... [\fB-S\fR \fIproperty\fR]... [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR]...
100 .fi
101
102 .LP
103 .nf
104 \fBzfs\fR \fBset\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR...
105 .fi
106
107 .LP
108 .nf
109 \fBzfs\fR \fBget\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR][\fB-Hp\fR][\fB-o\fR \fIfield\fR[,\fIfield\fR]...] [\fB-t\fR \fItype\fR[,\fItype\fR]...]
110 [\fB-s\fR \fIsource\fR[,\fIsource\fR]...] \fBall\fR | \fIproperty\fR[,\fIproperty\fR]...
111 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR...
112 .fi
113
114 .LP
115 .nf
116 \fBzfs\fR \fBinherit\fR [\fB-r\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume|snapshot\fR...
117 .fi
118
119 .LP
120 .nf
121 \fBzfs\fR \fBupgrade\fR [\fB-v\fR]
122 .fi
123
124 .LP
125 .nf
126 \fBzfs\fR \fBupgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] \fB-a\fR | \fIfilesystem\fR
127 .fi
128
129 .LP
130 .nf
131 \fBzfs\fR \fBuserspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,\fIfield\fR]...] [\fB-s\fR \fIfield\fR]...
132 [\fB-S\fR \fIfield\fR]... [\fB-t\fR \fItype\fR[,\fItype\fR]...] \fIfilesystem\fR|\fIsnapshot\fR
133 .fi
134
135 .LP
136 .nf
137 \fBzfs\fR \fBgroupspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,\fIfield\fR]...] [\fB-s\fR \fIfield\fR]...
138 [\fB-S\fR \fIfield\fR]... [\fB-t\fR \fItype\fR[,\fItype\fR]...] \fIfilesystem\fR|\fIsnapshot\fR
139 .fi
140
141 .LP
142 .nf
143 \fBzfs\fR \fBmount\fR
144 .fi
145
146 .LP
147 .nf
148 \fBzfs\fR \fBmount\fR [\fB-vO\fR] [\fB-o \fIoptions\fR\fR] \fB-a\fR | \fIfilesystem\fR
149 .fi
150
151 .LP
152 .nf
153 \fBzfs\fR \fBunmount\fR [\fB-f\fR] \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR
154 .fi
155
156 .LP
157 .nf
158 \fBzfs\fR \fBshare\fR \fB-a\fR | \fIfilesystem\fR
159 .fi
160
161 .LP
162 .nf
163 \fBzfs\fR \fBunshare\fR \fB-a\fR \fIfilesystem\fR|\fImountpoint\fR
164 .fi
165
166 .LP
167 .nf
168 \fBzfs\fR \fBsend\fR [\fB-DnPpRrv\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
169 .fi
170
171 .LP
172 .nf
173 \fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
174 .fi
175
176 .LP
177 .nf
178 \fBzfs\fR \fBreceive\fR [\fB-vnFu\fR] [\fB-d\fR|\fB-e\fR] \fIfilesystem\fR
179 .fi
180
181 .LP
182 .nf
183 \fBzfs\fR \fBallow\fR \fIfilesystem\fR|\fIvolume\fR
184 .fi
185
186 .LP
187 .nf
188 \fBzfs\fR \fBallow\fR [\fB-ldug\fR] \fIuser\fR|\fIgroup\fR[,\fIuser\fR|\fIgroup\fR]...
189 \fIperm\fR|\fI@setname\fR[,\fIperm\fR|\fI@setname\fR]... \fIfilesystem\fR|\fIvolume\fR
190 .fi
191
192 .LP
193 .nf
194 \fBzfs\fR \fBallow\fR [\fB-ld\fR] \fB-e\fR|\fBeveryone\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]...
195 \fIfilesystem\fR|\fIvolume\fR
196 .fi
197
198 .LP
199 .nf
200 \fBzfs\fR \fBallow\fR \fB-c\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]... \fIfilesystem\fR|\fIvolume\fR
201 .fi
202
203 .LP
204 .nf
205 \fBzfs\fR \fBallow\fR \fB-s\fR @\fIsetname\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]... \fIfilesystem\fR|\fIvolume\fR
206 .fi
207
208 .LP
209 .nf
210 \fBzfs\fR \fBunallow\fR [\fB-rldug\fR] \fIuser\fR|\fIgroup\fR[,\fIuser\fR|\fIgroup\fR]...
211 [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]...] \fIfilesystem\fR|\fIvolume\fR
212 .fi
213
214 .LP
215 .nf
216 \fBzfs\fR \fBunallow\fR [\fB-rld\fR] \fB-e\fR|\fBeveryone\fR [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]...]
217 \fIfilesystem\fR|\fIvolume\fR
218 .fi
219
220 .LP
221 .nf
222 \fBzfs\fR \fBunallow\fR [\fB-r\fR] \fB-c\fR [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]...] \fIfilesystem\fR|\fIvolume\fR
223 .fi
224
225 .LP
226 .nf
227 \fBzfs\fR \fBunallow\fR [\fB-r\fR] \fB-s\fR @\fIsetname\fR [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|\fI@setname\fR]...]
228 \fIfilesystem\fR|\fIvolume\fR
229 .fi
230
231 .LP
232 .nf
233 \fBzfs\fR \fBhold\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...
234 .fi
235
236 .LP
237 .nf
238 \fBzfs\fR \fBholds\fR [\fB-r\fR] \fIsnapshot\fR...
239 .fi
240
241 .LP
242 .nf
243 \fBzfs\fR \fBrelease\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...
244 .fi
245
246 .LP
247 .nf
248 \fBzfs\fR \fBdiff\fR [\fB-FHt\fR] \fIsnapshot\fR \fIsnapshot|filesystem\fR
249
250 .SH DESCRIPTION
251 .sp
252 .LP
253 The \fBzfs\fR command configures \fBZFS\fR datasets within a \fBZFS\fR storage
254 pool, as described in \fBzpool\fR(1M). A dataset is identified by a unique path
255 within the \fBZFS\fR namespace. For example:
256 .sp
257 .in +2
258 .nf
259 pool/{filesystem,volume,snapshot}
260 .fi
261 .in -2
262 .sp
263
264 .sp
265 .LP
266 where the maximum length of a dataset name is \fBMAXNAMELEN\fR (256 bytes).
267 .sp
268 .LP
269 A dataset can be one of the following:
270 .sp
271 .ne 2
272 .na
273 \fB\fIfile system\fR\fR
274 .ad
275 .sp .6
276 .RS 4n
277 A \fBZFS\fR dataset of type \fBfilesystem\fR can be mounted within the standard
278 system namespace and behaves like other file systems. While \fBZFS\fR file
279 systems are designed to be \fBPOSIX\fR compliant, known issues exist that
280 prevent compliance in some cases. Applications that depend on standards
281 conformance might fail due to nonstandard behavior when checking file system
282 free space.
283 .RE
284
285 .sp
286 .ne 2
287 .na
288 \fB\fIvolume\fR\fR
289 .ad
290 .sp .6
291 .RS 4n
292 A logical volume exported as a raw or block device. This type of dataset should
293 only be used under special circumstances. File systems are typically used in
294 most environments.
295 .RE
296
297 .sp
298 .ne 2
299 .na
300 \fB\fIsnapshot\fR\fR
301 .ad
302 .sp .6
303 .RS 4n
304 A read-only version of a file system or volume at a given point in time. It is
305 specified as \fIfilesystem@name\fR or \fIvolume@name\fR.
306 .RE
307
308 .SS "ZFS File System Hierarchy"
309 .sp
310 .LP
311 A \fBZFS\fR storage pool is a logical collection of devices that provide space
312 for datasets. A storage pool is also the root of the \fBZFS\fR file system
313 hierarchy.
314 .sp
315 .LP
316 The root of the pool can be accessed as a file system, such as mounting and
317 unmounting, taking snapshots, and setting properties. The physical storage
318 characteristics, however, are managed by the \fBzpool\fR(1M) command.
319 .sp
320 .LP
321 See \fBzpool\fR(1M) for more information on creating and administering pools.
322 .SS "Snapshots"
323 .sp
324 .LP
325 A snapshot is a read-only copy of a file system or volume. Snapshots can be
326 created extremely quickly, and initially consume no additional space within the
327 pool. As data within the active dataset changes, the snapshot consumes more
328 data than would otherwise be shared with the active dataset.
329 .sp
330 .LP
331 Snapshots can have arbitrary names. Snapshots of volumes can be cloned or
332 rolled back, but cannot be accessed independently.
333 .sp
334 .LP
335 File system snapshots can be accessed under the \fB\&.zfs/snapshot\fR directory
336 in the root of the file system. Snapshots are automatically mounted on demand
337 and may be unmounted at regular intervals. The visibility of the \fB\&.zfs\fR
338 directory can be controlled by the \fBsnapdir\fR property.
339 .SS "Clones"
340 .sp
341 .LP
342 A clone is a writable volume or file system whose initial contents are the same
343 as another dataset. As with snapshots, creating a clone is nearly
344 instantaneous, and initially consumes no additional space.
345 .sp
346 .LP
347 Clones can only be created from a snapshot. When a snapshot is cloned, it
348 creates an implicit dependency between the parent and child. Even though the
349 clone is created somewhere else in the dataset hierarchy, the original snapshot
350 cannot be destroyed as long as a clone exists. The \fBorigin\fR property
351 exposes this dependency, and the \fBdestroy\fR command lists any such
352 dependencies, if they exist.
353 .sp
354 .LP
355 The clone parent-child dependency relationship can be reversed by using the
356 \fBpromote\fR subcommand. This causes the "origin" file system to become a
357 clone of the specified file system, which makes it possible to destroy the file
358 system that the clone was created from.
359 .SS "Mount Points"
360 .sp
361 .LP
362 Creating a \fBZFS\fR file system is a simple operation, so the number of file
363 systems per system is likely to be numerous. To cope with this, \fBZFS\fR
364 automatically manages mounting and unmounting file systems without the need to
365 edit the \fB/etc/vfstab\fR file. All automatically managed file systems are
366 mounted by \fBZFS\fR at boot time.
367 .sp
368 .LP
369 By default, file systems are mounted under \fB/\fIpath\fR\fR, where \fIpath\fR
370 is the name of the file system in the \fBZFS\fR namespace. Directories are
371 created and destroyed as needed.
372 .sp
373 .LP
374 A file system can also have a mount point set in the \fBmountpoint\fR property.
375 This directory is created as needed, and \fBZFS\fR automatically mounts the
376 file system when the \fBzfs mount -a\fR command is invoked (without editing
377 \fB/etc/vfstab\fR). The \fBmountpoint\fR property can be inherited, so if
378 \fBpool/home\fR has a mount point of \fB/export/stuff\fR, then
379 \fBpool/home/user\fR automatically inherits a mount point of
380 \fB/export/stuff/user\fR.
381 .sp
382 .LP
383 A file system \fBmountpoint\fR property of \fBnone\fR prevents the file system
384 from being mounted.
385 .sp
386 .LP
387 If needed, \fBZFS\fR file systems can also be managed with traditional tools
388 (\fBmount\fR, \fBumount\fR, \fB/etc/vfstab\fR). If a file system's mount point
389 is set to \fBlegacy\fR, \fBZFS\fR makes no attempt to manage the file system,
390 and the administrator is responsible for mounting and unmounting the file
391 system.
392 .SS "Zones"
393 .sp
394 .LP
395 A \fBZFS\fR file system can be added to a non-global zone by using the
396 \fBzonecfg\fR \fBadd fs\fR subcommand. A \fBZFS\fR file system that is added to
397 a non-global zone must have its \fBmountpoint\fR property set to \fBlegacy\fR.
398 .sp
399 .LP
400 The physical properties of an added file system are controlled by the global
401 administrator. However, the zone administrator can create, modify, or destroy
402 files within the added file system, depending on how the file system is
403 mounted.
404 .sp
405 .LP
406 A dataset can also be delegated to a non-global zone by using the \fBzonecfg\fR
407 \fBadd dataset\fR subcommand. You cannot delegate a dataset to one zone and the
408 children of the same dataset to another zone. The zone administrator can change
409 properties of the dataset or any of its children. However, the \fBquota\fR
410 property is controlled by the global administrator.
411 .sp
412 .LP
413 A \fBZFS\fR volume can be added as a device to a non-global zone by using the
414 \fBzonecfg\fR \fBadd device\fR subcommand. However, its physical properties can
415 be modified only by the global administrator.
416 .sp
417 .LP
418 For more information about \fBzonecfg\fR syntax, see \fBzonecfg\fR(1M).
419 .sp
420 .LP
421 After a dataset is delegated to a non-global zone, the \fBzoned\fR property is
422 automatically set. A zoned file system cannot be mounted in the global zone,
423 since the zone administrator might have to set the mount point to an
424 unacceptable value.
425 .sp
426 .LP
427 The global administrator can forcibly clear the \fBzoned\fR property, though
428 this should be done with extreme care. The global administrator should verify
429 that all the mount points are acceptable before clearing the property.
430 .SS "Native Properties"
431 .sp
432 .LP
433 Properties are divided into two types, native properties and user-defined (or
434 "user") properties. Native properties either export internal statistics or
435 control \fBZFS\fR behavior. In addition, native properties are either editable
436 or read-only. User properties have no effect on \fBZFS\fR behavior, but you can
437 use them to annotate datasets in a way that is meaningful in your environment.
438 For more information about user properties, see the "User Properties" section,
439 below.
440 .sp
441 .LP
442 Every dataset has a set of properties that export statistics about the dataset
443 as well as control various behaviors. Properties are inherited from the parent
444 unless overridden by the child. Some properties apply only to certain types of
445 datasets (file systems, volumes, or snapshots).
446 .sp
447 .LP
448 The values of numeric properties can be specified using human-readable suffixes
449 (for example, \fBk\fR, \fBKB\fR, \fBM\fR, \fBGb\fR, and so forth, up to \fBZ\fR
450 for zettabyte). The following are all valid (and equal) specifications:
451 .sp
452 .in +2
453 .nf
454 1536M, 1.5g, 1.50GB
455 .fi
456 .in -2
457 .sp
458
459 .sp
460 .LP
461 The values of non-numeric properties are case sensitive and must be lowercase,
462 except for \fBmountpoint\fR, \fBsharenfs\fR, and \fBsharesmb\fR.
463 .sp
464 .LP
465 The following native properties consist of read-only statistics about the
466 dataset. These properties can be neither set, nor inherited. Native properties
467 apply to all dataset types unless otherwise noted.
468 .sp
469 .ne 2
470 .na
471 \fB\fBavailable\fR\fR
472 .ad
473 .sp .6
474 .RS 4n
475 The amount of space available to the dataset and all its children, assuming
476 that there is no other activity in the pool. Because space is shared within a
477 pool, availability can be limited by any number of factors, including physical
478 pool size, quotas, reservations, or other datasets within the pool.
479 .sp
480 This property can also be referred to by its shortened column name,
481 \fBavail\fR.
482 .RE
483
484 .sp
485 .ne 2
486 .na
487 \fB\fBcompressratio\fR\fR
488 .ad
489 .sp .6
490 .RS 4n
491 For non-snapshots, the compression ratio achieved for the \fBused\fR
492 space of this dataset, expressed as a multiplier. The \fBused\fR
493 property includes descendant datasets, and, for clones, does not include
494 the space shared with the origin snapshot. For snapshots, the
495 \fBcompressratio\fR is the same as the \fBrefcompressratio\fR property.
496 Compression can be turned on by running: \fBzfs set compression=on
497 \fIdataset\fR\fR. The default value is \fBoff\fR.
498 .RE
499
500 .sp
501 .ne 2
502 .na
503 \fB\fBcreation\fR\fR
504 .ad
505 .sp .6
506 .RS 4n
507 The time this dataset was created.
508 .RE
509
510 .sp
511 .ne 2
512 .na
513 \fB\fBclones\fR\fR
514 .ad
515 .sp .6
516 .RS 4n
517 For snapshots, this property is a comma-separated list of filesystems or
518 volumes which are clones of this snapshot. The clones' \fBorigin\fR property
519 is this snapshot. If the \fBclones\fR property is not empty, then this
520 snapshot can not be destroyed (even with the \fB-r\fR or \fB-f\fR options).
521 .RE
522
523 .sp
524 .ne 2
525 .na
526 \fB\fBdefer_destroy\fR\fR
527 .ad
528 .sp .6
529 .RS 4n
530 This property is \fBon\fR if the snapshot has been marked for deferred destroy
531 by using the \fBzfs destroy\fR \fB-d\fR command. Otherwise, the property is
532 \fBoff\fR.
533 .RE
534
535 .sp
536 .ne 2
537 .na
538 \fB\fBlogicalreferenced\fR\fR
539 .ad
540 .sp .6
541 .RS 4n
542 The amount of space that is "logically" accessible by this dataset. See
543 the \fBreferenced\fR property. The logical space ignores the effect of
544 the \fBcompression\fR and \fBcopies\fR properties, giving a quantity
545 closer to the amount of data that applications see. However, it does
546 include space consumed by metadata.
547 .sp
548 This property can also be referred to by its shortened column name,
549 \fBlrefer\fR.
550 .RE
551
552 .sp
553 .ne 2
554 .na
555 \fB\fBlogicalused\fR\fR
556 .ad
557 .sp .6
558 .RS 4n
559 The amount of space that is "logically" consumed by this dataset and all
560 its descendents. See the \fBused\fR property. The logical space
561 ignores the effect of the \fBcompression\fR and \fBcopies\fR properties,
562 giving a quantity closer to the amount of data that applications see.
563 However, it does include space consumed by metadata.
564 .sp
565 This property can also be referred to by its shortened column name,
566 \fBlused\fR.
567 .RE
568
569 .sp
570 .ne 2
571 .na
572 \fB\fBmounted\fR\fR
573 .ad
574 .sp .6
575 .RS 4n
576 For file systems, indicates whether the file system is currently mounted. This
577 property can be either \fByes\fR or \fBno\fR.
578 .RE
579
580 .sp
581 .ne 2
582 .na
583 \fB\fBorigin\fR\fR
584 .ad
585 .sp .6
586 .RS 4n
587 For cloned file systems or volumes, the snapshot from which the clone was
588 created. See also the \fBclones\fR property.
589 .RE
590
591 .sp
592 .ne 2
593 .na
594 \fB\fBreferenced\fR\fR
595 .ad
596 .sp .6
597 .RS 4n
598 The amount of data that is accessible by this dataset, which may or may not be
599 shared with other datasets in the pool. When a snapshot or clone is created, it
600 initially references the same amount of space as the file system or snapshot it
601 was created from, since its contents are identical.
602 .sp
603 This property can also be referred to by its shortened column name,
604 \fBrefer\fR.
605 .RE
606
607 .sp
608 .ne 2
609 .na
610 \fB\fBrefcompressratio\fR\fR
611 .ad
612 .sp .6
613 .RS 4n
614 The compression ratio achieved for the \fBreferenced\fR space of this
615 dataset, expressed as a multiplier. See also the \fBcompressratio\fR
616 property.
617 .RE
618
619 .sp
620 .ne 2
621 .na
622 \fB\fBtype\fR\fR
623 .ad
624 .sp .6
625 .RS 4n
626 The type of dataset: \fBfilesystem\fR, \fBvolume\fR, or \fBsnapshot\fR.
627 .RE
628
629 .sp
630 .ne 2
631 .na
632 \fB\fBused\fR\fR
633 .ad
634 .sp .6
635 .RS 4n
636 The amount of space consumed by this dataset and all its descendents. This is
637 the value that is checked against this dataset's quota and reservation. The
638 space used does not include this dataset's reservation, but does take into
639 account the reservations of any descendent datasets. The amount of space that a
640 dataset consumes from its parent, as well as the amount of space that are freed
641 if this dataset is recursively destroyed, is the greater of its space used and
642 its reservation.
643 .sp
644 When snapshots (see the "Snapshots" section) are created, their space is
645 initially shared between the snapshot and the file system, and possibly with
646 previous snapshots. As the file system changes, space that was previously
647 shared becomes unique to the snapshot, and counted in the snapshot's space
648 used. Additionally, deleting snapshots can increase the amount of space unique
649 to (and used by) other snapshots.
650 .sp
651 The amount of space used, available, or referenced does not take into account
652 pending changes. Pending changes are generally accounted for within a few
653 seconds. Committing a change to a disk using \fBfsync\fR(3c) or \fBO_SYNC\fR
654 does not necessarily guarantee that the space usage information is updated
655 immediately.
656 .RE
657
658 .sp
659 .ne 2
660 .na
661 \fB\fBusedby*\fR\fR
662 .ad
663 .sp .6
664 .RS 4n
665 The \fBusedby*\fR properties decompose the \fBused\fR properties into the
666 various reasons that space is used. Specifically, \fBused\fR =
667 \fBusedbychildren\fR + \fBusedbydataset\fR + \fBusedbyrefreservation\fR +,
668 \fBusedbysnapshots\fR. These properties are only available for datasets created
669 on \fBzpool\fR "version 13" pools.
670 .RE
671
672 .sp
673 .ne 2
674 .na
675 \fB\fBusedbychildren\fR\fR
676 .ad
677 .sp .6
678 .RS 4n
679 The amount of space used by children of this dataset, which would be freed if
680 all the dataset's children were destroyed.
681 .RE
682
683 .sp
684 .ne 2
685 .na
686 \fB\fBusedbydataset\fR\fR
687 .ad
688 .sp .6
689 .RS 4n
690 The amount of space used by this dataset itself, which would be freed if the
691 dataset were destroyed (after first removing any \fBrefreservation\fR and
692 destroying any necessary snapshots or descendents).
693 .RE
694
695 .sp
696 .ne 2
697 .na
698 \fB\fBusedbyrefreservation\fR\fR
699 .ad
700 .sp .6
701 .RS 4n
702 The amount of space used by a \fBrefreservation\fR set on this dataset, which
703 would be freed if the \fBrefreservation\fR was removed.
704 .RE
705
706 .sp
707 .ne 2
708 .na
709 \fB\fBusedbysnapshots\fR\fR
710 .ad
711 .sp .6
712 .RS 4n
713 The amount of space consumed by snapshots of this dataset. In particular, it is
714 the amount of space that would be freed if all of this dataset's snapshots were
715 destroyed. Note that this is not simply the sum of the snapshots' \fBused\fR
716 properties because space can be shared by multiple snapshots.
717 .RE
718
719 .sp
720 .ne 2
721 .na
722 \fB\fBuserused@\fR\fIuser\fR\fR
723 .ad
724 .sp .6
725 .RS 4n
726 The amount of space consumed by the specified user in this dataset. Space is
727 charged to the owner of each file, as displayed by \fBls\fR \fB-l\fR. The
728 amount of space charged is displayed by \fBdu\fR and \fBls\fR \fB-s\fR. See the
729 \fBzfs userspace\fR subcommand for more information.
730 .sp
731 Unprivileged users can access only their own space usage. The root user, or a
732 user who has been granted the \fBuserused\fR privilege with \fBzfs allow\fR,
733 can access everyone's usage.
734 .sp
735 The \fBuserused@\fR... properties are not displayed by \fBzfs get all\fR. The
736 user's name must be appended after the \fB@\fR symbol, using one of the
737 following forms:
738 .RS +4
739 .TP
740 .ie t \(bu
741 .el o
742 \fIPOSIX name\fR (for example, \fBjoe\fR)
743 .RE
744 .RS +4
745 .TP
746 .ie t \(bu
747 .el o
748 \fIPOSIX numeric ID\fR (for example, \fB789\fR)
749 .RE
750 .RS +4
751 .TP
752 .ie t \(bu
753 .el o
754 \fISID name\fR (for example, \fBjoe.smith@mydomain\fR)
755 .RE
756 .RS +4
757 .TP
758 .ie t \(bu
759 .el o
760 \fISID numeric ID\fR (for example, \fBS-1-123-456-789\fR)
761 .RE
762 .RE
763
764 .sp
765 .ne 2
766 .na
767 \fB\fBuserrefs\fR\fR
768 .ad
769 .sp .6
770 .RS 4n
771 This property is set to the number of user holds on this snapshot. User holds
772 are set by using the \fBzfs hold\fR command.
773 .RE
774
775 .sp
776 .ne 2
777 .na
778 \fB\fBgroupused@\fR\fIgroup\fR\fR
779 .ad
780 .sp .6
781 .RS 4n
782 The amount of space consumed by the specified group in this dataset. Space is
783 charged to the group of each file, as displayed by \fBls\fR \fB-l\fR. See the
784 \fBuserused@\fR\fIuser\fR property for more information.
785 .sp
786 Unprivileged users can only access their own groups' space usage. The root
787 user, or a user who has been granted the \fBgroupused\fR privilege with \fBzfs
788 allow\fR, can access all groups' usage.
789 .RE
790
791 .sp
792 .ne 2
793 .na
794 \fB\fBvolblocksize\fR=\fIblocksize\fR\fR
795 .ad
796 .sp .6
797 .RS 4n
798 For volumes, specifies the block size of the volume. The \fBblocksize\fR cannot
799 be changed once the volume has been written, so it should be set at volume
800 creation time. The default \fBblocksize\fR for volumes is 8 Kbytes. Any power
801 of 2 from 512 bytes to 128 Kbytes is valid.
802 .sp
803 This property can also be referred to by its shortened column name,
804 \fBvolblock\fR.
805 .RE
806
807 .sp
808 .ne 2
809 .na
810 \fB\fBwritten\fR\fR
811 .ad
812 .sp .6
813 .RS 4n
814 The amount of \fBreferenced\fR space written to this dataset since the
815 previous snapshot.
816 .RE
817
818 .sp
819 .ne 2
820 .na
821 \fB\fBwritten@\fR\fIsnapshot\fR\fR
822 .ad
823 .sp .6
824 .RS 4n
825 The amount of \fBreferenced\fR space written to this dataset since the
826 specified snapshot. This is the space that is referenced by this dataset
827 but was not referenced by the specified snapshot.
828 .sp
829 The \fIsnapshot\fR may be specified as a short snapshot name (just the part
830 after the \fB@\fR), in which case it will be interpreted as a snapshot in
831 the same filesystem as this dataset.
832 The \fIsnapshot\fR be a full snapshot name (\fIfilesystem\fR@\fIsnapshot\fR),
833 which for clones may be a snapshot in the origin's filesystem (or the origin
834 of the origin's filesystem, etc).
835 .RE
836
837 .sp
838 .LP
839 The following native properties can be used to change the behavior of a
840 \fBZFS\fR dataset.
841 .sp
842 .ne 2
843 .na
844 \fB\fBaclinherit\fR=\fBdiscard\fR | \fBnoallow\fR | \fBrestricted\fR |
845 \fBpassthrough\fR | \fBpassthrough-x\fR\fR
846 .ad
847 .sp .6
848 .RS 4n
849 Controls how \fBACL\fR entries are inherited when files and directories are
850 created. A file system with an \fBaclinherit\fR property of \fBdiscard\fR does
851 not inherit any \fBACL\fR entries. A file system with an \fBaclinherit\fR
852 property value of \fBnoallow\fR only inherits inheritable \fBACL\fR entries
853 that specify "deny" permissions. The property value \fBrestricted\fR (the
854 default) removes the \fBwrite_acl\fR and \fBwrite_owner\fR permissions when the
855 \fBACL\fR entry is inherited. A file system with an \fBaclinherit\fR property
856 value of \fBpassthrough\fR inherits all inheritable \fBACL\fR entries without
857 any modifications made to the \fBACL\fR entries when they are inherited. A file
858 system with an \fBaclinherit\fR property value of \fBpassthrough-x\fR has the
859 same meaning as \fBpassthrough\fR, except that the \fBowner@\fR, \fBgroup@\fR,
860 and \fBeveryone@\fR \fBACE\fRs inherit the execute permission only if the file
861 creation mode also requests the execute bit.
862 .sp
863 When the property value is set to \fBpassthrough\fR, files are created with a
864 mode determined by the inheritable \fBACE\fRs. If no inheritable \fBACE\fRs
865 exist that affect the mode, then the mode is set in accordance to the requested
866 mode from the application.
867 .RE
868
869 .sp
870 .ne 2
871 .na
872 \fB\fBaclmode\fR=\fBdiscard\fR | \fBgroupmask\fR | \fBpassthrough\fR\fR | \fBrestricted\fR\fR
873 .ad
874 .sp .6
875 .RS 4n
876 Controls how an \fBACL\fR is modified during \fBchmod\fR(2). A file system with
877 an \fBaclmode\fR property of \fBdiscard\fR (the default) deletes all \fBACL\fR
878 entries that do not represent the mode of the file. An \fBaclmode\fR property
879 of \fBgroupmask\fR reduces permissions granted in all \fBALLOW\fR entries found
880 in the \fBACL\fR such that they are no greater than the group permissions
881 specified by \fBchmod\fR(2). A file system with an \fBaclmode\fR property of
882 \fBpassthrough\fR indicates that no changes are made to the \fBACL\fR other
883 than creating or updating the necessary \fBACL\fR entries to represent the new
884 mode of the file or directory. An \fBaclmode\fR property of \fBrestricted\fR
885 will cause the \fBchmod\fR(2) operation to return an error when used on any
886 file or directory which has a non-trivial \fBACL\fR whose entries can not be
887 represented by a mode. \fBchmod\fR(2) is required to change the set user ID,
888 set group ID, or sticky bits on a file or directory, as they do not have
889 equivalent \fBACL\fR entries. In order to use \fBchmod\fR(2) on a file or
890 directory with a non-trivial \fBACL\fR when \fBaclmode\fR is set to
891 \fBrestricted\fR, you must first remove all \fBACL\fR entries which do not
892 represent the current mode.
893 .RE
894
895 .sp
896 .ne 2
897 .na
898 \fB\fBatime\fR=\fBon\fR | \fBoff\fR\fR
899 .ad
900 .sp .6
901 .RS 4n
902 Controls whether the access time for files is updated when they are read.
903 Turning this property off avoids producing write traffic when reading files and
904 can result in significant performance gains, though it might confuse mailers
905 and other similar utilities. The default value is \fBon\fR.
906 .RE
907
908 .sp
909 .ne 2
910 .na
911 \fB\fBcanmount\fR=\fBon\fR | \fBoff\fR | \fBnoauto\fR\fR
912 .ad
913 .sp .6
914 .RS 4n
915 If this property is set to \fBoff\fR, the file system cannot be mounted, and is
916 ignored by \fBzfs mount -a\fR. Setting this property to \fBoff\fR is similar to
917 setting the \fBmountpoint\fR property to \fBnone\fR, except that the dataset
918 still has a normal \fBmountpoint\fR property, which can be inherited. Setting
919 this property to \fBoff\fR allows datasets to be used solely as a mechanism to
920 inherit properties. One example of setting \fBcanmount=\fR\fBoff\fR is to have
921 two datasets with the same \fBmountpoint\fR, so that the children of both
922 datasets appear in the same directory, but might have different inherited
923 characteristics.
924 .sp
925 When the \fBnoauto\fR option is set, a dataset can only be mounted and
926 unmounted explicitly. The dataset is not mounted automatically when the dataset
927 is created or imported, nor is it mounted by the \fBzfs mount -a\fR command or
928 unmounted by the \fBzfs unmount -a\fR command.
929 .sp
930 This property is not inherited.
931 .RE
932
933 .sp
934 .ne 2
935 .na
936 \fB\fBchecksum\fR=\fBon\fR | \fBoff\fR | \fBfletcher2\fR | \fBfletcher4\fR |
937 \fBsha256\fR | \fBnoparity\fR \fR
938 .ad
939 .sp .6
940 .RS 4n
941 Controls the checksum used to verify data integrity. The default value is
942 \fBon\fR, which automatically selects an appropriate algorithm (currently,
943 \fBfletcher4\fR, but this may change in future releases). The value \fBoff\fR
944 disables integrity checking on user data. The value \fBnoparity\fR not only
945 disables integrity but also disables maintaining parity for user data. This
946 setting is used internally by a dump device residing on a RAID-Z pool and should
947 not be used by any other dataset. Disabling checksums is \fBNOT\fR a recommended
948 practice.
949 .sp
950 Changing this property affects only newly-written data.
951 .RE
952
953 .sp
954 .ne 2
955 .na
956 \fB\fBcompression\fR=\fBon\fR | \fBoff\fR | \fBlzjb\fR | \fBgzip\fR |
957 \fBgzip-\fR\fIN\fR | \fBzle\fR\fR | \fBlz4\fR
958 .ad
959 .sp .6
960 .RS 4n
961 Controls the compression algorithm used for this dataset. The \fBlzjb\fR
962 compression algorithm is optimized for performance while providing decent data
963 compression. Setting compression to \fBon\fR uses the \fBlzjb\fR compression
964 algorithm. The \fBgzip\fR compression algorithm uses the same compression as
965 the \fBgzip\fR(1) command. You can specify the \fBgzip\fR level by using the
966 value \fBgzip-\fR\fIN\fR where \fIN\fR is an integer from 1 (fastest) to 9
967 (best compression ratio). Currently, \fBgzip\fR is equivalent to \fBgzip-6\fR
968 (which is also the default for \fBgzip\fR(1)). The \fBzle\fR compression
969 algorithm compresses runs of zeros.
970 .sp
971 The \fBlz4\fR compression algorithm is a high-performance replacement
972 for the \fBlzjb\fR algorithm. It features significantly faster
973 compression and decompression, as well as a moderately higher
974 compression ratio than \fBlzjb\fR, but can only be used on pools with
975 the \fBlz4_compress\fR feature set to \fIenabled\fR. See
976 \fBzpool-features\fR(5) for details on ZFS feature flags and the
977 \fBlz4_compress\fR feature.
978 .sp
979 This property can also be referred to by its shortened column name
980 \fBcompress\fR. Changing this property affects only newly-written data.
981 .RE
982
983 .sp
984 .ne 2
985 .na
986 \fB\fBcopies\fR=\fB1\fR | \fB2\fR | \fB3\fR\fR
987 .ad
988 .sp .6
989 .RS 4n
990 Controls the number of copies of data stored for this dataset. These copies are
991 in addition to any redundancy provided by the pool, for example, mirroring or
992 RAID-Z. The copies are stored on different disks, if possible. The space used
993 by multiple copies is charged to the associated file and dataset, changing the
994 \fBused\fR property and counting against quotas and reservations.
995 .sp
996 Changing this property only affects newly-written data. Therefore, set this
997 property at file system creation time by using the \fB-o\fR
998 \fBcopies=\fR\fIN\fR option.
999 .RE
1000
1001 .sp
1002 .ne 2
1003 .na
1004 \fB\fBdevices\fR=\fBon\fR | \fBoff\fR\fR
1005 .ad
1006 .sp .6
1007 .RS 4n
1008 Controls whether device nodes can be opened on this file system. The default
1009 value is \fBon\fR.
1010 .RE
1011
1012 .sp
1013 .ne 2
1014 .na
1015 \fB\fBexec\fR=\fBon\fR | \fBoff\fR\fR
1016 .ad
1017 .sp .6
1018 .RS 4n
1019 Controls whether processes can be executed from within this file system. The
1020 default value is \fBon\fR.
1021 .RE
1022
1023 .sp
1024 .ne 2
1025 .na
1026 \fB\fBmountpoint\fR=\fIpath\fR | \fBnone\fR | \fBlegacy\fR\fR
1027 .ad
1028 .sp .6
1029 .RS 4n
1030 Controls the mount point used for this file system. See the "Mount Points"
1031 section for more information on how this property is used.
1032 .sp
1033 When the \fBmountpoint\fR property is changed for a file system, the file
1034 system and any children that inherit the mount point are unmounted. If the new
1035 value is \fBlegacy\fR, then they remain unmounted. Otherwise, they are
1036 automatically remounted in the new location if the property was previously
1037 \fBlegacy\fR or \fBnone\fR, or if they were mounted before the property was
1038 changed. In addition, any shared file systems are unshared and shared in the
1039 new location.
1040 .RE
1041
1042 .sp
1043 .ne 2
1044 .na
1045 \fB\fBnbmand\fR=\fBon\fR | \fBoff\fR\fR
1046 .ad
1047 .sp .6
1048 .RS 4n
1049 Controls whether the file system should be mounted with \fBnbmand\fR (Non
1050 Blocking mandatory locks). This is used for \fBCIFS\fR clients. Changes to this
1051 property only take effect when the file system is umounted and remounted. See
1052 \fBmount\fR(1M) for more information on \fBnbmand\fR mounts.
1053 .RE
1054
1055 .sp
1056 .ne 2
1057 .na
1058 \fB\fBprimarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR
1059 .ad
1060 .sp .6
1061 .RS 4n
1062 Controls what is cached in the primary cache (ARC). If this property is set to
1063 \fBall\fR, then both user data and metadata is cached. If this property is set
1064 to \fBnone\fR, then neither user data nor metadata is cached. If this property
1065 is set to \fBmetadata\fR, then only metadata is cached. The default value is
1066 \fBall\fR.
1067 .RE
1068
1069 .sp
1070 .ne 2
1071 .na
1072 \fB\fBquota\fR=\fIsize\fR | \fBnone\fR\fR
1073 .ad
1074 .sp .6
1075 .RS 4n
1076 Limits the amount of space a dataset and its descendents can consume. This
1077 property enforces a hard limit on the amount of space used. This includes all
1078 space consumed by descendents, including file systems and snapshots. Setting a
1079 quota on a descendent of a dataset that already has a quota does not override
1080 the ancestor's quota, but rather imposes an additional limit.
1081 .sp
1082 Quotas cannot be set on volumes, as the \fBvolsize\fR property acts as an
1083 implicit quota.
1084 .RE
1085
1086 .sp
1087 .ne 2
1088 .na
1089 \fB\fBuserquota@\fR\fIuser\fR=\fIsize\fR | \fBnone\fR\fR
1090 .ad
1091 .sp .6
1092 .RS 4n
1093 Limits the amount of space consumed by the specified user. User space
1094 consumption is identified by the \fBuserspace@\fR\fIuser\fR property.
1095 .sp
1096 Enforcement of user quotas may be delayed by several seconds. This delay means
1097 that a user might exceed their quota before the system notices that they are
1098 over quota and begins to refuse additional writes with the \fBEDQUOT\fR error
1099 message . See the \fBzfs userspace\fR subcommand for more information.
1100 .sp
1101 Unprivileged users can only access their own groups' space usage. The root
1102 user, or a user who has been granted the \fBuserquota\fR privilege with \fBzfs
1103 allow\fR, can get and set everyone's quota.
1104 .sp
1105 This property is not available on volumes, on file systems before version 4, or
1106 on pools before version 15. The \fBuserquota@\fR... properties are not
1107 displayed by \fBzfs get all\fR. The user's name must be appended after the
1108 \fB@\fR symbol, using one of the following forms:
1109 .RS +4
1110 .TP
1111 .ie t \(bu
1112 .el o
1113 \fIPOSIX name\fR (for example, \fBjoe\fR)
1114 .RE
1115 .RS +4
1116 .TP
1117 .ie t \(bu
1118 .el o
1119 \fIPOSIX numeric ID\fR (for example, \fB789\fR)
1120 .RE
1121 .RS +4
1122 .TP
1123 .ie t \(bu
1124 .el o
1125 \fISID name\fR (for example, \fBjoe.smith@mydomain\fR)
1126 .RE
1127 .RS +4
1128 .TP
1129 .ie t \(bu
1130 .el o
1131 \fISID numeric ID\fR (for example, \fBS-1-123-456-789\fR)
1132 .RE
1133 .RE
1134
1135 .sp
1136 .ne 2
1137 .na
1138 \fB\fBgroupquota@\fR\fIgroup\fR=\fIsize\fR | \fBnone\fR\fR
1139 .ad
1140 .sp .6
1141 .RS 4n
1142 Limits the amount of space consumed by the specified group. Group space
1143 consumption is identified by the \fBuserquota@\fR\fIuser\fR property.
1144 .sp
1145 Unprivileged users can access only their own groups' space usage. The root
1146 user, or a user who has been granted the \fBgroupquota\fR privilege with \fBzfs
1147 allow\fR, can get and set all groups' quotas.
1148 .RE
1149
1150 .sp
1151 .ne 2
1152 .na
1153 \fB\fBreadonly\fR=\fBon\fR | \fBoff\fR\fR
1154 .ad
1155 .sp .6
1156 .RS 4n
1157 Controls whether this dataset can be modified. The default value is \fBoff\fR.
1158 .sp
1159 This property can also be referred to by its shortened column name,
1160 \fBrdonly\fR.
1161 .RE
1162
1163 .sp
1164 .ne 2
1165 .na
1166 \fB\fBrecordsize\fR=\fIsize\fR\fR
1167 .ad
1168 .sp .6
1169 .RS 4n
1170 Specifies a suggested block size for files in the file system. This property is
1171 designed solely for use with database workloads that access files in fixed-size
1172 records. \fBZFS\fR automatically tunes block sizes according to internal
1173 algorithms optimized for typical access patterns.
1174 .sp
1175 For databases that create very large files but access them in small random
1176 chunks, these algorithms may be suboptimal. Specifying a \fBrecordsize\fR
1177 greater than or equal to the record size of the database can result in
1178 significant performance gains. Use of this property for general purpose file
1179 systems is strongly discouraged, and may adversely affect performance.
1180 .sp
1181 The size specified must be a power of two greater than or equal to 512 and less
1182 than or equal to 128 Kbytes.
1183 .sp
1184 Changing the file system's \fBrecordsize\fR affects only files created
1185 afterward; existing files are unaffected.
1186 .sp
1187 This property can also be referred to by its shortened column name,
1188 \fBrecsize\fR.
1189 .RE
1190
1191 .sp
1192 .ne 2
1193 .na
1194 \fB\fBrefquota\fR=\fIsize\fR | \fBnone\fR\fR
1195 .ad
1196 .sp .6
1197 .RS 4n
1198 Limits the amount of space a dataset can consume. This property enforces a hard
1199 limit on the amount of space used. This hard limit does not include space used
1200 by descendents, including file systems and snapshots.
1201 .RE
1202
1203 .sp
1204 .ne 2
1205 .na
1206 \fB\fBrefreservation\fR=\fIsize\fR | \fBnone\fR\fR
1207 .ad
1208 .sp .6
1209 .RS 4n
1210 The minimum amount of space guaranteed to a dataset, not including its
1211 descendents. When the amount of space used is below this value, the dataset is
1212 treated as if it were taking up the amount of space specified by
1213 \fBrefreservation\fR. The \fBrefreservation\fR reservation is accounted for in
1214 the parent datasets' space used, and counts against the parent datasets' quotas
1215 and reservations.
1216 .sp
1217 If \fBrefreservation\fR is set, a snapshot is only allowed if there is enough
1218 free pool space outside of this reservation to accommodate the current number
1219 of "referenced" bytes in the dataset.
1220 .sp
1221 This property can also be referred to by its shortened column name,
1222 \fBrefreserv\fR.
1223 .RE
1224
1225 .sp
1226 .ne 2
1227 .na
1228 \fB\fBreservation\fR=\fIsize\fR | \fBnone\fR\fR
1229 .ad
1230 .sp .6
1231 .RS 4n
1232 The minimum amount of space guaranteed to a dataset and its descendents. When
1233 the amount of space used is below this value, the dataset is treated as if it
1234 were taking up the amount of space specified by its reservation. Reservations
1235 are accounted for in the parent datasets' space used, and count against the
1236 parent datasets' quotas and reservations.
1237 .sp
1238 This property can also be referred to by its shortened column name,
1239 \fBreserv\fR.
1240 .RE
1241
1242 .sp
1243 .ne 2
1244 .na
1245 \fB\fBsecondarycache\fR=\fBall\fR | \fBnone\fR | \fBmetadata\fR\fR
1246 .ad
1247 .sp .6
1248 .RS 4n
1249 Controls what is cached in the secondary cache (L2ARC). If this property is set
1250 to \fBall\fR, then both user data and metadata is cached. If this property is
1251 set to \fBnone\fR, then neither user data nor metadata is cached. If this
1252 property is set to \fBmetadata\fR, then only metadata is cached. The default
1253 value is \fBall\fR.
1254 .RE
1255
1256 .sp
1257 .ne 2
1258 .na
1259 \fB\fBsetuid\fR=\fBon\fR | \fBoff\fR\fR
1260 .ad
1261 .sp .6
1262 .RS 4n
1263 Controls whether the set-\fBUID\fR bit is respected for the file system. The
1264 default value is \fBon\fR.
1265 .RE
1266
1267 .sp
1268 .ne 2
1269 .na
1270 \fB\fBshareiscsi\fR=\fBon\fR | \fBoff\fR\fR
1271 .ad
1272 .sp .6
1273 .RS 4n
1274 Like the \fBsharenfs\fR property, \fBshareiscsi\fR indicates whether a
1275 \fBZFS\fR volume is exported as an \fBiSCSI\fR target. The acceptable values
1276 for this property are \fBon\fR, \fBoff\fR, and \fBtype=disk\fR. The default
1277 value is \fBoff\fR. In the future, other target types might be supported. For
1278 example, \fBtape\fR.
1279 .sp
1280 You might want to set \fBshareiscsi=on\fR for a file system so that all
1281 \fBZFS\fR volumes within the file system are shared by default. However,
1282 setting this property on a file system has no direct effect.
1283 .RE
1284
1285 .sp
1286 .ne 2
1287 .na
1288 \fB\fBsharesmb\fR=\fBon\fR | \fBoff\fR | \fIopts\fR\fR
1289 .ad
1290 .sp .6
1291 .RS 4n
1292 Controls whether the file system is shared by using the Solaris \fBCIFS\fR
1293 service, and what options are to be used. A file system with the \fBsharesmb\fR
1294 property set to \fBoff\fR is managed through traditional tools such as
1295 \fBsharemgr\fR(1M). Otherwise, the file system is automatically shared and
1296 unshared with the \fBzfs share\fR and \fBzfs unshare\fR commands. If the
1297 property is set to \fBon\fR, the \fBsharemgr\fR(1M) command is invoked with no
1298 options. Otherwise, the \fBsharemgr\fR(1M) command is invoked with options
1299 equivalent to the contents of this property.
1300 .sp
1301 Because \fBSMB\fR shares requires a resource name, a unique resource name is
1302 constructed from the dataset name. The constructed name is a copy of the
1303 dataset name except that the characters in the dataset name, which would be
1304 illegal in the resource name, are replaced with underscore (\fB_\fR)
1305 characters. A pseudo property "name" is also supported that allows you to
1306 replace the data set name with a specified name. The specified name is then
1307 used to replace the prefix dataset in the case of inheritance. For example, if
1308 the dataset \fBdata/home/john\fR is set to \fBname=john\fR, then
1309 \fBdata/home/john\fR has a resource name of \fBjohn\fR. If a child dataset of
1310 \fBdata/home/john/backups\fR, it has a resource name of \fBjohn_backups\fR.
1311 .sp
1312 When SMB shares are created, the SMB share name appears as an entry in the
1313 \fB\&.zfs/shares\fR directory. You can use the \fBls\fR or \fBchmod\fR command
1314 to display the share-level ACLs on the entries in this directory.
1315 .sp
1316 When the \fBsharesmb\fR property is changed for a dataset, the dataset and any
1317 children inheriting the property are re-shared with the new options, only if
1318 the property was previously set to \fBoff\fR, or if they were shared before the
1319 property was changed. If the new property is set to \fBoff\fR, the file systems
1320 are unshared.
1321 .RE
1322
1323 .sp
1324 .ne 2
1325 .na
1326 \fB\fBsharenfs\fR=\fBon\fR | \fBoff\fR | \fIopts\fR\fR
1327 .ad
1328 .sp .6
1329 .RS 4n
1330 Controls whether the file system is shared via \fBNFS\fR, and what options are
1331 used. A file system with a \fBsharenfs\fR property of \fBoff\fR is managed
1332 through traditional tools such as \fBshare\fR(1M), \fBunshare\fR(1M), and
1333 \fBdfstab\fR(4). Otherwise, the file system is automatically shared and
1334 unshared with the \fBzfs share\fR and \fBzfs unshare\fR commands. If the
1335 property is set to \fBon\fR, the \fBshare\fR(1M) command is invoked with no
1336 options. Otherwise, the \fBshare\fR(1M) command is invoked with options
1337 equivalent to the contents of this property.
1338 .sp
1339 When the \fBsharenfs\fR property is changed for a dataset, the dataset and any
1340 children inheriting the property are re-shared with the new options, only if
1341 the property was previously \fBoff\fR, or if they were shared before the
1342 property was changed. If the new property is \fBoff\fR, the file systems are
1343 unshared.
1344 .RE
1345
1346 .sp
1347 .ne 2
1348 .na
1349 \fB\fBlogbias\fR = \fBlatency\fR | \fBthroughput\fR\fR
1350 .ad
1351 .sp .6
1352 .RS 4n
1353 Provide a hint to ZFS about handling of synchronous requests in this dataset.
1354 If \fBlogbias\fR is set to \fBlatency\fR (the default), ZFS will use pool log
1355 devices (if configured) to handle the requests at low latency. If \fBlogbias\fR
1356 is set to \fBthroughput\fR, ZFS will not use configured pool log devices. ZFS
1357 will instead optimize synchronous operations for global pool throughput and
1358 efficient use of resources.
1359 .RE
1360
1361 .sp
1362 .ne 2
1363 .na
1364 \fB\fBsnapdir\fR=\fBhidden\fR | \fBvisible\fR\fR
1365 .ad
1366 .sp .6
1367 .RS 4n
1368 Controls whether the \fB\&.zfs\fR directory is hidden or visible in the root of
1369 the file system as discussed in the "Snapshots" section. The default value is
1370 \fBhidden\fR.
1371 .RE
1372
1373 .sp
1374 .ne 2
1375 .na
1376 \fB\fBsync\fR=\fBdefault\fR | \fBalways\fR | \fBdisabled\fR\fR
1377 .ad
1378 .sp .6
1379 .RS 4n
1380 Controls the behavior of synchronous requests (e.g. fsync, O_DSYNC).
1381 \fBdefault\fR is the POSIX specified behavior of ensuring all synchronous
1382 requests are written to stable storage and all devices are flushed to ensure
1383 data is not cached by device controllers (this is the default). \fBalways\fR
1384 causes every file system transaction to be written and flushed before its
1385 system call returns. This has a large performance penalty. \fBdisabled\fR
1386 disables synchronous requests. File system transactions are only committed to
1387 stable storage periodically. This option will give the highest performance.
1388 However, it is very dangerous as ZFS would be ignoring the synchronous
1389 transaction demands of applications such as databases or NFS. Administrators
1390 should only use this option when the risks are understood.
1391 .RE
1392
1393 .sp
1394 .ne 2
1395 .na
1396 \fB\fBversion\fR=\fB1\fR | \fB2\fR | \fBcurrent\fR\fR
1397 .ad
1398 .sp .6
1399 .RS 4n
1400 The on-disk version of this file system, which is independent of the pool
1401 version. This property can only be set to later supported versions. See the
1402 \fBzfs upgrade\fR command.
1403 .RE
1404
1405 .sp
1406 .ne 2
1407 .na
1408 \fB\fBvolsize\fR=\fIsize\fR\fR
1409 .ad
1410 .sp .6
1411 .RS 4n
1412 For volumes, specifies the logical size of the volume. By default, creating a
1413 volume establishes a reservation of equal size. For storage pools with a
1414 version number of 9 or higher, a \fBrefreservation\fR is set instead. Any
1415 changes to \fBvolsize\fR are reflected in an equivalent change to the
1416 reservation (or \fBrefreservation\fR). The \fBvolsize\fR can only be set to a
1417 multiple of \fBvolblocksize\fR, and cannot be zero.
1418 .sp
1419 The reservation is kept equal to the volume's logical size to prevent
1420 unexpected behavior for consumers. Without the reservation, the volume could
1421 run out of space, resulting in undefined behavior or data corruption, depending
1422 on how the volume is used. These effects can also occur when the volume size is
1423 changed while it is in use (particularly when shrinking the size). Extreme care
1424 should be used when adjusting the volume size.
1425 .sp
1426 Though not recommended, a "sparse volume" (also known as "thin provisioning")
1427 can be created by specifying the \fB-s\fR option to the \fBzfs create -V\fR
1428 command, or by changing the reservation after the volume has been created. A
1429 "sparse volume" is a volume where the reservation is less then the volume size.
1430 Consequently, writes to a sparse volume can fail with \fBENOSPC\fR when the
1431 pool is low on space. For a sparse volume, changes to \fBvolsize\fR are not
1432 reflected in the reservation.
1433 .RE
1434
1435 .sp
1436 .ne 2
1437 .na
1438 \fB\fBvscan\fR=\fBon\fR | \fBoff\fR\fR
1439 .ad
1440 .sp .6
1441 .RS 4n
1442 Controls whether regular files should be scanned for viruses when a file is
1443 opened and closed. In addition to enabling this property, the virus scan
1444 service must also be enabled for virus scanning to occur. The default value is
1445 \fBoff\fR.
1446 .RE
1447
1448 .sp
1449 .ne 2
1450 .na
1451 \fB\fBxattr\fR=\fBon\fR | \fBoff\fR\fR
1452 .ad
1453 .sp .6
1454 .RS 4n
1455 Controls whether extended attributes are enabled for this file system. The
1456 default value is \fBon\fR.
1457 .RE
1458
1459 .sp
1460 .ne 2
1461 .na
1462 \fB\fBzoned\fR=\fBon\fR | \fBoff\fR\fR
1463 .ad
1464 .sp .6
1465 .RS 4n
1466 Controls whether the dataset is managed from a non-global zone. See the "Zones"
1467 section for more information. The default value is \fBoff\fR.
1468 .RE
1469
1470 .sp
1471 .LP
1472 The following three properties cannot be changed after the file system is
1473 created, and therefore, should be set when the file system is created. If the
1474 properties are not set with the \fBzfs create\fR or \fBzpool create\fR
1475 commands, these properties are inherited from the parent dataset. If the parent
1476 dataset lacks these properties due to having been created prior to these
1477 features being supported, the new file system will have the default values for
1478 these properties.
1479 .sp
1480 .ne 2
1481 .na
1482 \fB\fBcasesensitivity\fR=\fBsensitive\fR | \fBinsensitive\fR | \fBmixed\fR\fR
1483 .ad
1484 .sp .6
1485 .RS 4n
1486 Indicates whether the file name matching algorithm used by the file system
1487 should be case-sensitive, case-insensitive, or allow a combination of both
1488 styles of matching. The default value for the \fBcasesensitivity\fR property is
1489 \fBsensitive\fR. Traditionally, UNIX and POSIX file systems have case-sensitive
1490 file names.
1491 .sp
1492 The \fBmixed\fR value for the \fBcasesensitivity\fR property indicates that the
1493 file system can support requests for both case-sensitive and case-insensitive
1494 matching behavior. Currently, case-insensitive matching behavior on a file
1495 system that supports mixed behavior is limited to the Solaris CIFS server
1496 product. For more information about the \fBmixed\fR value behavior, see the
1497 \fISolaris ZFS Administration Guide\fR.
1498 .RE
1499
1500 .sp
1501 .ne 2
1502 .na
1503 \fB\fBnormalization\fR = \fBnone\fR | \fBformC\fR | \fBformD\fR | \fBformKC\fR
1504 | \fBformKD\fR\fR
1505 .ad
1506 .sp .6
1507 .RS 4n
1508 Indicates whether the file system should perform a \fBunicode\fR normalization
1509 of file names whenever two file names are compared, and which normalization
1510 algorithm should be used. File names are always stored unmodified, names are
1511 normalized as part of any comparison process. If this property is set to a
1512 legal value other than \fBnone\fR, and the \fButf8only\fR property was left
1513 unspecified, the \fButf8only\fR property is automatically set to \fBon\fR. The
1514 default value of the \fBnormalization\fR property is \fBnone\fR. This property
1515 cannot be changed after the file system is created.
1516 .RE
1517
1518 .sp
1519 .ne 2
1520 .na
1521 \fB\fButf8only\fR=\fBon\fR | \fBoff\fR\fR
1522 .ad
1523 .sp .6
1524 .RS 4n
1525 Indicates whether the file system should reject file names that include
1526 characters that are not present in the \fBUTF-8\fR character code set. If this
1527 property is explicitly set to \fBoff\fR, the normalization property must either
1528 not be explicitly set or be set to \fBnone\fR. The default value for the
1529 \fButf8only\fR property is \fBoff\fR. This property cannot be changed after the
1530 file system is created.
1531 .RE
1532
1533 .sp
1534 .LP
1535 The \fBcasesensitivity\fR, \fBnormalization\fR, and \fButf8only\fR properties
1536 are also new permissions that can be assigned to non-privileged users by using
1537 the \fBZFS\fR delegated administration feature.
1538 .SS "Temporary Mount Point Properties"
1539 .sp
1540 .LP
1541 When a file system is mounted, either through \fBmount\fR(1M) for legacy mounts
1542 or the \fBzfs mount\fR command for normal file systems, its mount options are
1543 set according to its properties. The correlation between properties and mount
1544 options is as follows:
1545 .sp
1546 .in +2
1547 .nf
1548 PROPERTY MOUNT OPTION
1549 devices devices/nodevices
1550 exec exec/noexec
1551 readonly ro/rw
1552 setuid setuid/nosetuid
1553 xattr xattr/noxattr
1554 .fi
1555 .in -2
1556 .sp
1557
1558 .sp
1559 .LP
1560 In addition, these options can be set on a per-mount basis using the \fB-o\fR
1561 option, without affecting the property that is stored on disk. The values
1562 specified on the command line override the values stored in the dataset. The
1563 \fB-nosuid\fR option is an alias for \fBnodevices,nosetuid\fR. These properties
1564 are reported as "temporary" by the \fBzfs get\fR command. If the properties are
1565 changed while the dataset is mounted, the new setting overrides any temporary
1566 settings.
1567 .SS "User Properties"
1568 .sp
1569 .LP
1570 In addition to the standard native properties, \fBZFS\fR supports arbitrary
1571 user properties. User properties have no effect on \fBZFS\fR behavior, but
1572 applications or administrators can use them to annotate datasets (file systems,
1573 volumes, and snapshots).
1574 .sp
1575 .LP
1576 User property names must contain a colon (\fB:\fR) character to distinguish
1577 them from native properties. They may contain lowercase letters, numbers, and
1578 the following punctuation characters: colon (\fB:\fR), dash (\fB-\fR), period
1579 (\fB\&.\fR), and underscore (\fB_\fR). The expected convention is that the
1580 property name is divided into two portions such as
1581 \fImodule\fR\fB:\fR\fIproperty\fR, but this namespace is not enforced by
1582 \fBZFS\fR. User property names can be at most 256 characters, and cannot begin
1583 with a dash (\fB-\fR).
1584 .sp
1585 .LP
1586 When making programmatic use of user properties, it is strongly suggested to
1587 use a reversed \fBDNS\fR domain name for the \fImodule\fR component of property
1588 names to reduce the chance that two independently-developed packages use the
1589 same property name for different purposes. Property names beginning with
1590 \fBcom.sun\fR. are reserved for use by Sun Microsystems.
1591 .sp
1592 .LP
1593 The values of user properties are arbitrary strings, are always inherited, and
1594 are never validated. All of the commands that operate on properties (\fBzfs
1595 list\fR, \fBzfs get\fR, \fBzfs set\fR, and so forth) can be used to manipulate
1596 both native properties and user properties. Use the \fBzfs inherit\fR command
1597 to clear a user property . If the property is not defined in any parent
1598 dataset, it is removed entirely. Property values are limited to 1024
1599 characters.
1600 .SS "ZFS Volumes as Swap or Dump Devices"
1601 .sp
1602 .LP
1603 During an initial installation a swap device and dump device are created on
1604 \fBZFS\fR volumes in the \fBZFS\fR root pool. By default, the swap area size is
1605 based on 1/2 the size of physical memory up to 2 Gbytes. The size of the dump
1606 device depends on the kernel's requirements at installation time. Separate
1607 \fBZFS\fR volumes must be used for the swap area and dump devices. Do not swap
1608 to a file on a \fBZFS\fR file system. A \fBZFS\fR swap file configuration is
1609 not supported.
1610 .sp
1611 .LP
1612 If you need to change your swap area or dump device after the system is
1613 installed or upgraded, use the \fBswap\fR(1M) and \fBdumpadm\fR(1M) commands.
1614 If you need to change the size of your swap area or dump device, see the
1615 \fISolaris ZFS Administration Guide\fR.
1616 .SH SUBCOMMANDS
1617 .sp
1618 .LP
1619 All subcommands that modify state are logged persistently to the pool in their
1620 original form.
1621 .sp
1622 .ne 2
1623 .na
1624 \fB\fBzfs ?\fR\fR
1625 .ad
1626 .sp .6
1627 .RS 4n
1628 Displays a help message.
1629 .RE
1630
1631 .sp
1632 .ne 2
1633 .na
1634 \fB\fBzfs create\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]...
1635 \fIfilesystem\fR\fR
1636 .ad
1637 .sp .6
1638 .RS 4n
1639 Creates a new \fBZFS\fR file system. The file system is automatically mounted
1640 according to the \fBmountpoint\fR property inherited from the parent.
1641 .sp
1642 .ne 2
1643 .na
1644 \fB\fB-p\fR\fR
1645 .ad
1646 .sp .6
1647 .RS 4n
1648 Creates all the non-existing parent datasets. Datasets created in this manner
1649 are automatically mounted according to the \fBmountpoint\fR property inherited
1650 from their parent. Any property specified on the command line using the
1651 \fB-o\fR option is ignored. If the target filesystem already exists, the
1652 operation completes successfully.
1653 .RE
1654
1655 .sp
1656 .ne 2
1657 .na
1658 \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1659 .ad
1660 .sp .6
1661 .RS 4n
1662 Sets the specified property as if the command \fBzfs set\fR
1663 \fIproperty\fR=\fIvalue\fR was invoked at the same time the dataset was
1664 created. Any editable \fBZFS\fR property can also be set at creation time.
1665 Multiple \fB-o\fR options can be specified. An error results if the same
1666 property is specified in multiple \fB-o\fR options.
1667 .RE
1668
1669 .RE
1670
1671 .sp
1672 .ne 2
1673 .na
1674 \fB\fBzfs create\fR [\fB-ps\fR] [\fB-b\fR \fIblocksize\fR] [\fB-o\fR
1675 \fIproperty\fR=\fIvalue\fR]... \fB-V\fR \fIsize\fR \fIvolume\fR\fR
1676 .ad
1677 .sp .6
1678 .RS 4n
1679 Creates a volume of the given size. The volume is exported as a block device in
1680 \fB/dev/zvol/{dsk,rdsk}/\fR\fIpath\fR, where \fIpath\fR is the name of the
1681 volume in the \fBZFS\fR namespace. The size represents the logical size as
1682 exported by the device. By default, a reservation of equal size is created.
1683 .sp
1684 \fIsize\fR is automatically rounded up to the nearest 128 Kbytes to ensure that
1685 the volume has an integral number of blocks regardless of \fIblocksize\fR.
1686 .sp
1687 .ne 2
1688 .na
1689 \fB\fB-p\fR\fR
1690 .ad
1691 .sp .6
1692 .RS 4n
1693 Creates all the non-existing parent datasets. Datasets created in this manner
1694 are automatically mounted according to the \fBmountpoint\fR property inherited
1695 from their parent. Any property specified on the command line using the
1696 \fB-o\fR option is ignored. If the target filesystem already exists, the
1697 operation completes successfully.
1698 .RE
1699
1700 .sp
1701 .ne 2
1702 .na
1703 \fB\fB-s\fR\fR
1704 .ad
1705 .sp .6
1706 .RS 4n
1707 Creates a sparse volume with no reservation. See \fBvolsize\fR in the Native
1708 Properties section for more information about sparse volumes.
1709 .RE
1710
1711 .sp
1712 .ne 2
1713 .na
1714 \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1715 .ad
1716 .sp .6
1717 .RS 4n
1718 Sets the specified property as if the \fBzfs set\fR \fIproperty\fR=\fIvalue\fR
1719 command was invoked at the same time the dataset was created. Any editable
1720 \fBZFS\fR property can also be set at creation time. Multiple \fB-o\fR options
1721 can be specified. An error results if the same property is specified in
1722 multiple \fB-o\fR options.
1723 .RE
1724
1725 .sp
1726 .ne 2
1727 .na
1728 \fB\fB-b\fR \fIblocksize\fR\fR
1729 .ad
1730 .sp .6
1731 .RS 4n
1732 Equivalent to \fB-o\fR \fBvolblocksize\fR=\fIblocksize\fR. If this option is
1733 specified in conjunction with \fB-o\fR \fBvolblocksize\fR, the resulting
1734 behavior is undefined.
1735 .RE
1736
1737 .RE
1738
1739 .sp
1740 .ne 2
1741 .na
1742 \fBzfs destroy\fR [\fB-fnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR
1743 .ad
1744 .sp .6
1745 .RS 4n
1746 Destroys the given dataset. By default, the command unshares any file systems
1747 that are currently shared, unmounts any file systems that are currently
1748 mounted, and refuses to destroy a dataset that has active dependents (children
1749 or clones).
1750 .sp
1751 .ne 2
1752 .na
1753 \fB\fB-r\fR\fR
1754 .ad
1755 .sp .6
1756 .RS 4n
1757 Recursively destroy all children.
1758 .RE
1759
1760 .sp
1761 .ne 2
1762 .na
1763 \fB\fB-R\fR\fR
1764 .ad
1765 .sp .6
1766 .RS 4n
1767 Recursively destroy all dependents, including cloned file systems outside the
1768 target hierarchy.
1769 .RE
1770
1771 .sp
1772 .ne 2
1773 .na
1774 \fB\fB-f\fR\fR
1775 .ad
1776 .sp .6
1777 .RS 4n
1778 Force an unmount of any file systems using the \fBunmount -f\fR command. This
1779 option has no effect on non-file systems or unmounted file systems.
1780 .RE
1781
1782 .sp
1783 .ne 2
1784 .na
1785 \fB\fB-n\fR\fR
1786 .ad
1787 .sp .6
1788 .RS 4n
1789 Do a dry-run ("No-op") deletion. No data will be deleted. This is
1790 useful in conjunction with the \fB-v\fR or \fB-p\fR flags to determine what
1791 data would be deleted.
1792 .RE
1793
1794 .sp
1795 .ne 2
1796 .na
1797 \fB\fB-p\fR\fR
1798 .ad
1799 .sp .6
1800 .RS 4n
1801 Print machine-parsable verbose information about the deleted data.
1802 .RE
1803
1804 .sp
1805 .ne 2
1806 .na
1807 \fB\fB-v\fR\fR
1808 .ad
1809 .sp .6
1810 .RS 4n
1811 Print verbose information about the deleted data.
1812 .RE
1813 .sp
1814 Extreme care should be taken when applying either the \fB-r\fR or the \fB-R\fR
1815 options, as they can destroy large portions of a pool and cause unexpected
1816 behavior for mounted file systems in use.
1817 .RE
1818
1819 .sp
1820 .ne 2
1821 .na
1822 \fBzfs destroy\fR [\fB-dnpRrv\fR] \fIfilesystem\fR|\fIvolume\fR@\fIsnap\fR[%\fIsnap\fR][,\fIsnap\fR[%\fIsnap\fR]]...
1823 .ad
1824 .sp .6
1825 .RS 4n
1826 The given snapshots are destroyed immediately if and only if the \fBzfs
1827 destroy\fR command without the \fB-d\fR option would have destroyed it. Such
1828 immediate destruction would occur, for example, if the snapshot had no clones
1829 and the user-initiated reference count were zero.
1830 .sp
1831 If a snapshot does not qualify for immediate destruction, it is marked for
1832 deferred deletion. In this state, it exists as a usable, visible snapshot until
1833 both of the preconditions listed above are met, at which point it is destroyed.
1834 .sp
1835 An inclusive range of snapshots may be specified by separating the
1836 first and last snapshots with a percent sign.
1837 The first and/or last snapshots may be left blank, in which case the
1838 filesystem's oldest or newest snapshot will be implied.
1839 .sp
1840 Multiple snapshots
1841 (or ranges of snapshots) of the same filesystem or volume may be specified
1842 in a comma-separated list of snapshots.
1843 Only the snapshot's short name (the
1844 part after the \fB@\fR) should be specified when using a range or
1845 comma-separated list to identify multiple snapshots.
1846 .sp
1847 .ne 2
1848 .na
1849 \fB\fB-d\fR\fR
1850 .ad
1851 .sp .6
1852 .RS 4n
1853 Defer snapshot deletion.
1854 .RE
1855
1856 .sp
1857 .ne 2
1858 .na
1859 \fB\fB-r\fR\fR
1860 .ad
1861 .sp .6
1862 .RS 4n
1863 Destroy (or mark for deferred deletion) all snapshots with this name in
1864 descendent file systems.
1865 .RE
1866
1867 .sp
1868 .ne 2
1869 .na
1870 \fB\fB-R\fR\fR
1871 .ad
1872 .sp .6
1873 .RS 4n
1874 Recursively destroy all clones of these snapshots, including the clones,
1875 snapshots, and children. If this flag is specified, the \fB-d\fR flag will
1876 have no effect.
1877 .RE
1878
1879 .sp
1880 .ne 2
1881 .na
1882 \fB\fB-n\fR\fR
1883 .ad
1884 .sp .6
1885 .RS 4n
1886 Do a dry-run ("No-op") deletion. No data will be deleted. This is
1887 useful in conjunction with the \fB-v\fR or \fB-p\fR flags to determine what
1888 data would be deleted.
1889 .RE
1890
1891 .sp
1892 .ne 2
1893 .na
1894 \fB\fB-p\fR\fR
1895 .ad
1896 .sp .6
1897 .RS 4n
1898 Print machine-parsable verbose information about the deleted data.
1899 .RE
1900
1901 .sp
1902 .ne 2
1903 .na
1904 \fB\fB-v\fR\fR
1905 .ad
1906 .sp .6
1907 .RS 4n
1908 Print verbose information about the deleted data.
1909 .RE
1910
1911 .sp
1912 Extreme care should be taken when applying either the \fB-r\fR or the \fB-R\fR
1913 options, as they can destroy large portions of a pool and cause unexpected
1914 behavior for mounted file systems in use.
1915 .RE
1916
1917 .sp
1918 .ne 2
1919 .na
1920 \fB\fBzfs snapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]...
1921 \fIfilesystem@snapname\fR|\fIvolume@snapname\fR\fR...
1922 .ad
1923 .sp .6
1924 .RS 4n
1925 Creates snapshots with the given names. All previous modifications by
1926 successful system calls to the file system are part of the snapshots.
1927 Snapshots are taken atomically, so that all snapshots correspond to the same
1928 moment in time. See the "Snapshots" section for details.
1929 .sp
1930 .ne 2
1931 .na
1932 \fB\fB-r\fR\fR
1933 .ad
1934 .sp .6
1935 .RS 4n
1936 Recursively create snapshots of all descendent datasets
1937 .RE
1938
1939 .sp
1940 .ne 2
1941 .na
1942 \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1943 .ad
1944 .sp .6
1945 .RS 4n
1946 Sets the specified property; see \fBzfs create\fR for details.
1947 .RE
1948
1949 .RE
1950
1951 .sp
1952 .ne 2
1953 .na
1954 \fB\fBzfs rollback\fR [\fB-rRf\fR] \fIsnapshot\fR\fR
1955 .ad
1956 .sp .6
1957 .RS 4n
1958 Roll back the given dataset to a previous snapshot. When a dataset is rolled
1959 back, all data that has changed since the snapshot is discarded, and the
1960 dataset reverts to the state at the time of the snapshot. By default, the
1961 command refuses to roll back to a snapshot other than the most recent one. In
1962 order to do so, all intermediate snapshots must be destroyed by specifying the
1963 \fB-r\fR option.
1964 .sp
1965 The \fB-rR\fR options do not recursively destroy the child snapshots of a
1966 recursive snapshot. Only the top-level recursive snapshot is destroyed by
1967 either of these options. To completely roll back a recursive snapshot, you must
1968 rollback the individual child snapshots.
1969 .sp
1970 .ne 2
1971 .na
1972 \fB\fB-r\fR\fR
1973 .ad
1974 .sp .6
1975 .RS 4n
1976 Recursively destroy any snapshots more recent than the one specified.
1977 .RE
1978
1979 .sp
1980 .ne 2
1981 .na
1982 \fB\fB-R\fR\fR
1983 .ad
1984 .sp .6
1985 .RS 4n
1986 Recursively destroy any more recent snapshots, as well as any clones of those
1987 snapshots.
1988 .RE
1989
1990 .sp
1991 .ne 2
1992 .na
1993 \fB\fB-f\fR\fR
1994 .ad
1995 .sp .6
1996 .RS 4n
1997 Used with the \fB-R\fR option to force an unmount of any clone file systems
1998 that are to be destroyed.
1999 .RE
2000
2001 .RE
2002
2003 .sp
2004 .ne 2
2005 .na
2006 \fB\fBzfs clone\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]...
2007 \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR\fR
2008 .ad
2009 .sp .6
2010 .RS 4n
2011 Creates a clone of the given snapshot. See the "Clones" section for details.
2012 The target dataset can be located anywhere in the \fBZFS\fR hierarchy, and is
2013 created as the same type as the original.
2014 .sp
2015 .ne 2
2016 .na
2017 \fB\fB-p\fR\fR
2018 .ad
2019 .sp .6
2020 .RS 4n
2021 Creates all the non-existing parent datasets. Datasets created in this manner
2022 are automatically mounted according to the \fBmountpoint\fR property inherited
2023 from their parent. If the target filesystem or volume already exists, the
2024 operation completes successfully.
2025 .RE
2026
2027 .sp
2028 .ne 2
2029 .na
2030 \fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
2031 .ad
2032 .sp .6
2033 .RS 4n
2034 Sets the specified property; see \fBzfs create\fR for details.
2035 .RE
2036
2037 .RE
2038
2039 .sp
2040 .ne 2
2041 .na
2042 \fB\fBzfs promote\fR \fIclone-filesystem\fR\fR
2043 .ad
2044 .sp .6
2045 .RS 4n
2046 Promotes a clone file system to no longer be dependent on its "origin"
2047 snapshot. This makes it possible to destroy the file system that the clone was
2048 created from. The clone parent-child dependency relationship is reversed, so
2049 that the origin file system becomes a clone of the specified file system.
2050 .sp
2051 The snapshot that was cloned, and any snapshots previous to this snapshot, are
2052 now owned by the promoted clone. The space they use moves from the origin file
2053 system to the promoted clone, so enough space must be available to accommodate
2054 these snapshots. No new space is consumed by this operation, but the space
2055 accounting is adjusted. The promoted clone must not have any conflicting
2056 snapshot names of its own. The \fBrename\fR subcommand can be used to rename
2057 any conflicting snapshots.
2058 .RE
2059
2060 .sp
2061 .ne 2
2062 .na
2063 \fB\fBzfs rename\fR [\fB-f\fR] \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
2064 .ad
2065 .br
2066 .na
2067 \fB\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
2068 .ad
2069 .br
2070 .na
2071 \fB\fBzfs rename\fR [\fB-fp\fR] \fIfilesystem\fR|\fIvolume\fR
2072 \fIfilesystem\fR|\fIvolume\fR\fR
2073 .ad
2074 .sp .6
2075 .RS 4n
2076 Renames the given dataset. The new target can be located anywhere in the
2077 \fBZFS\fR hierarchy, with the exception of snapshots. Snapshots can only be
2078 renamed within the parent file system or volume. When renaming a snapshot, the
2079 parent file system of the snapshot does not need to be specified as part of the
2080 second argument. Renamed file systems can inherit new mount points, in which
2081 case they are unmounted and remounted at the new mount point.
2082 .sp
2083 .ne 2
2084 .na
2085 \fB\fB-p\fR\fR
2086 .ad
2087 .sp .6
2088 .RS 4n
2089 Creates all the nonexistent parent datasets. Datasets created in this manner
2090 are automatically mounted according to the \fBmountpoint\fR property inherited
2091 from their parent.
2092 .RE
2093
2094 .sp
2095 .ne 2
2096 .na
2097 \fB\fB-f\fR\fR
2098 .ad
2099 .sp .6
2100 .RS 4n
2101 Force unmount any filesystems that need to be unmounted in the process.
2102 .RE
2103
2104 .RE
2105
2106 .sp
2107 .ne 2
2108 .na
2109 \fB\fBzfs rename\fR \fB-r\fR \fIsnapshot\fR \fIsnapshot\fR\fR
2110 .ad
2111 .sp .6
2112 .RS 4n
2113 Recursively rename the snapshots of all descendent datasets. Snapshots are the
2114 only dataset that can be renamed recursively.
2115 .RE
2116
2117 .sp
2118 .ne 2
2119 .na
2120 \fB\fBzfs\fR \fBlist\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-H\fR] [\fB-o\fR
2121 \fIproperty\fR[,\fIproperty\fR]...] [ \fB-t\fR \fItype\fR[,\fItype\fR]...] [ \fB-s\fR
2122 \fIproperty\fR ]... [ \fB-S\fR \fIproperty\fR ]...
2123 [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR]...\fR
2124 .ad
2125 .sp .6
2126 .RS 4n
2127 Lists the property information for the given datasets in tabular form. If
2128 specified, you can list property information by the absolute pathname or the
2129 relative pathname. By default, all file systems and volumes are displayed.
2130 Snapshots are displayed if the \fBlistsnaps\fR property is \fBon\fR (the
2131 default is \fBoff\fR) . The following fields are displayed,
2132 \fBname,used,available,referenced,mountpoint\fR.
2133 .sp
2134 .ne 2
2135 .na
2136 \fB\fB-H\fR\fR
2137 .ad
2138 .sp .6
2139 .RS 4n
2140 Used for scripting mode. Do not print headers and separate fields by a single
2141 tab instead of arbitrary white space.
2142 .RE
2143
2144 .sp
2145 .ne 2
2146 .na
2147 \fB\fB-r\fR\fR
2148 .ad
2149 .sp .6
2150 .RS 4n
2151 Recursively display any children of the dataset on the command line.
2152 .RE
2153
2154 .sp
2155 .ne 2
2156 .na
2157 \fB\fB-d\fR \fIdepth\fR\fR
2158 .ad
2159 .sp .6
2160 .RS 4n
2161 Recursively display any children of the dataset, limiting the recursion to
2162 \fIdepth\fR. A depth of \fB1\fR will display only the dataset and its direct
2163 children.
2164 .RE
2165
2166 .sp
2167 .ne 2
2168 .na
2169 \fB\fB-o\fR \fIproperty\fR\fR
2170 .ad
2171 .sp .6
2172 .RS 4n
2173 A comma-separated list of properties to display. The property must be:
2174 .RS +4
2175 .TP
2176 .ie t \(bu
2177 .el o
2178 One of the properties described in the "Native Properties" section
2179 .RE
2180 .RS +4
2181 .TP
2182 .ie t \(bu
2183 .el o
2184 A user property
2185 .RE
2186 .RS +4
2187 .TP
2188 .ie t \(bu
2189 .el o
2190 The value \fBname\fR to display the dataset name
2191 .RE
2192 .RS +4
2193 .TP
2194 .ie t \(bu
2195 .el o
2196 The value \fBspace\fR to display space usage properties on file systems and
2197 volumes. This is a shortcut for specifying \fB-o
2198 name,avail,used,usedsnap,usedds,usedrefreserv,usedchild\fR \fB-t
2199 filesystem,volume\fR syntax.
2200 .RE
2201 .RE
2202
2203 .sp
2204 .ne 2
2205 .na
2206 \fB\fB-s\fR \fIproperty\fR\fR
2207 .ad
2208 .sp .6
2209 .RS 4n
2210 A property for sorting the output by column in ascending order based on the
2211 value of the property. The property must be one of the properties described in
2212 the "Properties" section, or the special value \fBname\fR to sort by the
2213 dataset name. Multiple properties can be specified at one time using multiple
2214 \fB-s\fR property options. Multiple \fB-s\fR options are evaluated from left to
2215 right in decreasing order of importance.
2216 .sp
2217 The following is a list of sorting criteria:
2218 .RS +4
2219 .TP
2220 .ie t \(bu
2221 .el o
2222 Numeric types sort in numeric order.
2223 .RE
2224 .RS +4
2225 .TP
2226 .ie t \(bu
2227 .el o
2228 String types sort in alphabetical order.
2229 .RE
2230 .RS +4
2231 .TP
2232 .ie t \(bu
2233 .el o
2234 Types inappropriate for a row sort that row to the literal bottom, regardless
2235 of the specified ordering.
2236 .RE
2237 .RS +4
2238 .TP
2239 .ie t \(bu
2240 .el o
2241 If no sorting options are specified the existing behavior of \fBzfs list\fR is
2242 preserved.
2243 .RE
2244 .RE
2245
2246 .sp
2247 .ne 2
2248 .na
2249 \fB\fB-S\fR \fIproperty\fR\fR
2250 .ad
2251 .sp .6
2252 .RS 4n
2253 Same as the \fB-s\fR option, but sorts by property in descending order.
2254 .RE
2255
2256 .sp
2257 .ne 2
2258 .na
2259 \fB\fB-t\fR \fItype\fR\fR
2260 .ad
2261 .sp .6
2262 .RS 4n
2263 A comma-separated list of types to display, where \fItype\fR is one of
2264 \fBfilesystem\fR, \fBsnapshot\fR , \fBvolume\fR, or \fBall\fR. For example,
2265 specifying \fB-t snapshot\fR displays only snapshots.
2266 .RE
2267
2268 .RE
2269
2270 .sp
2271 .ne 2
2272 .na
2273 \fB\fBzfs set\fR \fIproperty\fR=\fIvalue\fR
2274 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR...\fR
2275 .ad
2276 .sp .6
2277 .RS 4n
2278 Sets the property to the given value for each dataset. Only some properties can
2279 be edited. See the "Properties" section for more information on what properties
2280 can be set and acceptable values. Numeric values can be specified as exact
2281 values, or in a human-readable form with a suffix of \fBB\fR, \fBK\fR, \fBM\fR,
2282 \fBG\fR, \fBT\fR, \fBP\fR, \fBE\fR, \fBZ\fR (for bytes, kilobytes, megabytes,
2283 gigabytes, terabytes, petabytes, exabytes, or zettabytes, respectively). User
2284 properties can be set on snapshots. For more information, see the "User
2285 Properties" section.
2286 .RE
2287
2288 .sp
2289 .ne 2
2290 .na
2291 \fB\fBzfs get\fR [\fB-r\fR|\fB-d\fR \fIdepth\fR] [\fB-Hp\fR] [\fB-o\fR
2292 \fIfield\fR[,\fIfield\fR]... [\fB-t\fR \fItype\fR[,\fItype\fR]...] [\fB-s\fR \fIsource\fR[,\fIsource\fR]... \fBall\fR |
2293 \fIproperty\fR[,\fIproperty\fR]... \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR...\fR
2294 .ad
2295 .sp .6
2296 .RS 4n
2297 Displays properties for the given datasets. If no datasets are specified, then
2298 the command displays properties for all datasets on the system. For each
2299 property, the following columns are displayed:
2300 .sp
2301 .in +2
2302 .nf
2303 name Dataset name
2304 property Property name
2305 value Property value
2306 source Property source. Can either be local, default,
2307 temporary, inherited, or none (-).
2308 .fi
2309 .in -2
2310 .sp
2311
2312 All columns are displayed by default, though this can be controlled by using
2313 the \fB-o\fR option. This command takes a comma-separated list of properties as
2314 described in the "Native Properties" and "User Properties" sections.
2315 .sp
2316 The special value \fBall\fR can be used to display all properties that apply to
2317 the given dataset's type (filesystem, volume, or snapshot).
2318 .sp
2319 .ne 2
2320 .na
2321 \fB\fB-r\fR\fR
2322 .ad
2323 .sp .6
2324 .RS 4n
2325 Recursively display properties for any children.
2326 .RE
2327
2328 .sp
2329 .ne 2
2330 .na
2331 \fB\fB-d\fR \fIdepth\fR\fR
2332 .ad
2333 .sp .6
2334 .RS 4n
2335 Recursively display any children of the dataset, limiting the recursion to
2336 \fIdepth\fR. A depth of \fB1\fR will display only the dataset and its direct
2337 children.
2338 .RE
2339
2340 .sp
2341 .ne 2
2342 .na
2343 \fB\fB-H\fR\fR
2344 .ad
2345 .sp .6
2346 .RS 4n
2347 Display output in a form more easily parsed by scripts. Any headers are
2348 omitted, and fields are explicitly separated by a single tab instead of an
2349 arbitrary amount of space.
2350 .RE
2351
2352 .sp
2353 .ne 2
2354 .na
2355 \fB\fB-o\fR \fIfield\fR\fR
2356 .ad
2357 .sp .6
2358 .RS 4n
2359 A comma-separated list of columns to display. \fBname,property,value,source\fR
2360 is the default value.
2361 .RE
2362
2363 .sp
2364 .ne 2
2365 .na
2366 \fB\fB-s\fR \fIsource\fR\fR
2367 .ad
2368 .sp .6
2369 .RS 4n
2370 A comma-separated list of sources to display. Those properties coming from a
2371 source other than those in this list are ignored. Each source must be one of
2372 the following: \fBlocal,default,inherited,temporary,none\fR. The default value
2373 is all sources.
2374 .RE
2375
2376 .sp
2377 .ne 2
2378 .na
2379 \fB\fB-p\fR\fR
2380 .ad
2381 .sp .6
2382 .RS 4n
2383 Display numbers in parseable (exact) values.
2384 .RE
2385
2386 .RE
2387
2388 .sp
2389 .ne 2
2390 .na
2391 \fB\fBzfs inherit\fR [\fB-r\fR] \fIproperty\fR
2392 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR...\fR
2393 .ad
2394 .sp .6
2395 .RS 4n
2396 Clears the specified property, causing it to be inherited from an ancestor. If
2397 no ancestor has the property set, then the default value is used. See the
2398 "Properties" section for a listing of default values, and details on which
2399 properties can be inherited.
2400 .sp
2401 .ne 2
2402 .na
2403 \fB\fB-r\fR\fR
2404 .ad
2405 .sp .6
2406 .RS 4n
2407 Recursively inherit the given property for all children.
2408 .RE
2409
2410 .RE
2411
2412 .sp
2413 .ne 2
2414 .na
2415 \fB\fBzfs upgrade\fR [\fB-v\fR]\fR
2416 .ad
2417 .sp .6
2418 .RS 4n
2419 Displays a list of file systems that are not the most recent version.
2420 .RE
2421
2422 .sp
2423 .ne 2
2424 .na
2425 \fB\fBzfs upgrade\fR [\fB-r\fR] [\fB-V\fR \fIversion\fR] [\fB-a\fR |
2426 \fIfilesystem\fR]\fR
2427 .ad
2428 .sp .6
2429 .RS 4n
2430 Upgrades file systems to a new on-disk version. Once this is done, the file
2431 systems will no longer be accessible on systems running older versions of the
2432 software. \fBzfs send\fR streams generated from new snapshots of these file
2433 systems cannot be accessed on systems running older versions of the software.
2434 .sp
2435 In general, the file system version is independent of the pool version. See
2436 \fBzpool\fR(1M) for information on the \fBzpool upgrade\fR command.
2437 .sp
2438 In some cases, the file system version and the pool version are interrelated
2439 and the pool version must be upgraded before the file system version can be
2440 upgraded.
2441 .sp
2442 .ne 2
2443 .na
2444 \fB\fB-a\fR\fR
2445 .ad
2446 .sp .6
2447 .RS 4n
2448 Upgrade all file systems on all imported pools.
2449 .RE
2450
2451 .sp
2452 .ne 2
2453 .na
2454 \fB\fIfilesystem\fR\fR
2455 .ad
2456 .sp .6
2457 .RS 4n
2458 Upgrade the specified file system.
2459 .RE
2460
2461 .sp
2462 .ne 2
2463 .na
2464 \fB\fB-r\fR\fR
2465 .ad
2466 .sp .6
2467 .RS 4n
2468 Upgrade the specified file system and all descendent file systems
2469 .RE
2470
2471 .sp
2472 .ne 2
2473 .na
2474 \fB\fB-V\fR \fIversion\fR\fR
2475 .ad
2476 .sp .6
2477 .RS 4n
2478 Upgrade to the specified \fIversion\fR. If the \fB-V\fR flag is not specified,
2479 this command upgrades to the most recent version. This option can only be used
2480 to increase the version number, and only up to the most recent version
2481 supported by this software.
2482 .RE
2483
2484 .RE
2485
2486 .sp
2487 .ne 2
2488 .na
2489 \fBzfs\fR \fBuserspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,\fIfield\fR]...]
2490 [\fB-s\fR \fIfield\fR]...
2491 [\fB-S\fR \fIfield\fR]...
2492 [\fB-t\fR \fItype\fR[,\fItype\fR]...] \fIfilesystem\fR|\fIsnapshot\fR
2493 .ad
2494 .sp .6
2495 .RS 4n
2496 Displays space consumed by, and quotas on, each user in the specified
2497 filesystem or snapshot. This corresponds to the \fBuserused@\fR\fIuser\fR and
2498 \fBuserquota@\fR\fIuser\fR properties.
2499 .sp
2500 .ne 2
2501 .na
2502 \fB\fB-n\fR\fR
2503 .ad
2504 .sp .6
2505 .RS 4n
2506 Print numeric ID instead of user/group name.
2507 .RE
2508
2509 .sp
2510 .ne 2
2511 .na
2512 \fB\fB-H\fR\fR
2513 .ad
2514 .sp .6
2515 .RS 4n
2516 Do not print headers, use tab-delimited output.
2517 .RE
2518
2519 .sp
2520 .ne 2
2521 .na
2522 \fB\fB-p\fR\fR
2523 .ad
2524 .sp .6
2525 .RS 4n
2526 Use exact (parsable) numeric output.
2527 .RE
2528
2529 .sp
2530 .ne 2
2531 .na
2532 \fB\fB-o\fR \fIfield\fR[,\fIfield\fR]...\fR
2533 .ad
2534 .sp .6
2535 .RS 4n
2536 Display only the specified fields from the following
2537 set: \fBtype, name, used, quota\fR. The default is to display all fields.
2538 .RE
2539
2540 .sp
2541 .ne 2
2542 .na
2543 \fB\fB-s\fR \fIfield\fR\fR
2544 .ad
2545 .sp .6
2546 .RS 4n
2547 Sort output by this field. The \fIs\fR and \fIS\fR flags may be specified
2548 multiple times to sort first by one field, then by another. The default is
2549 \fB-s type\fR \fB-s name\fR.
2550 .RE
2551
2552 .sp
2553 .ne 2
2554 .na
2555 \fB\fB-S\fR \fIfield\fR\fR
2556 .ad
2557 .sp .6
2558 .RS 4n
2559 Sort by this field in reverse order. See \fB-s\fR.
2560 .RE
2561
2562 .sp
2563 .ne 2
2564 .na
2565 \fB\fB-t\fR \fItype\fR[,\fItype\fR]...\fR
2566 .ad
2567 .sp .6
2568 .RS 4n
2569 Print only the specified types from the following
2570 set: \fBall, posixuser, smbuser, posixgroup, smbgroup\fR. The default
2571 is \fB-t posixuser,smbuser\fR. The default can be changed to include group
2572 types.
2573 .RE
2574
2575 .sp
2576 .ne 2
2577 .na
2578 \fB\fB-i\fR\fR
2579 .ad
2580 .sp .6
2581 .RS 4n
2582 Translate SID to POSIX ID. The POSIX ID may be ephemeral if no mapping exists.
2583 Normal POSIX interfaces (for example, \fBstat\fR(2), \fBls\fR \fB-l\fR) perform
2584 this translation, so the \fB-i\fR option allows the output from \fBzfs
2585 userspace\fR to be compared directly with those utilities. However, \fB-i\fR
2586 may lead to confusion if some files were created by an SMB user before a
2587 SMB-to-POSIX name mapping was established. In such a case, some files will be owned
2588 by the SMB entity and some by the POSIX entity. However, the \fB-i\fR option
2589 will report that the POSIX entity has the total usage and quota for both.
2590 .RE
2591
2592 .RE
2593
2594 .sp
2595 .ne 2
2596 .na
2597 \fBzfs\fR \fBgroupspace\fR [\fB-Hinp\fR] [\fB-o\fR \fIfield\fR[,\fIfield\fR]...]
2598 [\fB-s\fR \fIfield\fR]...
2599 [\fB-S\fR \fIfield\fR]...
2600 [\fB-t\fR \fItype\fR[,\fItype\fR]...] \fIfilesystem\fR|\fIsnapshot\fR
2601 .ad
2602 .sp .6
2603 .RS 4n
2604 Displays space consumed by, and quotas on, each group in the specified
2605 filesystem or snapshot. This subcommand is identical to \fBzfs userspace\fR,
2606 except that the default types to display are \fB-t posixgroup,smbgroup\fR.
2607 .RE
2608
2609 .sp
2610 .ne 2
2611 .na
2612 \fB\fBzfs mount\fR\fR
2613 .ad
2614 .sp .6
2615 .RS 4n
2616 Displays all \fBZFS\fR file systems currently mounted.
2617 .RE
2618
2619 .sp
2620 .ne 2
2621 .na
2622 \fB\fBzfs mount\fR [\fB-vO\fR] [\fB-o\fR \fIoptions\fR] \fB-a\fR |
2623 \fIfilesystem\fR\fR
2624 .ad
2625 .sp .6
2626 .RS 4n
2627 Mounts \fBZFS\fR file systems. Invoked automatically as part of the boot
2628 process.
2629 .sp
2630 .ne 2
2631 .na
2632 \fB\fB-o\fR \fIoptions\fR\fR
2633 .ad
2634 .sp .6
2635 .RS 4n
2636 An optional, comma-separated list of mount options to use temporarily for the
2637 duration of the mount. See the "Temporary Mount Point Properties" section for
2638 details.
2639 .RE
2640
2641 .sp
2642 .ne 2
2643 .na
2644 \fB\fB-O\fR\fR
2645 .ad
2646 .sp .6
2647 .RS 4n
2648 Perform an overlay mount. See \fBmount\fR(1M) for more information.
2649 .RE
2650
2651 .sp
2652 .ne 2
2653 .na
2654 \fB\fB-v\fR\fR
2655 .ad
2656 .sp .6
2657 .RS 4n
2658 Report mount progress.
2659 .RE
2660
2661 .sp
2662 .ne 2
2663 .na
2664 \fB\fB-a\fR\fR
2665 .ad
2666 .sp .6
2667 .RS 4n
2668 Mount all available \fBZFS\fR file systems. Invoked automatically as part of
2669 the boot process.
2670 .RE
2671
2672 .sp
2673 .ne 2
2674 .na
2675 \fB\fIfilesystem\fR\fR
2676 .ad
2677 .sp .6
2678 .RS 4n
2679 Mount the specified filesystem.
2680 .RE
2681
2682 .RE
2683
2684 .sp
2685 .ne 2
2686 .na
2687 \fB\fBzfs unmount\fR [\fB-f\fR] \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR
2688 .ad
2689 .sp .6
2690 .RS 4n
2691 Unmounts currently mounted \fBZFS\fR file systems. Invoked automatically as
2692 part of the shutdown process.
2693 .sp
2694 .ne 2
2695 .na
2696 \fB\fB-f\fR\fR
2697 .ad
2698 .sp .6
2699 .RS 4n
2700 Forcefully unmount the file system, even if it is currently in use.
2701 .RE
2702
2703 .sp
2704 .ne 2
2705 .na
2706 \fB\fB-a\fR\fR
2707 .ad
2708 .sp .6
2709 .RS 4n
2710 Unmount all available \fBZFS\fR file systems. Invoked automatically as part of
2711 the boot process.
2712 .RE
2713
2714 .sp
2715 .ne 2
2716 .na
2717 \fB\fIfilesystem\fR|\fImountpoint\fR\fR
2718 .ad
2719 .sp .6
2720 .RS 4n
2721 Unmount the specified filesystem. The command can also be given a path to a
2722 \fBZFS\fR file system mount point on the system.
2723 .RE
2724
2725 .RE
2726
2727 .sp
2728 .ne 2
2729 .na
2730 \fB\fBzfs share\fR \fB-a\fR | \fIfilesystem\fR\fR
2731 .ad
2732 .sp .6
2733 .RS 4n
2734 Shares available \fBZFS\fR file systems.
2735 .sp
2736 .ne 2
2737 .na
2738 \fB\fB-a\fR\fR
2739 .ad
2740 .sp .6
2741 .RS 4n
2742 Share all available \fBZFS\fR file systems. Invoked automatically as part of
2743 the boot process.
2744 .RE
2745
2746 .sp
2747 .ne 2
2748 .na
2749 \fB\fIfilesystem\fR\fR
2750 .ad
2751 .sp .6
2752 .RS 4n
2753 Share the specified filesystem according to the \fBsharenfs\fR and
2754 \fBsharesmb\fR properties. File systems are shared when the \fBsharenfs\fR or
2755 \fBsharesmb\fR property is set.
2756 .RE
2757
2758 .RE
2759
2760 .sp
2761 .ne 2
2762 .na
2763 \fB\fBzfs unshare\fR \fB-a\fR | \fIfilesystem\fR|\fImountpoint\fR\fR
2764 .ad
2765 .sp .6
2766 .RS 4n
2767 Unshares currently shared \fBZFS\fR file systems. This is invoked automatically
2768 as part of the shutdown process.
2769 .sp
2770 .ne 2
2771 .na
2772 \fB\fB-a\fR\fR
2773 .ad
2774 .sp .6
2775 .RS 4n
2776 Unshare all available \fBZFS\fR file systems. Invoked automatically as part of
2777 the boot process.
2778 .RE
2779
2780 .sp
2781 .ne 2
2782 .na
2783 \fB\fIfilesystem\fR|\fImountpoint\fR\fR
2784 .ad
2785 .sp .6
2786 .RS 4n
2787 Unshare the specified filesystem. The command can also be given a path to a
2788 \fBZFS\fR file system shared on the system.
2789 .RE
2790
2791 .RE
2792
2793 .sp
2794 .ne 2
2795 .na
2796 \fBzfs send\fR [\fB-DnPpRv\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
2797 .ad
2798 .sp .6
2799 .RS 4n
2800 Creates a stream representation of the second \fIsnapshot\fR, which is written
2801 to standard output. The output can be redirected to a file or to a different
2802 system (for example, using \fBssh\fR(1). By default, a full stream is
2803 generated.
2804 .sp
2805 .ne 2
2806 .na
2807 \fB\fB-i\fR \fIsnapshot\fR\fR
2808 .ad
2809 .sp .6
2810 .RS 4n
2811 Generate an incremental stream from the first \fIsnapshot\fR to the second
2812 \fIsnapshot\fR. The incremental source (the first \fIsnapshot\fR) can be
2813 specified as the last component of the snapshot name (for example, the part
2814 after the \fB@\fR), and it is assumed to be from the same file system as the
2815 second \fIsnapshot\fR.
2816 .sp
2817 If the destination is a clone, the source may be the origin snapshot, which
2818 must be fully specified (for example, \fBpool/fs@origin\fR, not just
2819 \fB@origin\fR).
2820 .RE
2821
2822 .sp
2823 .ne 2
2824 .na
2825 \fB\fB-I\fR \fIsnapshot\fR\fR
2826 .ad
2827 .sp .6
2828 .RS 4n
2829 Generate a stream package that sends all intermediary snapshots from the first
2830 snapshot to the second snapshot. For example, \fB-I @a fs@d\fR is similar to
2831 \fB-i @a fs@b; -i @b fs@c; -i @c fs@d\fR. The incremental source snapshot may
2832 be specified as with the \fB-i\fR option.
2833 .RE
2834
2835 .sp
2836 .ne 2
2837 .na
2838 \fB\fB-R\fR\fR
2839 .ad
2840 .sp .6
2841 .RS 4n
2842 Generate a replication stream package, which will replicate the specified
2843 filesystem, and all descendent file systems, up to the named snapshot. When
2844 received, all properties, snapshots, descendent file systems, and clones are
2845 preserved.
2846 .sp
2847 If the \fB-i\fR or \fB-I\fR flags are used in conjunction with the \fB-R\fR
2848 flag, an incremental replication stream is generated. The current values of
2849 properties, and current snapshot and file system names are set when the stream
2850 is received. If the \fB-F\fR flag is specified when this stream is received,
2851 snapshots and file systems that do not exist on the sending side are destroyed.
2852 .RE
2853
2854 .sp
2855 .ne 2
2856 .na
2857 \fB\fB-D\fR\fR
2858 .ad
2859 .sp .6
2860 .RS 4n
2861 Generate a deduplicated stream. Blocks which would have been sent multiple
2862 times in the send stream will only be sent once. The receiving system must
2863 also support this feature to recieve a deduplicated stream. This flag can
2864 be used regardless of the dataset's \fBdedup\fR property, but performance
2865 will be much better if the filesystem uses a dedup-capable checksum (eg.
2866 \fBsha256\fR).
2867 .RE
2868
2869 .sp
2870 .ne 2
2871 .na
2872 \fB\fB-p\fR\fR
2873 .ad
2874 .sp .6
2875 .RS 4n
2876 Include the dataset's properties in the stream. This flag is implicit when
2877 \fB-R\fR is specified. The receiving system must also support this feature.
2878 .RE
2879
2880 .sp
2881 .ne 2
2882 .na
2883 \fB\fB-n\fR\fR
2884 .ad
2885 .sp .6
2886 .RS 4n
2887 Do a dry-run ("No-op") send. Do not generate any actual send data. This is
2888 useful in conjunction with the \fB-v\fR or \fB-P\fR flags to determine what
2889 data will be sent.
2890 .RE
2891
2892 .sp
2893 .ne 2
2894 .na
2895 \fB\fB-P\fR\fR
2896 .ad
2897 .sp .6
2898 .RS 4n
2899 Print machine-parsable verbose information about the stream package generated.
2900 .RE
2901
2902 .sp
2903 .ne 2
2904 .na
2905 \fB\fB-v\fR\fR
2906 .ad
2907 .sp .6
2908 .RS 4n
2909 Print verbose information about the stream package generated. This information
2910 includes a per-second report of how much data has been sent.
2911 .RE
2912
2913 The format of the stream is committed. You will be able to receive your streams
2914 on future versions of \fBZFS\fR.
2915 .RE
2916
2917 .sp
2918 .ne 2
2919 .na
2920 \fB\fBzfs receive\fR [\fB-vnFu\fR]
2921 \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR\fR
2922 .ad
2923 .br
2924 .na
2925 \fB\fBzfs receive\fR [\fB-vnFu\fR] [\fB-d\fR|\fB-e\fR] \fIfilesystem\fR\fR
2926 .ad
2927 .sp .6
2928 .RS 4n
2929 Creates a snapshot whose contents are as specified in the stream provided on
2930 standard input. If a full stream is received, then a new file system is created
2931 as well. Streams are created using the \fBzfs send\fR subcommand, which by
2932 default creates a full stream. \fBzfs recv\fR can be used as an alias for
2933 \fBzfs receive\fR.
2934 .sp
2935 If an incremental stream is received, then the destination file system must
2936 already exist, and its most recent snapshot must match the incremental stream's
2937 source. For \fBzvols\fR, the destination device link is destroyed and
2938 recreated, which means the \fBzvol\fR cannot be accessed during the
2939 \fBreceive\fR operation.
2940 .sp
2941 When a snapshot replication package stream that is generated by using the
2942 \fBzfs send\fR \fB-R\fR command is received, any snapshots that do not exist
2943 on the sending location are destroyed by using the \fBzfs destroy\fR \fB-d\fR
2944 command.
2945 .sp
2946 The name of the snapshot (and file system, if a full stream is received) that
2947 this subcommand creates depends on the argument type and the use of the
2948 \fB-d\fR or \fB-e\fR options.
2949 .sp
2950 If the argument is a snapshot name, the specified \fIsnapshot\fR is created. If
2951 the argument is a file system or volume name, a snapshot with the same name as
2952 the sent snapshot is created within the specified \fIfilesystem\fR or
2953 \fIvolume\fR. If neither of the \fB-d\fR or \fB-e\fR options are specified,
2954 the provided target snapshot name is used exactly as provided.
2955 .sp
2956 The \fB-d\fR and \fB-e\fR options cause the file system name of the target
2957 snapshot to be determined by appending a portion of the sent snapshot's name to
2958 the specified target \fIfilesystem\fR. If the \fB-d\fR option is specified, all
2959 but the first element of the sent snapshot's file system path (usually the
2960 pool name) is used and any required intermediate file systems within the
2961 specified one are created. If the \fB-e\fR option is specified, then only the
2962 last element of the sent snapshot's file system name (i.e. the name of the
2963 source file system itself) is used as the target file system name.
2964 .sp
2965 .ne 2
2966 .na
2967 \fB\fB-d\fR\fR
2968 .ad
2969 .sp .6
2970 .RS 4n
2971 Discard the first element of the sent snapshot's file system name, using
2972 the remaining elements to determine the name of the target file system for
2973 the new snapshot as described in the paragraph above.
2974 .RE
2975
2976 .sp
2977 .ne 2
2978 .na
2979 \fB\fB-e\fR\fR
2980 .ad
2981 .sp .6
2982 .RS 4n
2983 Discard all but the last element of the sent snapshot's file system name,
2984 using that element to determine the name of the target file system for
2985 the new snapshot as described in the paragraph above.
2986 .RE
2987
2988 .sp
2989 .ne 2
2990 .na
2991 \fB\fB-u\fR\fR
2992 .ad
2993 .sp .6
2994 .RS 4n
2995 File system that is associated with the received stream is not mounted.
2996 .RE
2997
2998 .sp
2999 .ne 2
3000 .na
3001 \fB\fB-v\fR\fR
3002 .ad
3003 .sp .6
3004 .RS 4n
3005 Print verbose information about the stream and the time required to perform the
3006 receive operation.
3007 .RE
3008
3009 .sp
3010 .ne 2
3011 .na
3012 \fB\fB-n\fR\fR
3013 .ad
3014 .sp .6
3015 .RS 4n
3016 Do not actually receive the stream. This can be useful in conjunction with the
3017 \fB-v\fR option to verify the name the receive operation would use.
3018 .RE
3019
3020 .sp
3021 .ne 2
3022 .na
3023 \fB\fB-F\fR\fR
3024 .ad
3025 .sp .6
3026 .RS 4n
3027 Force a rollback of the file system to the most recent snapshot before
3028 performing the receive operation. If receiving an incremental replication
3029 stream (for example, one generated by \fBzfs send -R -[iI]\fR), destroy
3030 snapshots and file systems that do not exist on the sending side.
3031 .RE
3032
3033 .RE
3034
3035 .sp
3036 .ne 2
3037 .na
3038 \fB\fBzfs allow\fR \fIfilesystem\fR | \fIvolume\fR\fR
3039 .ad
3040 .sp .6
3041 .RS 4n
3042 Displays permissions that have been delegated on the specified filesystem or
3043 volume. See the other forms of \fBzfs allow\fR for more information.
3044 .RE
3045
3046 .sp
3047 .ne 2
3048 .na
3049 \fB\fBzfs allow\fR [\fB-ldug\fR] \fIuser\fR|\fIgroup\fR[,\fIuser\fR|\fIgroup\fR]...
3050 \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]... \fIfilesystem\fR|\fIvolume\fR\fR
3051 .ad
3052 .br
3053 .na
3054 \fB\fBzfs allow\fR [\fB-ld\fR] \fB-e\fR|\fBeveryone\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...
3055 \fIfilesystem\fR|\fIvolume\fR\fR
3056 .ad
3057 .sp .6
3058 .RS 4n
3059 Delegates \fBZFS\fR administration permission for the file systems to
3060 non-privileged users.
3061 .sp
3062 .ne 2
3063 .na
3064 [\fB-ug\fR] \fIuser\fR|\fIgroup\fR[,\fIuser\fR|\fIgroup\fR]...
3065 .ad
3066 .sp .6
3067 .RS 4n
3068 Specifies to whom the permissions are delegated. Multiple entities can be
3069 specified as a comma-separated list. If neither of the \fB-ug\fR options are
3070 specified, then the argument is interpreted preferentially as the keyword
3071 \fBeveryone,\fR then as a user name, and lastly as a group name. To specify a user
3072 or group named "everyone", use the \fB-u\fR or \fB-g\fR options. To specify a
3073 group with the same name as a user, use the \fB-g\fR options.
3074 .RE
3075
3076 .sp
3077 .ne 2
3078 .na
3079 \fB-e\fR|\fBeveryone\fR
3080 .ad
3081 .sp .6
3082 .RS 4n
3083 Specifies that the permissions be delegated to everyone.
3084 .RE
3085
3086 .sp
3087 .ne 2
3088 .na
3089 \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...
3090 .ad
3091 .sp .6
3092 .RS 4n
3093 The permissions to delegate. Multiple permissions
3094 may be specified as a comma-separated list. Permission names are the same as
3095 \fBZFS\fR subcommand and property names. See the property list below. Property
3096 set names, which begin with an at sign (\fB@\fR) , may be specified. See the
3097 \fB-s\fR form below for details.
3098 .RE
3099
3100 .sp
3101 .ne 2
3102 .na
3103 [\fB-ld\fR] \fIfilesystem\fR|\fIvolume\fR
3104 .ad
3105 .sp .6
3106 .RS 4n
3107 Specifies where the permissions are delegated. If neither of the \fB-ld\fR
3108 options are specified, or both are, then the permissions are allowed for the
3109 file system or volume, and all of its descendents. If only the \fB-l\fR option
3110 is used, then is allowed "locally" only for the specified file system. If only
3111 the \fB-d\fR option is used, then is allowed only for the descendent file
3112 systems.
3113 .RE
3114
3115 .RE
3116
3117 .sp
3118 .LP
3119 Permissions are generally the ability to use a \fBZFS\fR subcommand or change a
3120 \fBZFS\fR property. The following permissions are available:
3121 .sp
3122 .in +2
3123 .nf
3124 NAME TYPE NOTES
3125 allow subcommand Must also have the permission that is being
3126 allowed
3127 clone subcommand Must also have the 'create' ability and 'mount'
3128 ability in the origin file system
3129 create subcommand Must also have the 'mount' ability
3130 destroy subcommand Must also have the 'mount' ability
3131 diff subcommand Allows lookup of paths within a dataset
3132 given an object number, and the ability to
3133 create snapshots necessary to 'zfs diff'.
3134 mount subcommand Allows mount/umount of ZFS datasets
3135 promote subcommand Must also have the 'mount'
3136 and 'promote' ability in the origin file system
3137 receive subcommand Must also have the 'mount' and 'create' ability
3138 rename subcommand Must also have the 'mount' and 'create'
3139 ability in the new parent
3140 rollback subcommand Must also have the 'mount' ability
3141 send subcommand
3142 share subcommand Allows sharing file systems over NFS or SMB
3143 protocols
3144 snapshot subcommand Must also have the 'mount' ability
3145 groupquota other Allows accessing any groupquota@... property
3146 groupused other Allows reading any groupused@... property
3147 userprop other Allows changing any user property
3148 userquota other Allows accessing any userquota@... property
3149 userused other Allows reading any userused@... property
3150
3151 aclinherit property
3152 aclmode property
3153 atime property
3154 canmount property
3155 casesensitivity property
3156 checksum property
3157 compression property
3158 copies property
3159 devices property
3160 exec property
3161 mountpoint property
3162 nbmand property
3163 normalization property
3164 primarycache property
3165 quota property
3166 readonly property
3167 recordsize property
3168 refquota property
3169 refreservation property
3170 reservation property
3171 secondarycache property
3172 setuid property
3173 shareiscsi property
3174 sharenfs property
3175 sharesmb property
3176 snapdir property
3177 utf8only property
3178 version property
3179 volblocksize property
3180 volsize property
3181 vscan property
3182 xattr property
3183 zoned property
3184 .fi
3185 .in -2
3186 .sp
3187
3188 .sp
3189 .ne 2
3190 .na
3191 \fB\fBzfs allow\fR \fB-c\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...
3192 \fIfilesystem\fR|\fIvolume\fR\fR
3193 .ad
3194 .sp .6
3195 .RS 4n
3196 Sets "create time" permissions. These permissions are granted (locally) to the
3197 creator of any newly-created descendent file system.
3198 .RE
3199
3200 .sp
3201 .ne 2
3202 .na
3203 \fB\fBzfs allow\fR \fB-s\fR @\fIsetname\fR \fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...
3204 \fIfilesystem\fR|\fIvolume\fR\fR
3205 .ad
3206 .sp .6
3207 .RS 4n
3208 Defines or adds permissions to a permission set. The set can be used by other
3209 \fBzfs allow\fR commands for the specified file system and its descendents.
3210 Sets are evaluated dynamically, so changes to a set are immediately reflected.
3211 Permission sets follow the same naming restrictions as ZFS file systems, but
3212 the name must begin with an "at sign" (\fB@\fR), and can be no more than 64
3213 characters long.
3214 .RE
3215
3216 .sp
3217 .ne 2
3218 .na
3219 \fB\fBzfs unallow\fR [\fB-rldug\fR] \fIuser\fR|\fIgroup\fR[,\fIuser\fR|\fIgroup\fR]...
3220 [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...] \fIfilesystem\fR|\fIvolume\fR\fR
3221 .ad
3222 .br
3223 .na
3224 \fB\fBzfs unallow\fR [\fB-rld\fR] \fB-e\fR|\fBeveryone\fR [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...]
3225 \fIfilesystem\fR|\fIvolume\fR\fR
3226 .ad
3227 .br
3228 .na
3229 \fB\fBzfs unallow\fR [\fB-r\fR] \fB-c\fR [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...]\fR
3230 .ad
3231 .br
3232 .na
3233 \fB\fIfilesystem\fR|\fIvolume\fR\fR
3234 .ad
3235 .sp .6
3236 .RS 4n
3237 Removes permissions that were granted with the \fBzfs allow\fR command. No
3238 permissions are explicitly denied, so other permissions granted are still in
3239 effect. For example, if the permission is granted by an ancestor. If no
3240 permissions are specified, then all permissions for the specified \fIuser\fR,
3241 \fIgroup\fR, or everyone are removed. Specifying \fBeveryone\fR (or using the
3242 \fB-e\fR option) only removes the permissions that were granted to everyone,
3243 not all permissions for every user and group. See the \fBzfs allow\fR command
3244 for a description of the \fB-ldugec\fR options.
3245 .sp
3246 .ne 2
3247 .na
3248 \fB\fB-r\fR\fR
3249 .ad
3250 .sp .6
3251 .RS 4n
3252 Recursively remove the permissions from this file system and all descendents.
3253 .RE
3254
3255 .RE
3256
3257 .sp
3258 .ne 2
3259 .na
3260 \fB\fBzfs unallow\fR [\fB-r\fR] \fB-s\fR @\fIsetname\fR
3261 [\fIperm\fR|@\fIsetname\fR[,\fIperm\fR|@\fIsetname\fR]...]\fR
3262 .ad
3263 .br
3264 .na
3265 \fB\fIfilesystem\fR|\fIvolume\fR\fR
3266 .ad
3267 .sp .6
3268 .RS 4n
3269 Removes permissions from a permission set. If no permissions are specified,
3270 then all permissions are removed, thus removing the set entirely.
3271 .RE
3272
3273 .sp
3274 .ne 2
3275 .na
3276 \fB\fBzfs hold\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR
3277 .ad
3278 .sp .6
3279 .RS 4n
3280 Adds a single reference, named with the \fItag\fR argument, to the specified
3281 snapshot or snapshots. Each snapshot has its own tag namespace, and tags must
3282 be unique within that space.
3283 .sp
3284 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
3285 \fBzfs destroy\fR command return \fBEBUSY\fR.
3286 .sp
3287 .ne 2
3288 .na
3289 \fB\fB-r\fR\fR
3290 .ad
3291 .sp .6
3292 .RS 4n
3293 Specifies that a hold with the given tag is applied recursively to the
3294 snapshots of all descendent file systems.
3295 .RE
3296
3297 .RE
3298
3299 .sp
3300 .ne 2
3301 .na
3302 \fB\fBzfs holds\fR [\fB-r\fR] \fIsnapshot\fR...\fR
3303 .ad
3304 .sp .6
3305 .RS 4n
3306 Lists all existing user references for the given snapshot or snapshots.
3307 .sp
3308 .ne 2
3309 .na
3310 \fB\fB-r\fR\fR
3311 .ad
3312 .sp .6
3313 .RS 4n
3314 Lists the holds that are set on the named descendent snapshots, in addition to
3315 listing the holds on the named snapshot.
3316 .RE
3317
3318 .RE
3319
3320 .sp
3321 .ne 2
3322 .na
3323 \fB\fBzfs release\fR [\fB-r\fR] \fItag\fR \fIsnapshot\fR...\fR
3324 .ad
3325 .sp .6
3326 .RS 4n
3327 Removes a single reference, named with the \fItag\fR argument, from the
3328 specified snapshot or snapshots. The tag must already exist for each snapshot.
3329 .sp
3330 If a hold exists on a snapshot, attempts to destroy that snapshot by using the
3331 \fBzfs destroy\fR command return \fBEBUSY\fR.
3332 .sp
3333 .ne 2
3334 .na
3335 \fB\fB-r\fR\fR
3336 .ad
3337 .sp .6
3338 .RS 4n
3339 Recursively releases a hold with the given tag on the snapshots of all
3340 descendent file systems.
3341 .RE
3342
3343 .sp
3344 .ne 2
3345 .na
3346 \fBzfs diff\fR [\fB-FHt\fR] \fIsnapshot\fR \fIsnapshot|filesystem\fR
3347 .ad
3348 .sp .6
3349 .RS 4n
3350 Display the difference between a snapshot of a given filesystem and another
3351 snapshot of that filesystem from a later time or the current contents of the
3352 filesystem. The first column is a character indicating the type of change,
3353 the other columns indicate pathname, new pathname (in case of rename), change
3354 in link count, and optionally file type and/or change time.
3355
3356 The types of change are:
3357 .in +2
3358 .nf
3359 - The path has been removed
3360 + The path has been created
3361 M The path has been modified
3362 R The path has been renamed
3363 .fi
3364 .in -2
3365 .sp
3366 .ne 2
3367 .na
3368 \fB-F\fR
3369 .ad
3370 .sp .6
3371 .RS 4n
3372 Display an indication of the type of file, in a manner similar to the \fB-F\fR
3373 option of \fBls\fR(1).
3374 .in +2
3375 .nf
3376 B Block device
3377 C Character device
3378 / Directory
3379 > Door
3380 | Named pipe
3381 @ Symbolic link
3382 P Event port
3383 = Socket
3384 F Regular file
3385 .fi
3386 .in -2
3387 .RE
3388 .sp
3389 .ne 2
3390 .na
3391 \fB-H\fR
3392 .ad
3393 .sp .6
3394 .RS 4n
3395 Give more parseable tab-separated output, without header lines and without arrows.
3396 .RE
3397 .sp
3398 .ne 2
3399 .na
3400 \fB-t\fR
3401 .ad
3402 .sp .6
3403 .RS 4n
3404 Display the path's inode change time as the first column of output.
3405 .RE
3406
3407 .SH EXAMPLES
3408 .LP
3409 \fBExample 1 \fRCreating a ZFS File System Hierarchy
3410 .sp
3411 .LP
3412 The following commands create a file system named \fBpool/home\fR and a file
3413 system named \fBpool/home/bob\fR. The mount point \fB/export/home\fR is set for
3414 the parent file system, and is automatically inherited by the child file
3415 system.
3416
3417 .sp
3418 .in +2
3419 .nf
3420 # \fBzfs create pool/home\fR
3421 # \fBzfs set mountpoint=/export/home pool/home\fR
3422 # \fBzfs create pool/home/bob\fR
3423 .fi
3424 .in -2
3425 .sp
3426
3427 .LP
3428 \fBExample 2 \fRCreating a ZFS Snapshot
3429 .sp
3430 .LP
3431 The following command creates a snapshot named \fByesterday\fR. This snapshot
3432 is mounted on demand in the \fB\&.zfs/snapshot\fR directory at the root of the
3433 \fBpool/home/bob\fR file system.
3434
3435 .sp
3436 .in +2
3437 .nf
3438 # \fBzfs snapshot pool/home/bob@yesterday\fR
3439 .fi
3440 .in -2
3441 .sp
3442
3443 .LP
3444 \fBExample 3 \fRCreating and Destroying Multiple Snapshots
3445 .sp
3446 .LP
3447 The following command creates snapshots named \fByesterday\fR of
3448 \fBpool/home\fR and all of its descendent file systems. Each snapshot is
3449 mounted on demand in the \fB\&.zfs/snapshot\fR directory at the root of its
3450 file system. The second command destroys the newly created snapshots.
3451
3452 .sp
3453 .in +2
3454 .nf
3455 # \fBzfs snapshot -r pool/home@yesterday\fR
3456 # \fBzfs destroy -r pool/home@yesterday\fR
3457 .fi
3458 .in -2
3459 .sp
3460
3461 .LP
3462 \fBExample 4 \fRDisabling and Enabling File System Compression
3463 .sp
3464 .LP
3465 The following command disables the \fBcompression\fR property for all file
3466 systems under \fBpool/home\fR. The next command explicitly enables
3467 \fBcompression\fR for \fBpool/home/anne\fR.
3468
3469 .sp
3470 .in +2
3471 .nf
3472 # \fBzfs set compression=off pool/home\fR
3473 # \fBzfs set compression=on pool/home/anne\fR
3474 .fi
3475 .in -2
3476 .sp
3477
3478 .LP
3479 \fBExample 5 \fRListing ZFS Datasets
3480 .sp
3481 .LP
3482 The following command lists all active file systems and volumes in the system.
3483 Snapshots are displayed if the \fBlistsnaps\fR property is \fBon\fR. The
3484 default is \fBoff\fR. See \fBzpool\fR(1M) for more information on pool
3485 properties.
3486
3487 .sp
3488 .in +2
3489 .nf
3490 # \fBzfs list\fR
3491 NAME USED AVAIL REFER MOUNTPOINT
3492 pool 450K 457G 18K /pool
3493 pool/home 315K 457G 21K /export/home
3494 pool/home/anne 18K 457G 18K /export/home/anne
3495 pool/home/bob 276K 457G 276K /export/home/bob
3496 .fi
3497 .in -2
3498 .sp
3499
3500 .LP
3501 \fBExample 6 \fRSetting a Quota on a ZFS File System
3502 .sp
3503 .LP
3504 The following command sets a quota of 50 Gbytes for \fBpool/home/bob\fR.
3505
3506 .sp
3507 .in +2
3508 .nf
3509 # \fBzfs set quota=50G pool/home/bob\fR
3510 .fi
3511 .in -2
3512 .sp
3513
3514 .LP
3515 \fBExample 7 \fRListing ZFS Properties
3516 .sp
3517 .LP
3518 The following command lists all properties for \fBpool/home/bob\fR.
3519
3520 .sp
3521 .in +2
3522 .nf
3523 # \fBzfs get all pool/home/bob\fR
3524 NAME PROPERTY VALUE SOURCE
3525 pool/home/bob type filesystem -
3526 pool/home/bob creation Tue Jul 21 15:53 2009 -
3527 pool/home/bob used 21K -
3528 pool/home/bob available 20.0G -
3529 pool/home/bob referenced 21K -
3530 pool/home/bob compressratio 1.00x -
3531 pool/home/bob mounted yes -
3532 pool/home/bob quota 20G local
3533 pool/home/bob reservation none default
3534 pool/home/bob recordsize 128K default
3535 pool/home/bob mountpoint /pool/home/bob default
3536 pool/home/bob sharenfs off default
3537 pool/home/bob checksum on default
3538 pool/home/bob compression on local
3539 pool/home/bob atime on default
3540 pool/home/bob devices on default
3541 pool/home/bob exec on default
3542 pool/home/bob setuid on default
3543 pool/home/bob readonly off default
3544 pool/home/bob zoned off default
3545 pool/home/bob snapdir hidden default
3546 pool/home/bob aclmode discard default
3547 pool/home/bob aclinherit restricted default
3548 pool/home/bob canmount on default
3549 pool/home/bob shareiscsi off default
3550 pool/home/bob xattr on default
3551 pool/home/bob copies 1 default
3552 pool/home/bob version 4 -
3553 pool/home/bob utf8only off -
3554 pool/home/bob normalization none -
3555 pool/home/bob casesensitivity sensitive -
3556 pool/home/bob vscan off default
3557 pool/home/bob nbmand off default
3558 pool/home/bob sharesmb off default
3559 pool/home/bob refquota none default
3560 pool/home/bob refreservation none default
3561 pool/home/bob primarycache all default
3562 pool/home/bob secondarycache all default
3563 pool/home/bob usedbysnapshots 0 -
3564 pool/home/bob usedbydataset 21K -
3565 pool/home/bob usedbychildren 0 -
3566 pool/home/bob usedbyrefreservation 0 -
3567 .fi
3568 .in -2
3569 .sp
3570
3571 .sp
3572 .LP
3573 The following command gets a single property value.
3574
3575 .sp
3576 .in +2
3577 .nf
3578 # \fBzfs get -H -o value compression pool/home/bob\fR
3579 on
3580 .fi
3581 .in -2
3582 .sp
3583
3584 .sp
3585 .LP
3586 The following command lists all properties with local settings for
3587 \fBpool/home/bob\fR.
3588
3589 .sp
3590 .in +2
3591 .nf
3592 # \fBzfs get -r -s local -o name,property,value all pool/home/bob\fR
3593 NAME PROPERTY VALUE
3594 pool/home/bob quota 20G
3595 pool/home/bob compression on
3596 .fi
3597 .in -2
3598 .sp
3599
3600 .LP
3601 \fBExample 8 \fRRolling Back a ZFS File System
3602 .sp
3603 .LP
3604 The following command reverts the contents of \fBpool/home/anne\fR to the
3605 snapshot named \fByesterday\fR, deleting all intermediate snapshots.
3606
3607 .sp
3608 .in +2
3609 .nf
3610 # \fBzfs rollback -r pool/home/anne@yesterday\fR
3611 .fi
3612 .in -2
3613 .sp
3614
3615 .LP
3616 \fBExample 9 \fRCreating a ZFS Clone
3617 .sp
3618 .LP
3619 The following command creates a writable file system whose initial contents are
3620 the same as \fBpool/home/bob@yesterday\fR.
3621
3622 .sp
3623 .in +2
3624 .nf
3625 # \fBzfs clone pool/home/bob@yesterday pool/clone\fR
3626 .fi
3627 .in -2
3628 .sp
3629
3630 .LP
3631 \fBExample 10 \fRPromoting a ZFS Clone
3632 .sp
3633 .LP
3634 The following commands illustrate how to test out changes to a file system, and
3635 then replace the original file system with the changed one, using clones, clone
3636 promotion, and renaming:
3637
3638 .sp
3639 .in +2
3640 .nf
3641 # \fBzfs create pool/project/production\fR
3642 populate /pool/project/production with data
3643 # \fBzfs snapshot pool/project/production@today\fR
3644 # \fBzfs clone pool/project/production@today pool/project/beta\fR
3645 make changes to /pool/project/beta and test them
3646 # \fBzfs promote pool/project/beta\fR
3647 # \fBzfs rename pool/project/production pool/project/legacy\fR
3648 # \fBzfs rename pool/project/beta pool/project/production\fR
3649 once the legacy version is no longer needed, it can be destroyed
3650 # \fBzfs destroy pool/project/legacy\fR
3651 .fi
3652 .in -2
3653 .sp
3654
3655 .LP
3656 \fBExample 11 \fRInheriting ZFS Properties
3657 .sp
3658 .LP
3659 The following command causes \fBpool/home/bob\fR and \fBpool/home/anne\fR to
3660 inherit the \fBchecksum\fR property from their parent.
3661
3662 .sp
3663 .in +2
3664 .nf
3665 # \fBzfs inherit checksum pool/home/bob pool/home/anne\fR
3666 .fi
3667 .in -2
3668 .sp
3669
3670 .LP
3671 \fBExample 12 \fRRemotely Replicating ZFS Data
3672 .sp
3673 .LP
3674 The following commands send a full stream and then an incremental stream to a
3675 remote machine, restoring them into \fBpoolB/received/fs@a\fRand
3676 \fBpoolB/received/fs@b\fR, respectively. \fBpoolB\fR must contain the file
3677 system \fBpoolB/received\fR, and must not initially contain
3678 \fBpoolB/received/fs\fR.
3679
3680 .sp
3681 .in +2
3682 .nf
3683 # \fBzfs send pool/fs@a | \e\fR
3684 \fBssh host zfs receive poolB/received/fs@a\fR
3685 # \fBzfs send -i a pool/fs@b | ssh host \e\fR
3686 \fBzfs receive poolB/received/fs\fR
3687 .fi
3688 .in -2
3689 .sp
3690
3691 .LP
3692 \fBExample 13 \fRUsing the \fBzfs receive\fR \fB-d\fR Option
3693 .sp
3694 .LP
3695 The following command sends a full stream of \fBpoolA/fsA/fsB@snap\fR to a
3696 remote machine, receiving it into \fBpoolB/received/fsA/fsB@snap\fR. The
3697 \fBfsA/fsB@snap\fR portion of the received snapshot's name is determined from
3698 the name of the sent snapshot. \fBpoolB\fR must contain the file system
3699 \fBpoolB/received\fR. If \fBpoolB/received/fsA\fR does not exist, it is created
3700 as an empty file system.
3701
3702 .sp
3703 .in +2
3704 .nf
3705 # \fBzfs send poolA/fsA/fsB@snap | \e
3706 ssh host zfs receive -d poolB/received\fR
3707 .fi
3708 .in -2
3709 .sp
3710
3711 .LP
3712 \fBExample 14 \fRSetting User Properties
3713 .sp
3714 .LP
3715 The following example sets the user-defined \fBcom.example:department\fR
3716 property for a dataset.
3717
3718 .sp
3719 .in +2
3720 .nf
3721 # \fBzfs set com.example:department=12345 tank/accounting\fR
3722 .fi
3723 .in -2
3724 .sp
3725
3726 .LP
3727 \fBExample 15 \fRCreating a ZFS Volume as an iSCSI Target Device
3728 .sp
3729 .LP
3730 The following example shows how to create a \fBZFS\fR volume as an \fBiSCSI\fR
3731 target.
3732
3733 .sp
3734 .in +2
3735 .nf
3736 # \fBzfs create -V 2g pool/volumes/vol1\fR
3737 # \fBzfs set shareiscsi=on pool/volumes/vol1\fR
3738 # \fBiscsitadm list target\fR
3739 Target: pool/volumes/vol1
3740 iSCSI Name:
3741 iqn.1986-03.com.sun:02:7b4b02a6-3277-eb1b-e686-a24762c52a8c
3742 Connections: 0
3743 .fi
3744 .in -2
3745 .sp
3746
3747 .sp
3748 .LP
3749 After the \fBiSCSI\fR target is created, set up the \fBiSCSI\fR initiator. For
3750 more information about the Solaris \fBiSCSI\fR initiator, see
3751 \fBiscsitadm\fR(1M).
3752 .LP
3753 \fBExample 16 \fRPerforming a Rolling Snapshot
3754 .sp
3755 .LP
3756 The following example shows how to maintain a history of snapshots with a
3757 consistent naming scheme. To keep a week's worth of snapshots, the user
3758 destroys the oldest snapshot, renames the remaining snapshots, and then creates
3759 a new snapshot, as follows:
3760
3761 .sp
3762 .in +2
3763 .nf
3764 # \fBzfs destroy -r pool/users@7daysago\fR
3765 # \fBzfs rename -r pool/users@6daysago @7daysago\fR
3766 # \fBzfs rename -r pool/users@5daysago @6daysago\fR
3767 # \fBzfs rename -r pool/users@yesterday @5daysago\fR
3768 # \fBzfs rename -r pool/users@yesterday @4daysago\fR
3769 # \fBzfs rename -r pool/users@yesterday @3daysago\fR
3770 # \fBzfs rename -r pool/users@yesterday @2daysago\fR
3771 # \fBzfs rename -r pool/users@today @yesterday\fR
3772 # \fBzfs snapshot -r pool/users@today\fR
3773 .fi
3774 .in -2
3775 .sp
3776
3777 .LP
3778 \fBExample 17 \fRSetting \fBsharenfs\fR Property Options on a ZFS File System
3779 .sp
3780 .LP
3781 The following commands show how to set \fBsharenfs\fR property options to
3782 enable \fBrw\fR access for a set of \fBIP\fR addresses and to enable root
3783 access for system \fBneo\fR on the \fBtank/home\fR file system.
3784
3785 .sp
3786 .in +2
3787 .nf
3788 # \fBzfs set sharenfs='rw=@123.123.0.0/16,root=neo' tank/home\fR
3789 .fi
3790 .in -2
3791 .sp
3792
3793 .sp
3794 .LP
3795 If you are using \fBDNS\fR for host name resolution, specify the fully
3796 qualified hostname.
3797
3798 .LP
3799 \fBExample 18 \fRDelegating ZFS Administration Permissions on a ZFS Dataset
3800 .sp
3801 .LP
3802 The following example shows how to set permissions so that user \fBcindys\fR
3803 can create, destroy, mount, and take snapshots on \fBtank/cindys\fR. The
3804 permissions on \fBtank/cindys\fR are also displayed.
3805
3806 .sp
3807 .in +2
3808 .nf
3809 # \fBzfs allow cindys create,destroy,mount,snapshot tank/cindys\fR
3810 # \fBzfs allow tank/cindys\fR
3811 -------------------------------------------------------------
3812 Local+Descendent permissions on (tank/cindys)
3813 user cindys create,destroy,mount,snapshot
3814 -------------------------------------------------------------
3815 .fi
3816 .in -2
3817 .sp
3818
3819 .sp
3820 .LP
3821 Because the \fBtank/cindys\fR mount point permission is set to 755 by default,
3822 user \fBcindys\fR will be unable to mount file systems under \fBtank/cindys\fR.
3823 Set an \fBACL\fR similar to the following syntax to provide mount point access:
3824 .sp
3825 .in +2
3826 .nf
3827 # \fBchmod A+user:cindys:add_subdirectory:allow /tank/cindys\fR
3828 .fi
3829 .in -2
3830 .sp
3831
3832 .LP
3833 \fBExample 19 \fRDelegating Create Time Permissions on a ZFS Dataset
3834 .sp
3835 .LP
3836 The following example shows how to grant anyone in the group \fBstaff\fR to
3837 create file systems in \fBtank/users\fR. This syntax also allows staff members
3838 to destroy their own file systems, but not destroy anyone else's file system.
3839 The permissions on \fBtank/users\fR are also displayed.
3840
3841 .sp
3842 .in +2
3843 .nf
3844 # \fBzfs allow staff create,mount tank/users\fR
3845 # \fBzfs allow -c destroy tank/users\fR
3846 # \fBzfs allow tank/users\fR
3847 -------------------------------------------------------------
3848 Create time permissions on (tank/users)
3849 create,destroy
3850 Local+Descendent permissions on (tank/users)
3851 group staff create,mount
3852 -------------------------------------------------------------
3853 .fi
3854 .in -2
3855 .sp
3856
3857 .LP
3858 \fBExample 20 \fRDefining and Granting a Permission Set on a ZFS Dataset
3859 .sp
3860 .LP
3861 The following example shows how to define and grant a permission set on the
3862 \fBtank/users\fR file system. The permissions on \fBtank/users\fR are also
3863 displayed.
3864
3865 .sp
3866 .in +2
3867 .nf
3868 # \fBzfs allow -s @pset create,destroy,snapshot,mount tank/users\fR
3869 # \fBzfs allow staff @pset tank/users\fR
3870 # \fBzfs allow tank/users\fR
3871 -------------------------------------------------------------
3872 Permission sets on (tank/users)
3873 @pset create,destroy,mount,snapshot
3874 Create time permissions on (tank/users)
3875 create,destroy
3876 Local+Descendent permissions on (tank/users)
3877 group staff @pset,create,mount
3878 -------------------------------------------------------------
3879 .fi
3880 .in -2
3881 .sp
3882
3883 .LP
3884 \fBExample 21 \fRDelegating Property Permissions on a ZFS Dataset
3885 .sp
3886 .LP
3887 The following example shows to grant the ability to set quotas and reservations
3888 on the \fBusers/home\fR file system. The permissions on \fBusers/home\fR are
3889 also displayed.
3890
3891 .sp
3892 .in +2
3893 .nf
3894 # \fBzfs allow cindys quota,reservation users/home\fR
3895 # \fBzfs allow users/home\fR
3896 -------------------------------------------------------------
3897 Local+Descendent permissions on (users/home)
3898 user cindys quota,reservation
3899 -------------------------------------------------------------
3900 cindys% \fBzfs set quota=10G users/home/marks\fR
3901 cindys% \fBzfs get quota users/home/marks\fR
3902 NAME PROPERTY VALUE SOURCE
3903 users/home/marks quota 10G local
3904 .fi
3905 .in -2
3906 .sp
3907
3908 .LP
3909 \fBExample 22 \fRRemoving ZFS Delegated Permissions on a ZFS Dataset
3910 .sp
3911 .LP
3912 The following example shows how to remove the snapshot permission from the
3913 \fBstaff\fR group on the \fBtank/users\fR file system. The permissions on
3914 \fBtank/users\fR are also displayed.
3915
3916 .sp
3917 .in +2
3918 .nf
3919 # \fBzfs unallow staff snapshot tank/users\fR
3920 # \fBzfs allow tank/users\fR
3921 -------------------------------------------------------------
3922 Permission sets on (tank/users)
3923 @pset create,destroy,mount,snapshot
3924 Create time permissions on (tank/users)
3925 create,destroy
3926 Local+Descendent permissions on (tank/users)
3927 group staff @pset,create,mount
3928 -------------------------------------------------------------
3929 .fi
3930 .in -2
3931 .sp
3932
3933 .LP
3934 \fBExample 23\fR Showing the differences between a snapshot and a ZFS Dataset
3935 .sp
3936 .LP
3937 The following example shows how to see what has changed between a prior
3938 snapshot of a ZFS Dataset and its current state. The \fB-F\fR option is used
3939 to indicate type information for the files affected.
3940
3941 .sp
3942 .in +2
3943 .nf
3944 # zfs diff -F tank/test@before tank/test
3945 M / /tank/test/
3946 M F /tank/test/linked (+1)
3947 R F /tank/test/oldname -> /tank/test/newname
3948 - F /tank/test/deleted
3949 + F /tank/test/created
3950 M F /tank/test/modified
3951 .fi
3952 .in -2
3953 .sp
3954
3955 .SH EXIT STATUS
3956 .sp
3957 .LP
3958 The following exit values are returned:
3959 .sp
3960 .ne 2
3961 .na
3962 \fB\fB0\fR\fR
3963 .ad
3964 .sp .6
3965 .RS 4n
3966 Successful completion.
3967 .RE
3968
3969 .sp
3970 .ne 2
3971 .na
3972 \fB\fB1\fR\fR
3973 .ad
3974 .sp .6
3975 .RS 4n
3976 An error occurred.
3977 .RE
3978
3979 .sp
3980 .ne 2
3981 .na
3982 \fB\fB2\fR\fR
3983 .ad
3984 .sp .6
3985 .RS 4n
3986 Invalid command line options were specified.
3987 .RE
3988
3989 .SH ATTRIBUTES
3990 .sp
3991 .LP
3992 See \fBattributes\fR(5) for descriptions of the following attributes:
3993 .sp
3994
3995 .sp
3996 .TS
3997 box;
3998 c | c
3999 l | l .
4000 ATTRIBUTE TYPE ATTRIBUTE VALUE
4001 _
4002 Interface Stability Committed
4003 .TE
4004
4005 .SH SEE ALSO
4006 .sp
4007 .LP
4008 \fBssh\fR(1), \fBiscsitadm\fR(1M), \fBmount\fR(1M), \fBshare\fR(1M),
4009 \fBsharemgr\fR(1M), \fBunshare\fR(1M), \fBzonecfg\fR(1M), \fBzpool\fR(1M),
4010 \fBchmod\fR(2), \fBstat\fR(2), \fBwrite\fR(2), \fBfsync\fR(3C),
4011 \fBdfstab\fR(4), \fBacl\fR(5), \fBattributes\fR(5)
4012 .sp
4013 .LP
4014 See the \fBgzip\fR(1) man page, which is not part of the SunOS man page
4015 collection.
4016 .sp
4017 .LP
4018 For information about using the \fBZFS\fR web-based management tool and other
4019 \fBZFS\fR features, see the \fISolaris ZFS Administration Guide\fR.