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