Whamcloud - gitweb
LU-4315 doc: add separate lctl-list_param 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 .TP
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 .TP
15 .B lfs setquota {\fB-u|--user|-g|--group|-p|--projid\fR} <\fIuname|uid|gname|gid|projid\fR>
16        [\fB--default|-d\fR] <\fIfilesystem\fR>
17 .TP
18 .B lfs setquota {\fB-U|--default-usr|-G|--default-grp|-P|--default-prj\fR}
19        [\fB--block-softlimit|-b\fR <\fIblock-softlimit\fR>[kMGTPE]]
20        [\fB--block-hardlimit|-B\fR <\fIblock-hardlimit\fR>[kMGTPE]]
21        [\fB--inode-softlimit|-i\fR <\fIinode-softlimit\fR>[kMGTPE]]
22        [\fB--inode-hardlimit|-I\fR <\fIinode-hardlimit\fR>[kMGTPE]] <\fIfilesystem\fR>
23 .TP
24 .SH DESCRIPTION
25 .PP
26 .BR "lfs setquota " {\fB-u|-g|-p\fR}
27 .TP
28 Command sets the filesystem quotas for users, groups or projects respectively. \
29 Block limits unit is kilobyte (1024) by default and block limits are always \
30 kilobyte-grained (even if specified in bytes), block limits can be specified \
31 with a \
32 .BR k "," M "," G "," T "," P ", or " E \
33 suffixes which specify units of 2^10, 2^20, 2^30, 2^40, 2^50 and 2^60 \
34 accordingly.
35 .TP
36 .B -u|--user <\fIuname|uid\fR>
37 Set user quota for \fIuname\fR or \fIuid\fR.
38 .TP
39 .B -g|--group <\fIgname|gid\fR>
40 Set group quota for name \fIgname\fR or \fIgid\fR.
41 .TP
42 .B -p|--project <\fIprojid\fR>
43 Set project quota for \fIprojid\fR.
44 .TP
45 .B -d|--default
46 Set user/group/project to use the default quota limits.
47 .TP
48 .B -b|--block-softlimit <\fIblock-softlimit\fR>
49 Specify block softlimit, zero means unlimited.
50 .TP
51 .B -B|--block-hardlimit <\fIblock-hardlimit\fR>
52 Specify block hardlimit, zero means unlimited. The block hardlimit should be \
53 greater than block softlimit when it's being specified.
54 .TP
55 .B -i|--inode-softlimit <\fIinode-softlimit\fR>
56 Specify inode softlimit, zero means unlimited.
57 .TP
58 .B -I|--inode-hardlimit <\fIinode-hardlimit\fR>
59 Specify inode hardlimit, zero means unlimited. The inode hardlimit should be \
60 greater than inode softlimit when it's being specified.
61 .PP
62 .BR "lfs setquota -t "
63 .TP
64 Command sets the filesystem quota grace time for users, groups, or projects. \
65 This is a global value that indicates the amount of time, in seconds, that the \
66 soft quota limit can be exceeded before users are prevented from creating \
67 new files or consuming more space.  This is intended to allow users to exceed \
68 the quota limit for a short time to complete their work, without having to \
69 grant each user a larger hard quota limit.  The soft quota limit is reset once \
70 the user, group, or project reduces their space usage below the soft quota \
71 limit. Grace time is specified in "XXwXXdXXhXXmXXs" format or as an integer \
72 seconds value, and the maximum is 2^48 - 1 seconds.
73 .TP
74 .B -t
75 Set quota grace times.
76 .TP
77 .B -u
78 Set grace time for user.
79 .TP
80 .B -g
81 Set grace time for group.
82 .TP
83 .B -p
84 Set grace time for project.
85 .TP
86 .B -b|--block-grace <\fIblock-grace\fR>
87 Specify grace time for block quota.
88 .TP
89 .B -i|--inode-grace <\fIindoe-grace\fR>
90 Specify grace time for inode quota.
91 .PP
92 .BR "lfs setquota " {\fB-U|--default-usr|-G|--default-grp|-P|--default-prj\fR}
93 .TP
94 Command sets the filesystem default limits for user,group,project quotas, \
95 if set, users/groups/projects without specific quota setting will use \
96 default quota limits automatically.
97 .TP
98 .B -U|--default-usr
99 Set default user quota limit.
100 .TP
101 .B -G|--default-grp
102 Set default group quota limit.
103 .TP
104 .B -P|--default-prj
105 Set default project quota limit.
106 .TP
107 .PP
108 .SH EXAMPLES
109 .TP
110 .B $ lfs setquota -u bob --block-softlimit 2G --block-hardlimit 1G /mnt/lustre
111 Set quotas of user `bob': 1GB block hardlimit and 2 GB block softlimit
112 .TP
113 .B $ lfs setquota -u bob -d /mnt/lustre
114 Set quotas of user `bob' to use default quota setting
115 .TP
116 .B $ lfs setquota -U --block-softlimit 1G --block-hardlimit 2G /mnt/lustre
117 Set system default user quota: 1 GB block softlimit and 2 GB block hardlimit
118 .TP
119 .B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
120 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 \
121 days for inode quotas
122 .SH SEE ALSO
123 .BR lfs (1)