-#LyX 1.2 created this file. For more info see http://www.lyx.org/
-\lyxformat 220
-\textclass manpage
+#LyX 1.3 created this file. For more info see http://www.lyx.org/
+\lyxformat 221
+\textclass amsart
\language english
\inputencoding auto
\fontscheme times
\layout Section
+lconf
+\layout Subsection
+
NAME
-\layout Standard
+\layout Description
-lctl - low level Lustre file system configuration utility
-\layout Section
+lconf Lustre filesystem configuration utility.
+\layout Subsection
SYNOPSIS
\layout Standard
\series bold
-lctl
-\layout Standard
-
-
-\series bold
-lctl\SpecialChar ~
---device\SpecialChar ~
-<devno> <command\SpecialChar ~
-[args]>
-\layout Standard
-
-
-\series bold
-lctl\SpecialChar ~
---threads\SpecialChar ~
-<numthreads>\SpecialChar ~
-<verbose>\SpecialChar ~
-<devno>\SpecialChar ~
-<command [args]>
-\layout Section
+lconf\SpecialChar ~
+[--node <node_name>] [-d,--cleanup] [--noexec] [--gdb] [--nosetup]
+ [--nomod] [-n,--noexec] [-v,--verbose] [-h,--help] <XML-config file>
+\layout Subsection
DESCRIPTION
\layout Standard
-The program can be invoked in interactive mode by issuing
-\series bold
-lctl.
+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
-\series default
- After than commands are issued as below.
-\layout Standard
+--client_uuid\SpecialChar ~
+<uuid> The failed client (required for recovery).
+\layout Description
-For non-interactive single threaded use, one uses the second invocation
- which runs
-\emph on
-command
-\emph default
- after connecting to the
-\emph on
-device.
+--clientoptions\SpecialChar ~
+<options> Additional options for Lustre.
+\layout Description
-\emph default
-
+--config\SpecialChar ~
+<arg> Cluster configuration name used for LDAP query
\layout Description
---device The device number to be used for the operation.
- The value of devno is an integer, normally found by calling
-\emph on
-lctl name2dev
-\emph default
-on a device name.
-
+--conn_uuid\SpecialChar ~
+<uuid> The failed connection (required for recovery).
\layout Description
---threads How many threads should be forked doing the command specified.
- The numthreads variable is a strictly positivie integer indicating how
- many threads should be started.
- Verbose can take values <XXXX>,
+--d|--cleanup Unconfigure a node.
+ The same config and
\emph on
-devno
+--node
\emph default
-is used as above.
-\layout Section
-
-SUBCOMMANDS
+ 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 Description
-network\SpecialChar ~
-config
-\begin_deeper
+--debug_path\SpecialChar ~
+<path> Path to save debug dumps.
\layout Description
-network\SpecialChar ~
-<tcp/elans/myrinet> Indicate what kind of network applies for the
- configuration commands that follow.
+--dump\SpecialChar ~
+<file> Dump the kernel debug log to the specified file before portals
+ is unloaded during cleanup.
\layout Description
-connect\SpecialChar ~
-[[<hostname>\SpecialChar ~
-<port>]\SpecialChar ~
-|\SpecialChar ~
-<elan\SpecialChar ~
-id>]
+--dump_path\SpecialChar ~
+<arg> Path to save debug dumps.
+ Default is /tmp/lustre_log
\layout Description
-disconnect
+--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
-mynid
+--force Forced unmounting and/or obd detach during cleanup.
+ Default is 0.
+
\layout Description
-add_uuid
+--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 Description
-close_uuid
+--gdb_script\SpecialChar ~
+<arg> Full name of gdb debug script.
+ Default is /tmp/ogdb.
\layout Description
-del_uuid
+--group\SpecialChar ~
+<arg> The group of devices to cleanup/configure.
\layout Description
-add_route
+-h,--help Print help.
\layout Description
-del_route
+--inactive\SpecialChar ~
+<UUID> The UUID of the service to be ignored by a client mounting
+ Lustre.
+ Allows the client to mount in the presence of some inactive services.
+ (currently OST only).
+ Multiple UUIDs can be specified by repeating the option.
+
\layout Description
-route_list
+--lctl-dump\SpecialChar ~
+<arg> Dump all ioctls to the specified file
\layout Description
-recv_mem
+--ldapurl\SpecialChar ~
+<arg> LDAP server URL
\layout Description
-send_mem
+--lustre_upcall\SpecialChar ~
+<path> Set the location of the Lustre upcall scripts used
+ by the client for recovery
\layout Description
-nagle
-\end_deeper
+--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
-device\SpecialChar ~
-selection
-\begin_deeper
+--mds_ost_conn Open connections to OSTs on MDS.
\layout Description
-newdev
+--maxlevel\SpecialChar ~
+<level> Perform configuration of devices and services up to level
+ given.
+
+\emph on
+level
+\emph default
+ can take the values
+\series bold
+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
-name2dev
+--minlevel\SpecialChar ~
+<level> Specify the minimum level of services to configure/cleanup.
+ Default is 0.
\layout Description
-device
+--mkfsoptions\SpecialChar ~
+<options> Specify additional options for the mk*fs command
+ line.
\layout Description
-device_list
-\end_deeper
-\layout Description
+--mountfsoptions\SpecialChar ~
+<options> Specify additional options for mount fs command
+ line.
+ Mount options will be passed by this argument.
+ For example, extents are to be enabled by adding
+\begin_inset Quotes eld
+\end_inset
-device\SpecialChar ~
-config
-\begin_deeper
-\layout Description
+,extents
+\begin_inset Quotes erd
+\end_inset
-attach
-\layout Description
+ to the --mountfsoptions option.
+
+\begin_inset Quotes eld
+\end_inset
-setup
-\layout Description
+errors=remount-ro
+\begin_inset Quotes erd
+\end_inset
-cleanup
-\layout Description
+ and
+\begin_inset Quotes eld
+\end_inset
-detach
-\layout Description
+asyncdel
+\begin_inset Quotes erd
+\end_inset
-lovconfig
-\end_deeper
+ can also be added to it.
\layout Description
-device\SpecialChar ~
-operations
-\begin_deeper
+--node\SpecialChar ~
+node_name Specify a specific node to configure.
+ By default, lconf will search for nodes with the local hostname and 'localhost'.
+ When
+\emph on
+ --node
+\emph default
+ is used, only
+\emph on
+node_name
+\emph default
+ is searched for.
+ If a matching node is not found in the config, then lconf exits with an
+ error.
\layout Description
-probe
+--noexec,-n 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 Description
-close
+--nomod Only setup devices and services, do not load modules.
\layout Description
-getattr
+--nosetup Only load modules, do not configure devices or services.
\layout Description
-setattr
+--portals\SpecialChar ~
+<path> Specify portals source directory.
+ If this is a relative path, then it is assumed to be relative to lustre.
\layout Description
-create
+--portals_upcall\SpecialChar ~
+<path> Specify the location of the Portals upcall scripts
+ used by the client for recovery
\layout Description
-destroy
+--ptldebug\SpecialChar ~
+debug\SpecialChar ~
+level This options can be used to set the required debug
+ level.
\layout Description
-test_getattr
+--record Write config information on mds.
\layout Description
-test_brw
+--record_log\SpecialChar ~
+<arg> Specify the name of config record log.
\layout Description
-test_ldlm
+--record_device\SpecialChar ~
+<arg> Specify MDS device name that will record the config
+ commands.
\layout Description
-ldlm_regress_start
+--recover\SpecialChar ~
+<arg> Recover a device.
\layout Description
-ldlm_regress_stop
+--reformat Reformat all the devices.
+ This is essential on the first time the file system is brought up.
\layout Description
-dump_ldlm
+--select\SpecialChar ~
+<arg> Select a particular node for a service
\layout Description
-newconn
-\end_deeper
+--single_socket Specify socknal option: only use one socket instead of bundle.
\layout Description
-debug
-\begin_deeper
+--subsystem\SpecialChar ~
+<arg> Set the portals debug subsystem.
\layout Description
-debug_kernel
+--tgt_uuid\SpecialChar ~
+<uuid> Specify the failed target (required for recovery).
\layout Description
-debug_file
+--timeout\SpecialChar ~
+<arg> Set the recovery timeout period.
\layout Description
-clear
+--upcall\SpecialChar ~
+<path> Set the location of both Lustre and Portals upcall scripts
+ used by the client for recovery
\layout Description
-mark
+--verbose,-v Be verbose and show actions while going along.
\layout Description
-filter
-\layout Description
+--write_conf Save all client configuration information on the MDS
+\layout Subsection
-show
-\layout Description
+EXAMPLES
+\layout Standard
-debug_list\SpecialChar ~
-modules
-\layout Description
+On client nodes this is typically invoked as:
+\layout LyX-Code
-panic
-\end_deeper
-\layout Description
-control
-\begin_deeper
-\layout Description
+\size small
+lconf --node client config.xml
+\layout Standard
-help
-\layout Description
+in order to give clients, regardless of hostname, a single configuration.
+\layout Standard
-exit
-\layout Description
+Required debug levels can be set like this:
+\layout LyX-Code
-quit
-\end_deeper
-\layout Section
-EXAMPLES
-\layout Section
+\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
+
-BUGS
\layout Standard
-None are known.
-\layout Section
+A subset of failed OSTs can be ignored during Lustre mount on the clients
+ by using the following option:
+\layout LyX-Code
-AUTHOR
+ lconf --inactive OST_ost1_UUID --inactive OST_ost2_UUID config.xml
\layout Standard
-Cluster File Systems, Inc.
- 2002 - created
+where OST1 and OST2 have failed and need to be ignored.
+\layout Subsection
+
+BUGS
+\layout Standard
+
+None are known.
\the_end
git://git.whamcloud.com / fs / lustre-release.git / blobdiff