Whamcloud - gitweb
- configurable stack size fo x86_64
[fs/lustre-release.git] / lustre / doc / lmc.lyx
index 02ac31e..5a73e06 100644 (file)
@@ -1,5 +1,5 @@
-#LyX 1.2 created this file. For more info see http://www.lyx.org/
-\lyxformat 220
+#LyX 1.3 created this file. For more info see http://www.lyx.org/
+\lyxformat 221
 \textclass amsart
 \language english
 \inputencoding auto
@@ -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 
@@ -142,6 +138,53 @@ To generate configuration data associated with systems in a Lustre cluster:
 -
 \emph default 
 -add\SpecialChar ~
+node Adds a new node in the cluster configuration.
+\begin_deeper 
+\layout Standard
+
+The arguments required are:
+\layout Description
+
+--node\SpecialChar ~
+''node_name'' This will create a new node with the given name if not
+ already present.
+\layout Description
+
+--timeout\SpecialChar ~
+<num> Timeout before going into recovery
+\layout Description
+
+--lustre_upcall\SpecialChar ~
+<path> Set the location of the Lustre upcall scripts used
+ by the client for recovery
+\layout Description
+
+--portals_upcall\SpecialChar ~
+<path> Specify the location of the Portals upcall scripts
+ used by the client for recovery
+\layout Description
+
+--upcall\SpecialChar ~
+<path> Specify the location of both (Lustre and Portals) upcall
+ scripts used by the client for recovery
+\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
+
+
+\emph on 
+-
+\emph default 
+-add\SpecialChar ~
 net Adds a network device descriptor for the given node, with parameters
  as indicated.
 \begin_deeper 
@@ -157,7 +200,7 @@ 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.
 \layout Description
@@ -171,31 +214,61 @@ id
  ElanID or IP address as used by Portals.
  If 
 \emph on 
-host_name
+nid
 \emph default 
- is '*', then the local address while be substituted when the node is configured
- with lconf.
+ is '*', then the local address of the interface with specified 
+\series bold 
+nettype 
+\series default 
+is will be substituted when the node is configured with lconf.
+ An 
+\emph on 
+nid
+\emph default 
+ of 
+\emph on 
+'*'
+\emph default 
+ should be used only for the generic 
+\emph on 
+client
+\emph default 
+ configuration.
 \layout Description
 
---router Optional flag to mark this node as a router
+--cluster_id\SpecialChar ~
+id Specify the cluster ID.
 \layout Description
 
---profile Optional flag to mark this node as a profile node.
- This is automatically true if the the 
-\emph on 
---nid
-\emph default 
- argument contains a '*'.
+--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
 \layout Description
 
 --port\SpecialChar ~
-[port] Optional argument to indicate the tcp port.
+[port] Optional arguement to indicate the tcp port.
  The default is 988.
  
 \layout Description
 
 --tcpbuf\SpecialChar ~
-<size> Optional argument.
+<size> Optional arguement.
+ The default TCP buffer size is 1MB.
+\layout Description
+
+--irq_affinity\SpecialChar ~
+0|1 Optional arguement.
+ Default is 0.
+\layout Description
+
+--nid_exchange\SpecialChar ~
+0|1 Optional arguement since some OSTs might not have the
+ required support.
+ This is turned off by default, value of 1 will turn it ON.
 \end_deeper 
 \layout Description
 
@@ -204,8 +277,16 @@ mds
 \begin_deeper 
 \layout Description
 
+--node\SpecialChar ~
+<node\SpecialChar ~
+name> Name of the node on which the MDS resides
+\layout Description
+
 --mds\SpecialChar ~
-<mds_name> 
+<mds_name> Specify MDS name.
+\layout Description
+
+--failover Enable failover support on MDS.
 \layout Description
 
 --dev\SpecialChar ~
@@ -213,9 +294,13 @@ mds
  If the is a file, then a loop device is created and used as the block device.
 \layout Description
 
+--backdev\SpecialChar ~
+<pathname> Path of the device for backing storage on local system.
+\layout Description
+
 --size\SpecialChar ~
-<size> Optional argument indicating the size of the device to be created
- (used typically for loop devices).
+<size> Optional argument indicating the size (in KB) of the device
to be created (used typically for loop devices).
 \layout Description
 
 --node\SpecialChar ~
@@ -225,6 +310,63 @@ mds
 --node
 \emph default 
  argument, and it must not be a profile node.
+\layout Description
+
+--fstype\SpecialChar ~
+extN|ext3 Optional argument used to specify the file system type.
+ Default is ext3.
+\layout Description
+
+--backfstype\SpecialChar ~
+ext3|tmpfs Optional argument to specify the backing filesystem
+ type.
+\layout Description
+
+--nspath Local mount point of server namespace.
+\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 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.
 \end_deeper 
 \layout Description
 
