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