Whamcloud - gitweb
LU-13417 utils: lfs setdirstripe -D -i -1 should work
[fs/lustre-release.git] / lustre / doc / lfs-setdirstripe.1
1 .TH LFS-SETDIRSTRIPE 1 2017-11-07 "Lustre" "Lustre Utilities"
2 .SH NAME
3 lfs setdirstripe, mkdir \- set striping pattern of a directory.
4 .SH SYNOPSIS
5 .B lfs setdirstripe [\fR-cdDHioTx\fR] \fIDIR\fR...
6 .br
7 .SH DESCRIPTION
8 Create a striped directory with specified striping pattern. This
9 .B lfs
10 sub-command is similar to
11 .BR "lfs setstripe" ,
12 but is used to create a striped directory or set the default layout for
13 subdirectories.
14 Can also be used to create directory with a foreign (free format) striping pattern (see
15 .BR --foreign
16 and
17 .BR --xattr
18 options).
19 .B lfs mkdir
20 is an alias for this command.
21 .SH OPTIONS
22 .TP
23 .BR \-c ", " \-T ", " \-\-mdt\-count =\fICOUNT\fR
24 Stripe the new directory over
25 .I COUNT
26 MDTs.
27 .TP
28 .BR \-i ", " \-\-mdt\-index =\fISTART_MDT_INDEX\fR[,\fIMDT_INDEX ...]
29 Use the MDT whose index is
30 .I START_MDT_INDEX
31 as the master/starting MDT for the directory. If multiple
32 .I MDT_INDEX
33 values are given, then the stripes will be allocated on the specified
34 MDT indices.  If index -1 (default) is used, it will prefer to select
35 .B COUNT
36 MDTs proportional to the free space and inodes on each.
37 .TP
38 .BR \-H ", " \-\-mdt-hash =\fIHASH_TYPE\fR
39 Use
40 .I hash_type
41 for the striped directory.
42 .RS 1.2i
43 .TP
44 .B crush
45 CRUSH hash algorithm.  This is a consistent hash
46 algorithm, so minimum sub files need to relocate
47 during directory restripe.
48 .TP
49 .B fnv_1a_64
50 Fowler-Noll-Vo (FNV-1a) hash algorithm.  This provides
51 reasonably uniform, but not cryptographically strong,
52 hashing of the filename. (default)
53 .TP
54 .B all_char
55 Sum of ASCII characters modulo number of MDTs. This
56 provides weak hashing of the filename, and is suitable
57 for only testing or when the input is known to have
58 perfectly uniform distribution (e.g. sequential numbers).
59 .RE
60 .TP
61 .BR \-d ", " \-\-delete
62 Delete the default striping layout from the directory.  New subdirectories
63 created in this directory will inherit the global default directory layout
64 (by default they will not be striped).
65 .TP
66 .BR \-D ", " \-\-default
67 Set the default striping pattern of subdirectories. Newly created
68 sub-directories will use the new default striping pattern,
69 but existing sub-directories will not be affected.  The newly
70 created sub-directories will also inherit the specified default
71 striping pattern. Only default stripe count is supported for now.
72
73 Note that striping all directories across all MDTs by default is
74 .B not
75 recommended at this time, as the clients will have to do more RPCs to
76 create and access each directory, hurting performance rather than
77 improving it.  Default striped directories are preferred for parent
78 directories
79 where large subdirectories will be created (e.g. file-per-process
80 job output directories).
81 .TP
82 .BR \-o ", " \-\-mode =\fIMODE\fR
83 Set the file access permissions of the new directory to the specified
84 numeric
85 .I MODE
86 (typically octal), as with
87 .BR chmod (1).
88 It is not affected by the current
89 .BR umask (1p).
90 .TP
91 .BR \-\-foreign[=type]
92 Create a directory with a foreign (non-Lustre/free format, see
93 .BR \-\-xattr
94 option) striping. Where
95 .BR type
96 specifies a known foreign type (like
97 .BR none ,
98 .BR daos )
99 or a 32-bit numeric type.
100 .TP
101 .BR \-\-flags =\fI<hex>\fR
102 Specify a numeric bitmask of type-specific layout flags for the foreign layout.
103 .TP
104 .BR \-x ", " \-\-xattr =\fISTRING\fR
105 Specify a string to be used as a foreign (free format) striping.
106 .SH NOTE
107 .PP
108 The
109 .B lfs setdirstripe
110 command is only usable by root unless the
111 .B "mdt.*.enable_remote_dir_gid"
112 is set on the MDS via
113 .B lctl set_param
114 to be either a non-zero numeric GID to limit it to a single group (e.g. the
115 .BR "operator " or " admin"
116 GID), or
117 .B "-1"
118 to allow any user/group to create remote directories.  By default, it is
119 .B "0"
120 to limit remote/striped directories to only the root user.
121
122 The root directory of the file system is on MDT0000, and directories and
123 files inherit the MDT of their parent directory unless a different MDT is
124 specified with this command.
125
126 By default, only directories on MDT0000 can contain directories that are not on
127 the same MDT.  However, if
128 .B "mdt.*.enable_remote_dir"
129 is set non-zero on an MDT (the default)
130 then it will allow creating remote directories that have parents other than
131 MDT0000. This is restricted to avoid creating directory trees that have
132 intermediate path components on a series different MDTs and become unavailable
133 if any of the intermediate MDTs are offline.
134 .SH EXAMPLES
135 .TP
136 .B $ lfs setdirstripe -c 2 -i 1 -H all_char /mnt/lustre/dir1
137 This creates a directory striped on two MDTs, whose first stripe is on
138 .B MDT0001
139 (MDT index 1), and whose hash type is
140 .BR all_char .
141 .TP
142 .B $ lfs mkdir --foreign=daos --xattr PUUID:CUUID /mnt/lustre/dir1
143 This creates
144 .B dir1
145 with foreign (non-lustre/free format)
146 .B PUUID:CUUID
147 striping/LMV EA.
148 .SH AVAILABILITY
149 The
150 .B lfs setdirstripe
151 command is part of the Lustre filesystem.
152 .SH SEE ALSO
153 .BR lctl (8),
154 .BR lfs (1),
155 .BR lfs-getdirstripe (1),
156 .BR lfs-setstripe (1),
157 .BR lustre (7)