Whamcloud - gitweb
Branch HEAD
[fs/lustre-release.git] / lustre / doc / lmc.lyx
index fb14d0e..48fcb4b 100644 (file)
@@ -119,11 +119,7 @@ net
 \series default 
 ,
 \series bold 
-\series default 
-or
-\series bold 
- echo_client.
+ echo_client, or cobd.
  
 \series default 
 We describe the arguments required for the addition of each 
@@ -172,6 +168,20 @@ The arguments required are:
 --upcall\SpecialChar ~
 <path> Specify the location of both (Lustre and Portals) upcall
  scripts used by the client for recovery
+\layout Description
+
+--group_upcall\SpecialChar ~
+<path> Specify the location of the group upcall scripts used by the MDS
+ for determiningsupplementary group membership
+\layout Description
+
+--ptldebug\SpecialChar ~
+<debug_level> Set the portals debug level.
+\layout Description
+
+--subsytem\SpecialChar ~
+<subsystem_name> Specify which Lustre subsystems have debug output
+ recorded in the log.
 \end_deeper 
 \layout Description
 
@@ -195,9 +205,9 @@ The arguments required are:
 \layout Description
 
 --nettype\SpecialChar ~
-<type> This can be 
+<type> Specify the network type.This can be 
 \series bold 
-tcp, elan, gm, scimac.
+tcp, elan, gm.
 \layout Description
 
 --nid\SpecialChar ~
@@ -231,7 +241,13 @@ client
  configuration.
 \layout Description
 
---hostaddr addr
+--cluster_id\SpecialChar ~
+id Specify the cluster ID.
+\layout Description
+
+--hostaddr\SpecialChar ~
+addr Specify the host address.
+ lconf will transfer it to the real host address.
 \layout Description
 
 --router Optional flag to mark this node as a router
@@ -272,7 +288,14 @@ name> Name of the node on which the MDS resides
 \layout Description
 
 --mds\SpecialChar ~
-<mds_name> 
+<mds_name> Specify MDS name.
+\layout Description
+
+--mdsuuid\SpecialChar ~
+<uuid> Specify MDS uuid.
+\layout Description
+
+--failover Enable failover support on MDS.
 \layout Description
 
 --dev\SpecialChar ~
@@ -295,20 +318,61 @@ name> Name of the node on which the MDS resides
 \layout Description
 
 --fstype\SpecialChar ~
-extN|ext3 Optional argument used to specify the file system type.
- Default is ext3.
+ldiskfs|ext3 Optional argument used to specify the file system type.
+ Default is ext3.  For 2.6 kernels the ldiskfs filesystem must be used.
+\layout Description
+
+--inode_size\SpecialChar ~
+<size> Specify new inode size for underlying ext3 file system.  Must be a
+ power of 2 between 128 and 4096.  The default inode size is selected based
+ on the default number of stripes specified for the filesystem.
+\layout Description
+
+--group_upcall\SpecialChar ~
+<pathname> The group upcall program to call for resolving a user's secondary
+ groups.  The default value is NONE, which means that the MDS will use whatever
+ supplementary group is passed from the client.  The supplied upcall is
+ /usr/sbin/l_getgroups, which gets groups from the MDS's /etc/group file
+ based on the client-supplied UID.
+
+--mkfsoptions\SpecialChar ~
+<options> Optional argument to mkfs.
+\layout Description
+
+--mountfsoptions\SpecialChar ~
+<options> Optional argument to mount fs.
+ Mount options will be passed by this argument.
+ For example, extents are to be enabled by adding ",extents" to the --mountfsopt
+ions option.
+\begin_inset Quotes eld
+\end_inset 
+
+errors=remount-ro
+\begin_inset Quotes erd
+\end_inset 
+
+ and 
+\begin_inset Quotes eld
+\end_inset 
+
+asyncdel
+\begin_inset Quotes erd
+\end_inset 
+
+ can also be added to it.
 \layout Description
 
 --journal_size\SpecialChar ~
 <size> Optional arguement to specify the journal size for
