Whamcloud - gitweb
Branch HEAD
[fs/lustre-release.git] / lustre / doc / lmc.lyx
index 183994b..48fcb4b 100644 (file)
-#LyX 1.3 created this file. For more info see http://www.lyx.org/\r
-\lyxformat 221\r
-\textclass amsart\r
-\language english\r
-\inputencoding auto\r
-\fontscheme times\r
-\graphics default\r
-\paperfontsize default\r
-\spacing single \r
-\papersize letterpaper\r
-\paperpackage a4\r
-\use_geometry 0\r
-\use_amsmath 0\r
-\use_natbib 0\r
-\use_numerical_citations 0\r
-\paperorientation portrait\r
-\secnumdepth 3\r
-\tocdepth 3\r
-\paragraph_separation skip\r
-\defskip medskip\r
-\quotes_language english\r
-\quotes_times 2\r
-\papercolumns 1\r
-\papersides 1\r
-\paperpagestyle default\r
-\r
-\layout Section\r
-\r
-lmc\r
-\layout Subsection\r
-\r
-NAME\r
-\layout Description\r
-\r
-lmc Lustre configuration maker.\r
-\layout Subsection\r
-\r
-SYNOPSIS\r
-\layout Standard\r
-\r
-\r
-\series bold \r
-lmc [options] --add <objectype> [args] \r
-\layout Standard\r
-\r
-\r
-\series bold \r
-lmc [options] --remove <objecttype> [args] -- [NOT IMPLEMENTED]\r
-\layout Standard\r
-\r
-\r
-\series bold \r
-lmc [options] --convert [args] -- [NOT IMPLEMENTED]\r
-\layout Subsection\r
-\r
-DESCRIPTION\r
-\layout Standard\r
-\r
-At present \r
-\series bold \r
-\emph on \r
-lmc\r
-\series default \r
-\emph default \r
-, when invoked, adds configuration data to the config file.\r
- In future, \r
-\series bold \r
-\emph on \r
-lmc\r
-\series default \r
-\emph default \r
- will also be able to remove configuration data or convert its format.\r
- A Lustre cluster consists of several components - MDS's, mount-points,\r
- OSTs, LOVs and whatever those reference (e.g nets and profiles).\r
- A single configuration file would be generated for the complete cluster.\r
- In the \r
-\series bold \r
-\emph on \r
-lmc\r
-\series default \r
-\emph default \r
- command line interface, each of these components is associated with an\r
\r
-\emph on \r
-objecttype\r
-\emph default \r
-.\r
\r
-\layout Standard\r
-\r
-The \r
-\emph on \r
-objecttype\r
-\emph default \r
- refers to a collection of related configuration entities and can be one\r
- of \r
-\series bold \r
-net\r
-\series default \r
-,\r
-\series bold \r
- MDS\r
-\series default \r
-,\r
-\series bold \r
- LOV\r
-\series default \r
-,\r
-\series bold \r
- OST\r
-\series default \r
-,\r
-\series bold \r
- mtpt\r
-\series default \r
-,\r
-\series bold \r
- route\r
-\series default \r
-,\r
-\series bold \r
- echo_client, or cobd.\r
\r
-\series default \r
-We describe the arguments required for the addition of each \r
-\emph on \r
-objecttype\r
-\emph default \r
-.\r
\r
-\layout Standard\r
-\r
-To generate configuration data associated with systems in a Lustre cluster:\r
-\layout Description\r
-\r
-\r
-\emph on \r
--\r
-\emph default \r
--add\SpecialChar ~\r
-node Adds a new node in the cluster configuration.\r
\r
-\begin_deeper \r
-\layout Standard\r
-\r
-The arguments required are:\r
-\layout Description\r
-\r
---node\SpecialChar ~\r
-''node_name'' This will create a new node with the given name if not\r
- already present.\r
-\layout Description\r
-\r
---timeout\SpecialChar ~\r
-<num> Timeout before going into recovery\r
-\layout Description\r
-\r
---lustre_upcall\SpecialChar ~\r
-<path> Set the location of the Lustre upcall scripts used\r
- by the client for recovery\r
-\layout Description\r
-\r
---portals_upcall\SpecialChar ~\r
-<path> Specify the location of the Portals upcall scripts\r
- used by the client for recovery\r
-\layout Description\r
-\r
---upcall\SpecialChar ~\r
-<path> Specify the location of both (Lustre and Portals) upcall\r
- scripts used by the client for recovery\r
-\layout Description\r
-\r
---ptldebug\SpecialChar ~\r
-<debug_level> Set the portals debug level.\r
-\layout Description\r
-\r
---subsytem\SpecialChar ~\r
-<subsystem_name> Specify which Lustre subsystems have debug output\r
- recorded in the log.\r
-\end_deeper \r
-\layout Description\r
-\r
-\r
-\emph on \r
--\r
-\emph default \r
--add\SpecialChar ~\r
-net Adds a network device descriptor for the given node, with parameters\r
- as indicated.\r
-\begin_deeper \r
-\layout Standard\r
-\r
-The arguments required are:\r
-\layout Description\r
-\r
---node\SpecialChar ~\r
-''node_name'' This will create a new node with the given name if not\r
- already present.\r
- This is also used to specify a specific node for other elements.\r
-\layout Description\r
-\r
---nettype\SpecialChar ~\r
-<type> Specify the network type.This can be \r
-\series bold \r
-tcp, elan, gm.\r
-\layout Description\r
-\r
---nid\SpecialChar ~\r
-nid The network \r
-\emph on \r
-id\r
-\emph default \r
-, e.g.\r
- ElanID or IP address as used by Portals.\r
- If \r
-\emph on \r
-nid\r
-\emph default \r
- is '*', then the local address of the interface with specified \r
-\series bold \r
-nettype \r
-\series default \r
-is will be substituted when the node is configured with lconf.\r
- An \r
-\emph on \r
-nid\r
-\emph default \r
- of \r
-\emph on \r
-'*'\r
-\emph default \r
- should be used only for the generic \r
-\emph on \r
-client\r
-\emph default \r
- configuration.\r
-\layout Description\r
-\r
---cluster_id\SpecialChar ~\r
-id Specify the cluster ID.\r
-\layout Description\r
-\r
---hostaddr\SpecialChar ~\r
-addr Specify the host address.\r
- lconf will transfer it to the real host address.\r
-\layout Description\r
-\r
---router Optional flag to mark this node as a router\r
-\layout Description\r
-\r
---port\SpecialChar ~\r
-[port] Optional arguement to indicate the tcp port.\r
- The default is 988.\r
\r
-\layout Description\r
-\r
---tcpbuf\SpecialChar ~\r
-<size> Optional arguement.\r
- The default TCP buffer size is 1MB.\r
-\layout Description\r
-\r
---irq_affinity\SpecialChar ~\r
-0|1 Optional arguement.\r
- Default is 0.\r
-\layout Description\r
-\r
---nid_exchange\SpecialChar ~\r
-0|1 Optional arguement since some OSTs might not have the\r
- required support.\r
- This is turned off by default, value of 1 will turn it ON.\r
\r
-\end_deeper \r
-\layout Description\r
-\r
---add\SpecialChar ~\r
-mds\r
-\begin_deeper \r
-\layout Description\r
-\r
---node\SpecialChar ~\r
-<node\SpecialChar ~\r
-name> Name of the node on which the MDS resides\r
-\layout Description\r
-\r
---mds\SpecialChar ~\r
-<mds_name> Specify MDS name.\r
-\layout Description\r
-\r
---mdsuuid\SpecialChar ~\r
-<uuid> Specify MDS uuid.\r
-\layout Description\r
-\r
---failover Enable failover support on MDS.\r
-\layout Description\r
-\r
---dev\SpecialChar ~\r
-<pathname> Path of device on local system.\r
- If the is a file, then a loop device is created and used as the block device.\r
-\layout Description\r
-\r
---backdev\SpecialChar ~\r
-<pathname> Path of the device for backing storage on local system.\r
-\layout Description\r
-\r
---size\SpecialChar ~\r
-<size> Optional argument indicating the size (in KB) of the device\r
- to be created (used typically for loop devices).\r
-\layout Description\r
-\r
---node\SpecialChar ~\r
-<nodename> Adds an MDS to the specified node.\r
- This requires a \r
-\emph on \r
---node\r
-\emph default \r
- argument, and it must not be a profile node.\r
-\layout Description\r
-\r
---fstype\SpecialChar ~\r
-extN|ext3 Optional argument used to specify the file system type.\r
- Default is ext3.\r
-\layout Description\r
-\r
---backfstype\SpecialChar ~\r
-ext3|tmpfs Optional argument to specify the backing filesystem\r
- type.\r
-\layout Description\r
-\r
---nspath Local mount point of server namespace.\r
-\layout Description\r
-\r
---inode_size\SpecialChar ~\r
-<size> Specify new inode size for underlying ext3 file system.\r
-\layout Description\r
-\r
---mkfsoptions\SpecialChar ~\r
-<options> Optional argument to mkfs.\r
-\layout Description\r
-\r
---mountfsoptions\SpecialChar ~\r
-<options> Optional argument to mount fs.\r
- Mount options will be passed by this argument.\r
- For example, extents are to be enabled by adding ",extents" to the --mountfsopt\r
-ions option.\r
\r
-\begin_inset Quotes eld\r
-\end_inset \r
-\r
-errors=remount-ro\r
-\begin_inset Quotes erd\r
-\end_inset \r
-\r
- and \r
-\begin_inset Quotes eld\r
-\end_inset \r
-\r
-asyncdel\r
-\begin_inset Quotes erd\r
-\end_inset \r
-\r
- can also be added to it.\r
-\layout Description\r
-\r
---journal_size\SpecialChar ~\r
-<size> Optional arguement to specify the journal size for\r
- the ext2/ext3 file system.\r
- The size should be in the units expected by \r
-\series bold \r
-mkfs\r
-\series default \r
-, so for ext3 it should be in MB.\r
- If this is option is not used, the ext2/ext3 filesystem will be configured\r
- with the default journal size.\r
-\end_deeper \r
-\layout Description\r
-\r
---add\SpecialChar ~\r
-lov Creates an LOV with the specified parameters.\r
- The \r
-\emph on \r
-mds_name\r
-\emph default \r
- must already exist in the descriptor.\r
-\begin_deeper \r
-\layout Description\r
-\r
---lov\SpecialChar ~\r
-<name> Specify LOV name.\r
-\layout Description\r
-\r
---mds\SpecialChar ~\r
-<name> Specify the mds name.\r
-\layout Description\r
-\r
---stripe_sz\SpecialChar ~\r
-<size> Specify the stripe size in bytes.\r
-\layout Description\r
-\r
---stripe_cnt\SpecialChar ~\r
-<count> A value of 0 for this means to stripe on all available\r
- OSTs.\r
- Default is 0.\r
-\layout Description\r
-\r
---stripe_pattern\SpecialChar ~\r
-<pattern> Only Pattern 0 (RAID 0) is supported currently.\r
-\end_deeper \r
-\layout Description\r
-\r
---add\SpecialChar ~\r
-ost Creates an OBD, OST, and OSC.\r
- The OST and OBD are created on the specified node.\r
-\begin_deeper \r
-\layout Description\r
-\r
---ost\SpecialChar ~\r
-<name> Assign a name to the OST device.\r
-\layout Description\r
-\r
---node\SpecialChar ~\r
-<nodename> Node on which the OST service is run, can not be a profile\r
- node.\r
-\layout Description\r
-\r
---failover Enable failover support on OST.\r
-\layout Description\r
-\r
---dev\SpecialChar ~\r
-<pathname> Path of device on local system.\r
- If this is a file, then a loop device is created and used as the block\r
- device.\r
-\layout Description\r
-\r
---backdev\SpecialChar ~\r
-<pathname> Path of the device for backing storage on local system.\r
-\layout Description\r
-\r
---size\SpecialChar ~\r
-[size] Optional argument indicating the size (in KB) of the device\r
- to be created (used typically for loop devices).\r
-\layout Description\r
-\r
---osdtype\SpecialChar ~\r
-obdfilter|obdecho Specify the type of OSD.\r
-\layout Description\r
-\r
---lov\SpecialChar ~\r
-<name> Optional arguement.\r
- Name of LOV to which this OSC will be attached.\r
\r
-\layout Description\r
-\r
---ostuuid\SpecialChar ~\r
-UUID Specify the UUID of the OST device.\r
\r
-\layout Description\r
-\r
---fstype\SpecialChar ~\r
-extN|ext3 Optional arguement used to specify the file system type.\r
- Default is ext3.\r
-\layout Description\r
-\r
---backfstype\SpecialChar ~\r
-ext3|tmpfs Optional argument to specify the backing filesystem\r
- type.\r
-\layout Description\r
-\r
---inode_size\SpecialChar ~\r
-<size> Specify new inode size for underlying ext3 file system.\r
-\layout Description\r
-\r
---nspath Local mount point of server namespace.\r
-\layout Description\r
-\r
---mkfsoptions\SpecialChar ~\r
-<options> Optional argument to mkfs.\r
-\layout Description\r
-\r
---mountfsoptions\SpecialChar ~\r
-<options> Optional argument to mount fs.\r
- Mount options will be passed by this argument.\r
- For example, extents are to be enabled by adding ",extents" to the --mountfsopt\r
-ions option.\r
\r
-\begin_inset Quotes eld\r
-\end_inset \r
-\r
-errors=remount-ro\r
-\begin_inset Quotes erd\r
-\end_inset \r
-\r
- and \r
-\begin_inset Quotes eld\r
-\end_inset \r
-\r
-asyncdel\r
-\begin_inset Quotes erd\r
-\end_inset \r
-\r
- can also be added to it.\r
-\layout Description\r
-\r
---journal_size\SpecialChar ~\r
-<size> Optional arguement to specify the journal size for\r
- the ext2/ext3 file system.\r
- The size should be in the units expected by \r
-\series bold \r
-mkfs\r
-\series default \r
-, so for ext3 it should be in MB.\r
- If this is option is not used, the ext2/ext3 filesystem will be configured\r
- with the default journal size.\r
-\end_deeper \r
-\layout Description\r
-\r
---add\SpecialChar ~\r
-mtpt Creates a mount-point on the specified node.\r
- Either an LOV or OSC name can be used.\r
-\begin_deeper \r
-\layout Description\r
-\r
---node\SpecialChar ~\r
-node Node or profile node that will use the \r
-\emph on \r
-mtpt\r
-\emph default \r
-.\r
-\layout Description\r
-\r
---path\SpecialChar ~\r
-/mnt/path Specify the mountpoint for Lustre.\r
-\layout Description\r
-\r
---mds\SpecialChar ~\r
-mds_name Specify the mds name, which will provide service for this\r
- client.\r
-\layout Description\r
-\r
---ost\SpecialChar ~\r
-ost_name\SpecialChar ~\r
-|\SpecialChar ~\r
---lov\SpecialChar ~\r
-lov_name Specify the ost or lov, which will provide service\r
- for this client.\r
-\layout Description\r
-\r
---clientoptions Specify the options for Lustre, such as async.\r
-\end_deeper \r
-\layout Description\r
-\r
---add\SpecialChar ~\r
-route Creates a static route through a gateway to a specific \r
-\emph on \r
-nid\r
-\emph default \r
- or a range of \r
-\emph on \r
-nid\r
-\emph default \r
-'s.\r
-\begin_deeper \r
-\layout Description\r
-\r
---node\SpecialChar ~\r
-node Node to add the route to.\r
-\layout Description\r
-\r
---router Optional flag to mark a node as router.\r
-\layout Description\r
-\r
---gw\SpecialChar ~\r
-nid The \r
-\emph on \r
-nid\r
-\emph default \r
- of the gateway (must be a local interface or a peer).\r
-\layout Description\r
-\r
---gateway_cluster_id\SpecialChar ~\r
-id Specify the id of the cluster, to which the gateway\r
- belongs.\r
-\layout Description\r
-\r
---target_cluster_id\SpecialChar ~\r
-id Specify the id of the cluster, to which the target\r
- of the route belongs.\r
-\layout Description\r
-\r
---lo\SpecialChar ~\r
-nid For a range route, this is the lo value \r
-\emph on \r
-nid.\r
-\layout Description\r
-\r
---hi\SpecialChar ~\r
-nid For a range route, this is the hi value \r
-\emph on \r
-nid.\r
-\end_deeper \r
-\layout Description\r
-\r
---add\SpecialChar ~\r
-echo-client Used for testing purpose only.\r
\r
-\begin_deeper \r
-\layout Description\r
-\r
---node\SpecialChar ~\r
-nodename\r
-\emph on \r
\r
-\emph default \r
-Node on which the echo-client resides.\r
-\end_deeper \r
-\layout Description\r
-\r
---add\SpecialChar ~\r
-mgmt Management/monitoring service.\r
-\begin_deeper \r
-\layout Description\r
-\r
---node\SpecialChar ~\r
-nodename\r
-\emph on \r
\r
-\emph default \r
-Node on which the mgmt service resides.\r
-\layout Description\r
-\r
---mgmt\SpecialChar ~\r
-<mgmt_service_name> Specify management/monitoring service name.\r
-\end_deeper \r
-\layout List\r
-\labelwidthstring 00.00.0000\r
-\r
-\r
-\series bold \r
---add\SpecialChar ~\r
-cobd \r
-\series default \r
-Create the cobd on the specified node.\r
-\begin_deeper \r
-\layout Description\r
-\noindent \align left \r
---node\SpecialChar ~\r
-nodename\r
-\emph on \r
\r
-\emph default \r
-Node on which the cobd resides.\r
-\layout Description\r
-\r
---cache_obd\SpecialChar ~\r
-obd_name Specify the cache device for the cache obd system.\r
-\layout Description\r
-\r
---real_obd\SpecialChar ~\r
-obd_name\r
-\emph on \r
\r
-\emph default \r
-Specify the real device for the cache obd system.\r
-\end_deeper \r
-\layout List\r
-\labelwidthstring 00.00.0000\r
-\r
-\r
-\series bold \r
-Options\r
-\layout Description\r
-\r
---reference Print short reference for commands.\r
-\layout Description\r
-\r
---verbose Print system commands as they are run.\r
-\layout Description\r
-\r
---batch\SpecialChar ~\r
-filename Used to execute lmc commands in batch mode.\r
-\layout Description\r
-\r
---output\SpecialChar ~\r
-filename Send output to the file.\r
- If the file exists, it will be overwritten.\r
-\layout Description\r
-\r
---merge\SpecialChar ~\r
-filename\r
-\emph on \r
\r
-\emph default \r
-Add the new element to an existing file.\r
\r
-\layout Subsection\r
-\r
-EXAMPLES\r
-\layout Subsubsection\r
-\r
---add net\r
-\layout Standard\r
-\r
-\r
-\series bold \r
-lmc --node adev3 --add net --nid adev3 --cluster_id 0x1000 --nettype tcp\r
- --hostaddr adev3-eth0 --port 988\r
-\layout Standard\r
-\r
-\r
-\series bold \r
-lmc --node adev3 --add net --nid adev3 --cluster_id 0x2000 --nettype tcp\r
- --hostaddr adev3-eth1 --port 989\r
-\series default \r
-\emph on \r
\r
-\layout Standard\r
-\r
-Used to add a Lustre node to a specified Lustre cluster through a network\r
- interface.\r
- In this example, Lustre node adev3 has been added to 2 Lustre clusters\r
- whose cluster_id are 0x1000 and 0x2000 separately through 2 network interface\r
- cards: adev3-eth0 and adev3-eth1.\r
- adev3 would listen in some specified port(s) to prepare for possible connection\r
- requests from nodes in these two clusters.\r
-\layout Subsubsection\r
-\r
---add route\r
-\layout Standard\r
-\r
-\r
-\series bold \r
-lmc --node adev3 --add route --nettype tcp --gw 5 --gateway_cluster_id 0x1000\r
- --target_cluster_id 0x1000 --lo 4 --hi 7\r
-\layout Standard\r
-\r
-Used to add a route entry for a Lustre node.\r
- Here Lustre node adev3 is told it has a new route entry that now it could\r
- send packets to Lustre nodes whose nids is from 4 to 7 with the help of\r
- Lustre gateway node whose nid is 5.\r
- Besides, Lustre gateway node is in cluster whose id is 0x1000 and target\r
- of the route belongs to cluster whose id is also 0x1000.\r
- The network in this route path is a tcp network.\r
-\layout Subsection\r
-\r
-BUGS\r
-\layout Standard\r
-\r
-None are known.\r
-\the_end\r
+#LyX 1.3 created this file. For more info see http://www.lyx.org/
+\lyxformat 221
+\textclass amsart
+\language english
+\inputencoding auto
+\fontscheme times
+\graphics default
+\paperfontsize default
+\spacing single 
+\papersize letterpaper
+\paperpackage a4
+\use_geometry 0
+\use_amsmath 0
+\use_natbib 0
+\use_numerical_citations 0
+\paperorientation portrait
+\secnumdepth 3
+\tocdepth 3
+\paragraph_separation skip
+\defskip medskip
+\quotes_language english
+\quotes_times 2
+\papercolumns 1
+\papersides 1
+\paperpagestyle default
+
+\layout Section
+
+lmc
+\layout Subsection
+
+NAME
+\layout Description
+
+lmc Lustre configuration maker.
+\layout Subsection
+
+SYNOPSIS
+\layout Standard
+
+
+\series bold 
+lmc [options] --add <objectype> [args] 
+\layout Standard
+
+
+\series bold 
+lmc [options] --remove <objecttype> [args] -- [NOT IMPLEMENTED]
+\layout Standard
+
+
+\series bold 
+lmc [options] --convert [args] -- [NOT IMPLEMENTED]
+\layout Subsection
+
+DESCRIPTION
+\layout Standard
+
+At present 
+\series bold 
+\emph on 
+lmc
+\series default 
+\emph default 
+, when invoked, adds configuration data to the config file.
+ In future, 
+\series bold 
+\emph on 
+lmc
+\series default 
+\emph default 
+ will also be able to remove configuration data or convert its format.
+ A Lustre cluster consists of several components - MDS's, mount-points,
+ OSTs, LOVs and whatever those reference (e.g nets and profiles).
+ A single configuration file would be generated for the complete cluster.
+ In the 
+\series bold 
+\emph on 
+lmc
+\series default 
+\emph default 
+ command line interface, each of these components is associated with an
+\emph on 
+objecttype
+\emph default 
+.
+\layout Standard
+
+The 
+\emph on 
+objecttype
+\emph default 
+ refers to a collection of related configuration entities and can be one
+ of 
+\series bold 
+net
+\series default 
+,
+\series bold 
+ MDS
+\series default 
+,
+\series bold 
+ LOV
+\series default 
+,
+\series bold 
+ OST
+\series default 
+,
+\series bold 
+ mtpt
+\series default 
+,
+\series bold 
+ route
+\series default 
+,
+\series bold 
+ echo_client, or cobd.
+\series default 
+We describe the arguments required for the addition of each 
+\emph on 
+objecttype
+\emph default 
+.
+\layout Standard
+
+To generate configuration data associated with systems in a Lustre cluster:
+\layout Description
+
+
+\emph on 
+-
+\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
+
+--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
+
+
+\emph on 
+-
+\emph default 
+-add\SpecialChar ~
+net Adds a network device descriptor for the given node, with parameters
+ as indicated.
+\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.
+ This is also used to specify a specific node for other elements.
+\layout Description
+
+--nettype\SpecialChar ~
+<type> Specify the network type.This can be 
+\series bold 
+tcp, elan, gm.
+\layout Description
+
+--nid\SpecialChar ~
+nid The network 
+\emph on 
+id
+\emph default 
+, e.g.
+ ElanID or IP address as used by Portals.
+ If 
+\emph on 
+nid
+\emph default 
+ 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
+
+--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
+\layout Description
+
+--port\SpecialChar ~
+[port] Optional arguement to indicate the tcp port.
+ The default is 988.
+\layout Description
+
+--tcpbuf\SpecialChar ~
+<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
+
+--add\SpecialChar ~
+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> Specify MDS name.
+\layout Description
+
+--mdsuuid\SpecialChar ~
+<uuid> Specify MDS uuid.
+\layout Description
+
+--failover Enable failover support on MDS.
+\layout Description
+
+--dev\SpecialChar ~
+<pathname> Path of device on local system.
+ If the is a file, then a loop device is created and used as the block device.
+\layout Description
+
+--size\SpecialChar ~
+<size> Optional argument indicating the size (in KB) of the device
+ to be created (used typically for loop devices).
+\layout Description
+
+--node\SpecialChar ~
+<nodename> Adds an MDS to the specified node.
+ This requires a 
+\emph on 
+--node
+\emph default 
+ argument, and it must not be a profile node.
+\layout Description
+
+--fstype\SpecialChar ~
+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 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 ext3 filesystem will be configured
+ with a journal size dependent upon how large the filesystem is.
+\end_deeper 
+\layout Description
+
+--add\SpecialChar ~
+lov Creates an LOV with the specified parameters.
+ The 
+\emph on 
+mds_name
+\emph default 
+ must already exist in the descriptor.
+\begin_deeper 
+\layout Description
+
+--lov\SpecialChar ~
+<name> Specify LOV name.
+\layout Description
+
+--mds\SpecialChar ~
+<name> Specify the mds name.
+\layout Description
+
+--stripe_sz\SpecialChar ~
+<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 use the currently optimal number
+ of stripes.  Default is 1 stripe per file.
+\layout Description
+
+--stripe_pattern\SpecialChar ~
+<pattern> Only Pattern 0 (RAID 0) is supported currently.
+\end_deeper 
+\layout Description
+
+--add\SpecialChar ~
+ost Creates an OBD, OST, and OSC.
+ The OST and OBD are created on the specified node.
+\begin_deeper 
+\layout Description
+
+--ost\SpecialChar ~
+<name> Assign a name to the OST device.
+\layout Description
+
+--node\SpecialChar ~
+<nodename> Node on which the OST service is run, can not be a profile
+ 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
+
+--size\SpecialChar ~
+[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> Optional arguement.
+ Name of LOV to which this OSC will be attached.
+\layout Description
+
+--ostuuid\SpecialChar ~
+UUID Specify the UUID of the OST device.
+\layout Description
+
+--fstype\SpecialChar ~
+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 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 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 for the given LOV.
+\begin_deeper 
+\layout Description
+
+--node\SpecialChar ~
+node Node or profile node that will use the 
+\emph on 
+mtpt
+\emph default 
+.
+\layout Description
+
+--path\SpecialChar ~
+/mnt/path Specify the mountpoint for Lustre.
+\layout Description
+
+--mds\SpecialChar ~
+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 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
+
+--add\SpecialChar ~
+route Creates a static route through a gateway to a specific 
+\emph on 
+nid
+\emph default 
+ or a range of 
+\emph on 
+nid
+\emph default 
+'s.
+\begin_deeper 
+\layout Description
+
+--node\SpecialChar ~
+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 
+nid
+\emph default 
+ of the gateway (must be a local interface or a peer).
+\layout Description
+
+--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 ~
+nid For a range route, this is the lo value 
+\emph on 
+nid.
+\layout Description
+
+--hi\SpecialChar ~
+nid For a range route, this is the hi value 
+\emph on 
+nid.
+\end_deeper 
+\layout Description
+
+--add\SpecialChar ~
+echo-client Used for testing purpose only.
+\begin_deeper 
+\layout Description
+
+--node\SpecialChar ~
+nodename
+\emph on 
+\emph default 
+Node on which the echo-client resides.
+\end_deeper 
+\layout Description
+
+\end_deeper 
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold 
+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.
+\layout Description
+
+--merge\SpecialChar ~
+filename
+\emph on 
+\emph default 
+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
+
+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
+\layout Standard
+
+None are known.
+\the_end