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 autoconn_list Print autoconnect entries.
273 add_autoconn\SpecialChar ~
293 Add an autoconnect entry.
296 del_autoconn\SpecialChar ~
311 Remove an autoconnect entry.
314 conn_list Print all the connected remote nid.
317 connect\SpecialChar ~
318 <hostname>\SpecialChar ~
320 [iIOC] This will establish a connection to a remote
325 given by the hostname/port combination.
328 disconnect\SpecialChar ~
329 <nid> Disconnect from a remote
336 active_tx This command should print active transmits, and it is only used
337 for elan network type.
341 [nid] Informs the socknal of the local
346 It defaults to hostname for tcp networks and is automatically setup for
347 elan/myrinet networks.
350 shownid Print the local NID.
353 add_uuid\SpecialChar ~
356 <net_type> Associate a given UUID with an
361 close_uuid\SpecialChar ~
363 <net_type> Disconnect a UUID.
366 del_uuid\SpecialChar ~
367 <uuid> Delete a UUID association.
370 add_route\SpecialChar ~
371 <gateway>\SpecialChar ~
372 <target>\SpecialChar ~
373 [<target>] Add an entry to the portals routing
374 table for the given target.
375 The arguments should be nid.
376 If only one <target> is provided, this command should only add the route
378 But, if both of the <target>s are provides, this command should add the
379 route for all the target in the range specified by the two targets(from
380 low nid to high nid).
383 del_route\SpecialChar ~
384 <gateway>\SpecialChar ~
385 [<target>]\SpecialChar ~
386 [<target>] Delete the route entry for the given
387 targets from the portals routing table.
388 The arguments should be nid.
392 set_route\SpecialChar ~
393 <gateway>\SpecialChar ~
394 <up/down>\SpecialChar ~
395 [<time>] Enable/disable routes via the given
396 gateway in the protals routing table.
397 <time> is used to tell when a gateway comes back online.
400 route_list Print the complete portals routing table.
404 nid|_all_\SpecialChar ~
405 [count] Fail/restore communications.
406 Omitting the count implies fail indefinitely, count of zero indicates that
407 communication should be restored.
408 A non-zero count indicates the number of portals messages to be dropped
409 after which the communication is restored.
411 \begin_inset Quotes eld
415 \begin_inset Quotes erd
418 is used to specify the gateway, which is one peer of the communication.
427 newdev Create a new device.
431 <%name|$name|devno> This will select the specified OBD device.
432 All other commands depend on the device being set.
435 cfg_device\SpecialChar ~
436 <$name> Set current device being configured to <$name>.
439 device_list Show all the devices.
442 dl The same as device_list.
445 lustre_build_version Print the Lustre build version.
463 a type to the current device (which you need to set using the
469 command) and give that device a name and UUID.
470 This allows us to identify the device for use later, and also tells us
471 what type of device we will have.
475 <args...> Type specific device setup commands.
476 For obdfilter, a setup command tells the driver which block device it should
477 use for storage and what type of filesystem is on that device.
481 cleanup\SpecialChar ~
482 [force|failover] Cleanup a previously setup device.
485 detach Remove driver (and name and UUID) from the current device.
488 lov_setup\SpecialChar ~
489 lov-uuid\SpecialChar ~
490 stripe-count\SpecialChar ~
491 stripe-size\SpecialChar ~
493 pattern\SpecialChar ~
496 LOV configuration to an MDS device.
499 lov_getconfig\SpecialChar ~
500 lov-uuid Read LOV configuration from an MDS device.
501 Returns stripe-count, stripe-size, offset, pattern, and a list of OST UUID's.
505 cfg-uuid-name Record commands that follow in log.
508 endrecord Stop recording
512 config-uuid-name Parse the log of recorded commands for this config.
515 dump_log\SpecialChar ~
516 config-uuid-name Print log of recorded commands for this config
520 clear_log\SpecialChar ~
521 config-name Delete current config log of recorded commands.
531 [timeout] Build a connection handle to a device.
532 This command is used to suspend configuration until the lctl command has
533 ensured that the MDS and OSC services are available.
534 This is to avoid mount failures in a rebooting cluster.
548 getattr\SpecialChar ~
549 <objid> Get attributes for an OST object
556 setattr\SpecialChar ~
557 <objid>\SpecialChar ~
558 <mode> Set mode attribute for OST object
568 [verbose\SpecialChar ~
570 data]]]] Create the specified number
574 of OST objects with the given
581 destroy\SpecialChar ~
583 starting\SpecialChar ~
589 > number of objects starting from the object with object id <
596 test_getattr\SpecialChar ~
598 [verbose\SpecialChar ~
618 test_brw\SpecialChar ~
619 [t]<num>\SpecialChar ~
621 [verbose\SpecialChar ~
622 [npages\SpecialChar ~
646 get_stripe\SpecialChar ~
647 objid Show stripe info for an echo client object.
650 set_stripe\SpecialChar ~
651 <objid>[=width!count[@offset]\SpecialChar ~
652 [:id:id....] Set stripe info for an echo
656 unset_stripe\SpecialChar ~
657 <objid> Unset stripe info for an echo client object.
660 test_ldlm Perform lock manager test.
663 ldlm_regress_start\SpecialChar ~
664 [numthreads\SpecialChar ~
665 [refheld\SpecialChar ~
666 [numres\SpecialChar ~
667 [numext]]]] Start lock manager
671 ldlm_regress_stop Stop lock manager stress test.
674 dump_ldlm Dump all lock manager state, this is very useful for debugging.
677 activate Activate an import.
680 deactivate De-activate an import.
683 recover\SpecialChar ~
684 [<connection\SpecialChar ~
685 UUID>] Pass the information of the new target and initialize
686 the connection to this target.
691 <directory>\SpecialChar ~
692 <file> Print some information of the given file.
695 notransno Disable sending of committed transnumber updates.
698 readonly Disable writes to the underlying device.
701 abort_recovery Abort recovery on MDS device.
705 <profilename> Setup mds/ost from the llog file.
708 mount_option\SpecialChar ~
709 profile\SpecialChar ~
710 osc_name\SpecialChar ~
711 [mdc_name] Add a new profile to lustre.
714 del_mount_option\SpecialChar ~
715 profile Delete a specified profile.
718 set_timeout\SpecialChar ~
719 <secs> Set the timeout(
723 ) for server to wait before failing recovery.
726 set_lustre_upcall\SpecialChar ~
727 </full/path/to/upcall> Set the lustre upcall(obd_lustre_upcall)
728 via the lustre.upcall sysctl.
731 llog_catlist List all catalog logs on current device.
734 llog_info\SpecialChar ~
735 <$logname|#oid#ogr#ogen> Print log header information.
739 llog_print\SpecialChar ~
740 <$logname|#oid#ogr#ogen>\SpecialChar ~
742 [to] Print log content information.
743 It will print all records from index 1 by default.
746 llog_check\SpecialChar ~
747 <$logname|#oid#ogr#ogen>\SpecialChar ~
749 [to] Check log content information.
750 It will check all records from index 1 by default.
753 llog_cancel\SpecialChar ~
754 <catalog\SpecialChar ~
755 id|catalog\SpecialChar ~
759 <index> Cancel one record in log.
762 llog_remove\SpecialChar ~
763 <catalog\SpecialChar ~
764 id|catalog\SpecialChar ~
767 id> Remove one log from catalog, erase
776 debug_daemon\SpecialChar ~
779 <#MB>|stop|pause|continue] Debug daemon control and
783 debug_kernel\SpecialChar ~
785 [raw] Get debug buffer and dump to a
792 dk The same as debug_kernel.
795 debug_file\SpecialChar ~
796 <input>\SpecialChar ~
797 [output]\SpecialChar ~
798 [raw] Read debug buffer from input and dump to
806 clear Clear kernel debug buffer.
810 <text> Insert marker text in kernel debug buffer.
814 <subsystem\SpecialChar ~
815 id/debug\SpecialChar ~
816 mask> Filter message type from the kernel debug
821 <subsystem\SpecialChar ~
822 id/debug\SpecialChar ~
823 mask> Show specific type of messages.
826 debug_list\SpecialChar ~
827 <subs/types> List all the subsystem and debug types.
830 modules\SpecialChar ~
831 <path> Provide gdb-friendly module information.
834 panic Force the kernel to panic.
838 start/stop\SpecialChar ~
839 [file] Light-weight tracing.
846 flags>] Memory pressure testing.
854 help Show a complete list of commands;
858 can be used to get help on specific command.
861 exit Close the lctl session.
864 quit Close the lctl session.
880 lctl > attach obdfilter OBDDEV OBDUUID
892 lctl > name2dev OSCDEV
960 lctl > setup /dev/loop0 extN