Whamcloud - gitweb
LUDOC-103 version: mds-survey is now marked as 2.2 and beyond.
[doc/manual.git] / UserUtilities.xml
index cfad87e..5587608 100644 (file)
@@ -34,48 +34,51 @@ lfs changelog [--follow] <mdtname> [startrec [endrec]]
 lfs changelog_clear <mdtname> <id> <endrec>
 lfs check <mds|osts|servers>
 lfs df [-i] [-h] [--pool]-p <fsname>[.<pool>] [path]
-lfs find [[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N] 
-   [[!] --ctime|-C [-+]N] [--maxdepth|-D N] [--name|-n <pattern>]
-   [--print|-p] [--print0|-P] [[!] --obd|-O <uuid[s]>] 
-   [[!] --size|-S [+-]N[kMGTPE]] --type |-t {bcdflpsD}]
-   [[!] --gid|-g|--group|-G <gname>|<gid>]
-   [[!] --uid|-u|--user|-U <uname>|<uid>]
-   <dirname|filename>
-lfs osts [path]
+lfs find [[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N]
+         [[!] --ctime|-C [-+]N] [--maxdepth|-D N] [--name|-n <pattern>]
+         [--print|-p] [--print0|-P] [[!] --obd|-O <uuid[s]>]
+         [[!] --size|-S [+-]N[kMGTPE]] --type |-t {bcdflpsD}]
+         [[!] --gid|-g|--group|-G <gname>|<gid>]
+         [[!] --uid|-u|--user|-U <uname>|<uid>]
+         <dirname|filename>
+lfs getname [-h]|[path...]
 lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
-                   [--count|-c] [--index|-i | --offset|-o]
-                   [--size|-s] [--pool|-p] [--directory|-d]
-                   [--recursive|-r] <dirname|filename> ...
-lfs setstripe              [--size|-s stripe_size] [--count|-c stripe_cnt] 
-           [--index|-i|--offset|-o start_ost_index] 
-           [--pool|-p <pool>]
-           <dirname|filename>
+              [--count|-c] [--index|-i | --offset|-o]
+              [--size|-s] [--pool|-p] [--directory|-d]
+              [--recursive|-r] [--raw|-R] <dirname|filename> ...
+lfs setstripe [--size|-s stripe_size] [--count|-c stripe_cnt]
+              [--index|-i|--offset|-o start_ost_index]
+              [--pool|-p <pool>]
+              <dirname|filename>
 lfs setstripe -d <dir>
+lfs osts [path]
 lfs poollist <filesystem>[.<pool>]|<pathname>
-lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u <uname>| -u <uid>|-g <gname>| -g <gid>] <filesystem>
+lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx]
+          [-u <uname>|-u <uid>|-g <gname>|-g <gid>]
+          <filesystem>
 lfs quota -t <-u|-g> <filesystem>
 lfs quotacheck [-ug] <filesystem>
 lfs quotachown [-i] <filesystem>
+lfs quotainv [-ug] [-f] <filesystem>
 lfs quotaon [-ugf] <filesystem>
 lfs quotaoff [-ug] <filesystem>
-lfs quotainv [-ug] [-f] <filesystem>
-lfs setquota               <-u|--user|-g|--group> <uname|uid|gname|gid>
-                   [--block-softlimit <block-softlimit>]
-                   [--block-hardlimit <block-hardlimit>]
-                   [--inode-softlimit <inode-softlimit>]
-                   [--inode-hardlimit <inode-hardlimit>]
-                   <filesystem>
 lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
-           [-b <block-softlimit>] [-B <block-hardlimit>]
-           [-i <inode-softlimit>] [-I <inode-hardlimit>] 
-           <filesystem>
+             [--block-softlimit <block-softlimit>]
+             [--block-hardlimit <block-hardlimit>]
+             [--inode-softlimit <inode-softlimit>]
+             [--inode-hardlimit <inode-hardlimit>]
+             <filesystem>
+lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
+             [-b <block-softlimit>] [-B <block-hardlimit>]
+             [-i <inode-softlimit>] [-I <inode-hardlimit>]
+             <filesystem>
 lfs setquota -t <-u|-g>
