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 lmc Lustre configuration maker.
43 lmc [options] --add <objectype> [args]
48 lmc [options] --remove <objecttype> [args] -- [NOT IMPLEMENTED]
53 lmc [options] --convert [args] -- [NOT IMPLEMENTED]
65 , when invoked, adds configuration data to the config file.
72 will also be able to remove configuration data or convert its format.
73 A Lustre cluster consists of several components - MDS's, mount-points,
74 OSTs, LOVs and whatever those reference (e.g nets and profiles).
75 A single configuration file would be generated for the complete cluster.
82 command line interface, each of these components is associated with an
95 refers to a collection of related configuration entities and can be one
122 echo_client, or cobd.
125 We describe the arguments required for the addition of each
133 To generate configuration data associated with systems in a Lustre cluster:
141 node Adds a new node in the cluster configuration.
146 The arguments required are:
150 ''node_name'' This will create a new node with the given name if not
154 --timeout\SpecialChar ~
155 <num> Timeout before going into recovery
158 --lustre_upcall\SpecialChar ~
159 <path> Set the location of the Lustre upcall scripts used
160 by the client for recovery
163 --portals_upcall\SpecialChar ~
164 <path> Specify the location of the Portals upcall scripts
165 used by the client for recovery
168 --upcall\SpecialChar ~
169 <path> Specify the location of both (Lustre and Portals) upcall
170 scripts used by the client for recovery
173 --ptldebug\SpecialChar ~
174 <debug_level> Set the portals debug level.
177 --subsytem\SpecialChar ~
178 <subsystem_name> Specify which Lustre subsystems have debug output
188 net Adds a network device descriptor for the given node, with parameters
193 The arguments required are:
197 ''node_name'' This will create a new node with the given name if not
199 This is also used to specify a specific node for other elements.
202 --nettype\SpecialChar ~
203 <type> Specify the network type.This can be
205 tcp, elan, gm, ibnal.
214 ElanID or IP address as used by Portals.
219 is '*', then the local address of the interface with specified
223 is will be substituted when the node is configured with lconf.
232 should be used only for the generic
239 --cluster_id\SpecialChar ~
240 id Specify the cluster ID.
243 --hostaddr\SpecialChar ~
244 addr Specify the host address.
245 lconf will transfer it to the real host address.
248 --router Optional flag to mark this node as a router
252 [port] Optional arguement to indicate the tcp port.
257 --tcpbuf\SpecialChar ~
258 <size> Optional arguement.
259 The default TCP buffer size is 1MB.
262 --irq_affinity\SpecialChar ~
263 0|1 Optional arguement.
267 --nid_exchange\SpecialChar ~
268 0|1 Optional arguement since some OSTs might not have the
270 This is turned off by default, value of 1 will turn it ON.
282 name> Name of the node on which the MDS resides
286 <mds_name> Specify MDS name.
289 --mdsuuid\SpecialChar ~
290 <uuid> Specify MDS uuid.
293 --failover Enable failover support on MDS.
297 <pathname> Path of device on local system.
298 If the is a file, then a loop device is created and used as the block device.
301 --backdev\SpecialChar ~
302 <pathname> Path of the device for backing storage on local system.
306 <size> Optional argument indicating the size (in KB) of the device
307 to be created (used typically for loop devices).
311 <nodename> Adds an MDS to the specified node.
316 argument, and it must not be a profile node.
319 --fstype\SpecialChar ~
320 extN|ext3 Optional argument used to specify the file system type.
324 --backfstype\SpecialChar ~
325 ext3|tmpfs Optional argument to specify the backing filesystem
329 --nspath Local mount point of server namespace.
332 --inode_size\SpecialChar ~
333 <size> Specify new inode size for underlying ext3 file system.
336 --mkfsoptions\SpecialChar ~
337 <options> Optional argument to mkfs.
340 --mountfsoptions\SpecialChar ~
341 <options> Optional argument to mount fs.
342 Mount options will be passed by this argument.
343 For example, extents are to be enabled by adding ",extents" to the --mountfsopt
346 \begin_inset Quotes eld
350 \begin_inset Quotes erd
354 \begin_inset Quotes eld
358 \begin_inset Quotes erd
361 can also be added to it.
364 --journal_size\SpecialChar ~
365 <size> Optional arguement to specify the journal size for
366 the ext2/ext3 file system.
367 The size should be in the units expected by
371 , so for ext3 it should be in MB.
372 If this is option is not used, the ext2/ext3 filesystem will be configured
373 with the default journal size.
378 lov Creates an LOV with the specified parameters.
383 must already exist in the descriptor.
388 <name> Specify LOV name.
392 <name> Specify the mds name.
395 --stripe_sz\SpecialChar ~
396 <size> Specify the stripe size in bytes.
399 --stripe_cnt\SpecialChar ~
400 <count> A value of 0 for this means to stripe on all available
405 --stripe_pattern\SpecialChar ~
406 <pattern> Only Pattern 0 (RAID 0) is supported currently.
411 ost Creates an OBD, OST, and OSC.
412 The OST and OBD are created on the specified node.
417 <name> Assign a name to the OST device.
421 <nodename> Node on which the OST service is run, can not be a profile
425 --failover Enable failover support on OST.
429 <pathname> Path of device on local system.
430 If this is a file, then a loop device is created and used as the block
434 --backdev\SpecialChar ~
435 <pathname> Path of the device for backing storage on local system.
439 [size] Optional argument indicating the size (in KB) of the device
440 to be created (used typically for loop devices).
443 --osdtype\SpecialChar ~
444 obdfilter|obdecho Specify the type of OSD.
448 <name> Optional arguement.
449 Name of LOV to which this OSC will be attached.
453 --ostuuid\SpecialChar ~
454 UUID Specify the UUID of the OST device.
458 --fstype\SpecialChar ~
459 extN|ext3 Optional arguement used to specify the file system type.
463 --backfstype\SpecialChar ~
464 ext3|tmpfs Optional argument to specify the backing filesystem
468 --inode_size\SpecialChar ~
469 <size> Specify new inode size for underlying ext3 file system.
472 --nspath Local mount point of server namespace.
475 --mkfsoptions\SpecialChar ~
476 <options> Optional argument to mkfs.
479 --mountfsoptions\SpecialChar ~
480 <options> Optional argument to mount fs.
481 Mount options will be passed by this argument.
482 For example, extents are to be enabled by adding ",extents" to the --mountfsopt
485 \begin_inset Quotes eld
489 \begin_inset Quotes erd
493 \begin_inset Quotes eld
497 \begin_inset Quotes erd
500 can also be added to it.
503 --journal_size\SpecialChar ~
504 <size> Optional arguement to specify the journal size for
505 the ext2/ext3 file system.
506 The size should be in the units expected by
510 , so for ext3 it should be in MB.
511 If this is option is not used, the ext2/ext3 filesystem will be configured
512 with the default journal size.
517 mtpt Creates a mount-point on the specified node.
518 Either an LOV or OSC name can be used.
523 node Node or profile node that will use the
531 /mnt/path Specify the mountpoint for Lustre.
535 mds_name Specify the mds name, which will provide service for this
540 ost_name\SpecialChar ~
543 lov_name Specify the ost or lov, which will provide service
547 --clientoptions Specify the options for Lustre, such as async.
552 route Creates a static route through a gateway to a specific
565 node Node to add the route to.
568 --router Optional flag to mark a node as router.
576 of the gateway (must be a local interface or a peer).
579 --gateway_cluster_id\SpecialChar ~
580 id Specify the id of the cluster, to which the gateway
584 --target_cluster_id\SpecialChar ~
585 id Specify the id of the cluster, to which the target
586 of the route belongs.
590 nid For a range route, this is the lo value
596 nid For a range route, this is the hi value
603 echo-client Used for testing purpose only.
613 Node on which the echo-client resides.
618 mgmt Management/monitoring service.
627 Node on which the mgmt service resides.
631 <mgmt_service_name> Specify management/monitoring service name.
634 \labelwidthstring 00.00.0000
641 Create the cobd on the specified node.
644 \noindent \align left
650 Node on which the cobd resides.
653 --cache_obd\SpecialChar ~
654 obd_name Specify the cache device for the cache obd system.
657 --real_obd\SpecialChar ~
662 Specify the real device for the cache obd system.
665 \labelwidthstring 00.00.0000
672 --reference Print short reference for commands.
675 --verbose Print system commands as they are run.
678 --batch\SpecialChar ~
679 filename Used to execute lmc commands in batch mode.
682 --output\SpecialChar ~
683 filename Send output to the file.
684 If the file exists, it will be overwritten.
687 --merge\SpecialChar ~
692 Add the new element to an existing file.
699 Real life examples are given in the Lustre-conf manual page.