1 #LyX 1.3 created this file. For more info see http://www.lyx.org/
10 \papersize letterpaper
15 \use_numerical_citations 0
16 \paperorientation portrait
19 \paragraph_separation skip
21 \quotes_language english
25 \paperpagestyle default
35 lconf Lustre filesystem configuration utility.
44 [--node <node_name>] [-d,--cleanup] [--noexec] [--gdb] [--nosetup]
45 [--nomod] [-n,--noexec] [-v,--verbose] [-h,--help] <XML-config file>
51 This program configures a node following directives in the <XML-config-file>.
52 There will be single configuration file for all the nodes in a single cluster.
53 This file should be distributed to all the nodes in the cluster or kept
54 in a location accessible to all the nodes.
55 One option is to store the cluster configuration information in LDAP format
56 on an LDAP server that can be reached from all the cluster nodes.
59 --client_uuid\SpecialChar ~
60 <uuid> The failed client (required for recovery).
63 --clientoptions\SpecialChar ~
64 <options> Additional options for Lustre.
67 --config\SpecialChar ~
68 <arg> Cluster configuration name used for LDAP query
71 --conn_uuid\SpecialChar ~
72 <uuid> The failed connection (required for recovery).
75 --d|--cleanup Unconfigure a node.
80 argument used for configuration needs to be used for cleanup as well.
81 This will attempt to undo all of the configuration steps done by lconf,
82 including unloading the kernel modules.
85 --debug_path\SpecialChar ~
86 <path> Path to save debug dumps.
90 <file> Dump the kernel debug log to the specified file before portals
91 is unloaded during cleanup.
94 --dump_path\SpecialChar ~
95 <arg> Path to save debug dumps.
96 Default is /tmp/lustre_log
99 --failover Used to shutdown without saving state.
101 This will allow the node to give up service to another node for failover
103 This will not be a clean shutdown.
106 --force Forced unmounting and/or obd detach during cleanup.
111 --gdb Causes lconf to print a message and pause for 5 seconds after creating
112 a gdb module script and before doing any Lustre configuration (the gdb
113 module script is always created, however).
116 --gdb_script\SpecialChar ~
117 <arg> Full name of gdb debug script.
118 Default is /tmp/ogdb.
121 --group\SpecialChar ~
122 <arg> The group of devices to cleanup/configure.
125 -h,--help Print help.
128 --inactive\SpecialChar ~
129 <UUID> The UUID of the service to be ignored by a client mounting
131 Allows the client to mount in the presence of some inactive services.
132 (currently OST only).
133 Multiple UUIDs can be specified by repeating the option.
137 --lctl-dump\SpecialChar ~
138 <arg> Dump all ioctls to the specified file
141 --ldapurl\SpecialChar ~
142 <arg> LDAP server URL
145 --lustre_upcall\SpecialChar ~
146 <path> Set the location of the Lustre upcall scripts used
147 by the client for recovery
150 --lustre=src_dir Specify the base directory for Lustre sources, this parameter
151 will cause lconf to load the lustre modules from this soure tree.
154 --mds_ost_conn Open connections to OSTs on MDS.
157 --maxlevel\SpecialChar ~
158 <level> Perform configuration of devices and services up to level
169 When used in conjunction with cleanup, services are torn down up to a certain
174 --minlevel\SpecialChar ~
175 <level> Specify the minimum level of services to configure/cleanup.
179 --mkfsoptions\SpecialChar ~
180 <options> Specify additional options for the mk*fs command
184 --mountfsoptions\SpecialChar ~
185 <options> Specify additional options for mount fs command
187 Mount options will be passed by this argument.
188 For example, extents are to be enabled by adding
189 \begin_inset Quotes eld
193 \begin_inset Quotes erd
196 to the --mountfsoptions option.
198 \begin_inset Quotes eld
202 \begin_inset Quotes erd
206 \begin_inset Quotes eld
210 \begin_inset Quotes erd
213 can also be added to it.
217 node_name Specify a specific node to configure.
218 By default, lconf will search for nodes with the local hostname and 'localhost'.
228 If a matching node is not found in the config, then lconf exits with an
232 --noexec,-n Print, but don't execute, the steps lconf will perform.
233 This is useful for debugging a configuration, and when used with
237 , can be run on any host.
240 --nomod Only setup devices and services, do not load modules.
243 --nosetup Only load modules, do not configure devices or services.
246 --portals\SpecialChar ~
247 <path> Specify portals source directory.
248 If this is a relative path, then it is assumed to be relative to lustre.
251 --portals_upcall\SpecialChar ~
252 <path> Specify the location of the Portals upcall scripts
253 used by the client for recovery
256 --ptldebug\SpecialChar ~
258 level This options can be used to set the required debug
262 --record Write config information on mds.
265 --record_log\SpecialChar ~
266 <arg> Specify the name of config record log.
269 --record_device\SpecialChar ~
270 <arg> Specify MDS device name that will record the config
274 --recover\SpecialChar ~
275 <arg> Recover a device.
278 --reformat Reformat all the devices.
279 This is essential on the first time the file system is brought up.
282 --select\SpecialChar ~
283 <arg> Select a particular node for a service
286 --single_socket Specify socknal option: only use one socket instead of bundle.
289 --subsystem\SpecialChar ~
290 <arg> Set the portals debug subsystem.
293 --tgt_uuid\SpecialChar ~
294 <uuid> Specify the failed target (required for recovery).
297 --timeout\SpecialChar ~
298 <arg> Set the recovery timeout period.
301 --upcall\SpecialChar ~
302 <path> Set the location of both Lustre and Portals upcall scripts
303 used by the client for recovery
306 --verbose,-v Be verbose and show actions while going along.
309 --write_conf Save all client configuration information on the MDS
315 On client nodes this is typically invoked as:
320 lconf --node client config.xml
323 in order to give clients, regardless of hostname, a single configuration.
326 Required debug levels can be set like this:
331 ## Everything but these
337 \begin_inset Quotes eld
340 ~(portals | malloc | trace)
341 \begin_inset Quotes erd
351 ## Only these debug types
357 \begin_inset Quotes eld
361 \begin_inset Quotes erd
367 A subset of failed OSTs can be ignored during Lustre mount on the clients
368 by using the following option:
371 lconf --inactive OST_ost1_UUID --inactive OST_ost2_UUID config.xml
374 where OST1 and OST2 have failed and need to be ignored.