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