View | Details | Raw Unified | Return to bug 144984
Collapse All | Expand All

(-)cddl/contrib/opensolaris/cmd/zfs/zfs.8 (-511 / +487 lines)
Lines 1-24 Link Here
1
'\" te
1
'\" te
2
.\" CDDL HEADER START
2
.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
3
.\"
3
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4
.\" The contents of this file are subject to the terms of the
4
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5
.\" Common Development and Distribution License (the "License").  
5
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6
.\" You may not use this file except in compliance with the License.
6
.TH zfs 1M "14 Feb 2009" "SunOS 5.11" "System Administration Commands"
7
.\"
8
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9
.\" or http://www.opensolaris.org/os/licensing.
10
.\" See the License for the specific language governing permissions
11
.\" and limitations under the License.
12
.\"
13
.\" When distributing Covered Code, include this CDDL HEADER in each
14
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15
.\" If applicable, add the following below this CDDL HEADER, with the
16
.\" fields enclosed by brackets "[]" replaced with your own identifying
17
.\" information: Portions Copyright [yyyy] [name of copyright owner]
18
.\"
19
.\" CDDL HEADER END
20
.\" Copyright (c) 2007 Sun Microsystems, Inc. All Rights Reserved.
21
.TH zfs 1M "8 Apr 2008" "SunOS 5.11" "System Administration Commands"
22
.SH NAME
7
.SH NAME
23
zfs \- configures ZFS file systems
8
zfs \- configures ZFS file systems
24
.SH SYNOPSIS
9
.SH SYNOPSIS
Lines 44-50 Link Here
44
29
45
.LP
30
.LP
46
.nf
31
.nf
47
\fBzfs\fR \fBsnapshot\fR [\fB-r\fR] \fIfilesystem@snapname\fR|\fIvolume@snapname\fR
32
\fBzfs\fR \fBsnapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]... 
33
      \fIfilesystem@snapname\fR|\fIvolume@snapname\fR
48
.fi
34
.fi
49
35
50
.LP
36
.LP
Lines 54-60 Link Here
54
40
55
.LP
41
.LP
56
.nf
42
.nf
57
\fBzfs\fR \fBclone\fR [\fB-p\fR] \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR
43
\fBzfs\fR \fBclone\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR
58
.fi
44
.fi
59
45
60
.LP
46
.LP
Lines 65-71 Link Here
65
.LP
51
.LP
66
.nf
52
.nf
67
\fBzfs\fR \fBrename\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR 
53
\fBzfs\fR \fBrename\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR 
68
    \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
54
     \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
