Whamcloud - gitweb
e8abe6b9714d42fc87501a92f2a553fedd2234fe
[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 By default the statistics for the entire filesystem are displayed but \
28 individual MDTs and OSTs can be specified. \
29 A user or group name or an ID can \
30 be specified. If user, group and project are omitted, quotas for \
31 current uid/gid/projid are shown.
32 .TP
33 .B -h
34 Human readable. This will change the formatting of \
35 block storage and time values. Without this option block storage values \
36 are in kilobytes and times are in seconds. With this option block storage \
37 values use the common metric binary suffixes
38 .BR k "," M "," G "," T "," P "," E
39 which specify units of 2^10, 2^20, 2^30, 2^40, 2^50 and 2^60 \
40 respectively.
41 Time values use the "XXwXXdXXhXXmXXs" format. This format specifies \
42 weeks, days, hours, minutes, seconds.
43 .TP
44 .B -q
45 Quiet. Display only the line containing the data. \
46 The line saying what the data is, and the line with the data
47 column headers will not be printed.
48 .TP
49 .B -v
50 Verbose. Display per-MDT and per-OST statistics in addition
51 to the usual system wide data.
52 .TP
53 .B -u <\fIuname|uid\fR>
54 Display user quota information for \fIuname\fR or \fIuid\fR.
55 .TP
56 .B -g <\fIgname|gid\fR>
57 Display group quota information for name \fIgname\fR or \fIgid\fR.
58 .TP
59 .B -p <\fIprojid\fR>
60 Display project quota information for \fIprojid\fR.
61 .TP
62 .B -o <\fIobd_uuid\fR>
63 Display quota information for \fIobd_uuid\fR.
64 .TP
65 .B -i <\fImdt_idx\fR>
66 Display project quota information for \fImdt_idx\fR.
67 .TP
68 .B -I <\fIost_idx\fR>
69 Display project quota information for \fIost_idx\fR.
70 .TP
71 .B --pool <\fIpname\fR>
72 Display quota information per OST pool \fIpname\fR.
73 .TP
74 .B lfs quota \fR<\fB-U\fR|\fB-G\fR|\fB-P\fR> <\fIfilesystem\fR>
75 .TP
76 Display default quota values for users, groups, or projects. \
77 This command requires super user permissions.
78 .TP
79 .B -U <\fIuname|uid\fR>
80 Display default user quota information for <\fIfilesystem\fR>.
81 .TP
82 .B -G <\fIgname|gid\fR>
83 Display default group quota information for name <\fIfilesystem\fR>.
84 .TP
85 .B -P <\fIprojid\fR>
86 Display default project quota information for <\fIfilesystem\fR>.
87 .TP
88 .B lfs quota -t \fR<\fB-u\fR|\fB-g\fR|\fB-p\fR> [\fB--pool\fR <\fIpname\fR>] <\fIfilesystem\fR>
89 .TP
90 Display grace times for users, groups, or projects. \
91 The format is always "XXwXXdXXhXXmXXs".
92 .TP
93 .B -u <\fIuname|uid\fR>
94 Display default user grace times for <\fIfilesystem\fR>.
95 .TP
96 .B -g <\fIgname|gid\fR>
97 Display default group grace times for name <\fIfilesystem\fR>.
98 .TP
99 .B -p <\fIprojid\fR>
100 Display default project grace times for <\fIfilesystem\fR>.
101 .TP
102 .B --pool <\fIpname\fR>
103 Display user, group or project grace times per OST pool \fIpname\fR.
104 .TP
105 .SH EXAMPLES
106 .TP
107 .B $ lfs quota /mnt/lustre
108 Display quotas and usage for current user, group, and project
109 .TP
110 .B $ lfs quota -u bob /mnt/lustre
111 Display quotas and usage for user 'bob'
112 .TP
113 .B $ lfs quota -U /mnt/lustre
114 Display default user quotas
115 .TP
116 .B $ lfs quota -t -u /mnt/lustre
117 Display grace times for user quotas on /mnt/lustre
118 .TP
119 .B $ lfs quota -u ivan --pool flash_pool /mnt/lustre
120 Display quotas and usage for user 'ivan' per 'flash_pool"
121 .TP
122 .B $ lfs quota -t -g --pool flash_pool /mnt/lustre
123 Display grace times for group quotas per 'flash_pool"
124 .TP
125 .SH SEE ALSO
126 .BR lfs (1),
127 .BR lfs-setquota(1)