Whamcloud - gitweb
LU-7544 doc: improve setquota man page
[fs/lustre-release.git] / lustre / doc / lfs-setquota.1
1 .TH LFS-SETQUOTA 1 2017-07-21 "Lustre" "Lustre Utilities"
2 .SH NAME
3 lfs setquota \- set quota limits or grace time for users, groups or projects.
4 .SH SYNOPSIS
5 .B lfs setquota {\fB-u|--user|-g|--group|-p|--projid\fR} <\fIuname|uid|gname|gid|projid\fR>
6        [\fB--block-softlimit|-b\fR <\fIblock-softlimit\fR>[kMGTPE]]
7        [\fB--block-hardlimit|-B\fR <\fIblock-hardlimit\fR>[kMGTPE]]
8        [\fB--inode-softlimit|-i\fR <\fIinode-softlimit\fR>[kMGTPE]]
9        [\fB--inode-hardlimit|-I\fR <\fIinode-hardlimit\fR>[kMGTPE]] <\fIfilesystem\fR>
10 .br
11 .B lfs setquota \fB-t\fR {\fB-u|-g|-p\fR}
12        [\fB--block-grace|-b\fR <\fIblock-grace\fR>]
13        [\fB--inode-grace|-i\fR <\fIinode-grace\fR>] <\fIfilesystem\fR>
14 .br
15 .SH DESCRIPTION
16 .PP
17 .BR "lfs setquota " {\fB-u|-g|-p\fR}
18 .TP
19 Command sets the filesystem quotas for users, groups or projects respectively. \
20 Block limits unit is kilobyte (1024) by default and block limits are always \
21 kilobyte-grained (even if specified in bytes), block limits can be specified \
22 with a \
23 .BR k "," M "," G "," T "," P ", or " E \
24 suffixes which specify units of 2^10, 2^20, 2^30, 2^40, 2^50 and 2^60 \
25 accordingly.
26 .TP
27 .B -u|--user <\fIuname|uid\fR>
28 Set user quota for \fIuname\fR or \fIuid\fR.
29 .TP
30 .B -g|--group <\fIgname|gid\fR>
31 Set group quota for name \fIgname\fR or \fIgid\fR.
32 .TP
33 .B -p|--project <\fIprojid\fR>
34 Set project quota for \fIprojid\fR.
35 .TP
36 .B -b|--block-softlimit <\fIblock-softlimit\fR>
37 Specify block softlimit, zero means unlimited.
38 .TP
39 .B -B|--block-hardlimit <\fIblock-hardlimit\fR>
40 Specify block hardlimit, zero means unlimited. The block hardlimit should be \
41 greater than block softlimit when it's being specified.
42 .TP
43 .B -i|--inode-softlimit <\fIinode-softlimit\fR>
44 Specify inode softlimit, zero means unlimited.
45 .TP
46 .B -I|--inode-hardlimit <\fIinode-hardlimit\fR>
47 Specify inode hardlimit, zero means unlimited. The inode hardlimit should be \
48 greater than inode softlimit when it's being specified.
49 .PP
50 .BR "lfs setquota -t "
51 .TP
52 Command sets the filesystem quota grace time for users, groups, or projects. \
53 This is a global value that indicates the amount of time, in seconds, that the \
54 soft quota limit can be exceeded before users are prevented from creating \
55 new files or consuming more space.  This is intended to allow users to exceed \
56 the quota limit for a short time to complete their work, without having to \
57 grant each user a larger hard quota limit.  The soft quota limit is reset once \
58 the user, group, or project reduces their space usage below the soft quota \
59 limit. Grace time is specified in "XXwXXdXXhXXmXXs" format or as an integer \
60 seconds value.
61 .TP
62 .B -t
63 Set quota grace times.
64 .TP
65 .B -u
66 Set grace time for user.
67 .TP
68 .B -g
69 Set grace time for group.
70 .TP
71 .B -p
72 Set grace time for project.
73 .TP
74 .B -b|--block-grace <\fIblock-grace\fR>
75 Specify grace time for block quota.
76 .TP
77 .B -i|--inode-grace <\fIindoe-grace\fR>
78 Specify grace time for inode quota.
79 .SH EXAMPLES
80 .TP
81 .B $ lfs setquota -u bob --block-softlimit 2000000 --block-hardlimit 1000000 /mnt/lustre
82 Set quotas of user `bob': 1GB block quota hardlimit and 2 GB block quota softlimit
83 .TP
84 .B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
85 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 \
86 days for inode quotas
87 .SH SEE ALSO
88 .BR lfs (1)