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 (where \fIend\fR marks the end of the
66 current component), or set or replace the default file layout on an existing
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, \fBsymlink\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 -C\fR, \fB--overstripe-count \fR<\fIstripe_count\fR>
150 The number of stripes to create, creating > 1 stripe per OST if count exceeds
151 the number of OSTs in the file system. \fB0 \fRmeans to use the filesystem-wide
152 default stripe count (default 1), and \fB-1 \fRmeans to stripe over all
155 .B -S\fR, \fB--stripe-size \fR<\fIstripe_size\fR>
156 The number of bytes to store on each OST before moving to the next OST. A
159 means the file should use the filesystem-wide default stripe_size
160 (default 4MiB). An optional suffix can be used to specify the units in
166 must be a multiple of 64KiB. Values below 4096 are assumed to be in KiB units.
168 .B -i\fR, \fB--stripe-index \fR<\fIstart_ost_index\fR>
169 The OST index (starting at 0) on which to start striping for this file. A
173 allows the MDS to choose the starting index and it is strongly recommended, as
174 this allows space and load balancing to be done by the MDS as needed.
176 .B -L\fR, \fB--layout \fR<\fIlayout_type\fR>
177 The type of layout for that component, which can be one of:
179 .B raid0\fR - stripe the file data across
181 OST objects in units of
183 chunks. This is the default layout if not specified.
186 .B mdt\fR - place the first component of the file data on the MDT for faster
187 access where the inode is located. This can be used for small files, and with
188 composite file layouts. The
190 type may only be used for first component of a file. The
192 of the MDT component is always equal to the component size. There is also a
193 per-MDT tunable parameter
194 .IR lod.dom_stripesize
195 that limits the maximum size of a DoM stripe. It can be changed on the MDS via
196 .B lctl set_param lod.*.dom_stripesize=\fR<\fIstripe_size\fR> ,
199 must be a multiple of 64KiB in size,
205 .B -o\fR, \fB--ost \fR<\fIost_indices\fR>
206 Used to specify the exact stripe layout on the file system. \fIost_indices\fR
207 is a list of OSTs referenced by their indices, which are specified in decimal
208 or hex form and can be obtained using the
210 command. The list format consists of individual OST indices and index ranges
211 separated by commas, e.g. 1,2-4,7. The
213 option may be specified multiple times to stripe across the union of all listed
216 option is combined with
220 must agree with the number of OSTs in
224 option is combined with
228 must be in the OST list, and it will be used as the index on which to start
229 striping the file. Otherwise the striping will occur in the order specified in
232 .B -p\fR, \fB--pool \fR<\fIpool_name\fR>
233 Allocate objects from the predefined OST pool
235 for the layout of this file or component. The
240 can be used to select a subset of the OSTs within the pool; the
242 must be part of the pool or an error will be returned.
243 It is possible to specify a different pool for each component of a file. If
244 no pool is specified, it will be inherited from the previous component (for
245 later components of a composite layout) or the parent or root directory (for
248 layouts, or the first component of a composite file).
251 to force a component without a pool set (no inheritance from last component,
256 .BR pool_name=inherit
257 (since Lustre 2.15) to force a component to inherit the pool from the parent
258 or root directory instead of the previous component.
260 .B --foreign \fR[<\fIforeign_type\fR>]
261 file layout is non-lustre/free-format and of type <
263 >, if specified (see also
268 Current known types are
275 .B -x\fR, \fB--xattr \fR<\fIlayout_string\fR>
276 Mandatory non-lustre/free-format layout/LOV EA content for
280 .B -F\fR, \fB--flags \fR<\fIhex\fR>
281 Optional bitmap of flags for foreign type.
282 .SH COMPONENT_OPTIONS
283 The various component related options are listed and explained below. The
285 options can be shortened to
289 .B -E\fR, \fB--component-end \fR<\fIend\fR>
290 Add a new component to a file using the
294 argument. These options apply to the component ending at offset
296 in bytes, or by using a suffix (KMGTP) to specify base-two units,
297 such as 256M for 2^28 bytes. An offset of
301 means the following options extend to the end of the file. The first
302 component starts at offset 0, and each subsequent component starts at
303 the end of the previous component, so they must be specified in increasing
304 file offset order, and must be a multiple of 64KiB to align with the
307 value. Values below 4096 are assumed to be in KiB units.
310 The first component specified will inherit default parameters from the
311 parent directory or the root directory like a plain layout, as specified
312 above. Later components will inherit the default layout parameters from
313 the previous component. Multiple
315 options are used to separate the
317 parameters for different regions of the file.
321 If a file does not have a component extending to
323 it will generate an error when trying to write beyond the last component
325 This can be useful to limit the size of a file to the end of the last
326 specified component, or use
328 to add more components to the end of the file.
331 .B -z, --extension-size, ext-size\fR <\fIext_size\fR>
332 This option modifies the \fB-E\fR option, components which have this
333 option specified are created as pairs of components, extendable and
337 The extendable component starts at offset 0 if this is the first
338 component of the file. In this case it ends at offset \fIext_size\fR and
339 it gets the flag \fBinit\fR (initialized). The extendable component starts
340 at the end of the previous component if this is not the first component of
341 the file. In this case it ends at the same offset (0-length component).
343 The extension component covers the rest of the specified region up to
344 the \fIend\fR specified by \fB-E\fR option and gets the flag \fBextension\fR.
345 This component covers the space reserved for the extendable component but
346 not used immediately, the later extension of the extendable component is done
347 by \fIext_size\fR each time until the extension component is used up. This is
348 used to control the space on OSTs the stripe is located on, in case one of
349 them is low on space, the remaining extension component region is added to the
354 Add components to the end an existing composite file. It is not possible
355 to add components incrementally to the default directory layout, since the
356 entire default layout can be replaced with a single
358 command. Adding components to mirrored files is not currently allowed.
361 Delete specified the components from an existing file using either the
362 .BR --component-id | -I
364 .BR --component-flags .
365 Deletion must start with the last component. The ID specified by the
367 option is the numerical unique ID of the component, it can be obtained using
370 command. It is not possible to delete components from a default directory
371 layout, since the entire default layout can be replaced with a single
374 The \fB--component-flags\fR option is used to specify certain type of
375 components. The only allowed component flag for deleting a component is
377 to indicate an uninstantiated component. Deleting a single component from
378 mirrored files is not currently allowed, see the
379 .BR lfs-mirror-split (1)
382 .B --component-flags \fR<\fIflags\fR>
385 on a specific component. Allowed
389 .B * init\fR - component is initialized (has allocated objects). Used with
390 .B --component-del --component-flags ^init
391 to find uninitialized components.
394 .B * prefer\fR - component preferred for read/write in a mirrored file
397 .B * prefrd\fR - component preferred for read in a mirrored file
400 .B * prefwr\fR - component preferred for write in a mirrored file
403 .B * stale\fR - component has outdated data in a mirrored file. This flag is
404 not allowed to be set on a component of the last non-stale mirror.
405 Once a component is marked
407 it isn't permitted to clear this flag directly. \fBlfs-mirror-resync\fR(1)
408 is required to clear the flag.
411 .B * nosync\fR - mirror components will not be resynched by default when the
412 .BR lfs-mirror-resync (1)
413 command is run. This option is useful to freeze a file mirror as an old
414 version or snapshot of the file.
417 A leading '^' before \fIflags\fR clears the flags, or finds components not
418 matching the flags. Multiple flags can be separated by comma(s).
421 .B -I\fR, \fB--component-id \fR<\fIcomp_id\fR>
422 The numerical unique component ID to identify a component to be modified.
424 .BR -N "[\fImirror_count\fR], " --mirror-count=" [\fImirror_count\fR]
427 identical replicas on the file or directory. The
429 argument is optional and defaults to 1 if it's not specified; if specified,
432 option without a space.
434 The \fISTRIPE_OPTIONS\fR specify the specific layout for the mirror. It
435 can be a plain layout with specific striping pattern or a composite layout.
436 If not specified, the stripe options are inherited from the previous
437 component. If there is no previous component, the
441 options are inherited from filesystem-wide default values, and OST
443 will be inherited from the parent directory.
447 options may be specified, each with its own
449 if there is a reason to have different layouts for the replicas, such as
450 flash pools and archive pools (see
451 .BR lfs-mirror-create (1)
455 that in the current client implementation, only
457 replica will be written by client nodes, and the other replicas need to
458 be resynched using the
460 command, or an external resync agent.
463 .B lfs setstripe -S 128K -c 2 /mnt/lustre/file1
464 This creates a file striped on two OSTs with 128KiB on each stripe.
466 .B lfs setstripe -d /mnt/lustre/dir
467 This deletes a default stripe pattern on dir. New files created in that
468 directory will use the filesystem global default instead.
470 .B lfs setstripe -N2 -E 1M -E eof -c -1 /mnt/lustre/dir1
471 This sets a default mirror layout on a directory with 2 PFL mirrors. Each mirror
472 has the same specified PFL layout.
474 .B lfs setstripe -N -E 1M -L mdt -E eof --component-flags=prefer -p flash \
475 -N -E 1G -c 1 -p disk -E eof -c -1 /mnt/lustre/file1
476 This creates a mirrored file with 2 replicas. The first replica is using the
477 MDT for files smaller than 1MB, and the remainder of the file is on the
479 OST pool with filesystem-wide default values. The second replica is on the
481 OST pool, with 1 stripe for the first 1GB of the file, and striped across
483 .B disk pool for the remainder of the file. Clients will
485 the first (flash) replica for both reads and writes.
487 .B lfs setstripe -E 4M -c 1 -E 64M -c 4 -E -1 -c -1 /mnt/lustre/file1
488 This creates a file with composite layout, the component has 1 stripe and
489 covers [0, 4MiB), the second component has 4 stripes and covers [4MiB, 64MiB),
490 the last component stripes over all available OSTs and covers [64MiB, EOF).
492 .B lfs setstripe -E -1 -z 64M /mnt/lustre/file1
493 This creates a file with a composite layout, the component one covers [0, 64MiB)
494 and the second component the rest [64MiB, EOF) originally. Once written beyond
495 64MiB the component one is extended to [0, 128MiB), once written beyond 128MiB
496 it is extended to [0, 192MiB), etc; the second component is shortened
500 When one of the OSTs of the first component layout is low on space, e.g. while
501 writing beyond 192MiB, the first component is left as [0, 192MiB), and a new
502 component is allocated between them, its layout repeats the first component
503 layout but initialized on different OSTs so that the full OSTs are avoided.
504 It is allocated and immediately extended to [192MiB, 256MiB), the following
505 extension component is shortened again.
508 .B lfs setstripe -E 1G -z 64M -E 100G -z 256M -E -1 -z 1G /mnt/lustre/file1
509 This creates a file with a composite layout, the component one covers [0,
510 64MiB), the third component covers [1G, 1G), the fifth component covers
511 [100GiB, 100GiB) originally. The second, fourth and sixth extension components
512 cover the left space accordingly. The process of writing is similar to above,
513 but when one of the OSTs of the first component layout is low on space, e.g.
514 while writing beyond 192MiB in the example above, the first component is left
515 as [0, 192MiB), the second (extension) component is removed, and its range
516 spills over to the third and the fourth components - they are moved left to
517 start at 192MiB instead of 100GiB; the third component is immediately extended
518 and becomes [192MiB, 448MiB), the fourth (the extension one) component becomes
521 .B lfs setstripe --component-add -E eof -c 4 /mnt/lustre/file1
522 This add a component which starts at the end of last existing component to
525 .B lfs setstripe --component-del -I 1 /mnt/lustre/file1
526 This deletes the component with ID equal to 1 from an existing file.
528 .B lfs setstripe --comp-set -I 1 --comp-flags=^prefer,stale /mnt/lustre/file1
529 This command will clear the \fBprefer\fR flag and set the \fBstale\fR flag on
533 .B lfs setstripe -E 1M -L mdt -E -1 /mnt/lustre/file1
536 with Data-on-MDT layout. The first 1MiB of the file data is placed on the
537 MDT and rest of file is placed on OST(s) with default striping.
539 .B lfs setstripe --yaml=/tmp/layout_yaml /mnt/lustre/file2
542 with layout stored in the layout template
545 which can be created with the
546 .B lfs getstripe --yaml
549 .B lfs setstripe --foreign=symlink --flags=0xda08 \
550 --xattr=PUUID:CUUID /mnt/lustre/file1
555 with non-lustre/free-format
557 layout/LOV EA and flags
564 .BR lfs-mirror-create (1),
565 .BR lfs-mirror-split (1),