Whamcloud - gitweb
[fs/lustre-release.git] / lustre / doc / lfs.1
1 .TH lfs 1 "2008 Mar 15" Lustre "user utilities"
3 lfs \- Lustre utility to create a file with specific striping pattern, find the striping pattern of exiting files
5 .br
6 .B lfs
7 .br
8 .B lfs check <mds|osts|servers>
9 .br
10 .B lfs df [-i] [-h] [path]
11 .br
12 .B lfs find [[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N]
13         \fB[[!] --ctime|-C [-+]N] [--maxdepth|-D N] [--name|-n pattern]
14         \fB[--print|-p] \fB[--print0|-P] [--obd|-O <uuid[s]>]
15         \fB[[!] --size|-S [-+]N[kMGTPE]] [--type |-t {bcdflpsD}]
16         \fB[[!] --gid|-g N] [[!] --group|-G <name>]
17         \fB[[!] --uid|-u N] [[!] --user|-U <name>]
18         \fB<dirname|filename>\fR
19 .br
20 .B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v] 
21               \fB[--recursive|-r] <dirname|filename>\fR
22 .br
23 .B lfs setstripe [--size|-s stripe-size] [--count|-c stripe-cnt]
24               \fB[--index|-i start-ost] <filename|dirname>\fR
25 .br
26 .B lfs setstripe -d <dirname>
27 .br
28 .B lfs quotachown [-i] <filesystem>
29 .br
30 .B lfs quotacheck [-ug] <filesystem>
31 .br
32 .B lfs quotaon [-ugf] <filesystem>
33 .br
34 .B lfs quotaoff [-ug] <filesystem>
35 .br
36 .B lfs setquota [-u|-g] <username|groupname> <block-softlimit>
37              \fB<block-hardlimit> <inode-softlimit> <inode-hardlimit>
38              \fB<filesystem>\fR
39 .br
40 .B lfs setquota -t [-u|-g] <block-grace> <inode-grace> <filesystem>
41 .br
42 .B lfs quota [-o obd_uuid] [-u|-g] <username|groupname> <filesystem>
43 .br
44 .B lfs quota -t [-u|-g] <filesystem>
45 .br
46 .B lfs help
48 .B lfs
49 can be used to create a new file with a specific striping pattern, determine the default striping pattern, gather the extended attributes (object numbers and location) for a specific file. It can be invoked interactively without any arguments or in a non-interactive mode with one of the arguements supported. 
51 The various options supported by lctl are listed and explained below:
52 .TP
53 .B check 
54 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
55 .TP
56 .B df
57 Report filesystem disk space usage or inodes usage of each MDT/OST.
58 .TP
59 .B find 
60 To search the directory tree rooted at the given dir/file name for the files that match the given parameters: \fB--atime\fR (file was last accessed N*24 hours ago), \fB--ctime\fR (file's status was last changed N*24 hours ago), \fB--mtime\fR (file's data was last modified N*24 hours ago), \fB--obd\fR (file has an object on a specific OST or OSTs), \fB--size\fR (file has size in bytes, or \fBk\fRilo-, \fBM\fRega-, \fBG\fRiga-, \fBT\fRera-, \fBP\fReta-, or \fBE\fRxabytes if a suffix is given), \fB--type\fR (file has the type: \fBb\fRlock, \fBc\fRharacter, \fBd\fRirectory, \fBp\fRipe, \fBf\fRile, sym\fBl\fRink, \fBs\fRocket, or \fBD\fRoor (Solaris)), \fB--uid\fR (file has specific numeric user ID), \fB--user\fR (file owned by specific user, numeric user ID allowed), \fB--gid\fR (file has specific group ID), \fB--group\fR (file belongs to specific group, numeric group ID allowed). The option \fB--maxdepth\fR allows find to decend at most N levels of directory tree. The options \fB--print\fR and \fB--print0\fR print full file name, followed by a newline or NUL character correspondingly.  Using \fB!\fR before an option negates its meaning (\fIfiles NOT matching the parameter\fR).  Using \fB+\fR before a numeric value means \fIfiles with the parameter OR MORE\fR, while \fB-\fR before a numeric value means \fIfiles with the parameter OR LESS\fR.
61 .TP
62 .B getstripe
63 To list the striping info for a given filename or files in a directory, optionally recursively, for all files in a directory tree: \fB--quiet\fR (don't print object IDs), \fB--verbose\fR (print striping parameters), \fB--recursive\fR (recurse into subdirectories).
64 .TP
65 .B osts 
66 List all the OSTs for the filesystem
67 .TP
68 .B setstripe [--size stripe-size] [--count stripe-cnt] [--index start-ost]
69 To create a new file, or set the directory default, with the specified striping parameters.  The
70 .I stripe-count
71 is the number of OSTs to stripe a file over. A
72 .I stripe-count
73 of 0 means to use the filesystem-wide default stripe count (default 1), and a
74 .I stripe-count
75 of -1 means to stripe over all available OSTs.  The
76 .I stripe-size
77 is the number of bytes to store on each OST before moving to the next OST.  A
78 .I stripe-size
79 of 0 means to use the filesystem-wide default stripe size (default 1MB).  The
80 .I start-ost
81 is the OST index (starting at 0) on which to start striping for this file.  A
82 .I start-ost
83 of -1 allows the MDS to specify the starting index and it is strongly
84 recommended that the starting OST not be given, as this allows space and
85 load balancing to be done by the MDS as needed.
86 .TP
87 .B lfs setstripe -d
88 Delete the default striping on the specified directory.
89 .TP
90 .B quotachown
91 To change files' owner and group on OSTs of the specified filesystem
92 .TP
93 .B quotacheck [-ugf] <filesystem>
94 To scan the specified filesystem for disk usage, and create or update quota files. Options specify quota for users (-u) groups (-g) and force (-f)
95 .TP
96 .B quotaon [-ugf] <filesystem>
97 To turn filesystem quotas on. Options specify quota for users (-u) groups (-g) and force (-f)
98 .TP
99 .B quotaoff [-ugf] <filesystem>
100 To turn filesystem quotas off.  Options specify quota for users (-u) groups (-g) and force (-f)
101 .TP
102 .B setquota  [-u|-g] <name> <block-softlimit> <block-hardlimit> <inode-softlimit> <inode-hardlimit> <filesystem>
103 To set filesystem quotas for users or groups. Limits are specific as blocks and inodes, see EXAMPLES
104 .TP
105 .B setquota -t [-u|-g] <block-grace> <inode-grace> <filesystem>
106 To set filesystem quota grace times for users or groups. Grace time is specified in "XXwXXdXXhXXmXXs" format or as an integer seconds value, see EXAMPLES
107 .TP
108 .B quota [-o obd_uuid] [-u|-g] <username|groupname> <filesystem>
109 To display disk usage and limits, either for the full filesystem, or for objects on a specific obd. A user or group name must be specified.
110 .TP
111 .B quota -t [-u|-g] <filesystem>
112 To display block and inode grace times for user (-u) or group (-g) quotas
113 .TP
114 .B help 
115 Provides brief help on the various arguments
116 .TP
117 .B exit/quit 
118 Quit the interactive lfs session
120 .TP
121 .B $ lfs setstripe -s 128k -c 2 /mnt/lustre/file1
122 This creats a file striped on two OSTs with 128kB on each stripe.
123 .TP
124 .B $ lfs setstripe -d /mnt/lustre/dir
125 This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein.
126 .TP
127 .B $ lfs getstripe -v /mnt/lustre/file1
128 Lists the detailed object allocation of a given file
129 .TP
130 .B $ lfs find /mnt/lustre
131 Efficiently lists all files in a given directory and its subdirectories
132 .TP
133 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
134 Recursively list all regular files in given directory more than 30 days old
135 .TP
136 .B $ lfs find --obd OST2-UUID /mnt/lustre/
137 Recursively list all files in a given directory that have objects on OST2-UUID.
138 .tP
139 .B $ lfs check servers 
140 Check the status of all servers (MDT, OST)
141 .TP
142 .B $ lfs osts
143 List all the OSTs
144 .TP
145 .B $ lfs df -h 
146 Lists space usage per OST and MDT in human readable format.
147 .TP
148 .B $ lfs df -i 
149 Lists inode usage per OST and MDT
150 .TP
151 .B $ lfs quotachown -i /mnt/lustre
152 Change file owner and group
153 .TP
154 .B $ lfs quotacheck -ug /mnt/lustre
155 Quotacheck for user and group - will turn on quotas after making the check.
156 .TP
157 .B $ lfs quotaon -ug /mnt/lustre
158 Turn quotas of user and group on
159 .TP
160 .B $ lfs quotaoff -ug /mnt/lustre
161 Turn quotas of user and group off
162 .TP
163 .B $ lfs setquota -u bob 0 1000000 0 10000 /mnt/lustre
164 Set quotas of user `bob': 1GB block quota and 10,000 file quota
165 .TP
166 .B $ lfs setquota -t -u 1000 1w4d /mnt/lustre
167 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
168 .TP
169 .B $ lfs quota -u bob /mnt/lustre
170 List quotas of user `bob'
171 .TP
172 .B $ lfs quota -t -u /mnt/lustre
173 Show grace times for user quotas on /mnt/lustre
174 .SH BUGS
175 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
176 Report bugs using http://bugzilla.lustre.org.
178 The lfs command is part of the Lustre filesystem.  Contact info@clusterfs.com.
180 .BR lctl (8),
181 .BR lustre (7)