X-Git-Url: https://git.whamcloud.com/?a=blobdiff_plain;f=lustre%2Fdoc%2Flctl.lyx;h=33b40b279d47866d6592d5bb09c86db97afef154;hb=baee98bd55a247f24d906a699f9e25fbd2877649;hp=d9f578f385edfbdf6538937c00b9ffda24c37124;hpb=c6c7c257f106de91ecdac623cf32012f7cdd8007;p=fs%2Flustre-release.git diff --git a/lustre/doc/lctl.lyx b/lustre/doc/lctl.lyx index d9f578f..33b40b2 100644 --- a/lustre/doc/lctl.lyx +++ b/lustre/doc/lctl.lyx @@ -26,13 +26,13 @@ \layout Section -LCTL +lctl \layout Subsection -NAME kfjlkjd -\layout Standard +NAME +\layout Description -lctl - low level Lustre file system configuration utility +lctl Low level Lustre filesystem configuration utility. \layout Subsection SYNOPSIS @@ -69,17 +69,94 @@ 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 +\size small +device +\family default +\size default + and +\family typewriter +\size small +attach +\family default +\size default +, +\family typewriter +\size small +detach +\family default +\size default + and +\family typewriter +\size small +setup +\family default +\size default +, +\family typewriter +\size small +cleanup +\family default +\size default + and +\family typewriter +\size small +connect +\family default +\size default +, +\family typewriter +\size small +disconnect +\family default +\size default + and +\family typewriter +\size small +help +\family default +\size default +, and +\family typewriter +\size small +quit +\family default +\size default +. + To get a complete listing of available commands, type +\family typewriter +\size small +help +\family default +\size default + at the lctl prompt. + To get basic help on the meaning and syntax of a command, type +\family typewriter +\size small +help command +\family default +\size default +. + Command completion is activated with the +\family typewriter +\size small +TAB +\family default +\size 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 +For non-interactive single threaded use, one uses the second invocation, which runs \emph on command \emph default - after connecting to the + after connecting to the device \emph on -device. +. \emph default @@ -95,20 +172,21 @@ on a device name. \layout Description --threads How many threads should be forked doing the command specified. - The numthreads variable is a strictly positivie integer indicating how - many threads should be started. - Verbose can take values , + The numthreads variable is a strictly positive integer indicating how many + threads should be started. + The \emph on devno \emph default -is used as above. -\layout Subsection +option is used as above. +\layout LyX-Code + +\layout LyX-Code -SUBCOMMANDS \layout Description -network\SpecialChar ~ -config +Network\SpecialChar ~ +Configuration \begin_deeper \layout Description @@ -122,183 +200,463 @@ connect\SpecialChar ~ ]\SpecialChar ~ |\SpecialChar ~ ] +id>] This will establish a connection to + a remote network network +\emph on +id +\emph default + given by the hostname/port combination, or the elan +\emph on +id +\emph default +. \layout Description -disconnect +disconnect\SpecialChar ~ + Disconnect from a remote +\emph on +nid +\emph default +. \layout Description -mynid +mynid\SpecialChar ~ +[nid] Informs the socknal of the local +\emph on +nid +\emph default +. + 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. \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 +\emph on +receive +\emph default + buffer size; if the size is omitted, 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 omitted, + the default size for the buffer is printed. \layout Description -nagle +nagle\SpecialChar ~ +[on/off] Enable/disable nagle; omitting the argument will cause the + default value to be printed. \end_deeper \layout Description -device\SpecialChar ~ -selection +Device\SpecialChar ~ +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 -device\SpecialChar ~ -config +Device\SpecialChar ~ +Configuration \begin_deeper \layout Description -attach +attach\SpecialChar ~ +type\SpecialChar ~ +[name\SpecialChar ~ +[uuid]] +\shape italic +\emph on +Attach +\shape default +\emph default + a type to the current device (which you need to set using the +\family typewriter +\size small +device +\family default +\size 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 -setup +cleanup Cleanup a previously setup device. \layout Description -cleanup +detach Remove driver (and name and UUID) from the current device. \layout Description -detach +lov_setconfig\SpecialChar ~ +lov-uuid\SpecialChar ~ +default-stripe-count\SpecialChar ~ +default-stripe-size\SpecialChar ~ +offset\SpecialChar ~ +pattern\SpecialChar ~ +UUID1\SpecialChar ~ +[U +UID2...] Write LOV configuration to an MDS device. \layout Description -lovconfig +lov_getconfig\SpecialChar ~ +lov-uuid Read LOV configuration from an MDS device. + Returns default-stripe-count, default-stripe-size, offset, pattern, and + a list of OST UUID's. \end_deeper \layout Description -device\SpecialChar ~ -operations +Device\SpecialChar ~ +Operations \begin_deeper \layout Description -probe +probe\SpecialChar ~ +[timeout] Build a connection handle to a device. + This command is used to suspend configuration until the lctl command has + ensured that the MDS and OSC services are available. + This is to avoid mount failures in a rebooting cluster. \layout Description -close +close +\emph on + \layout Description -getattr +getattr\SpecialChar ~ + Get attributes for an OST object +\emph on + +\emph default + . \layout Description -setattr +setattr\SpecialChar ~ +\SpecialChar ~ + Set mode attribute for OST object +\emph on + +\emph default +. \layout Description -create +create\SpecialChar ~ +[num\SpecialChar ~ +[mode\SpecialChar ~ +[verbose]]] Create the specified number +\emph on + +\emph default + of OST objects with the given +\emph on + +\emph default +. \layout Description -destroy +destroy\SpecialChar ~ + Destroy an OST object. \layout Description -test_getattr +test_getattr\SpecialChar ~ +\SpecialChar ~ +[verbose\SpecialChar ~ +[[t]objid]] Do +\emph on + +\emph default + +\emph on +getattrs +\emph default + on OST object +\emph on + +\emph default + ( +\emph on +objectid +\emph default ++1 on each thread). \layout Description -test_brw +test_brw\SpecialChar ~ +[t]\SpecialChar ~ +[write\SpecialChar ~ +[verbose\SpecialChar ~ +[npages\SpecialChar ~ +[[t]objid]]]] Do +\emph on + +\emph default + bulk +\emph on +read +\emph default +/ +\emph on +writes +\emph default + on OST object +\emph on + +\emph default + ( +\emph on + +\emph default + 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 -debug +Debug \begin_deeper \layout Description -debug_kernel +debug_kernel\SpecialChar ~ +[file]\SpecialChar ~ +[raw] Get debug buffer and dump to a +\emph on +fileusage +\emph default +. \layout Description -debug_file +debug_file\SpecialChar ~ +\SpecialChar ~ +[output]\SpecialChar ~ +[raw] Read debug buffer from input and dump to + +\emph on +outputusage +\emph default +. \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 -control +Control \begin_deeper \layout Description -help +help Show a complete list of commands; +\emph on +help +\emph default + 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 Subsection +\layout Description -BUGS -\layout Standard +attach +\layout LyX-Code + + +\size small +# lctl +\newline +lctl > newdev +\newline +lctl > attach obdfilter OBDDEV OBDUUID +\size default + +\newline + +\layout Description + +connect +\layout LyX-Code + + +\size small +lctl > name2dev OSCDEV +\newline +2 +\newline +lctl > device 2 +\newline +lctl > connect +\size default + +\newline + +\layout Description + +getattr +\layout LyX-Code + + +\size small +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) +\newline + +\layout Description + +setup +\emph on + +\layout LyX-Code + + +\size small +lctl > setup /dev/loop0 extN +\newline +lctl > quit +\size default + +\newline + +\layout LyX-Code -None are known. \layout Subsection -AUTHOR +BUGS \layout Standard -Cluster File Systems, Inc. - 2002 - created +None are known. \the_end