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