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