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 June 2, 2021 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 SEE ALSO 181.Xr zfsprops 7 , 182.Xr zfs-list 8 183