lustre/doc/lfs.1

   1 .TH lfs 1 "2018-01-24" Lustre "user utilities"
   2 .SH NAME
   3 lfs \- client utility for Lustre-specific file layout and other attributes
   4 .SH SYNOPSIS
   5 .br
   6 .B lfs changelog [--follow] <mdtname> [startrec [endrec]]
   7 .br
   8 .B lfs changelog_clear <mdtname> <id> <endrec>
   9 .br
  10 .B lfs check <mds|osts|servers>
  11 .br
  12 .B lfs data_version [-n] \fB<filename>\fR
  13 .br
  14 .B lfs df [-ihlv] [--pool|-p <fsname>[.<pool>]] [path]
  15 .br
  16 .B lfs fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
  17 .br
  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|\fB--comp-count\fR [\fB+-\fR]\fIn\fR]
  23       [[\fB!\fR] \fB--component-flags|\fB--comp-flags\fR <[\fB^\fR]\fIflag\fB,\fR...>]
  24       [[\fB!\fR] \fB--component-end|\fB--comp-end\fR|\fB-E\fR [\fB+-\fR]\fIn\fR[\fBKMGTPE\fR]]
  25       [[\fB!\fR] \fB--component-start|\fB--comp-start\fR [\fB+-\fR]\fIn\fR[\fBKMGTPE\fR]]
  26       [[\fB!\fR] \fB--gid\fR|\fB-g\fR|\fB--group\fR|\fB-G\fR <\fIgname\fR>|<\fIgid\fR>]
  27       [[\fB!\fR] \fB--layout\fR|\fB-L mdt\fR,\fBraid0\fR,\fBreleased\fR]
  28 [\fB--maxdepth\fR|\fB-D\fI n\fR]
  29       [[\fB!\fR] \fB--mdt\fR|\fB--mdt-index\fR|\fB-m\fR <\fIuuid\fR|\fIindex\fR,...>]
  30       [[\fB!\fR] \fB--mdt-count\fR|\fB-T\fR [\fB+-\fR]\fIn\fR]
  31 [[\fB!\fR] \fB--mdt-hash\fR|\fB-H \fI<hashtype>\fR]
  32       [[\fB!\fR] \fB--name\fR|\fB-n \fI<pattern>\fR]
  33 [[\fB!\fR] \fB--ost\fR|\fB-O\fR <\fIuuid\fR|\fIindex\fR,...>]
  34       [[\fB!\fR] \fB--pool\fR <\fIpool\fR>]
  35 [\fB--print\fR|\fB-P\fR] [\fB--print0\fR|\fB-0\fR]
  36       [[\fB!\fR] \fB--projid\fR |<\fIprojid\fR>]
  37 [[\fB!\fR] \fB--size|\fB-s\fR [\fB-+\fR]\fIn\fR[\fBKMGTPE\fR]]
  38       [[\fB!\fR] \fB--stripe-count|\fB-c\fR [\fB+-\fR]\fIn\fR]
  39       [[\fB!\fR] \fB--stripe-index|\fB-i\fR \fIn\fR,...]
  40       [[\fB!\fR] \fB--stripe-size|\fB-S\fR [\fB+-\fR]\fIn\fR[\fBKMG\fR]]
  41 [[\fB!\fR] \fB--type\fR|\fB-t\fR {\fBbcdflps\fR}]
  42       [[\fB!\fR] \fB--uid\fR|\fB-u\fR|\fB--user\fR|\fB-U
  43 <\fIuname\fR>|<\fIuid>\fR]
  44 .br
  45 .B lfs getname [-h]|[path ...]
  46 .br
  47 .B lfs getstripe
  48 [\fB--component-count\fR|\fB--comp-count\fR]
  49         [\fB--component-end\fR[=[\fB+-\fR]\fIN\fR[kMGTPE]]|\fB-E\fR[[+-]\fIN\fR[kMGTPE]]]
  50         [\fB--component-flags\fR[=[\fB^\fR]\fIflag\fB,\fR...]]
  51         [\fB--component-id\fR[=\fIcomp_id\fR]|\fB-I\fR[<\fIcomp_id\fR>]]
  52         [\fB--component-start\fR[=[\fB+-\fR]\fIN\fR[kMGTPE]]]
  53         [\fB--directory\fR|\fB-d\fR]
  54 [\fB--fid\fR|\fB-F\fR]
  55 [\fB--generation\fR|\fB-g\fR]
  56         [\fB--layout\fR|\fB-L\fR]
  57 [\fB--mdt\fR|\fB--mdt-index\fR|\fB-m\fR]
  58 [\fB--ost\fR|\fB-O\fR <\fIuuid\fR>]
  59         [\fB--pool\fR|\fB-p\fR]
  60 [\fB--quiet\fR|\fB-q\fR]
  61 [\fB--recursive\fR|\fB-r\fR]
  62         [\fB--raw\fR|\fB-R\fR]
  63 [\fB--stripe-count\fR|\fB-c\fR]
  64 [\fB--stripe-index\fR|\fB-i\fR]
  65         [\fB--stripe-size\fR|\fB-S\fR]
  66 [\fB--verbose\fR|\fB-v\fR]
  67 [\fB--yaml\fR|\fB-y\fR]
  68         <\fIdirname\fR|\fIfilename\fR> ...
  69 .br
  70 .B lfs migrate { --mdt-index | -m } \fI<mdt_index>\fR
  71 .IR directory
  72 .br
  73 .B lfs migrate [\fB-c | --stripe-count <stripe_count>\fR]
  74             [\fB-i | --stripe-index <start_ost_idx>\fR]
  75             [\fB-S | --stripe-size <stripe_size>\fR]
  76             [\fB-p | --pool <pool_name>\fR]
  77             [\fB-o | --ost-list <ost_indices>\fR]
  78             [\fB-b | --block\fR]
  79             [\fB-n | --non-block\fR]
  80 .IR file|directory
  81 .br
  82 .B lfs migrate <\fB-E | --component-end comp_end1\fR> [\fBSTRIPE_OPTIONS\fR]
  83             <\fB-E | --component-end comp_end2\fR> [\fBSTRIPE_OPTIONS\fR]
  84             \fB...\fR
  85 .IR filename
  86 .br
  87 .B lfs mkdir [\fB-c | --count <stripe_count>\fR]
  88            [\fB-i | --index <mdt_idx>\fR]
  89            [\fB-h | --hash-type <hash_name>\fR]
  90            [\fB-m | --mode <mode>\fR]
  91            [\fB-D | --default\fR]
  92 .IR directory
  93 .br
  94 .B lfs osts
  95 .RB [ path ]
  96 .br
  97 .B lfs mdts
  98 .RB [ path ]
  99 .br
 100 .B lfs path2fid [--parents] <path> ...
 101 .br
 102 .B lfs pool_list <filesystem>[.<pool>] | <pathname>
 103 .br
 104 .B lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u <uname>| -u <uid>|-g <gname>| -g <gid>] [-p <projid>] <filesystem>
 105 .br
 106 .B lfs quota -t <-u|-g|-p> <filesystem>
 107 .br
 108 .B lfs quotacheck [-ug] <filesystem>
 109 .br
 110 .B lfs quotaon [-ugf] <filesystem>
 111 .br
 112 .B lfs quotaoff [-ug] <filesystem>
 113 .br
 114 .B lfs setstripe [--stripe-size|-S <size>] [--stripe-count|-c <count>]
 115         \fB[--stripe-index|-i <start_ost_index>] [--pool|-p <poolname>]
 116         \fB[--ost-list|-o <ost_indices>] <directory|filename>\fR
 117 .br
 118 .B lfs setstripe -d <dir>
 119 .br
 120 .B lfs setstripe --component-end|-E <end1> [STRIPE_OPTIONS]
 121      [\fB--component-end|-E <end2> [STRIPE_OPTIONS]] ... <filename>\fR
 122 .br
 123 .B lfs setstripe --component-add --component-end|-E <end1> [STRIPE_OPTIONS]
 124      \fB<--component-end|-E <end2>> [STRIPE_OPTIONS]] ... <filename>\fR
 125 .br
 126 .B lfs setstripe --component-del {--component-id|-I id |
 127      \fB--component-flags <flags>} <filename>
 128 .br
 129 .B lfs --version
 130 .br
 131 .B lfs --list-commands
 132 .br
 133 .B lfs help
 134 .SH DESCRIPTION
 135 .B lfs
 136 can be used to create a new file with a specific striping pattern, determine
 137 the default striping pattern, gather the extended attributes (object numbers
 138 and location) for a specific file. It can be invoked interactively without any
 139 arguments or in a non-interactive mode with one of the arguments supported.
 140 .SH OPTIONS
 141 The various options supported by lfs are listed and explained below:
 142 .TP
 143 .B changelog
 144 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.
 145 .TP
 146 .B changelog_clear
 147 Indicate that changelog records previous to <endrec> are no longer of
 148 interest to a particular consumer <id>, potentially allowing the MDT to
 149 free up disk space. An <endrec> of 0 indicates the current last record.
 150 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
 151 .TP
 152 .B check
 153 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
 154 .TP
 155 .B data_version [-n] <filename>
 156 Display current version of file data. If -n is specified, data version is read
 157 without taking lock. As a consequence, data version could be outdated if there
 158 is dirty caches on filesystem clients, but this will not force data flushes and
 159 has less impact on filesystem.
 160
 161 Even without -n, race conditions are possible and data version should be
 162 checked before and after an operation to be confident the data did not change
 163 during it.
 164 .TP
 165 .B getname [-h]|[path ...]
 166 Report all the Lustre mount points and the corresponding Lustre filesystem
 167 instance. If one or more \fBpath\fR entries are provided, then only the
 168 Lustre instance for these mount points is returned. If the path given is not on
 169 a Lustre instance 'No such device' is reported.
 170 .TP
 171 .B osts
 172 .RB [ path ]
 173 List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
 174 that is located on a lustre mounted file system then only the OSTs belonging
 175 to that filesystem are displayed.
 176 .TP
 177 .B fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
 178 Print out the pathname(s) for the specified \fIfid\fR(s) from the filesystem
 179 mounted at \fBrootpath\fR or named \fBfsname\fR.  If a file has multiple
 180 hard links, then all of the pathnames for that file are printed, unless
 181 \fB--link\fR limits the printing to only the specified link number (starting
 182 at 0, in no particular order).  If multiple fids are specified, but only a
 183 single pathname is needed for each file, use \fB--link 0\fR.
 184 .TP
 185 .B path2fid [--parents] <path> ...
 186 Print out the FIDs for the specified \fBpath(s)\fR.  If multiple pathnames
 187 are given, then they will be printed one per line with the path as prefix.
 188 The \fB--parents\fR switch makes it output the parent FID and name(s) of the
 189 given entries. If an entry has multiple links, these are displayed on a single
 190 line, tab-separated.
 191 .TP
 192 .B pool_list
 193 .RI { filesystem }[ .poolname "] | {" pathname }
 194 List the pools in
 195 .I filesystem
 196 or
 197 .IR pathname ,
 198 or the OSTs in
 199 .IR filesystem.pool .
 200 .TP
 201 .B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g|-p <uname>|<uid>|<gname>|<gid>|<projid>] <filesystem>
 202 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).
 203 .TP
 204 .B quota -t <-u|-g|-p> <filesystem>
 205 To display block and inode grace times for user (-u) or group (-g) or project (-p) quotas
 206 .TP
 207 .B quotacheck [-ugf] <filesystem> (deprecated as of 2.4.0)
 208 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.
 209 .TP
 210 .B quotaon [-ugf] <filesystem> (deprecated as of 2.4.0)
 211 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>)
 212 .TP
 213 .B quotaoff [-ugf] <filesystem> (deprecated as of 2.4.0)
 214 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>=""
 215 .TP
 216 .B swap_layouts <filename1> <filename2>
 217 Swap the data (layout and OST objects) of two regular files. The
 218 two files have to be in the same filesystem, owned by the same user,
 219 reside on the same MDT and writable by the user.
 220
 221 Swapping the layout of two directories is not permitted.
 222 .TP
 223 .B mkdir
 224 lfs mkdir is documented in the man page: lfs-mkdir(1). NOTE:
 225 .B lfs setdirstripe
 226 is an alias of the command
 227 .B lfs mkdir
 228 .TP
 229 .B mv
 230 lfs mv is deprecated, use lfs
 231 .B migrate
 232 instead.
 233 .TP
 234 .B migrate
 235 See lfs-migrate(1).
 236 .TP
 237 .B setstripe
 238 See lfs-setstripe(1).
 239 .TP
 240 .B --version
 241 Output the build version of the lfs utility. Use "lctl lustre_build_version" to get the version of the Lustre kernel modules
 242 .TP
 243 .B --list-commands
 244 Output a list of the commands supported by the lfs utility
 245 .TP
 246 .B help
 247 Provides brief help on the various arguments
 248 .TP
 249 .B exit/quit
 250 Quit the interactive lfs session
 251 .SH EXAMPLES
 252 .TP
 253 .B $ lfs check servers
 254 Check the status of all servers (MDT, OST)
 255 .TP
 256 .B $ lfs osts
 257 List all the OSTs
 258 .TP
 259 .B $ lfs mdts
 260 List all the MDTs
 261 .TP
 262 .B $ lfs quota -u bob /mnt/lustre
 263 List quotas of user `bob'
 264 .TP
 265 .B $ lfs quota -t -u /mnt/lustre
 266 Show grace times for user quotas on /mnt/lustre
 267 .TP
 268 .B $ lfs quotachown -i /mnt/lustre
 269 Change file owner and group
 270 .TP
 271 .B $ lfs quotacheck -ug /mnt/lustre
 272 Quotacheck for user and group - will turn on quotas after making the check.
 273 .TP
 274 .B $ lfs quotaon -ug /mnt/lustre
 275 Turn quotas of user and group on
 276 .TP
 277 .B $ lfs quotaoff -ug /mnt/lustre
 278 Turn quotas of user and group off
 279 .SH NOTES
 280 The usage of \fBlfs find\fR, \fBlfs getstripe\fR, \fBlfs hsm_*\fR,
 281 \fBlfs setstripe\fR, \fBlfs migrate\fR, \fBlfs getdirstripe\fR,
 282 \fBlfs setdirstripe\fR, \fBlfs mkdir\fR, and \fBlfs project\fR are explained
 283 in separate man pages.
 284 .SH AUTHOR
 285 The lfs command is part of the Lustre filesystem.
 286 .SH SEE ALSO
 287 .BR lctl (8),
 288 .BR lfs-df (1),
 289 .BR lfs-find (1),
 290 .BR lfs-getstripe (1),
 291 .BR lfs-getdirstripe (1),
 292 .BR lfs-hsm (1),
 293 .BR lfs-mkdir (1),
 294 .BR lfs-migrate (1),
 295 .BR lfs_migrate (1),
 296 .BR lfs-project (1),
 297 .BR lfs-setdirstripe (1),
 298 .BR lfs-setquota (1),
 299 .BR lfs-setstripe (1),
 300 .BR lustre (7)