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 --group_upcall\SpecialChar ~
126 <arg> Pathname to the MDS upcall to resolve secondary group membership.
127 Defaults to NONE, meaning that the MDS will use whatever group the client
128 supplies, but this is limited to a single supplementary group.
131 -h,--help Print help.
134 --inactive\SpecialChar ~
135 <UUID> The UUID of the service to be ignored by a client mounting
137 Allows the client to mount in the presence of some inactive services.
138 (currently OST only).
139 Multiple UUIDs can be specified by repeating the option.
143 --lctl-dump\SpecialChar ~
144 <arg> Dump all ioctls to the specified file
147 --ldapurl\SpecialChar ~
148 <arg> LDAP server URL
151 --lustre_upcall\SpecialChar ~
152 <path> Set the location of the Lustre upcall scripts used
153 by the client for recovery
156 --lustre=src_dir Specify the base directory for Lustre sources, this parameter
157 will cause lconf to load the lustre modules from this soure tree.
160 --mds_ost_conn Open connections to OSTs on MDS.
163 --maxlevel\SpecialChar ~
164 <level> Perform configuration of devices and services up to level
175 When used in conjunction with cleanup, services are torn down up to a certain
180 --minlevel\SpecialChar ~
181 <level> Specify the minimum level of services to configure/cleanup.
185 --mkfsoptions\SpecialChar ~
186 <options> Specify additional options for the mk*fs command
190 --mountfsoptions\SpecialChar ~
191 <options> Specify additional options for mount fs command
193 Mount options will be passed by this argument.
194 For example, extents are to be enabled by adding
195 \begin_inset Quotes eld
199 \begin_inset Quotes erd
202 to the --mountfsoptions option.
204 \begin_inset Quotes eld
208 \begin_inset Quotes erd
212 \begin_inset Quotes eld
216 \begin_inset Quotes erd
219 can also be added to it.
223 node_name Specify a specific node to configure.
224 By default, lconf will search for nodes with the local hostname and 'localhost'.
234 If a matching node is not found in the config, then lconf exits with an
238 --noexec,-n Print, but don't execute, the steps lconf will perform.
239 This is useful for debugging a configuration, and when used with
243 , can be run on any host.
246 --nomod Only setup devices and services, do not load modules.
249 --nosetup Only load modules, do not configure devices or services.
252 --portals\SpecialChar ~
253 <path> Specify portals source directory.
254 If this is a relative path, then it is assumed to be relative to lustre.
257 --portals_upcall\SpecialChar ~
258 <path> Specify the location of the Portals upcall scripts
259 used by the client for recovery
262 --ptldebug\SpecialChar ~
264 level This options can be used to set the required debug
268 --record Write config information on mds.
271 --record_log\SpecialChar ~
272 <arg> Specify the name of config record log.
275 --record_device\SpecialChar ~
276 <arg> Specify MDS device name that will record the config
280 --recover\SpecialChar ~
281 <arg> Recover a device.
284 --reformat Reformat all the devices.
285 This is essential on the first time the file system is brought up.
288 --select\SpecialChar ~
289 <arg> Select a particular node for a service
292 --single_socket Specify socknal option: only use one socket instead of bundle.
295 --subsystem\SpecialChar ~
296 <arg> Set the portals debug subsystem.
299 --tgt_uuid\SpecialChar ~
300 <uuid> Specify the failed target (required for recovery).
303 --timeout\SpecialChar ~
304 <arg> Set the recovery timeout period.
307 --upcall\SpecialChar ~
308 <path> Set the location of both Lustre and Portals upcall scripts
309 used by the client for recovery
312 --verbose,-v Be verbose and show actions while going along.
315 --write_conf Save all client configuration information on the MDS
321 On client nodes this is typically invoked as:
326 lconf --node client config.xml
329 in order to give clients, regardless of hostname, a single configuration.
332 Required debug levels can be set like this:
337 ## Everything but these
343 \begin_inset Quotes eld
346 ~(portals | malloc | trace)
347 \begin_inset Quotes erd
357 ## Only these debug types
363 \begin_inset Quotes eld
367 \begin_inset Quotes erd
373 A subset of failed OSTs can be ignored during Lustre mount on the clients
374 by using the following option:
377 lconf --inactive OST_ost1_UUID --inactive OST_ost2_UUID config.xml
380 where OST1 and OST2 have failed and need to be ignored.