@@ -238,22 +380,26 @@ mds_name
 \begin_deeper 
 \layout Description
 
---lov_<name>
+--lov\SpecialChar ~
+<name> Specify LOV name.
 \layout Description
 
---mds_<name>
+--mds\SpecialChar ~
+<name> Specify the mds name.
 \layout Description
 
 --stripe_sz\SpecialChar ~
-<size>
+<size> Specify the stripe size in bytes.
 \layout Description
 
 --stripe_cnt\SpecialChar ~
-<count>
+<count> A value of 0 for this means to stripe on all available
+ OSTs.
+ Default is 0.
 \layout Description
 
 --stripe_pattern\SpecialChar ~
-<pattern> Pattern can be 0.
+<pattern> Only Pattern 0 (RAID 0) is supported currently.
 \end_deeper 
 \layout Description
 
@@ -263,8 +409,8 @@ ost Creates an OBD, OST, and OSC.
 \begin_deeper 
 \layout Description
 
---obd\SpecialChar ~
-<name> Assign a name to the OBD device.
+--ost\SpecialChar ~
+<name> Assign a name to the OST device.
 \layout Description
 
 --node\SpecialChar ~
@@ -272,28 +418,94 @@ 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
  device.
 \layout Description
 
+--backdev\SpecialChar ~
+<pathname> Path of the device for backing storage on local system.
+\layout Description
+
 --size\SpecialChar ~
-[size]
+[size] Optional argument indicating the size (in KB) of the device
+ to be created (used typically for loop devices).
+\layout Description
+
+--osdtype\SpecialChar ~
+obdfilter|obdecho Specify the type of OSD.
 \layout Description
 
 --lov\SpecialChar ~
-<name> Name of LOV to which this OSC will be attached.
+<name> Optional arguement.
+ Name of LOV to which this OSC will be attached.
  
 \layout Description
 
---obduuid\SpecialChar ~
-UUID Specify the UUID of the OBD device.
- The default value is 
-\emph on 
-OBD_nodename_UUID
-\emph default 
-.
+--ostuuid\SpecialChar ~
+UUID Specify the UUID of the OST device.
+\layout Description
+
+--fstype\SpecialChar ~
+extN|ext3 Optional arguement used to specify the file system type.
+ Default is ext3.
+\layout Description
+
+--backfstype\SpecialChar ~
+ext3|tmpfs Optional argument to specify the backing filesystem
+ type.
+\layout Description
+
+--inode_size\SpecialChar ~
+<size> Specify new inode size for underlying ext3 file system.
+\layout Description
+
+--nspath Local mount point of server namespace.
+\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 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.
 \end_deeper 
 \layout Description
 
@@ -312,19 +524,20 @@ 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
 
---obd\SpecialChar ~
-obd_name\SpecialChar ~
+--ost\SpecialChar ~
+ost_name\SpecialChar ~
 |\SpecialChar ~
 --lov\SpecialChar ~
-lov_name
+lov_name Specify the ost or lov, which will provide service
+ for this client.
 \end_deeper 
 \layout Description
 
@@ -342,7 +555,10 @@ nid
 \layout Description
 
 --node\SpecialChar ~
-node Node or profile node to add the route to.
+node Node to add the route to.
+\layout Description
+
+--router Optional flag to mark a node as router.
 \layout Description
 
 --gw\SpecialChar ~
@@ -353,10 +569,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 ~
@@ -373,18 +593,48 @@ nid.
 \layout Description
 
 --add\SpecialChar ~
-echo-client Used for testing
+echo-client Used for testing purpose only.
 \begin_deeper 
 \layout Description
 
 --node\SpecialChar ~
-node
+nodename
 \emph on 
  
+\emph default 
+Node on which the echo-client resides.
+\end_deeper 
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold 
+--add\SpecialChar ~
+cobd 
+\series default 
+Create the cobd on the specified node.
+\begin_deeper 
+\layout Description
+\noindent \align left 
+--node\SpecialChar ~
+nodename
+\emph on 
+\emph default 
+Node on which the cobd resides.
+\layout Description
+
+--cache_obd\SpecialChar ~
+obd_name Specify the cache device for the cache obd system.
 \layout Description
 
---obd\SpecialChar ~
-obd_name 
+--real_obd\SpecialChar ~
+obd_name
+\emph on 
+\emph default 
+Specify the real device for the cache obd system.
 \end_deeper 
 \layout List
 \labelwidthstring 00.00.0000
@@ -394,6 +644,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.