69
.fi
55
.fi
70
56
71
.LP
57
.LP
Lines 81-103 Link Here
81
.LP
67
.LP
82
.nf
68
.nf
83
\fBzfs\fR \fBlist\fR [\fB-rH\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fB-t\fR \fItype\fR[,...]]
69
\fBzfs\fR \fBlist\fR [\fB-rH\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fB-t\fR \fItype\fR[,...]]
84
    [\fB-s\fR \fIproperty\fR] ... [\fB-S\fR \fIproperty\fR ... [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR] ...
70
     [\fB-s\fR \fIproperty\fR] ... [\fB-S\fR \fIproperty\fR] ... [\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR] ...
85
.fi
71
.fi
86
72
87
.LP
73
.LP
88
.nf
74
.nf
89
\fBzfs\fR \fBset\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR ...
75
\fBzfs\fR \fBset\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR|snapshot ...
90
.fi
76
.fi
91
77
92
.LP
78
.LP
93
.nf
79
.nf
94
\fBzfs\fR \fBget\fR [\fB-rHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-s\fR \fIsource\fR[,...]] "\fIall\fR" | \fIproperty\fR[,...]
80
\fBzfs\fR \fBget\fR [\fB-rHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-s\fR \fIsource\fR[,...]] "\fIall\fR" | \fIproperty\fR[,...]
95
     \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...
81
      \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...
96
.fi
82
.fi
97
83
98
.LP
84
.LP
99
.nf
85
.nf
100
\fBzfs\fR \fBinherit\fR [\fB-r\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume\fR ...
86
\fBzfs\fR \fBinherit\fR [\fB-r\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume|snapshot\fR ...
101
.fi
87
.fi
102
88
103
.LP
89
.LP
Lines 132-143 Link Here
132
118
133
.LP
119
.LP
134
.nf
120
.nf
135
\fBzfs\fR \fBunshare\fR  \fB-a\fR \fIfilesystem\fR|\fImountpoint\fR
121
\fBzfs\fR \fBunshare\fR \fB-a\fR \fIfilesystem\fR|\fImountpoint\fR
136
.fi
122
.fi
137
123
138
.LP
124
.LP
139
.nf
125
.nf
140
\fBzfs\fR \fBsend\fR [\fB-vR\fR] [\fB-\fR[\fB-iI\fR] \fIsnapshot\fR] \fIsnapshot\fR
126
\fBzfs\fR \fBsend\fR [\fB-vR\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
141
.fi
127
.fi
142
128
143
.LP
129
.LP
Lines 153-159 Link Here
153
.LP
139
.LP
154
.nf
140
.nf
155
\fBzfs\fR \fBallow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|\fI@setname\fR[,...] 
141
\fBzfs\fR \fBallow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \fIperm\fR|\fI@setname\fR[,...] 
156
    \fIfilesystem\fR|\fIvolume\fR
142
     \fIfilesystem\fR|\fIvolume\fR
157
.fi
143
.fi
158
144
159
.LP
145
.LP
Lines 174-180 Link Here
174
.LP
160
.LP
175
.nf
161
.nf
176
\fBzfs\fR \fBunallow\fR [\fB-rldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] [\fIperm\fR|@\fIsetname\fR[,... ]] 
162
\fBzfs\fR \fBunallow\fR [\fB-rldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] [\fIperm\fR|@\fIsetname\fR[,... ]] 
177
    \fIfilesystem\fR|\fIvolume\fR
163
     \fIfilesystem\fR|\fIvolume\fR
178
.fi
164
.fi
179
165
180
.LP
166
.LP
Lines 192-211 Link Here
192
\fBzfs\fR \fBunallow\fR [\fB-r\fR] \fB-s\fR @setname [\fIperm\fR|@\fIsetname\fR[,... ]] \fIfilesystem\fR|\fIvolume\fR
178
\fBzfs\fR \fBunallow\fR [\fB-r\fR] \fB-s\fR @setname [\fIperm\fR|@\fIsetname\fR[,... ]] \fIfilesystem\fR|\fIvolume\fR
193
.fi
179
.fi
194
180
195
.LP
196
.nf
197
\fBzfs\fR \fBjail\fR \fBjailid\fR \fB\fIfilesystem\fR\fR
198
.fi
199
.LP
200
.nf
201
\fBzfs\fR \fBunjail\fR \fBjailid\fR \fB\fIfilesystem\fR\fR
202
.fi
203
204
.SH DESCRIPTION
181
.SH DESCRIPTION
205
.sp
182
.sp
206
.LP
183
.LP
207
The \fBzfs\fR command configures \fBZFS\fR datasets within a \fBZFS\fR storage pool, as described in \fBzpool\fR(1M). A
184
The \fBzfs\fR command configures \fBZFS\fR datasets within a \fBZFS\fR storage pool, as described in \fBzpool\fR(1M). A dataset is identified by a unique path within the \fBZFS\fR namespace. For example:
208
dataset is identified by a unique path within the \fBZFS\fR namespace. For example:
209
.sp
185
.sp
210
.in +2
186
.in +2
211
.nf
187
.nf
Lines 226-234 Link Here
226
.na
202
.na
227
\fB\fIfile system\fR\fR
203
\fB\fIfile system\fR\fR
228
.ad
204
.ad
229
.RS 15n
205
.sp .6
230
.rt  
206
.RS 4n
231
A standard \fBPOSIX\fR file system. \fBZFS\fR file systems can be mounted within the standard file system namespace and behave like any other file system.
207
A \fBZFS\fR dataset of type "filesystem" that can be mounted within the standard system namespace and behaves like other file systems. While \fBZFS\fR file systems are designed to be \fBPOSIX\fR compliant, known issues exist that prevent compliance in some cases. Applications that depend on standards conformance might fail due to nonstandard behavior when checking file system free space.
232
.RE
208
.RE
233
209
234
.sp
210
.sp
Lines 237-244 Link Here
237
.na
213
.na
238
\fB\fIvolume\fR\fR
214
\fB\fIvolume\fR\fR
239
.ad
215
.ad
240
.RS 15n
216
.sp .6
241
.rt  
217
.RS 4n
242
A logical volume exported as a raw or block device. This type of dataset should only be used under special circumstances. File systems are typically used in most environments. Volumes cannot be used in a non-global zone.
218
A logical volume exported as a raw or block device. This type of dataset should only be used under special circumstances. File systems are typically used in most environments. Volumes cannot be used in a non-global zone.
243
.RE
219
.RE
244
220
Lines 248-255 Link Here
248
.na
224
.na
249
\fB\fIsnapshot\fR\fR
225
\fB\fIsnapshot\fR\fR
250
.ad
226
.ad
251
.RS 15n
227
.sp .6
252
.rt  
228
.RS 4n
253
A read-only version of a file system or volume at a given point in time. It is specified as \fIfilesystem@name\fR or \fIvolume@name\fR.
229
A read-only version of a file system or volume at a given point in time. It is specified as \fIfilesystem@name\fR or \fIvolume@name\fR.
254
.RE
230
.RE
255
231
Lines 272-291 Link Here
272
Snapshots can have arbitrary names. Snapshots of volumes can be cloned or rolled back, but cannot be accessed independently.
248
Snapshots can have arbitrary names. Snapshots of volumes can be cloned or rolled back, but cannot be accessed independently.
273
.sp
249
.sp
274
.LP
250
.LP
275
File system snapshots can be accessed under the ".zfs/snapshot" directory in the root of the file system. Snapshots are automatically mounted on demand and may be unmounted at regular intervals. The visibility of the ".zfs" directory can be controlled by the "snapdir"
251
File system snapshots can be accessed under the ".zfs/snapshot" directory in the root of the file system. Snapshots are automatically mounted on demand and may be unmounted at regular intervals. The visibility of the ".zfs" directory can be controlled by the "snapdir" property.
276
property.
277
.SS "Clones"
252
.SS "Clones"
278
.sp
253
.sp
279
.LP
254
.LP
280
A clone is a writable volume or file system whose initial contents are the same as another dataset. As with snapshots, creating a clone is nearly instantaneous, and initially consumes no additional space.
255
A clone is a writable volume or file system whose initial contents are the same as another dataset. As with snapshots, creating a clone is nearly instantaneous, and initially consumes no additional space.
281
.sp
256
.sp
282
.LP
257
.LP
283
Clones can only be created from a snapshot. When a snapshot is cloned, it creates an implicit dependency between the parent and child. Even though the clone is created somewhere else in the dataset hierarchy, the original snapshot cannot be destroyed as long as a clone exists. The "origin"
258
Clones can only be created from a snapshot. When a snapshot is cloned, it creates an implicit dependency between the parent and child. Even though the clone is created somewhere else in the dataset hierarchy, the original snapshot cannot be destroyed as long as a clone exists. The "origin" property exposes this dependency, and the \fBdestroy\fR command lists any such dependencies, if they exist.
284
property exposes this dependency, and the \fBdestroy\fR command lists any such dependencies, if they exist.
285
.sp
259
.sp
286
.LP
260
.LP
287
The clone parent-child dependency relationship can be reversed by using the "\fBpromote\fR" subcommand. This causes the "origin" file system to become a clone of the specified file system, which makes it possible to destroy the file system that the clone
261
The clone parent-child dependency relationship can be reversed by using the "\fBpromote\fR" subcommand. This causes the "origin" file system to become a clone of the specified file system, which makes it possible to destroy the file system that the clone was created from.
288
was created from.
289
.SS "Mount Points"
262
.SS "Mount Points"
290
.sp
263
.sp
291
.LP
264
.LP
Lines 301-308 Link Here
301
A file system mountpoint property of "none" prevents the file system from being mounted.
274
A file system mountpoint property of "none" prevents the file system from being mounted.
302
.sp
275
.sp
303
.LP
276
.LP
304
If needed, \fBZFS\fR file systems can also be managed with traditional tools (\fBmount\fR, \fBumount\fR, \fB/etc/vfstab\fR). If a file system's mount point is set to "legacy", \fBZFS\fR makes no attempt to manage
277
If needed, \fBZFS\fR file systems can also be managed with traditional tools (\fBmount\fR, \fBumount\fR, \fB/etc/vfstab\fR). If a file system's mount point is set to "legacy", \fBZFS\fR makes no attempt to manage the file system, and the administrator is responsible for mounting and unmounting the file system.
305
the file system, and the administrator is responsible for mounting and unmounting the file system.
306
.SS "Zones"
278
.SS "Zones"
307
.sp
279
.sp
308
.LP
280
.LP
Lines 312-319 Link Here
312
The physical properties of an added file system are controlled by the global administrator. However, the zone administrator can create, modify, or destroy files within the added file system, depending on how the file system is mounted.
284
The physical properties of an added file system are controlled by the global administrator. However, the zone administrator can create, modify, or destroy files within the added file system, depending on how the file system is mounted.
313
.sp
285
.sp
314
.LP
286
.LP
315
A dataset can also be delegated to a non-global zone by using zonecfg's "\fBadd dataset\fR" subcommand. You cannot delegate a dataset to one zone and the children of the same dataset to another zone. The zone administrator can change properties of the dataset or
287
A dataset can also be delegated to a non-global zone by using zonecfg's "\fBadd dataset\fR" subcommand. You cannot delegate a dataset to one zone and the children of the same dataset to another zone. The zone administrator can change properties of the dataset or any of its children. However, the "quota" property is controlled by the global administrator.
316
any of its children. However, the "quota" property is controlled by the global administrator.
317
.sp
288
.sp
318
.LP
289
.LP
319
A \fBZFS\fR volume can be added as a device to a non-global zone by using zonecfg's "\fBadd device\fR" subcommand. However, its physical properties can only be modified by the global administrator.
290
A \fBZFS\fR volume can be added as a device to a non-global zone by using zonecfg's "\fBadd device\fR" subcommand. However, its physical properties can only be modified by the global administrator.
Lines 329-343 Link Here
329
.SS "Native Properties"
300
.SS "Native Properties"
330
.sp
301
.sp
331
.LP
302
.LP
332
Properties are divided into two types, native properties and user defined properties. Native properties either export internal statistics or control \fBZFS\fR behavior. In addition, native properties are either editable or read-only. User properties have no effect on \fBZFS\fR behavior,
303
Properties are divided into two types, native properties and user defined properties. Native properties either export internal statistics or control \fBZFS\fR behavior. In addition, native properties are either editable or read-only. User properties have no effect on \fBZFS\fR behavior, but you can use them to annotate datasets in a way that is meaningful in your environment. For more information about user properties, see the "User Properties" section.
333
but you can use them to annotate datasets in a way that is meaningful in your environment. For more information about user properties, see the "User Properties" section.
334
.sp
304
.sp
335
.LP
305
.LP
336
Every dataset has a set of properties that export statistics about the dataset as well as control various behavior. Properties are inherited from the parent unless overridden by the child. Snapshot properties can not be edited; they always inherit their inheritable properties. Properties
306
Every dataset has a set of properties that export statistics about the dataset as well as control various behavior. Properties are inherited from the parent unless overridden by the child. Some properties only apply to certain types of datasets (file systems, volumes or snapshots).
337
that are not applicable to snapshots are not displayed.
338
.sp
307
.sp
339
.LP
308
.LP
340
The values of numeric properties can be specified using the following human-readable suffixes (for example, "k", "KB", "M", "Gb", etc, up to Z for zettabyte). The following are all valid (and equal) specifications: 
309
The values of numeric properties can be specified using human-readable suffixes (for example, "k", "KB", "M", "Gb", etc, up to Z for zettabyte). The following are all valid (and equal) specifications: 
341
.sp
310
.sp
342
.in +2
311
.in +2
343
.nf
312
.nf
Lines 360-367 Link Here
360
.ad
329
.ad
361
.sp .6
330
.sp .6
362
.RS 4n
331
.RS 4n
363
The amount of space available to the dataset and all its children, assuming that there is no other activity in the pool. Because space is shared within a pool, availability can be limited by any number of factors, including physical pool size, quotas, reservations, or other datasets
332
The amount of space available to the dataset and all its children, assuming that there is no other activity in the pool. Because space is shared within a pool, availability can be limited by any number of factors, including physical pool size, quotas, reservations, or other datasets within the pool.
364
within the pool.
365
.sp
333
.sp
366
This property can also be referred to by its shortened column name, "avail".
334
This property can also be referred to by its shortened column name, "avail".
367
.RE
335
.RE
Lines 418-425 Link Here
418
.ad
386
.ad
419
.sp .6
387
.sp .6
420
.RS 4n
388
.RS 4n
421
The amount of data that is accessible by this dataset, which may or may not be shared with other datasets in the pool. When a snapshot or clone is created, it initially references the same amount of space as the file system or snapshot it was created from, since its contents are
389
The amount of data that is accessible by this dataset, which may or may not be shared with other datasets in the pool. When a snapshot or clone is created, it initially references the same amount of space as the file system or snapshot it was created from, since its contents are identical.
422
identical.
423
.sp
390
.sp
424
This property can also be referred to by its shortened column name, "refer".
391
This property can also be referred to by its shortened column name, "refer".
425
.RE
392
.RE
Lines 432-438 Link Here
432
.ad
399
.ad
433
.sp .6
400
.sp .6
434
.RS 4n
401
.RS 4n
435
The type of dataset: "filesystem", "volume", "snapshot", or "clone".
402
The type of dataset: "filesystem", "volume", or "snapshot".
436
.RE
403
.RE
437
404
438
.sp
405
.sp
Lines 443-453 Link Here
443
.ad
410
.ad
444
.sp .6
411
.sp .6
445
.RS 4n
412
.RS 4n
446
The amount of space consumed by this dataset and all its descendents. This is the value that is checked against this dataset's quota and reservation. The space used does not include this dataset's reservation, but does take into account the reservations of any descendent datasets.
413
The amount of space consumed by this dataset and all its descendents. This is the value that is checked against this dataset's quota and reservation. The space used does not include this dataset's reservation, but does take into account the reservations of any descendent datasets. The amount of space that a dataset consumes from its parent, as well as the amount of space that are freed if this dataset is recursively destroyed, is the greater of its space used and its reservation.
447
The amount of space that a dataset consumes from its parent, as well as the amount of space that are freed if this dataset is recursively destroyed, is the greater of its space used and its reservation.
448
.sp
414
.sp
449
When snapshots (see the "Snapshots" section) are created, their space is initially shared between the snapshot and the file system, and possibly with previous snapshots. As the file system changes, space that was previously shared becomes unique to the snapshot, and counted in
415
When snapshots (see the "Snapshots" section) are created, their space is initially shared between the snapshot and the file system, and possibly with previous snapshots. As the file system changes, space that was previously shared becomes unique to the snapshot, and counted in the snapshot's space used. Additionally, deleting snapshots can increase the amount of space unique to (and used by) other snapshots.
450
the snapshot's space used. Additionally, deleting snapshots can increase the amount of space unique to (and used by) other snapshots.
451
.sp
416
.sp
452
The amount of space used, available, or referenced does not take into account pending changes. Pending changes are generally accounted for within a few seconds. Committing a change to a disk using \fBfsync\fR(3c) or \fBO_SYNC\fR does not necessarily guarantee that the space usage information is updated immediately.
417
The amount of space used, available, or referenced does not take into account pending changes. Pending changes are generally accounted for within a few seconds. Committing a change to a disk using \fBfsync\fR(3c) or \fBO_SYNC\fR does not necessarily guarantee that the space usage information is updated immediately.
453
.RE
418
.RE
Lines 456-467 Link Here
456
.ne 2
421
.ne 2
457
.mk
422
.mk
458
.na
423
.na
424
\fBusedby*\fR
425
.ad
426
.sp .6
427
.RS 4n
428
The \fBusedby*\fR snapshots decompose the "used" properties into the various reasons that space is used. Specifically, \fBused\fR = \fBusedbychildren\fR + \fBusedbydataset\fR + \fBusedbyrefreservation\fR +, \fBusedbysnapshots\fR. These properties are only available for datasets created on zpool "version 13" pools.
429
.RE
430
431
.sp
432
.ne 2
433
.mk
434
.na
435
\fBusedbychildren\fR
436
.ad
437
.sp .6
438
.RS 4n
439
The amount of space used by children of this dataset, which would be freed if all the dataset's children were destroyed.
440
.RE
441
442
.sp
443
.ne 2
444
.mk
445
.na
446
\fBusedbydataset\fR
447
.ad
448
.sp .6
449
.RS 4n
450
The amount of space used by this dataset itself, which would be freed if the dataset were destroyed (after first removing any \fBrefreservation\fR and destroying any necessary snapshots or descendents).
451
.RE
452
453
.sp
454
.ne 2
455
.mk
456
.na
457
\fBusedbyrefreservation\fR
458
.ad
459
.sp .6
460
.RS 4n
461
The amount of space used by a \fBrefreservation\fR set on this dataset, which would be freed if the \fBrefreservation\fR was removed.
462
.RE
463
464
.sp
465
.ne 2
466
.mk
467
.na
468
\fBusedbysnapshots\fR
469
.ad
470
.sp .6
471
.RS 4n
472
The amount of space consumed by snapshots of this dataset. In particular, it is the amount of space that would be freed if all of this dataset's snapshots were destroyed. Note that this is not simply the sum of the snapshots' "used" properties because space can be shared by multiple snapshots
473
.RE
474
475
.sp
476
.ne 2
477
.mk
478
.na
459
\fBvolblocksize=\fIblocksize\fR\fR
479
\fBvolblocksize=\fIblocksize\fR\fR
460
.ad
480
.ad
461
.sp .6
481
.sp .6
462
.RS 4n
482
.RS 4n
463
For volumes, specifies the block size of the volume. The \fBblocksize\fR cannot be changed once the volume has been written, so it should be set at volume creation time. The default \fBblocksize\fR for volumes is 8 Kbytes. Any power of 2 from 512 bytes
483
For volumes, specifies the block size of the volume. The \fBblocksize\fR cannot be changed once the volume has been written, so it should be set at volume creation time. The default \fBblocksize\fR for volumes is 8 Kbytes. Any power of 2 from 512 bytes to 128 Kbytes is valid.
464
to 128 Kbytes is valid.
465
.sp
484
.sp
466
This property can also be referred to by its shortened column name, "volblock".
485
This property can also be referred to by its shortened column name, "volblock".
467
.RE
486
.RE
Lines 473-487 Link Here
473
.ne 2
492
.ne 2
474
.mk
493
.mk
475
.na
494
.na
476
\fBaclinherit=\fBdiscard\fR | \fBnoallow\fR | \fBrestricted\fR | \fBpassthrough\fR\fR
495
\fBaclinherit=\fBdiscard\fR | \fBnoallow\fR | \fBrestricted\fR | \fBpassthrough\fR | \fBpassthrough-x\fR\fR
477
.ad
496
.ad
478
.sp .6
497
.sp .6
479
.RS 4n
498
.RS 4n
480
Controls how \fBACL\fR entries are inherited when files and directories are created. A file system with an "aclinherit" property of "\fBdiscard\fR" does not inherit any \fBACL\fR entries. A file system with an "aclinherit"
499
Controls how \fBACL\fR entries are inherited when files and directories are created. A file system with an "aclinherit" property of "\fBdiscard\fR" does not inherit any \fBACL\fR entries. A file system with an "aclinherit" property value of "\fBnoallow\fR" only inherits inheritable \fBACL\fR entries that specify "deny" permissions. The property value "\fBrestricted\fR" (the default) removes the "\fBwrite_acl\fR" and "\fBwrite_owner\fR" permissions when the \fBACL\fR entry is inherited. A file system with an "aclinherit" property value of "\fBpassthrough\fR" inherits all inheritable \fBACL\fR entries without any modifications made to the \fBACL\fR entries when they are inherited. A file system with an "aclinherit" property value of "\fBpassthrough-x\fR" has the same meaning as "\fBpassthrough\fR", except that the \fBowner@\fR, \fBgroup@\fR, and \fBeveryone@\fR \fBACE\fRs inherit the execute permission only if the file creation mode also requests the execute bit.
481
property value of "\fBnoallow\fR" only inherits inheritable \fBACL\fR entries that specify "deny" permissions. The property value "\fBrestricted\fR" (the default) removes the "\fBwrite_acl\fR" and "\fBwrite_owner\fR" permissions when the \fBACL\fR entry is inherited. A file system with an "aclinherit" property value of "\fBpassthrough\fR" inherits all inheritable \fBACL\fR entries without any modifications made to the \fBACL\fR entries when they are inherited.
482
.sp
500
.sp
483
When the property value is set to "\fBpassthrough\fR," files are created with a mode determined by the inheritable \fBACE\fRs. If no inheritable \fBACE\fRs exist that affect the mode, then the mode is set in accordance to the requested mode
501
When the property value is set to "\fBpassthrough\fR," files are created with a mode determined by the inheritable \fBACE\fRs. If no inheritable \fBACE\fRs exist that affect the mode, then the mode is set in accordance to the requested mode from the application.
484
from the application.
485
.RE
502
.RE
486
503
487
.sp
504
.sp
Lines 492-500 Link Here
492
.ad
509
.ad
493
.sp .6
510
.sp .6
494
.RS 4n
511
.RS 4n
495
Controls how an \fBACL\fR is modified during \fBchmod\fR(2). A file system with an "aclmode" property of "\fBdiscard\fR"
512
Controls how an \fBACL\fR is modified during \fBchmod\fR(2). A file system with an "aclmode" property of "\fBdiscard\fR" deletes all \fBACL\fR entries that do not represent the mode of the file. An "aclmode" property of "\fBgroupmask\fR" (the default) reduces user or group permissions. The permissions are reduced, such that they are no greater than the group permission bits, unless it is a user entry that has the same \fBUID\fR as the owner of the file or directory. In this case, the \fBACL\fR permissions are reduced so that they are no greater than owner permission bits. A file system with an "aclmode" property of "\fBpassthrough\fR" indicates that no changes are made to the \fBACL\fR other than generating the necessary \fBACL\fR entries to represent the new mode of the file or directory.
496
deletes all \fBACL\fR entries that do not represent the mode of the file. An "aclmode" property of "\fBgroupmask\fR" (the default) reduces user or group permissions. The permissions are reduced, such that they are no greater than the group permission
497
bits, unless it is a user entry that has the same \fBUID\fR as the owner of the file or directory. In this case, the \fBACL\fR permissions are reduced so that they are no greater than owner permission bits. A file system with an "aclmode" property of "\fBpassthrough\fR" indicates that no changes are made to the \fBACL\fR other than generating the necessary \fBACL\fR entries to represent the new mode of the file or directory.
498
.RE
513
.RE
499
514
500
.sp
515
.sp
Lines 505-512 Link Here
505
.ad
520
.ad
506
.sp .6
521
.sp .6
507
.RS 4n
522
.RS 4n
508
Controls whether the access time for files is updated when they are read. Turning this property off avoids producing write traffic when reading files and can result in significant performance gains, though it might confuse mailers and other similar utilities. The default value
523
Controls whether the access time for files is updated when they are read. Turning this property off avoids producing write traffic when reading files and can result in significant performance gains, though it might confuse mailers and other similar utilities. The default value is "on".
509
is "on".
510
.RE
524
.RE
511
525
512
.sp
526
.sp
Lines 517-528 Link Here
517
.ad
531
.ad
518
.sp .6
532
.sp .6
519
.RS 4n
533
.RS 4n
520
If this property is set to "\fBoff\fR", the file system cannot be mounted, and is ignored by "\fBzfs mount -a\fR". Setting this property to "\fBoff\fR" is similar to setting the "mountpoint"
534
If this property is set to "\fBoff\fR", the file system cannot be mounted, and is ignored by "\fBzfs mount -a\fR". Setting this property to "\fBoff\fR" is similar to setting the "mountpoint" property to "\fBnone\fR", except that the dataset still has a normal "mountpoint" property, which can be inherited. Setting this property to "\fBoff\fR" allows datasets to be used solely as a mechanism to inherit properties. One example of setting canmount=\fBoff\fR is to have two datasets with the same mountpoint, so that the children of both datasets appear in the same directory, but might have different inherited characteristics.
521
property to "\fBnone\fR", except that the dataset still has a normal "mountpoint" property, which can be inherited. Setting this property to "\fBoff\fR" allows datasets to be used solely as a mechanism to inherit properties. One example
522
of setting canmount=\fBoff\fR is to have two datasets with the same mountpoint, so that the children of both datasets appear in the same directory, but might have different inherited characteristics.
523
.sp
535
.sp
524
When the "\fBnoauto\fR" option is set, a dataset can only be mounted and unmounted explicitly. The dataset is not mounted automatically when the dataset is created or imported, nor is it mounted by the "\fBzfs mount -a\fR" command or unmounted
536
When the "\fBnoauto\fR" option is set, a dataset can only be mounted and unmounted explicitly. The dataset is not mounted automatically when the dataset is created or imported, nor is it mounted by the "\fBzfs mount -a\fR" command or unmounted by the "\fBzfs unmount -a\fR" command. 
525
by the "\fBzfs unmount -a\fR" command. 
526
.sp
537
.sp
527
This property is not inherited.
538
This property is not inherited.
528
.RE
539
.RE
Lines 535-542 Link Here
535
.ad
546
.ad
536
.sp .6
547
.sp .6
537
.RS 4n
548
.RS 4n
538
Controls the checksum used to verify data integrity. The default value is "on", which automatically selects an appropriate algorithm (currently, \fIfletcher4\fR, but this may change in future releases). The value "off" disables integrity
549
Controls the checksum used to verify data integrity. The default value is "on", which automatically selects an appropriate algorithm (currently, \fIfletcher2\fR, but this may change in future releases). The value "off" disables integrity checking on user data. Disabling checksums is NOT a recommended practice.
539
checking on user data. Disabling checksums is NOT a recommended practice.
540
.RE
550
.RE
541
551
542
.sp
552
.sp
Lines 547-555 Link Here
547
.ad
557
.ad
548
.sp .6
558
.sp .6
549
.RS 4n
559
.RS 4n
550
Controls the compression algorithm used for this dataset. The "lzjb" compression algorithm is optimized for performance while providing decent data compression. Setting compression to "on" uses the "lzjb" compression algorithm. The "gzip"
560
Controls the compression algorithm used for this dataset. The "lzjb" compression algorithm is optimized for performance while providing decent data compression. Setting compression to "on" uses the "lzjb" compression algorithm. The "gzip" compression algorithm uses the same compression as the \fBgzip\fR(1) command. You can specify the "gzip" level by using the value "gzip-\fIN\fR" where \fIN\fR is an integer from 1 (fastest) to 9 (best compression ratio). Currently, "gzip" is equivalent to "gzip-6" (which is also the default for \fBgzip\fR(1)).
551
compression algorithm uses the same compression as the \fBgzip\fR(1) command. You can specify the "gzip" level by using the value "gzip-\fIN\fR" where \fIN\fR is
552
an integer from 1 (fastest) to 9 (best compression ratio). Currently, "gzip" is equivalent to "gzip-6" (which is also the default for \fBgzip\fR(1)).
553
.sp
561
.sp
554
This property can also be referred to by its shortened column name "compress".
562
This property can also be referred to by its shortened column name "compress".
555
.RE
563
.RE
Lines 562-569 Link Here
562
.ad
570
.ad
563
.sp .6
571
.sp .6
564
.RS 4n
572
.RS 4n
565
Controls the number of copies of data stored for this dataset. These copies are in addition to any redundancy provided by the pool, for example, mirroring or raid-z. The copies are stored on different disks, if possible. The space used by multiple copies is charged to the associated
573
Controls the number of copies of data stored for this dataset. These copies are in addition to any redundancy provided by the pool, for example, mirroring or raid-z. The copies are stored on different disks, if possible. The space used by multiple copies is charged to the associated file and dataset, changing the "used" property and counting against quotas and reservations.
566
file and dataset, changing the "used" property and counting against quotas and reservations.
567
.sp
574
.sp
568
Changing this property only affects newly-written data. Therefore, set this property at file system creation time by using the "\fB-o\fR copies=" option.
575
Changing this property only affects newly-written data. Therefore, set this property at file system creation time by using the "\fB-o\fR copies=" option.
569
.RE
576
.RE
Lines 600-607 Link Here
600
.RS 4n
607
.RS 4n
601
Controls the mount point used for this file system. See the "Mount Points" section for more information on how this property is used. 
608
Controls the mount point used for this file system. See the "Mount Points" section for more information on how this property is used. 
602
.sp
609
.sp
603
When the mountpoint property is changed for a file system, the file system and any children that inherit the mount point are unmounted. If the new value is "legacy", then they remain unmounted. Otherwise, they are automatically remounted in the new location if the property was
610
When the mountpoint property is changed for a file system, the file system and any children that inherit the mount point are unmounted. If the new value is "legacy", then they remain unmounted. Otherwise, they are automatically remounted in the new location if the property was previously "legacy" or "none", or if they were mounted before the property was changed. In addition, any shared file systems are unshared and shared in the new location.
604
previously "legacy" or "none", or if they were mounted before the property was changed. In addition, any shared file systems are unshared and shared in the new location.
605
.RE
611
.RE
606
612
607
.sp
613
.sp
Lines 612-630 Link Here
612
.ad
618
.ad
613
.sp .6
619
.sp .6
614
.RS 4n
620
.RS 4n
615
Controls whether the file system should be mounted with "\fBnbmand\fR" (Non Blocking mandatory locks). This is used for \fBCIFS\fR clients. 	Changes to this property only take effect when the file system is umounted and remounted. See \fBmount\fR(1M) for more information on "\fBnbmand\fR" mounts.
621
Controls whether the file system should be mounted with "\fBnbmand\fR" (Non Blocking mandatory locks). This is used for \fBCIFS\fR clients. Changes to this property only take effect when the file system is umounted and remounted. See \fBmount\fR(1M) for more information on "\fBnbmand\fR" mounts.
616
.RE
622
.RE
617
623
618
.sp
624
.sp
619
.ne 2
625
.ne 2
620
.mk
626
.mk
621
.na
627
.na
628
\fBprimarycache=\fIall\fR | \fInone\fR | \fImetadata\fR\fR
629
.ad
630
.sp .6
631
.RS 4n
632
Controls what is cached in the primary cache (ARC). If this property is set to "all", then both user data and metadata is cached. If this property is set to "none", then neither user data nor metadata is cached. If this property is set to "metadata", then only metadata is cached. The default value is "all".
633
.RE
634
635
.sp
636
.ne 2
637
.mk
638
.na
622
\fBquota=\fIsize\fR | \fInone\fR\fR
639
\fBquota=\fIsize\fR | \fInone\fR\fR
623
.ad
640
.ad
624
.sp .6
641
.sp .6
625
.RS 4n
642
.RS 4n
626
Limits the amount of space a dataset and its descendents can consume. This property enforces a hard limit on the amount of space used. This includes all space consumed by descendents, including file systems and snapshots. Setting a quota on a descendent of a dataset that already
643
Limits the amount of space a dataset and its descendents can consume. This property enforces a hard limit on the amount of space used. This includes all space consumed by descendents, including file systems and snapshots. Setting a quota on a descendent of a dataset that already has a quota does not override the ancestor's quota, but rather imposes an additional limit.
627
has a quota does not override the ancestor's quota, but rather imposes an additional limit.
628
.sp
644
.sp
629
Quotas cannot be set on volumes, as the "volsize" property acts as an implicit quota.
645
Quotas cannot be set on volumes, as the "volsize" property acts as an implicit quota.
630
.RE
646
.RE
Lines 650-660 Link Here
650
.ad
666
.ad
651
.sp .6
667
.sp .6
652
.RS 4n
668
.RS 4n
653
Specifies a suggested block size for files in the file system. This property is designed solely for use with database workloads that access files in fixed-size records. \fBZFS\fR automatically tunes block sizes according to internal algorithms optimized for typical
669
Specifies a suggested block size for files in the file system. This property is designed solely for use with database workloads that access files in fixed-size records. \fBZFS\fR automatically tunes block sizes according to internal algorithms optimized for typical access patterns. 
654
access patterns. 
655
.sp
670
.sp
656
For databases that create very large files but access them in small random chunks, these algorithms may be suboptimal. Specifying a "recordsize" greater than or equal to the record size of the database can result in significant performance gains. Use of this property for general
671
For databases that create very large files but access them in small random chunks, these algorithms may be suboptimal. Specifying a "recordsize" greater than or equal to the record size of the database can result in significant performance gains. Use of this property for general purpose file systems is strongly discouraged, and may adversely affect performance.
657
purpose file systems is strongly discouraged, and may adversely affect performance.
658
.sp
672
.sp
659
The size specified must be a power of two greater than or equal to 512 and less than or equal to 128 Kbytes.
673
The size specified must be a power of two greater than or equal to 512 and less than or equal to 128 Kbytes.
660
.sp
674
.sp
Lines 682-689 Link Here
682
.ad
696
.ad
683
.sp .6
697
.sp .6
684
.RS 4n
698
.RS 4n
685
The minimum amount of space guaranteed to a dataset, not including its descendents. When the amount of space used is below this value, the dataset is treated as if it were taking up the amount of space specified by \fBrefreservation\fR. The \fBrefreservation\fR reservation
699
The minimum amount of space guaranteed to a dataset, not including its descendents. When the amount of space used is below this value, the dataset is treated as if it were taking up the amount of space specified by \fBrefreservation\fR. The \fBrefreservation\fR reservation is accounted for in the parent datasets' space used, and counts against the parent datasets' quotas and reservations.
686
is accounted for in the parent datasets' space used, and counts against the parent datasets' quotas and reservations.
687
.sp
700
.sp
688
If \fBrefreservation\fR is set, a snapshot is only allowed if there is enough free pool space outside of this reservation to accommodate the current number of "referenced" bytes in the dataset.
701
If \fBrefreservation\fR is set, a snapshot is only allowed if there is enough free pool space outside of this reservation to accommodate the current number of "referenced" bytes in the dataset.
689
.sp
702
.sp
Lines 698-705 Link Here
698
.ad
711
.ad
699
.sp .6
712
.sp .6
700
.RS 4n
713
.RS 4n
701
The minimum amount of space guaranteed to a dataset and its descendents. When the amount of space used is below this value, the dataset is treated as if it were taking up the amount of space specified by its reservation. Reservations are accounted for in the parent datasets' space
714
The minimum amount of space guaranteed to a dataset and its descendents. When the amount of space used is below this value, the dataset is treated as if it were taking up the amount of space specified by its reservation. Reservations are accounted for in the parent datasets' space used, and count against the parent datasets' quotas and reservations.
702
used, and count against the parent datasets' quotas and reservations.
703
.sp
715
.sp
704
This property can also be referred to by its shortened column name, "reserv".
716
This property can also be referred to by its shortened column name, "reserv".
705
.RE
717
.RE
Lines 708-713 Link Here
708
.ne 2
720
.ne 2
709
.mk
721
.mk
710
.na
722
.na
723
\fBsecondarycache=\fIall\fR | \fInone\fR | \fImetadata\fR\fR
724
.ad
725
.sp .6
726
.RS 4n
727
Controls what is cached in the secondary cache (L2ARC). If this property is set to "all", then both user data and metadata is cached. If this property is set to "none", then neither user data nor metadata is cached. If this property is set to "metadata", then only metadata is cached. The default value is "all".
728
.RE
729
730
.sp
731
.ne 2
732
.mk
733
.na
711
\fBsetuid=\fIon\fR | \fIoff\fR\fR
734
\fBsetuid=\fIon\fR | \fIoff\fR\fR
712
.ad
735
.ad
713
.sp .6
736
.sp .6
Lines 723-730 Link Here
723
.ad
746
.ad
724
.sp .6
747
.sp .6
725
.RS 4n
748
.RS 4n
726
Like the "sharenfs" property, "shareiscsi" indicates whether a \fBZFS\fR volume is exported as an \fBiSCSI\fR target. The acceptable values for this property are "on", "off", and "type=disk".
749
Like the "sharenfs" property, "shareiscsi" indicates whether a \fBZFS\fR volume is exported as an \fBiSCSI\fR target. The acceptable values for this property are "on", "off", and "type=disk". The default value is "off". In the future, other target types might be supported. For example, "tape".
727
The default value is "off". In the future, other target types might be supported. For example, "tape".
728
.sp
750
.sp
729
You might want to set "shareiscsi=on" for a file system so that all \fBZFS\fR volumes within the file system are shared by default. Setting this property on a file system has no direct effect, however.
751
You might want to set "shareiscsi=on" for a file system so that all \fBZFS\fR volumes within the file system are shared by default. Setting this property on a file system has no direct effect, however.
730
.RE
752
.RE
Lines 737-751 Link Here
737
.ad
759
.ad
738
.sp .6
760
.sp .6
739
.RS 4n
761
.RS 4n
740
Controls whether the file system is shared by using the Solaris \fBCIFS\fR service, and what options are to be used. A file system with the "\fBsharesmb\fR" property set to "off" is managed through traditional tools such as \fBsharemgr\fR(1M). Otherwise, the file system is automatically shared and unshared with the "zfs share" and "zfs unshare" commands. If the property is set to "on",
762
Controls whether the file system is shared by using the Solaris \fBCIFS\fR service, and what options are to be used. A file system with the "\fBsharesmb\fR" property set to "off" is managed through traditional tools such as \fBsharemgr\fR(1M). Otherwise, the file system is automatically shared and unshared with the \fBzfs share\fR and \fBzfs unshare\fR commands. If the property is set to \fBon\fR, the \fBsharemgr\fR(1M) command is invoked with no options. Otherwise, the \fBsharemgr\fR(1M) command is invoked with options equivalent to the contents of this property.
741
the \fBsharemgr\fR(1M) command is invoked with no options. Otherwise, the \fBsharemgr\fR(1M) command is invoked with options equivalent to the contents of this property.
742
.sp
763
.sp
743
Because \fBSMB\fR shares requires a resource name, a unique resource name is constructed from the dataset name. The constructed name is a copy of the dataset name except that the characters in the dataset name, which would be illegal in the resource name, are replaced with underscore
764
Because \fBSMB\fR shares requires a resource name, a unique resource name is constructed from the dataset name. The constructed name is a copy of the dataset name except that the characters in the dataset name, which would be illegal in the resource name, are replaced with underscore (\fB_\fR) characters. A pseudo property "name" is also supported that allows you to replace the data set name with a specified name. The specified name is then used to replace the prefix dataset in the case of inheritance. For example, if the dataset \fBdata/home/john\fR is set to \fBname=john\fR, then \fBdata/home/john\fR has a resource name of \fBjohn\fR. If a child dataset of \fBdata/home/john/backups\fR, it has a resource name of \fBjohn_backups\fR.
744
(_) characters. A pseudo property "name" is also supported that allows you to replace the data set name with a specified name. The specified name is then used to replace the prefix dataset in the case of inheritance. For example, if the dataset "\fBdata/home/john\fR"
745
is set to "name=john", then "\fBdata/home/john\fR" has a resource name of "john". If a child dataset of "\fBdata/home/john/backups\fR", it has a resource name of "john_backups".
746
.sp
765
.sp
747
When the "sharesmb" property is changed for a dataset, the dataset and any children inheriting the property are re-shared with the new options, only if the property was previously set to "off", or if they were shared before the property was changed. If the new property
766
When SMB shares are created, the SMB share name appears as an entry in the \fB\&.zfs/shares\fR directory. You can use the \fBls\fR or \fBchmod\fR command to display the share-level ACLs on the entries in this directory.
748
is set to "off", the file systems are unshared.
767
.sp
768
When the \fBsharesmb\fR property is changed for a dataset, the dataset and any children inheriting the property are re-shared with the new options, only if the property was previously set to \fBoff\fR, or if they were shared before the property was changed. If the new property is set to \fBoff\fR, the file systems are unshared.
749
.RE
769
.RE
750
770
751
.sp
771
.sp
Lines 756-766 Link Here
756
.ad
776
.ad
757
.sp .6
777
.sp .6
758
.RS 4n
778
.RS 4n
759
Controls whether the file system is shared via \fBNFS\fR, and what options are used. A file system with a"\fBsharenfs\fR" property of "off" is managed through traditional tools such as \fBshare\fR(1M), \fBunshare\fR(1M), and \fBdfstab\fR(4). Otherwise, the file system is automatically shared and unshared with the "\fBzfs share\fR" and "\fBzfs unshare\fR" commands. If the property is set to "on",
779
Controls whether the file system is shared via \fBNFS\fR, and what options are used. A file system with a"\fBsharenfs\fR" property of "off" is managed through traditional tools such as \fBshare\fR(1M), \fBunshare\fR(1M), and \fBdfstab\fR(4). Otherwise, the file system is automatically shared and unshared with the "\fBzfs share\fR" and "\fBzfs unshare\fR" commands. If the property is set to "on", the \fBshare\fR(1M) command is invoked with no options. Otherwise, the \fBshare\fR(1M) command is invoked with options equivalent to the contents of this property.
760
the \fBshare\fR(1M) command is invoked with no options. Otherwise, the \fBshare\fR(1M) command is invoked with options equivalent to the contents of this property.
761
.sp
780
.sp
762
When the "sharenfs" property is changed for a dataset, the dataset and any children inheriting the property are re-shared with the new options, only if the property was previously "off", or if they were shared before the property was changed. If the new property is "off",
781
When the "sharenfs" property is changed for a dataset, the dataset and any children inheriting the property are re-shared with the new options, only if the property was previously "off", or if they were shared before the property was changed. If the new property is "off", the file systems are unshared.
763
the file systems are unshared.
764
.RE
782
.RE
765
783
766
.sp
784
.sp
Lines 793-806 Link Here
793
.ad
811
.ad
794
.sp .6
812
.sp .6
795
.RS 4n
813
.RS 4n
796
For volumes, specifies the logical size of the volume. By default, creating a volume establishes a reservation of equal size. For storage pools with a version number of 9 or higher, a \fBrefreservation\fR is set instead. Any changes to \fBvolsize\fR are
814
For volumes, specifies the logical size of the volume. By default, creating a volume establishes a reservation of equal size. For storage pools with a version number of 9 or higher, a \fBrefreservation\fR is set instead. Any changes to \fBvolsize\fR are reflected in an equivalent change to the reservation (or \fBrefreservation\fR). The \fBvolsize\fR can only be set to a multiple of \fBvolblocksize\fR, and cannot be zero.
797
reflected in an equivalent change to the reservation (or \fBrefreservation\fR). The \fBvolsize\fR can only be set to a multiple of \fBvolblocksize\fR, and cannot be zero.
798
.sp
815
.sp
799
The reservation is kept equal to the volume's logical size to prevent unexpected behavior for consumers. Without the reservation, the volume could run out of space, resulting in undefined behavior or data corruption, depending on how the volume is used. These effects can also occur when
816
The reservation is kept equal to the volume's logical size to prevent unexpected behavior for consumers. Without the reservation, the volume could run out of space, resulting in undefined behavior or data corruption, depending on how the volume is used. These effects can also occur when the volume size is changed while it is in use (particularly when shrinking the size). Extreme care should be used when adjusting the volume size.
800
the volume size is changed while it is in use (particularly when shrinking the size). Extreme care should be used when adjusting the volume size.
801
.sp
817
.sp
802
Though not recommended, a "sparse volume" (also known as "thin provisioning") can be created by specifying the \fB-s\fR option to the "\fBzfs create -V\fR" command, or by changing the reservation after the volume has been created.
818
Though not recommended, a "sparse volume" (also known as "thin provisioning") can be created by specifying the \fB-s\fR option to the "\fBzfs create -V\fR" command, or by changing the reservation after the volume has been created. A "sparse volume" is a volume where the reservation is less then the volume size. Consequently, writes to a sparse volume can fail with \fBENOSPC\fR when the pool is low on space. For a sparse volume, changes to \fBvolsize\fR are not reflected in the reservation.
803
A "sparse volume" is a volume where the reservation is less then the volume size. Consequently, writes to a sparse volume can fail with \fBENOSPC\fR when the pool is low on space. For a sparse volume, changes to \fBvolsize\fR are not reflected in the reservation.
804
.RE
819
.RE
805
820
806
.sp
821
.sp
Lines 838-845 Link Here
838
853
839
.sp
854
.sp
840
.LP
855
.LP
841
The following three properties cannot be changed after the file system is created, and therefore, should be set when the file system is created. If the properties are not set with the "\fBzfs create\fR" command, these properties are inherited from the parent dataset.
856
The following three properties cannot be changed after the file system is created, and therefore, should be set when the file system is created. If the properties are not set with the "\fBzfs create\fR" or "\fBzpool create\fR" commands, these properties are inherited from the parent dataset. If the parent dataset lacks these properties due to having been created prior to these features being supported, the new file system will have the default values for these properties.
842
If the parent dataset lacks these properties due to having been created prior to these features being supported, the new file system will have the default values for these properties.
843
.sp
857
.sp
844
.ne 2
858
.ne 2
845
.mk
859
.mk
Lines 848-858 Link Here
848
.ad
862
.ad
849
.sp .6
863
.sp .6
850
.RS 4n
864
.RS 4n
851
Indicates whether the file name matching algorithm used by the file system should be case-sensitive, case-insensitive, or allow a combination of both styles of matching. The default value for the "\fBcasesensitivity\fR" property is "\fBsensitive\fR."
865
Indicates whether the file name matching algorithm used by the file system should be case-sensitive, case-insensitive, or allow a combination of both styles of matching. The default value for the "\fBcasesensitivity\fR" property is "\fBsensitive\fR." Traditionally, UNIX and POSIX file systems have case-sensitive file names.
852
Traditionally, UNIX and POSIX file systems have case-sensitive file names.
853
.sp
866
.sp
854
The "\fBmixed\fR" value for the "\fBcasesensitivity\fR" property indicates that the file system can support requests for both case-sensitive and case-insensitive matching behavior. Currently, case-insensitive matching behavior on a file system
867
The "\fBmixed\fR" value for the "\fBcasesensitivity\fR" property indicates that the file system can support requests for both case-sensitive and case-insensitive matching behavior. Currently, case-insensitive matching behavior on a file system that supports mixed behavior is limited to the Solaris CIFS server product. For more information about the "mixed" value behavior, see the \fIZFS Administration Guide\fR.
855
that supports mixed behavior is limited to the Solaris CIFS server product. For more information about the "mixed" value behavior, see the \fIZFS Administration Guide\fR.
856
.RE
868
.RE
857
869
858
.sp
870
.sp
Lines 863-949 Link Here
863
.ad
875
.ad
864
.sp .6
876
.sp .6
865
.RS 4n
877
.RS 4n
866
Indicates whether the file system should perform a \fBunicode\fR normalization of file names whenever two file names are compared, and which normalization algorithm should be used. File names are always stored unmodified, names are normalized as part of any comparison
878
Indicates whether the file system should perform a \fBunicode\fR normalization of file names whenever two file names are compared, and which normalization algorithm should be used. File names are always stored unmodified, names are normalized as part of any comparison process. If this property is set to a legal value other than "\fBnone\fR," and the "\fButf8only\fR" property was left unspecified, the "\fButf8only\fR" property is automatically set to "\fBon\fR." The default value of the "\fBnormalization\fR" property is "\fBnone\fR." This property cannot be changed after the file system is created.
867
process. If this property is set to a legal value other than "\fBnone\fR," and the "\fButf8only\fR" property was left unspecified, the "\fButf8only\fR" property is automatically set to "\fBon\fR."
868
The default value of the "\fBnormalization\fR" property is "\fBnone\fR." This property cannot be changed after the file system is created.
869
.RE
879
.RE
870
880
871
.sp
881
.sp
872
.ne 2
882
.ne 2
873
.mk
883
.mk
874
.na
884
.na
875
\fBjailed =\fIon\fR | \fIoff\fR\fR
876
.ad
877
.sp .6
878
.RS 4n
879
Controls whether the dataset is managed from within a jail. The default value is "off".
880
.RE
881
882
.sp
883
.ne 2
884
.mk
885
.na
886
\fButf8only =\fBon\fR | \fBoff\fR\fR
885
\fButf8only =\fBon\fR | \fBoff\fR\fR
887
.ad
886
.ad
888
.sp .6
887
.sp .6
889
.RS 4n
888
.RS 4n
890
Indicates whether the file system should reject file names that include characters that are not present in the \fBUTF-8\fR character code set. If this property is explicitly set to "\fBoff\fR," the normalization property must either not be
889
Indicates whether the file system should reject file names that include characters that are not present in the \fBUTF-8\fR character code set. If this property is explicitly set to "\fBoff\fR," the normalization property must either not be explicitly set or be set to "\fBnone\fR." The default value for the "\fButf8only\fR" property is "off." This property cannot be changed after the file system is created.
891
explicitly set or be set to "\fBnone\fR." The default value for the "\fButf8only\fR" property is "off." This property cannot be changed after the file system is created.
892
.RE
890
.RE
893
891
894
.sp
892
.sp
895
.LP
893
.LP
896
The "\fBcasesensitivity\fR," "\fBnormalization\fR," and "\fButf8only\fR" properties are also new permissions that can be assigned to non-privileged users by using the \fBZFS\fR delegated administration
894
The "\fBcasesensitivity\fR," "\fBnormalization\fR," and "\fButf8only\fR" properties are also new permissions that can be assigned to non-privileged users by using the \fBZFS\fR delegated administration feature.
897
feature.
898
.SS "Temporary Mount Point Properties"
895
.SS "Temporary Mount Point Properties"
899
.sp
896
.sp
900
.LP
897
.LP
901
When a file system is mounted, either through \fBmount\fR(1M) for legacy mounts or the "\fBzfs mount\fR" command for normal file systems,
898
When a file system is mounted, either through \fBmount\fR(1M) for legacy mounts or the "\fBzfs mount\fR" command for normal file systems, its mount options are set according to its properties. The correlation between properties and mount options is as follows:
902
its mount options are set according to its properties. The correlation between properties and mount options is as follows:
903
.sp
899
.sp
904
.in +2
900
.in +2
905
.nf
901
.nf
906
    PROPERTY                MOUNT OPTION
902
    PROPERTY                MOUNT OPTION
907
    devices                 devices/nodevices
903
     devices                 devices/nodevices
908
    exec                    exec/noexec
904
     exec                    exec/noexec
909
    readonly                ro/rw
905
     readonly                ro/rw
910
    setuid                  setuid/nosetuid
906
     setuid                  setuid/nosetuid
911
    xattr                   xattr/noxattr
907
     xattr                   xattr/noxattr
912
.fi
908
.fi
913
.in -2
909
.in -2
914
.sp
910
.sp
915
911
916
.sp
912
.sp
917
.LP
913
.LP
918
In addition, these options can be set on a per-mount basis using the \fB-o\fR option, without affecting the property that is stored on disk. The values specified on the command line override the values stored in the dataset. The \fB-nosuid\fR option is an alias for "nodevices,nosetuid".
914
In addition, these options can be set on a per-mount basis using the \fB-o\fR option, without affecting the property that is stored on disk. The values specified on the command line override the values stored in the dataset. The \fB-nosuid\fR option is an alias for "nodevices,nosetuid". These properties are reported as "temporary" by the "\fBzfs get\fR" command. If the properties are changed while the dataset is mounted, the new setting overrides any temporary settings.
919
These properties are reported as "temporary" by the "\fBzfs get\fR" command. If the properties are changed while the dataset is mounted, the new setting overrides any temporary settings.
920
.SS "User Properties"
915
.SS "User Properties"
921
.sp
916
.sp
922
.LP
917
.LP
923
In addition to the standard native properties, \fBZFS\fR supports arbitrary user properties. User properties have no effect on \fBZFS\fR behavior, but applications or administrators can use them to annotate datasets.
918
In addition to the standard native properties, \fBZFS\fR supports arbitrary user properties. User properties have no effect on \fBZFS\fR behavior, but applications or administrators can use them to annotate datasets (file systems, volumes, and snapshots).
924
.sp
919
.sp
925
.LP
920
.LP
926
User property names must contain a colon (":") character, to distinguish them from native properties. They might contain lowercase letters, numbers, and the following punctuation characters: colon (":"), dash ("-"), period ("."), and underscore
921
User property names must contain a colon (":") character to distinguish them from native properties. They may contain lowercase letters, numbers, and the following punctuation characters: colon (":"), dash ("-"), period ("."), and underscore ("_"). The expected convention is that the property name is divided into two portions such as "\fImodule\fR:\fIproperty\fR", but this namespace is not enforced by \fBZFS\fR. User property names can be at most 256 characters, and cannot begin with a dash ("-").
927
("_"). The expected convention is that the property name is divided into two portions such as "\fImodule\fR:\fIproperty\fR", but this namespace is not enforced by \fBZFS\fR. User property names can be at most 256 characters,
928
and cannot begin with a dash ("-").
929
.sp
922
.sp
930
.LP
923
.LP
931
When making programmatic use of user properties, it is strongly suggested to use a reversed \fBDNS\fR domain name for the \fImodule\fR component of property names to reduce the chance that two independently-developed packages use the same property name for
924
When making programmatic use of user properties, it is strongly suggested to use a reversed \fBDNS\fR domain name for the \fImodule\fR component of property names to reduce the chance that two independently-developed packages use the same property name for different purposes. Property names beginning with "com.sun." are reserved for use by Sun Microsystems.
932
different purposes. Property names beginning with "com.sun." are reserved for use by Sun Microsystems.
933
.sp
925
.sp
934
.LP
926
.LP
935
The values of user properties are arbitrary strings, are always inherited, and are never validated. All of the commands that operate on properties ("zfs list", "zfs get", "zfs set", etc.) can be used to manipulate both native properties and user properties.
927
The values of user properties are arbitrary strings, are always inherited, and are never validated. All of the commands that operate on properties ("zfs list", "zfs get", "zfs set", etc.) can be used to manipulate both native properties and user properties. Use the "\fBzfs inherit\fR" command to clear a user property . If the property is not defined in any parent dataset, it is removed entirely. Property values are limited to 1024 characters.
936
Use the "\fBzfs inherit\fR" command to clear a user property . If the property is not defined in any parent dataset, it is removed entirely. Property values are limited to 1024 characters.
928
.SS "ZFS Volumes as Swap or Dump Devices"
937
.SS "Volumes as Swap or Dump Devices"
938
.sp
929
.sp
939
.LP
930
.LP
940
To set up a swap area, create a \fBZFS\fR volume of a specific size and then enable swap on that device. For more information, see the EXAMPLES section.
931
During an initial installation or a live upgrade from a \fBUFS\fR file system, a swap device and dump device are created on \fBZFS\fR volumes in the \fBZFS\fR root pool. By default, the swap area size is based on 1/2 the size of physical memory up to 2 Gbytes. The size of the dump device depends on the kernel's requirements at installation time. Separate \fBZFS\fR volumes must be used for the swap area and dump devices. Do not swap to a file on a \fBZFS\fR file system. A \fBZFS\fR swap file configuration is not supported. 
941
.sp
932
.sp
942
.LP
933
.LP
943
Do not swap to a file on a \fBZFS\fR file system. A \fBZFS\fR swap file configuration is not supported.
934
If you need to change your swap area or dump device after the system is installed or upgraded, use the \fBswap\fR(1M) and \fBdumpadm\fR(1M) commands. If you need to change the size of your swap area or dump device, see the \fISolaris ZFS Administration Guide\fR.
944
.sp
945
.LP
946
Using a \fBZFS\fR volume as a dump device is not supported.
947
.SH SUBCOMMANDS
935
.SH SUBCOMMANDS
948
.sp
936
.sp
949
.LP
937
.LP
Lines 974-983 Link Here
974
.na
962
.na
975
\fB\fB-p\fR\fR
963
\fB\fB-p\fR\fR
976
.ad
964
.ad
977
.RS 21n
965
.sp .6
978
.rt  
966
.RS 4n
979
Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the "mountpoint" property inherited from their parent. Any property specified on the command line using the \fB-o\fR option is ignored. If
967
Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the "mountpoint" property inherited from their parent. Any property specified on the command line using the \fB-o\fR option is ignored. If the target filesystem already exists, the operation completes successfully.
980
the target filesystem already exists, the operation completes successfully.
981
.RE
968
.RE
982
969
983
.sp
970
.sp
Lines 986-995 Link Here
986
.na
973
.na
987
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
974
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
988
.ad
975
.ad
989
.RS 21n
976
.sp .6
990
.rt  
977
.RS 4n
991
Sets the specified property as if "\fBzfs set property=value\fR" was invoked at the same time the dataset was created. Any editable \fBZFS\fR property can also be set at creation time. Multiple \fB-o\fR options can be specified. An
978
Sets the specified property as if "\fBzfs set property=value\fR" was invoked at the same time the dataset was created. Any editable \fBZFS\fR property can also be set at creation time. Multiple \fB-o\fR options can be specified. An error results if the same property is specified in multiple \fB-o\fR options.
992
error results if the same property is specified in multiple \fB-o\fR options.
993
.RE
979
.RE
994
980
995
.RE
981
.RE
Lines 1002-1009 Link Here
1002
.ad
988
.ad
1003
.sp .6
989
.sp .6
1004
.RS 4n
990
.RS 4n
1005
Creates a volume of the given size. The volume is exported as a block device in \fB/dev/zvol/{dsk,rdsk}/\fIpath\fR\fR, where \fIpath\fR is the name of the volume in the \fBZFS\fR namespace. The size represents
991
Creates a volume of the given size. The volume is exported as a block device in \fB/dev/zvol/{dsk,rdsk}/\fIpath\fR\fR, where \fIpath\fR is the name of the volume in the \fBZFS\fR namespace. The size represents the logical size as exported by the device. By default, a reservation of equal size is created.
1006
the logical size as exported by the device. By default, a reservation of equal size is created.
1007
.sp
992
.sp
1008
\fIsize\fR is automatically rounded up to the nearest 128 Kbytes to ensure that the volume has an integral number of blocks regardless of \fIblocksize\fR.
993
\fIsize\fR is automatically rounded up to the nearest 128 Kbytes to ensure that the volume has an integral number of blocks regardless of \fIblocksize\fR.
1009
.sp
994
.sp
Lines 1012-1021 Link Here
1012
.na
997
.na
1013
\fB\fB-p\fR\fR
998
\fB\fB-p\fR\fR
1014
.ad
999
.ad
1015
.RS 21n
1000
.sp .6
1016
.rt  
1001
.RS 4n
1017
Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the "mountpoint" property inherited from their parent. Any property specified on the command line using the \fB-o\fR option is ignored. If
1002
Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the "mountpoint" property inherited from their parent. Any property specified on the command line using the \fB-o\fR option is ignored. If the target filesystem already exists, the operation completes successfully.
1018
the target filesystem already exists, the operation completes successfully.
1019
.RE
1003
.RE
1020
1004
1021
.sp
1005
.sp
Lines 1024-1031 Link Here
1024
.na
1008
.na
1025
\fB\fB-s\fR\fR
1009
\fB\fB-s\fR\fR
1026
.ad
1010
.ad
1027
.RS 21n
1011
.sp .6
1028
.rt  
1012
.RS 4n
1029
Creates a sparse volume with no reservation. See "volsize" in the Native Properties section for more information about sparse volumes.
1013
Creates a sparse volume with no reservation. See "volsize" in the Native Properties section for more information about sparse volumes.
1030
.RE
1014
.RE
1031
1015
Lines 1035-1044 Link Here
1035
.na
1019
.na
1036
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1020
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1037
.ad
1021
.ad
1038
.RS 21n
1022
.sp .6
1039
.rt  
1023
.RS 4n
1040
Sets the specified property as if "\fBzfs set property=value\fR" was invoked at the same time the dataset was created. Any editable \fBZFS\fR property can also be set at creation time. Multiple \fB-o\fR options can be specified. An
1024
Sets the specified property as if "\fBzfs set property=value\fR" was invoked at the same time the dataset was created. Any editable \fBZFS\fR property can also be set at creation time. Multiple \fB-o\fR options can be specified. An error results if the same property is specified in multiple \fB-o\fR options.
1041
error results if the same property is specified in multiple \fB-o\fR options.
1042
.RE
1025
.RE
1043
1026
1044
.sp
1027
.sp
Lines 1047-1056 Link Here
1047
.na
1030
.na
1048
\fB\fB-b\fR \fIblocksize\fR\fR
1031
\fB\fB-b\fR \fIblocksize\fR\fR
1049
.ad
1032
.ad
1050
.RS 21n
1033
.sp .6
1051
.rt  
1034
.RS 4n
1052
Equivalent to "\fB\fR\fB-o\fR \fBvolblocksize=\fIblocksize\fR\fR". If this option is specified in conjunction with "\fB\fR\fB-o\fR \fBvolblocksize\fR", the resulting
1035
Equivalent to "\fB\fR\fB-o\fR \fBvolblocksize=\fIblocksize\fR\fR". If this option is specified in conjunction with "\fB\fR\fB-o\fR \fBvolblocksize\fR", the resulting behavior is undefined.
1053
behavior is undefined.
1054
.RE
1036
.RE
1055
1037
1056
.RE
1038
.RE
Lines 1070-1077 Link Here
1070
.na
1052
.na
1071
\fB\fB-r\fR\fR
1053
\fB\fB-r\fR\fR
1072
.ad
1054
.ad
1073
.RS 6n
1055
.sp .6
1074
.rt  
1056
.RS 4n
1075
Recursively destroy all children. If a snapshot is specified, destroy all snapshots with this name in descendent file systems.
1057
Recursively destroy all children. If a snapshot is specified, destroy all snapshots with this name in descendent file systems.
1076
.RE
1058
.RE
1077
1059
Lines 1081-1088 Link Here
1081
.na
1063
.na
1082
\fB\fB-R\fR\fR
1064
\fB\fB-R\fR\fR
1083
.ad
1065
.ad
1084
.RS 6n
1066
.sp .6
1085
.rt  
1067
.RS 4n
1086
Recursively destroy all dependents, including cloned file systems outside the target hierarchy. If a snapshot is specified, destroy all snapshots with this name in descendent file systems.
1068
Recursively destroy all dependents, including cloned file systems outside the target hierarchy. If a snapshot is specified, destroy all snapshots with this name in descendent file systems.
1087
.RE
1069
.RE
1088
1070
Lines 1092-1099 Link Here
1092
.na
1074
.na
1093
\fB\fB-f\fR\fR
1075
\fB\fB-f\fR\fR
1094
.ad
1076
.ad
1095
.RS 6n
1077
.sp .6
1096
.rt  
1078
.RS 4n
1097
Force an unmount of any file systems using the "\fBunmount -f\fR" command. This option has no effect on non-file systems or unmounted file systems.
1079
Force an unmount of any file systems using the "\fBunmount -f\fR" command. This option has no effect on non-file systems or unmounted file systems.
1098
.RE
1080
.RE
1099
1081
Lines 1104-1110 Link Here
1104
.ne 2
1086
.ne 2
1105
.mk
1087
.mk
1106
.na
1088
.na
1107
\fB\fBzfs snapshot\fR [\fB-r\fR] \fIfilesystem@snapname\fR|\fIvolume@snapname\fR\fR
1089
\fB\fBzfs snapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIfilesystem@snapname\fR|\fIvolume@snapname\fR\fR
1108
.ad
1090
.ad
1109
.sp .6
1091
.sp .6
1110
.RS 4n
1092
.RS 4n
Lines 1115-1127 Link Here
1115
.na
1097
.na
1116
\fB\fB-r\fR\fR
1098
\fB\fB-r\fR\fR
1117
.ad
1099
.ad
1118
.RS 6n
1100
.sp .6
1119
.rt  
1101
.RS 4n
1120
Recursively create snapshots of all descendent datasets. Snapshots are taken atomically, so that all recursive snapshots correspond to the same moment in time.
1102
Recursively create snapshots of all descendent datasets. Snapshots are taken atomically, so that all recursive snapshots correspond to the same moment in time.
1121
.RE
1103
.RE
1122
1104
1105
.sp
1106
.ne 2
1107
.mk
1108
.na
1109
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1110
.ad
1111
.sp .6
1112
.RS 4n
1113
Sets the specified property; see "\fBzfs create\fR" for details.
1123
.RE
1114
.RE
1124
1115
1116
.RE
1117
1125
.sp
1118
.sp
1126
.ne 2
1119
.ne 2
1127
.mk
1120
.mk
Lines 1130-1145 Link Here
1130
.ad
1123
.ad
1131
.sp .6
1124
.sp .6
1132
.RS 4n
1125
.RS 4n
1133
Roll back the given dataset to a previous snapshot. When a dataset is rolled back, all data that has changed since the snapshot is discarded, and the dataset reverts to the state at the time of the snapshot. By default, the command refuses to roll back to a snapshot other than
1126
Roll back the given dataset to a previous snapshot. When a dataset is rolled back, all data that has changed since the snapshot is discarded, and the dataset reverts to the state at the time of the snapshot. By default, the command refuses to roll back to a snapshot other than the most recent one. In order to do so, all intermediate snapshots must be destroyed by specifying the \fB-r\fR option.
1134
the most recent one. In order to do so, all intermediate snapshots must be destroyed by specifying the \fB-r\fR option.
1135
.sp
1127
.sp
1136
.ne 2
1128
.ne 2
1137
.mk
1129
.mk
1138
.na
1130
.na
1139
\fB\fB-r\fR\fR
1131
\fB\fB-r\fR\fR
1140
.ad
1132
.ad
1141
.RS 6n
1133
.sp .6
1142
.rt  
1134
.RS 4n
1143
Recursively destroy any snapshots more recent than the one specified.
1135
Recursively destroy any snapshots more recent than the one specified.
1144
.RE
1136
.RE
1145
1137
Lines 1149-1156 Link Here
1149
.na
1141
.na
1150
\fB\fB-R\fR\fR
1142
\fB\fB-R\fR\fR
1151
.ad
1143
.ad
1152
.RS 6n
1144
.sp .6
1153
.rt  
1145
.RS 4n
1154
Recursively destroy any more recent snapshots, as well as any clones of those snapshots.
1146
Recursively destroy any more recent snapshots, as well as any clones of those snapshots.
1155
.RE
1147
.RE
1156
1148
Lines 1160-1167 Link Here
1160
.na
1152
.na
1161
\fB\fB-f\fR\fR
1153
\fB\fB-f\fR\fR
1162
.ad
1154
.ad
1163
.RS 6n
1155
.sp .6
1164
.rt  
1156
.RS 4n
1165
Used with the \fB-R\fR option to force an unmount of any clone file systems that are to be destroyed.
1157
Used with the \fB-R\fR option to force an unmount of any clone file systems that are to be destroyed.
1166
.RE
1158
.RE
1167
1159
Lines 1171-1177 Link Here
1171
.ne 2
1163
.ne 2
1172
.mk
1164
.mk
1173
.na
1165
.na
1174
\fB\fBzfs clone\fR [\fB-p\fR] \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR\fR
1166
\fB\fBzfs clone\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR\fR
1175
.ad
1167
.ad
1176
.sp .6
1168
.sp .6
1177
.RS 4n
1169
.RS 4n
Lines 1182-1194 Link Here
1182
.na
1174
.na
1183
\fB\fB-p\fR\fR
1175
\fB\fB-p\fR\fR
1184
.ad
1176
.ad
1185
.RS 6n
1177
.sp .6
1186
.rt  
1178
.RS 4n
1187
Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the "mountpoint" property inherited from their parent. If the target filesystem or volume already exists, the operation completes successfully.
1179
Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the "mountpoint" property inherited from their parent. If the target filesystem or volume already exists, the operation completes successfully.
1188
.RE
1180
.RE
1189
1181
1182
.sp
1183
.ne 2
1184
.mk
1185
.na
1186
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
1187
.ad
1188
.sp .6
1189
.RS 4n
1190
Sets the specified property; see "\fBzfs create\fR" for details.
1190
.RE
1191
.RE
1191
1192
1193
.RE
1194
1192
.sp
1195
.sp
1193
.ne 2
1196
.ne 2
1194
.mk
1197
.mk
Lines 1197-1207 Link Here
1197
.ad
1200
.ad
1198
.sp .6
1201
.sp .6
1199
.RS 4n
1202
.RS 4n
1200
Promotes a clone file system to no longer be dependent on its "origin" snapshot. This makes it possible to destroy the file system that the clone was created from. The clone parent-child dependency relationship is reversed, so that the "origin" file system
1203
Promotes a clone file system to no longer be dependent on its "origin" snapshot. This makes it possible to destroy the file system that the clone was created from. The clone parent-child dependency relationship is reversed, so that the "origin" file system becomes a clone of the specified file system. 
1201
becomes a clone of the specified file system. 
1202
.sp
1204
.sp
1203
The snapshot that was cloned, and any snapshots previous to this snapshot, are now owned by the promoted clone. The space they use moves from the "origin" file system to the promoted clone, so enough space must be available to accommodate these snapshots. No new space is consumed
1205
The snapshot that was cloned, and any snapshots previous to this snapshot, are now owned by the promoted clone. The space they use moves from the "origin" file system to the promoted clone, so enough space must be available to accommodate these snapshots. No new space is consumed by this operation, but the space accounting is adjusted. The promoted clone must not have any conflicting snapshot names of its own. The "\fBrename\fR" subcommand can be used to rename any conflicting snapshots.
1204
by this operation, but the space accounting is adjusted. The promoted clone must not have any conflicting snapshot names of its own. The "\fBrename\fR" subcommand can be used to rename any conflicting snapshots.
1205
.RE
1206
.RE
1206
1207
1207
.sp
1208
.sp
Lines 1216-1236 Link Here
1216
.ad
1217
.ad
1217
.br
1218
.br
1218
.na
1219
.na
1219
\fB\fBzfs
1220
\fB\fBzfs rename\fR [\fB-p\fR] \fIfilesystem\fR|\fIvolume\fR \fIfilesystem\fR|\fIvolume\fR\fR
1220
rename\fR [\fB-p\fR] \fIfilesystem\fR|\fIvolume\fR \fIfilesystem\fR|\fIvolume\fR\fR
1221
.ad
1221
.ad
1222
.sp .6
1222
.sp .6
1223
.RS 4n
1223
.RS 4n
1224
Renames the given dataset. The new target can be located anywhere in the \fBZFS\fR hierarchy, with the exception of snapshots. Snapshots can only be renamed within the parent file system or volume. When renaming a snapshot, the parent file system of the snapshot does
1224
Renames the given dataset. The new target can be located anywhere in the \fBZFS\fR hierarchy, with the exception of snapshots. Snapshots can only be renamed within the parent file system or volume. When renaming a snapshot, the parent file system of the snapshot does not need to be specified as part of the second argument. Renamed file systems can inherit new mount points, in which case they are unmounted and remounted at the new mount point.
1225
not need to be specified as part of the second argument. Renamed file systems can inherit new mount points, in which case they are unmounted and remounted at the new mount point.
1226
.sp
1225
.sp
1227
.ne 2
1226
.ne 2
1228
.mk
1227
.mk
1229
.na
1228
.na
1230
\fB\fB-p\fR\fR
1229
\fB\fB-p\fR\fR
1231
.ad
1230
.ad
1232
.RS 6n
1231
.sp .6
1233
.rt  
1232
.RS 4n
1234
Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the "mountpoint" property inherited from their parent.
1233
Creates all the non-existing parent datasets. Datasets created in this manner are automatically mounted according to the "mountpoint" property inherited from their parent.
1235
.RE
1234
.RE
1236
1235
Lines 1259-1265 Link Here
1259
.ad
1258
.ad
1260
.sp .6
1259
.sp .6
1261
.RS 4n
1260
.RS 4n
1262
Lists the property information for the given datasets in tabular form. If specified, you can list property information by the absolute pathname or the relative pathname. By default, all datasets are displayed and contain the following fields:
1261
Lists the property information for the given datasets in tabular form. If specified, you can list property information by the absolute pathname or the relative pathname. By default, all file systems and volumes are displayed. Snapshots are displayed if the "listsnaps" property is "on" (the default is "off") . The following fields are displayed:
1263
.sp
1262
.sp
1264
.in +2
1263
.in +2
1265
.nf
1264
.nf
Lines 1274-1281 Link Here
1274
.na
1273
.na
1275
\fB\fB-H\fR\fR
1274
\fB\fB-H\fR\fR
1276
.ad
1275
.ad
1277
.RS 15n
1276
.sp .6
1278
.rt  
1277
.RS 4n
1279
Used for scripting mode. Do not print headers and separate fields by a single tab instead of arbitrary whitespace.
1278
Used for scripting mode. Do not print headers and separate fields by a single tab instead of arbitrary whitespace.
1280
.RE
1279
.RE
1281
1280
Lines 1285-1292 Link Here
1285
.na
1284
.na
1286
\fB\fB-r\fR\fR
1285
\fB\fB-r\fR\fR
1287
.ad
1286
.ad
1288
.RS 15n
1287
.sp .6
1289
.rt  
1288
.RS 4n
1290
Recursively display any children of the dataset on the command line. 
1289
Recursively display any children of the dataset on the command line. 
1291
.RE
1290
.RE
1292
1291
Lines 1296-1305 Link Here
1296
.na
1295
.na
1297
\fB\fB-o\fR \fIproperty\fR\fR
1296
\fB\fB-o\fR \fIproperty\fR\fR
1298
.ad
1297
.ad
1299
.RS 15n
1298
.sp .6
1300
.rt  
1299
.RS 4n
1301
A comma-separated list of properties to display. The property must be one of the properties described in the "Native Properties" section, or the special value "name" to display the dataset name.
1300
A comma-separated list of properties to display. The property must be:
1301
.RS +4
1302
.TP
1303
.ie t \(bu
1304
.el o
1305
one of the properties described in the "Native Properties" section.
1302
.RE
1306
.RE
1307
.RS +4
1308
.TP
1309
.ie t \(bu
1310
.el o
1311
a user property.
1312
.RE
1313
.RS +4
1314
.TP
1315
.ie t \(bu
1316
.el o
1317
the value "name" to display the dataset name.
1318
.RE
1319
.RS +4
1320
.TP
1321
.ie t \(bu
1322
.el o
1323
the value "space" to display space usage properties on file systems and volumes. This is a shortcut for "\fB-o name,avail,used,usedsnap,usedds, usedrefreserv,usedchild -t filesystem,volume\fR".
1324
.RE
1325
.RE
1303
1326
1304
.sp
1327
.sp
1305
.ne 2
1328
.ne 2
Lines 1307-1316 Link Here
1307
.na
1330
.na
1308
\fB\fB-s\fR \fIproperty\fR\fR
1331
\fB\fB-s\fR \fIproperty\fR\fR
1309
.ad
1332
.ad
1310
.RS 15n
1333
.sp .6
1311
.rt  
1334
.RS 4n
1312
A property to use for sorting the output by column in ascending order based on the value of the property. The property must be one of the properties described in the "Properties" section, or the special value "name" to sort by the dataset name. Multiple
1335
A property to use for sorting the output by column in ascending order based on the value of the property. The property must be one of the properties described in the "Properties" section, or the special value "name" to sort by the dataset name. Multiple properties can be specified at one time using multiple \fB-s\fR property options. Multiple \fB-s\fR options are evaluated from left to right in decreasing order of importance.
1313
properties can be specified at one time using multiple \fB-s\fR property options. Multiple \fB-s\fR options are evaluated from left to right in decreasing order of importance.
1314
.sp
1336
.sp
1315
The following is a list of sorting criteria:
1337
The following is a list of sorting criteria:
1316
.RS +4
1338
.RS +4
Lines 1345-1352 Link Here
1345
.na
1367
.na
1346
\fB\fB-S\fR \fIproperty\fR\fR
1368
\fB\fB-S\fR \fIproperty\fR\fR
1347
.ad
1369
.ad
1348
.RS 15n
1370
.sp .6
1349
.rt  
1371
.RS 4n
1350
Same as the \fB-s\fR option, but sorts by property in descending order. 
1372
Same as the \fB-s\fR option, but sorts by property in descending order. 
1351
.RE
1373
.RE
1352
1374
Lines 1356-1364 Link Here
1356
.na
1378
.na
1357
\fB\fB-t\fR \fItype\fR\fR
1379
\fB\fB-t\fR \fItype\fR\fR
1358
.ad
1380
.ad
1359
.RS 15n
1381
.sp .6
1360
.rt  
1382
.RS 4n
1361
A comma-separated list of types to display, where "type" is one of "filesystem", "snapshot" or "volume". For example, specifying "\fB-t snapshot\fR" displays only snapshots.
1383
A comma-separated list of types to display, where "type" is one of "filesystem", "snapshot" , "volume" or "all". For example, specifying "\fB-t snapshot\fR" displays only snapshots.
1362
.RE
1384
.RE
1363
1385
1364
.RE
1386
.RE
Lines 1367-1378 Link Here
1367
.ne 2
1389
.ne 2
1368
.mk
1390
.mk
1369
.na
1391
.na
1370
\fB\fBzfs set\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR ...\fR
1392
\fB\fBzfs set\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
1371
.ad
1393
.ad
1372
.sp .6
1394
.sp .6
1373
.RS 4n
1395
.RS 4n
1374
Sets the property to the given value for each dataset. Only some properties can be edited. See the "Properties" section for more information on what properties can be set and acceptable values. Numeric values can be specified as exact values, or in a human-readable
1396
Sets the property to the given value for each dataset. Only some properties can be edited. See the "Properties" section for more information on what properties can be set and acceptable values. Numeric values can be specified as exact values, or in a human-readable form with a suffix of "B", "K", "M", "G", "T", "P", "E", "Z" (for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes, or zettabytes, respectively). Properties cannot be set on snapshots.
1375
form with a suffix of "B", "K", "M", "G", "T", "P", "E", "Z" (for bytes, Kbytes, Mbytes, gigabytes, terabytes, petabytes, exabytes, or zettabytes, respectively). Properties cannot be set on snapshots.
1376
.RE
1397
.RE
1377
1398
1378
.sp
1399
.sp
Lines 1388-1412 Link Here
1388
.in +2
1409
.in +2
1389
.nf
1410
.nf
1390
    name      Dataset name
1411
    name      Dataset name
1391
    property  Property name
1412
     property  Property name
1392
    value     Property value
1413
     value     Property value
1393
    source    Property source. Can either be local, default,
1414
     source    Property source. Can either be local, default,
1394
              temporary, inherited, or none (-).
1415
               temporary, inherited, or none (-).
1395
.fi
1416
.fi
1396
.in -2
1417
.in -2
1397
.sp
1418
.sp
1398
1419
1399
All columns are displayed by default, though this can be controlled by using the \fB-o\fR option. This command takes a comma-separated list of properties as described in the "Native Properties" and "User Properties" sections.
1420
All columns are displayed by default, though this can be controlled by using the \fB-o\fR option. This command takes a comma-separated list of properties as described in the "Native Properties" and "User Properties" sections.
1400
.sp
1421
.sp
1401
The special value "all" can be used to display all properties for the given dataset.
1422
The special value "all" can be used to display all properties that apply to the given dataset's type (filesystem, volume or snapshot).
1402
.sp
1423
.sp
1403
.ne 2
1424
.ne 2
1404
.mk
1425
.mk
1405
.na
1426
.na
1406
\fB\fB-r\fR\fR
1427
\fB\fB-r\fR\fR
1407
.ad
1428
.ad
1408
.RS 13n
1429
.sp .6
1409
.rt  
1430
.RS 4n
1410
Recursively display properties for any children.
1431
Recursively display properties for any children.
1411
.RE
1432
.RE
1412
1433
Lines 1416-1423 Link Here
1416
.na
1437
.na
1417
\fB\fB-H\fR\fR
1438
\fB\fB-H\fR\fR
1418
.ad
1439
.ad
1419
.RS 13n
1440
.sp .6
1420
.rt  
1441
.RS 4n
1421
Display output in a form more easily parsed by scripts. Any headers are omitted, and fields are explicitly separated by a single tab instead of an arbitrary amount of space.
1442
Display output in a form more easily parsed by scripts. Any headers are omitted, and fields are explicitly separated by a single tab instead of an arbitrary amount of space.
1422
.RE
1443
.RE
1423
1444
Lines 1427-1434 Link Here
1427
.na
1448
.na
1428
\fB\fB-o\fR \fIfield\fR\fR
1449
\fB\fB-o\fR \fIfield\fR\fR
1429
.ad
1450
.ad
1430
.RS 13n
1451
.sp .6
1431
.rt  
1452
.RS 4n
1432
A comma-separated list of columns to display. "name,property,value,source" is the default value. 
1453
A comma-separated list of columns to display. "name,property,value,source" is the default value. 
1433
.RE
1454
.RE
1434
1455
Lines 1438-1445 Link Here
1438
.na
1459
.na
1439
\fB\fB-s\fR \fIsource\fR\fR
1460
\fB\fB-s\fR \fIsource\fR\fR
1440
.ad
1461
.ad
1441
.RS 13n
1462
.sp .6
1442
.rt  
1463
.RS 4n
1443
A comma-separated list of sources to display. Those properties coming from a source other than those in this list are ignored. Each source must be one of the following: "local,default,inherited,temporary,none". The default value is all sources.
1464
A comma-separated list of sources to display. Those properties coming from a source other than those in this list are ignored. Each source must be one of the following: "local,default,inherited,temporary,none". The default value is all sources.
1444
.RE
1465
.RE
1445
1466
Lines 1449-1456 Link Here
1449
.na
1470
.na
1450
\fB\fB-p\fR\fR
1471
\fB\fB-p\fR\fR
1451
.ad
1472
.ad
1452
.RS 13n
1473
.sp .6
1453
.rt  
1474
.RS 4n
1454
Display numbers in parsable (exact) values.
1475
Display numbers in parsable (exact) values.
1455
.RE
1476
.RE
1456
1477
Lines 1460-1466 Link Here
1460
.ne 2
1481
.ne 2
1461
.mk
1482
.mk
1462
.na
1483
.na
1463
\fB\fBzfs inherit\fR [\fB-r\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume\fR ...\fR
1484
\fB\fBzfs inherit\fR [\fB-r\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...\fR
1464
.ad
1485
.ad
1465
.sp .6
1486
.sp .6
1466
.RS 4n
1487
.RS 4n
Lines 1471-1478 Link Here
1471
.na
1492
.na
1472
\fB\fB-r\fR\fR
1493
\fB\fB-r\fR\fR
1473
.ad
1494
.ad
1474
.RS 6n
1495
.sp .6
1475
.rt  
1496
.RS 4n
1476
Recursively inherit the given property for all children.
1497
Recursively inherit the given property for all children.
1477
.RE
1498
.RE
1478
1499
Lines 1497-1504 Link Here
1497
.ad
1518
.ad
1498
.sp .6
1519
.sp .6
1499
.RS 4n
1520
.RS 4n
1500
Upgrades file systems to a new on-disk version. Once this is done, the file systems will no longer be accessible on systems running older versions of the software. "\fBzfs send\fR" streams generated from new snapshots of these file systems can not be accessed
1521
Upgrades file systems to a new on-disk version. Once this is done, the file systems will no longer be accessible on systems running older versions of the software. "\fBzfs send\fR" streams generated from new snapshots of these file systems can not be accessed on systems running older versions of the software.
1501
on systems running older versions of the software.
1502
.sp
1522
.sp
1503
The file system version is independent of the pool version (see \fBzpool\fR(1M) for information on the "\fBzpool upgrade\fR" command). 
1523
The file system version is independent of the pool version (see \fBzpool\fR(1M) for information on the "\fBzpool upgrade\fR" command). 
1504
.sp
1524
.sp
Lines 1509-1516 Link Here
1509
.na
1529
.na
1510
\fB\fB-a\fR\fR
1530
\fB\fB-a\fR\fR
1511
.ad
1531
.ad
1512
.RS 14n
1532
.sp .6
1513
.rt  
1533
.RS 4n
1514
Upgrade all file systems on all imported pools.
1534
Upgrade all file systems on all imported pools.
1515
.RE
1535
.RE
1516
1536
Lines 1520-1527 Link Here
1520
.na
1540
.na
1521
\fB\fIfilesystem\fR\fR
1541
\fB\fIfilesystem\fR\fR
1522
.ad
1542
.ad
1523
.RS 14n
1543
.sp .6
1524
.rt  
1544
.RS 4n
1525
Upgrade the specified file system. 
1545
Upgrade the specified file system. 
1526
.RE
1546
.RE
1527
1547
Lines 1531-1538 Link Here
1531
.na
1551
.na
1532
\fB\fB-r\fR\fR
1552
\fB\fB-r\fR\fR
1533
.ad
1553
.ad
1534
.RS 14n
1554
.sp .6
1535
.rt  
1555
.RS 4n
1536
Upgrade the specified file system and all descendent file systems 
1556
Upgrade the specified file system and all descendent file systems 
1537
.RE
1557
.RE
1538
1558
Lines 1542-1551 Link Here
1542
.na
1562
.na
1543
\fB\fB-V\fR \fIversion\fR\fR
1563
\fB\fB-V\fR \fIversion\fR\fR
1544
.ad
1564
.ad
1545
.RS 14n
1565
.sp .6
1546
.rt  
1566
.RS 4n
1547
Upgrade to the specified \fIversion\fR. If the \fB-V\fR flag is not specified, this command upgrades to the most recent version. This option can only be used to increase the version number, and only up to the most recent version supported by this
1567
Upgrade to the specified \fIversion\fR. If the \fB-V\fR flag is not specified, this command upgrades to the most recent version. This option can only be used to increase the version number, and only up to the most recent version supported by this software.
1548
software.
1549
.RE
1568
.RE
1550
1569
1551
.RE
1570
.RE
Lines 1576-1583 Link Here
1576
.na
1595
.na
1577
\fB\fB-o\fR \fIoptions\fR\fR
1596
\fB\fB-o\fR \fIoptions\fR\fR
1578
.ad
1597
.ad
1579
.RS 14n
1598
.sp .6
1580
.rt  
1599
.RS 4n
1581
An optional comma-separated list of mount options to use temporarily for the duration of the mount. See the "Temporary Mount Point Properties" section for details.
1600
An optional comma-separated list of mount options to use temporarily for the duration of the mount. See the "Temporary Mount Point Properties" section for details.
1582
.RE
1601
.RE
1583
1602
Lines 1587-1594 Link Here
1587
.na
1606
.na
1588
\fB\fB-O\fR\fR
1607
\fB\fB-O\fR\fR
1589
.ad
1608
.ad
1590
.RS 14n
1609
.sp .6
1591
.rt  
1610
.RS 4n
1592
Perform an overlay mount. See \fBmount\fR(1M) for more information.
1611
Perform an overlay mount. See \fBmount\fR(1M) for more information.
1593
.RE
1612
.RE
1594
1613
Lines 1598-1605 Link Here
1598
.na
1617
.na
1599
\fB\fB-v\fR\fR
1618
\fB\fB-v\fR\fR
1600
.ad
1619
.ad
1601
.RS 14n
1620
.sp .6
1602
.rt  
1621
.RS 4n
1603
Report mount progress.
1622
Report mount progress.
1604
.RE
1623
.RE
1605
1624
Lines 1609-1616 Link Here
1609
.na
1628
.na
1610
\fB\fB-a\fR\fR
1629
\fB\fB-a\fR\fR
1611
.ad
1630
.ad
1612
.RS 14n
1631
.sp .6
1613
.rt  
1632
.RS 4n
1614
Mount all available \fBZFS\fR file systems. Invoked automatically as part of the boot process. 
1633
Mount all available \fBZFS\fR file systems. Invoked automatically as part of the boot process. 
1615
.RE
1634
.RE
1616
1635
Lines 1620-1627 Link Here
1620
.na
1639
.na
1621
\fB\fIfilesystem\fR\fR
1640
\fB\fIfilesystem\fR\fR
1622
.ad
1641
.ad
1623
.RS 14n
1642
.sp .6
1624
.rt  
1643
.RS 4n
1625
Mount the specified filesystem.
1644
Mount the specified filesystem.
1626
.RE
1645
.RE
1627
1646
Lines 1642-1649 Link Here
1642
.na
1661
.na
1643
\fB\fB-f\fR\fR
1662
\fB\fB-f\fR\fR
1644
.ad
1663
.ad
1645
.RS 25n
1664
.sp .6
1646
.rt  
1665
.RS 4n
1647
Forcefully unmount the file system, even if it is currently in use.
1666
Forcefully unmount the file system, even if it is currently in use.
1648
.RE
1667
.RE
1649
1668
Lines 1653-1660 Link Here
1653
.na
1672
.na
1654
\fB\fB-a\fR\fR
1673
\fB\fB-a\fR\fR
1655
.ad
1674
.ad
1656
.RS 25n
1675
.sp .6
1657
.rt  
1676
.RS 4n
1658
Unmount all available \fBZFS\fR file systems. Invoked automatically as part of the boot process. 
1677
Unmount all available \fBZFS\fR file systems. Invoked automatically as part of the boot process. 
1659
.RE
1678
.RE
1660
1679
Lines 1664-1671 Link Here
1664
.na
1683
.na
1665
\fB\fIfilesystem\fR|\fImountpoint\fR\fR
1684
\fB\fIfilesystem\fR|\fImountpoint\fR\fR
1666
.ad
1685
.ad
1667
.RS 25n
1686
.sp .6
1668
.rt  
1687
.RS 4n
1669
Unmount the specified filesystem. The command can also be given a path to a \fBZFS\fR file system mount point on the system.
1688
Unmount the specified filesystem. The command can also be given a path to a \fBZFS\fR file system mount point on the system.
1670
.RE
1689
.RE
1671
1690
Lines 1686-1693 Link Here
1686
.na
1705
.na
1687
\fB\fB-a\fR\fR
1706
\fB\fB-a\fR\fR
1688
.ad
1707
.ad
1689
.RS 14n
1708
.sp .6
1690
.rt  
1709
.RS 4n
1691
Share all available \fBZFS\fR file systems. Invoked automatically as part of the boot process. 
1710
Share all available \fBZFS\fR file systems. Invoked automatically as part of the boot process. 
1692
.RE
1711
.RE
1693
1712
Lines 1697-1704 Link Here
1697
.na
1716
.na
1698
\fB\fIfilesystem\fR\fR
1717
\fB\fIfilesystem\fR\fR
1699
.ad
1718
.ad
1700
.RS 14n
1719
.sp .6
1701
.rt  
1720
.RS 4n
1702
Share the specified filesystem according to the "sharenfs" and "sharesmb" properties. File systems are shared when the "sharenfs" or "sharesmb" property is set.
1721
Share the specified filesystem according to the "sharenfs" and "sharesmb" properties. File systems are shared when the "sharenfs" or "sharesmb" property is set.
1703
.RE
1722
.RE
1704
1723
Lines 1719-1726 Link Here
1719
.na
1738
.na
1720
\fB\fB-a\fR\fR
1739
\fB\fB-a\fR\fR
1721
.ad
1740
.ad
1722
.RS 25n
1741
.sp .6
1723
.rt  
1742
.RS 4n
1724
Unshare all available \fBZFS\fR file systems. Invoked automatically as part of the boot process. 
1743
Unshare all available \fBZFS\fR file systems. Invoked automatically as part of the boot process. 
1725
.RE
1744
.RE
1726
1745
Lines 1730-1737 Link Here
1730
.na
1749
.na
1731
\fB\fIfilesystem\fR|\fImountpoint\fR\fR
1750
\fB\fIfilesystem\fR|\fImountpoint\fR\fR
1732
.ad
1751
.ad
1733
.RS 25n
1752
.sp .6
1734
.rt  
1753
.RS 4n
1735
Unshare the specified filesystem. The command can also be given a path to a \fBZFS\fR file system shared on the system.
1754
Unshare the specified filesystem. The command can also be given a path to a \fBZFS\fR file system shared on the system.
1736
.RE
1755
.RE
1737
1756
Lines 1741-1747 Link Here
1741
.ne 2
1760
.ne 2
1742
.mk
1761
.mk
1743
.na
1762
.na
1744
\fB\fBzfs send\fR [\fB-vR\fR] [\fB-\fR[\fB-iI\fR] \fIsnapshot\fR] \fIsnapshot\fR\fR
1763
\fB\fBzfs send\fR [\fB-vR\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR\fR
1745
.ad
1764
.ad
1746
.sp .6
1765
.sp .6
1747
.RS 4n
1766
.RS 4n
Lines 1752-1761 Link Here
1752
.na
1771
.na
1753
\fB\fB-i\fR \fIsnapshot\fR\fR
1772
\fB\fB-i\fR \fIsnapshot\fR\fR
1754
.ad
1773
.ad
1755
.RS 15n
1774
.sp .6
1756
.rt  
1775
.RS 4n
1757
Generate an incremental stream from the first \fIsnapshot\fR to the second \fIsnapshot\fR. The incremental source (the first \fIsnapshot\fR) can be specified as the last component of the snapshot name (for example,
1776
Generate an incremental stream from the first \fIsnapshot\fR to the second \fIsnapshot\fR. The incremental source (the first \fIsnapshot\fR) can be specified as the last component of the snapshot name (for example, the part after the "@"), and it is assumed to be from the same file system as the second \fIsnapshot\fR.
1758
the part after the "@"), and it is assumed to be from the same file system as the second \fIsnapshot\fR.
1759
.sp
1777
.sp
1760
If the destination is a clone, the source may be the origin snapshot, which must be fully specified (for example, "pool/fs@origin", not just "@origin").
1778
If the destination is a clone, the source may be the origin snapshot, which must be fully specified (for example, "pool/fs@origin", not just "@origin").
1761
.RE
1779
.RE
Lines 1766-1775 Link Here
1766
.na
1784
.na
1767
\fB\fB-I\fR \fIsnapshot\fR\fR
1785
\fB\fB-I\fR \fIsnapshot\fR\fR
1768
.ad
1786
.ad
1769
.RS 15n
1787
.sp .6
1770
.rt  
1788
.RS 4n
1771
Generate a stream package that sends all intermediary snapshots from the first snapshot to the second snapshot. For example, "\fB-I @a fs@d\fR" is similar to "\fB-i @a fs@b; -i @b fs@c; -i @c fs@d\fR". The incremental source snapshot
1789
Generate a stream package that sends all intermediary snapshots from the first snapshot to the second snapshot. For example, "\fB-I @a fs@d\fR" is similar to "\fB-i @a fs@b; -i @b fs@c; -i @c fs@d\fR". The incremental source snapshot may be specified as with the \fB-i\fR option.
1772
may be specified as with the \fB-i\fR option.
1773
.RE
1790
.RE
1774
1791
1775
.sp
1792
.sp
Lines 1778-1785 Link Here
1778
.na
1795
.na
1779
\fB\fB-R\fR\fR
1796
\fB\fB-R\fR\fR
1780
.ad
1797
.ad
1781
.RS 15n
1798
.sp .6
1782
.rt  
1799
.RS 4n
1783
Generate a replication stream package, which will replicate the specified filesystem, and all descendant file systems, up to the named snapshot. When received, all properties, snapshots, descendent file systems, and clones are preserved.
1800
Generate a replication stream package, which will replicate the specified filesystem, and all descendant file systems, up to the named snapshot. When received, all properties, snapshots, descendent file systems, and clones are preserved.
1784
.sp
1801
.sp
1785
If the \fB-i\fR or \fB-I\fR flags are used in conjunction with the \fB-R\fR flag, an incremental replication stream is generated. The current values of properties, and current snapshot and file system names are set when the stream is received. If the \fB-F\fR flag is specified when this stream is recieved, snapshots and file systems that do not exist on the sending side are destroyed. 
1802
If the \fB-i\fR or \fB-I\fR flags are used in conjunction with the \fB-R\fR flag, an incremental replication stream is generated. The current values of properties, and current snapshot and file system names are set when the stream is received. If the \fB-F\fR flag is specified when this stream is recieved, snapshots and file systems that do not exist on the sending side are destroyed. 
Lines 1791-1798 Link Here
1791
.na
1808
.na
1792
\fB\fB-v\fR\fR
1809
\fB\fB-v\fR\fR
1793
.ad
1810
.ad
1794
.RS 15n
1811
.sp .6
1795
.rt  
1812
.RS 4n
1796
Print verbose information about the stream package generated.
1813
Print verbose information about the stream package generated.
1797
.RE
1814
.RE
1798
1815
Lines 1811-1834 Link Here
1811
.ad
1828
.ad
1812
.sp .6
1829
.sp .6
1813
.RS 4n
1830
.RS 4n
1814
Creates a snapshot whose contents are as specified in the stream provided on standard input. If a full stream is received, then a new file system is created as well. Streams are created using the "\fBzfs send\fR" subcommand, which by default creates a full
1831
Creates a snapshot whose contents are as specified in the stream provided on standard input. If a full stream is received, then a new file system is created as well. Streams are created using the "\fBzfs send\fR" subcommand, which by default creates a full stream. "\fBzfs recv\fR" can be used as an alias for "\fBzfs receive\fR".
1815
stream. "\fBzfs recv\fR" can be used as an alias for "\fBzfs receive\fR".
1816
.sp
1832
.sp
1817
If an incremental stream is received, then the destination file system must already exist, and its most recent snapshot must match the incremental stream's source. For \fBzvols\fR, the destination device link is destroyed and re-created, which means the \fBzvol\fR cannot
1833
If an incremental stream is received, then the destination file system must already exist, and its most recent snapshot must match the incremental stream's source. For \fBzvols\fR, the destination device link is destroyed and re-created, which means the \fBzvol\fR cannot be accessed during the \fBreceive\fR operation.
1818
be accessed during the \fBreceive\fR operation.
1819
.sp
1834
.sp
1820
The name of the snapshot (and file system, if a full stream is received) that this subcommand creates depends on the argument type and the \fB-d\fR option.
1835
The name of the snapshot (and file system, if a full stream is received) that this subcommand creates depends on the argument type and the \fB-d\fR option.
1821
.sp
1836
.sp
1822
If the argument is a snapshot name, the specified \fIsnapshot\fR is created. If the argument is a file system or volume name, a snapshot with the same name as the sent snapshot is created within the specified \fIfilesystem\fR or \fIvolume\fR.
1837
If the argument is a snapshot name, the specified \fIsnapshot\fR is created. If the argument is a file system or volume name, a snapshot with the same name as the sent snapshot is created within the specified \fIfilesystem\fR or \fIvolume\fR. If the \fB-d\fR option is specified, the snapshot name is determined by appending the sent snapshot's name to the specified \fIfilesystem\fR. If the \fB-d\fR option is specified, any required file systems within the specified one are created.
1823
If the \fB-d\fR option is specified, the snapshot name is determined by appending the sent snapshot's name to the specified \fIfilesystem\fR. If the \fB-d\fR option is specified, any required file systems within the specified one are created.
1824
.sp
1838
.sp
1825
.ne 2
1839
.ne 2
1826
.mk
1840
.mk
1827
.na
1841
.na
1828
\fB\fB-d\fR\fR
1842
\fB\fB-d\fR\fR
1829
.ad
1843
.ad
1830
.RS 6n
1844
.sp .6
1831
.rt  
1845
.RS 4n
1832
Use the name of the sent snapshot to determine the name of the new snapshot as described in the paragraph above.
1846
Use the name of the sent snapshot to determine the name of the new snapshot as described in the paragraph above.
1833
.RE
1847
.RE
1834
1848
Lines 1838-1845 Link Here
1838
.na
1852
.na
1839
\fB\fB-v\fR\fR
1853
\fB\fB-v\fR\fR
1840
.ad
1854
.ad
1841
.RS 6n
1855
.sp .6
1842
.rt  
1856
.RS 4n
1843
Print verbose information about the stream and the time required to perform the receive operation.
1857
Print verbose information about the stream and the time required to perform the receive operation.
1844
.RE
1858
.RE
1845
1859
Lines 1849-1856 Link Here
1849
.na
1863
.na
1850
\fB\fB-n\fR\fR
1864
\fB\fB-n\fR\fR
1851
.ad
1865
.ad
1852
.RS 6n
1866
.sp .6
1853
.rt  
1867
.RS 4n
1854
Do not actually receive the stream. This can be useful in conjunction with the \fB-v\fR option to verify the name the receive operation would use.
1868
Do not actually receive the stream. This can be useful in conjunction with the \fB-v\fR option to verify the name the receive operation would use.
1855
.RE
1869
.RE
1856
1870
Lines 1860-1869 Link Here
1860
.na
1874
.na
1861
\fB\fB-F\fR\fR
1875
\fB\fB-F\fR\fR
1862
.ad
1876
.ad
1863
.RS 6n
1877
.sp .6
1864
.rt  
1878
.RS 4n
1865
Force a rollback of the file system to the most recent snapshot before performing the receive operation. If receiving an incremental replication stream (for example, one generated by "z\fBfs send -R -[iI]\fR"), destroy snapshots and file systems that do
1879
Force a rollback of the file system to the most recent snapshot before performing the receive operation. If receiving an incremental replication stream (for example, one generated by "z\fBfs send -R -[iI]\fR"), destroy snapshots and file systems that do not exist on the sending side.
1866
not exist on the sending side.
1867
.RE
1880
.RE
1868
1881
1869
.RE
1882
.RE
Lines 1889-1896 Link Here
1889
.ad
1902
.ad
1890
.sp .6
1903
.sp .6
1891
.RS 4n
1904
.RS 4n
1892
Specifies to whom the permissions are delegated. Multiple entities can be specified as a comma-separated list. If neither of the \fB-ug\fR options are specified, then the argument is interpreted preferentially as the keyword "everyone", then as a user name,
1905
Specifies to whom the permissions are delegated. Multiple entities can be specified as a comma-separated list. If neither of the \fB-ug\fR options are specified, then the argument is interpreted preferentially as the keyword "everyone", then as a user name, and lastly as a group name. To specify a user or group named "everyone", use the \fB-u\fR or \fB-g\fR options. To specify a group with the same name as a user, use the \fB-g\fR options.
1893
and lastly as a group name. To specify a user or group named "everyone", use the \fB-u\fR or \fB-g\fR options. To specify a group with the same name as a user, use the \fB-g\fR options.
1894
.RE
1906
.RE
1895
1907
1896
.sp
1908
.sp
Lines 1901-1908 Link Here
1901
.ad
1913
.ad
1902
.sp .6
1914
.sp .6
1903
.RS 4n
1915
.RS 4n
1904
Specifies that the permissions be delegated to "everyone." Multiple permissions may be specified as a comma-separated list. Permission names are the same as \fBZFS\fR subcommand and property names. See the property list below. Property set names, which
1916
Specifies that the permissions be delegated to "everyone." Multiple permissions may be specified as a comma-separated list. Permission names are the same as \fBZFS\fR subcommand and property names. See the property list below. Property set names, which begin with an "at sign" ("@") , may be specified. See the \fB-s\fR form below for details.
1905
begin with an "at sign" ("@") , may be specified. See the \fB-s\fR form below for details.
1906
.RE
1917
.RE
1907
1918
1908
.sp
1919
.sp
Lines 1913-1920 Link Here
1913
.ad
1924
.ad
1914
.sp .6
1925
.sp .6
1915
.RS 4n
1926
.RS 4n
1916
Specifies where the permissions are delegated. If neither of the \fB-ld\fR options are specified, or both are, then the permissions are allowed for the file system or volume, and all of its descendents. If only the \fB-l\fR option is used, then is allowed "locally"
1927
Specifies where the permissions are delegated. If neither of the \fB-ld\fR options are specified, or both are, then the permissions are allowed for the file system or volume, and all of its descendents. If only the \fB-l\fR option is used, then is allowed "locally" only for the specified file system. If only the \fB-d\fR option is used, then is allowed only for the descendent file systems.
1917
only for the specified file system. If only the \fB-d\fR option is used, then is allowed only for the descendent file systems.
1918
.RE
1928
.RE
1919
1929
1920
.RE
1930
.RE
Lines 1927-1975 Link Here
1927
.nf
1937
.nf
1928
NAME         TYPE         NOTES
1938
NAME         TYPE         NOTES
1929
allow        subcommand   Must also have the permission
1939
allow        subcommand   Must also have the permission
1930
                          that is being allowed.
1940
                           that is being allowed.
1931
clone        subcommand   Must also have the 'create' ability
1941
clone        subcommand   Must also have the 'create' ability
1932
                          and the 'mount' ability in the origin 
1942
                           and the 'mount' ability in the origin 
1933
                          file system.
1943
                           file system.
1934
create       subcommand   Must also have the 'mount' ability.
1944
create       subcommand   Must also have the 'mount' ability.
1935
destroy      subcommand   Must also have the 'mount' ability.     
1945
destroy      subcommand   Must also have the 'mount' ability.     
1936
mount        subcommand   Allows mount, unmount, and
1946
mount        subcommand   Allows mount, unmount, and
1937
                          create/remove zvol device links.
1947
                           create/remove zvol device links.
1938
promote      subcommand   Must also have the 'mount' ability and
1948
promote      subcommand   Must also have the 'mount' ability and
1939
                          'promote' ability in the origin file system.    
1949
                           'promote' ability in the origin file system.    
1940
receive      subcommand   Must also have the 'mount' ability and 
1950
receive      subcommand   Must also have the 'mount' ability and 
1941
                          the 'create' ability.     
1951
                           the 'create' ability.     
1942
rename       subcommand   Must also have the 'mount' ability and
1952
rename       subcommand   Must also have the 'mount' ability and
1943
                          the 'create' ability in the new parent.
1953
                           the 'create' ability in the new parent.
1944
rollback     subcommand   Must also have the 'mount' ability.      
1954
rollback     subcommand   Must also have the 'mount' ability.      
1945
snapshot     subcommand   Must also have the 'mount' ability.
1955
snapshot     subcommand   Must also have the 'mount' ability.
1946
share        subcommand   Allows share and unshare.
1956
share        subcommand   Allows share and unshare.
1947
send         subcommand
1957
send         subcommand
1948
      
1958
       
1949
      
1959
       
1950
aclinherit   property
1960
aclinherit       property
1951
aclmode      property
1961
aclmode          property
1952
atime        property
1962
atime            property
1953
canmount     property
1963
canmount         property
1954
checksum     property
1964
checksum         property
1955
compression  property
1965
compression      property
1956
copies       property
1966
copies           property
1957
devices      property
1967
devices          property
1958
exec         property
1968
exec             property
1959
mountpoint   property
1969
mountpoint       property
1960
quota        property
1970
primarycache     property
1961
readonly     property
1971
quota            property
1962
recordsize   property
1972
readonly         property
1963
reservation  property
1973
recordsize       property
1964
setuid       property
1974
reservation      property
1965
shareiscsi   property
1975
secondarycache   property
1966
sharenfs     property
1976
setuid           property
1967
snapdir      property
1977
shareiscsi       property
1968
version      property
1978
sharenfs         property
1969
volsize      property
1979
snapdir          property
1970
xattr        property
1980
version          property
1971
zoned        property
1981
volsize          property
1972
userprop     other        Allows changing any user property.
1982
xattr            property
1983
zoned            property
1984
userprop         other        Allows changing any user property.
1973
.fi
1985
.fi
1974
.in -2
1986
.in -2
1975
.sp
1987
.sp
Lines 1993-2000 Link Here
1993
.ad
2005
.ad
1994
.sp .6
2006
.sp .6
1995
.RS 4n
2007
.RS 4n
1996
Defines or adds permissions to a permission set. The set can be used by other \fBzfs allow\fR commands for the specified file system and its descendents. Sets are evaluated dynamically, so changes to a set are immediately reflected. Permission sets follow the same
2008
Defines or adds permissions to a permission set. The set can be used by other \fBzfs allow\fR commands for the specified file system and its descendents. Sets are evaluated dynamically, so changes to a set are immediately reflected. Permission sets follow the same naming restrictions as ZFS file systems, but the name must begin with an "at sign" ("@"), and can be no more than 64 characters long.
1997
naming restrictions as ZFS file systems, but the name must begin with an "at sign" ("@"), and can be no more than 64 characters long.
1998
.RE
2009
.RE
1999
2010
2000
.sp
2011
.sp
Lines 2017-2033 Link Here
2017
.ad
2028
.ad
2018
.sp .6
2029
.sp .6
2019
.RS 4n
2030
.RS 4n
2020
Removes permissions that were granted with the "\fBzfs allow\fR" command. No permissions are explicitly denied, so other permissions granted are still in effect. For example, if the permission is granted by an ancestor. If no permissions are specified,
2031
Removes permissions that were granted with the "\fBzfs allow\fR" command. No permissions are explicitly denied, so other permissions granted are still in effect. For example, if the permission is granted by an ancestor. If no permissions are specified, then all permissions for the specified \fIuser\fR, \fIgroup\fR, or \fIeveryone\fR are removed. Specifying "everyone" (or using the \fB-e\fR option) only removes the permissions that were granted to "everyone", not all permissions for every user and group. See the "\fBzfs allow\fR" command for a description of the \fB-ldugec\fR options.
2021
then all permissions for the specified \fIuser\fR, \fIgroup\fR, or \fIeveryone\fR are removed. Specifying "everyone" (or using the \fB-e\fR option) only removes the permissions that were granted to "everyone",
2022
not all permissions for every user and group. See the "\fBzfs allow\fR" command for a description of the \fB-ldugec\fR options.
2023
.sp
2032
.sp
2024
.ne 2
2033
.ne 2
2025
.mk
2034
.mk
2026
.na
2035
.na
2027
\fB\fB-r\fR\fR
2036
\fB\fB-r\fR\fR
2028
.ad
2037
.ad
2029
.RS 6n
2038
.sp .6
2030
.rt  
2039
.RS 4n
2031
Recursively remove the permissions from this file system and all descendents.
2040
Recursively remove the permissions from this file system and all descendents.
2032
.RE
2041
.RE
2033
2042
Lines 2048-2083 Link Here
2048
Removes permissions from a permission set. If no permissions are specified, then all permissions are removed, thus removing the set entirely.
2057
Removes permissions from a permission set. If no permissions are specified, then all permissions are removed, thus removing the set entirely.
2049
.RE
2058
.RE
2050
2059
2051
.sp
2052
.ne 2
2053
.mk
2054
.na
2055
\fB\fBzfs jail\fR \fIjailid\fR \fIfilesystem\fR\fR
2056
.ad
2057
.sp .6
2058
.RS 4n
2059
Attaches the given file system to the given jail. From now on this file system tree can be managed from within a jail if the "\fBjailed\fR" property has been set.
2060
To use this functionality, sysctl \fBsecurity.jail.enforce_statfs\fR should be set to 0 and sysctl \fBsecurity.jail.mount_allowed\fR should be set to 1.
2061
.RE
2062
2063
.sp
2064
.ne 2
2065
.mk
2066
.na
2067
\fB\fBzfs unjail\fR \fIjailid\fR \fIfilesystem\fR\fR
2068
.ad
2069
.sp .6
2070
.RS 4n
2071
Detaches the given file system from the given jail.
2072
.RE
2073
2074
.SH EXAMPLES
2060
.SH EXAMPLES
2075
.LP
2061
.LP
2076
\fBExample 1 \fRCreating a ZFS File System Hierarchy
2062
\fBExample 1 \fRCreating a ZFS File System Hierarchy
2077
.sp
2063
.sp
2078
.LP
2064
.LP
2079
The following commands create a file system named "\fBpool/home\fR" and a file system named "\fBpool/home/bob\fR". The mount point "\fB/export/home\fR" is set for the parent file system, and automatically inherited
2065
The following commands create a file system named "\fBpool/home\fR" and a file system named "\fBpool/home/bob\fR". The mount point "\fB/export/home\fR" is set for the parent file system, and automatically inherited by the child file system.
2080
by the child file system.
2081
2066
2082
.sp
2067
.sp
2083
.in +2
2068
.in +2
Lines 2107-2114 Link Here
2107
\fBExample 3 \fRTaking and destroying multiple snapshots
2092
\fBExample 3 \fRTaking and destroying multiple snapshots
2108
.sp
2093
.sp
2109
.LP
2094
.LP
2110
The following command creates snapshots named "\fByesterday\fR" of "\fBpool/home\fR" and all of its descendent file systems. Each snapshot is mounted on demand in the ".zfs/snapshot" directory at the root of its file system. The
2095
The following command creates snapshots named "\fByesterday\fR" of "\fBpool/home\fR" and all of its descendent file systems. Each snapshot is mounted on demand in the ".zfs/snapshot" directory at the root of its file system. The second command destroys the newly created snapshots.
2111
second command destroys the newly created snapshots.
2112
2096
2113
.sp
2097
.sp
2114
.in +2
2098
.in +2
Lines 2138-2144 Link Here
2138
\fBExample 5 \fRListing ZFS Datasets
2122
\fBExample 5 \fRListing ZFS Datasets
2139
.sp
2123
.sp
2140
.LP
2124
.LP
2141
The following command lists all active file systems and volumes in the system.
2125
The following command lists all active file systems and volumes in the system. Snapshots are displayed if the "listsnaps" property is "on" (the default is "off") . See \fBzpool\fR(1M) for more information on pool properties.
2142
2126
2143
.sp
2127
.sp
2144
.in +2
2128
.in +2
Lines 2146-2157 Link Here
2146
\fB# zfs list\fR
2130
\fB# zfs list\fR
2147
2131
2148
2132
2149
  NAME                      USED  AVAIL  REFER  MOUNTPOINT
2133
   NAME                      USED  AVAIL  REFER  MOUNTPOINT
2150
  pool                      450K   457G    18K  /pool
2134
   pool                      450K   457G    18K  /pool
2151
  pool/home                 315K   457G    21K  /export/home
2135
   pool/home                 315K   457G    21K  /export/home
2152
  pool/home/anne             18K   457G    18K  /export/home/anne
2136
   pool/home/anne             18K   457G    18K  /export/home/anne
2153
  pool/home/bob             276K   457G   276K  /export/home/bob
2137
   pool/home/bob             276K   457G   276K  /export/home/bob
2154
  pool/home/bob@yesterday      0      -   276K  -
2155
.fi
2138
.fi
2156
.in -2
2139
.in -2
2157
.sp
2140
.sp
Lines 2182-2223 Link Here
2182
\fB# zfs get all pool/home/bob\fR
2165
\fB# zfs get all pool/home/bob\fR
2183
2166
2184
2167
2185
  NAME           PROPERTY       VALUE                  SOURCE
2168
NAME           PROPERTY              VALUE                  SOURCE
2186
  pool/home/bob  type           filesystem             -
2169
pool/home/bob  type                  filesystem             -
2187
  pool/home/bob  creation       Thu Jul 12 14:44 2007  -
2170
pool/home/bob  creation              Thu Jul 12 14:44 2007  -
2188
  pool/home/bob  used           276K                   -
2171
pool/home/bob  used                  276K                   -
2189
  pool/home/bob  available      50.0G                  -
2172
pool/home/bob  available             50.0G                  -
2190
  pool/home/bob  referenced     276K                   -
2173
pool/home/bob  referenced            276K                   -
2191
  pool/home/bob  compressratio  1.00x                  -
2174
pool/home/bob  compressratio         1.00x                  -
2192
  pool/home/bob  mounted        yes                    -
2175
pool/home/bob  mounted               yes                    -
2193
  pool/home/bob  quota          50G                    local
2176
pool/home/bob  quota                 50G                    local
2194
  pool/home/bob  reservation    none                   default
2177
pool/home/bob  reservation           none                   default
2195
  pool/home/bob  recordsize     128K                   default
2178
pool/home/bob  recordsize            128K                   default
2196
  pool/home/bob  mountpoint     /export/home/bob       inherited from
2179
pool/home/bob  mountpoint            /export/home/bob       inherited 
2197
                                                       pool/home
2180
                                                            from
2198
  pool/home/bob  checksum       on                     default
2181
                                                            pool/home
2199
  pool/home/bob  compression    off                    default
2182
pool/home/bob  sharenfs              off                    default
2200
  pool/home/bob  atime          on                     default
2183
pool/home/bob  checksum              on                     default
2201
  pool/home/bob  devices        on                     default
2184
pool/home/bob  compression           off                    default
2202
  pool/home/bob  exec           on                     default
2185
pool/home/bob  atime                 on                     default
2203
  pool/home/bob  setuid         on                     default
2186
pool/home/bob  devices               on                     default
2204
  pool/home/bob  readonly       off                    default
2187
pool/home/bob  exec                  on                     default
2205
  pool/home/bob  zoned          off                    default
2188
pool/home/bob  setuid                on                     default
2206
  pool/home/bob  snapdir        hidden                 default
2189
pool/home/bob  readonly              off                    default
2207
  pool/home/bob  aclmode        groupmask              default
2190
pool/home/bob  zoned                 off                    default
2208
  pool/home/bob  aclinherit     restricted             default
2191
pool/home/bob  snapdir               hidden                 default
2209
  pool/home/bob  canmount       on                     default
2192
pool/home/bob  aclmode               groupmask              default
2210
  pool/home/bob  nbmand         off                    default
2193
pool/home/bob  aclinherit            restricted             default
2211
  pool/home/bob  shareiscsi     off                    default
2194
pool/home/bob  canmount              on                     default
2212
  pool/home/bob  sharesmb       off                    default
2195
pool/home/bob  shareiscsi            off                    default
2213
  pool/home/bob  sharenfs       off                    default
2196
pool/home/bob  xattr                 on                     default
2214
  pool/home/bob  xattr          on                     default
2197
pool/home/bob  copies                1                      default
2215
  pool/home/bob  refquota       10M                    local
2198
pool/home/bob  version               1                      -
2216
  pool/home/bob  refreservation none                   default
2199
pool/home/bob  utf8only              off                    -
2217
  pool/home/bob  copies         1                      default
2200
pool/home/bob  normalization         none                   -
2218
  pool/home/bob  version        1                      -
2201
pool/home/bob  casesensitivity       sensitive              -
2219
2202
pool/home/bob  vscan                 off                    default
2220
   
2203
pool/home/bob  nbmand                off                    default
2204
pool/home/bob  sharesmb              off                    default
2205
pool/home/bob  refquota              10M                    local
2206
pool/home/bob  refreservation        none                   default
2207
pool/home/bob  primarycache          all                    default
2208
pool/home/bob  secondarycache        a                      default
2209
pool/home/bob  usedbysnapshots       0                      -
2210
pool/home/bob  usedbydataset         18K                    -
2211
pool/home/bob  usedbychildren        0                      -
2212
pool/home/bob  usedbyrefreservation  0                      -
2213
    
2221
.fi
2214
.fi
2222
.in -2
2215
.in -2
2223
.sp
2216
.sp
Lines 2244-2252 Link Here
2244
.nf
2237
.nf
2245
\fB# zfs get -r -s local -o name,property,value all pool/home/bob\fR
2238
\fB# zfs get -r -s local -o name,property,value all pool/home/bob\fR
2246
2239
2247
  NAME             PROPERTY      VALUE
2240
   NAME             PROPERTY      VALUE
2248
  pool             compression   on
2241
   pool             compression   on
2249
  pool/home        checksum      off
2242
   pool/home        checksum      off
2250
.fi
2243
.fi
2251
.in -2
2244
.in -2
2252
.sp
2245
.sp
Lines 2289-2303 Link Here
2289
.in +2
2282
.in +2
2290
.nf
2283
.nf
2291
\fB# zfs create pool/project/production\fR
2284
\fB# zfs create pool/project/production\fR
2292
 populate /pool/project/production with data
2285
  populate /pool/project/production with data
2293
\fB# zfs snapshot pool/project/production@today
2286
\fB# zfs snapshot pool/project/production@today
2294
# zfs clone pool/project/production@today pool/project/beta\fR
2287
# zfs clone pool/project/production@today pool/project/beta\fR
2295
 make changes to /pool/project/beta and test them
2288
  make changes to /pool/project/beta and test them
2296
\fB# zfs promote pool/project/beta
2289
\fB# zfs promote pool/project/beta
2297
# zfs rename pool/project/production pool/project/legacy
2290
# zfs rename pool/project/production pool/project/legacy
2298
# zfs rename pool/project/beta pool/project/production\fR
2291
# zfs rename pool/project/beta pool/project/production\fR
2299
 once the legacy version is no longer needed, it can be
2292
  once the legacy version is no longer needed, it can be
2300
 destroyed
2293
  destroyed
2301
\fB# zfs destroy pool/project/legacy\fR
2294
\fB# zfs destroy pool/project/legacy\fR
2302
.fi
2295
.fi
2303
.in -2
2296
.in -2
Lines 2321-2336 Link Here
2321
\fBExample 12 \fRRemotely Replicating ZFS Data
2314
\fBExample 12 \fRRemotely Replicating ZFS Data
2322
.sp
2315
.sp
2323
.LP
2316
.LP
2324
The following commands send a full stream and then an incremental stream to a remote machine, restoring them into "\fBpoolB/received/fs\fR@a" and "\fBpoolB/received/fs@b\fR", respectively. "\fBpoolB\fR" must contain
2317
The following commands send a full stream and then an incremental stream to a remote machine, restoring them into "\fBpoolB/received/fs\fR@a" and "\fBpoolB/received/fs@b\fR", respectively. "\fBpoolB\fR" must contain the file system "\fBpoolB/received\fR", and must not initially contain "\fBpoolB/received/fs\fR".
2325
the file system "\fBpoolB/received\fR", and must not initially contain "\fBpoolB/received/fs\fR".
2326
2318
2327
.sp
2319
.sp
2328
.in +2
2320
.in +2
2329
.nf
2321
.nf
2330
# zfs send pool/fs@a | \e
2322
# zfs send pool/fs@a | \e
2331
  ssh host zfs receive poolB/received/fs@a
2323
   ssh host zfs receive poolB/received/fs@a
2332
# zfs send -i a pool/fs@b | ssh host \e
2324
# zfs send -i a pool/fs@b | ssh host \e
2333
  zfs receive poolB/received/fs
2325
   zfs receive poolB/received/fs
2334
.fi
2326
.fi
2335
.in -2
2327
.in -2
2336
.sp
2328
.sp
Lines 2339-2375 Link Here
2339
\fBExample 13 \fRUsing the zfs receive -d Option
2331
\fBExample 13 \fRUsing the zfs receive -d Option
2340
.sp
2332
.sp
2341
.LP
2333
.LP
2342
The following command sends a full stream of "\fBpoolA/fsA/fsB@snap\fR" to a remote machine, receiving it into "\fBpoolB/received/fsA/fsB@snap\fR". The "\fBfsA/fsB@snap\fR" portion of the received snapshot's name
2334
The following command sends a full stream of "\fBpoolA/fsA/fsB@snap\fR" to a remote machine, receiving it into "\fBpoolB/received/fsA/fsB@snap\fR". The "\fBfsA/fsB@snap\fR" portion of the received snapshot's name is determined from the name of the sent snapshot. "\fBpoolB\fR" must contain the file system "\fBpoolB/received\fR". If "\fBpoolB/received/fsA\fR" does not exist, it is be created as an empty file system.
2343
is determined from the name of the sent snapshot. "\fBpoolB\fR" must contain the file system "\fBpoolB/received\fR". If "\fBpoolB/received/fsA\fR" does not exist, it is be created as an empty file system.
2344
2335
2345
.sp
2336
.sp
2346
.in +2
2337
.in +2
2347
.nf
2338
.nf
2348
\fB# zfs send poolA/fsA/fsB@snap | \e
2339
\fB# zfs send poolA/fsA/fsB@snap | \e
2349
  ssh host zfs receive -d poolB/received\fR
2340
   ssh host zfs receive -d poolB/received\fR
2350
.fi
2341
.fi
2351
.in -2
2342
.in -2
2352
.sp
2343
.sp
2353
2344
2354
.LP
2345
.LP
2355
\fBExample 14 \fRCreating a ZFS volume as a Swap Device
2346
\fBExample 14 \fRSetting User Properties
2356
.sp
2347
.sp
2357
.LP
2348
.LP
2358
The following example shows how to create a 5-Gbyte ZFS volume and then add the volume as a swap device.
2359
2360
.sp
2361
.in +2
2362
.nf
2363
\fB# zfs create -V 5gb tank/vol
2364
# swap -a /dev/zvol/dsk/tank/vol\fR
2365
.fi
2366
.in -2
2367
.sp
2368
2369
.LP
2370
\fBExample 15 \fRSetting User Properties
2371
.sp
2372
.LP
2373
The following example sets the user defined "com.example:department" property for a dataset.
2349
The following example sets the user defined "com.example:department" property for a dataset.
2374
2350
2375
.sp
2351
.sp
Lines 2381-2387 Link Here
2381
.sp
2357
.sp
2382
2358
2383
.LP
2359
.LP
2384
\fBExample 16 \fRCreating a ZFS Volume as a iSCSI Target Device
2360
\fBExample 15 \fRCreating a ZFS Volume as a iSCSI Target Device
2385
.sp
2361
.sp
2386
.LP
2362
.LP
2387
The following example shows how to create a \fBZFS\fR volume as an \fBiSCSI\fR target. 
2363
The following example shows how to create a \fBZFS\fR volume as an \fBiSCSI\fR target. 
Lines 2390-2401 Link Here
2390
.in +2
2366
.in +2
2391
.nf
2367
.nf
2392
\fB# zfs create -V 2g pool/volumes/vol1
2368
\fB# zfs create -V 2g pool/volumes/vol1
2393
# zfs set shareiscsi=on pool/volumes/vol1
2369
 # zfs set shareiscsi=on pool/volumes/vol1
2394
# iscsitadm list target\fR
2370
 # iscsitadm list target\fR
2395
Target: pool/volumes/vol1
2371
 Target: pool/volumes/vol1
2396
iSCSI Name: 
2372
 iSCSI Name: 
2397
iqn.1986-03.com.sun:02:7b4b02a6-3277-eb1b-e686-a24762c52a8c
2373
 iqn.1986-03.com.sun:02:7b4b02a6-3277-eb1b-e686-a24762c52a8c
2398
Connections: 0
2374
 Connections: 0
2399
.fi
2375
.fi
2400
.in -2
2376
.in -2
2401
.sp
2377
.sp
Lines 2404-2410 Link Here
2404
.LP
2380
.LP
2405
After the \fBiSCSI\fR target is created, set up the \fBiSCSI\fR initiator. For more information about the Solaris \fBiSCSI\fR initiator, see the Solaris Administration Guide: Devices and File Systems.
2381
After the \fBiSCSI\fR target is created, set up the \fBiSCSI\fR initiator. For more information about the Solaris \fBiSCSI\fR initiator, see the Solaris Administration Guide: Devices and File Systems.
2406
.LP
2382
.LP
2407
\fBExample 17 \fRPerforming a Rolling Snapshot
2383
\fBExample 16 \fRPerforming a Rolling Snapshot
2408
.sp
2384
.sp
2409
.LP
2385
.LP
2410
The following example shows how to maintain a history of snapshots with a consistent naming scheme. To keep a week's worth of snapshots, the user destroys the oldest snapshot, renames the remaining snapshots, and then creates a new snapshot, as follows:
2386
The following example shows how to maintain a history of snapshots with a consistent naming scheme. To keep a week's worth of snapshots, the user destroys the oldest snapshot, renames the remaining snapshots, and then creates a new snapshot, as follows:
Lines 2424-2430 Link Here
2424
.sp
2400
.sp
2425
2401
2426
.LP
2402
.LP
2427
\fBExample 18 \fRSetting sharenfs Property Options on a ZFS File System
2403
\fBExample 17 \fRSetting sharenfs Property Options on a ZFS File System
2428
.sp
2404
.sp
2429
.LP
2405
.LP
2430
The following commands show how to set "sharenfs" property options to enable \fBrw\fR access for a set of \fBIP\fR addresses and to enable root access for system \fBneo\fR on the \fBtank/home\fR file system.
2406
The following commands show how to set "sharenfs" property options to enable \fBrw\fR access for a set of \fBIP\fR addresses and to enable root access for system \fBneo\fR on the \fBtank/home\fR file system.
Lines 2433-2439 Link Here
2433
.in +2
2409
.in +2
2434
.nf
2410
.nf
2435
\fB# zfs set sharenfs='rw=@123.123.0.0/16,root=neo' tank/home\fR
2411
\fB# zfs set sharenfs='rw=@123.123.0.0/16,root=neo' tank/home\fR
2436
2412
 
2437
.fi
2413
.fi
2438
.in -2
2414
.in -2
2439
.sp
2415
.sp
Lines 2443-2449 Link Here
2443
If you are using \fBDNS\fR for host name resolution, specify the fully qualified hostname.
2419
If you are using \fBDNS\fR for host name resolution, specify the fully qualified hostname.
2444
2420
2445
.LP
2421
.LP
2446
\fBExample 19 \fRDelegating ZFS Administration Permissions on a ZFS Dataset
2422
\fBExample 18 \fRDelegating ZFS Administration Permissions on a ZFS Dataset
2447
.sp
2423
.sp
2448
.LP
2424
.LP
2449
The following example shows how to set permissions so that user "\fBcindys\fR" can create, destroy, mount and take snapshots on \fBtank/cindys\fR. The permissions on \fBtank/cindys\fR are also displayed.
2425
The following example shows how to set permissions so that user "\fBcindys\fR" can create, destroy, mount and take snapshots on \fBtank/cindys\fR. The permissions on \fBtank/cindys\fR are also displayed.
Lines 2455-2463 Link Here
2455
# zfs allow tank/cindys\fR
2431
# zfs allow tank/cindys\fR
2456
-------------------------------------------------------------
2432
-------------------------------------------------------------
2457
Local+Descendent permissions on (tank/cindys)
2433
Local+Descendent permissions on (tank/cindys)
2458
         user cindys create,destroy,mount,snapshot
2434
          user cindys create,destroy,mount,snapshot
2459
-------------------------------------------------------------
2435
-------------------------------------------------------------
2460
2436
 
2461
.fi
2437
.fi
2462
.in -2
2438
.in -2
2463
.sp
2439
.sp
Lines 2474-2480 Link Here
2474
.sp
2450
.sp
2475
2451
2476
.LP
2452
.LP
2477
\fBExample 20 \fRDelegating Create Time Permissions on a ZFS Dataset
2453
\fBExample 19 \fRDelegating Create Time Permissions on a ZFS Dataset
2478
.sp
2454
.sp
2479
.LP
2455
.LP
2480
The following example shows how to grant anyone in the group \fBstaff\fR to create file systems in \fBtank/users\fR. This syntax also allows staff members to destroy their own file systems, but not destroy anyone else's file system. The permissions on \fBtank/users\fR are also displayed.
2456
The following example shows how to grant anyone in the group \fBstaff\fR to create file systems in \fBtank/users\fR. This syntax also allows staff members to destroy their own file systems, but not destroy anyone else's file system. The permissions on \fBtank/users\fR are also displayed.
Lines 2487-2502 Link Here
2487
# zfs allow tank/users\fR
2463
# zfs allow tank/users\fR
2488
-------------------------------------------------------------
2464
-------------------------------------------------------------
2489
Create time permissions on (tank/users)
2465
Create time permissions on (tank/users)
2490
         create,destroy
2466
          create,destroy
2491
Local+Descendent permissions on (tank/users)
2467
Local+Descendent permissions on (tank/users)
2492
         group staff create,mount
2468
          group staff create,mount
2493
------------------------------------------------------------- 
2469
------------------------------------------------------------- 
2494
.fi
2470
.fi
2495
.in -2
2471
.in -2
2496
.sp
2472
.sp
2497
2473
2498
.LP
2474
.LP
2499
\fBExample 21 \fRDefining and Granting a Permission Set on a ZFS Dataset
2475
\fBExample 20 \fRDefining and Granting a Permission Set on a ZFS Dataset
2500
.sp
2476
.sp
2501
.LP
2477
.LP
2502
The following example shows how to define and grant a permission set on the \fBtank/users\fR file system. The permissions on \fBtank/users\fR are also displayed.
2478
The following example shows how to define and grant a permission set on the \fBtank/users\fR file system. The permissions on \fBtank/users\fR are also displayed.
Lines 2509-2526 Link Here
2509
# zfs allow tank/users
2485
# zfs allow tank/users
2510
-------------------------------------------------------------
2486
-------------------------------------------------------------
2511
Permission sets on (tank/users)
2487
Permission sets on (tank/users)
2512
       @pset create,destroy,mount,snapshot
2488
        @pset create,destroy,mount,snapshot
2513
Create time permissions on (tank/users)
2489
Create time permissions on (tank/users)
2514
       create,destroy
2490
        create,destroy
2515
Local+Descendent permissions on (tank/users)
2491
Local+Descendent permissions on (tank/users)
2516
       group staff @pset,create,mount
2492
        group staff @pset,create,mount
2517
-------------------------------------------------------------\fR
2493
-------------------------------------------------------------\fR
2518
.fi
2494
.fi
2519
.in -2
2495
.in -2
2520
.sp
2496
.sp
2521
2497
2522
.LP
2498
.LP
2523
\fBExample 22 \fRDelegating Property Permissions on a ZFS Dataset
2499
\fBExample 21 \fRDelegating Property Permissions on a ZFS Dataset
2524
.sp
2500
.sp
2525
.LP
2501
.LP
2526
The following example shows to grant the ability to set quotas and reservations on the \fBusers/home\fR file system. The permissions on \fBusers/home\fR are also displayed.
2502
The following example shows to grant the ability to set quotas and reservations on the \fBusers/home\fR file system. The permissions on \fBusers/home\fR are also displayed.
Lines 2532-2538 Link Here
2532
# zfs allow users/home\fR
2508
# zfs allow users/home\fR
2533
-------------------------------------------------------------
2509
-------------------------------------------------------------
2534
Local+Descendent permissions on (users/home)
2510
Local+Descendent permissions on (users/home)
2535
       user cindys quota,reservation
2511
        user cindys quota,reservation
2536
-------------------------------------------------------------
2512
-------------------------------------------------------------
2537
cindys% zfs set quota=10G users/home/marks
2513
cindys% zfs set quota=10G users/home/marks
2538
cindys% zfs get quota users/home/marks
2514
cindys% zfs get quota users/home/marks
Lines 2543-2549 Link Here
2543
.sp
2519
.sp
2544
2520
2545
.LP
2521
.LP
2546
\fBExample 23 \fRRemoving ZFS Delegated Permissions on a ZFS Dataset
2522
\fBExample 22 \fRRemoving ZFS Delegated Permissions on a ZFS Dataset
2547
.sp
2523
.sp
2548
.LP
2524
.LP
2549
The following example shows how to remove the snapshot permission from the \fBstaff\fR group on the \fBtank/users\fR file system. The permissions on \fBtank/users\fR are also displayed.
2525
The following example shows how to remove the snapshot permission from the \fBstaff\fR group on the \fBtank/users\fR file system. The permissions on \fBtank/users\fR are also displayed.
Lines 2555-2565 Link Here
2555
# zfs allow tank/users\fR
2531
# zfs allow tank/users\fR
2556
-------------------------------------------------------------
2532
-------------------------------------------------------------
2557
Permission sets on (tank/users)
2533
Permission sets on (tank/users)
2558
       @pset create,destroy,mount,snapshot
2534
        @pset create,destroy,mount,snapshot
2559
Create time permissions on (tank/users)
2535
Create time permissions on (tank/users)
2560
       create,destroy
2536
        create,destroy
2561
Local+Descendent permissions on (tank/users)
2537
Local+Descendent permissions on (tank/users)
2562
       group staff @pset,create,mount
2538
        group staff @pset,create,mount
2563
------------------------------------------------------------- 
2539
------------------------------------------------------------- 
2564
.fi
2540
.fi
2565
.in -2
2541
.in -2
Lines 2575-2582 Link Here
2575
.na
2551
.na
2576
\fB\fB0\fR\fR
2552
\fB\fB0\fR\fR
2577
.ad
2553
.ad
2578
.RS 5n
2554
.sp .6
2579
.rt  
2555
.RS 4n
2580
Successful completion. 
2556
Successful completion. 
2581
.RE
2557
.RE
2582
2558
Lines 2586-2593 Link Here
2586
.na
2562
.na
2587
\fB\fB1\fR\fR
2563
\fB\fB1\fR\fR
2588
.ad
2564
.ad
2589
.RS 5n
2565
.sp .6
2590
.rt  
2566
.RS 4n
2591
An error occurred.
2567
An error occurred.
2592
.RE
2568
.RE
2593
2569
Lines 2597-2604 Link Here
2597
.na
2573
.na
2598
\fB\fB2\fR\fR
2574
\fB\fB2\fR\fR
2599
.ad
2575
.ad
2600
.RS 5n
2576
.sp .6
2601
.rt  
2577
.RS 4n
2602
Invalid command line options were specified.
2578
Invalid command line options were specified.
2603
.RE
2579
.RE
2604
2580
Lines 2627-2630 Link Here
2627
\fBgzip\fR(1), \fBssh\fR(1), \fBmount\fR(1M), \fBshare\fR(1M), \fBsharemgr\fR(1M), \fBunshare\fR(1M), \fBzonecfg\fR(1M), \fBzpool\fR(1M), \fBchmod\fR(2), \fBstat\fR(2), \fBfsync\fR(3c), \fBdfstab\fR(4), \fBattributes\fR(5)
2603
\fBgzip\fR(1), \fBssh\fR(1), \fBmount\fR(1M), \fBshare\fR(1M), \fBsharemgr\fR(1M), \fBunshare\fR(1M), \fBzonecfg\fR(1M), \fBzpool\fR(1M), \fBchmod\fR(2), \fBstat\fR(2), \fBfsync\fR(3c), \fBdfstab\fR(4), \fBattributes\fR(5)
2628
.sp
2604
.sp
2629
.LP
2605
.LP
2630
For information about using the \fBZFS\fR web-based management tool and other \fBZFS\fR features, see the \fIZFS Administration Guide\fR.
2606
For information about using the \fBZFS\fR web-based management tool and other \fBZFS\fR features, see the \fISolaris ZFS Administration Guide\fR.
(-)cddl/contrib/opensolaris/cmd/zpool/zpool.8 (-113 / +92 lines)
Lines 1-24 Link Here
1
'\" te
1
'\" te
2
.\" CDDL HEADER START
3
.\"
4
.\" The contents of this file are subject to the terms of the
5
.\" Common Development and Distribution License (the "License").  
6
.\" You may not use this file except in compliance with the License.
7
.\"
8
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9
.\" or http://www.opensolaris.org/os/licensing.
10
.\" See the License for the specific language governing permissions
11
.\" and limitations under the License.
12
.\"
13
.\" When distributing Covered Code, include this CDDL HEADER in each
14
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15
.\" If applicable, add the following below this CDDL HEADER, with the
16
.\" fields enclosed by brackets "[]" replaced with your own identifying
17
.\" information: Portions Copyright [yyyy] [name of copyright owner]
18
.\"
19
.\" CDDL HEADER END
20
.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
2
.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
21
.TH zpool 1M "13 Nov 2007" "SunOS 5.11" "System Administration Commands"
3
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6
.TH zpool 1M "5 Mar 2009" "SunOS 5.11" "System Administration Commands"
22
.SH NAME
7
.SH NAME
23
zpool \- configures ZFS storage pools
8
zpool \- configures ZFS storage pools
24
.SH SYNOPSIS
9
.SH SYNOPSIS
Lines 29-36 Link Here
29
14
30
.LP
15
.LP
31
.nf
16
.nf
32
\fBzpool create\fR [\fB-fn\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR \fIroot\fR]
17
\fBzpool create\fR [\fB-fn\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR \fIfile-system-property=value\fR] 
33
    \fIpool\fR \fIvdev\fR ...
18
     ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR \fIvdev\fR ...
34
.fi
19
.fi
35
20
36
.LP
21
.LP
Lines 106-118 Link Here
106
.LP
91
.LP
107
.nf
92
.nf
108
\fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-p\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] 
93
\fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-p\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] 
109
    [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fB-a\fR
94
     [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fB-a\fR
110
.fi
95
.fi
111
96
112
.LP
97
.LP
113
.nf
98
.nf
114
\fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
99
\fBzpool import\fR [\fB-o \fImntopts\fR\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
115
    [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR |\fIid\fR [\fInewpool\fR]
100
     [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR |\fIid\fR [\fInewpool\fR]
116
.fi
101
.fi
117
102
118
.LP
103
.LP
Lines 169-176 Link Here
169
.ad
154
.ad
170
.RS 10n
155
.RS 10n
171
.rt  
156
.rt  
172
A block device, typically located under "/dev/dsk". \fBZFS\fR can use individual slices or partitions, though the recommended mode of operation is to use whole disks. A disk can be specified by a full path, or it can be a shorthand name (the relative portion
157
A block device, typically located under "/dev/dsk". \fBZFS\fR can use individual slices or partitions, though the recommended mode of operation is to use whole disks. A disk can be specified by a full path, or it can be a shorthand name (the relative portion of the path under "/dev/dsk"). A whole disk can be specified by omitting the slice or partition designation. For example, "c0t0d0" is equivalent to "/dev/dsk/c0t0d0s2". When given a whole disk, \fBZFS\fR automatically labels the disk, if necessary.
173
of the path under "/dev/dsk"). A whole disk can be specified by omitting the slice or partition designation. For example, "c0t0d0" is equivalent to "/dev/dsk/c0t0d0s2". When given a whole disk, \fBZFS\fR automatically labels the disk, if necessary.
174
.RE
158
.RE
175
159
176
.sp
160
.sp
Lines 192-199 Link Here
192
.ad
176
.ad
193
.RS 10n
177
.RS 10n
194
.rt  
178
.rt  
195
A mirror of two or more devices. Data is replicated in an identical fashion across all components of a mirror. A mirror with \fIN\fR disks of size \fIX\fR can hold \fIX\fR bytes and can withstand (\fIN-1\fR)
179
A mirror of two or more devices. Data is replicated in an identical fashion across all components of a mirror. A mirror with \fIN\fR disks of size \fIX\fR can hold \fIX\fR bytes and can withstand (\fIN-1\fR) devices failing before data integrity is compromised.
196
devices failing before data integrity is compromised.
197
.RE
180
.RE
198
181
199
.sp
182
.sp
Lines 214-224 Link Here
214
.rt  
197
.rt  
215
A variation on \fBRAID-5\fR that allows for better distribution of parity and eliminates the "\fBRAID-5\fR write hole" (in which data and parity become inconsistent after a power loss). Data and parity is striped across all disks within a \fBraidz\fR group.
198
A variation on \fBRAID-5\fR that allows for better distribution of parity and eliminates the "\fBRAID-5\fR write hole" (in which data and parity become inconsistent after a power loss). Data and parity is striped across all disks within a \fBraidz\fR group.
216
.sp
199
.sp
217
A \fBraidz\fR group can have either single- or double-parity, meaning that the \fBraidz\fR group can sustain one or two failures respectively without losing any data. The \fBraidz1\fR \fBvdev\fR type specifies a single-parity \fBraidz\fR group
200
A \fBraidz\fR group can have either single- or double-parity, meaning that the \fBraidz\fR group can sustain one or two failures respectively without losing any data. The \fBraidz1\fR \fBvdev\fR type specifies a single-parity \fBraidz\fR group and the \fBraidz2\fR \fBvdev\fR type specifies a double-parity \fBraidz\fR group. The \fBraidz\fR \fBvdev\fR type is an alias for \fBraidz1\fR.
218
and the \fBraidz2\fR \fBvdev\fR type specifies a double-parity \fBraidz\fR group. The \fBraidz\fR \fBvdev\fR type is an alias for \fBraidz1\fR.
219
.sp
201
.sp
220
A \fBraidz\fR group with \fIN\fR disks of size \fIX\fR with \fIP\fR parity disks can hold approximately (\fIN-P\fR)*\fIX\fR bytes and can withstand \fIP\fR device(s)
202
A \fBraidz\fR group with \fIN\fR disks of size \fIX\fR with \fIP\fR parity disks can hold approximately (\fIN-P\fR)*\fIX\fR bytes and can withstand \fIP\fR device(s) failing before data integrity is compromised. The minimum number of devices in a \fBraidz\fR group is one more than the number of parity disks. The recommended number is between 3 and 9 to help increase performance.
221
failing before data integrity is compromised. The minimum number of devices in a \fBraidz\fR group is one more than the number of parity disks. The recommended number is between 3 and 9 to help increase performance.
222
.RE
203
.RE
223
204
224
.sp
205
.sp
Lines 240-247 Link Here
240
.ad
221
.ad
241
.RS 10n
222
.RS 10n
242
.rt  
223
.rt  
243
A separate intent log device. If more than one log device is specified, then writes are load-balanced between devices. Log devices can be mirrored. However, \fBraidz\fR and \fBraidz2\fR are not supported for the intent log. For more information, see the "Intent
224
A separate intent log device. If more than one log device is specified, then writes are load-balanced between devices. Log devices can be mirrored. However, \fBraidz\fR and \fBraidz2\fR are not supported for the intent log. For more information, see the "Intent Log" section.
244
Log" section.
245
.RE
225
.RE
246
226
247
.sp
227
.sp
Lines 260-267 Link Here
260
Virtual devices cannot be nested, so a mirror or \fBraidz\fR virtual device can only contain files or disks. Mirrors of mirrors (or other combinations) are not allowed.
240
Virtual devices cannot be nested, so a mirror or \fBraidz\fR virtual device can only contain files or disks. Mirrors of mirrors (or other combinations) are not allowed.
261
.sp
241
.sp
262
.LP
242
.LP
263
A pool can have any number of virtual devices at the top of the configuration (known as "root vdevs"). Data is dynamically distributed across all top-level devices to balance data among devices. As new virtual devices are added, \fBZFS\fR automatically places data
243
A pool can have any number of virtual devices at the top of the configuration (known as "root vdevs"). Data is dynamically distributed across all top-level devices to balance data among devices. As new virtual devices are added, \fBZFS\fR automatically places data on the newly available devices.
264
on the newly available devices.
265
.sp
244
.sp
266
.LP
245
.LP
267
Virtual devices are specified one at a time on the command line, separated by whitespace. The keywords "mirror" and "raidz" are used to distinguish where a group ends and another begins. For example, the following creates two root vdevs, each a mirror of two disks:
246
Virtual devices are specified one at a time on the command line, separated by whitespace. The keywords "mirror" and "raidz" are used to distinguish where a group ends and another begins. For example, the following creates two root vdevs, each a mirror of two disks:
Lines 279-290 Link Here
279
\fBZFS\fR supports a rich set of mechanisms for handling device failure and data corruption. All metadata and data is checksummed, and \fBZFS\fR automatically repairs bad data from a good copy when corruption is detected.
258
\fBZFS\fR supports a rich set of mechanisms for handling device failure and data corruption. All metadata and data is checksummed, and \fBZFS\fR automatically repairs bad data from a good copy when corruption is detected.
280
.sp
259
.sp
281
.LP
260
.LP
282
In order to take advantage of these features, a pool must make use of some form of redundancy, using either mirrored or \fBraidz\fR groups. While \fBZFS\fR supports running in a non-redundant configuration, where each root vdev is simply a disk or file, this is
261
In order to take advantage of these features, a pool must make use of some form of redundancy, using either mirrored or \fBraidz\fR groups. While \fBZFS\fR supports running in a non-redundant configuration, where each root vdev is simply a disk or file, this is strongly discouraged. A single case of bit corruption can render some or all of your data unavailable.
283
strongly discouraged. A single case of bit corruption can render some or all of your data unavailable.
284
.sp
262
.sp
285
.LP
263
.LP
286
A pool's health status is described by one of three states: online, degraded, or faulted. An online pool has all devices operating normally. A degraded pool is one in which one or more devices have failed, but the data is still available due to a redundant configuration. A faulted pool has
264
A pool's health status is described by one of three states: online, degraded, or faulted. An online pool has all devices operating normally. A degraded pool is one in which one or more devices have failed, but the data is still available due to a redundant configuration. A faulted pool has corrupted metadata, or one or more faulted devices, and insufficient replicas to continue functioning. 
287
corrupted metadata, or one or more faulted devices, and insufficient replicas to continue functioning. 
288
.sp
265
.sp
289
.LP
266
.LP
290
The health of the top-level vdev, such as mirror or \fBraidz\fR device, is potentially impacted by the state of its associated vdevs, or component devices. A top-level vdev or component device is in one of the following states:
267
The health of the top-level vdev, such as mirror or \fBraidz\fR device, is potentially impacted by the state of its associated vdevs, or component devices. A top-level vdev or component device is in one of the following states:
Lines 399-408 Link Here
399
376
400
.sp
377
.sp
401
.LP
378
.LP
402
Spares can be shared across multiple pools, and can be added with the "\fBzpool add\fR" command and removed with the "\fBzpool remove\fR" command. Once a spare replacement is initiated, a new "spare" \fBvdev\fR is
379
Spares can be shared across multiple pools, and can be added with the "\fBzpool add\fR" command and removed with the "\fBzpool remove\fR" command. Once a spare replacement is initiated, a new "spare" \fBvdev\fR is created within the configuration that will remain there until the original device is replaced. At this point, the hot spare becomes available again if another device fails.
403
created within the configuration that will remain there until the original device is replaced. At this point, the hot spare becomes available again if another device fails.
404
.sp
380
.sp
405
.LP
381
.LP
382
If a pool has a shared spare that is currently being used, the pool can not be exported since other pools may use this shared spare, which may lead to potential data corruption.
383
.sp
384
.LP
406
An in-progress spare replacement can be cancelled by detaching the hot spare. If the original faulted device is detached, then the hot spare assumes its place in the configuration, and is removed from the spare list of all active pools.
385
An in-progress spare replacement can be cancelled by detaching the hot spare. If the original faulted device is detached, then the hot spare assumes its place in the configuration, and is removed from the spare list of all active pools.
407
.sp
386
.sp
408
.LP
387
.LP
Lines 410-418 Link Here
410
.SS "Intent Log"
389
.SS "Intent Log"
411
.sp
390
.sp
412
.LP
391
.LP
413
The \fBZFS\fR Intent Log (\fBZIL\fR) satisfies \fBPOSIX\fR requirements for synchronous transactions. For instance, databases often require their transactions to be on stable storage devices when returning from a system call. \fBNFS\fR and
392
The \fBZFS\fR Intent Log (\fBZIL\fR) satisfies \fBPOSIX\fR requirements for synchronous transactions. For instance, databases often require their transactions to be on stable storage devices when returning from a system call. \fBNFS\fR and other applications can also use \fBfsync\fR() to ensure data stability. By default, the intent log is allocated from blocks within the main pool. However, it might be possible to get better performance using separate intent log devices such as \fBNVRAM\fR or a dedicated disk. For example:
414
other applications can also use \fBfsync\fR() to ensure data stability. By default, the intent log is allocated from blocks within the main pool. However, it might be possible to get better performance using separate intent log devices such as \fBNVRAM\fR or a dedicated
415
disk. For example:
416
.sp
393
.sp
417
.in +2
394
.in +2
418
.nf
395
.nf
Lines 430-437 Link Here
430
.SS "Cache Devices"
407
.SS "Cache Devices"
431
.sp
408
.sp
432
.LP
409
.LP
433
Devices can be added to a storage pool as "cache devices." These devices provide an additional layer of caching between main memory and disk. For read-heavy workloads, where the working set size is much larger than what can be cached in main memory, using cache devices allow
410
Devices can be added to a storage pool as "cache devices." These devices provide an additional layer of caching between main memory and disk. For read-heavy workloads, where the working set size is much larger than what can be cached in main memory, using cache devices allow much more of this working set to be served from low latency media. Using cache devices provides the greatest performance improvement for random read-workloads of mostly static content.
434
much more of this working set to be served from low latency media. Using cache devices provides the greatest performance improvement for random read-workloads of mostly static content.
435
.sp
411
.sp
436
.LP
412
.LP
437
To create a pool with cache devices, specify a "cache" \fBvdev\fR with any number of devices. For example:
413
To create a pool with cache devices, specify a "cache" \fBvdev\fR with any number of devices. For example:
Lines 521-528 Link Here
521
497
522
.sp
498
.sp
523
.LP
499
.LP
524
These space usage properties report actual physical space available to the storage pool. The physical space can be different from the total amount of space that any contained datasets can actually use. The amount of space used in a \fBraidz\fR configuration depends on the characteristics
500
These space usage properties report actual physical space available to the storage pool. The physical space can be different from the total amount of space that any contained datasets can actually use. The amount of space used in a \fBraidz\fR configuration depends on the characteristics of the data being written. In addition, \fBZFS\fR reserves some space for internal accounting that the \fBzfs\fR(1M) command takes into account, but the \fBzpool\fR command does not. For non-full pools of a reasonable size, these effects should be invisible. For small pools, or pools that are close to being completely full, these discrepancies may become more noticeable.
525
of the data being written. In addition, \fBZFS\fR reserves some space for internal accounting that the \fBzfs\fR(1M) command takes into account, but the \fBzpool\fR command does not. For non-full pools of a reasonable size, these effects should be invisible. For small pools, or pools that are close to being completely full, these discrepancies may become more noticeable.
526
.sp
501
.sp
527
.LP
502
.LP
528
The following property can be set at creation time and import time:
503
The following property can be set at creation time and import time:
Lines 534-541 Link Here
534
.ad
509
.ad
535
.sp .6
510
.sp .6
536
.RS 4n
511
.RS 4n
537
Alternate root directory. If set, this directory is prepended to any mount points within the pool. This can be used when examining an unknown pool where the mount points cannot be trusted, or in an alternate boot environment, where the typical paths are not valid. \fBaltroot\fR is
512
Alternate root directory. If set, this directory is prepended to any mount points within the pool. This can be used when examining an unknown pool where the mount points cannot be trusted, or in an alternate boot environment, where the typical paths are not valid. \fBaltroot\fR is not a persistent property. It is valid only while the system is up. Setting \fBaltroot\fR defaults to using \fBcachefile\fR=none, though this may be overridden	 using an explicit setting.
538
not a persistent property. It is valid only while the system is up. Setting \fBaltroot\fR defaults to using \fBcachefile\fR=none, though this may be overridden	 using an explicit setting.
539
.RE
513
.RE
540
514
541
.sp
515
.sp
Lines 549-556 Link Here
549
.ad
523
.ad
550
.sp .6
524
.sp .6
551
.RS 4n
525
.RS 4n
552
Controls automatic device replacement. If set to "\fBoff\fR", device replacement must be initiated by the administrator by using the "\fBzpool replace\fR" command. If set to "\fBon\fR", any new device, found
526
Controls automatic device replacement. If set to "\fBoff\fR", device replacement must be initiated by the administrator by using the "\fBzpool replace\fR" command. If set to "\fBon\fR", any new device, found in the same physical location as a device that previously belonged to the pool, is automatically formatted and replaced. The default behavior is "\fBoff\fR". This property can also be referred to by its shortened column name, "replace".
553
in the same physical location as a device that previously belonged to the pool, is automatically formatted and replaced. The default behavior is "\fBoff\fR". This property can also be referred to by its shortened column name, "replace".
554
.RE
527
.RE
555
528
556
.sp
529
.sp
Lines 572-580 Link Here
572
.ad
545
.ad
573
.sp .6
546
.sp .6
574
.RS 4n
547
.RS 4n
575
Controls the location of where the pool configuration is cached. Discovering all pools on system startup requires a cached copy of the configuration data that is stored on the root file system. All pools in this cache are automatically imported when the system boots. Some environments,
548
Controls the location of where the pool configuration is cached. Discovering all pools on system startup requires a cached copy of the configuration data that is stored on the root file system. All pools in this cache are automatically imported when the system boots. Some environments, such as install and clustering, need to cache this information in a different location so that pools are not automatically imported. Setting this property caches the pool configuration in a different location that can later be imported with "\fBzpool import -c\fR". Setting it to the special value "\fBnone\fR" creates a temporary pool that is never cached, and the special value \fB\&''\fR (empty string) uses the default location. 
576
such as install and clustering, need to cache this information in a different location so that pools are not automatically imported. Setting this property caches the pool configuration in a different location that can later be imported with "\fBzpool import -c\fR". Setting
577
it to the special value "\fBnone\fR" creates a temporary pool that is never cached, and the special value \fB\&''\fR (empty string) uses the default location. 
578
.sp
549
.sp
579
Multiple pools can share the same cache file. Because the kernel destroys and recreates this file when pools are added and removed, care should be taken when attempting to access this file. When the last pool using a \fBcachefile\fR is exported or destroyed, the file is removed.
550
Multiple pools can share the same cache file. Because the kernel destroys and recreates this file when pools are added and removed, care should be taken when attempting to access this file. When the last pool using a \fBcachefile\fR is exported or destroyed, the file is removed.
580
.RE
551
.RE
Lines 587-594 Link Here
587
.ad
558
.ad
588
.sp .6
559
.sp .6
589
.RS 4n
560
.RS 4n
590
Controls whether a non-privileged user is granted access based on the dataset permissions defined on the dataset. See \fBzfs\fR(1M) for more information
561
Controls whether a non-privileged user is granted access based on the dataset permissions defined on the dataset. See \fBzfs\fR(1M) for more information on \fBZFS\fR delegated administration.
591
on \fBZFS\fR delegated administration.
592
.RE
562
.RE
593
563
594
.sp
564
.sp
Lines 639-650 Link Here
639
.ne 2
609
.ne 2
640
.mk
610
.mk
641
.na
611
.na
612
\fB\fBlistsnaps\fR=on | off\fR
613
.ad
614
.sp .6
615
.RS 4n
616
Controls whether information about snapshots associated with this pool is output when "\fBzfs list\fR" is run without the  \fB-t\fR option.  The default value is "off".
617
.RE
618
619
.sp
620
.ne 2
621
.mk
622
.na
642
\fB\fBversion\fR=\fIversion\fR\fR
623
\fB\fBversion\fR=\fIversion\fR\fR
643
.ad
624
.ad
644
.sp .6
625
.sp .6
645
.RS 4n
626
.RS 4n
646
The current on-disk version of the pool. This can be increased, but never decreased. The preferred method of updating pools is with the "\fBzpool upgrade\fR" command, though this property can be used when a specific version is needed for backwards compatibility.
627
The current on-disk version of the pool. This can be increased, but never decreased. The preferred method of updating pools is with the "\fBzpool upgrade\fR" command, though this property can be used when a specific version is needed for backwards compatibility. This property can be any number between 1 and the current version reported by "\fBzpool upgrade -v\fR".
647
This property can be any number between 1 and the current version reported by "\fBzpool upgrade -v\fR". The special value "\fBcurrent\fR" is an alias for the latest supported version.
648
.RE
628
.RE
649
629
650
.SS "Subcommands"
630
.SS "Subcommands"
Lines 669-686 Link Here
669
.ne 2
649
.ne 2
670
.mk
650
.mk
671
.na
651
.na
672
\fB\fBzpool create\fR [\fB-fn\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR \fIvdev\fR ...\fR
652
\fB\fBzpool create\fR [\fB-fn\fR] [\fB-o\fR \fIproperty=value\fR] ... [\fB-O\fR \fIfile-system-property=value\fR] ... [\fB-m\fR \fImountpoint\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR \fIvdev\fR ...\fR
673
.ad
653
.ad
674
.sp .6
654
.sp .6
675
.RS 4n
655
.RS 4n
676
Creates a new storage pool containing the virtual devices specified on the command line. The pool name must begin with a letter, and can only contain alphanumeric characters as well as underscore ("_"), dash ("-"), and period ("."). The pool
656
Creates a new storage pool containing the virtual devices specified on the command line. The pool name must begin with a letter, and can only contain alphanumeric characters as well as underscore ("_"), dash ("-"), and period ("."). The pool names "mirror", "raidz", "spare" and "log" are reserved, as are names beginning with the pattern "c[0-9]". The \fBvdev\fR specification is described in the "Virtual Devices" section.
677
names "mirror", "raidz", "spare" and "log" are reserved, as are names beginning with the pattern "c[0-9]". The \fBvdev\fR specification is described in the "Virtual Devices" section.
678
.sp
657
.sp
679
The command verifies that each device specified is accessible and not currently in use by another subsystem. There are some uses, such as being currently mounted, or specified as the dedicated dump device, that prevents a device from ever being used by \fBZFS\fR. Other uses,
658
The command verifies that each device specified is accessible and not currently in use by another subsystem. There are some uses, such as being currently mounted, or specified as the dedicated dump device, that prevents a device from ever being used by \fBZFS\fR. Other uses, such as having a preexisting \fBUFS\fR file system, can be overridden with the \fB-f\fR option.
680
such as having a preexisting \fBUFS\fR file system, can be overridden with the \fB-f\fR option.
681
.sp
659
.sp
682
The command also checks that the replication strategy for the pool is consistent. An attempt to combine redundant and non-redundant storage in a single pool, or to mix disks and files, results in an error unless \fB-f\fR is specified. The use of differently sized devices within
660
The command also checks that the replication strategy for the pool is consistent. An attempt to combine redundant and non-redundant storage in a single pool, or to mix disks and files, results in an error unless \fB-f\fR is specified. The use of differently sized devices within a single \fBraidz\fR or mirror group is also flagged as an error unless \fB-f\fR is specified.
683
a single \fBraidz\fR or mirror group is also flagged as an error unless \fB-f\fR is specified.
684
.sp
661
.sp
685
Unless the \fB-R\fR option is specified, the default mount point is "/\fIpool\fR". The mount point must not exist or must be empty, or else the root dataset cannot be mounted. This can be overridden with the \fB-m\fR option.
662
Unless the \fB-R\fR option is specified, the default mount point is "/\fIpool\fR". The mount point must not exist or must be empty, or else the root dataset cannot be mounted. This can be overridden with the \fB-m\fR option.
686
.sp
663
.sp
Lines 720-725 Link Here
720
.ne 2
697
.ne 2
721
.mk
698
.mk
722
.na
699
.na
700
\fB\fB-O\fR \fIfile-system-property=value\fR\fR
701
.ad
702
.br
703
.na
704
\fB[\fB-O\fR \fIfile-system-property=value\fR] ...\fR
705
.ad
706
.sp .6
707
.RS 4n
708
Sets the given file system properties in the root file system of the pool. See the "Properties" section of \fBzfs\fR(1M) for a list of valid properties that can be set.
709
.RE
710
711
.sp
712
.ne 2
713
.mk
714
.na
723
\fB\fB-R\fR \fIroot\fR\fR
715
\fB\fB-R\fR \fIroot\fR\fR
724
.ad
716
.ad
725
.sp .6
717
.sp .6
Lines 770-777 Link Here
770
.ad
762
.ad
771
.sp .6
763
.sp .6
772
.RS 4n
764
.RS 4n
773
Adds the specified virtual devices to the given pool. The \fIvdev\fR specification is described in the "Virtual Devices" section. The behavior of the \fB-f\fR option, and the device checks performed are described in the "zpool create"
765
Adds the specified virtual devices to the given pool. The \fIvdev\fR specification is described in the "Virtual Devices" section. The behavior of the \fB-f\fR option, and the device checks performed are described in the "zpool create" subcommand.
774
subcommand.
775
.sp
766
.sp
776
.ne 2
767
.ne 2
777
.mk
768
.mk
Lines 805-812 Link Here
805
.ad
796
.ad
806
.sp .6
797
.sp .6
807
.RS 4n
798
.RS 4n
808
Removes the specified device from the pool. This command currently only supports removing hot spares and cache devices. Devices that are part of a mirrored configuration can be removed using the "\fBzpool detach\fR" command. Non-redundant and \fBraidz\fR devices
799
Removes the specified device from the pool. This command currently only supports removing hot spares and cache devices. Devices that are part of a mirrored configuration can be removed using the "\fBzpool detach\fR" command. Non-redundant and \fBraidz\fR devices cannot be removed from a pool.
809
cannot be removed from a pool.
810
.RE
800
.RE
811
801
812
.sp
802
.sp
Lines 850-857 Link Here
850
.ad
840
.ad
851
.sp .6
841
.sp .6
852
.RS 4n
842
.RS 4n
853
Displays \fBI/O\fR statistics for the given pools. When given an interval, the statistics are printed every \fIinterval\fR seconds until \fBCtrl-C\fR is pressed. If no \fIpools\fR are specified, statistics for
843
Displays \fBI/O\fR statistics for the given pools. When given an interval, the statistics are printed every \fIinterval\fR seconds until \fBCtrl-C\fR is pressed. If no \fIpools\fR are specified, statistics for every pool in the system is shown. If \fIcount\fR is specified, the command exits after \fIcount\fR reports are printed.
854
every pool in the system is shown. If \fIcount\fR is specified, the command exits after \fIcount\fR reports are printed.
855
.sp
844
.sp
856
.ne 2
845
.ne 2
857
.mk
846
.mk
Lines 956-963 Link Here
956
.ad
945
.ad
957
.sp .6
946
.sp .6
958
.RS 4n
947
.RS 4n
959
Attaches \fInew_device\fR to an existing \fBzpool\fR device. The existing device cannot be part of a \fBraidz\fR configuration. If \fIdevice\fR is not currently part of a mirrored configuration, \fIdevice\fR automatically
948
Attaches \fInew_device\fR to an existing \fBzpool\fR device. The existing device cannot be part of a \fBraidz\fR configuration. If \fIdevice\fR is not currently part of a mirrored configuration, \fIdevice\fR automatically transforms into a two-way mirror of \fIdevice\fR and \fInew_device\fR. If \fIdevice\fR is part of a two-way mirror, attaching \fInew_device\fR creates a three-way mirror, and so on. In either case, \fInew_device\fR begins to resilver immediately.
960
transforms into a two-way mirror of \fIdevice\fR and \fInew_device\fR. If \fIdevice\fR is part of a two-way mirror, attaching \fInew_device\fR creates a three-way mirror, and so on. In either case, \fInew_device\fR begins to resilver immediately.
961
.sp
949
.sp
962
.ne 2
950
.ne 2
963
.mk
951
.mk
Lines 994-1001 Link Here
994
.sp
982
.sp
995
The size of \fInew_device\fR must be greater than or equal to the minimum size of all the devices in a mirror or \fBraidz\fR configuration.
983
The size of \fInew_device\fR must be greater than or equal to the minimum size of all the devices in a mirror or \fBraidz\fR configuration.
996
.sp
984
.sp
997
\fInew_device\fR is required if the pool is not redundant. If \fInew_device\fR is not specified, it defaults to \fIold_device\fR. This form of replacement is useful after an existing disk has failed and has been physically replaced.
985
\fInew_device\fR is required if the pool is not redundant. If \fInew_device\fR is not specified, it defaults to \fIold_device\fR. This form of replacement is useful after an existing disk has failed and has been physically replaced. In this case, the new disk may have the same \fB/dev/dsk\fR path as the old device, even though it is actually a different disk. \fBZFS\fR recognizes this.
998
In this case, the new disk may have the same \fB/dev/dsk\fR path as the old device, even though it is actually a different disk. \fBZFS\fR recognizes this.
999
.sp
986
.sp
1000
.ne 2
987
.ne 2
1001
.mk
988
.mk
Lines 1017-1027 Link Here
1017
.ad
1004
.ad
1018
.sp .6
1005
.sp .6
1019
.RS 4n
1006
.RS 4n
1020
Begins a scrub. The scrub examines all data in the specified pools to verify that it checksums correctly. For replicated (mirror or \fBraidz\fR) devices, \fBZFS\fR automatically repairs any damage discovered during the scrub. The "\fBzpool
1007
Begins a scrub. The scrub examines all data in the specified pools to verify that it checksums correctly. For replicated (mirror or \fBraidz\fR) devices, \fBZFS\fR automatically repairs any damage discovered during the scrub. The "\fBzpool status\fR" command reports the progress of the scrub and summarizes the results of the scrub upon completion.
1021
status\fR" command reports the progress of the scrub and summarizes the results of the scrub upon completion.
1022
.sp
1008
.sp
1023
Scrubbing and resilvering are very similar operations. The difference is that resilvering only examines data that \fBZFS\fR knows to be out of date (for example, when attaching a new device to a mirror or replacing an existing device), whereas scrubbing examines all data to
1009
Scrubbing and resilvering are very similar operations. The difference is that resilvering only examines data that \fBZFS\fR knows to be out of date (for example, when attaching a new device to a mirror or replacing an existing device), whereas scrubbing examines all data to discover silent errors due to hardware faults or disk failure.
1024
discover silent errors due to hardware faults or disk failure.
1025
.sp
1010
.sp
1026
Because scrubbing and resilvering are \fBI/O\fR-intensive operations, \fBZFS\fR only allows one at a time. If a scrub is already in progress, the "\fBzpool scrub\fR" command terminates it and starts a new scrub. If a resilver is in progress, \fBZFS\fR does not allow a scrub to be started until the resilver completes.
1011
Because scrubbing and resilvering are \fBI/O\fR-intensive operations, \fBZFS\fR only allows one at a time. If a scrub is already in progress, the "\fBzpool scrub\fR" command terminates it and starts a new scrub. If a resilver is in progress, \fBZFS\fR does not allow a scrub to be started until the resilver completes.
1027
.sp
1012
.sp
Lines 1045-1052 Link Here
1045
.ad
1030
.ad
1046
.sp .6
1031
.sp .6
1047
.RS 4n
1032
.RS 4n
1048
Lists pools available to import. If the \fB-d\fR option is not specified, this command searches for devices in "/dev/dsk". The \fB-d\fR option can be specified multiple times, and all directories are searched. If the device appears to be part of
1033
Lists pools available to import. If the \fB-d\fR option is not specified, this command searches for devices in "/dev/dsk". The \fB-d\fR option can be specified multiple times, and all directories are searched. If the device appears to be part of an exported pool, this command displays a summary of the pool with the name of the pool, a numeric identifier, as well as the \fIvdev\fR layout and current health of the device for each device or file. Destroyed pools, pools that were previously destroyed with the "\fBzpool destroy\fR" command, are not listed unless the \fB-D\fR option is specified. 
1049
an exported pool, this command displays a summary of the pool with the name of the pool, a numeric identifier, as well as the \fIvdev\fR layout and current health of the device for each device or file. Destroyed pools, pools that were previously destroyed with the "\fBzpool destroy\fR" command, are not listed unless the \fB-D\fR option is specified. 
1050
.sp
1034
.sp
1051
The numeric identifier is unique, and can be used instead of the pool name when multiple exported pools of the same name are available.
1035
The numeric identifier is unique, and can be used instead of the pool name when multiple exported pools of the same name are available.
1052
.sp
1036
.sp
Lines 1088-1100 Link Here
1088
.ne 2
1072
.ne 2
1089
.mk
1073
.mk
1090
.na
1074
.na
1091
\fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR \fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
1075
\fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR \fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fB-a\fR\fR
1092
[\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fB-a\fR\fR
1093
.ad
1076
.ad
1094
.sp .6
1077
.sp .6
1095
.RS 4n
1078
.RS 4n
1096
Imports all pools found in the search directories. Identical to the previous command, except that all pools with a sufficient number of devices available are imported. Destroyed pools, pools that were previously destroyed with the "\fBzpool destroy\fR"
1079
Imports all pools found in the search directories. Identical to the previous command, except that all pools with a sufficient number of devices available are imported. Destroyed pools, pools that were previously destroyed with the "\fBzpool destroy\fR" command, will not be imported unless the \fB-D\fR option is specified.
1097
command, will not be imported unless the \fB-D\fR option is specified.
1098
.sp
1080
.sp
1099
.ne 2
1081
.ne 2
1100
.mk
1082
.mk
Lines 1103-1110 Link Here
1103
.ad
1085
.ad
1104
.RS 21n
1086
.RS 21n
1105
.rt  
1087
.rt  
1106
Comma-separated list of mount options to use when mounting datasets within the pool. See \fBzfs\fR(1M) for a description of dataset properties and mount
1088
Comma-separated list of mount options to use when mounting datasets within the pool. See \fBzfs\fR(1M) for a description of dataset properties and mount options.
1107
options.
1108
.RE
1089
.RE
1109
1090
1110
.sp
1091
.sp
Lines 1190-1204 Link Here
1190
.ne 2
1171
.ne 2
1191
.mk
1172
.mk
1192
.na
1173
.na
1193
\fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR \fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR]
1174
\fB\fBzpool import\fR [\fB-o\fR \fImntopts\fR] [ \fB-o\fR \fIproperty\fR=\fIvalue\fR] ... [\fB-d\fR \fIdir\fR | \fB-c\fR \fIcachefile\fR] [\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR | \fIid\fR [\fInewpool\fR]\fR
1194
[\fB-D\fR] [\fB-f\fR] [\fB-R\fR \fIroot\fR] \fIpool\fR | \fIid\fR [\fInewpool\fR]\fR
1195
.ad
1175
.ad
1196
.sp .6
1176
.sp .6
1197
.RS 4n
1177
.RS 4n
1198
Imports a specific pool. A pool can be identified by its name or the numeric identifier. If \fInewpool\fR is specified, the pool is imported using the name \fInewpool\fR. Otherwise, it is imported with the same name as its exported name.
1178
Imports a specific pool. A pool can be identified by its name or the numeric identifier. If \fInewpool\fR is specified, the pool is imported using the name \fInewpool\fR. Otherwise, it is imported with the same name as its exported name.
1199
.sp
1179
.sp
1200
If a device is removed from a system without running "\fBzpool export\fR" first, the device appears as potentially active. It cannot be determined if this was a failed export, or whether the device is really in use from another host. To import a pool in this state,
1180
If a device is removed from a system without running "\fBzpool export\fR" first, the device appears as potentially active. It cannot be determined if this was a failed export, or whether the device is really in use from another host. To import a pool in this state, the \fB-f\fR option is required.
1201
the \fB-f\fR option is required.
1202
.sp
1181
.sp
1203
.ne 2
1182
.ne 2
1204
.mk
1183
.mk
Lines 1207-1214 Link Here
1207
.ad
1186
.ad
1208
.sp .6
1187
.sp .6
1209
.RS 4n
1188
.RS 4n
1210
Comma-separated list of mount options to use when mounting datasets within the pool. See \fBzfs\fR(1M) for a description of dataset properties and mount
1189
Comma-separated list of mount options to use when mounting datasets within the pool. See \fBzfs\fR(1M) for a description of dataset properties and mount options.
1211
options.
1212
.RE
1190
.RE
1213
1191
1214
.sp
1192
.sp
Lines 1289-1295 Link Here
1289
.RS 4n
1267
.RS 4n
1290
Exports the given pools from the system. All devices are marked as exported, but are still considered in use by other subsystems. The devices can be moved between systems (even those of different endianness) and imported as long as a sufficient number of devices are present.
1268
Exports the given pools from the system. All devices are marked as exported, but are still considered in use by other subsystems. The devices can be moved between systems (even those of different endianness) and imported as long as a sufficient number of devices are present.
1291
.sp
1269
.sp
1292
Before exporting the pool, all datasets within the pool are unmounted.
1270
Before exporting the pool, all datasets within the pool are unmounted. A pool can not be exported if it has a shared spare that is currently being used.
1293
.sp
1271
.sp
1294
For pools to be portable, you must give the \fBzpool\fR command whole disks, not just slices, so that \fBZFS\fR can label the disks with portable \fBEFI\fR labels. Otherwise, disk drivers on platforms of different endianness will not recognize the disks.
1272
For pools to be portable, you must give the \fBzpool\fR command whole disks, not just slices, so that \fBZFS\fR can label the disks with portable \fBEFI\fR labels. Otherwise, disk drivers on platforms of different endianness will not recognize the disks.
1295
.sp
1273
.sp
Lines 1301-1306 Link Here
1301
.RS 6n
1279
.RS 6n
1302
.rt  
1280
.rt  
1303
Forcefully unmount all datasets, using the "\fBunmount -f\fR" command.
1281
Forcefully unmount all datasets, using the "\fBunmount -f\fR" command.
1282
.sp
1283
This command will forcefully export the pool even if it has a shared spare that is currently being used. This may lead to potential data corruption.
1304
.RE
1284
.RE
1305
1285
1306
.RE
1286
.RE
Lines 1313-1320 Link Here
1313
.ad
1293
.ad
1314
.sp .6
1294
.sp .6
1315
.RS 4n
1295
.RS 4n
1316
Displays all pools formatted using a different \fBZFS\fR on-disk version. Older versions can continue to be used, but some features may not be available. These pools can be upgraded using "\fBzpool upgrade -a\fR". Pools that are formatted with
1296
Displays all pools formatted using a different \fBZFS\fR on-disk version. Older versions can continue to be used, but some features may not be available. These pools can be upgraded using "\fBzpool upgrade -a\fR". Pools that are formatted with a more recent version are also displayed, although these pools will be inaccessible on the system.
1317
a more recent version are also displayed, although these pools will be inaccessible on the system.
1318
.RE
1297
.RE
1319
1298
1320
.sp
1299
.sp
Lines 1407-1415 Link Here
1407
.in +2
1386
.in +2
1408
.nf
1387
.nf
1409
       name          Name of storage pool
1388
       name          Name of storage pool
1410
       property      Property name
1389
        property      Property name
1411
       value         Property value
1390
        value         Property value
1412
       source        Property source, either 'default' or 'local'.
1391
        source        Property source, either 'default' or 'local'.
1413
.fi
1392
.fi
1414
.in -2
1393
.in -2
1415
.sp
1394
.sp
Lines 1421-1427 Link Here
1421
.ne 2
1400
.ne 2
1422
.mk
1401
.mk
1423
.na
1402
.na
1424
\fB\fBzpool set\fR \fIproperty\fR=\fIvalue\fR \fIpool\fR \fR
1403
\fB\fBzpool set\fR \fIproperty\fR=\fIvalue\fR \fIpool\fR\fR
1425
.ad
1404
.ad
1426
.sp .6
1405
.sp .6
1427
.RS 4n
1406
.RS 4n
Lines 1513-1522 Link Here
1513
.in +2
1492
.in +2
1514
.nf
1493
.nf
1515
\fB# zpool list\fR
1494
\fB# zpool list\fR
1516
    NAME              SIZE    USED   AVAIL    CAP  HEALTH     ALTROOT
1495
     NAME              SIZE    USED   AVAIL    CAP  HEALTH     ALTROOT
1517
    pool             67.5G   2.92M   67.5G     0%  ONLINE     -
1496
     pool             67.5G   2.92M   67.5G     0%  ONLINE     -
1518
    tank             67.5G   2.92M   67.5G     0%  ONLINE     -
1497
     tank             67.5G   2.92M   67.5G     0%  ONLINE     -
1519
    zion                 -       -       -     0%  FAULTED    -
1498
     zion                 -       -       -     0%  FAULTED    -
1520
.fi
1499
.fi
1521
.in -2
1500
.in -2
1522
.sp
1501
.sp
Lines 1563-1578 Link Here
1563
.in +2
1542
.in +2
1564
.nf
1543
.nf
1565
\fB# zpool import\fR
1544
\fB# zpool import\fR
1566
 pool: tank
1545
  pool: tank
1567
   id: 15451357997522795478
1546
    id: 15451357997522795478
1568
state: ONLINE
1547
 state: ONLINE
1569
action: The pool can be imported using its name or numeric identifier.
1548
action: The pool can be imported using its name or numeric identifier.
1570
config:
1549
config:
1571
1550
1572
       tank        ONLINE
1551
        tank        ONLINE
1573
         mirror    ONLINE
1552
          mirror    ONLINE
1574
           c1t2d0  ONLINE
1553
            c1t2d0  ONLINE
1575
           c1t3d0  ONLINE
1554
            c1t3d0  ONLINE
1576
1555
1577
\fB# zpool import tank\fR
1556
\fB# zpool import tank\fR
1578
.fi
1557
.fi
Lines 1642-1648 Link Here
1642
.in +2
1621
.in +2
1643
.nf
1622
.nf
1644
\fB# zpool create pool mirror c0d0 c1d0 mirror c2d0 c3d0 log mirror \e
1623
\fB# zpool create pool mirror c0d0 c1d0 mirror c2d0 c3d0 log mirror \e
1645
  c4d0 c5d0\fR
1624
   c4d0 c5d0\fR
1646
.fi
1625
.fi
1647
.in -2
1626
.in -2
1648
.sp
1627
.sp

Return to bug 144984