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