1 .TH LFS-SETSTRIPE 1 2017-08-23 "Lustre" "Lustre Utilities"
3 lfs setstripe \- set striping pattern of a file or directory default
5 .B lfs setstripe \fR[\fISTRIPE_OPTIONS\fR] <\fIdirectory\fR|\fIfile\fR>
7 .B lfs setstripe -E \fIend1\fR [\fISTRIPE_OPTIONS\fR] ... \
8 <\fIdirectory\fR|\fIfile\fR>
10 .B lfs setstripe --comp-add -E \fIend1\fR [\fISTRIPE_OPTIONS\fR] ... \
13 .B lfs setstripe --comp-del \fR{\fB-I \fIcomp_id\fR|\
14 \fB--comp-flags=\fIcomp_flags\fR} <\fIfile\fR>
16 .B lfs setstripe --comp-set \fR{-I \fIcomp_id\fR|\
17 \fB--comp-flags=\fIcomp_flags\fR} <\fIfile\fR>
19 .B lfs setstripe -N\fR[\fImirror_count\fR] \fR[\fISTRIPE_OPTIONS\fR] <\fIdirectory\fR|\fIfilename\fR>
21 .B lfs setstripe -d \fR<\fIdirectory\fR>
23 .B lfs setstripe --yaml=\fR<\fIyaml_template_file.lyl\fR> <\fIfile\fR>
25 .B lfs setstripe --copy=\fR<\fIsource_template_file\fR> <\fIfile\fR>
27 .B lfs setstripe --foreign[=\fR<\fIforeign_type\fR>\fB] \
28 [--flags=\fR<\fIhex\fR>\fB] --xattr=\fR<\fIlayout_string\fR> <\fIfile\fR>
32 command is used to create a new
34 in a Lustre filesystem with the specified layout, or to specify the default
35 layout for new files created in
37 or anywhere in the filesystem if
39 is the filesystem root and no other layout takes precedence.
41 Files with composite layouts allow different
43 to be specified for non-overlapping extents of the file. Files will
44 inherit options not explicitly specified on the command line either from
45 the default layout on the parent directory, or from the filesystem-wide
46 default. New subdirectories created under root directory will not explicitly
47 copy the default layout at creation time, but will implicitly inherit the
48 default layout at runtime. The default layout set on a non-root directory
49 will be copied to any new subdirectories created within that directory
50 at the time they are created.
52 .B lfs setstripe \fR[\fISTRIPE_OPTIONS\fR ...] <\fIdirectory\fR|\fIfile\fR>
55 with specified plain layout using the specified
57 or replace the default file layout on an existing
60 .B lfs setstripe -E \fIend\fR [\fISTRIPE_OPTIONS\fR] ... \
61 <\fIdirectory\fR|\fIfile\fR>
63 Create a new composite
65 with one or more component layouts, or set or replace the default file layout
69 .B lfs setstripe --component-add -E \fIend1\fR [\fISTRIPE_OPTIONS\fR] \
72 Add one or more components after the last component of an existing composite
73 file that does not yet have a component at
76 .B lfs setstripe --comp-del \fR{\fB-I \fIcomp_id\fR | \
77 \fB--comp-flags \fIcomp_flags\fR} <\fIfile\fR>
78 Remove the component(s) specified by component ID or flags from
81 .B lfs setstripe --comp-set \fR{\fB-I \fIcomp_id\fR | \
82 \fB--comp-flags \fIcomp_flags\fR} <\fIfile\fR>
85 on the specified component. This command can be only
86 be applied to mirrored files.
88 .B lfs setstripe -N \fR[\fImirror_count\fR] \fR[\fICOMPONENT_OPTIONS\fR] <\fIdirectory\fR|\fIfile\fR>
91 with the specified number of mirrors and other specified layout options, or
92 set or replace the default file layout on an existing
95 .B lfs setstripe -d \fR<\fIdirectory\fR>
97 Delete the default layout on the specified directory. It is not necessary
98 to delete the default layout on a directory before replacing it, only if
99 the directory should revert from a directory-specific default layout
100 to using the global filesystem default layout stored on the root directory.
102 .B lfs setstripe --yaml=\fR<\fIyaml_template_file.lyl\fR> <\fIfile\fR>
106 using the Lustre YAML Layout template
107 .IR yaml_template_file.lyl ,
112 .B lfs getstripe --yaml \fR<\fIexisting_file\fR> > <\fIyaml_template_file.lyl\fR>
114 .I yaml_template_file.lyl
115 is a plain-text file that may be saved and/or modified after creation.
116 This allows complex file layouts to be created once and re-used later.
118 .B lfs setstripe --copy=\fR<\fIsource_template_file\fR> <\fIfile\fR>
122 using the same layout as an existing
123 .IR source_template_file .
124 This is similar to the
126 option but avoids the need for the intermediate
130 .B lfs setstripe --foreign[=\fR<\fIforeign_type\fR>\fB] \
131 [--flags=\fR<\fIhex\fR>\fB] --xattr=\fR<\fIlayout_string\fR> <\fIfile\fR>
135 with a foreign/non-lustre layout of type
136 .I foreign_type \fR(\fBnone\fR, \fBdaos\fR, ...)
139 and a free-format layout value of
142 The various OST stripe related options are listed and explained below:
144 .B -c\fR, \fB--stripe-count \fR<\fIstripe_count\fR>
145 The number of OSTs to stripe a file over. \fB0 \fRmeans to use the
146 filesystem-wide default stripe count (default 1), and \fB-1 \fRmeans to stripe
147 over all available OSTs.
149 .B -S\fR, \fB--stripe-size \fR<\fIstripe_size\fR>
150 The number of bytes to store on each OST before moving to the next OST. A
153 means the file should use the filesystem-wide default stripe_size
154 (default 1MiB). An optional suffix can be used to specify the units in
160 must be a multiple of 64KiB in size.
162 .B -i\fR, \fB--stripe-index \fR<\fIstart_ost_index\fR>
163 The OST index (starting at 0) on which to start striping for this file. A
167 allows the MDS to choose the starting index and it is strongly recommended, as
168 this allows space and load balancing to be done by the MDS as needed.
170 .B -L\fR, \fB--layout \fR<\fIlayout_type\fR>
171 The type of layout for that component, which can be one of:
173 .B raid0\fR - stripe the file data across
175 OST objects in units of
177 chunks. This is the default layout if not specified.
180 .B mdt\fR - place the first component of the file data on the MDT for faster
181 access where the inode is located. This can be used for small files, and with
182 composite file layouts. The
184 type may only be used for first component of a file. The
186 of the MDT component is always equal to the component size. There is also a
187 per-MDT tunable parameter
188 .IR lod.dom_stripesize
189 that limits the maximum size of a DoM stripe. It can be changed on the MDS via
190 .B lctl set_param lod.*.dom_stripesize=\fR<\fIstripe_size\fR> ,
193 must be a multiple of 64KiB in size,
199 .B -o\fR, \fB--ost \fR<\fIost_indices\fR>
200 Used to specify the exact stripe layout on the file system. \fIost_indices\fR
201 is a list of OSTs referenced by their indices, which are specified in decimal
202 or hex form and can be obtained using the
204 command. The list format consists of individual OST indices and index ranges
205 separated by commas, e.g. 1,2-4,7. The
207 option may be specified multiple times to stripe across the union of all listed
210 option is combined with
214 must agree with the number of OSTs in
218 option is combined with
222 must be in the OST list, and it will be used as the index on which to start
223 striping the file. Otherwise the striping will occur in the order specified in
226 .B -p\fR, \fB--pool \fR<\fIpool_name\fR>
227 Allocate objects from the predefined OST pool
229 for the layout of this file or component. The
234 can be used to select a subset of the OSTs within the pool; the
236 must be part of the pool or an error will be returned.
237 It is possible to specify a different pool for each component of a file. If
238 no pool is specified, it will be inherited from the previous component (for
239 later components of a composite layout) or the parent or root directory (for
242 layouts, or the first component of a composite file).
247 (since Lustre 2.11) to force a component to inherit the pool from the parent
248 or root directory instead of the previous component.
250 .B --foreign \fR[<\fIforeign_type\fR>]
251 file layout is non-lustre/free-format and of type <
253 >, if specified (see also
258 Current known types are
265 .B -x\fR, \fB--xattr \fR<\fIlayout_string\fR>
266 Mandatory non-lustre/free-format layout/LOV EA content for
270 .B -F\fR, \fB--flags \fR<\fIhex\fR>
271 Optional bitmap of flags for foreign type.
272 .SH COMPONENT_OPTIONS
273 The various component related options are listed and explained below. The
275 options can be shortened to
279 .B -E\fR, \fB--component-end \fR<\fIend\fR>
280 Add a new component to a file using the
284 argument. These options apply to the component ending at offset
286 in bytes, or by using a suffix (KMGTP) to specify base-two units,
287 such as 256M for 2^28 bytes. An offset of
291 means the following options extend to the end of the file. The first
292 component starts at offset 0, and each subsequent component starts at
293 the end of the previous component, so they must be specified in increasing
297 The first component specified will inherit default parameters from the
298 parent directory or the root directory like a plain layout, as specified
299 above. Later components will inherit the default layout parameters from
300 the previous component. Multiple
302 options are used to separate the
304 parameters for different regions of the file.
308 If a file does not have a component extending to
310 it will generate an error when trying to write beyond the last component
312 This can be useful to limit the size of a file to the end of the last
313 specified component, or use
315 to add more components to the end of the file.
319 Add components to the end an existing composite file. It is not possible
320 to add components incrementally to the default directory layout, since the
321 entire default layout can be replaced with a single
323 command. Adding components to mirrored files is not currently allowed.
326 Delete specified the components from an existing file using either the
327 .BR --component-id | -I
329 .BR --component-flags .
330 Deletion must start with the last component. The ID specified by the
332 option is the numerical unique ID of the component, it can be obtained using
335 command. It is not possible to delete components from a default directory
336 layout, since the entire default layout can be replaced with a single
339 The \fB--component-flags\fR option is used to specify certain type of
340 components. The only allowed component flag for deleting a component is
342 to indicate an uninstantiated component. Deleting a single component from
343 mirrored files is not currently allowed, see the
344 .BR lfs-mirror-split (1)
347 .B --component-flags \fR<\fIflags\fR>
350 on a specific component. Allowed
354 .B * init\fR - component is initialized (has allocated objects). Used with
355 .B --component-del --component-flags ^init
356 to find uninitialized components.
359 .B * prefer\fR - component preferred for read/write in a mirrored file
362 .B * stale\fR - component has outdated data in a mirrored file. Once a
365 it isn't permitted to clear this flag directly. \fBlfs-mirror-resync\fR(1)
366 is required to clear the flag.
369 .B * nosync\fR - mirror components will not be resynched by default when the
370 .BR lfs-mirror-resync (1)
371 command is run. This option is useful to freeze a file mirror as an old
372 version or snapshot of the file.
375 A leading '^' before \fIflags\fR clears the flags, or finds components not
376 matching the flags. Multiple flags can be separated by comma(s).
379 .B -I\fR, \fB--component-id \fR<\fIcomp_id\fR>
380 The numerical unique component ID to identify a component to be modified.
382 .BR -N "[\fImirror_count\fR], " --mirror-count=" [\fImirror_count\fR]
385 identical replicas on the file or directory. The
387 argument is optional and defaults to 1 if it's not specified; if specified,
390 option without a space.
392 The \fISTRIPE_OPTIONS\fR specify the specific layout for the mirror. It
393 can be a plain layout with specific striping pattern or a composite layout.
394 If not specified, the stripe options are inherited from the previous
395 component. If there is no previous component, the
399 options are inherited from filesystem-wide default values, and OST
401 will be inherited from the parent directory.
405 options may be specified, each with its own
407 if there is a reason to have different layouts for the replicas, such as
408 flash pools and archive pools (see
409 .BR lfs-mirror-create (1)
413 that in the current client implementation, only
415 replica will be written by client nodes, and the other replicas need to
416 be resynched using the
418 command, or an external resync agent.
421 .B lfs setstripe -S 128K -c 2 /mnt/lustre/file1
422 This creates a file striped on two OSTs with 128KiB on each stripe.
424 .B lfs setstripe -d /mnt/lustre/dir
425 This deletes a default stripe pattern on dir. New files created in that
426 directory will use the filesystem global default instead.
428 .B lfs setstripe -N2 -E 1M -E eof -c -1 /mnt/lustre/dir1
429 This sets a default mirror layout on a directory with 2 PFL mirrors. Each mirror
430 has the same specified PFL layout.
432 .B lfs setstripe -N -E 1M -L mdt -E eof --component-flags=prefer -p flash \
433 -N -E 1G -c 1 -p disk -E eof -c -1 /mnt/lustre/file1
434 This creates a mirrored file with 2 replicas. The first replica is using the
435 MDT for files smaller than 1MB, and the remainder of the file is on the
437 OST pool with filesystem-wide default values. The second replica is on the
439 OST pool, with 1 stripe for the first 1GB of the file, and striped across
441 .B disk pool for the remainder of the file. Clients will
443 the first (flash) replica for both reads and writes.
445 .B lfs setstripe -E 4M -c 1 -E 64M -c 4 -E -1 -c -1 /mnt/lustre/file1
446 This creates a file with composite layout, the component has 1 stripe and
447 covers [0, 4MiB), the second component has 4 stripes and covers [4MiB, 64MiB),
448 the last component stripes over all available OSTs and covers [64MiB, EOF).
450 .B lfs setstripe --component-add -E eof -c 4 /mnt/lustre/file1
451 This add a component which starts at the end of last existing component to
454 .B lfs setstripe --component-del -I 1 /mnt/lustre/file1
455 This deletes the component with ID equal to 1 from an existing file.
457 .B lfs setstripe --comp-set -I 1 --comp-flags=^prefer,stale /mnt/lustre/file1
458 This command will clear the \fBprefer\fR flag and set the \fBstale\fR flag on
462 .B lfs setstripe -E 1M -L mdt -E -1 /mnt/lustre/file1
465 with Data-on-MDT layout. The first 1MiB of the file data is placed on the
466 MDT and rest of file is placed on OST(s) with default striping.
468 .B lfs setstripe --yaml=/tmp/layout_yaml /mnt/lustre/file2
471 with layout stored in the layout template
474 which can be created with the
475 .B lfs getstripe --yaml
478 .B lfs setstripe --foreign=daos --flags=0xda08 \
479 --xattr=PUUID:CUUID /mnt/lustre/file1
484 with non-lustre/free-format
486 layout/LOV EA and flags
493 .BR lfs-mirror-create (1),
494 .BR lfs-mirror-split (1),