Whamcloud - gitweb
LU-17662 osd-zfs: Support for ZFS 2.2.3
[fs/lustre-release.git] / lustre / doc / lfs-quota.1
1 .TH LFS-QUOTA 1 2022-02-26 "Lustre" "Lustre Utilities"
2 .SH NAME
3 lfs-quota \- display quota limits and status for users, groups, or projects.
4 .SH SYNOPSIS
5 .BR "lfs quota " [ -hqv "] [" --ost " \fIobd_uuid\fR|" --mdt " \fIMDT_IDX\fR]
6        [\fB-u \fIUSER\fR|\fB-g <\fIGROUP\fR>|\fB-p \fIPROJID\fR]
7 [\fB--pool\fR \fIPOOL_NAME\fR] \fIFILESYSTEM
8
9 .br
10 .BR "lfs quota " [ -hq "] {" -U | -G | -P } " " \fIFILESYSTEM
11 .br
12
13 .br
14 .BR "lfs quota " -t " {" -u | -g | -p "} " \fIFILESYSTEM
15 .br
16
17 .br
18 .B lfs quota -a \fR<\fB-u\fR|\fB-g\fR|\fB-p\fR> <\fIfilesystem\fR>
19 .br
20
21 .TP
22 .SH DESCRIPTION
23 .PP
24 .TP
25 .B lfs quota \fIFILESYSTEM
26 Display disk usage and limits for individual users, groups, and projects.
27 An asterisk is displayed when the quota is exceeded.
28 By default the statistics for the entire filesystem are displayed but
29 individual MDTs and OSTs can be specified with the
30 .B --ost
31 or
32 .B --mdt
33 options.  A user, group, or project ID can be specified.
34 If user, group, and project are omitted, quotas for the
35 current uid/gid/projid are shown.
36 .TP
37 .BR -h | --human-readable
38 This will change the formatting of
39 block storage and time values. Without this option block storage values
40 are in kilobytes and times are in seconds. With this option block storage
41 values use the common metric binary suffixes
42 .BR K ", " M ", " G ", " T ", " P ", and " E
43 which specify units of 2^10, 2^20, 2^30, 2^40, 2^50 and 2^60 bytes,
44 respectively.  Time values will use the "XXwXXdXXhXXmXXs" format, which
45 specifies weeks, days, hours, minutes, seconds.
46 .TP
47 .BR -g | --group " {" \fIGROUP | \fIGID }
48 Display quota information for group name \fIGROUP\fR or numeric \fIGID\fR.
49 .TP
50 .BR -m | --mdt " " \fIMDT_IDX
51 Display quota information for MDT \fIMDT_IDX\fR.
52 .TP
53 .BR -o | --ost " " \fIOST_IDX
54 Display quota information for OST \fIOST_IDX\fR.
55 .TP
56 .BR --pool " " \fIPOOL_NAME
57 Display quota information for OST pool \fIPOOL_NAME\fR.
58 .TP
59 .BR -p | --projid " " \fIPROJID
60 Display quota information for project \fIPROJID\fR.
61 .TP
62 .BR -q | --quiet
63 Display only the line containing the data.
64 The line saying what the data is, and the column headers will not be printed.
65 .TP
66 .BR -u | --user " {" \fIUSER | \fIUID }
67 Display quota information for user name \fIUSER\fR or numeric \fIUID\fR.
68 .TP
69 .BR -v | --verbose
70 Display per-MDT and per-OST statistics in addition
71 to the usual system wide data. An asterisk near the OST or MDT means that
72 the quota is exceeded only for that specific target. The user is over the
73 quota only if an asterisk is near the whole filesystem usage.
74 Inactive target will also be printed but marked as "inact".
75 .TP
76 .BR "lfs quota " { -U | -G | -P "} " FILESYSTEM
77 Display default quota values for users, groups, or projects.
78 This command requires super user permissions.
79 .TP
80 .BR -G | --default-grp " {" \fIGROUP | \fIGID }
81 Display default quota limits for group name \fIGROUP\fR or numeric \fIGID\fR.
82 .TP
83 .BR -P \fIPROJID
84 Display default quota limits for project \fIPROJID\fR.
85 .TP
86 .BR -U | --default-usr " {" \fIUSER | UID }
87 Display default quota limits for username \fIUSER\fR or numeric \fIUID\fR.
88 .TP
89 .BR "lfs quota -a" " {" -u | -g | -p "} " \fIFILESYSTEM
90 .TP
91 Display all quota setting for all users, groups, or projects.
92 .TP
93 .BR "lfs quota -t" | --times " {" -u | -g | -p "} [" --pool " \fIPOOL_NAME\fR] " \fIFILESYSTEM
94 Display grace times for users, groups, or projects.
95 Time values use the "XXwXXdXXhXXmXXs" format, which specifies
96 weeks, days, hours, minutes, seconds.
97 .SH EXAMPLES
98 .TP
99 .B $ lfs quota /mnt/lustre
100 Display quotas and usage for current user, group, and project
101 .TP
102 .B # lfs quota -u bob /mnt/lustre
103 Display quotas and usage for user 'bob'
104 .TP
105 .B # lfs quota -U /mnt/lustre
106 Display default user quotas
107 .TP
108 .B $ lfs quota -t -u /mnt/lustre
109 Display grace times for user quotas on /mnt/lustre
110 .TP
111 .B # lfs quota -u ivan --pool flash_pool /mnt/lustre
112 Display quotas and usage for user
113 .B ivan
114 from the OST pool
115 .BR flash_pool .
116 .TP
117 .B $ lfs quota -t -g --pool flash_pool /mnt/lustre
118 Display grace times for group quotas for the OST pool
119 .BR flash_pool .
120 .TP
121 .SH SEE ALSO
122 .BR lfs (1),
123 .BR lfs-setquota(1)