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