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 https://opensource.org/licenses/CDDL-1.0. 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 February 8, 2024 33.Dt ZFS-LIST 8 34.Os 35. 36.Sh NAME 37.Nm zfs-list 38.Nd list properties of ZFS datasets 39.Sh SYNOPSIS 40.Nm zfs 41.Cm list 42.Op Fl r Ns | Ns Fl d Ar depth 43.Op Fl Hp 44.Oo Fl o Ar property Ns Oo , Ns Ar property Oc Ns … Oc 45.Oo Fl s Ar property Oc Ns … 46.Oo Fl S Ar property Oc Ns … 47.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns … Oc 48.Oo Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot Oc Ns … 49. 50.Sh DESCRIPTION 51If specified, you can list property information by the absolute pathname or the 52relative pathname. 53By default, all file systems and volumes are displayed. 54Snapshots are displayed if the 55.Sy listsnapshots 56pool property is 57.Sy on 58.Po the default is 59.Sy off 60.Pc , 61or if the 62.Fl t Sy snapshot 63or 64.Fl t Sy all 65options are specified. 66The following fields are displayed: 67.Sy name , Sy used , Sy available , Sy referenced , Sy mountpoint . 68.Bl -tag -width "-H" 69.It Fl H 70Used for scripting mode. 71Do not print headers and separate fields by a single tab instead of arbitrary 72white space. 73.It Fl d Ar depth 74Recursively display any children of the dataset, limiting the recursion to 75.Ar depth . 76A 77.Ar depth 78of 79.Sy 1 80will display only the dataset and its direct children. 81.It Fl o Ar property 82A comma-separated list of properties to display. 83The property must be: 84.Bl -bullet -compact 85.It 86One of the properties described in the 87.Sx Native Properties 88section of 89.Xr zfsprops 7 90.It 91A user property 92.It 93The value 94.Sy name 95to display the dataset name 96.It 97The value 98.Sy space 99to display space usage properties on file systems and volumes. 100This is a shortcut for specifying 101.Fl o Ns \ \& Ns Sy name , Ns Sy avail , Ns Sy used , Ns Sy usedsnap , Ns 102.Sy usedds , Ns Sy usedrefreserv , Ns Sy usedchild 103.Fl t Sy filesystem , Ns Sy volume . 104.El 105.It Fl p 106Display numbers in parsable 107.Pq exact 108values. 109.It Fl r 110Recursively display any children of the dataset on the command line. 111.It Fl s Ar property 112A property for sorting the output by column in ascending order based on the 113value of the property. 114The property must be one of the properties described in the 115.Sx Properties 116section of 117.Xr zfsprops 7 118or the value 119.Sy name 120to sort by the dataset name. 121Multiple properties can be specified at one time using multiple 122.Fl s 123property options. 124Multiple 125.Fl s 126options are evaluated from left to right in decreasing order of importance. 127The following is a list of sorting criteria: 128.Bl -bullet -compact 129.It 130Numeric types sort in numeric order. 131.It 132String types sort in alphabetical order. 133.It 134Types inappropriate for a row sort that row to the literal bottom, regardless of 135the specified ordering. 136.El 137.Pp 138If no sorting options are specified the existing behavior of 139.Nm zfs Cm list 140is preserved. 141.It Fl S Ar property 142Same as 143.Fl s , 144but sorts by property in descending order. 145.It Fl t Ar type 146A comma-separated list of types to display, where 147.Ar type 148is one of 149.Sy filesystem , 150.Sy snapshot , 151.Sy volume , 152.Sy bookmark , 153or 154.Sy all . 155For example, specifying 156.Fl t Sy snapshot 157displays only snapshots. 158.Sy fs , 159.Sy snap , 160or 161.Sy vol 162can be used as aliases for 163.Sy filesystem , 164.Sy snapshot , 165or 166.Sy volume . 167.El 168. 169.Sh EXAMPLES 170.\" These are, respectively, examples 5 from zfs.8 171.\" Make sure to update them bidirectionally 172.Ss Example 1 : No Listing ZFS Datasets 173The following command lists all active file systems and volumes in the system. 174Snapshots are displayed if 175.Sy listsnaps Ns = Ns Sy on . 176The default is 177.Sy off . 178See 179.Xr zpoolprops 7 180for more information on pool properties. 181.Bd -literal -compact -offset Ds 182.No # Nm zfs Cm list 183NAME USED AVAIL REFER MOUNTPOINT 184pool 450K 457G 18K /pool 185pool/home 315K 457G 21K /export/home 186pool/home/anne 18K 457G 18K /export/home/anne 187pool/home/bob 276K 457G 276K /export/home/bob 188.Ed 189. 190.Sh SEE ALSO 191.Xr zfsprops 7 , 192.Xr zfs-get 8 193