From e1698b585176ea26b2967e18b4ecc668e1d24853 Mon Sep 17 00:00:00 2001 From: Richard Henwood Date: Wed, 18 May 2011 13:39:05 -0500 Subject: [PATCH] FIX: xrefs and tidying --- SystemConfigurationUtilities.xml | 347 +++++++++++++++++---------------------- 1 file changed, 152 insertions(+), 195 deletions(-) diff --git a/SystemConfigurationUtilities.xml b/SystemConfigurationUtilities.xml index f6615b3..41b370d 100644 --- a/SystemConfigurationUtilities.xml +++ b/SystemConfigurationUtilities.xml @@ -1,128 +1,89 @@ - + - System Configuration Utilities + System Configuration Utilities + This chapter includes system configuration utilities and includes the following sections: - e2scan + + - + + - l_getidentity + + - + + - lctl + + - + + - ll_decode_filter_fid + + - + + - ll_recover_lost_found_objs + + - + + - llobdstat + + - + + - llog_reader + + - + + - llstat + + - + + - llverdev + + - + + - lshowmount - - - - - - lst - - - - - - lustre_rmmod.sh - - - - - - lustre_rsync - - - - - - mkfs.lustre - - - - - - mount.lustre - - - - - - plot-llstat - - - - - - routerstat - - - - - - tunefs.lustre - - - - - - Additional System Configuration Utilities - - - + + -
- <anchor xml:id="dbdoclet.50438219_pgfId-1317399" xreflabel=""/> -
- 36.1 <anchor xml:id="dbdoclet.50438219_55923" xreflabel=""/>e2<anchor xml:id="dbdoclet.50438219_marker-1317398" xreflabel=""/>scan +
+ 36.1 e2<anchor xml:id="dbdoclet.50438219_marker-1317398" xreflabel=""/>scan The e2scan utility is an ext2 file system-modified inode scan program. The e2scan program uses libext2fs to find inodes with ctime or mtime newer than a given time and prints out their pathname. Use e2scan to efficiently generate lists of files that have been modified. The e2scan tool is included in the e2fsprogs package, located at: http://downloads.lustre.org/public/tools/e2fsprogs/
@@ -168,8 +129,8 @@
-
- 36.2 <anchor xml:id="dbdoclet.50438219_76969" xreflabel=""/>l_<anchor xml:id="dbdoclet.50438219_marker-1318227" xreflabel=""/>getidentity +
+ 36.2 l_<anchor xml:id="dbdoclet.50438219_marker-1318227" xreflabel=""/>getidentity The l_getidentity utility handles Lustre user / group cache upcall.
<anchor xml:id="dbdoclet.50438219_pgfId-1318230" xreflabel=""/>Synopsis @@ -213,8 +174,8 @@
-
- 36.3 <anchor xml:id="dbdoclet.50438219_38274" xreflabel=""/>lc<anchor xml:id="dbdoclet.50438219_marker-1302539" xreflabel=""/>tl +
+ 36.3 lc<anchor xml:id="dbdoclet.50438219_marker-1302539" xreflabel=""/>tl The lctl utility is used for root control and configuration. With lctl you can directly control Lustre via an ioctl interface, allowing various configuration, maintenance and debugging features to be accessed.
<anchor xml:id="dbdoclet.50438219_pgfId-1294259" xreflabel=""/>Synopsis @@ -284,7 +245,7 @@ For example: $ lctl list_param obdfilter.lustre-OST0000 - For more information on using lctl to set temporary and permanent parameters, see Setting Parameters with lctl. +For more information on using lctl to set temporary and permanent parameters, see (Setting Parameters with lctl). Network Configuration @@ -420,7 +381,7 @@ conf_param[-d] <device|fsname>.<parameter>=<value> - Sets a permanent configuration parameter for any device via the MGS. This command must be run on the MGS node.All writeable parameters under lctl list_param (e.g. lctl list_param -F osc.*.* | grep =) can be permanently set using lctl conf_param, but the format is slightly different. For conf_param, the device is specified first, then the obdtype. Wildcards are not supported. Additionally, failover nodes may be added (or removed), and some system-wide parameters may be set as well (sys.at_max, sys.at_min, sys.at_extra, sys.at_early_margin, sys.at_history, sys.timeout, sys.ldlm_timeout). For system-wide parameters, <device> is ignored.For more information on setting permanent parameters and lctl conf_param command examples, see Setting Permanent Parameters. + Sets a permanent configuration parameter for any device via the MGS. This command must be run on the MGS node.All writeable parameters under lctl list_param (e.g. lctl list_param -F osc.*.* | grep =) can be permanently set using lctl conf_param, but the format is slightly different. For conf_param, the device is specified first, then the obdtype. Wildcards are not supported. Additionally, failover nodes may be added (or removed), and some system-wide parameters may be set as well (sys.at_max, sys.at_min, sys.at_extra, sys.at_early_margin, sys.at_history, sys.timeout, sys.ldlm_timeout). For system-wide parameters, <device> is ignored.For more information on setting permanent parameters and lctl conf_param command examples, see (Setting Permanent Parameters).   @@ -442,16 +403,7 @@ - - - - - - Note -Lustre tunables are not always accessible using the procfs interface, as it is platform-specific. As a solution, lctl {get,set,list}_param has been introduced as a platform-independent interface to the Lustre tunables. Avoid direct references to /proc/{fs,sys}/{lustre,lnet}. For future portability, use lctl {get,set,list}_param instead. - - - - + Lustre tunables are not always accessible using the procfs interface, as it is platform-specific. As a solution, lctl {get,set,list}_param has been introduced as a platform-independent interface to the Lustre tunables. Avoid direct references to /proc/{fs,sys}/{lustre,lnet}. For future portability, use lctl {get,set,list}_param instead. Virtual Block Device Operations Lustre can emulate a virtual block device upon a regular file. This emulation is needed when you are trying to set up a swap space via the file. @@ -494,11 +446,11 @@ changelog_register - Registers a new changelog user for a particular device. Changelog entries are not purged beyond a registered user’s set point (see lfs changelog_clear). + Registers a new changelog user for a particular device. Changelog entries are not purged beyond a registered user's set point (see lfs changelog_clear). changelog_deregister<id> - Unregisters an existing changelog user. If the user’s "clear" record number is the minimum for the device, changelog records are purged until the next minimum. + Unregisters an existing changelog user. If the user's "clear" record number is the minimum for the device, changelog records are purged until the next minimum. @@ -595,11 +547,21 @@
<anchor xml:id="dbdoclet.50438219_pgfId-1315077" xreflabel=""/>See Also - mkfs.lustre, mount.lustre, lctl, lfs + + + + + + + + + + +
-
- 36.4 <anchor xml:id="dbdoclet.50438219_58217" xreflabel=""/>ll_decode_filter_fid +
+ 36.4 ll_decode_filter_fid The ll_decode_filter_fid utility displays the Lustre object ID and MDT parent FID.
<anchor xml:id="dbdoclet.50438219_pgfId-1318306" xreflabel=""/>Synopsis @@ -626,22 +588,13 @@
<anchor xml:id="dbdoclet.50438219_pgfId-1318322" xreflabel=""/>See Also - ll_recover_lost_found_objs +
-
- 36.5 <anchor xml:id="dbdoclet.50438219_44971" xreflabel=""/>ll_recover_lost_<anchor xml:id="dbdoclet.50438219_marker-1317865" xreflabel=""/>found_objs +
+ 36.5 ll_recover_lost_<anchor xml:id="dbdoclet.50438219_marker-1317865" xreflabel=""/>found_objs The ll_recover_lost_found_objs utility helps recover Lustre OST objects (file data) from a lost and found directory and return them to their correct locations. - - - - - - Note -Running the ll_recover_lost_found_objs tool is not strictly necessary to bring an OST back online, it just avoids losing access to objects that were moved to the lost and found directory due to directory corruption. - - - - + Running the ll_recover_lost_found_objs tool is not strictly necessary to bring an OST back online, it just avoids losing access to objects that were moved to the lost and found directory due to directory corruption.
<anchor xml:id="dbdoclet.50438219_pgfId-1317869" xreflabel=""/>Synopsis $ ll_recover_lost_found_objs [-hv] -d directory @@ -687,8 +640,8 @@
-
- 36.6 <anchor xml:id="dbdoclet.50438219_84890" xreflabel=""/>llobdstat +
+ 36.6 llobdstat The llobdstat utility displays OST statistics.
<anchor xml:id="dbdoclet.50438219_pgfId-1316536" xreflabel=""/>Synopsis @@ -724,9 +677,9 @@ unch: 18
-
- 36.7 <anchor xml:id="dbdoclet.50438219_90386" xreflabel=""/>llog_reader - The llog_reader utility parses Lustre’s on-disk configuration logs. +
+ 36.7 llog_reader + The llog_reader utility parses Lustre's on-disk configuration logs.
<anchor xml:id="dbdoclet.50438219_pgfId-1318201" xreflabel=""/>Synopsis llog_reader filename @@ -766,11 +719,11 @@ unch: 18
<anchor xml:id="dbdoclet.50438219_pgfId-1318212" xreflabel=""/>See Also - Section 21.1, Troubleshooting Lustre, tunefs.lustre +
-
- 36.8 <anchor xml:id="dbdoclet.50438219_23232" xreflabel=""/>ll<anchor xml:id="dbdoclet.50438219_marker-1318052" xreflabel=""/>stat +
+ 36.8 ll<anchor xml:id="dbdoclet.50438219_marker-1318052" xreflabel=""/>stat The llstat utility displays Lustre statistics.
<anchor xml:id="dbdoclet.50438219_pgfId-1318055" xreflabel=""/>Synopsis @@ -841,8 +794,8 @@ unch: 18
-
- 36.9 <anchor xml:id="dbdoclet.50438219_23648" xreflabel=""/>llverdev<anchor xml:id="dbdoclet.50438219_marker-1317750" xreflabel=""/> +
+ 36.9 llverdev<anchor xml:id="dbdoclet.50438219_marker-1317750" xreflabel=""/> The llverdev verifies a block device is functioning properly over its full size.
<anchor xml:id="dbdoclet.50438219_pgfId-1317753" xreflabel=""/>Synopsis @@ -932,8 +885,8 @@ unch: 18
-
- 36.10 <anchor xml:id="dbdoclet.50438219_64286" xreflabel=""/>lshowmount<anchor xml:id="dbdoclet.50438219_marker-1317690" xreflabel=""/> +
+ 36.10 lshowmount<anchor xml:id="dbdoclet.50438219_marker-1317690" xreflabel=""/> The lshowmount utility shows Lustre exports.
<anchor xml:id="dbdoclet.50438219_pgfId-1317693" xreflabel=""/>Synopsis @@ -984,8 +937,8 @@ rts/<uuid>/nid /proc/fs/lustre/obdfilter/<server>/exports/<uuid&g
-
- 36.11 <anchor xml:id="dbdoclet.50438219_90218" xreflabel=""/>l<anchor xml:id="dbdoclet.50438219_marker-1318121" xreflabel=""/><anchor xml:id="dbdoclet.50438219_marker-1318122" xreflabel=""/>st +
+ 36.11 l<anchor xml:id="dbdoclet.50438219_marker-1318121" xreflabel=""/><anchor xml:id="dbdoclet.50438219_marker-1318122" xreflabel=""/>st The lst utility starts LNET self-test.
<anchor xml:id="dbdoclet.50438219_pgfId-1318125" xreflabel=""/>Synopsis @@ -1036,22 +989,13 @@ k=full size=4K
-
- 36.12 <anchor xml:id="dbdoclet.50438219_54734" xreflabel=""/>lustre_<anchor xml:id="dbdoclet.50438219_marker-1317379" xreflabel=""/>rmmod.sh +
+ 36.12 lustre_<anchor xml:id="dbdoclet.50438219_marker-1317379" xreflabel=""/>rmmod.sh The lustre_rmmod.sh utility removes all Lustre and LNET modules (assuming no Lustre services are running). It is located in /usr/bin. - - - - - - Note -The lustre_rmmod.sh utility does not work if Lustre modules are being used or if you have manually run the lctl network up command. - - - - + The lustre_rmmod.sh utility does not work if Lustre modules are being used or if you have manually run the lctl network up command.
-
- 36.13 <anchor xml:id="dbdoclet.50438219_63667" xreflabel=""/>lustre_<anchor xml:id="dbdoclet.50438219_marker-1317224" xreflabel=""/>rsync +
+ 36.13 lustre_<anchor xml:id="dbdoclet.50438219_marker-1317224" xreflabel=""/>rsync The lustre_rsync utility synchronizes (replicates) a Lustre file system to a target file system.
<anchor xml:id="dbdoclet.50438219_pgfId-1317227" xreflabel=""/>Synopsis @@ -1073,17 +1017,13 @@ k=full size=4K A changelog user must be registered (see lctl (8) changelog_register) - - - + - AND - Verify that the Lustre file system (source) and the replica file system (target) are identical before the changelog user is registered. If the file systems are discrepant, use a utility, e.g. regular rsync (not lustre_rsync) to make them identical. - - - +
@@ -1187,11 +1127,11 @@ k=full size=4K
<anchor xml:id="dbdoclet.50438219_pgfId-1317346" xreflabel=""/>See Also - lctl, lfs +
-
- 36.14 <anchor xml:id="dbdoclet.50438219_75432" xreflabel=""/>mkfs.<anchor xml:id="dbdoclet.50438219_marker-1316695" xreflabel=""/>lustre +
+ 36.14 mkfs.<anchor xml:id="dbdoclet.50438219_marker-1316695" xreflabel=""/>lustre The mkfs.lustre utility formats a disk for a Lustre service.
<anchor xml:id="dbdoclet.50438219_pgfId-1316927" xreflabel=""/>Synopsis @@ -1232,7 +1172,7 @@ k=full size=4K
<anchor xml:id="dbdoclet.50438219_pgfId-1316744" xreflabel=""/>Description mkfs.lustre is used to format a disk device for use as part of a Lustre file system. After formatting, a disk can be mounted to start the Lustre service defined by this command. - When the file system is created, parameters can simply be added as a --param option to the mkfs.lustre command. See Setting Parameters with mkfs.lustre. + When the file system is created, parameters can simply be added as a --param option to the mkfs.lustre command. See . @@ -1267,7 +1207,7 @@ k=full size=4K --fsname=filesystem_name - The Lustre file system of which this service/node will be a part. The default file system name is “lustreâ€. NOTE: The file system name is limited to 8 characters. + The Lustre file system of which this service/node will be a part. The default file system name is 'lustreâ€. The file system name is limited to 8 characters. --index=index @@ -1323,7 +1263,7 @@ k=full size=4K --stripe-count-hint=stripes - Used to optimize the MDT’s inode size. + Used to optimize the MDT's inode size. --verbose @@ -1350,11 +1290,19 @@ k=full size=4K
<anchor xml:id="dbdoclet.50438219_pgfId-1316899" xreflabel=""/>See Also - mkfs.lustre, mount.lustre, lfs + + + mkfs.lustre, + + mount.lustre, + + lfs + +
-
- 36.15 <anchor xml:id="dbdoclet.50438219_12635" xreflabel=""/>mount.<anchor xml:id="dbdoclet.50438219_marker-1310637" xreflabel=""/>lustre +
+ 36.15 mount.<anchor xml:id="dbdoclet.50438219_marker-1310637" xreflabel=""/>lustre The mount.lustre utility starts a Lustre client or target service.
<anchor xml:id="dbdoclet.50438219_pgfId-1310640" xreflabel=""/>Synopsis @@ -1525,11 +1473,21 @@ k=full size=4K
<anchor xml:id="dbdoclet.50438219_pgfId-1315248" xreflabel=""/>See Also - mkfs.lustre, tunefs.lustre, lctl, lfs + + + + + + + + + + +
-
- 36.16 <anchor xml:id="dbdoclet.50438219_82679" xreflabel=""/>plot-<anchor xml:id="dbdoclet.50438219_marker-1317989" xreflabel=""/>llstat +
+ 36.16 plot-<anchor xml:id="dbdoclet.50438219_marker-1317989" xreflabel=""/>llstat The plot-llstat utility plots Lustre statistics.
<anchor xml:id="dbdoclet.50438219_pgfId-1317992" xreflabel=""/>Synopsis @@ -1574,8 +1532,8 @@ k=full size=4K
-
- 36.17 <anchor xml:id="dbdoclet.50438219_51496" xreflabel=""/>router<anchor xml:id="dbdoclet.50438219_marker-1317921" xreflabel=""/>stat +
+ 36.17 router<anchor xml:id="dbdoclet.50438219_marker-1317921" xreflabel=""/>stat The routerstat utility prints Lustre router statistics.
<anchor xml:id="dbdoclet.50438219_pgfId-1317924" xreflabel=""/>Synopsis @@ -1635,8 +1593,8 @@ k=full size=4K
-
- 36.18 <anchor xml:id="dbdoclet.50438219_39574" xreflabel=""/>tunefs.<anchor xml:id="dbdoclet.50438219_marker-1317076" xreflabel=""/>lustre +
+ 36.18 tunefs.<anchor xml:id="dbdoclet.50438219_marker-1317076" xreflabel=""/>lustre The tunefs.lustre utility modifies configuration information on a Lustre target disk.
<anchor xml:id="dbdoclet.50438219_pgfId-1317079" xreflabel=""/>Synopsis @@ -1704,7 +1662,7 @@ k=full size=4K --fsname=filesystem_name - The Lustre file system of which this service will be a part. The default file system name is “lustreâ€. + The Lustre file system of which this service will be a part. The default file system name is 'lustreâ€. --index=index @@ -1748,7 +1706,7 @@ k=full size=4K
<anchor xml:id="dbdoclet.50438219_pgfId-1317194" xreflabel=""/>Examples - Change the MGS’s NID address. (This should be done on each target disk, since they should all contact the same MGS.) + Change the MGS's NID address. (This should be done on each target disk, since they should all contact the same MGS.) tunefs.lustre --erase-param --mgsnode=<new_nid> --writeconf /dev/sda Add a failover NID location for this target. @@ -1757,11 +1715,21 @@ k=full size=4K
<anchor xml:id="dbdoclet.50438219_pgfId-1317199" xreflabel=""/>See Also - mkfs.lustre, mount.lustre, lctl, lfs + + + + + + + + + + +
-
- 36.19 <anchor xml:id="dbdoclet.50438219_99928" xreflabel=""/>Additional System <anchor xml:id="dbdoclet.50438219_marker-1313048" xreflabel=""/>Configuration Utilities +
+ 36.19 Additional System <anchor xml:id="dbdoclet.50438219_marker-1313048" xreflabel=""/>Configuration Utilities This section describes additional system configuration utilities for Lustre.
<anchor xml:id="dbdoclet.50438219_pgfId-1294829" xreflabel=""/>36.19.1 Application <anchor xml:id="dbdoclet.50438219_marker-1313051" xreflabel=""/>Profiling Utilities @@ -1793,9 +1761,7 @@ k=full size=4K Per-client statistics tracked on the servers - - - + Each MDT and OST now tracks LDLM and operations statistics for every connected client, for comparisons and simpler collection of distributed job statistics. /proc/fs/lustre/mds|obdfilter/*/exports/ @@ -1803,9 +1769,7 @@ k=full size=4K Improved MDT statistics - - - + More detailed MDT operations statistics are collected for better profiling. /proc/fs/lustre/mds/*/stats @@ -1922,15 +1886,11 @@ tests 5 times each Many (echo) clients cache locks for the specified resource at the same time. - - - + Many (echo) clients enqueue locks for the specified resource simultaneously. - - - + @@ -1938,11 +1898,9 @@ tests 5 times each - Fold the Lustre I/O kit’s obdsurvey script functionality into loadgen - - - + Fold the Lustre I/O kit's obdsurvey script functionality into loadgen + @@ -1958,13 +1916,13 @@ tests 5 times each
<anchor xml:id="dbdoclet.50438219_pgfId-1315458" xreflabel=""/>Description - llog_reader parses the binary format of Lustre’s on-disk configuration logs. It can only read the logs. Use tunefs.lustre to write to them. - To examine a log file on a stopped Lustre server, mount its backing file system as ldiskfs, then use llog_reader to dump the log file’s contents. For example: + llog_reader parses the binary format of Lustre's on-disk configuration logs. It can only read the logs. Use tunefs.lustre to write to them. + To examine a log file on a stopped Lustre server, mount its backing file system as ldiskfs, then use llog_reader to dump the log file's contents. For example: mount -t ldiskfs /dev/sda /mnt/mgs llog_reader /mnt/mgs/CONFIGS/tfs-client To examine the same log file on a running Lustre server, use the ldiskfs-enabled debugfs utility (called debug.ldiskfs on some distributions) to extract the file. For example: - debugfs -c -R ’dump CONFIGS/tfs-client /tmp/tfs-client’ /dev/sda + debugfs -c -R 'dump CONFIGS/tfs-client /tmp/tfs-client' /dev/sda llog_reader /tmp/tfs-client @@ -1988,12 +1946,12 @@ tests 5 times each See Also - tunefs.lustre +
<anchor xml:id="dbdoclet.50438219_pgfId-1294873" xreflabel=""/>lr_reader The lr_reader utility translates a last received (last_rcvd) file into human-readable form. - The following utilites are part of the Lustre I/O kit. For more information, see Chapter 24:Benchmarking Lustre Performance (Lustre I/O Kit). + The following utilites are part of the Lustre I/O kit. For more information, see .
<anchor xml:id="dbdoclet.50438219_pgfId-1318396" xreflabel=""/>sgpdd_survey @@ -2038,7 +1996,7 @@ tests 5 times each
<anchor xml:id="dbdoclet.50438219_pgfId-1295755" xreflabel=""/>36.19.4 Flock <anchor xml:id="dbdoclet.50438219_marker-1295910" xreflabel=""/>Feature - Lustre now includes the flock feature, which provides file locking support. Flock describes classes of file locks known as ‘flocks’. Flock can apply or remove a lock on an open file as specified by the user. However, a single file may not, simultaneously, have both shared and exclusive locks. + Lustre now includes the flock feature, which provides file locking support. Flock describes classes of file locks known as 'flocks'. Flock can apply or remove a lock on an open file as specified by the user. However, a single file may not, simultaneously, have both shared and exclusive locks. By default, the flock utility is disabled on Lustre. Two modes are available. @@ -2047,7 +2005,7 @@ tests 5 times each local mode - In this mode, locks are coherent on one node (a single-node flock), but not across all clients. To enable it, use -o localflock. This is a client-mount option.NOTE: This mode does not impact performance and is appropriate for single-node databases. + In this mode, locks are coherent on one node (a single-node flock), but not across all clients. To enable it, use -o localflock. This is a client-mount option.This mode does not impact performance and is appropriate for single-node databases. consistent mode @@ -2067,5 +2025,4 @@ tests 5 times each
-
-- 1.8.3.1