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 quota <-U|-G|-P> <filesystem>
 111 .br
 112 .B lfs quotaon [-ugf] <filesystem>
 113 .br
 114 .B lfs quotaoff [-ug] <filesystem>
 115 .br
 116 .B lfs setstripe [--stripe-size|-S <size>] [--stripe-count|-c <count>]
 117         \fB[--stripe-index|-i <start_ost_index>] [--pool|-p <poolname>]
 118         \fB[--ost-list|-o <ost_indices>] <directory|filename>\fR
 119 .br
 120 .B lfs setstripe -d <dir>
 121 .br
 122 .B lfs setstripe --component-end|-E <end1> [STRIPE_OPTIONS]
 123      [\fB--component-end|-E <end2> [STRIPE_OPTIONS]] ... <filename>\fR
 124 .br
 125 .B lfs setstripe --component-add --component-end|-E <end1> [STRIPE_OPTIONS]
 126      \fB<--component-end|-E <end2>> [STRIPE_OPTIONS]] ... <filename>\fR
 127 .br
 128 .B lfs setstripe --component-del {--component-id|-I id |
 129      \fB--component-flags <flags>} <filename>
 130 .br
 131 .B lfs setstripe --yaml=<yaml_template_file> <filename>
 132 .br
 133 .B lfs --version
 134 .br
 135 .B lfs --list-commands
 136 .br
 137 .B lfs help
 138 .SH DESCRIPTION
 139 .B lfs
 140 can be used to create a new file with a specific striping pattern, determine
 141 the default striping pattern, gather the extended attributes (object numbers
 142 and location) for a specific file. It can be invoked interactively without any
 143 arguments or in a non-interactive mode with one of the arguments supported.
 144 .SH OPTIONS
 145 The various options supported by lfs are listed and explained below:
 146 .TP
 147 .B changelog
 148 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.
 149 .TP
 150 .B changelog_clear
 151 Indicate that changelog records previous to <endrec> are no longer of
 152 interest to a particular consumer <id>, potentially allowing the MDT to
 153 free up disk space. An <endrec> of 0 indicates the current last record.
 154 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
 155 .TP
 156 .B check
 157 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
 158 .TP
 159 .B data_version [-n] <filename>
 160 Display current version of file data. If -n is specified, data version is read
 161 without taking lock. As a consequence, data version could be outdated if there
 162 is dirty caches on filesystem clients, but this will not force data flushes and
 163 has less impact on filesystem.
 164
 165 Even without -n, race conditions are possible and data version should be
 166 checked before and after an operation to be confident the data did not change
 167 during it.
 168 .TP
 169 .B getname [-h]|[path ...]
 170 Report all the Lustre mount points and the corresponding Lustre filesystem
 171 instance. If one or more \fBpath\fR entries are provided, then only the
 172 Lustre instance for these mount points is returned. If the path given is not on
 173 a Lustre instance 'No such device' is reported.
 174 .TP
 175 .B osts
 176 .RB [ path ]
 177 List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
 178 that is located on a lustre mounted file system then only the OSTs belonging
 179 to that filesystem are displayed.
 180 .TP
 181 .B fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
 182 Print out the pathname(s) for the specified \fIfid\fR(s) from the filesystem
 183 mounted at \fBrootpath\fR or named \fBfsname\fR.  If a file has multiple
 184 hard links, then all of the pathnames for that file are printed, unless
 185 \fB--link\fR limits the printing to only the specified link number (starting
 186 at 0, in no particular order).  If multiple fids are specified, but only a
 187 single pathname is needed for each file, use \fB--link 0\fR.
 188 .TP
 189 .B path2fid [--parents] <path> ...
 190 Print out the FIDs for the specified \fBpath(s)\fR.  If multiple pathnames
 191 are given, then they will be printed one per line with the path as prefix.
 192 The \fB--parents\fR switch makes it output the parent FID and name(s) of the
 193 given entries. If an entry has multiple links, these are displayed on a single
 194 line, tab-separated.
 195 .TP
 196 .B pool_list
 197 .RI { filesystem }[ .poolname "] | {" pathname }
 198 List the pools in
 199 .I filesystem
 200 or
 201 .IR pathname ,
 202 or the OSTs in
 203 .IR filesystem.pool .
 204 .TP
 205 .B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g|-p <uname>|<uid>|<gname>|<gid>|<projid>] <filesystem>
 206 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).
 207 .TP
 208 .B quota -t <-u|-g|-p> <filesystem>
 209 To display block and inode grace times for user (-u) or group (-g) or project (-p) quotas
 210 .TP
 211 .B quotacheck [-ugf] <filesystem> (deprecated as of 2.4.0)
 212 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.
 213 .TP
 214 .B quotaon [-ugf] <filesystem> (deprecated as of 2.4.0)
 215 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>)
 216 .TP
 217 .B quotaoff [-ugf] <filesystem> (deprecated as of 2.4.0)
 218 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>=""
 219 .TP
 220 .B swap_layouts <filename1> <filename2>
 221 Swap the data (layout and OST objects) of two regular files. The
 222 two files have to be in the same filesystem, owned by the same user,
 223 reside on the same MDT and writable by the user.
 224
 225 Swapping the layout of two directories is not permitted.
 226 .TP
 227 .B mkdir
 228 lfs mkdir is documented in the man page: lfs-mkdir(1). NOTE:
 229 .B lfs setdirstripe
 230 is an alias of the command
 231 .B lfs mkdir
 232 .TP
 233 .B mv
 234 lfs mv is deprecated, use lfs
 235 .B migrate
 236 instead.
 237 .TP
 238 .B migrate
 239 See lfs-migrate(1).
 240 .TP
 241 .B setstripe
 242 See lfs-setstripe(1).
 243 .TP
 244 .B --version
 245 Output the build version of the lfs utility. Use "lctl lustre_build_version" to get the version of the Lustre kernel modules
 246 .TP
 247 .B --list-commands
 248 Output a list of the commands supported by the lfs utility
 249 .TP
 250 .B help
 251 Provides brief help on the various arguments
 252 .TP
 253 .B exit/quit
 254 Quit the interactive lfs session
 255 .SH EXAMPLES
 256 .TP
 257 .B $ lfs check servers
 258 Check the status of all servers (MDT, OST)
 259 .TP
 260 .B $ lfs osts
 261 List all the OSTs
 262 .TP
 263 .B $ lfs mdts
 264 List all the MDTs
 265 .TP
 266 .B $ lfs quota -u bob /mnt/lustre
 267 List quotas of user `bob'
 268 .TP
 269 .B $ lfs quota -U /mnt/lustre
 270 List user quotas of system default setting
 271 .TP
 272 .B $ lfs quota -t -u /mnt/lustre
 273 Show grace times for user quotas on /mnt/lustre
 274 .TP
 275 .B $ lfs quotachown -i /mnt/lustre
 276 Change file owner and group
 277 .TP
 278 .B $ lfs quotacheck -ug /mnt/lustre
 279 Quotacheck for user and group - will turn on quotas after making the check.
 280 .TP
 281 .B $ lfs quotaon -ug /mnt/lustre
 282 Turn quotas of user and group on
 283 .TP
 284 .B $ lfs quotaoff -ug /mnt/lustre
 285 Turn quotas of user and group off
 286 .SH NOTES
 287 The usage of \fBlfs find\fR, \fBlfs getstripe\fR, \fBlfs hsm_*\fR,
 288 \fBlfs setstripe\fR, \fBlfs migrate\fR, \fBlfs getdirstripe\fR,
 289 \fBlfs setdirstripe\fR, \fBlfs mkdir\fR, and \fBlfs project\fR are explained
 290 in separate man pages.
 291 .SH AUTHOR
 292 The lfs command is part of the Lustre filesystem.
 293 .SH SEE ALSO
 294 .BR lctl (8),
 295 .BR lfs-df (1),
 296 .BR lfs-find (1),
 297 .BR lfs-getstripe (1),
 298 .BR lfs-getdirstripe (1),
 299 .BR lfs-hsm (1),
 300 .BR lfs-mkdir (1),
 301 .BR lfs-migrate (1),
 302 .BR lfs_migrate (1),
 303 .BR lfs-project (1),
 304 .BR lfs-setdirstripe (1),
 305 .BR lfs-setquota (1),
 306 .BR lfs-setstripe (1),
 307 .BR lustre (7)