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