1 #LyX 1.3 created this file. For more info see http://www.lyx.org/
3 \textclass amsart-plain
10 \papersize letterpaper
15 \use_numerical_citations 0
16 \paperorientation portrait
19 \paragraph_separation skip
21 \quotes_language english
25 \paperpagestyle default
35 lctl Low level Lustre filesystem configuration utility.
49 --device\SpecialChar ~
50 <devno> <command\SpecialChar ~
57 --threads\SpecialChar ~
58 <numthreads>\SpecialChar ~
59 <verbose>\SpecialChar ~
67 The program can be invoked in interactive mode by issuing
72 After that, commands are issued as below.
73 The most common commands in lctl are (in matching pairs)
128 To get a complete listing of available commands, type
135 To get basic help on the meaning and syntax of a command, type
142 Command completion is activated with the
148 key, and command history is available via the up- and down-arrow keys.
152 For non-interactive single threaded use, one uses the second invocation,
157 after connecting to the device
165 --device The device number to be used for the operation.
166 The value of devno is an integer, normally found by calling
174 --threads How many threads should be forked doing the command specified.
175 The numthreads variable is a strictly positive integer indicating how many
176 threads should be started.
181 option is used as above.
184 --ignore_errors\SpecialChar ~
186 ignore_errors Ignore errors that occur during script processing.
189 dump Save ioctl buffer to file.
194 Network\SpecialChar ~
209 Indicate the network type to be used for the operation.
212 network\SpecialChar ~
213 <tcp/elans/myrinet> Indicate what kind of network applies for the
214 configuration commands that follow.
217 interface_list Print the interface entries.
220 add_interface\SpecialChar ~
226 [netmask] Add an interface entry.
229 del_interface\SpecialChar ~
230 [ip] Delete an interface entry.
233 peer_list Print the peer entries.
236 add_peer\SpecialChar ~
256 del_peer\SpecialChar ~
267 [ks] Remove a peer entry.
270 connect\SpecialChar ~
271 <hostname>\SpecialChar ~
273 [iIOC] This will establish a connection to a remote
278 given by the hostname/port combination.
281 disconnect\SpecialChar ~
282 <nid> Disconnect from a remote
289 active_tx This command should print active transmits, and it is only used
290 for elan network type.
294 [nid] Informs the socknal of the local
299 It defaults to hostname for tcp networks and is automatically setup for
300 elan/myrinet networks.
303 shownid Print the local NID.
306 add_uuid\SpecialChar ~
309 <net_type> Associate a given UUID with an
314 close_uuid\SpecialChar ~
316 <net_type> Disconnect a UUID.
319 del_uuid\SpecialChar ~
320 <uuid> Delete a UUID association.
323 add_route\SpecialChar ~
324 <gateway>\SpecialChar ~
325 <target>\SpecialChar ~
326 [<target>] Add an entry to the portals routing
327 table for the given target.
328 The arguments should be nid.
329 If only one <target> is provided, this command should only add the route
331 But, if both of the <target>s are provides, this command should add the
332 route for all the target in the range specified by the two targets(from
333 low nid to high nid).
336 del_route\SpecialChar ~
337 <gateway>\SpecialChar ~
338 [<target>]\SpecialChar ~
339 [<target>] Delete the route entry for the given
340 targets from the portals routing table.
341 The arguments should be nid.
345 set_route\SpecialChar ~
346 <gateway>\SpecialChar ~
347 <up/down>\SpecialChar ~
348 [<time>] Enable/disable routes via the given
349 gateway in the protals routing table.
350 <time> is used to tell when a gateway comes back online.
353 route_list Print the complete portals routing table.
357 nid|_all_\SpecialChar ~
358 [count] Fail/restore communications.
359 Omitting the count implies fail indefinitely, count of zero indicates that
360 communication should be restored.
361 A non-zero count indicates the number of portals messages to be dropped
362 after which the communication is restored.
364 \begin_inset Quotes eld
368 \begin_inset Quotes erd
371 is used to specify the gateway, which is one peer of the communication.
380 newdev Create a new device.
384 <%name|$name|devno> This will select the specified OBD device.
385 All other commands depend on the device being set.
388 cfg_device\SpecialChar ~
389 <$name> Set current device being configured to <$name>.
392 device_list Show all the devices.
395 dl The same as device_list.
398 lustre_build_version Print the Lustre build version.
416 a type to the current device (which you need to set using the
422 command) and give that device a name and UUID.
423 This allows us to identify the device for use later, and also tells us
424 what type of device we will have.
428 <args...> Type specific device setup commands.
429 For obdfilter, a setup command tells the driver which block device it should
430 use for storage and what type of filesystem is on that device.
434 cleanup\SpecialChar ~
435 [force|failover] Cleanup a previously setup device.
438 detach Remove driver (and name and UUID) from the current device.
441 lov_setup\SpecialChar ~
442 lov-uuid\SpecialChar ~
443 stripe-count\SpecialChar ~
444 stripe-size\SpecialChar ~
446 pattern\SpecialChar ~
449 LOV configuration to an MDS device.
452 lov_getconfig\SpecialChar ~
453 lov-uuid Read LOV configuration from an MDS device.
454 Returns stripe-count, stripe-size, offset, pattern, and a list of OST UUID's.
458 cfg-uuid-name Record commands that follow in log.
461 endrecord Stop recording
465 config-uuid-name Parse the log of recorded commands for this config.
468 dump_log\SpecialChar ~
469 config-uuid-name Print log of recorded commands for this config
473 clear_log\SpecialChar ~
474 config-name Delete current config log of recorded commands.
484 [timeout] Build a connection handle to a device.
485 This command is used to suspend configuration until the lctl command has
486 ensured that the MDS and OSC services are available.
487 This is to avoid mount failures in a rebooting cluster.
501 getattr\SpecialChar ~
502 <objid> Get attributes for an OST object
509 setattr\SpecialChar ~
510 <objid>\SpecialChar ~
511 <mode> Set mode attribute for OST object
521 [verbose\SpecialChar ~
523 data]]]] Create the specified number
527 of OST objects with the given
534 destroy\SpecialChar ~
536 starting\SpecialChar ~
542 > number of objects starting from the object with object id <
549 test_getattr\SpecialChar ~
551 [verbose\SpecialChar ~
571 test_brw\SpecialChar ~
572 [t]<num>\SpecialChar ~
574 [verbose\SpecialChar ~
575 [npages\SpecialChar ~
599 get_stripe\SpecialChar ~
600 objid Show stripe info for an echo client object.
603 set_stripe\SpecialChar ~
604 <objid>[=width!count[@offset]\SpecialChar ~
605 [:id:id....] Set stripe info for an echo
609 unset_stripe\SpecialChar ~
610 <objid> Unset stripe info for an echo client object.
613 test_ldlm Perform lock manager test.
616 ldlm_regress_start\SpecialChar ~
617 [numthreads\SpecialChar ~
618 [refheld\SpecialChar ~
619 [numres\SpecialChar ~
620 [numext]]]] Start lock manager
624 ldlm_regress_stop Stop lock manager stress test.
627 dump_ldlm Dump all lock manager state, this is very useful for debugging.
630 activate Activate an import.
633 deactivate De-activate an import.
636 recover\SpecialChar ~
637 [<connection\SpecialChar ~
638 UUID>] Pass the information of the new target and initialize
639 the connection to this target.
644 <directory>\SpecialChar ~
645 <file> Print some information of the given file.
648 notransno Disable sending of committed transnumber updates.
651 readonly Disable writes to the underlying device.
654 abort_recovery Abort recovery on MDS device.
658 <profilename> Setup mds/ost from the llog file.
661 mount_option\SpecialChar ~
662 profile\SpecialChar ~
663 osc_name\SpecialChar ~
664 [mdc_name] Add a new profile to lustre.
667 del_mount_option\SpecialChar ~
668 profile Delete a specified profile.
671 set_timeout\SpecialChar ~
672 <secs> Set the timeout(
676 ) for server to wait before failing recovery.
679 set_lustre_upcall\SpecialChar ~
680 </full/path/to/upcall> Set the lustre upcall(obd_lustre_upcall)
681 via the lustre.upcall sysctl.
684 llog_catlist List all catalog logs on current device.
687 llog_info\SpecialChar ~
688 <$logname|#oid#ogr#ogen> Print log header information.
692 llog_print\SpecialChar ~
693 <$logname|#oid#ogr#ogen>\SpecialChar ~
695 [to] Print log content information.
696 It will print all records from index 1 by default.
699 llog_check\SpecialChar ~
700 <$logname|#oid#ogr#ogen>\SpecialChar ~
702 [to] Check log content information.
703 It will check all records from index 1 by default.
706 llog_cancel\SpecialChar ~
707 <catalog\SpecialChar ~
708 id|catalog\SpecialChar ~
712 <index> Cancel one record in log.
715 llog_remove\SpecialChar ~
716 <catalog\SpecialChar ~
717 id|catalog\SpecialChar ~
720 id> Remove one log from catalog, erase
729 debug_daemon\SpecialChar ~
732 <#MB>|stop|pause|continue] Debug daemon control and
736 debug_kernel\SpecialChar ~
738 [raw] Get Lustre debug buffer from kernel and dump to a
745 dk The same as debug_kernel.
748 debug_file\SpecialChar ~
749 <input>\SpecialChar ~
750 [output]\SpecialChar ~
751 Convert kernel-dumped debug log from binary to plain text format.
759 clear Clear kernel debug buffer.
763 <text> Insert marker text in kernel debug buffer.
767 <subsystem\SpecialChar ~
768 id/debug\SpecialChar ~
769 mask> Filter message type from the kernel debug
774 <subsystem\SpecialChar ~
775 id/debug\SpecialChar ~
776 mask> Show specific type of messages.
779 debug_list\SpecialChar ~
780 <subs/types> List all the subsystem and debug types.
783 modules\SpecialChar ~
784 <path> Provide gdb-friendly module information.
787 panic Force the kernel to panic.
791 start/stop\SpecialChar ~
792 [file] Light-weight tracing.
799 flags>] Memory pressure testing.
807 help Show a complete list of commands;
811 can be used to get help on specific command.
814 exit Close the lctl session.
817 quit Close the lctl session.
833 lctl > attach obdfilter OBDDEV OBDUUID
845 lctl > name2dev OSCDEV
913 lctl > setup /dev/loop0 ldiskfs