lustre/doc/lfs.1

   1 .TH lfs 1 "2008 Mar 15" Lustre "user utilities"
   2 .SH NAME
   3 lfs \- Lustre utility to create a file with specific striping pattern, find the striping pattern of exiting files
   4 .SH SYNOPSIS
   5 .br
   6 .B lfs
   7 .br
   8 .B lfs check <mds|osts|servers>
   9 .br
  10 .B lfs df [-i] [-h] [path]
  11 .br
  12 .B lfs find [[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N]
  13         \fB[[!] --ctime|-C [-+]N] [--maxdepth|-D N] [--name|-n pattern]
  14         \fB[--print|-p] \fB[--print0|-P] [--obd|-O <uuid[s]>]
  15         \fB[[!] --size|-S [-+]N[kMGTPE]] [--type |-t {bcdflpsD}]
  16         \fB[[!] --gid|-g N] [[!] --group|-G <name>]
  17         \fB[[!] --uid|-u N] [[!] --user|-U <name>]
  18         \fB<dirname|filename>\fR
  19 .br
  20 .B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
  21               \fB[--recursive|-r] <dirname|filename>\fR
  22 .br
  23 .B lfs setstripe [--size|-s stripe-size] [--count|-c stripe-cnt]
  24               \fB[--index|-i start-ost] <filename|dirname>\fR
  25 .br
  26 .B lfs setstripe -d <dirname>
  27 .br
  28 .B lfs quotachown [-i] <filesystem>
  29 .br
  30 .B lfs quotacheck [-ug] <filesystem>
  31 .br
  32 .B lfs quotaon [-ugf] <filesystem>
  33 .br
  34 .B lfs quotaoff [-ug] <filesystem>
  35 .br
  36 .B lfs quotainv [-ug] [-f] <filesystem>
  37 .br
  38 .B lfs setquota [-u|--user|-g|--group] <username|groupname>
  39              \fB[--block-softlimit <block-softlimit>]
  40              \fB[--block-hardlimit <block-hardlimit>]
  41              \fB[--inode-softlimit <inode-softlimit>]
  42              \fB[--inode-hardlimit <inode-hardlimit>]
  43              \fB<filesystem>\fR
  44 .br
  45 .B lfs setquota [-u|--user|-g|--group] <username|groupname>
  46              \fB[-b <block-softlimit>] [-B <block-hardlimit>]
  47              \fB[-i <inode-softlimit>] [-I <inode-hardlimit>]
  48              \fB<filesystem>\fR
  49 .br
  50 .B lfs setquota -t [-u|-g]
  51              \fB[--block-grace <block-grace>]
  52              \fB[--inode-grace <inode-grace>]
  53              \fB<filesystem>\fR
  54 .br
  55 .B lfs setquota -t [-u|-g]
  56              \fB[-b <block-grace>] [-i <inode-grace>]
  57              \fB<filesystem>\fR
  58 .br
  59
  60 .B lfs quota [-o obd_uuid] [-u|-g] <username|groupname> <filesystem>
  61 .br
  62 .B lfs quota -t [-u|-g] <filesystem>
  63 .br
  64 .B lfs help
  65 .SH DESCRIPTION
  66 .B lfs
  67 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.
  68 .SH OPTIONS
  69 The various options supported by lctl are listed and explained below:
  70 .TP
  71 .B check
  72 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
  73 .TP
  74 .B df
  75 Report filesystem disk space usage or inodes usage of each MDT/OST.
  76 .TP
  77 .B find
  78 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 allows 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.
  79 .TP
  80 .B getstripe
  81 To list the striping info for a given filename or files in a directory, optionally recursively, for all files in a directory tree: \fB--quiet\fR (don't print object IDs), \fB--verbose\fR (print striping parameters), \fB--recursive\fR (recurse into subdirectories).
  82 .TP
  83 .B osts
  84 List all the OSTs for the filesystem
  85 .TP
  86 .B setstripe [--size stripe-size] [--count stripe-cnt] [--index start-ost]
  87 To create a new file, or set the directory default, with the specified striping parameters.  The
  88 .I stripe-count
  89 is the number of OSTs to stripe a file over. A
  90 .I stripe-count
  91 of 0 means to use the filesystem-wide default stripe count (default 1), and a
  92 .I stripe-count
  93 of -1 means to stripe over all available OSTs.  The
  94 .I stripe-size
  95 is the number of bytes to store on each OST before moving to the next OST.  A
  96 .I stripe-size
  97 of 0 means to use the filesystem-wide default stripe size (default 1MB).  The
  98 .I start-ost
  99 is the OST index (starting at 0) on which to start striping for this file.  A
 100 .I start-ost
 101 of -1 allows the MDS to specify the starting index and it is strongly
 102 recommended that the starting OST not be given, as this allows space and
 103 load balancing to be done by the MDS as needed.
 104 .TP
 105 .B lfs setstripe -d
 106 Delete the default striping on the specified directory.
 107 .TP
 108 .B quotachown
 109 To change files' owner and group on OSTs of the specified filesystem
 110 .TP
 111 .B quotacheck [-ugf] <filesystem>
 112 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)
 113 .TP
 114 .B quotaon [-ugf] <filesystem>
 115 To turn filesystem quotas on. Options specify quota for users (-u) groups (-g) and force (-f)
 116 .TP
 117 .B quotaoff [-ugf] <filesystem>
 118 To turn filesystem quotas off.  Options specify quota for users (-u) groups (-g) and force (-f)
 119 .TP
 120 .B quotainv [-ug] [-f] <filesystem>
 121 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.
 122 .TP
 123 .B setquota  [-u|-g] <name> [--block-softlimit <block-softlimit>] [--block-hardlimit <block-hardlimit>] [--inode-softlimit <inode-softlimit>] [--inode-hardlimit <inode-hardlimit>] <filesystem>
 124 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
 125 .TP
 126 .B setquota -t [-u|-g] [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
 127 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
 128 .TP
 129 .B quota [-o obd_uuid] [-u|-g] <username|groupname> <filesystem>
 130 To display disk usage and limits, either for the full filesystem, or for objects on a specific obd. A user or group name must be specified.
 131 .TP
 132 .B quota -t [-u|-g] <filesystem>
 133 To display block and inode grace times for user (-u) or group (-g) quotas
 134 .TP
 135 .B help
 136 Provides brief help on the various arguments
 137 .TP
 138 .B exit/quit
 139 Quit the interactive lfs session
 140 .SH EXAMPLES
 141 .TP
 142 .B $ lfs setstripe -s 128k -c 2 /mnt/lustre/file1
 143 This creates a file striped on two OSTs with 128kB on each stripe.
 144 .TP
 145 .B $ lfs setstripe -d /mnt/lustre/dir
 146 This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein.
 147 .TP
 148 .B $ lfs getstripe -v /mnt/lustre/file1
 149 Lists the detailed object allocation of a given file
 150 .TP
 151 .B $ lfs find /mnt/lustre
 152 Efficiently lists all files in a given directory and its subdirectories
 153 .TP
 154 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
 155 Recursively list all regular files in given directory more than 30 days old
 156 .TP
 157 .B $ lfs find --obd OST2-UUID /mnt/lustre/
 158 Recursively list all files in a given directory that have objects on OST2-UUID.
 159 .tP
 160 .B $ lfs check servers
 161 Check the status of all servers (MDT, OST)
 162 .TP
 163 .B $ lfs osts
 164 List all the OSTs
 165 .TP
 166 .B $ lfs df -h
 167 Lists space usage per OST and MDT in human readable format.
 168 .TP
 169 .B $ lfs df -i
 170 Lists inode usage per OST and MDT
 171 .TP
 172 .B $ lfs quotachown -i /mnt/lustre
 173 Change file owner and group
 174 .TP
 175 .B $ lfs quotacheck -ug /mnt/lustre
 176 Quotacheck for user and group - will turn on quotas after making the check.
 177 .TP
 178 .B $ lfs quotaon -ug /mnt/lustre
 179 Turn quotas of user and group on
 180 .TP
 181 .B $ lfs quotaoff -ug /mnt/lustre
 182 Turn quotas of user and group off
 183 .TP
 184 .B $ lfs setquota -u bob --block-softlimit 2000000 --block-hardlimit 1000000 /mnt/lustre
 185 Set quotas of user `bob': 1GB block quota hardlimit and 2 GB block quota softlimit
 186 .TP
 187 .B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
 188 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
 189 .TP
 190 .B $ lfs quota -u bob /mnt/lustre
 191 List quotas of user `bob'
 192 .TP
 193 .B $ lfs quota -t -u /mnt/lustre
 194 Show grace times for user quotas on /mnt/lustre
 195 .SH BUGS
 196 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
 197 Report bugs using http://bugzilla.lustre.org.
 198 .SH AUTHOR
 199 The lfs command is part of the Lustre filesystem.  Contact info@clusterfs.com.
 200 .SH SEE ALSO
 201 .BR lctl (8),
 202 .BR lustre (7)