1.\" 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.\" 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. 31.\" 32.Dd March 16, 2022 33.Dt ZFS-SET 8 34.Os 35. 36.Sh NAME 37.Nm zfs-set 38.Nd set properties on ZFS datasets 39.Sh SYNOPSIS 40.Nm zfs 41.Cm set 42.Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns … 43.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns … 44.Nm zfs 45.Cm get 46.Op Fl r Ns | Ns Fl d Ar depth 47.Op Fl Hp 48.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc 49.Oo Fl s Ar source Ns Oo , Ns Ar source Oc Ns … Oc 50.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns … Oc 51.Cm all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns … 52.Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Oc Ns … 53.Nm zfs 54.Cm inherit 55.Op Fl rS 56.Ar property Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns … 57. 58.Sh DESCRIPTION 59.Bl -tag -width "" 60.It Xo 61.Nm zfs 62.Cm set 63.Ar property Ns = Ns Ar value Oo Ar property Ns = Ns Ar value Oc Ns … 64.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns … 65.Xc 66Only some properties can be edited. 67See 68.Xr zfsprops 7 69for more information on what properties can be set and acceptable 70values. 71Numeric values can be specified as exact values, or in a human-readable form 72with a suffix of 73.Sy B , K , M , G , T , P , E , Z 74.Po for bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes, exabytes, 75or zettabytes, respectively 76.Pc . 77User properties can be set on snapshots. 78For more information, see the 79.Em User Properties 80section of 81.Xr zfsprops 7 . 82.It Xo 83.Nm zfs 84.Cm get 85.Op Fl r Ns | Ns Fl d Ar depth 86.Op Fl Hp 87.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc 88.Oo Fl s Ar source Ns Oo , Ns Ar source Oc Ns … Oc 89.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns … Oc 90.Cm all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns … 91.Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns | Ns Ar bookmark Oc Ns … 92.Xc 93Displays properties for the given datasets. 94If no datasets are specified, then the command displays properties for all 95datasets on the system. 96For each property, the following columns are displayed: 97.Bl -tag -compact -offset 4n -width "property" 98.It Sy name 99Dataset name 100.It Sy property 101Property name 102.It Sy value 103Property value 104.It Sy source 105Property source 106.Sy local , default , inherited , temporary , received , No or Sy - Pq none . 107.El 108.Pp 109All columns are displayed by default, though this can be controlled by using the 110.Fl o 111option. 112This command takes a comma-separated list of properties as described in the 113.Sx Native Properties 114and 115.Sx User Properties 116sections of 117.Xr zfsprops 7 . 118.Pp 119The value 120.Sy all 121can be used to display all properties that apply to the given dataset's type 122.Pq Sy filesystem , volume , snapshot , No or Sy bookmark . 123.Bl -tag -width "-s source" 124.It Fl H 125Display output in a form more easily parsed by scripts. 126Any headers are omitted, and fields are explicitly separated by a single tab 127instead of an arbitrary amount of space. 128.It Fl d Ar depth 129Recursively display any children of the dataset, limiting the recursion to 130.Ar depth . 131A depth of 132.Sy 1 133will display only the dataset and its direct children. 134.It Fl o Ar field 135A comma-separated list of columns to display, defaults to 136.Sy name , Ns Sy property , Ns Sy value , Ns Sy source . 137.It Fl p 138Display numbers in parsable 139.Pq exact 140values. 141.It Fl r 142Recursively display properties for any children. 143.It Fl s Ar source 144A comma-separated list of sources to display. 145Those properties coming from a source other than those in this list are ignored. 146Each source must be one of the following: 147.Sy local , default , inherited , temporary , received , No or Sy none . 148The default value is all sources. 149.It Fl t Ar type 150A comma-separated list of types to display, where 151.Ar type 152is one of 153.Sy filesystem , snapshot , volume , bookmark , No or Sy all . 154.El 155.It Xo 156.Nm zfs 157.Cm inherit 158.Op Fl rS 159.Ar property Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Ns … 160.Xc 161Clears the specified property, causing it to be inherited from an ancestor, 162restored to default if no ancestor has the property set, or with the 163.Fl S 164option reverted to the received value if one exists. 165See 166.Xr zfsprops 7 167for a listing of default values, and details on which properties can be 168inherited. 169.Bl -tag -width "-r" 170.It Fl r 171Recursively inherit the given property for all children. 172.It Fl S 173Revert the property to the received value if one exists; otherwise operate as 174if the 175.Fl S 176option was not specified. 177.El 178.El 179. 180.Sh EXAMPLES 181.\" These are, respectively, examples 1, 4, 6, 7, 11, 14, 16 from zfs.8 182.\" Make sure to update them bidirectionally 183.Ss Example 1 : No Creating a ZFS File System Hierarchy 184The following commands create a file system named 185.Ar pool/home 186and a file system named 187.Ar pool/home/bob . 188The mount point 189.Pa /export/home 190is set for the parent file system, and is automatically inherited by the child 191file system. 192.Dl # Nm zfs Cm create Ar pool/home 193.Dl # Nm zfs Cm set Sy mountpoint Ns = Ns Ar /export/home pool/home 194.Dl # Nm zfs Cm create Ar pool/home/bob 195. 196.Ss Example 2 : No Disabling and Enabling File System Compression 197The following command disables the 198.Sy compression 199property for all file systems under 200.Ar pool/home . 201The next command explicitly enables 202.Sy compression 203for 204.Ar pool/home/anne . 205.Dl # Nm zfs Cm set Sy compression Ns = Ns Sy off Ar pool/home 206.Dl # Nm zfs Cm set Sy compression Ns = Ns Sy on Ar pool/home/anne 207. 208.Ss Example 3 : No Setting a Quota on a ZFS File System 209The following command sets a quota of 50 Gbytes for 210.Ar pool/home/bob : 211.Dl # Nm zfs Cm set Sy quota Ns = Ns Ar 50G pool/home/bob 212. 213.Ss Example 4 : No Listing ZFS Properties 214The following command lists all properties for 215.Ar pool/home/bob : 216.Bd -literal -compact -offset Ds 217.No # Nm zfs Cm get Sy all Ar pool/home/bob 218NAME PROPERTY VALUE SOURCE 219pool/home/bob type filesystem - 220pool/home/bob creation Tue Jul 21 15:53 2009 - 221pool/home/bob used 21K - 222pool/home/bob available 20.0G - 223pool/home/bob referenced 21K - 224pool/home/bob compressratio 1.00x - 225pool/home/bob mounted yes - 226pool/home/bob quota 20G local 227pool/home/bob reservation none default 228pool/home/bob recordsize 128K default 229pool/home/bob mountpoint /pool/home/bob default 230pool/home/bob sharenfs off default 231pool/home/bob checksum on default 232pool/home/bob compression on local 233pool/home/bob atime on default 234pool/home/bob devices on default 235pool/home/bob exec on default 236pool/home/bob setuid on default 237pool/home/bob readonly off default 238pool/home/bob zoned off default 239pool/home/bob snapdir hidden default 240pool/home/bob acltype off default 241pool/home/bob aclmode discard default 242pool/home/bob aclinherit restricted default 243pool/home/bob canmount on default 244pool/home/bob xattr on default 245pool/home/bob copies 1 default 246pool/home/bob version 4 - 247pool/home/bob utf8only off - 248pool/home/bob normalization none - 249pool/home/bob casesensitivity sensitive - 250pool/home/bob vscan off default 251pool/home/bob nbmand off default 252pool/home/bob sharesmb off default 253pool/home/bob refquota none default 254pool/home/bob refreservation none default 255pool/home/bob primarycache all default 256pool/home/bob secondarycache all default 257pool/home/bob usedbysnapshots 0 - 258pool/home/bob usedbydataset 21K - 259pool/home/bob usedbychildren 0 - 260pool/home/bob usedbyrefreservation 0 - 261.Ed 262.Pp 263The following command gets a single property value: 264.Bd -literal -compact -offset Ds 265.No # Nm zfs Cm get Fl H o Sy value compression Ar pool/home/bob 266on 267.Ed 268.Pp 269The following command lists all properties with local settings for 270.Ar pool/home/bob : 271.Bd -literal -compact -offset Ds 272.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 273NAME PROPERTY VALUE 274pool/home/bob quota 20G 275pool/home/bob compression on 276.Ed 277. 278.Ss Example 5 : No Inheriting ZFS Properties 279The following command causes 280.Ar pool/home/bob No and Ar pool/home/anne 281to inherit the 282.Sy checksum 283property from their parent. 284.Dl # Nm zfs Cm inherit Sy checksum Ar pool/home/bob pool/home/anne 285. 286.Ss Example 6 : No Setting User Properties 287The following example sets the user-defined 288.Ar com.example : Ns Ar department 289property for a dataset: 290.Dl # Nm zfs Cm set Ar com.example : Ns Ar department Ns = Ns Ar 12345 tank/accounting 291. 292.Ss Example 7 : No Setting sharenfs Property Options on a ZFS File System 293The following commands show how to set 294.Sy sharenfs 295property options to enable read-write 296access for a set of IP addresses and to enable root access for system 297.Qq neo 298on the 299.Ar tank/home 300file system: 301.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 302.Pp 303If you are using DNS for host name resolution, 304specify the fully-qualified hostname. 305. 306.Sh SEE ALSO 307.Xr zfsprops 7 , 308.Xr zfs-list 8 309