Whamcloud - gitweb
bab4ad02643ede1c5b26def29b9726f50bb1352f
[fs/lustre-release.git] / lustre / doc / lfs-quota.1
1 .TH LFS-QUOTA 1 2020-04-06 "Lustre" "Lustre Utilities"
2 .SH NAME
3 lfs quota \- display quota limits and status for users, groups, or projects.
4 .SH SYNOPSIS
5 .B lfs quota \fR[\fB-hqv\fR]
6        [\fB-o <\fIobd_uuid\fR>|\fB-I <\fIost_idx\fR>|\fB-i <\fImdt_idx\fR>]
7        [\fB-u <\fIuname\fR|\fIuid\fR>|\fB-g <\fIgname\fR|\fIgid\fR>\
8 |\fB-p <\fIprojid\fR>]
9        [\fB--pool\fR <\fIpname\fR>]
10        <\fIfilesystem\fR>\fR
11
12 .br
13 .B lfs quota \fR[\fB-hq\fR] \fR<\fB-U\fR|\fB-G\fR|\fB-P\fR> <\fIfilesystem\fR>
14 .br
15
16 .br
17 .B lfs quota -t \fR<\fB-u\fR|\fB-g\fR|\fB-p\fR> <\fIfilesystem\fR>
18 .br
19
20 .TP
21 .SH DESCRIPTION
22 .PP
23 .B lfs quota <\fIfilesystem\fR>\fR
24 .TP
25
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. \
30 A user or group name or an ID can \
31 be specified. If user, group and project are omitted, quotas for \
32 current uid/gid/projid are shown.
33 .TP
34 .B -h
35 Human readable. This will change the formatting of \
36 block storage and time values. Without this option block storage values \
37 are in kilobytes and times are in seconds. With this option block storage \
38 values use the common metric binary suffixes
39 .BR k "," M "," G "," T "," P "," E
40 which specify units of 2^10, 2^20, 2^30, 2^40, 2^50 and 2^60 \
41 respectively.
42 Time values use the "XXwXXdXXhXXmXXs" format. This format specifies \
43 weeks, days, hours, minutes, seconds.
44 .TP
45 .B -q
46 Quiet. Display only the line containing the data. \
47 The line saying what the data is, and the line with the data
48 column headers will not be printed.
49 .TP
50 .B -v
51 Verbose. Display per-MDT and per-OST statistics in addition
52 to the usual system wide data. An asterisk near the OST or MDT means that
53 the quota is exceeded only for that specific target. The user is over the
54 quota only if an asterisk is near the whole filesystem usage.
55 .TP
56 .B -u <\fIuname|uid\fR>
57 Display user quota information for \fIuname\fR or \fIuid\fR.
58 .TP
59 .B -g <\fIgname|gid\fR>
60 Display group quota information for name \fIgname\fR or \fIgid\fR.
61 .TP
62 .B -p <\fIprojid\fR>
63 Display project quota information for \fIprojid\fR.
64 .TP
65 .B -o <\fIobd_uuid\fR>
66 Display quota information for \fIobd_uuid\fR.
67 .TP
68 .B -i <\fImdt_idx\fR>
69 Display project quota information for \fImdt_idx\fR.
70 .TP
71 .B -I <\fIost_idx\fR>
72 Display project quota information for \fIost_idx\fR.
73 .TP
74 .B --pool <\fIpname\fR>
75 Display quota information per OST pool \fIpname\fR.
76 .TP
77 .B lfs quota \fR<\fB-U\fR|\fB-G\fR|\fB-P\fR> <\fIfilesystem\fR>
78 .TP
79 Display default quota values for users, groups, or projects. \
80 This command requires super user permissions.
81 .TP
82 .B -U <\fIuname|uid\fR>
83 Display default user quota information for <\fIfilesystem\fR>.
84 .TP
85 .B -G <\fIgname|gid\fR>
86 Display default group quota information for name <\fIfilesystem\fR>.
87 .TP
88 .B -P <\fIprojid\fR>
89 Display default project quota information for <\fIfilesystem\fR>.
90 .TP
91 .B lfs quota -t \fR<\fB-u\fR|\fB-g\fR|\fB-p\fR> [\fB--pool\fR <\fIpname\fR>] <\fIfilesystem\fR>
92 .TP
93 Display grace times for users, groups, or projects. \
94 The format is always "XXwXXdXXhXXmXXs".
95 .TP
96 .B -u <\fIuname|uid\fR>
97 Display default user grace times for <\fIfilesystem\fR>.
98 .TP
99 .B -g <\fIgname|gid\fR>
100 Display default group grace times for name <\fIfilesystem\fR>.
101 .TP
102 .B -p <\fIprojid\fR>
103 Display default project grace times for <\fIfilesystem\fR>.
104 .TP
105 .B --pool <\fIpname\fR>
106 Display user, group or project grace times per OST pool \fIpname\fR.
107 .TP
108 .SH EXAMPLES
109 .TP
110 .B $ lfs quota /mnt/lustre
111 Display quotas and usage for current user, group, and project
112 .TP
113 .B $ lfs quota -u bob /mnt/lustre
114 Display quotas and usage for user 'bob'
115 .TP
116 .B $ lfs quota -U /mnt/lustre
117 Display default user quotas
118 .TP
119 .B $ lfs quota -t -u /mnt/lustre
120 Display grace times for user quotas on /mnt/lustre
121 .TP
122 .B $ lfs quota -u ivan --pool flash_pool /mnt/lustre
123 Display quotas and usage for user 'ivan' per 'flash_pool"
124 .TP
125 .B $ lfs quota -t -g --pool flash_pool /mnt/lustre
126 Display grace times for group quotas per 'flash_pool"
127 .TP
128 .SH SEE ALSO
129 .BR lfs (1),
130 .BR lfs-setquota(1)