Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages


home | help
ZFS-SET(8)		FreeBSD	System Manager's Manual		    ZFS-SET(8)

     zfs-set --	set properties on ZFS datasets

     zfs set property=value [property=value]a| filesystem|volume|snapshota|
     zfs get [-r|-d depth] [-Hp] [-o field[,field]a|] [-s source[,source]a|]
	 [-t type[,type]a|] all|property[,property]a|
     zfs inherit [-rS] property	filesystem|volume|snapshota|

     zfs set property=value [property=value]a| filesystem|volume|snapshota|
       Only some properties can	be edited.  See	zfsprops(7) for	more informa-
       tion on what properties can be set and acceptable values.  Numeric val-
       ues 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).  User properties can be set on snapshots.	 For more in-
       formation, see the User Properties section of zfsprops(7).

     zfs get [-r|-d depth] [-Hp] [-o field[,field]a|] [-s source[,source]a|]
       [-t type[,type]a|] all|property[,property]a|
       Displays	properties for the given datasets.  If no datasets are speci-
       fied, then the command displays properties for all datasets on the sys-
       tem.  For each property,	the following columns are displayed:
	   name	     Dataset name
	   property  Property name
	   value     Property value
	   source    Property source local, default, inherited,	temporary,
		     received, or - (none).

       All columns are displayed by default, though this can be	controlled by
       using the -o option.  This command takes	a comma-separated list of
       properties as described in the Native Properties	and User Properties
       sections	of zfsprops(7).

       The value all can be used to display all	properties that	apply to the
       given dataset's type (filesystem, volume, snapshot, or bookmark).

       -H	  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.

       -d depth	  Recursively display any children of the dataset, limiting
		  the recursion	to depth.  A depth of 1	will display only the
		  dataset and its direct children.

       -o field	  A comma-separated list of columns to display,	defaults to

       -p	  Display numbers in parsable (exact) values.

       -r	  Recursively display properties for any children.

       -s source  A comma-separated list of sources to display.	 Those proper-
		  ties coming from a source other than those in	this list are
		  ignored.  Each source	must be	one of the following: local,
		  default, inherited, temporary, received, or none.  The de-
		  fault	value is all sources.

       -t type	  A comma-separated list of types to display, where type is
		  one of filesystem, snapshot, volume, bookmark, or all.

     zfs inherit [-rS] property	filesystem|volume|snapshota|
       Clears the specified property, causing it to be inherited from an an-
       cestor, restored	to default if no ancestor has the property set,	or
       with the	-S option reverted to the received value if one	exists.	 See
       zfsprops(7) for a listing of default values, and	details	on which prop-
       erties can be inherited.

       -r  Recursively inherit the given property for all children.

       -S  Revert the property to the received value if	one exists; otherwise
	   operate as if the -S	option was not specified.

     zfsprops(7), zfs-list(8)

FreeBSD	13.0			 June 2, 2021			  FreeBSD 13.0


Want to link to this manual page? Use this URL:

home | help