- the ext2/ext3 file system.
+ the ext3 file system.
  The size should be in the units expected by 
 \series bold 
 mkfs
 \series default 
 , so for ext3 it should be in MB.
- If this is option is not used, the ext2/ext3 filesystem will be configured
- with the default journal size.
+ If this is option is not used, the ext3 filesystem will be configured
+ with a journal size dependent upon how large the filesystem is.
 \end_deeper 
 \layout Description
 
@@ -323,21 +387,21 @@ mds_name
 \layout Description
 
 --lov\SpecialChar ~
-<name>
+<name> Specify LOV name.
 \layout Description
 
 --mds\SpecialChar ~
-<name>
+<name> Specify the mds name.
 \layout Description
 
 --stripe_sz\SpecialChar ~
-<size>
+<size> Specify the stripe size in bytes.  This much data is written to each
+ stripe before starting to write in the next stripe.  Default is 1048576.
 \layout Description
 
 --stripe_cnt\SpecialChar ~
-<count> A value of 0 for this means to stripe on all available
- OSTs.
- Default is 0.
+<count> A value of 0 for this means to use the currently optimal number
+ of stripes.  Default is 1 stripe per file.
 \layout Description
 
 --stripe_pattern\SpecialChar ~
@@ -360,6 +424,9 @@ ost Creates an OBD, OST, and OSC.
  node.
 \layout Description
 
+--failover Enable failover support on OST.
+\layout Description
+
 --dev\SpecialChar ~
 <pathname> Path of device on local system.
  If this is a file, then a loop device is created and used as the block
@@ -371,8 +438,8 @@ ost Creates an OBD, OST, and OSC.
  to be created (used typically for loop devices).
 \layout Description
 
---obdtype\SpecialChar ~
-obdfilter|obdecho 
+--osdtype\SpecialChar ~
+obdfilter|obdecho Specify the type of OSD.
 \layout Description
 
 --lov\SpecialChar ~
@@ -387,26 +454,57 @@ UUID Specify the UUID of the OST device.
 \layout Description
 
 --fstype\SpecialChar ~
-extN|ext3 Optional arguement used to specify the file system type.
+ldiskfs|ext3 Optional arguement used to specify the file system type.
  Default is ext3.
 \layout Description
 
+--inode_size\SpecialChar ~
+<size> Specify new inode size for underlying ext3 file system.
+\layout Description
+
+--mkfsoptions\SpecialChar ~
+<options> Optional argument to mkfs.
+\layout Description
+
+--mountfsoptions\SpecialChar ~
+<options> Optional argument to mount fs.
+ Mount options will be passed by this argument.
+ For example, extents are to be enabled by adding ",extents" to the --mountfsopt
+ions option.
+\begin_inset Quotes eld
+\end_inset 
+
+errors=remount-ro
+\begin_inset Quotes erd
+\end_inset 
+
+ and 
+\begin_inset Quotes eld
+\end_inset 
+
+asyncdel
+\begin_inset Quotes erd
+\end_inset 
+
+ can also be added to it.
+\layout Description
+
 --journal_size\SpecialChar ~
 <size> Optional arguement to specify the journal size for
- the ext2/ext3 file system.
+ the ext3 file system.
  The size should be in the units expected by 
 \series bold 
 mkfs
 \series default 
 , so for ext3 it should be in MB.
- If this is option is not used, the ext2/ext3 filesystem will be configured
- with the default journal size.
+ If this is option is not used, the ext3 filesystem will be configured
+ with a journal size dependent upon how large the filesystem is.
 \end_deeper 
 \layout Description
 
 --add\SpecialChar ~
-mtpt Creates a mount-point on the specified node.
- Either an LOV or OSC name can be used.
+mtpt Creates a mount-point on the specified node for the given LOV.
 \begin_deeper 
 \layout Description
 
@@ -419,19 +517,23 @@ mtpt
 \layout Description
 
 --path\SpecialChar ~
