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