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