1 .TH lfs 1 "2018-01-24" Lustre "user utilities"
3 lfs \- client utility for Lustre-specific file layout and other attributes
6 .B lfs changelog \fR[\fB--follow\fR] <\fImdtname\fR> [\fIstartrec \fR[\fIendrec\fR]]
8 .B lfs changelog_clear <\fImdtname\fR> <\fIid\fR> <\fIendrec\fR>
10 .B lfs check \fR<\fBmgts\fR|\fBmdts\fR|\fBosts\fR|\fBall\fR>
12 .B lfs data_version \fR[\fB-nrw\fR] \fB<\fIfilename\fR>
14 .B lfs df \fR[\fB-ihlv\fR] [\fB--pool\fR|\fB-p \fR<\fIfsname\fR>[.<\fIpool\fR>]] [\fIpath\fR]
16 .B lfs fid2path \fR[\fB--link \fR<\fIlinkno\fR>] <\fIfsname\fR|\fIrootpath\fR> <fid\fR> ...
18 .B lfs find \fR<\fIdirectory\fR|\fIfilename \fR...>
19 [[\fB!\fR] \fB--atime\fR|\fB-A\fR [\fB-+\fR]\fIn\fR]
20 [[\fB!\fR] \fB--ctime\fR|\fB-C\fR [\fB+-\fR]\fIn\fR]
21 [[\fB!\fR] \fB--mtime\fR|\fB-M\fR [\fB-+\fR]\fIn\fR]
22 [[\fB!\fR] \fB--component-count\fR|\fB--comp-count\fR [\fB+-\fR]\fIn\fR]
23 [[\fB!\fR] \fB--component-flags\fR|\fB--comp-flags\fR <[\fB^\fR]\fIflag\fB,\fR...>]
24 [[\fB!\fR] \fB--component-end\fR|\fB--comp-end\fR|\fB-E\fR [\fB+-\fR]\fIn\fR[\fBKMGTPE\fR]]
25 [[\fB!\fR] \fB--component-start\fR|\fB--comp-start\fR [\fB+-\fR]\fIn\fR[\fBKMGTPE\fR]]
26 [[\fB!\fR] \fB--mirror-count\fR|\fB-N\fR [\fB+-\fR]\fIn\fR]
27 [[\fB!\fR] \fB--mirror-state\fR <[^]\fIstate\fR>]
28 [[\fB!\fR] \fB--gid\fR|\fB-g\fR|\fB--group\fR|\fB-G\fR <\fIgname\fR>|<\fIgid\fR>]
29 [[\fB!\fR] \fB--layout\fR|\fB-L mdt\fR,\fBraid0\fR,\fBreleased\fR]
30 [\fB--maxdepth\fR|\fB-D\fI n\fR]
31 [[\fB!\fR] \fB--mdt\fR|\fB--mdt-index\fR|\fB-m\fR <\fIuuid\fR|\fIindex\fR,...>]
32 [[\fB!\fR] \fB--mdt-count\fR|\fB-T\fR [\fB+-\fR]\fIn\fR]
33 [[\fB!\fR] \fB--mdt-hash\fR|\fB-H \fI<hashtype>\fR]
34 [[\fB!\fR] \fB--name\fR|\fB-n \fI<pattern>\fR]
35 [[\fB!\fR] \fB--ost\fR|\fB-O\fR <\fIuuid\fR|\fIindex\fR,...>]
36 [[\fB!\fR] \fB--pool\fR <\fIpool\fR>]
37 [\fB--print\fR|\fB-P\fR] [\fB--print0\fR|\fB-0\fR]
38 [[\fB!\fR] \fB--projid\fR |<\fIprojid\fR>]
39 [[\fB!\fR] \fB--size|\fB-s\fR [\fB-+\fR]\fIn\fR[\fBKMGTPE\fR]]
40 [[\fB!\fR] \fB--stripe-count\fR|\fB-c\fR [\fB+-\fR]\fIn\fR]
41 [[\fB!\fR] \fB--stripe-index\fR|\fB-i\fR \fIn\fR,...]
42 [[\fB!\fR] \fB--stripe-size\fR|\fB-S\fR [\fB+-\fR]\fIn\fR[\fBKMG\fR]]
43 [[\fB!\fR] \fB--type\fR|\fB-t\fR {\fBbcdflps\fR}]
44 [[\fB!\fR] \fB--uid\fR|\fB-u\fR|\fB--user\fR|\fB-U
45 \fR<\fIuname\fR>|<\fIuid\fR>]
48 .RB [ --help | -h "] [" --instance | -i "] [" --fsname | -n "] ["
52 [\fB--component-count\fR|\fB--comp-count\fR]
53 [\fB--component-end\fR|\fB-E\fR[=[\fB+-\fR]\fIN\fR[\fBKMGTPE\fR]]
54 [\fB--component-flags\fR[=[\fB^\fR]\fIflag\fB,\fR...]]
55 [\fB--component-id\fR|\fB-I \fR[=\fIcomp_id\fR]]
56 [\fB--component-start\fR[=[\fB+-\fR]\fIN\fR[\fBKMGTPE\fR]]]
57 [\fB--directory\fR|\fB-d\fR]
58 [\fB--fid\fR|\fB-F\fR]
59 [\fB--generation\fR|\fB-g\fR]
60 [\fB--layout\fR|\fB-L\fR]
61 [\fB--mdt\fR|\fB--mdt-index\fR|\fB-m\fR]
62 [\fB--ost\fR|\fB-O\fR <\fIuuid\fR>]
63 [\fB--pool\fR|\fB-p\fR]
64 [\fB--quiet\fR|\fB-q\fR]
65 [\fB--recursive\fR|\fB-r\fR]
66 [\fB--raw\fR|\fB-R\fR]
67 [\fB--stripe-count\fR|\fB-c\fR]
68 [\fB--stripe-index\fR|\fB-i\fR]
69 [\fB--stripe-size\fR|\fB-S\fR]
70 [\fB--verbose\fR|\fB-v\fR]
71 [\fB--yaml\fR|\fB-y\fR]
72 <\fIdirname\fR|\fIfilename\fR> ...
74 .B lfs migrate \fR{\fB--mdt-index\fR|\fB-m\fR} <\fImdt_index\fR> \fIdirectory\fR
76 .B lfs migrate \fR[\fB--stripe-count\fR|\fB-c\fR \fR<\fIstripe_count\fR>]
77 [\fB--stripe-index\fR|\fB-i\fR \fR<\fIstart_ost_idx\fR>]
78 [\fB--stripe-size\fR|\fB-S\fR \fR<\fIstripe_size\fR>]
79 [\fB--pool\fR|\fB-p\fR \fR<\fIpool_name\fR>]
80 [\fB-o\fR|\fB--ost-list \fR<\fIost_indices\fR>]
81 [\fB--block\fR|\fB-b\fR]
82 [\fB--non-block\fR|\fB-n\fR] <\fIfile\fR|\fIdirectory\fR>
84 .B lfs migrate \fR<\fB--component-end\fR|\fB-E\fR \fIcomp_end1\fR>
85 [\fISTRIPE_OPTIONS\fR]
86 <\fB--component-end\fR|\fB-E\fR \fIcomp_end2\fR>
87 [\fISTRIPE_OPTIONS\fR]
90 .B lfs mkdir \fR[\fB-c\fR|\fB--count \fR<\fIstripe_count\fR>]
91 [\fB-i\fR|\fB--index \fR<\fImdt_idx\fR>]
92 [\fB-h\fR|\fB--hash-type \fR<\fIhash_name\fR>]
93 [\fB-m\fR|\fB--mode \fR<\fImode\fR>]
94 [\fB-D\fR|\fB--default\fR] \fIdirectory\fR
96 .B lfs osts \fR[<\fIpath\fR>]
98 .B lfs mdts \fR[<\fIpath\fR>]
100 .B lfs path2fid \fR[\fB--parents\fR] <\fIpath\fR> ...
102 .B lfs pool_list \fR<\fIfilesystem\fR>[\fB.\fR<\fIpool\fR>] | <\fIpathname\fR>
104 .B lfs quota \fR[\fB-qv\fR] [\fB-o \fIobd_uuid\fR|\fB-I \fIost_idx\fR|\fB-i \fImdt_idx\fR]
105 [\fB-u <\fIuname\fR|\fIuid\fR>|\fB-g <\fIgname\fR|\fIgid\fR>]
106 [\fB-p <\fIprojid\fR>] <\fIfilesystem\fR>
108 .B lfs quota -t \fR<\fB-u\fR|\fB-g\fR|\fB-p\fR> <\fIfilesystem\fR>
110 .B lfs quotacheck \fR[\fB-ug\fR] <\fIfilesystem\fR>
112 .B lfs quota \fR<\fB-U\fR|\fB-G\fR|\fB-P\fR> <\fIfilesystem\fR>
114 .B lfs quotaon \fR[\fB-ugf\fR] <\fIfilesystem\fR>
116 .B lfs quotaoff \fR[\fB-ug\fR] <\fIfilesystem\fR>
118 .B lfs setstripe \fR[\fB--stripe-size\fR|\fB-S <\fIsize\fR>] [\fB--stripe-count\fR|-c <\fIcount\fR>]
119 [\fB--stripe-index\fR|\fB-i <\fIstart_ost_index\fR>] [\fB--pool\fR|\fB-p \fR<\fIpoolname\fR>]
120 [\fB--ost-list\fR|\fB-o <\fIost_indices\fR>] <\fIdirectory\fR|\fIfilename\fR>
122 .B lfs setstripe -d \fR<\fIdir\fR>
124 .B lfs setstripe --component-end\fR|\fB-E <\fIend1> [\fISTRIPE_OPTIONS\fR]
125 [\fB--component-end\fR|\fB-E \fR<\fIend2\fR> [\fISTRIPE_OPTIONS\fR]]
128 .B lfs setstripe --component-add \fB-E\fR <\fIend1> [\fISTRIPE_OPTIONS]
129 [\fB--component-end\fR|\fB-E \fR<\fIend2\fR> [\fISTRIPE_OPTIONS\fR]]
132 .B lfs setstripe --component-del \fR{\fB--component-id\fR|\fB-I \fR<\fIid\fR> |
133 \fB--component-flags \fR<\fIflags\fR>}
136 .B lfs setstripe --yaml=\fR<\fIyaml_template_file\fR> <\fIfilename\fR>
140 .B lfs --list-commands
145 can be used to create a new file with a specific striping pattern, determine
146 the default striping pattern, gather the extended attributes (object numbers
147 and location) for a specific file. It can be invoked interactively without any
148 arguments or in a non-interactive mode with one of the arguments supported.
150 A number of sub-commands supported by lfs are listed below. Other commands
151 are described in separate man pages of the form
158 Show the metadata changes on an MDT. Start and end points are optional. The --follow option will block on new changes; this option is only valid when run direclty on the MDT node.
161 Indicate that changelog records previous to <endrec> are no longer of
162 interest to a particular consumer <id>, potentially allowing the MDT to
163 free up disk space. An <endrec> of 0 indicates the current last record.
164 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
166 .B check <mgts|mdts|osts|all>
167 Display the status of the MGTs, MDTs or OSTs (as specified in the command) or
168 all the servers (MGTs, MDTs and OSTs).
170 .B data_version [-nrw] <filename>
171 Display the current version of file data. If -n is specified, the data version
172 is read without taking a lock. As a consequence, the data version could be
173 outdated if there are dirty caches on filesystem clients, but this option will
174 not force data flushes and has less of an impact on the filesystem. If -r is
175 specified, the data version is read after dirty pages on clients are flushed. If
176 -w is specified, the data version is read after all caching pages on clients are
179 Even with -r or -w, race conditions are possible and the data version should be
180 checked before and after an operation to be confident the data did not change
183 The data version is the sum of the last committed transaction numbers of all
184 data objects of a file. It is used by HSM policy engines for verifying that file
185 data has not been changed during an archive operation or before a release
186 operation, and by OST migration, primarily for verifying that file data has not
187 been changed during a data copy, when done in non-blocking mode.
191 List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
192 that is located on a lustre mounted file system then only the OSTs belonging
193 to that filesystem are displayed.
196 .RI { filesystem }[ .poolname "] | {" pathname }
202 .IR filesystem.pool .
204 .B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g|-p <uname>|<uid>|<gname>|<gid>|<projid>] <filesystem>
205 To display disk usage and limits, either for the full filesystem, or for objects on a specific obd. A user or group name or an ID can be specified. If user group and project are omitted quotas for current uid/gid/projid are shown. -v provides more verbose (with per-obd statistics) output. -q disables printing of additional descriptions (including column titles).
207 .B quota -t <-u|-g|-p> <filesystem>
208 To display block and inode grace times for user (-u) or group (-g) or project (-p) quotas
210 .B quotacheck [-ugf] <filesystem> (deprecated as of 2.4.0)
211 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). Not useful anymore with servers >= 2.4.0 since space accounting is always turned on.
213 .B quotaon [-ugf] <filesystem> (deprecated as of 2.4.0)
214 To turn filesystem quotas on. Options specify quota for users (-u) groups (-g) and force (-f). Not used anymore in lustre 2.4.0 where quota enforcement must be enabled via conf_param (e.g. lctl conf_param ${FSNAME}.quota.<ost|mdt>=<u|g|ug>)
216 .B quotaoff [-ugf] <filesystem> (deprecated as of 2.4.0)
217 To turn filesystem quotas off. Options specify quota for users (-u) groups (-g) and force (-f). Not used anymore in lustre 2.4.0 where quota enforcement can be turned off (for inode or block) by running the following command on the MGS: lctl conf_param ${FSNAME}.quota.<ost|mdt>=""
219 .B swap_layouts <filename1> <filename2>
220 Swap the data (layout and OST objects) of two regular files. The
221 two files have to be in the same filesystem, owned by the same user,
222 reside on the same MDT and writable by the user.
224 Swapping the layout of two directories is not permitted.
227 lfs mkdir is documented in the man page: lfs-mkdir(1). NOTE:
229 is an alias of the command
233 lfs mv is deprecated, use lfs
241 See lfs-setstripe(1).
244 Output the build version of the lfs utility. Use "lctl lustre_build_version" to get the version of the Lustre kernel modules
247 Output a list of the commands supported by the lfs utility
250 Provides brief help on the various arguments
253 Quit the interactive lfs session
257 Check the status of all servers (MGT, MDT, OST)
265 .B $ lfs quota -u bob /mnt/lustre
266 List quotas of user `bob'
268 .B $ lfs quota -U /mnt/lustre
269 List user quotas of system default setting
271 .B $ lfs quota -t -u /mnt/lustre
272 Show grace times for user quotas on /mnt/lustre
274 .B $ lfs quotachown -i /mnt/lustre
275 Change file owner and group
277 .B $ lfs quotacheck -ug /mnt/lustre
278 Quotacheck for user and group - will turn on quotas after making the check.
280 .B $ lfs quotaon -ug /mnt/lustre
281 Turn quotas of user and group on
283 .B $ lfs quotaoff -ug /mnt/lustre
284 Turn quotas of user and group off
286 The usage of \fBlfs find\fR, \fBlfs getstripe\fR, \fBlfs hsm_*\fR,
287 \fBlfs setstripe\fR, \fBlfs migrate\fR, \fBlfs getdirstripe\fR,
288 \fBlfs setdirstripe\fR, \fBlfs mkdir\fR, and \fBlfs project\fR are explained
289 in separate man pages.
291 The lfs command is part of the Lustre filesystem.
295 .BR lfs-fid2path (1),
297 .BR lfs-getdirstripe (1),
299 .BR lfs-getstripe (1),
305 .BR lfs-path2fid (1),
306 .BR lfs-setdirstripe (1),
307 .BR lfs-setquota (1),
308 .BR lfs-setstripe (1),