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