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>]
15         \fB[[!] --size|-S [-+]N[kMGTPE]] [--type |-t {bcdflpsD}]
16         \fB<dirname|filename>\fR
17 .br
18 .B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v] 
19               \fB[--recursive|-r] <dirname|filename>\fR
20 .br
21 .B lfs setstripe [--size|-s stripe-size] [--count|-c stripe-cnt]
22               \fB[--index|-i start-ost] <filename|dirname>\fR
23 .br
24 .B lfs setstripe -d <dirname>
25 .br
26 .B lfs quotachown [-i] <filesystem>
27 .br
28 .B lfs quotacheck [-ug] <filesystem>
29 .br
30 .B lfs quotaon [-ugf] <filesystem>
31 .br
32 .B lfs quotaoff [-ug] <filesystem>
33 .br
34 .B lfs setquota [-u|-g] <username|groupname> <block-softlimit>
35              \fB<block-hardlimit> <inode-softlimit> <inode-hardlimit>
36              \fB<filesystem>\fR
37 .br
38 .B lfs setquota -t [-u|-g] <block-grace> <inode-grace> <filesystem>
39 .br
40 .B lfs quota [-o obd_uuid] [-u|-g] <username|groupname> <filesystem>
41 .br
42 .B lfs quota -t [-u|-g] <filesystem>
43 .br
44 .B lfs help
46 .B lfs
47 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. 
49 The various options supported by lctl are listed and explained below:
50 .TP
51 .B check 
52 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
53 .TP
54 .B df
55 Report filesystem disk space usage or inodes usage of each MDT/OST.
56 .TP
57 .B find 
58 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), \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)). 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.
59 .TP
60 .B getstripe
61 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).
62 .TP
63 .B osts 
64 List all the OSTs for the filesystem
65 .TP
66 .B setstripe [--size stripe-size] [--count stripe-cnt] [--index start-ost]
67 To create a new file, or set the directory default, with the specified striping parameters.  The
68 .I stripe-count
69 is the number of OSTs to stripe a file over. A
70 .I stripe-count
71 of 0 means to use the filesystem-wide default stripe count (default 1), and a
72 .I stripe-count
73 of -1 means to stripe over all available OSTs.  The
74 .I stripe-size
75 is the number of bytes to store on each OST before moving to the next OST.  A
76 .I stripe-size
77 of 0 means to use the filesystem-wide default stripe size (default 1MB).  The
78 .I start-ost
79 is the OST index (starting at 0) on which to start striping for this file.  A
80 .I start-ost
81 of -1 allows the MDS to specify the starting index and it is strongly
82 recommended that the starting OST not be given, as this allows space and
83 load balancing to be done by the MDS as needed.
84 .TP
85 .B lfs setstripe -d
86 Delete the default striping on the specified directory.
87 .TP
88 .B quotachown
89 To change files' owner and group on OSTs of the specified filesystem
90 .TP
91 .B quotacheck [-ugf] <filesystem>
92 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)
93 .TP
94 .B quotaon [-ugf] <filesystem>
95 To turn filesystem quotas on. Options specify quota for users (-u) groups (-g) and force (-f)
96 .TP
97 .B quotaoff [-ugf] <filesystem>
98 To turn filesystem quotas off.  Options specify quota for users (-u) groups (-g) and force (-f)
99 .TP
100 .B setquota  [-u|-g] <name> <block-softlimit> <block-hardlimit> <inode-softlimit> <inode-hardlimit> <filesystem>
101 To set filesystem quotas for users or groups. Limits are specific as blocks and inodes, see EXAMPLES
102 .TP
103 .B setquota -t [-u|-g] <block-grace> <inode-grace> <filesystem>
104 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
105 .TP
106 .B quota [-o obd_uuid] [-u|-g] <username|groupname> <filesystem>
107 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.
108 .TP
109 .B quota -t [-u|-g] <filesystem>
110 To display block and inode grace times for user (-u) or group (-g) quotas
111 .TP
112 .B help 
113 Provides brief help on the various arguments
114 .TP
115 .B exit/quit 
116 Quit the interactive lfs session
118 .TP
119 .B $ lfs setstripe -s 128k -c 2 /mnt/lustre/file1
120 This creats a file striped on two OSTs with 128kB on each stripe.
121 .TP
122 .B $ lfs setstripe -d /mnt/lustre/dir
123 This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein.
124 .TP
125 .B $ lfs getstripe -v /mnt/lustre/file1
126 Lists the detailed object allocation of a given file
127 .TP
128 .B $ lfs find /mnt/lustre
129 Efficiently lists all files in a given directory and its subdirectories
130 .TP
131 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
132 Recursively list all regular files in given directory more than 30 days old
133 .TP
134 .B $ lfs find --obd OST2-UUID /mnt/lustre/
135 Recursively list all files in a given directory that have objects on OST2-UUID.
136 .tP
137 .B $ lfs check servers 
138 Check the status of all servers (MDT, OST)
139 .TP
140 .B $ lfs osts
141 List all the OSTs
142 .TP
143 .B $ lfs df -h 
144 Lists space usage per OST and MDT in human readable format.
145 .TP
146 .B $ lfs df -i 
147 Lists inode usage per OST and MDT
148 .TP
149 .B $ lfs quotachown -i /mnt/lustre
150 Change file owner and group
151 .TP
152 .B $ lfs quotacheck -ug /mnt/lustre
153 Quotacheck for user and group - will turn on quotas after making the check.
154 .TP
155 .B $ lfs quotaon -ug /mnt/lustre
156 Turn quotas of user and group on
157 .TP
158 .B $ lfs quotaoff -ug /mnt/lustre
159 Turn quotas of user and group off
160 .TP
161 .B $ lfs setquota -u bob 0 1000000 0 10000 /mnt/lustre
162 Set quotas of user `bob': 1GB block quota and 10,000 file quota
163 .TP
164 .B $ lfs setquota -t -u 1000 1w4d /mnt/lustre
165 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
166 .TP
167 .B $ lfs quota -u bob /mnt/lustre
168 List quotas of user `bob'
169 .TP
170 .B $ lfs quota -t -u /mnt/lustre
171 Show grace times for user quotas on /mnt/lustre
172 .SH BUGS
173 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
174 Report bugs using http://bugzilla.lustre.org.
176 The lfs command is part of the Lustre filesystem.  Contact info@clusterfs.com.
178 .BR lctl (8),
179 .BR lustre (7)