X-Git-Url: https://git.whamcloud.com/?a=blobdiff_plain;f=lustre%2Fdoc%2Flconf.lyx;h=85c670b51f04d577c2b9007cd2170dc4963a2860;hb=96ec6856f91f7f9031cfce4273c714d72cfe59ae;hp=3bfecbdf68e8d1f1bb0db8284807769d876df740;hpb=0bcac33c5aec463e9f471fba6f7d0adc26e6df9f;p=fs%2Flustre-release.git

diff --git a/lustre/doc/lconf.lyx b/lustre/doc/lconf.lyx
index 3bfecbd..85c670b 100644
--- a/lustre/doc/lconf.lyx
+++ b/lustre/doc/lconf.lyx
@@ -48,7 +48,24 @@ lconf\SpecialChar ~
 DESCRIPTION
 \layout Standard
 
-This program configures a node following directives in the <XML-config-file>.
+This program configures a node following directives in the <XML-config-file>..
+ There will be single configuration file for all the nodes in a single cluster.
+ This file should be distributed to all the nodes in the cluster or kept
+ in a location accessible to all the nodes.
+ One option is to store the cluster configuration information in LDAP format
+ on an LDAP server that can be reached from all the cluster nodes.
+\layout Description
+
+--ldapurl\SpecialChar ~
+<arg> LDAP server URL 
+\layout Description
+
+--config\SpecialChar ~
+<arg> Cluster configuration name used for LDAP query
+\layout Description
+
+--select\SpecialChar ~
+<arg> Select a particular node for a service 
 \layout Description
 
 --node\SpecialChar ~
@@ -67,7 +84,7 @@ node_name
  error.
 \layout Description
 
---cleanup Unconfigure a node.
+--d|--cleanup Unconfigure a node.
  The same config and 
 \emph on 
 --node
@@ -77,6 +94,21 @@ node_name
  including unloading the kernel modules.
 \layout Description
 
+--force Forced unmounting and/or obd detach during cleanup.
+ Default is 0.
+ 
+\layout Description
+
+--mds_ost_conn Open connections to OSTs on MDS.
+\layout Description
+
+--failover Used to shutdown without saving state.
+ Default is 0.
+ This will allow the node to give up service to another node for failover
+ purposes.
+ This will not be a clean shutdown.
+\layout Description
+
 --noexec Print, but don't execute, the steps lconf will perform.
  This is useful for debugging a configuration, and when used with 
 \emph on 
@@ -90,9 +122,27 @@ node_name
  module script is always created, however).
 \layout Description
 
+--gdb_script\SpecialChar ~
+<arg> Full name of gdb debug script.
+ Default is /tmp/ogdb.
+\layout Description
+
+--dump_path\SpecialChar ~
+<arg> Path to save debug dumps.
+ Default is /tmp/lustre_log
+\layout Description
+
+--recover\SpecialChar ~
+<arg> Recover a device.
+\layout Description
+
 --nosetup Only load modules, do not configure devices or services.
 \layout Description
 
+--group\SpecialChar ~
+<arg> The group of devices tol cleanup/configure.
+\layout Description
+
 --nomod Only setup devices and services, do not load modules.
 \layout Description
 
@@ -102,15 +152,44 @@ node_name
 --verbose,-v Be verbose and show actions while going along.
 \layout Description
 
---reformat Reformat all the devices
+--timeout\SpecialChar ~
+<arg> Set the recovery timeout period.
+\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> Set the location of both Lustre and Portals upcall scripts
+ used by the client for recovery
+\layout Description
+
+--lctl-dump\SpecialChar ~
+<arg> Dump all ioctls to the specified file
+\layout Description
+
+--dump\SpecialChar ~
+<file> Dump the kernel debug log to the specified file before portals
+ is unloaded during cleanup.
+\layout Description
+
+--reformat Reformat all the devices.
+ This is essential on the first time the file system is brought up.
 \layout Description
 
 -h,--help Print help.
 \layout Description
 
 --maxlevel\SpecialChar ~
-<level> [NOT IMPLEMENTED] Perform configuration of devices and
- services up to level given.
+<level> Perform configuration of devices and services up to level
+ given.
  
 \emph on 
 level
@@ -122,6 +201,32 @@ net, dev, svc, fs.
 \series default 
 When used in conjunction with cleanup, services are torn down up to a certain
  level.
+ Default is 100.
+\layout Description
+
+--minlevel\SpecialChar ~
+<level> Specify the minimum level of services to configure/cleanup.
+ Default is 0.
+\layout Description
+
+--lustre=src_dir Specify the base directory for Lustre sources, this parameter
+ will cause lconf to load the lustre modules from this soure tree.
+\layout Description
+
+--portals=src_dir Portals source directory.
+ If this is a relative path, it is assumed to be relative to Lustre source
+ tree location.
+ 
+\layout Description
+
+--ptldebug\SpecialChar ~
+debug\SpecialChar ~
+level This options can be used to set the required debug
+ level 
+\layout Description
+
+--subsystem\SpecialChar ~
+<arg> Set the portals debug subsystem 
 \layout Subsection
 
 EXAMPLES
@@ -136,6 +241,47 @@ lconf --node client config.xml
 \layout Standard
 
 in order to give clients, regardless of hostname, a single configuration.
+\layout Standard
+
+Required debug levels can be set like this:
+\layout LyX-Code
+
+
+\size small 
+   ## Everything but these
+\layout LyX-Code
+
+
+\size small 
+lconf --ptldebug 
+\begin_inset Quotes eld
+\end_inset 
+
+~(portals | malloc | trace)
+\begin_inset Quotes erd
+\end_inset 
+
+
+\layout LyX-Code
+
+\layout LyX-Code
+
+
+\size small 
+## Only these debug types
+\layout LyX-Code
+
+
+\size small 
+lconf --ptldebug 
+\begin_inset Quotes eld
+\end_inset 
+
+ldlm|ha
+\begin_inset Quotes erd
+\end_inset 
+
+
 \layout Subsection
 
 BUGS