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.
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 .\" or https://opensource.org/licenses/CDDL-1.0.
10 .\" See the License for the specific language governing permissions
11 .\" and limitations under the License.
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]
21 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
22 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
23 .\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
24 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
25 .\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
26 .\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
27 .\" Copyright (c) 2014 Integros [integros.com]
28 .\" Copyright 2019 Richard Laager. All rights reserved.
29 .\" Copyright 2018 Nexenta Systems, Inc.
30 .\" Copyright 2019 Joyent, Inc.
38 .Nd set properties on ZFS datasets
43 .Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns …
44 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns …
47 .Op Fl r Ns | Ns Fl d Ar depth
49 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc
50 .Oo Fl s Ar source Ns Oo , Ns Ar source Oc Ns … Oc
51 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns … Oc
52 .Cm all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns …
53 .Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Oc Ns …
57 .Ar property Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns …
65 .Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns …
66 .Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns …
68 Only some properties can be edited.
71 for more information on what properties can be set and acceptable
73 Numeric values can be specified as exact values, or in a human-readable form
75 .Sy B , K , M , G , T , P , E , Z
76 .Po for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes,
77 or zettabytes, respectively
79 User properties can be set on snapshots.
80 For more information, see the
86 Update mountpoint, sharenfs, sharesmb property but do not mount or share the
92 .Op Fl r Ns | Ns Fl d Ar depth
94 .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc
95 .Oo Fl s Ar source Ns Oo , Ns Ar source Oc Ns … Oc
96 .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns … Oc
97 .Cm all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns …
98 .Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Oc Ns …
100 Displays properties for the given datasets.
101 If no datasets are specified, then the command displays properties for all
102 datasets on the system.
103 For each property, the following columns are displayed:
104 .Bl -tag -compact -offset 4n -width "property"
113 .Sy local , default , inherited , temporary , received , No or Sy - Pq none .
116 All columns are displayed by default, though this can be controlled by using the
119 This command takes a comma-separated list of properties as described in the
120 .Sx Native Properties
128 can be used to display all properties that apply to the given dataset's type
129 .Pq Sy filesystem , volume , snapshot , No or Sy bookmark .
130 .Bl -tag -width "-s source"
132 Display output in a form more easily parsed by scripts.
133 Any headers are omitted, and fields are explicitly separated by a single tab
134 instead of an arbitrary amount of space.
136 Recursively display any children of the dataset, limiting the recursion to
140 will display only the dataset and its direct children.
142 A comma-separated list of columns to display, defaults to
143 .Sy name , Ns Sy property , Ns Sy value , Ns Sy source .
145 Display numbers in parsable
149 Recursively display properties for any children.
151 A comma-separated list of sources to display.
152 Those properties coming from a source other than those in this list are ignored.
153 Each source must be one of the following:
154 .Sy local , default , inherited , temporary , received , No or Sy none .
155 The default value is all sources.
157 A comma-separated list of types to display, where
160 .Sy filesystem , snapshot , volume , bookmark , No or Sy all .
166 .Ar property Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns …
168 Clears the specified property, causing it to be inherited from an ancestor,
169 restored to default if no ancestor has the property set, or with the
171 option reverted to the received value if one exists.
174 for a listing of default values, and details on which properties can be
178 Recursively inherit the given property for all children.
180 Revert the property to the received value, if one exists;
181 otherwise, for non-inheritable properties, to the default;
182 otherwise, operate as if the
184 option was not specified.
189 .\" These are, respectively, examples 1, 4, 6, 7, 11, 14, 16 from zfs.8
190 .\" Make sure to update them bidirectionally
191 .Ss Example 1 : No Creating a ZFS File System Hierarchy
192 The following commands create a file system named
194 and a file system named
198 is set for the parent file system, and is automatically inherited by the child
200 .Dl # Nm zfs Cm create Ar pool/home
201 .Dl # Nm zfs Cm set Sy mountpoint Ns = Ns Ar /export/home pool/home
202 .Dl # Nm zfs Cm create Ar pool/home/bob
204 .Ss Example 2 : No Disabling and Enabling File System Compression
205 The following command disables the
207 property for all file systems under
209 The next command explicitly enables
213 .Dl # Nm zfs Cm set Sy compression Ns = Ns Sy off Ar pool/home
214 .Dl # Nm zfs Cm set Sy compression Ns = Ns Sy on Ar pool/home/anne
216 .Ss Example 3 : No Setting a Quota on a ZFS File System
217 The following command sets a quota of 50 Gbytes for
219 .Dl # Nm zfs Cm set Sy quota Ns = Ns Ar 50G pool/home/bob
221 .Ss Example 4 : No Listing ZFS Properties
222 The following command lists all properties for
224 .Bd -literal -compact -offset Ds
225 .No # Nm zfs Cm get Sy all Ar pool/home/bob
226 NAME PROPERTY VALUE SOURCE
227 pool/home/bob type filesystem -
228 pool/home/bob creation Tue Jul 21 15:53 2009 -
229 pool/home/bob used 21K -
230 pool/home/bob available 20.0G -
231 pool/home/bob referenced 21K -
232 pool/home/bob compressratio 1.00x -
233 pool/home/bob mounted yes -
234 pool/home/bob quota 20G local
235 pool/home/bob reservation none default
236 pool/home/bob recordsize 128K default
237 pool/home/bob mountpoint /pool/home/bob default
238 pool/home/bob sharenfs off default
239 pool/home/bob checksum on default
240 pool/home/bob compression on local
241 pool/home/bob atime on default
242 pool/home/bob devices on default
243 pool/home/bob exec on default
244 pool/home/bob setuid on default
245 pool/home/bob readonly off default
246 pool/home/bob zoned off default
247 pool/home/bob snapdir hidden default
248 pool/home/bob acltype off default
249 pool/home/bob aclmode discard default
250 pool/home/bob aclinherit restricted default
251 pool/home/bob canmount on default
252 pool/home/bob xattr on default
253 pool/home/bob copies 1 default
254 pool/home/bob version 4 -
255 pool/home/bob utf8only off -
256 pool/home/bob normalization none -
257 pool/home/bob casesensitivity sensitive -
258 pool/home/bob vscan off default
259 pool/home/bob nbmand off default
260 pool/home/bob sharesmb off default
261 pool/home/bob refquota none default
262 pool/home/bob refreservation none default
263 pool/home/bob primarycache all default
264 pool/home/bob secondarycache all default
265 pool/home/bob usedbysnapshots 0 -
266 pool/home/bob usedbydataset 21K -
267 pool/home/bob usedbychildren 0 -
268 pool/home/bob usedbyrefreservation 0 -
271 The following command gets a single property value:
272 .Bd -literal -compact -offset Ds
273 .No # Nm zfs Cm get Fl H o Sy value compression Ar pool/home/bob
277 The following command lists all properties with local settings for
279 .Bd -literal -compact -offset Ds
280 .No # Nm zfs Cm get Fl r s Sy local Fl o Sy name , Ns Sy property , Ns Sy value all Ar pool/home/bob
282 pool/home/bob quota 20G
283 pool/home/bob compression on
286 .Ss Example 5 : No Inheriting ZFS Properties
287 The following command causes
288 .Ar pool/home/bob No and Ar pool/home/anne
291 property from their parent.
292 .Dl # Nm zfs Cm inherit Sy checksum Ar pool/home/bob pool/home/anne
294 .Ss Example 6 : No Setting User Properties
295 The following example sets the user-defined
296 .Ar com.example : Ns Ar department
297 property for a dataset:
298 .Dl # Nm zfs Cm set Ar com.example : Ns Ar department Ns = Ns Ar 12345 tank/accounting
300 .Ss Example 7 : No Setting sharenfs Property Options on a ZFS File System
301 The following commands show how to set
303 property options to enable read-write
304 access for a set of IP addresses and to enable root access for system
309 .Dl # Nm zfs Cm set Sy sharenfs Ns = Ns ' Ns Ar rw Ns =@123.123.0.0/16:[::1],root= Ns Ar neo Ns ' tank/home
311 If you are using DNS for host name resolution,
312 specify the fully-qualified hostname.