Whamcloud - gitweb
file netpoll-core.pc was initially added on branch b_devel.
[fs/lustre-release.git] / lustre / doc / lconf.lyx
index 60739c6..0b1416f 100644 (file)
@@ -40,7 +40,6 @@ SYNOPSIS
 
 
 \series bold 
-\emph on 
 lconf\SpecialChar ~
 [--node <node_name>] [-d,--cleanup] [--noexec] [--gdb] [--nosetup]
  [--nomod] [-n,--noexec] [-v,--verbose] [-h,--help] <XML-config file>
@@ -50,17 +49,27 @@ DESCRIPTION
 \layout Standard
 
 This program configures a node following directives in the <XML-config-file>.
-\layout List
-\labelwidthstring 00.00.0000
+ 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
 
-\series bold 
-\emph on 
 --node\SpecialChar ~
-node_name
-\series default 
-\emph default 
- Specify a specific node to configure.
+node_name Specify a specific node to configure.
  By default, lconf will search for nodes with the local hostname and 'localhost'.
  When
 \emph on 
@@ -73,16 +82,9 @@ node_name
  is searched for.
  If a matching node is not found in the config, then lconf exits with an
  error.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
---cleanup
-\series default 
-\emph default 
- Unconfigure a node.
+--d|--cleanup Unconfigure a node.
  The same config and 
 \emph on 
 --node
@@ -90,95 +92,104 @@ node_name
  argument used for configuration needs to be used for cleanup as well.
  This will attempt to undo all of the configuration steps done by lconf,
  including unloading the kernel modules.
-\layout List
-\labelwidthstring 00.00.0000
+\layout Description
 
+--force Forced unmounting and/or obd detach during cleanup.
+ Default is 0.
+\layout Description
 
-\series bold 
-\emph on 
---noexec
-\series default 
-\emph default 
- Print, but don't execute, the steps lconf will perform.
+--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 
 --node
 \emph default 
 , can be run on any host.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
---gdb
-\series default 
-\emph default 
- Causes lconf to print a message and pause for 5 seconds after creating
+--gdb Causes lconf to print a message and pause for 5 seconds after creating
  a gdb module script and before doing any Lustre configuration (the gdb
  module script is always created, however).
-\layout List
-\labelwidthstring 00.00.0000
+\layout Description
 
+--gdb_script\SpecialChar ~
+<arg> Full name of gdb debug script.
+ Default is /tmp/ogdb.
+\layout Description
 
-\series bold 
-\emph on 
---nosetup
-\series default 
-\emph default 
- Only load modules, do not configure devices or services.
-\layout List
-\labelwidthstring 00.00.0000
+--dump_path\SpecialChar ~
+<arg> Path to save debug dumps.
+ Default is /tmp/lustre_log
+\layout Description
 
+--recover\SpecialChar ~
+<arg> Recover a device.
+\layout Description
 
-\series bold 
-\emph on 
---nomod
-\series default 
-\emph default 
- Only setup devices and services, do not load modules.
-\layout List
-\labelwidthstring 00.00.0000
+--nosetup Only load modules, do not configure devices or services.
+\layout Description
 
+--group\SpecialChar ~
+<arg> The group of devices to cleanup/configure.
+\layout Description
 
-\series bold 
-\emph on 
---noexec,-n
-\emph default 
-\series default 
-Don't do anything, but print what would happen.
-\layout List
-\labelwidthstring 00.00.0000
+--nomod Only setup devices and services, do not load modules.
+\layout Description
 
+--noexec,-n Don't do anything, but print what would happen.
+ Useful for debugging purposes.
+\layout Description
 
-\series bold 
-\emph on 
---verbose,-v
-\series default 
-\emph default 
- Be verbose and show actions while going along.
-\layout List
-\labelwidthstring 00.00.0000
+--verbose,-v Be verbose and show actions while going along.
+\layout Description
 
+--timeout\SpecialChar ~
+<arg> Set the recovery timeout period.
+\layout Description
 
-\series bold 
-\emph on 
--h,--help
-\series default 
-\emph default 
- Print help.
-\layout List
-\labelwidthstring 00.00.0000
+--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
 
-\series bold 
-\emph on 
 --maxlevel\SpecialChar ~
-<level>
-\series default 
-\emph default 
- [NOT IMPLEMENTED] Perform configuration of devices and services up to level
+<level> Perform configuration of devices and services up to level
  given.
  
 \emph on 
@@ -191,6 +202,26 @@ 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
+
+--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
@@ -205,6 +236,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