-<?xml version='1.0' encoding='UTF-8'?>
-<!-- This document was created with Syntext Serna Free. --><chapter xmlns="http://docbook.org/ns/docbook" xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en-US" xml:id="userutilities">
+<?xml version='1.0' encoding='UTF-8'?><chapter xmlns="http://docbook.org/ns/docbook" xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en-US" xml:id="userutilities">
<title xml:id="userutilities.title">User Utilities</title>
<para>This chapter describes user utilities and includes the following sections:</para>
<itemizedlist>
lfs changelog [--follow] <replaceable>mdt_name</replaceable> [startrec [endrec]]
lfs changelog_clear <replaceable>mdt_name id endrec</replaceable>
lfs check <replaceable>mds|osts|servers</replaceable>
-lfs df [-i] [-h] [--pool]-p <replaceable>fsname</replaceable>[.<replaceable>pool</replaceable>] [<replaceable>path</replaceable>]
+lfs df [-i] [-h] [--pool]-p <replaceable>fsname</replaceable>[.<replaceable>pool</replaceable>] [<replaceable>path</replaceable>] [--lazy]
lfs find [[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N]
[[!] --ctime|-C [-+]N] [--maxdepth|-D N] [--name|-n <replaceable>pattern</replaceable>]
[--print|-p] [--print0|-P] [[!] --obd|-O <replaceable>ost_name</replaceable>[,<replaceable>ost_name...</replaceable>]]
lfs setstripe -d <replaceable>dir</replaceable>
lfs osts [path]
lfs poollist <replaceable>filesystem</replaceable>[.<replaceable>pool</replaceable>]|<replaceable>pathname</replaceable>
-lfs quota [-q] [-v] [-o <replaceable>obd_uuid</replaceable>|-I <replaceable>ost_idx</replaceable>|-i <replaceable>mdt_idx</replaceable>]
+lfs quota [-q] [-v] [-h] [-o <replaceable>obd_uuid</replaceable>|-I <replaceable>ost_idx</replaceable>|-i <replaceable>mdt_idx</replaceable>]
[-u <replaceable>username|uid|-g</replaceable> <replaceable>group|gid</replaceable>]
<replaceable>/mount_point</replaceable>
lfs quota -t -u|-g <replaceable>/mount_point</replaceable>
<para>The various <literal>lfs</literal> options are listed and described below. For a complete list of available options, type help at the <literal>lf</literal>s prompt.</para>
<informaltable frame="all">
<tgroup cols="3">
- <colspec colname="c1" colwidth="33*"/>
- <colspec colname="c2" colwidth="33*"/>
- <colspec colname="c3" colwidth="33*"/>
+ <colspec colname="c1" colwidth="20*"/>
+ <colspec colname="c2" colwidth="30*"/>
+ <colspec colname="c3" colwidth="50*"/>
<thead>
<row>
<entry nameend="c2" namest="c1">
</row>
<row>
<entry nameend="c2" namest="c1">
- <literal> df [-i] [-h] [--pool|-p <replaceable>fsname</replaceable>[.<replaceable>pool</replaceable>] [<replaceable>path</replaceable>] </literal>
- </entry>
- <entry>
- <para>Report file system disk space usage or inode usage (with <literal>-i</literal>) of each MDT/OST or a subset of OSTs if a pool is specified with <literal>-p</literal>. By default, prints the usage of all mounted Lustre file systems. Otherwise, if path is specified, prints only the usage of that file system. If <literal>-h</literal> is given, the output is printed in human-readable format, using SI base-2 suffixes for <emphasis role="bold">M</emphasis>ega-, <emphasis role="bold">G</emphasis>iga-, <emphasis role="bold">T</emphasis>era-, <emphasis role="bold">P</emphasis>eta-, or <emphasis role="bold">E</emphasis>xabytes.</para>
+ <literal> df [-i] [-h] [--pool|-p
+ <replaceable>fsname</replaceable>[.<replaceable>pool</replaceable>]
+ [<replaceable>path</replaceable>] [--lazy]</literal>
+ </entry>
+ <entry>
+ <para>Use <literal>-i</literal> to report file system disk space usage or inode
+ usage of each MDT or OST or, if a pool is specified with the <literal>-p</literal>
+ option, a subset of OSTs.</para>
+ <para>By default, the usage of all mounted Lustre file systems is reported. If the
+ <literal>path</literal> option is included, only the usage for the specified
+ file system is reported. If the <literal>-h</literal> option is included, the
+ output is printed in human-readable format, using SI base-2 suffixes for <emphasis
+ role="bold">M</emphasis>ega-, <emphasis role="bold">G</emphasis>iga-, <emphasis
+ role="bold">T</emphasis>era-, <emphasis role="bold">P</emphasis>eta-, or
+ <emphasis role="bold">E</emphasis>xabytes.</para>
+ <para>If the <literal>--lazy</literal> option is specified, any OST that is
+ currently disconnected from the client will be skipped. Using the
+ <literal>--lazy</literal> option prevents the <literal>df</literal> output from
+ being blocked when an OST is offline. Only the space on the OSTs that can
+ currently be accessed are returned. The <literal>llite.*.lazystatfs</literal>
+ tunable can be enabled to make this the default behaviour for all
+ <literal>statfs()</literal> operations.</para>
</entry>
</row>
<row>
</entry>
<entry>
<para>File was last accessed N*24 hours ago. (There is no guarantee that <literal>atime</literal> is kept coherent across the cluster.)</para>
- <para>OSTs store a transient <literal>atime</literal> that is updated when clients do read requests. Permanent <literal>atime</literal> is written to the MDS when the file is closed. However, on-disk atime is only updated if it is more than 60 seconds old (<literal>/proc/fs/lustre/mds/*/max_atime_diff</literal>). Lustre considers the latest <literal>atime</literal> from all OSTs. If a <literal>setattr</literal> is set by user, then it is updated on both the MDS and OST, allowing the <literal>atime</literal> to go backward.</para>
+ <para>OSTs store a transient <literal>atime</literal> that is updated when clients
+ do read requests. Permanent <literal>atime</literal> is written to the MDS when
+ the file is closed. However, on-disk atime is only updated if it is more than 60
+ seconds old (<literal>/proc/fs/lustre/mds/*/max_atime_diff</literal>). The Lustre
+ software considers the latest <literal>atime</literal> from all OSTs. If a
+ <literal>setattr</literal> is set by user, then it is updated on both the MDS
+ and OST, allowing the <literal>atime</literal> to go backward.</para>
</entry>
</row>
<row>
<para> <literal>--type</literal></para>
</entry>
<entry>
- <para>File has the type (block, character, directory, pipe, file, symlink, socket or Door [Solaris]).</para>
+ <para>File has the type - block, character, directory, pipe, file, symlink, socket
+ or door (used in Solaris operating system).</para>
</entry>
</row>
<row>
<para> <literal>osts [path]</literal></para>
</entry>
<entry>
- <para>Lists all OSTs for the file system. If a path located on a Lustre-mounted file system is specified, then only OSTs belonging to this file system are displayed.</para>
+ <para>Lists all OSTs for the file system. If a path located on a mounted Lustre file
+ system is specified, then only OSTs belonging to this file system are
+ displayed.</para>
</entry>
</row>
<row>
<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>
+ <para>List each Lustre file system instance associated with each Lustre mount
+ point. If no path is specified, all Lustre mount 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>
<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>
+ <para>If the <literal>--raw</literal> option is specified, the stripe information is
+ printed without substituting the file system 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>
<para condition='l24'>The <literal>-M</literal> prints the index of the MDT for a given directory. See <xref linkend='dbdoclet.rmremotedir'/>.</para>
</entry>
</row>
</entry>
<entry>
<para>Sets file system quotas for users or groups. Limits can be specified with <literal>--{block|inode}-{softlimit|hardlimit}</literal> or their short equivalents <literal>-b</literal>, <literal>-B</literal>, <literal>-i</literal>, <literal>-I</literal>. Users can set 1, 2, 3 or 4 limits.<footnote>
- <para>The old <literal>setquota</literal> interface is supported, but it may be removed in a future Lustre release.</para>
+ <para>The old <literal>setquota</literal> interface is supported, but it may be
+ removed in a future Lustre software release.</para>
</footnote>Also, limits can be specified with special suffixes, -b, -k, -m, -g, -t, and -p to indicate units of 1, 2^10, 2^20, 2^30, 2^40 and 2^50, respectively. By default, the block limits unit is 1 kilobyte (1,024), and block limits are always kilobyte-grained (even if specified in bytes). See <xref linkend="dbdoclet.50438206_11903"/>.</para>
</entry>
</row>
<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>
+ <para>List all the mounted Lustre file systems 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>
<screen>$ lfs df --pool <replaceable>filesystem</replaceable>[.<replaceable>pool</replaceable>] | <replaceable>pathname</replaceable></screen>
<para>List quotas of user 'bob'.</para>
<screen>$ lfs quota -u bob /mnt/lustre</screen>
- <para>Show grace times for user quotas on /mnt/lustre.</para>
+ <para>Show grace times for user quotas on <literal>/mnt/lustre</literal>.</para>
<screen>$ lfs quota -t -u /mnt/lustre</screen>
<para>Changes file owner and group.</para>
<screen>$ lfs quotachown -i /mnt/lustre</screen>
<para>The <literal>lfs_migrate</literal> utility is a simple tool to migrate files between Lustre OSTs.</para>
<section remap="h5">
<title>Synopsis</title>
- <screen>lfs_migrate [-c|-s] [-h] [-l] [-n] [-y] [file|directory ...]</screen>
+ <screen>lfs_migrate [-c <replaceable>stripecount</replaceable>] [-h] [-l] [-n] [-q] [-R] [-s] [-y] [file|directory ...]</screen>
</section>
<section remap="h5">
<title>Description</title>
<tbody>
<row>
<entry>
- <para> <literal>-c</literal></para>
- </entry>
- <entry>
- <para>Compares file data after migrate (default value, use <literal>-s</literal> to disable).</para>
- </entry>
- </row>
- <row>
- <entry>
- <para> <literal>-s</literal></para>
+ <para>
+ <literal>-c <replaceable>stripecount</replaceable></literal></para>
</entry>
<entry>
- <para>Skips file data comparison after migrate (use <literal>-c</literal> to enable).</para>
+ <para>Restripe file using the specified stripe count. This option may not be
+ specified at the same time as the <literal>-R</literal> option.</para>
</entry>
</row>
<row>
<entry>
- <para> <literal>-h</literal></para>
+ <para>
+ <literal>-h</literal></para>
</entry>
<entry>
- <para>Displays help information.</para>
+ <para>Display help information.</para>
</entry>
</row>
<row>
<literal>-l</literal>
</entry>
<entry>
- <para>Migrates files with hard links (skips, by default). Files with multiple hard links are split into multiple separate files by <literal>lfs_migrate</literal>, so they are skipped, by default, to avoid breaking the hard links.</para>
+ <para>Migrate files with hard links (skips, by default). Files with multiple hard
+ links are split into multiple separate files by <literal>lfs_migrate</literal>, so
+ they are skipped, by default, to avoid breaking the hard links.</para>
</entry>
</row>
<row>
<literal>-n</literal>
</entry>
<entry>
- <para>Only prints the names of files to be migrated.</para>
+ <para>Only print the names of files to be migrated.</para>
</entry>
</row>
<row>
<para> <literal>-q</literal></para>
</entry>
<entry>
- <para>Runs quietly (does not print filenames or status).</para>
+ <para>Run quietly (does not print filenames or status).</para>
</entry>
</row>
<row>
+ <entry><literal>-R</literal></entry>
+ <entry>Restripe file using default directory striping instead of keeping striping.
+ This option may not be specified at the same time as the <literal>-c</literal>
+ option.</entry>
+ </row>
+ <row>
+ <entry>
+ <literal>-s</literal></entry>
+ <entry>Skip file data comparison after migrate. Default is to compare migrated file
+ against original to verify correctness.</entry>
+ </row>
+ <row>
<entry>
- <para> <literal>--y</literal></para>
+ <para>
+ <literal>-y</literal></para>
</entry>
<entry>
- <para>Answers '<literal>y</literal>' to usage warning without prompting (for scripts).</para>
+ <para>Answer '<literal>y</literal>' to usage warning without prompting
+ (for scripts, use with caution).</para>
</entry>
</row>
</tbody>
<title><indexterm><primary>lfsck</primary></indexterm>
<literal>lfsck</literal>
</title>
- <para><literal>lfsck</literal> ensures that objects are not referenced by multiple MDS files, that there are no orphan objects on the OSTs (objects that do not have any file on the MDS which references them), and that all of the objects referenced by the MDS exist. Under normal circumstances, Lustre maintains such coherency by distributed logging mechanisms, but under exceptional circumstances that may fail (e.g. disk failure, file system corruption leading to e2fsck repair). To avoid lengthy downtime, you can also run <literal>lfsck</literal> once Lustre is already started.</para>
+ <para><literal>lfsck</literal> ensures that objects are not referenced by multiple MDS files,
+ that there are no orphan objects on the OSTs (objects that do not have any file on the MDS
+ which references them), and that all of the objects referenced by the MDS exist. Under normal
+ circumstances, the Lustre software maintains such coherency by distributed logging mechanisms,
+ but under exceptional circumstances that may fail (e.g. disk failure, file system corruption
+ leading to e2fsck repair). To avoid lengthy downtime, you can also run
+ <literal>lfsck</literal> once the Lustre file system is already started.</para>
<para>The <literal>e2fsck</literal> utility is run on each of the local MDS and OST device file systems and verifies that the underlying <literal>ldiskfs</literal> is consistent. After <literal>e2fsck</literal> is run, <literal>lfsck</literal> does distributed coherency checking for the Lustre file system. In most cases, <literal>e2fsck</literal> is sufficient to repair any file system issues and <literal>lfsck</literal> is not required.</para>
<section remap="h5">
<title>Synopsis</title>
<title>Description</title>
<para>The <literal>filefrag</literal> utility reports the extent of fragmentation in a given file. Initially, <literal>filefrag</literal> attempts to obtain extent information using <literal>FIEMAP ioctl</literal>, which is efficient and fast. If <literal>FIEMAP</literal> is not supported, then <literal>filefrag</literal> uses <literal>FIBMAP</literal>.</para>
<note>
- <para>Lustre only supports <literal>FIEMAP ioctl</literal>. <literal>FIBMAP ioctl</literal> is not supported.</para>
+ <para>The Lustre software only supports <literal>FIEMAP ioctl</literal>. <literal>FIBMAP
+ ioctl</literal> is not supported.</para>
</note>
<para>In default mode <footnote>
<para>The default mode is faster than the verbose/extent mode.</para>
- </footnote>, <literal>filefrag</literal> returns the number of physically discontiguous extents in the file. In extent or verbose mode, each extent is printed with details. For Lustre, the extents are printed in device offset order, not logical offset order.</para>
+ </footnote>, <literal>filefrag</literal> returns the number of physically discontiguous
+ extents in the file. In extent or verbose mode, each extent is printed with details. For a
+ Lustre file system, the extents are printed in device offset order, not logical offset
+ order.</para>
</section>
<section remap="h5">
<title>Options</title>
<para> <literal>-b</literal></para>
</entry>
<entry>
- <para>Uses the 1024-byte blocksize for the output. By default, this blocksize is used by Lustre, since OSTs may use different block sizes.</para>
+ <para>Uses the 1024-byte blocksize for the output. By default, this blocksize is
+ used by the Lustre file system, since OSTs may use different block sizes.</para>
</entry>
</row>
<row>
<title><indexterm><primary>mount</primary></indexterm>
<literal>mount</literal>
</title>
- <para>Lustre uses the standard <literal>mount(8)</literal> Linux command. When mounting a Lustre file system, mount(8) executes the <literal>/sbin/mount.lustre</literal> command to complete the mount. The mount command supports these Lustre-specific options:</para>
+ <para>The standard <literal>mount(8)</literal> Linux command is used to mount a Lustre file
+ system. When mounting a Lustre file system, mount(8) executes the
+ <literal>/sbin/mount.lustre</literal> command to complete the mount. The mount command
+ supports these options specific to a Lustre file system:</para>
<informaltable frame="all">
<tgroup cols="2">
<colspec colname="c1" colwidth="50*"/>
git://git.whamcloud.com / doc / manual.git / blobdiff