lustre/doc/lfs.1

   1 .TH lfs 1 "2009 Jan 29" Lustre "user utilities"
   2 .SH NAME
   3 lfs \- Lustre utility to create a file with specific striping pattern, find the striping pattern of existing files
   4 .SH SYNOPSIS
   5 .br
   6 .B lfs
   7 .br
   8 .B lfs changelog [--follow] <mdtname> [startrec [endrec]]
   9 .br
  10 .B lfs changelog_clear <mdtname> <id> <endrec>
  11 .br
  12 .B lfs check <mds|osts|servers>
  13 .br
  14 .B lfs df [-i] [-h] [--pool|-p <fsname>[.<pool>] [path]
  15 .br
  16 .B lfs find [[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N]
  17         \fB[[!] --ctime|-C [-+]N] [--maxdepth|-D N] [--name|-n pattern]
  18         \fB[--print|-p] \fB[--print0|-P] [[!] --obd|-O <uuid[s]>]
  19         \fB[[!] --size|-S [-+]N[kMGTPE]] [--type |-t {bcdflpsD}]
  20         \fB[[!] --gid|-g|--group|-G <gname>|<gid>]
  21         \fB[[!] --uid|-u|--user|-U <uname>|<uid>]
  22         \fB<directory|filename>\fR
  23 .br
  24 .B lfs getname [-h]|[path ...]
  25 .br
  26 .B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
  27         \fB[--count | -c ] [--index | -i | --offset | -o ]
  28         \fB[--size | -s ] [--pool | -p ] [--directory | -d ]
  29         \fB[--recursive | -r] [--raw|-R] <dirname|filename> ...\fR
  30 .br
  31 .B lfs setstripe [--size|-s stripe-size] [--count|-c stripe-cnt]
  32         \fB[--index|-i|--offset|-o start_ost_index ] [--pool|-p <pool>]
  33         \fB<directory|filename>\fR
  34 .br
  35 .B lfs setstripe -d <dir>
  36 .br
  37 .B lfs osts
  38 .RB [ path ]
  39 .br
  40 .B lfs poollist <filesystem>[.<pool>] | <pathname>
  41 .br
  42 .B lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u <uname>| -u <uid>|-g <gname>| -g <gid>] <filesystem>
  43 .br
  44 .B lfs quota -t <-u|-g> <filesystem>
  45 .br
  46 .B lfs quotacheck [-ug] <filesystem>
  47 .br
  48 .B lfs quotachown [-i] <filesystem>
  49 .br
  50 .B lfs quotaon [-ugf] <filesystem>
  51 .br
  52 .B lfs quotaoff [-ug] <filesystem>
  53 .br
  54 .B lfs quotainv [-ug] [-f] <filesystem>
  55 .br
  56 .B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
  57              \fB[--block-softlimit <block-softlimit>]
  58              \fB[--block-hardlimit <block-hardlimit>]
  59              \fB[--inode-softlimit <inode-softlimit>]
  60              \fB[--inode-hardlimit <inode-hardlimit>]
  61              \fB<filesystem>\fR
  62 .br
  63 .B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
  64              \fB[-b <block-softlimit>] [-B <block-hardlimit>]
  65              \fB[-i <inode-softlimit>] [-I <inode-hardlimit>]
  66              \fB<filesystem>\fR
  67 .br
  68 .B lfs setquota -t <-u|-g>
  69              \fB[--block-grace <block-grace>]
  70              \fB[--inode-grace <inode-grace>]
  71              \fB<filesystem>\fR
  72 .br
  73 .B lfs setquota -t <-u|-g>
  74              \fB[-b <block-grace>] [-i <inode-grace>]
  75              \fB<filesystem>\fR
  76 .br
  77 .B lfs help
  78 .SH DESCRIPTION
  79 .B lfs
  80 can be used to create a new file with a specific striping pattern, determine the default striping pattern, gather the extended attributes (object numbers and location) for a specific file. It can be invoked interactively without any arguments or in a non-interactive mode with one of the arguements supported.
  81 .SH OPTIONS
  82 The various options supported by lctl are listed and explained below:
  83 .TP
  84 .B changelog
  85 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.
  86 .TP
  87 .B changelog_clear
  88 Indicate that changelog records previous to <endrec> are no longer of
  89 interest to a particular consumer <id>, potentially allowing the MDT to
  90 free up disk space. An <endrec> of 0 indicates the current last record.
  91 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
  92 .TP
  93 .B check
  94 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
  95 .TP
  96 .B df [-i] [-h] [--pool|-p <fsname>[.<pool>] [path]
  97 Report filesystem disk space usage or inodes usage (with \fB-i\fR) of each
  98 MDT/OST, or a subset of OSTs if a pool is specified with \fB-p\fR.  By default
  99 print the usage of all mounted Lustre filesystems, otherwise if \fBpath\fR is
 100 specified print only the usage of that filesystem.  If \fB-h\fR is given, the
 101 output is printed in \fIh\fRuman readable format, using SI base-2 suffixes
 102 for \fBM\fRega-, \fBG\fRiga-, \fBT\fRera-, \fBP\fReta-, or \fBE\fRxabytes.
 103 .TP
 104 .B find
 105 To search the directory tree rooted at the given dir/file name for the files that match the given parameters: \fB--atime\fR (file was last accessed N*24 hours ago), \fB--ctime\fR (file's status was last changed N*24 hours ago), \fB--mtime\fR (file's data was last modified N*24 hours ago), \fB--obd\fR (file has an object on a specific OST or OSTs), \fB--size\fR (file has size in bytes, or \fBk\fRilo-, \fBM\fRega-, \fBG\fRiga-, \fBT\fRera-, \fBP\fReta-, or \fBE\fRxabytes if a suffix is given), \fB--type\fR (file has the type: \fBb\fRlock, \fBc\fRharacter, \fBd\fRirectory, \fBp\fRipe, \fBf\fRile, sym\fBl\fRink, \fBs\fRocket, or \fBD\fRoor (Solaris)), \fB--uid\fR (file has specific numeric user ID), \fB--user\fR (file owned by specific user, numeric user ID allowed), \fB--gid\fR (file has specific group ID), \fB--group\fR (file belongs to specific group, numeric group ID allowed). The option \fB--maxdepth\fR limits find to decend at most N levels of directory tree. The options \fB--print\fR and \fB--print0\fR print full file name, followed by a newline or NUL character correspondingly.  Using \fB!\fR before an option negates its meaning (\fIfiles NOT matching the parameter\fR).  Using \fB+\fR before a numeric value means \fIfiles with the parameter OR MORE\fR, while \fB-\fR before a numeric value means \fIfiles with the parameter OR LESS\fR.
 106 .TP
 107 .B getname [-h]|[path ...]
 108 Report all the Lustre mount points and the corresponding Lustre filesystem
 109 instance. If one or more \fBpath\fR entries are provided, then only the
 110 Lustre instance for these mount points is returned. If the path given is not on
 111 a Lustre instance 'No such device' is reported.
 112 .TP
 113 .B osts
 114 .RB [ path ]
 115 List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
 116 that is located on a lustre mounted file system then only the OSTs belonging
 117 to that filesystem are displayed.
 118 .TP
 119 .B getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
 120         \fB[--count | -c ] [--index | -i | --offset | -o  ]
 121         \fB[--pool | -p ] [--size | -s ] [--directory | -d ]
 122         \fB[--recursive | -r ] [--raw | -R ] <dirname|filename>\fR
 123 .br
 124 List the striping information for a given filename or directory tree.
 125 By default the stripe count, size, and offset will be returned. If you
 126 only want specific striping information then the options of
 127 .BR --count ,
 128 .BR --size ,
 129 .BR --index ,
 130 .BR --offset ,
 131 or
 132 .B --pool
 133 can be used to return only the specific fields.
 134 .br
 135 If the
 136 .B --raw
 137 option is specified, the stripe information is printed without substituting the
 138 filesystem's default values for unspecified fields. If the striping EA is not
 139 set, 0, 0, and -1 will be printed for the stripe count, size, and offset
 140 respectively.
 141 In the case where you only want details about the files' object id
 142 information then the
 143 .B --quiet
 144 option is used. Additional information available about striping can be
 145 displayed with
 146 .BR --verbose .
 147 The default behavior when a directory is specified is to list the striping
 148 information for all files within the specified directory (like
 149 .RB ' "ls -l" ') .
 150 This can be expanded with
 151 .B --recursive
 152 which will recurse into all subdirectories.
 153 If you wish to get striping information for only the specified directory, then
 154 .B --directory
 155 can be used to limit the information, like
 156 .RB ' "ls -d" ').
 157 You can limit the returned files to those with objects on a specific OST with
 158 .BR --obd .
 159 .TP
 160 .B setstripe [--count|-c stripe_cnt] [--size|-s stripe_size]
 161         \fB[--index|-i|--offset|-o start_ost_index] [--pool <pool>]
 162         \fB<dirname|filename>\fR
 163 .br
 164 To create a new file, or set the directory default, with the specified striping parameters.  The
 165 .I stripe_count
 166 is the number of OSTs to stripe a file over. A
 167 .I stripe_count
 168 of 0 means to use the filesystem-wide default stripe count (default 1), and a
 169 .I stripe_count
 170 of -1 means to stripe over all available OSTs.  The
 171 .I stripe_size
 172 is the number of bytes to store on each OST before moving to the next OST.  A
 173 .I stripe_size
 174 of 0 means to use the filesystem-wide default stripe size (default 1MB).  The
 175 .I start_ost_index
 176 is the OST index (starting at 0) on which to start striping for this file.  A
 177 .I start_ost_index
 178 of -1 allows the MDS to choose the starting index and it is strongly recommended, as this allows space and load balancing to be done by the MDS as needed.  The
 179 .I poolname
 180 is the name of a predefined pool of OSTs (see
 181 .B lctl
 182 ) that will be used for striping. The
 183 .IR stripe_count ,
 184 .IR stripe_size ,
 185 and
 186 .I start_ost_index
 187 will be used as well; the
 188 .I start_ost_index
 189 must be part of the pool or an error will be returned.
 190 .TP
 191 .B setstripe -d
 192 Delete the default striping on the specified directory.
 193 .TP
 194 .B poollist
 195 .RI { filesystem }[ .poolname "] | {" pathname }
 196 List the pools in
 197 .I filesystem
 198 or
 199 .IR pathname ,
 200 or the OSTs in
 201 .IR filesystem.pool .
 202 .TP
 203 .B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g <uname>|<uid>|<gname>|<gid>] <filesystem>
 204 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 both user and group are omitted quotas for current uid/gid are shown. -v provides more verbose (with per-obd statistics) output. -q disables printing of additional descriptions (including column titles).
 205 .TP
 206 .B quota -t <-u|-g> <filesystem>
 207 To display block and inode grace times for user (-u) or group (-g) quotas
 208 .TP
 209 .B quotachown
 210 To change files' owner and group on OSTs of the specified filesystem
 211 .TP
 212 .B quotacheck [-ugf] <filesystem>
 213 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)
 214 .TP
 215 .B quotaon [-ugf] <filesystem>
 216 To turn filesystem quotas on. Options specify quota for users (-u) groups (-g) and force (-f)
 217 .TP
 218 .B quotaoff [-ugf] <filesystem>
 219 To turn filesystem quotas off.  Options specify quota for users (-u) groups (-g) and force (-f)
 220 .TP
 221 .B quotainv [-ug] [-f] <filesystem>
 222 Clear quota files (administrative quota files if used without -f, operational quota files otherwise), all of their quota entries, for (-u) users or (-g) groups; after quotainv one must use quotacheck before using quotas. DO NOT USE THIS COMMAND UNLESS YOU REALLY KNOW WHAT IT DOES. IT IS MAINLY FOR INTERNAL PURPOSES.
 223 .TP
 224 .B setquota  <-u|-g> <uname>|<uid>|<gname>|<gid> [--block-softlimit <block-softlimit>] [--block-hardlimit <block-hardlimit>] [--inode-softlimit <inode-softlimit>] [--inode-hardlimit <inode-hardlimit>] <filesystem>
 225 To set filesystem quotas for users or groups. Limits can be specified with -b, -k, -m, -g, -t, -p suffixes which specify units of 1, 2^10, 2^20, 2^30, 2^40 and 2^50 accordingly. Block limits unit is kilobyte (1024) by default and block limits are always kilobyte-grained (even if specified in bytes), see EXAMPLES
 226 .TP
 227 .B setquota -t [-u|-g] [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
 228 To set filesystem quota grace times for users or groups. Grace time is specified in "XXwXXdXXhXXmXXs" format or as an integer seconds value, see EXAMPLES
 229 .TP
 230 .B help
 231 Provides brief help on the various arguments
 232 .TP
 233 .B exit/quit
 234 Quit the interactive lfs session
 235 .SH EXAMPLES
 236 .TP
 237 .B $ lfs setstripe -s 128k -c 2 /mnt/lustre/file1
 238 This creates a file striped on two OSTs with 128kB on each stripe.
 239 .TP
 240 .B $ lfs setstripe -d /mnt/lustre/dir
 241 This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein.
 242 .TP
 243 .B $ lfs getstripe -v /mnt/lustre/file1
 244 Lists the detailed object allocation of a given file
 245 .TP
 246 .B $ lfs find /mnt/lustre
 247 Efficiently lists all files in a given directory and its subdirectories
 248 .TP
 249 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
 250 Recursively list all regular files in given directory more than 30 days old
 251 .TP
 252 .B $ lfs find --obd OST2-UUID /mnt/lustre/
 253 Recursively list all files in a given directory that have objects on OST2-UUID.
 254 .tP
 255 .B $ lfs check servers
 256 Check the status of all servers (MDT, OST)
 257 .TP
 258 .B $ lfs osts
 259 List all the OSTs
 260 .TP
 261 .B $ lfs df -h
 262 Lists space usage per OST and MDT in human readable format.
 263 .TP
 264 .B $ lfs df -i
 265 Lists inode usage per OST and MDT
 266 .TP
 267 .B $ lfs df --pool <filesystem>[.<pool>] | <pathname>
 268 List space or inode usage for a specific OST pool
 269 .TP
 270 .B $ lfs quota -u bob /mnt/lustre
 271 List quotas of user `bob'
 272 .TP
 273 .B $ lfs quota -t -u /mnt/lustre
 274 Show grace times for user quotas on /mnt/lustre
 275 .TP
 276 .B $ lfs quotachown -i /mnt/lustre
 277 Change file owner and group
 278 .TP
 279 .B $ lfs quotacheck -ug /mnt/lustre
 280 Quotacheck for user and group - will turn on quotas after making the check.
 281 .TP
 282 .B $ lfs quotaon -ug /mnt/lustre
 283 Turn quotas of user and group on
 284 .TP
 285 .B $ lfs quotaoff -ug /mnt/lustre
 286 Turn quotas of user and group off
 287 .TP
 288 .B $ lfs setquota -u bob --block-softlimit 2000000 --block-hardlimit 1000000 /mnt/lustre
 289 Set quotas of user `bob': 1GB block quota hardlimit and 2 GB block quota softlimit
 290 .TP
 291 .B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
 292 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
 293 .SH BUGS
 294 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
 295 Report bugs using http://bugzilla.lustre.org.
 296 .SH AUTHOR
 297 The lfs command is part of the Lustre filesystem.  Contact http://www.lustre.org/
 298 .SH SEE ALSO
 299 .BR lctl (8),
 300 .BR lustre (7)