LustreOperations.xml

   1 <?xml version='1.0' encoding='utf-8'?>
   2 <chapter xmlns="http://docbook.org/ns/docbook"
   3 xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en-US"
   4 xml:id="lustreoperations">
   5   <title xml:id="lustreoperations.title">Lustre Operations</title>
   6   <para>Once you have the Lustre file system up and running, you can use the
   7   procedures in this section to perform these basic Lustre administration
   8   tasks.</para>
   9   <section xml:id="dbdoclet.50438194_42877">
  10     <title>
  11     <indexterm>
  12       <primary>operations</primary>
  13     </indexterm>
  14     <indexterm>
  15       <primary>operations</primary>
  16       <secondary>mounting by label</secondary>
  17     </indexterm>Mounting by Label</title>
  18     <para>The file system name is limited to 8 characters. We have encoded the
  19     file system and target information in the disk label, so you can mount by
  20     label. This allows system administrators to move disks around without
  21     worrying about issues such as SCSI disk reordering or getting the
  22     <literal>/dev/device</literal> wrong for a shared target. Soon, file system
  23     naming will be made as fail-safe as possible. Currently, Linux disk labels
  24     are limited to 16 characters. To identify the target within the file
  25     system, 8 characters are reserved, leaving 8 characters for the file system
  26     name:</para>
  27     <screen>
  28 <replaceable>fsname</replaceable>-MDT0000 or
  29 <replaceable>fsname</replaceable>-OST0a19
  30 </screen>
  31     <para>To mount by label, use this command:</para>
  32     <screen>
  33 mount -t lustre -L
  34 <replaceable>file_system_label</replaceable>
  35 <replaceable>/mount_point</replaceable>
  36 </screen>
  37     <para>This is an example of mount-by-label:</para>
  38     <screen>
  39 mds# mount -t lustre -L testfs-MDT0000 /mnt/mdt
  40 </screen>
  41     <caution>
  42       <para>Mount-by-label should NOT be used in a multi-path environment or
  43       when snapshots are being created of the device, since multiple block
  44       devices will have the same label.</para>
  45     </caution>
  46     <para>Although the file system name is internally limited to 8 characters,
  47     you can mount the clients at any mount point, so file system users are not
  48     subjected to short names. Here is an example:</para>
  49     <screen>
  50 client# mount -t lustre mds0@tcp0:/short
  51 <replaceable>/dev/long_mountpoint_name</replaceable>
  52 </screen>
  53   </section>
  54   <section xml:id="dbdoclet.50438194_24122">
  55     <title>
  56     <indexterm>
  57       <primary>operations</primary>
  58       <secondary>starting</secondary>
  59     </indexterm>Starting Lustre</title>
  60     <para>On the first start of a Lustre file system, the components must be
  61     started in the following order:</para>
  62     <orderedlist>
  63       <listitem>
  64         <para>Mount the MGT.</para>
  65         <note>
  66           <para>If a combined MGT/MDT is present, Lustre will correctly mount
  67           the MGT and MDT automatically.</para>
  68         </note>
  69       </listitem>
  70       <listitem>
  71         <para>Mount the MDT.</para>
  72         <note>
  73           <para condition='l24'>Mount all MDTs if multiple MDTs are
  74           present.</para>
  75         </note>
  76       </listitem>
  77       <listitem>
  78         <para>Mount the OST(s).</para>
  79       </listitem>
  80       <listitem>
  81         <para>Mount the client(s).</para>
  82       </listitem>
  83     </orderedlist>
  84   </section>
  85   <section xml:id="dbdoclet.50438194_84876">
  86     <title>
  87     <indexterm>
  88       <primary>operations</primary>
  89       <secondary>mounting</secondary>
  90     </indexterm>Mounting a Server</title>
  91     <para>Starting a Lustre server is straightforward and only involves the
  92     mount command. Lustre servers can be added to
  93     <literal>/etc/fstab</literal>:</para>
  94     <screen>
  95 mount -t lustre
  96 </screen>
  97     <para>The mount command generates output similar to this:</para>
  98     <screen>
  99 /dev/sda1 on /mnt/test/mdt type lustre (rw)
 100 /dev/sda2 on /mnt/test/ost0 type lustre (rw)
 101 192.168.0.21@tcp:/testfs on /mnt/testfs type lustre (rw)
 102 </screen>
 103     <para>In this example, the MDT, an OST (ost0) and file system (testfs) are
 104     mounted.</para>
 105     <screen>
 106 LABEL=testfs-MDT0000 /mnt/test/mdt lustre defaults,_netdev,noauto 0 0
 107 LABEL=testfs-OST0000 /mnt/test/ost0 lustre defaults,_netdev,noauto 0 0
 108 </screen>
 109     <para>In general, it is wise to specify noauto and let your
 110     high-availability (HA) package manage when to mount the device. If you are
 111     not using failover, make sure that networking has been started before
 112     mounting a Lustre server. If you are running Red Hat Enterprise Linux, SUSE
 113     Linux Enterprise Server, Debian operating system (and perhaps others), use
 114     the
 115     <literal>_netdev</literal> flag to ensure that these disks are mounted after
 116     the network is up.</para>
 117     <para>We are mounting by disk label here. The label of a device can be read
 118     with
 119     <literal>e2label</literal>. The label of a newly-formatted Lustre server
 120     may end in
 121     <literal>FFFF</literal> if the
 122     <literal>--index</literal> option is not specified to
 123     <literal>mkfs.lustre</literal>, meaning that it has yet to be assigned. The
 124     assignment takes place when the server is first started, and the disk label
 125     is updated. It is recommended that the
 126     <literal>--index</literal> option always be used, which will also ensure
 127     that the label is set at format time.</para>
 128     <caution>
 129       <para>Do not do this when the client and OSS are on the same node, as
 130       memory pressure between the client and OSS can lead to deadlocks.</para>
 131     </caution>
 132     <caution>
 133       <para>Mount-by-label should NOT be used in a multi-path
 134       environment.</para>
 135     </caution>
 136   </section>
 137   <section xml:id="dbdoclet.50438194_69255">
 138     <title>
 139     <indexterm>
 140       <primary>operations</primary>
 141       <secondary>unmounting</secondary>
 142     </indexterm>Unmounting a Server</title>
 143     <para>To stop a Lustre server, use the
 144     <literal>umount
 145     <replaceable>/mount</replaceable>
 146     <replaceable>point</replaceable></literal> command.</para>
 147     <para>For example, to stop
 148     <literal>ost0</literal> on mount point
 149     <literal>/mnt/test</literal>, run:</para>
 150     <screen>
 151 $ umount /mnt/test
 152 </screen>
 153     <para>Gracefully stopping a server with the
 154     <literal>umount</literal> command preserves the state of the connected
 155     clients. The next time the server is started, it waits for clients to
 156     reconnect, and then goes through the recovery procedure.</para>
 157     <para>If the force (
 158     <literal>-f</literal>) flag is used, then the server evicts all clients and
 159     stops WITHOUT recovery. Upon restart, the server does not wait for
 160     recovery. Any currently connected clients receive I/O errors until they
 161     reconnect.</para>
 162     <note>
 163       <para>If you are using loopback devices, use the
 164       <literal>-d</literal> flag. This flag cleans up loop devices and can
 165       always be safely specified.</para>
 166     </note>
 167   </section>
 168   <section xml:id="dbdoclet.50438194_57420">
 169     <title>
 170     <indexterm>
 171       <primary>operations</primary>
 172       <secondary>failover</secondary>
 173     </indexterm>Specifying Failout/Failover Mode for OSTs</title>
 174     <para>In a Lustre file system, an OST that has become unreachable because
 175     it fails, is taken off the network, or is unmounted can be handled in one
 176     of two ways:</para>
 177     <itemizedlist>
 178       <listitem>
 179         <para>In
 180         <literal>failout</literal> mode, Lustre clients immediately receive
 181         errors (EIOs) after a timeout, instead of waiting for the OST to
 182         recover.</para>
 183       </listitem>
 184       <listitem>
 185         <para>In
 186         <literal>failover</literal> mode, Lustre clients wait for the OST to
 187         recover.</para>
 188       </listitem>
 189     </itemizedlist>
 190     <para>By default, the Lustre file system uses
 191     <literal>failover</literal> mode for OSTs. To specify
 192     <literal>failout</literal> mode instead, use the
 193     <literal>--param="failover.mode=failout"</literal> option as shown below
 194     (entered on one line):</para>
 195     <screen>
 196 oss# mkfs.lustre --fsname=
 197 <replaceable>fsname</replaceable> --mgsnode=
 198 <replaceable>mgs_NID</replaceable> --param=failover.mode=failout
 199       --ost --index=
 200 <replaceable>ost_index</replaceable>
 201 <replaceable>/dev/ost_block_device</replaceable>
 202 </screen>
 203     <para>In the example below,
 204     <literal>failout</literal> mode is specified for the OSTs on the MGS
 205     <literal>mds0</literal> in the file system
 206     <literal>testfs</literal>(entered on one line).</para>
 207     <screen>
 208 oss# mkfs.lustre --fsname=testfs --mgsnode=mds0 --param=failover.mode=failout
 209       --ost --index=3 /dev/sdb
 210 </screen>
 211     <caution>
 212       <para>Before running this command, unmount all OSTs that will be affected
 213       by a change in
 214       <literal>failover</literal>/
 215       <literal>failout</literal> mode.</para>
 216     </caution>
 217     <note>
 218       <para>After initial file system configuration, use the
 219       <literal>tunefs.lustre</literal> utility to change the mode. For example,
 220       to set the
 221       <literal>failout</literal> mode, run:</para>
 222       <para>
 223         <screen>
 224 $ tunefs.lustre --param failover.mode=failout
 225 <replaceable>/dev/ost_device</replaceable>
 226 </screen>
 227       </para>
 228     </note>
 229   </section>
 230   <section xml:id="dbdoclet.50438194_54138">
 231     <title>
 232     <indexterm>
 233       <primary>operations</primary>
 234       <secondary>degraded OST RAID</secondary>
 235     </indexterm>Handling Degraded OST RAID Arrays</title>
 236     <para>Lustre includes functionality that notifies Lustre if an external
 237     RAID array has degraded performance (resulting in reduced overall file
 238     system performance), either because a disk has failed and not been
 239     replaced, or because a disk was replaced and is undergoing a rebuild. To
 240     avoid a global performance slowdown due to a degraded OST, the MDS can
 241     avoid the OST for new object allocation if it is notified of the degraded
 242     state.</para>
 243     <para>A parameter for each OST, called
 244     <literal>degraded</literal>, specifies whether the OST is running in
 245     degraded mode or not.</para>
 246     <para>To mark the OST as degraded, use:</para>
 247     <screen>
 248 lctl set_param obdfilter.{OST_name}.degraded=1
 249 </screen>
 250     <para>To mark that the OST is back in normal operation, use:</para>
 251     <screen>
 252 lctl set_param obdfilter.{OST_name}.degraded=0
 253 </screen>
 254     <para>To determine if OSTs are currently in degraded mode, use:</para>
 255     <screen>
 256 lctl get_param obdfilter.*.degraded
 257 </screen>
 258     <para>If the OST is remounted due to a reboot or other condition, the flag
 259     resets to
 260     <literal>0</literal>.</para>
 261     <para>It is recommended that this be implemented by an automated script
 262     that monitors the status of individual RAID devices.</para>
 263   </section>
 264   <section xml:id="dbdoclet.50438194_88063">
 265     <title>
 266     <indexterm>
 267       <primary>operations</primary>
 268       <secondary>multiple file systems</secondary>
 269     </indexterm>Running Multiple Lustre File Systems</title>
 270     <para>Lustre supports multiple file systems provided the combination of
 271     <literal>NID:fsname</literal> is unique. Each file system must be allocated
 272     a unique name during creation with the
 273     <literal>--fsname</literal> parameter. Unique names for file systems are
 274     enforced if a single MGS is present. If multiple MGSs are present (for
 275     example if you have an MGS on every MDS) the administrator is responsible
 276     for ensuring file system names are unique. A single MGS and unique file
 277     system names provides a single point of administration and allows commands
 278     to be issued against the file system even if it is not mounted.</para>
 279     <para>Lustre supports multiple file systems on a single MGS. With a single
 280     MGS fsnames are guaranteed to be unique. Lustre also allows multiple MGSs
 281     to co-exist. For example, multiple MGSs will be necessary if multiple file
 282     systems on different Lustre software versions are to be concurrently
 283     available. With multiple MGSs additional care must be taken to ensure file
 284     system names are unique. Each file system should have a unique fsname among
 285     all systems that may interoperate in the future.</para>
 286     <para>By default, the
 287     <literal>mkfs.lustre</literal> command creates a file system named
 288     <literal>lustre</literal>. To specify a different file system name (limited
 289     to 8 characters) at format time, use the
 290     <literal>--fsname</literal> option:</para>
 291     <para>
 292       <screen>
 293 mkfs.lustre --fsname=
 294 <replaceable>file_system_name</replaceable>
 295 </screen>
 296     </para>
 297     <note>
 298       <para>The MDT, OSTs and clients in the new file system must use the same
 299       file system name (prepended to the device name). For example, for a new
 300       file system named
 301       <literal>foo</literal>, the MDT and two OSTs would be named
 302       <literal>foo-MDT0000</literal>,
 303       <literal>foo-OST0000</literal>, and
 304       <literal>foo-OST0001</literal>.</para>
 305     </note>
 306     <para>To mount a client on the file system, run:</para>
 307     <screen>
 308 client# mount -t lustre
 309 <replaceable>mgsnode</replaceable>:
 310 <replaceable>/new_fsname</replaceable>
 311 <replaceable>/mount_point</replaceable>
 312 </screen>
 313     <para>For example, to mount a client on file system foo at mount point
 314     /mnt/foo, run:</para>
 315     <screen>
 316 client# mount -t lustre mgsnode:/foo /mnt/foo
 317 </screen>
 318     <note>
 319       <para>If a client(s) will be mounted on several file systems, add the
 320       following line to
 321       <literal>/etc/xattr.conf</literal> file to avoid problems when files are
 322       moved between the file systems:
 323       <literal>lustre.* skip</literal></para>
 324     </note>
 325     <note>
 326       <para>To ensure that a new MDT is added to an existing MGS create the MDT
 327       by specifying:
 328       <literal>--mdt --mgsnode=
 329       <replaceable>mgs_NID</replaceable></literal>.</para>
 330     </note>
 331     <para>A Lustre installation with two file systems (
 332     <literal>foo</literal> and
 333     <literal>bar</literal>) could look like this, where the MGS node is
 334     <literal>mgsnode@tcp0</literal> and the mount points are
 335     <literal>/mnt/foo</literal> and
 336     <literal>/mnt/bar</literal>.</para>
 337     <screen>
 338 mgsnode# mkfs.lustre --mgs /dev/sda
 339 mdtfoonode# mkfs.lustre --fsname=foo --mgsnode=mgsnode@tcp0 --mdt --index=0
 340 /dev/sdb
 341 ossfoonode# mkfs.lustre --fsname=foo --mgsnode=mgsnode@tcp0 --ost --index=0
 342 /dev/sda
 343 ossfoonode# mkfs.lustre --fsname=foo --mgsnode=mgsnode@tcp0 --ost --index=1
 344 /dev/sdb
 345 mdtbarnode# mkfs.lustre --fsname=bar --mgsnode=mgsnode@tcp0 --mdt --index=0
 346 /dev/sda
 347 ossbarnode# mkfs.lustre --fsname=bar --mgsnode=mgsnode@tcp0 --ost --index=0
 348 /dev/sdc
 349 ossbarnode# mkfs.lustre --fsname=bar --mgsnode=mgsnode@tcp0 --ost --index=1
 350 /dev/sdd
 351 </screen>
 352     <para>To mount a client on file system foo at mount point
 353     <literal>/mnt/foo</literal>, run:</para>
 354     <screen>
 355 client# mount -t lustre mgsnode@tcp0:/foo /mnt/foo
 356 </screen>
 357     <para>To mount a client on file system bar at mount point
 358     <literal>/mnt/bar</literal>, run:</para>
 359     <screen>
 360 client# mount -t lustre mgsnode@tcp0:/bar /mnt/bar
 361 </screen>
 362   </section>
 363   <section xml:id="dbdoclet.lfsmkdir" condition='l24'>
 364     <title>
 365     <indexterm>
 366       <primary>operations</primary>
 367       <secondary>remote directory</secondary>
 368     </indexterm>Creating a sub-directory on a given MDT</title>
 369     <para>Lustre 2.4 enables individual sub-directories to be serviced by
 370     unique MDTs. An administrator can allocate a sub-directory to a given MDT
 371     using the command:</para>
 372     <screen>
 373 client# lfs mkdir –i
 374 <replaceable>mdt_index</replaceable>
 375 <replaceable>/mount_point/remote_dir</replaceable>
 376 </screen>
 377     <para>This command will allocate the sub-directory
 378     <literal>remote_dir</literal> onto the MDT of index
 379     <literal>mdt_index</literal>. For more information on adding additional MDTs
 380     and
 381     <literal>mdt_index</literal> see
 382     <xref linkend='dbdoclet.addmdtindex' />.</para>
 383     <warning>
 384       <para>An administrator can allocate remote sub-directories to separate
 385       MDTs. Creating remote sub-directories in parent directories not hosted on
 386       MDT0 is not recommended. This is because the failure of the parent MDT
 387       will leave the namespace below it inaccessible. For this reason, by
 388       default it is only possible to create remote sub-directories off MDT0. To
 389       relax this restriction and enable remote sub-directories off any MDT, an
 390       administrator must issue the following command on the MGS:
 391       <screen>mgs# lctl conf_param <replaceable>fsname</replaceable>.mdt.enable_remote_dir=1</screen>
 392       For Lustre filesystem 'scratch', the command executed is:
 393       <screen>mgs# lctl conf_param scratch.mdt.enable_remote_dir=1</screen>
 394       To verify the configuration setting execute the following command on any
 395       MDS:
 396           <screen>mds# lctl get_param mdt.*.enable_remote_dir</screen></para>
 397     </warning>
 398     <para condition='l28'>With Lustre software version 2.8, a new
 399     tunable is available to allow users with a specific group ID to create
 400     and delete remote and striped directories. This tunable is
 401     <literal>enable_remote_dir_gid</literal>. For example, setting this
 402     parameter to the 'wheel' or 'admin' group ID allows users with that GID
 403     to create and delete remote and striped directories. Setting this
 404     parameter to <literal>-1</literal> on MDT0 to permanently allow any
 405     non-root users create and delete remote and striped directories.
 406     On the MGS execute the following command:
 407     <screen>mgs# lctl conf_param <replaceable>fsname</replaceable>.mdt.enable_remote_dir_gid=-1</screen>
 408     For the Lustre filesystem 'scratch', the commands expands to:
 409     <screen>mgs# lctl conf_param scratch.mdt.enable_remote_dir_gid=-1</screen>.
 410     The change can be verified by executing the following command on every MDS:
 411     <screen>mds# lctl get_param mdt.<replaceable>*</replaceable>.enable_remote_dir_gid</screen>
 412     </para>
 413   </section>
 414   <section xml:id="dbdoclet.lfsmkdirdne2" condition='l28'>
 415     <title>
 416     <indexterm>
 417       <primary>operations</primary>
 418       <secondary>striped directory</secondary>
 419     </indexterm>
 420     <indexterm>
 421       <primary>operations</primary>
 422       <secondary>mkdir</secondary>
 423     </indexterm>
 424     <indexterm>
 425       <primary>operations</primary>
 426       <secondary>setdirstripe</secondary>
 427     </indexterm>
 428     <indexterm>
 429       <primary>striping</primary>
 430       <secondary>metadata</secondary>
 431     </indexterm>Creating a directory striped across multiple MDTs</title>
 432     <para>The Lustre 2.8 DNE feature enables individual files in a given
 433     directory to store their metadata on separate MDTs (a <emphasis>striped
 434     directory</emphasis>) once additional MDTs have been added to the
 435     filesystem, see <xref linkend="dbdoclet.addingamdt"/>.
 436     The result of this is that metadata requests for
 437     files in a striped directory are serviced by multiple MDTs and metadata
 438     service load is distributed over all the MDTs that service a given
 439     directory. By distributing metadata service load over multiple MDTs,
 440     performance can be improved beyond the limit of single MDT
 441     performance. Prior to the development of this feature all files in a
 442     directory must record their metadata on a single MDT.</para>
 443     <para>This command to stripe a directory over
 444     <replaceable>mdt_count</replaceable> MDTs is:
 445     </para>
 446     <screen>
 447 client# lfs mkdir -c
 448 <replaceable>mdt_count</replaceable>
 449 <replaceable>/mount_point/new_directory</replaceable>
 450 </screen>
 451     <para>The striped directory feature is most useful for distributing
 452     single large directories (50k entries or more) across multiple MDTs,
 453     since it incurs more overhead than non-striped directories.</para>
 454   </section>
 455   <section xml:id="dbdoclet.50438194_88980">
 456     <title>
 457     <indexterm>
 458       <primary>operations</primary>
 459       <secondary>parameters</secondary>
 460     </indexterm>Setting and Retrieving Lustre Parameters</title>
 461     <para>Several options are available for setting parameters in
 462     Lustre:</para>
 463     <itemizedlist>
 464       <listitem>
 465         <para>When creating a file system, use mkfs.lustre. See
 466         <xref linkend="dbdoclet.50438194_17237" />below.</para>
 467       </listitem>
 468       <listitem>
 469         <para>When a server is stopped, use tunefs.lustre. See
 470         <xref linkend="dbdoclet.50438194_55253" />below.</para>
 471       </listitem>
 472       <listitem>
 473         <para>When the file system is running, use lctl to set or retrieve
 474         Lustre parameters. See
 475         <xref linkend="dbdoclet.50438194_51490" />and
 476         <xref linkend="dbdoclet.50438194_63247" />below.</para>
 477       </listitem>
 478     </itemizedlist>
 479     <section xml:id="dbdoclet.50438194_17237">
 480       <title>Setting Tunable Parameters with
 481       <literal>mkfs.lustre</literal></title>
 482       <para>When the file system is first formatted, parameters can simply be
 483       added as a
 484       <literal>--param</literal> option to the
 485       <literal>mkfs.lustre</literal> command. For example:</para>
 486       <screen>
 487 mds# mkfs.lustre --mdt --param="sys.timeout=50" /dev/sda
 488 </screen>
 489       <para>For more details about creating a file system,see
 490       <xref linkend="configuringlustre" />. For more details about
 491       <literal>mkfs.lustre</literal>, see
 492       <xref linkend="systemconfigurationutilities" />.</para>
 493     </section>
 494     <section xml:id="dbdoclet.50438194_55253">
 495       <title>Setting Parameters with
 496       <literal>tunefs.lustre</literal></title>
 497       <para>If a server (OSS or MDS) is stopped, parameters can be added to an
 498       existing file system using the
 499       <literal>--param</literal> option to the
 500       <literal>tunefs.lustre</literal> command. For example:</para>
 501       <screen>
 502 oss# tunefs.lustre --param=failover.node=192.168.0.13@tcp0 /dev/sda
 503 </screen>
 504       <para>With
 505       <literal>tunefs.lustre</literal>, parameters are
 506       <emphasis>additive</emphasis>-- new parameters are specified in addition
 507       to old parameters, they do not replace them. To erase all old
 508       <literal>tunefs.lustre</literal> parameters and just use newly-specified
 509       parameters, run:</para>
 510       <screen>
 511 mds# tunefs.lustre --erase-params --param=
 512 <replaceable>new_parameters</replaceable>
 513 </screen>
 514       <para>The tunefs.lustre command can be used to set any parameter settable
 515       in a /proc/fs/lustre file and that has its own OBD device, so it can be
 516       specified as
 517       <literal>
 518       <replaceable>obdname|fsname</replaceable>.
 519       <replaceable>obdtype</replaceable>.
 520       <replaceable>proc_file_name</replaceable>=
 521       <replaceable>value</replaceable></literal>. For example:</para>
 522       <screen>
 523 mds# tunefs.lustre --param mdt.identity_upcall=NONE /dev/sda1
 524 </screen>
 525       <para>For more details about
 526       <literal>tunefs.lustre</literal>, see
 527       <xref linkend="systemconfigurationutilities" />.</para>
 528     </section>
 529     <section xml:id="dbdoclet.50438194_51490">
 530       <title>Setting Parameters with
 531       <literal>lctl</literal></title>
 532       <para>When the file system is running, the
 533       <literal>lctl</literal> command can be used to set parameters (temporary
 534       or permanent) and report current parameter values. Temporary parameters
 535       are active as long as the server or client is not shut down. Permanent
 536       parameters live through server and client reboots.</para>
 537       <note>
 538         <para>The lctl list_param command enables users to list all parameters
 539         that can be set. See
 540         <xref linkend="dbdoclet.50438194_88217" />.</para>
 541       </note>
 542       <para>For more details about the
 543       <literal>lctl</literal> command, see the examples in the sections below
 544       and
 545       <xref linkend="systemconfigurationutilities" />.</para>
 546       <section remap="h4">
 547         <title>Setting Temporary Parameters</title>
 548         <para>Use
 549         <literal>lctl set_param</literal> to set temporary parameters on the
 550         node where it is run. These parameters map to items in
 551         <literal>/proc/{fs,sys}/{lnet,lustre}</literal>. The
 552         <literal>lctl set_param</literal> command uses this syntax:</para>
 553         <screen>
 554 lctl set_param [-n]
 555 <replaceable>obdtype</replaceable>.
 556 <replaceable>obdname</replaceable>.
 557 <replaceable>proc_file_name</replaceable>=
 558 <replaceable>value</replaceable>
 559 </screen>
 560         <para>For example:</para>
 561         <screen>
 562 # lctl set_param osc.*.max_dirty_mb=1024
 563 osc.myth-OST0000-osc.max_dirty_mb=32
 564 osc.myth-OST0001-osc.max_dirty_mb=32
 565 osc.myth-OST0002-osc.max_dirty_mb=32
 566 osc.myth-OST0003-osc.max_dirty_mb=32
 567 osc.myth-OST0004-osc.max_dirty_mb=32
 568 </screen>
 569       </section>
 570       <section xml:id="dbdoclet.50438194_64195">
 571         <title>Setting Permanent Parameters</title>
 572         <para>Use the
 573         <literal>lctl conf_param</literal> command to set permanent parameters.
 574         In general, the
 575         <literal>lctl conf_param</literal> command can be used to specify any
 576         parameter settable in a
 577         <literal>/proc/fs/lustre</literal> file, with its own OBD device. The
 578         <literal>lctl conf_param</literal> command uses this syntax (same as the
 579
 580         <literal>mkfs.lustre</literal> and
 581         <literal>tunefs.lustre</literal> commands):</para>
 582         <screen>
 583 <replaceable>obdname|fsname</replaceable>.
 584 <replaceable>obdtype</replaceable>.
 585 <replaceable>proc_file_name</replaceable>=
 586 <replaceable>value</replaceable>)
 587 </screen>
 588         <para>Here are a few examples of
 589         <literal>lctl conf_param</literal> commands:</para>
 590         <screen>
 591 mgs# lctl conf_param testfs-MDT0000.sys.timeout=40
 592 $ lctl conf_param testfs-MDT0000.mdt.identity_upcall=NONE
 593 $ lctl conf_param testfs.llite.max_read_ahead_mb=16
 594 $ lctl conf_param testfs-MDT0000.lov.stripesize=2M
 595 $ lctl conf_param testfs-OST0000.osc.max_dirty_mb=29.15
 596 $ lctl conf_param testfs-OST0000.ost.client_cache_seconds=15
 597 $ lctl conf_param testfs.sys.timeout=40
 598 </screen>
 599         <caution>
 600           <para>Parameters specified with the
 601           <literal>lctl conf_param</literal> command are set permanently in the
 602           file system's configuration file on the MGS.</para>
 603         </caution>
 604       </section>
 605       <section xml:id="dbdoclet.setparamp" condition='l25'>
 606         <title>Setting Permanent Parameters with lctl set_param -P</title>
 607         <para>Use the
 608         <literal>lctl set_param -P</literal> to set parameters permanently. This
 609         command must be issued on the MGS. The given parameter is set on every
 610         host using
 611         <literal>lctl</literal> upcall. Parameters map to items in
 612         <literal>/proc/{fs,sys}/{lnet,lustre}</literal>. The
 613         <literal>lctl set_param</literal> command uses this syntax:</para>
 614         <screen>
 615 lctl set_param -P
 616 <replaceable>obdtype</replaceable>.
 617 <replaceable>obdname</replaceable>.
 618 <replaceable>proc_file_name</replaceable>=
 619 <replaceable>value</replaceable>
 620 </screen>
 621         <para>For example:</para>
 622         <screen>
 623 # lctl set_param -P osc.*.max_dirty_mb=1024
 624 osc.myth-OST0000-osc.max_dirty_mb=32
 625 osc.myth-OST0001-osc.max_dirty_mb=32
 626 osc.myth-OST0002-osc.max_dirty_mb=32
 627 osc.myth-OST0003-osc.max_dirty_mb=32
 628 osc.myth-OST0004-osc.max_dirty_mb=32
 629 </screen>
 630         <para>Use
 631         <literal>-d</literal>(only with -P) option to delete permanent
 632         parameter. Syntax:</para>
 633         <screen>
 634 lctl set_param -P -d
 635 <replaceable>obdtype</replaceable>.
 636 <replaceable>obdname</replaceable>.
 637 <replaceable>proc_file_name</replaceable>
 638 </screen>
 639         <para>For example:</para>
 640         <screen>
 641 # lctl set_param -P -d osc.*.max_dirty_mb
 642 </screen>
 643       </section>
 644       <section xml:id="dbdoclet.50438194_88217">
 645         <title>Listing Parameters</title>
 646         <para>To list Lustre or LNet parameters that are available to set, use
 647         the
 648         <literal>lctl list_param</literal> command. For example:</para>
 649         <screen>
 650 lctl list_param [-FR]
 651 <replaceable>obdtype</replaceable>.
 652 <replaceable>obdname</replaceable>
 653 </screen>
 654         <para>The following arguments are available for the
 655         <literal>lctl list_param</literal> command.</para>
 656         <para>
 657         <literal>-F</literal> Add '
 658         <literal>/</literal>', '
 659         <literal>@</literal>' or '
 660         <literal>=</literal>' for directories, symlinks and writeable files,
 661         respectively</para>
 662         <para>
 663         <literal>-R</literal> Recursively lists all parameters under the
 664         specified path</para>
 665         <para>For example:</para>
 666         <screen>
 667 oss# lctl list_param obdfilter.lustre-OST0000
 668 </screen>
 669       </section>
 670       <section xml:id="dbdoclet.50438194_63247">
 671         <title>Reporting Current Parameter Values</title>
 672         <para>To report current Lustre parameter values, use the
 673         <literal>lctl get_param</literal> command with this syntax:</para>
 674         <screen>
 675 lctl get_param [-n]
 676 <replaceable>obdtype</replaceable>.
 677 <replaceable>obdname</replaceable>.
 678 <replaceable>proc_file_name</replaceable>
 679 </screen>
 680         <para>This example reports data on RPC service times.</para>
 681         <screen>
 682 oss# lctl get_param -n ost.*.ost_io.timeouts
 683 service : cur 1 worst 30 (at 1257150393, 85d23h58m54s ago) 1 1 1 1
 684 </screen>
 685         <para>This example reports the amount of space this client has reserved
 686         for writeback cache with each OST:</para>
 687         <screen>
 688 client# lctl get_param osc.*.cur_grant_bytes
 689 osc.myth-OST0000-osc-ffff8800376bdc00.cur_grant_bytes=2097152
 690 osc.myth-OST0001-osc-ffff8800376bdc00.cur_grant_bytes=33890304
 691 osc.myth-OST0002-osc-ffff8800376bdc00.cur_grant_bytes=35418112
 692 osc.myth-OST0003-osc-ffff8800376bdc00.cur_grant_bytes=2097152
 693 osc.myth-OST0004-osc-ffff8800376bdc00.cur_grant_bytes=33808384
 694 </screen>
 695       </section>
 696     </section>
 697   </section>
 698   <section xml:id="dbdoclet.50438194_41817">
 699     <title>
 700     <indexterm>
 701       <primary>operations</primary>
 702       <secondary>failover</secondary>
 703     </indexterm>Specifying NIDs and Failover</title>
 704     <para>If a node has multiple network interfaces, it may have multiple NIDs,
 705     which must all be identified so other nodes can choose the NID that is
 706     appropriate for their network interfaces. Typically, NIDs are specified in
 707     a list delimited by commas (
 708     <literal>,</literal>). However, when failover nodes are specified, the NIDs
 709     are delimited by a colon (
 710     <literal>:</literal>) or by repeating a keyword such as
 711     <literal>--mgsnode=</literal> or
 712     <literal>--servicenode=</literal>).</para>
 713     <para>To display the NIDs of all servers in networks configured to work
 714     with the Lustre file system, run (while LNet is running):</para>
 715     <screen>
 716 lctl list_nids
 717 </screen>
 718     <para>In the example below,
 719     <literal>mds0</literal> and
 720     <literal>mds1</literal> are configured as a combined MGS/MDT failover pair
 721     and
 722     <literal>oss0</literal> and
 723     <literal>oss1</literal> are configured as an OST failover pair. The Ethernet
 724     address for
 725     <literal>mds0</literal> is 192.168.10.1, and for
 726     <literal>mds1</literal> is 192.168.10.2. The Ethernet addresses for
 727     <literal>oss0</literal> and
 728     <literal>oss1</literal> are 192.168.10.20 and 192.168.10.21
 729     respectively.</para>
 730     <screen>
 731 mds0# mkfs.lustre --fsname=testfs --mdt --mgs \
 732         --servicenode=192.168.10.2@tcp0 \
 733         -–servicenode=192.168.10.1@tcp0 /dev/sda1
 734 mds0# mount -t lustre /dev/sda1 /mnt/test/mdt
 735 oss0# mkfs.lustre --fsname=testfs --servicenode=192.168.10.20@tcp0 \
 736         --servicenode=192.168.10.21 --ost --index=0 \
 737         --mgsnode=192.168.10.1@tcp0 --mgsnode=192.168.10.2@tcp0 \
 738         /dev/sdb
 739 oss0# mount -t lustre /dev/sdb /mnt/test/ost0
 740 client# mount -t lustre 192.168.10.1@tcp0:192.168.10.2@tcp0:/testfs \
 741         /mnt/testfs
 742 mds0# umount /mnt/mdt
 743 mds1# mount -t lustre /dev/sda1 /mnt/test/mdt
 744 mds1# lctl get_param mdt.testfs-MDT0000.recovery_status
 745 </screen>
 746     <para>Where multiple NIDs are specified separated by commas (for example,
 747     <literal>10.67.73.200@tcp,192.168.10.1@tcp</literal>), the two NIDs refer
 748     to the same host, and the Lustre software chooses the
 749     <emphasis>best</emphasis> one for communication. When a pair of NIDs is
 750     separated by a colon (for example,
 751     <literal>10.67.73.200@tcp:10.67.73.201@tcp</literal>), the two NIDs refer
 752     to two different hosts and are treated as a failover pair (the Lustre
 753     software tries the first one, and if that fails, it tries the second
 754     one.)</para>
 755     <para>Two options to
 756     <literal>mkfs.lustre</literal> can be used to specify failover nodes.
 757     Introduced in Lustre software release 2.0, the
 758     <literal>--servicenode</literal> option is used to specify all service NIDs,
 759     including those for primary nodes and failover nodes. When the
 760     <literal>--servicenode</literal> option is used, the first service node to
 761     load the target device becomes the primary service node, while nodes
 762     corresponding to the other specified NIDs become failover locations for the
 763     target device. An older option,
 764     <literal>--failnode</literal>, specifies just the NIDS of failover nodes.
 765     For more information about the
 766     <literal>--servicenode</literal> and
 767     <literal>--failnode</literal> options, see
 768     <xref xmlns:xlink="http://www.w3.org/1999/xlink"
 769     linkend="configuringfailover" />.</para>
 770   </section>
 771   <section xml:id="dbdoclet.50438194_70905">
 772     <title>
 773     <indexterm>
 774       <primary>operations</primary>
 775       <secondary>erasing a file system</secondary>
 776     </indexterm>Erasing a File System</title>
 777     <para>If you want to erase a file system and permanently delete all the
 778     data in the file system, run this command on your targets:</para>
 779     <screen>
 780 $ "mkfs.lustre --reformat"
 781 </screen>
 782     <para>If you are using a separate MGS and want to keep other file systems
 783     defined on that MGS, then set the
 784     <literal>writeconf</literal> flag on the MDT for that file system. The
 785     <literal>writeconf</literal> flag causes the configuration logs to be
 786     erased; they are regenerated the next time the servers start.</para>
 787     <para>To set the
 788     <literal>writeconf</literal> flag on the MDT:</para>
 789     <orderedlist>
 790       <listitem>
 791         <para>Unmount all clients/servers using this file system, run:</para>
 792         <screen>
 793 $ umount /mnt/lustre
 794 </screen>
 795       </listitem>
 796       <listitem>
 797         <para>Permanently erase the file system and, presumably, replace it
 798         with another file system, run:</para>
 799         <screen>
 800 $ mkfs.lustre --reformat --fsname spfs --mgs --mdt --index=0 /dev/
 801 <emphasis>{mdsdev}</emphasis>
 802 </screen>
 803       </listitem>
 804       <listitem>
 805         <para>If you have a separate MGS (that you do not want to reformat),
 806         then add the
 807         <literal>--writeconf</literal> flag to
 808         <literal>mkfs.lustre</literal> on the MDT, run:</para>
 809         <screen>
 810 $ mkfs.lustre --reformat --writeconf --fsname spfs --mgsnode=
 811 <replaceable>mgs_nid</replaceable> --mdt --index=0
 812 <replaceable>/dev/mds_device</replaceable>
 813 </screen>
 814       </listitem>
 815     </orderedlist>
 816     <note>
 817       <para>If you have a combined MGS/MDT, reformatting the MDT reformats the
 818       MGS as well, causing all configuration information to be lost; you can
 819       start building your new file system. Nothing needs to be done with old
 820       disks that will not be part of the new file system, just do not mount
 821       them.</para>
 822     </note>
 823   </section>
 824   <section xml:id="dbdoclet.50438194_16954">
 825     <title>
 826     <indexterm>
 827       <primary>operations</primary>
 828       <secondary>reclaiming space</secondary>
 829     </indexterm>Reclaiming Reserved Disk Space</title>
 830     <para>All current Lustre installations run the ldiskfs file system
 831     internally on service nodes. By default, ldiskfs reserves 5% of the disk
 832     space to avoid file system fragmentation. In order to reclaim this space,
 833     run the following command on your OSS for each OST in the file
 834     system:</para>
 835     <screen>
 836 tune2fs [-m reserved_blocks_percent] /dev/
 837 <emphasis>{ostdev}</emphasis>
 838 </screen>
 839     <para>You do not need to shut down Lustre before running this command or
 840     restart it afterwards.</para>
 841     <warning>
 842       <para>Reducing the space reservation can cause severe performance
 843       degradation as the OST file system becomes more than 95% full, due to
 844       difficulty in locating large areas of contiguous free space. This
 845       performance degradation may persist even if the space usage drops below
 846       95% again. It is recommended NOT to reduce the reserved disk space below
 847       5%.</para>
 848     </warning>
 849   </section>
 850   <section xml:id="dbdoclet.50438194_69998">
 851     <title>
 852     <indexterm>
 853       <primary>operations</primary>
 854       <secondary>replacing an OST or MDS</secondary>
 855     </indexterm>Replacing an Existing OST or MDT</title>
 856     <para>To copy the contents of an existing OST to a new OST (or an old MDT
 857     to a new MDT), follow the process for either OST/MDT backups in
 858     <xref linkend='dbdoclet.backup_device' />or
 859     <xref linkend='dbdoclet.backup_target_filesystem' />.
 860     For more information on removing a MDT, see
 861     <xref linkend='dbdoclet.rmremotedir' />.</para>
 862   </section>
 863   <section xml:id="dbdoclet.50438194_30872">
 864     <title>
 865     <indexterm>
 866       <primary>operations</primary>
 867       <secondary>identifying OSTs</secondary>
 868     </indexterm>Identifying To Which Lustre File an OST Object Belongs</title>
 869     <para>Use this procedure to identify the file containing a given object on
 870     a given OST.</para>
 871     <orderedlist>
 872       <listitem>
 873         <para>On the OST (as root), run
 874         <literal>debugfs</literal> to display the file identifier (
 875         <literal>FID</literal>) of the file associated with the object.</para>
 876         <para>For example, if the object is
 877         <literal>34976</literal> on
 878         <literal>/dev/lustre/ost_test2</literal>, the debug command is:
 879         <screen>
 880 # debugfs -c -R "stat /O/0/d$((34976 % 32))/34976" /dev/lustre/ost_test2
 881 </screen></para>
 882         <para>The command output is:
 883         <screen>
 884 debugfs 1.42.3.wc3 (15-Aug-2012)
 885 /dev/lustre/ost_test2: catastrophic mode - not reading inode or group bitmaps
 886 Inode: 352365   Type: regular    Mode:  0666   Flags: 0x80000
 887 Generation: 2393149953    Version: 0x0000002a:00005f81
 888 User:  1000   Group:  1000   Size: 260096
 889 File ACL: 0    Directory ACL: 0
 890 Links: 1   Blockcount: 512
 891 Fragment:  Address: 0    Number: 0    Size: 0
 892 ctime: 0x4a216b48:00000000 -- Sat May 30 13:22:16 2009
 893 atime: 0x4a216b48:00000000 -- Sat May 30 13:22:16 2009
 894 mtime: 0x4a216b48:00000000 -- Sat May 30 13:22:16 2009
 895 crtime: 0x4a216b3c:975870dc -- Sat May 30 13:22:04 2009
 896 Size of extra inode fields: 24
 897 Extended attributes stored in inode body:
 898   fid = "b9 da 24 00 00 00 00 00 6a fa 0d 3f 01 00 00 00 eb 5b 0b 00 00 00 0000
 899 00 00 00 00 00 00 00 00 " (32)
 900   fid: objid=34976 seq=0 parent=[0x24dab9:0x3f0dfa6a:0x0] stripe=1
 901 EXTENTS:
 902 (0-64):4620544-4620607
 903 </screen></para>
 904       </listitem>
 905       <listitem>
 906         <para>For Lustre software release 2.x file systems, the parent FID will
 907         be of the form [0x200000400:0x122:0x0] and can be resolved directly
 908         using the
 909         <literal>lfs fid2path [0x200000404:0x122:0x0]
 910         /mnt/lustre</literal> command on any Lustre client, and the process is
 911         complete.</para>
 912       </listitem>
 913       <listitem>
 914         <para>In this example the parent inode FID is an upgraded 1.x inode
 915         (due to the first part of the FID being below 0x200000400), the MDT
 916         inode number is
 917         <literal>0x24dab9</literal> and generation
 918         <literal>0x3f0dfa6a</literal> and the pathname needs to be resolved
 919         using
 920         <literal>debugfs</literal>.</para>
 921       </listitem>
 922       <listitem>
 923         <para>On the MDS (as root), use
 924         <literal>debugfs</literal> to find the file associated with the
 925         inode:</para>
 926         <screen>
 927 # debugfs -c -R "ncheck 0x24dab9" /dev/lustre/mdt_test
 928 </screen>
 929         <para>Here is the command output:</para>
 930         <screen>
 931 debugfs 1.42.3.wc2 (15-Aug-2012)
 932 /dev/lustre/mdt_test: catastrophic mode - not reading inode or group bitmap\
 933 s
 934 Inode      Pathname
 935 2415289    /ROOT/brian-laptop-guest/clients/client11/~dmtmp/PWRPNT/ZD16.BMP
 936 </screen>
 937       </listitem>
 938     </orderedlist>
 939     <para>The command lists the inode and pathname associated with the
 940     object.</para>
 941     <note>
 942       <para>
 943       <literal>Debugfs</literal>' ''ncheck'' is a brute-force search that may
 944       take a long time to complete.</para>
 945     </note>
 946     <note>
 947       <para>To find the Lustre file from a disk LBA, follow the steps listed in
 948       the document at this URL:
 949       <link xl:href="http://smartmontools.sourceforge.net/badblockhowto.html">
 950       http://smartmontools.sourceforge.net/badblockhowto.html</link>. Then,
 951       follow the steps above to resolve the Lustre filename.</para>
 952     </note>
 953   </section>
 954 </chapter>