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 30, 2019 33.Dt ZFS-USERSPACE 8 34.Os 35. 36.Sh NAME 37.Nm zfs-userspace 38.Nd display space and quotas of ZFS dataset 39.Sh SYNOPSIS 40.Nm zfs 41.Cm userspace 42.Op Fl Hinp 43.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc 44.Oo Fl s Ar field Oc Ns … 45.Oo Fl S Ar field Oc Ns … 46.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns … Oc 47.Ar filesystem Ns | Ns Ar snapshot Ns | Ns Ar path 48.Nm zfs 49.Cm groupspace 50.Op Fl Hinp 51.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc 52.Oo Fl s Ar field Oc Ns … 53.Oo Fl S Ar field Oc Ns … 54.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns … Oc 55.Ar filesystem Ns | Ns Ar snapshot Ns | Ns Ar path 56.Nm zfs 57.Cm projectspace 58.Op Fl Hp 59.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc 60.Oo Fl s Ar field Oc Ns … 61.Oo Fl S Ar field Oc Ns … 62.Ar filesystem Ns | Ns Ar snapshot Ns | Ns Ar path 63. 64.Sh DESCRIPTION 65.Bl -tag -width "" 66.It Xo 67.Nm zfs 68.Cm userspace 69.Op Fl Hinp 70.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc 71.Oo Fl s Ar field Oc Ns … 72.Oo Fl S Ar field Oc Ns … 73.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns … Oc 74.Ar filesystem Ns | Ns Ar snapshot Ns | Ns Ar path 75.Xc 76Displays space consumed by, and quotas on, each user in the specified filesystem, 77snapshot, or path. 78If a path is given, the filesystem that contains that path will be used. 79This corresponds to the 80.Sy userused@ Ns Em user , 81.Sy userobjused@ Ns Em user , 82.Sy userquota@ Ns Em user , 83and 84.Sy userobjquota@ Ns Em user 85properties. 86.Bl -tag -width "-S field" 87.It Fl H 88Do not print headers, use tab-delimited output. 89.It Fl S Ar field 90Sort by this field in reverse order. 91See 92.Fl s . 93.It Fl i 94Translate SID to POSIX ID. 95The POSIX ID may be ephemeral if no mapping exists. 96Normal POSIX interfaces 97.Pq like Xr stat 2 , Nm ls Fl l 98perform this translation, so the 99.Fl i 100option allows the output from 101.Nm zfs Cm userspace 102to be compared directly with those utilities. 103However, 104.Fl i 105may lead to confusion if some files were created by an SMB user before a 106SMB-to-POSIX name mapping was established. 107In such a case, some files will be owned by the SMB entity and some by the POSIX 108entity. 109However, the 110.Fl i 111option will report that the POSIX entity has the total usage and quota for both. 112.It Fl n 113Print numeric ID instead of user/group name. 114.It Fl o Ar field Ns Oo , Ns Ar field Oc Ns … 115Display only the specified fields from the following set: 116.Sy type , 117.Sy name , 118.Sy used , 119.Sy quota . 120The default is to display all fields. 121.It Fl p 122Use exact 123.Pq parsable 124numeric output. 125.It Fl s Ar field 126Sort output by this field. 127The 128.Fl s 129and 130.Fl S 131flags may be specified multiple times to sort first by one field, then by 132another. 133The default is 134.Fl s Sy type Fl s Sy name . 135.It Fl t Ar type Ns Oo , Ns Ar type Oc Ns … 136Print only the specified types from the following set: 137.Sy all , 138.Sy posixuser , 139.Sy smbuser , 140.Sy posixgroup , 141.Sy smbgroup . 142The default is 143.Fl t Sy posixuser , Ns Sy smbuser . 144The default can be changed to include group types. 145.El 146.It Xo 147.Nm zfs 148.Cm groupspace 149.Op Fl Hinp 150.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc 151.Oo Fl s Ar field Oc Ns … 152.Oo Fl S Ar field Oc Ns … 153.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns … Oc 154.Ar filesystem Ns | Ns Ar snapshot 155.Xc 156Displays space consumed by, and quotas on, each group in the specified 157filesystem or snapshot. 158This subcommand is identical to 159.Cm userspace , 160except that the default types to display are 161.Fl t Sy posixgroup , Ns Sy smbgroup . 162.It Xo 163.Nm zfs 164.Cm projectspace 165.Op Fl Hp 166.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc 167.Oo Fl s Ar field Oc Ns … 168.Oo Fl S Ar field Oc Ns … 169.Ar filesystem Ns | Ns Ar snapshot Ns | Ns Ar path 170.Xc 171Displays space consumed by, and quotas on, each project in the specified 172filesystem or snapshot. 173This subcommand is identical to 174.Cm userspace , 175except that the project identifier is a numeral, not a name. 176So need neither the option 177.Fl i 178for SID to POSIX ID nor 179.Fl n 180for numeric ID, nor 181.Fl t 182for types. 183.El 184. 185.Sh SEE ALSO 186.Xr zfsprops 7 , 187.Xr zfs-set 8 188