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--extension-size\fR|\fB-ext-size\fR|\fB-z\fR [\fB+-\fR]\fIn\fR[\fBKMG\fR]]
43 [[\fB!\fR] \fB--stripe-size\fR|\fB-S\fR [\fB+-\fR]\fIn\fR[\fBKMG\fR]]
44 [[\fB!\fR] \fB--type\fR|\fB-t\fR {\fBbcdflps\fR}]
45 [[\fB!\fR] \fB--uid\fR|\fB-u\fR|\fB--user\fR|\fB-U
46 \fR<\fIuname\fR>|<\fIuid\fR>]
49 .RB [ --help | -h "] [" --instance | -i "] [" --fsname | -n "] ["
53 [\fB--component-count\fR|\fB--comp-count\fR]
54 [\fB--component-end\fR|\fB-E\fR[=[\fB+-\fR]\fIN\fR[\fBKMGTPE\fR]]
55 [\fB--component-flags\fR[=[\fB^\fR]\fIflag\fB,\fR...]]
56 [\fB--component-id\fR|\fB-I \fR[=\fIcomp_id\fR]]
57 [\fB--component-start\fR[=[\fB+-\fR]\fIN\fR[\fBKMGTPE\fR]]]
58 [\fB--directory\fR|\fB-d\fR]
59 [\fB--fid\fR|\fB-F\fR]
60 [\fB--generation\fR|\fB-g\fR]
61 [\fB--layout\fR|\fB-L\fR]
62 [\fB--mdt\fR|\fB--mdt-index\fR|\fB-m\fR]
63 [\fB--ost\fR|\fB-O\fR <\fIuuid\fR>]
64 [\fB--pool\fR|\fB-p\fR]
65 [\fB--quiet\fR|\fB-q\fR]
66 [\fB--recursive\fR|\fB-r\fR]
67 [\fB--raw\fR|\fB-R\fR]
68 [\fB--stripe-count\fR|\fB-c\fR]
69 [\fB--stripe-index\fR|\fB-i\fR]
70 [\fB--stripe-size\fR|\fB-S\fR]
71 [\fB--extension-size\fR|\fB--ext-size\fR|\fB-z\fR]
72 [\fB--verbose\fR|\fB-v\fR]
73 [\fB--yaml\fR|\fB-y\fR]
74 <\fIdirname\fR|\fIfilename\fR> ...
76 .B lfs migrate \fR{\fB--mdt-index\fR|\fB-m\fR} <\fImdt_index\fR> \fIdirectory\fR
78 .B lfs migrate \fR[\fB--stripe-count\fR|\fB-c\fR \fR<\fIstripe_count\fR>]
79 [\fB--stripe-index\fR|\fB-i\fR \fR<\fIstart_ost_idx\fR>]
80 [\fB--stripe-size\fR|\fB-S\fR \fR<\fIstripe_size\fR>]
81 [\fB--pool\fR|\fB-p\fR \fR<\fIpool_name\fR>]
82 [\fB-o\fR|\fB--ost-list \fR<\fIost_indices\fR>]
83 [\fB--block\fR|\fB-b\fR]
84 [\fB--non-block\fR|\fB-n\fR] <\fIfile\fR|\fIdirectory\fR>
86 .B lfs migrate \fR<\fB--component-end\fR|\fB-E\fR \fIcomp_end1\fR>
87 [\fISTRIPE_OPTIONS\fR]
88 <\fB--component-end\fR|\fB-E\fR \fIcomp_end2\fR>
89 [\fISTRIPE_OPTIONS\fR]
92 .B lfs mkdir \fR[\fB-c\fR|\fB--count \fR<\fIstripe_count\fR>]
93 [\fB-i\fR|\fB--index \fR<\fImdt_idx\fR>]
94 [\fB-h\fR|\fB--hash-type \fR<\fIhash_name\fR>]
95 [\fB-m\fR|\fB--mode \fR<\fImode\fR>]
96 [\fB-D\fR|\fB--default\fR] \fIdirectory\fR
98 .B lfs osts \fR[<\fIpath\fR>]
100 .B lfs mdts \fR[<\fIpath\fR>]
102 .B lfs path2fid \fR[\fB--parents\fR] <\fIpath\fR> ...
104 .B lfs pool_list \fR<\fIfilesystem\fR>[\fB.\fR<\fIpool\fR>] | <\fIpathname\fR>
106 .B lfs setstripe \fR[\fB--stripe-size\fR|\fB-S <\fIsize\fR>] [\fB--stripe-count\fR|-c <\fIcount\fR>]
107 [\fB--stripe-index\fR|\fB-i <\fIstart_ost_index\fR>] [\fB--pool\fR|\fB-p \fR<\fIpoolname\fR>]
108 [\fB--extension-size\fR|\fB--ext-size\fR|\fB-z <\fIext_size\fR>]
109 [\fB--ost-list\fR|\fB-o <\fIost_indices\fR>] <\fIdirectory\fR|\fIfilename\fR>
111 .B lfs setstripe -d \fR<\fIdir\fR>
113 .B lfs setstripe --component-end\fR|\fB-E <\fIend1> [\fISTRIPE_OPTIONS\fR]
114 [\fB--component-end\fR|\fB-E \fR<\fIend2\fR> [\fISTRIPE_OPTIONS\fR]]
117 .B lfs setstripe --component-add \fB-E\fR <\fIend1> [\fISTRIPE_OPTIONS]
118 [\fB--component-end\fR|\fB-E \fR<\fIend2\fR> [\fISTRIPE_OPTIONS\fR]]
121 .B lfs setstripe --component-del \fR{\fB--component-id\fR|\fB-I \fR<\fIid\fR> |
122 \fB--component-flags \fR<\fIflags\fR>}
125 .B lfs setstripe --yaml=\fR<\fIyaml_template_file\fR> <\fIfilename\fR>
129 .B lfs --list-commands
134 can be used to create a new file with a specific striping pattern, determine
135 the default striping pattern, gather the extended attributes (object numbers
136 and location) for a specific file. It can be invoked interactively without any
137 arguments or in a non-interactive mode with one of the arguments supported.
139 A number of sub-commands supported by lfs are listed below. Other commands
140 are described in separate man pages of the form
147 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.
150 Indicate that changelog records previous to <endrec> are no longer of
151 interest to a particular consumer <id>, potentially allowing the MDT to
152 free up disk space. An <endrec> of 0 indicates the current last record.
153 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
155 .B check <mgts|mdts|osts|all>
156 Display the status of the MGTs, MDTs or OSTs (as specified in the command) or
157 all the servers (MGTs, MDTs and OSTs).
159 .B data_version [-nrw] <filename>
160 Display the current version of file data. If -n is specified, the data version
161 is read without taking a lock. As a consequence, the data version could be
162 outdated if there are dirty caches on filesystem clients, but this option will
163 not force data flushes and has less of an impact on the filesystem. If -r is
164 specified, the data version is read after dirty pages on clients are flushed. If
165 -w is specified, the data version is read after all caching pages on clients are
168 Even with -r or -w, race conditions are possible and the data version should be
169 checked before and after an operation to be confident the data did not change
172 The data version is the sum of the last committed transaction numbers of all
173 data objects of a file. It is used by HSM policy engines for verifying that file
174 data has not been changed during an archive operation or before a release
175 operation, and by OST migration, primarily for verifying that file data has not
176 been changed during a data copy, when done in non-blocking mode.
180 List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
181 that is located on a lustre mounted file system then only the OSTs belonging
182 to that filesystem are displayed.
185 .RI { filesystem }[ .poolname "] | {" pathname }
191 .IR filesystem.pool .
193 .B swap_layouts <filename1> <filename2>
194 Swap the data (layout and OST objects) of two regular files. The
195 two files have to be in the same filesystem, owned by the same user,
196 reside on the same MDT and writable by the user.
198 Swapping the layout of two directories is not permitted.
201 lfs mkdir is documented in the man page: lfs-mkdir(1). NOTE:
203 is an alias of the command
207 lfs mv is deprecated, use lfs
215 See lfs-setstripe(1).
218 Output the build version of the lfs utility. Use "lctl lustre_build_version" to get the version of the Lustre kernel modules
221 Output a list of the commands supported by the lfs utility
224 Provides brief help on the various arguments
227 Quit the interactive lfs session
231 Check the status of all servers (MGT, MDT, OST)
239 .B $ lfs quotaoff -ug /mnt/lustre
240 Turn quotas of user and group off
242 The usage of \fBlfs find\fR, \fBlfs getstripe\fR, \fBlfs hsm_*\fR,
243 \fBlfs setstripe\fR, \fBlfs migrate\fR, \fBlfs getdirstripe\fR,
244 \fBlfs setdirstripe\fR, \fBlfs mkdir\fR, and \fBlfs project\fR are explained
245 in separate man pages.
247 The lfs command is part of the Lustre filesystem.
251 .BR lfs-fid2path (1),
253 .BR lfs-getdirstripe (1),
255 .BR lfs-getstripe (1),
261 .BR lfs-path2fid (1),
263 .BR lfs-setdirstripe (1),
264 .BR lfs-setquota (1),
265 .BR lfs-setstripe (1),