-           [--block-grace <block-grace>]
-           [--inode-grace <inode-grace>]
-           <filesystem>
+             [--block-grace <block-grace>]
+             [--inode-grace <inode-grace>]
+             <filesystem>
 lfs setquota -t <-u|-g>
-           [-b <block-grace>] [-i <inode-grace>]
-           <filesystem>
+             [-b <block-grace>] [-i <inode-grace>]
+             <filesystem>
 lfs help
 </screen>
       <note>
@@ -290,11 +293,21 @@ lfs help
             </row>
             <row>
               <entry nameend="c2" namest="c1">
+                <para> <literal>getname [path...]</literal></para>
+              </entry>
+              <entry>
+                  <para>List each Lustre instance associated with each Lustre mount point.
+                      If no path is specified, all Lustre mounts points are interrogated. If a list of paths is provided, the instance of each path is provided. If the path is not a Lustre instance 'No such device' is returned.</para>
+              </entry>
+            </row>
+            <row>
+              <entry nameend="c2" namest="c1">
                 <para> <literal>getstripe</literal></para>
               </entry>
               <entry>
                 <para>Lists striping information for a given filename or directory. By default, the stripe count, stripe size and offset are returned.</para>
                 <para>If you only want specific striping information, then the options of <literal>--count</literal>,<literal>--size</literal>,<literal>--index</literal> or <literal>--offset</literal> plus various combinations of these options can be used to retrieve specific information.</para>
+                <para>If the <literal>--raw</literal> option is specified, the stripe information is printed without substituting the filesystem's default values for unspecified fields. If the striping EA is not set, 0, 0, and -1 will be printed for the stripe count, size, and offset respectively.</para>
               </entry>
             </row>
             <row>
@@ -425,7 +438,7 @@ lfs help
                 <para> <literal>--count stripe_cnt</literal></para>
               </entry>
               <entry>
-                <para>Number of OSTs over which to stripe a file. A <literal>stripe_cnt</literal> of 0 uses the file system-wide default stripe count (default is 1). A <literal>stripe_cnt</literal> of -1 stripes over all available OSTs, and normally results in a file with 80 stripes.</para>
+                <para>Number of OSTs over which to stripe a file. A <literal>stripe_cnt</literal> of 0 uses the file system-wide default stripe count (default is 1). A <literal>stripe_cnt</literal> of -1 stripes over all available OSTs.</para>
               </entry>
             </row>
             <row>
@@ -585,6 +598,8 @@ lfs help
       <screen>$ lfs setstripe -d /mnt/lustre/dir</screen>
       <para>Lists the detailed object allocation of a given file.</para>
       <screen>$ lfs getstripe -v /mnt/lustre/file1</screen>
+      <para>List all the mounted lustre filesystems and corresponding Lustre instances.</para>
+      <screen>$ lfs getname</screen>
       <para>Efficiently lists all files in a given directory and its subdirectories.</para>
       <screen>$ lfs find /mnt/lustre</screen>
       <para>Recursively lists all regular files in a given directory more than 30 days old.</para>
@@ -851,7 +866,7 @@ lfs help
     <section remap="h5">
       <title>Description</title>
       <para>The <literal>lfsck</literal> utility is used to check and repair the distributed coherency of a Lustre file system. If an MDS or an OST becomes corrupt, run a distributed check on the file system to determine what sort of problems exist. Use lfsck to correct any defects found.</para>
-      <para>For more information on using <literal>e2fsck</literal> and <literal>lfsck</literal>, including examples, see <xref linkend="dbdoclet.50438268_83826"/> (Commit on Share). For information on resolving orphaned objects, see <xref linkend="dbdoclet.50438225_13916"/> (Working with Orphaned Objects).</para>
+      <para>For more information on using <literal>e2fsck</literal> and <literal>lfsck</literal>, including examples, see <xref linkend="commitonshare"/> (Commit on Share). For information on resolving orphaned objects, see <xref linkend="dbdoclet.50438225_13916"/> (Working with Orphaned Objects).</para>
     </section>
   </section>
   <section xml:id="dbdoclet.50438206_75125">