-/mnt/path\SpecialChar ~
-
+/mnt/path Specify the mountpoint for Lustre.
 \layout Description
 
 --mds\SpecialChar ~
-mds_name 
+mds_name Specify the mds name, which will provide service for this
+ client.
 \layout Description
 
 --ost\SpecialChar ~
 ost_name\SpecialChar ~
 |\SpecialChar ~
 --lov\SpecialChar ~
-lov_name
+lov_name Specify the ost or lov, which will provide service
+ for this client.
+\layout Description
+
+--clientoptions Specify the options for Lustre, such as async.
 \end_deeper 
 \layout Description
 
@@ -452,6 +554,9 @@ nid
 node Node to add the route to.
 \layout Description
 
+--router Optional flag to mark a node as router.
+\layout Description
+
 --gw\SpecialChar ~
 nid The 
 \emph on 
@@ -460,10 +565,14 @@ nid
  of the gateway (must be a local interface or a peer).
 \layout Description
 
---tgt\SpecialChar ~
-nid For a specific route, this is the target 
-\emph on 
-nid.
+--gateway_cluster_id\SpecialChar ~
+id Specify the id of the cluster, to which the gateway
+ belongs.
+\layout Description
+
+--target_cluster_id\SpecialChar ~
+id Specify the id of the cluster, to which the target
+ of the route belongs.
 \layout Description
 
 --lo\SpecialChar ~
@@ -486,13 +595,14 @@ echo-client Used for testing purpose only.
 \layout Description
 
 --node\SpecialChar ~
-node
+nodename
 \emph on 
  
+\emph default 
+Node on which the echo-client resides.
+\end_deeper 
 \layout Description
 
---obd\SpecialChar ~
-obd_name 
 \end_deeper 
 \layout List
 \labelwidthstring 00.00.0000
@@ -502,6 +612,16 @@ obd_name
 Options
 \layout Description
 
+--reference Print short reference for commands.
+\layout Description
+
+--verbose Print system commands as they are run.
+\layout Description
+
+--batch\SpecialChar ~
+filename Used to execute lmc commands in batch mode.
+\layout Description
+
 --output\SpecialChar ~
 filename Send output to the file.
  If the file exists, it will be overwritten.
@@ -517,9 +637,51 @@ Add the new element to an existing file.
 \layout Subsection
 
 EXAMPLES
+\layout Subsubsection
+
+--add net
+\layout Standard
+
+
+\series bold 
+lmc --node adev3 --add net --nid adev3 --cluster_id 0x1000 --nettype tcp
+ --hostaddr adev3-eth0 --port 988
+\layout Standard
+
+
+\series bold 
+lmc --node adev3 --add net --nid adev3 --cluster_id 0x2000 --nettype tcp
+ --hostaddr adev3-eth1 --port 989
+\series default 
+\emph on 
+\layout Standard
+
+Used to add a Lustre node to a specified Lustre cluster through a network
+ interface.
+ In this example, Lustre node adev3 has been added to 2 Lustre clusters
+ whose cluster_id are 0x1000 and 0x2000 separately through 2 network interface
+ cards: adev3-eth0 and adev3-eth1.
+ adev3 would listen in some specified port(s) to prepare for possible connection
+ requests from nodes in these two clusters.
+\layout Subsubsection
+
+--add route
+\layout Standard
+
+
+\series bold 
+lmc --node adev3 --add route --nettype tcp --gw 5 --gateway_cluster_id 0x1000
+ --target_cluster_id 0x1000 --lo 4 --hi 7
 \layout Standard
 
-Real life examples are given in the Lustre-conf manual page.
+Used to add a route entry for a Lustre node.
+ Here Lustre node adev3 is told it has a new route entry that now it could
+ send packets to Lustre nodes whose nids is from 4 to 7 with the help of
+ Lustre gateway node whose nid is 5.
+ Besides, Lustre gateway node is in cluster whose id is 0x1000 and target
+ of the route belongs to cluster whose id is also 0x1000.
+ The network in this route path is a tcp network.
 \layout Subsection
 
 BUGS