From 20cb86656dff1ffd24b1aa40a920734b5a70dfce Mon Sep 17 00:00:00 2001 From: radhikav Date: Fri, 18 Oct 2002 16:30:15 +0000 Subject: [PATCH] Updated the lctl manpage and Lustre How-To. --- lustre/doc/lctl.lyx | 332 ++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 281 insertions(+), 51 deletions(-) diff --git a/lustre/doc/lctl.lyx b/lustre/doc/lctl.lyx index d9f578f..0e7a732 100644 --- a/lustre/doc/lctl.lyx +++ b/lustre/doc/lctl.lyx @@ -29,7 +29,7 @@ LCTL \layout Subsection -NAME kfjlkjd +NAME \layout Standard lctl - low level Lustre file system configuration utility @@ -69,7 +69,60 @@ The program can be invoked in interactive mode by issuing lctl. \series default - After than commands are issued as below. + After that commands are issued as below. + The most common commands in lctl are (in matching pairs) +\family typewriter +device +\family default +, +\family typewriter +attach +\family default + and +\family typewriter +detach +\family default +, +\family typewriter +setup +\family default + and +\family typewriter +cleanup +\family default +, +\family typewriter +connect +\family default + and +\family typewriter +disconnect +\family default +, +\family typewriter +help +\family default +, and +\family typewriter +quit +\family default +. + To get a complete listing of available commands, type +\family typewriter +help +\family default + at the lctl prompt. + To get basic help on the meaning and syntax of a command, type +\family typewriter +help command +\family default +. + Command completion is activated with the +\family typewriter +TAB +\family default + key, and command history is available via the up- and down-arrow keys. + \layout Standard For non-interactive single threaded use, one uses the second invocation @@ -102,9 +155,10 @@ on a device name. devno \emph default is used as above. -\layout Subsection +\layout LyX-Code + +\layout LyX-Code -SUBCOMMANDS \layout Description network\SpecialChar ~ @@ -114,7 +168,7 @@ config network\SpecialChar ~ Indicate what kind of network applies for the - configuration commands that follow. + configuration commands that follow \layout Description connect\SpecialChar ~ @@ -122,40 +176,65 @@ connect\SpecialChar ~ ]\SpecialChar ~ |\SpecialChar ~ ] +id>] This will establish a connection to + a remote network network id given by the hostname/port combination or the + elan id \layout Description -disconnect +disconnect\SpecialChar ~ + Disconnect from a remote nid \layout Description -mynid +mynid\SpecialChar ~ +[nid] Informs the socknal of the local nid. + It defaults to hostname for tcp networks and is automatically setup for + elan/myrinet networks \layout Description -add_uuid +add_uuid\SpecialChar ~ +\SpecialChar ~ + Associate a given UUID with an +\emph on +nid +\emph default + \layout Description -close_uuid +close_uuid\SpecialChar ~ + Disconnect a UUID \layout Description -del_uuid +del_uuid\SpecialChar ~ + Delete a UUID association \layout Description -add_route +add_route\SpecialChar ~ +\SpecialChar ~ +\SpecialChar ~ +[target] Add an entry to the routing table for + the given target \layout Description -del_route +del_route\SpecialChar ~ + Delete an entry for the target from the routing table \layout Description -route_list +route_list Print the complete routing table \layout Description -recv_mem +recv_mem\SpecialChar ~ +[size] Set the socket receive buffer size, if the size is omited + the default size for the buffer is printed \layout Description -send_mem +send_mem\SpecialChar ~ +[size] Set send buffer size for the socket, if size is omited the + default size for the buffer is printed \layout Description -nagle +nagle\SpecialChar ~ +[on/off] Enable/disable nagle, omiting the arguement will cause the + default value to be printed \end_deeper \layout Description @@ -164,16 +243,19 @@ selection \begin_deeper \layout Description -newdev +newdev Create a new device \layout Description -name2dev +name2dev This command can be used to determine a device number for the given + device name. \layout Description -device +device This will select the specified OBD device. + All other commands depend on the device being set. + \layout Description -device_list +device_list Show all the devices \end_deeper \layout Description @@ -182,19 +264,44 @@ config \begin_deeper \layout Description -attach -\layout Description - -setup +attach\SpecialChar ~ +type\SpecialChar ~ +[name\SpecialChar ~ +[uuid]] +\shape italic +Attach +\shape default + a type to the current device (which you need to set using the +\family typewriter +device +\family default + command) and give that device a name and UUID. + This allows us to identify the device for use later, and also tells us + what type of device we will have. +\layout Description + +setup\SpecialChar ~ + Type specific device setup commands. + For obdfilter a setup command tells the driver which block device it should + use for storage and what type of filesystem is on that device. + \layout Description -cleanup +cleanup Cleanup a previously setup device \layout Description -detach +detach Remove driver (and name and uuid) from the current device \layout Description -lovconfig +lovconfig\SpecialChar ~ +lov-uuid\SpecialChar ~ +stripe-count\SpecialChar ~ +stripe-size\SpecialChar ~ +offset\SpecialChar ~ +pattern\SpecialChar ~ +UUID1\SpecialChar ~ +[UUID2...] Write + LOV configuration to an MDS device \end_deeper \layout Description @@ -203,43 +310,73 @@ operations \begin_deeper \layout Description -probe +probe\SpecialChar ~ +[timeout] Build a connection handle to a device. + This command is used to suspend configuration till the lctl command has + ensured that the mds and osc services are available. + This is to avoid mount failures in a reebooting cluster \layout Description close \layout Description -getattr +getattr\SpecialChar ~ + Get attributes for an OST object \layout Description -setattr +setattr\SpecialChar ~ +\SpecialChar ~ + Set mode attribute for OST object \layout Description -create +create\SpecialChar ~ +[num\SpecialChar ~ +[mode\SpecialChar ~ +[verbose]]] Create the specified number of OST objects + with the given \layout Description -destroy +destroy\SpecialChar ~ + Destroy an OST object \layout Description -test_getattr +test_getattr\SpecialChar ~ +\SpecialChar ~ +[verbose\SpecialChar ~ +[[t]objid]] Do getattrs on OST object + (objectid+1 on each thread) \layout Description -test_brw +test_brw\SpecialChar ~ +[t]\SpecialChar ~ +[write\SpecialChar ~ +[verbose\SpecialChar ~ +[npages\SpecialChar ~ +[[t]objid]]]] Do bulk read/writes + on OST object ( per I/O) \layout Description -test_ldlm +test_ldlm Perform lock manager test \layout Description -ldlm_regress_start +ldlm_regress_start\SpecialChar ~ +%s\SpecialChar ~ +[numthreads\SpecialChar ~ +[refheld\SpecialChar ~ +[numres\SpecialChar ~ +[numext]]]] Start lock manager + stress test \layout Description -ldlm_regress_stop +ldlm_regress_stop Stop lock manager stress test \layout Description -dump_ldlm +dump_ldlm Dump all lock manager state, this is very useful for debugging \layout Description -newconn +newconn\SpecialChar ~ +\SpecialChar ~ +[newuuid] \end_deeper \layout Description @@ -247,29 +384,43 @@ debug \begin_deeper \layout Description -debug_kernel +debug_kernel\SpecialChar ~ +[file]\SpecialChar ~ +[raw] Get debug buffer and dump to a fileusage \layout Description -debug_file +debug_file\SpecialChar ~ +\SpecialChar ~ +[output]\SpecialChar ~ +[raw] Read debug buffer from input and dump to + outputusage \layout Description -clear +clear Clear kernel debug buffer \layout Description -mark +mark\SpecialChar ~ + Insert marker text in kernel debug buffer \layout Description -filter +filter\SpecialChar ~ + Filter message type from the kernel debug + buffer \layout Description -show +show\SpecialChar ~ + Show specific type of messages \layout Description debug_list\SpecialChar ~ -modules + List all the subsystem and debug types \layout Description -panic +panic Force the kernel to panic \end_deeper \layout Description @@ -277,17 +428,96 @@ control \begin_deeper \layout Description -help +help Show a complete list of commands, help can be used to + get help on specific command \layout Description -exit +exit Close the lctl session \layout Description -quit +quit Close the lctl session \end_deeper \layout Subsection EXAMPLES +\layout Description + +attach +\layout LyX-Code + +# lctl +\newline +lctl > newdev +\newline +lctl > attach obdfilter OBDDEV OBDUUID +\layout Description + +connect +\layout LyX-Code + +lctl > name2dev OSCDEV +\newline +2 +\newline +lctl > device 2 +\newline +lctl > connect +\newline + +\layout Description + +getattr +\layout LyX-Code + +lctl > getattr 12 +\newline +id: 12 +\newline +grp: 0 +\newline +atime: 1002663714 +\newline +mtime: 1002663535 +\newline +ctime: 1002663535 +\newline +size: 10 +\newline +blocks: 8 +\newline +blksize: 4096 +\newline +mode: 100644 +\newline +uid: 0 +\newline +gid: 0 +\newline +flags: 0 +\newline +obdflags: 0 +\newline +nlink: 1 +\newline +valid: ffffffff +\newline +inline: +\newline +obdmd: +\newline +lctl > disconnect +\newline +Finished (success) +\layout Description + +setup +\layout LyX-Code + +lctl > setup /dev/loop0 extN +\newline +lctl > quit +\layout LyX-Code + \layout Subsection BUGS -- 1.8.3.1