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