\layout Section
-LCTL
+lctl
\layout Subsection
NAME
-\layout Standard
+\layout Description
-lctl - low level Lustre file system configuration utility
+lctl Low level Lustre filesystem configuration utility.
\layout Subsection
SYNOPSIS
\series bold
+\emph on
+\SpecialChar ~
+
+\newline
lctl
\layout Standard
\series bold
+\emph on
lctl\SpecialChar ~
--device\SpecialChar ~
<devno> <command\SpecialChar ~
\series bold
+\emph on
lctl\SpecialChar ~
--threads\SpecialChar ~
<numthreads>\SpecialChar ~
lctl.
\series default
- After that 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
- and
+\size default
+,
\family typewriter
+\size small
detach
\family default
-,
+\size default
+ and
\family typewriter
+\size small
setup
\family default
- and
+\size default
+,
\family typewriter
+\size small
cleanup
\family default
-,
+\size default
+ and
\family typewriter
+\size small
connect
\family default
- and
+\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
+ 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
-\layout Description
+\layout List
+\labelwidthstring 00.00.0000
---device The device number to be used for the operation.
+
+\series bold
+\emph on
+--device
+\series default
+\emph default
+ The device number to be used for the operation.
The value of devno is an integer, normally found by calling
\emph on
lctl name2dev
\emph default
on a device name.
-\layout Description
+\layout List
+\labelwidthstring 00.00.0000
+
---threads How many threads should be forked doing the command specified.
+\series bold
+\emph on
+--threads
+\series default
+\emph default
+ 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 <XXXX>,
+ Verbose can take values <XXXX>;
\emph on
devno
\emph default
\layout Description
-network\SpecialChar ~
-config
+Network\SpecialChar ~
+Configuration
\begin_deeper
-\layout Description
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
network\SpecialChar ~
-<tcp/elans/myrinet> Indicate what kind of network applies for the
- configuration commands that follow
-\layout Description
+<tcp/elans/myrinet>
+\series default
+\emph default
+ Indicate what kind of network applies for the configuration commands that
+ follow.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
connect\SpecialChar ~
[[<hostname>\SpecialChar ~
<port>]\SpecialChar ~
|\SpecialChar ~
<elan\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
+id>]
+\series default
+\emph default
+ 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 List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
disconnect\SpecialChar ~
-<nid> Disconnect from a remote nid
-\layout Description
+<nid>
+\series default
+\emph default
+ Disconnect from a remote
+\emph on
+nid
+\emph default
+.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
mynid\SpecialChar ~
-[nid] Informs the socknal of the local nid.
+[nid]
+\series default
+\emph default
+ 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
+ elan/myrinet networks.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
add_uuid\SpecialChar ~
<uuid>\SpecialChar ~
-<nid> Associate a given UUID with an
-\emph on
-nid
+<nid>
+\series default
\emph default
-
-\layout Description
+ Associate a given UUID with an
+\emph on
+nid.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
close_uuid\SpecialChar ~
-<uuid> Disconnect a UUID
-\layout Description
+<uuid>
+\series default
+\emph default
+ Disconnect a UUID.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
del_uuid\SpecialChar ~
-<uuid> Delete a UUID association
-\layout Description
+<uuid>
+\series default
+\emph default
+ Delete a UUID association.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
add_route\SpecialChar ~
<gateway>\SpecialChar ~
<target>\SpecialChar ~
-[target] Add an entry to the routing table for
- the given target
-\layout Description
+[target]
+\series default
+\emph default
+ Add an entry to the routing table for the given target.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
del_route\SpecialChar ~
-<target> Delete an entry for the target from the routing table
-\layout Description
+<target>
+\series default
+\emph default
+ Delete an entry for the target from the routing table.
+\layout List
+\labelwidthstring 00.00.0000
-route_list Print the complete routing table
-\layout Description
+\series bold
+\emph on
+route_list
+\series default
+\emph default
+ Print the complete routing table.
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold
+\emph on
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
+[size]
+\series default
+\emph default
+ Set the socket
+\emph on
+receive
+\emph default
+ buffer size; if the size is omitted, the default size for the buffer is
+ printed.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
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
+[size]
+\series default
+\emph default
+ Set send buffer size for the socket; if size is omitted, the default size
+ for the buffer is printed.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
nagle\SpecialChar ~
-[on/off] Enable/disable nagle, omiting the arguement will cause the
- default value to be printed
+[on/off]
+\series default
+\emph default
+ 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
+\layout List
+\labelwidthstring 00.00.0000
-newdev Create a new device
-\layout Description
-name2dev This command can be used to determine a device number for the given
- device name.
-\layout Description
+\series bold
+\emph on
+newdev
+\series default
+\emph default
+ Create a new device.
+\layout List
+\labelwidthstring 00.00.0000
-device This will select the specified OBD device.
+
+\series bold
+\emph on
+name2dev
+\series default
+\emph default
+ This command can be used to determine a device number for the given device
+ name.
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold
+\emph on
+device
+\series default
+\emph default
+ This will select the specified OBD device.
All other commands depend on the device being set.
-\layout Description
+\layout List
+\labelwidthstring 00.00.0000
+
-device_list Show all the devices
+\series bold
+\emph on
+device_list
+\series default
+\emph default
+ Show all the devices.
\end_deeper
\layout Description
-device\SpecialChar ~
-config
+Device\SpecialChar ~
+Configuration
\begin_deeper
-\layout Description
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
attach\SpecialChar ~
type\SpecialChar ~
[name\SpecialChar ~
-[uuid]]
+[uuid]]
+\series default
+\emph default
+
\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
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
setup\SpecialChar ~
-<args...> Type specific device setup commands.
- For obdfilter a setup command tells the driver which block device it should
+<args...>
+\series default
+\emph default
+ 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
+\layout List
+\labelwidthstring 00.00.0000
-cleanup Cleanup a previously setup device
-\layout Description
-detach Remove driver (and name and uuid) from the current device
-\layout Description
+\series bold
+\emph on
+cleanup
+\series default
+\emph default
+ Cleanup a previously setup device.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
+detach
+\series default
+\emph default
+ Remove driver (and name and UUID) from the current device.
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold
+\emph on
lov_setconfig\SpecialChar ~
lov-uuid\SpecialChar ~
default-stripe-count\SpecialChar ~
pattern\SpecialChar ~
UUID1\SpecialChar ~
[U
-UID2...] Write LOV configuration to an MDS device
-\layout Description
+UID2...]
+\series default
+\emph default
+ Write LOV configuration to an MDS device.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
lov_getconfig\SpecialChar ~
-lov-uuid Read LOV configuration from an MDS device.
+lov-uuid
+\series default
+\emph default
+ Read LOV configuration from an MDS device.
Returns default-stripe-count, default-stripe-size, offset, pattern, and
- a list of OST UUIDs.
+ a list of OST UUID's.
\end_deeper
\layout Description
-device\SpecialChar ~
-operations
+Device\SpecialChar ~
+Operations
\begin_deeper
-\layout Description
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
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
+[timeout]
+\series default
+\emph default
+ 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 List
+\labelwidthstring 00.00.0000
-close
-\layout Description
+\series bold
+\emph on
+close
+\emph default
+
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold
+\emph on
getattr\SpecialChar ~
-<objid> Get attributes for an OST object <objid>
-\layout Description
+<objid>
+\series default
+\emph default
+ Get attributes for an OST object
+\emph on
+<objid>
+\emph default
+ .
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
setattr\SpecialChar ~
<objid>\SpecialChar ~
-<mode> Set mode attribute for OST object <objid>
-\layout Description
+<mode>
+\series default
+\emph default
+ Set mode attribute for OST object
+\emph on
+<objid>
+\emph default
+.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
create\SpecialChar ~
[num\SpecialChar ~
[mode\SpecialChar ~
-[verbose]]] Create the specified number <num> of OST objects
- with the given <mode>
-\layout Description
+[verbose]]]
+\series default
+\emph default
+ Create the specified number
+\emph on
+<num>
+\emph default
+ of OST objects with the given
+\emph on
+<mode>
+\emph default
+.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
destroy\SpecialChar ~
-<objid> Destroy an OST object
-\layout Description
+<objid>
+\series default
+\emph default
+ Destroy an OST object.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
test_getattr\SpecialChar ~
<num>\SpecialChar ~
[verbose\SpecialChar ~
-[[t]objid]] Do <num> getattrs on OST object <objid>
- (objectid+1 on each thread)
-\layout Description
+[[t]objid]]
+\series default
+\emph default
+ Do
+\emph on
+<num>
+\emph default
+
+\emph on
+getattrs
+\emph default
+ on OST object
+\emph on
+<objid>
+\emph default
+ (
+\emph on
+objectid
+\emph default
++1 on each thread).
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
test_brw\SpecialChar ~
[t]<num>\SpecialChar ~
[write\SpecialChar ~
[verbose\SpecialChar ~
[npages\SpecialChar ~
-[[t]objid]]]] Do <num> bulk read/writes
- on OST object <objid> (<npages> per I/O)
-\layout Description
+[[t]objid]]]]
+\series default
+\emph default
+ Do
+\emph on
+<num>
+\emph default
+ bulk
+\emph on
+read
+\emph default
+/
+\emph on
+writes
+\emph default
+ on OST object
+\emph on
+<objid>
+\emph default
+ (
+\emph on
+<npages>
+\emph default
+ per I/O).
+\layout List
+\labelwidthstring 00.00.0000
-test_ldlm Perform lock manager test
-\layout Description
+\series bold
+\emph on
+test_ldlm
+\series default
+\emph default
+ Perform lock manager test.
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold
+\emph on
ldlm_regress_start\SpecialChar ~
%s\SpecialChar ~
[numthreads\SpecialChar ~
[refheld\SpecialChar ~
[numres\SpecialChar ~
-[numext]]]] Start lock manager
- stress test
-\layout Description
+[numext]]]]
+\series default
+\emph default
+ Start lock manager stress test.
+\layout List
+\labelwidthstring 00.00.0000
-ldlm_regress_stop Stop lock manager stress test
-\layout Description
-dump_ldlm Dump all lock manager state, this is very useful for debugging
-\layout Description
+\series bold
+\emph on
+ldlm_regress_stop
+\series default
+\emph default
+ Stop lock manager stress test.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
+dump_ldlm
+\series default
+\emph default
+ Dump all lock manager state, this is very useful for debugging
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold
+\emph on
newconn\SpecialChar ~
<olduuid>\SpecialChar ~
[newuuid]
\end_deeper
\layout Description
-debug
+Debug
\begin_deeper
-\layout Description
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
debug_kernel\SpecialChar ~
[file]\SpecialChar ~
-[raw] Get debug buffer and dump to a fileusage
-\layout Description
+[raw]
+\series default
+\emph default
+ Get debug buffer and dump to a
+\emph on
+fileusage
+\emph default
+.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
debug_file\SpecialChar ~
<input>\SpecialChar ~
[output]\SpecialChar ~
-[raw] Read debug buffer from input and dump to
- outputusage
-\layout Description
+[raw]
+\series default
+\emph default
+ Read debug buffer from input and dump to
+\emph on
+outputusage
+\emph default
+.
+\layout List
+\labelwidthstring 00.00.0000
-clear Clear kernel debug buffer
-\layout Description
+\series bold
+\emph on
+clear
+\series default
+\emph default
+ Clear kernel debug buffer.
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold
+\emph on
mark\SpecialChar ~
-<text> Insert marker text in kernel debug buffer
-\layout Description
+<text>
+\series default
+\emph default
+ Insert marker text in kernel debug buffer.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
filter\SpecialChar ~
<subsystem\SpecialChar ~
id/debug\SpecialChar ~
-mask> Filter message type from the kernel debug
- buffer
-\layout Description
+mask>
+\series default
+\emph default
+ Filter message type from the kernel debug buffer.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
show\SpecialChar ~
<subsystem\SpecialChar ~
id/debug\SpecialChar ~
-mask> Show specific type of messages
-\layout Description
+mask>
+\series default
+\emph default
+ Show specific type of messages.
+\layout List
+\labelwidthstring 00.00.0000
+
+\series bold
+\emph on
debug_list\SpecialChar ~
-<subs/types> List all the subsystem and debug types
-\layout Description
+<subs/types>
+\series default
+\emph default
+ List all the subsystem and debug types.
+\layout List
+\labelwidthstring 00.00.0000
+
-panic Force the kernel to panic
+\series bold
+\emph on
+panic
+\series default
+\emph default
+ Force the kernel to panic.
\end_deeper
\layout Description
-control
+Control
\begin_deeper
-\layout Description
+\layout List
+\labelwidthstring 00.00.0000
-help Show a complete list of commands, help <command name> can be used to
- get help on specific command
-\layout Description
-exit Close the lctl session
-\layout Description
+\series bold
+\emph on
+help
+\series default
+\emph default
+ Show a complete list of commands;
+\emph on
+help <command name>
+\emph default
+ can be used to get help on specific command.
+\layout List
+\labelwidthstring 00.00.0000
-quit Close the lctl session
+
+\series bold
+\emph on
+exit
+\series default
+\emph default
+ Close the lctl session.
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold
+\emph on
+quit
+\series default
+\emph default
+ Close the lctl session.
\end_deeper
\layout Subsection
EXAMPLES
\layout Description
+
+\emph on
attach
\layout LyX-Code
+
+\size small
# lctl
\newline
lctl > newdev
\newline
-lctl > attach obdfilter OBDDEV OBDUUID
+lctl > attach obdfilter OBDDEV OBDUUID
+\size default
+
+\newline
+
\layout Description
+
+\emph on
connect
\layout LyX-Code
+
+\size small
lctl > name2dev OSCDEV
\newline
2
lctl > device 2
\newline
lctl > connect
+\size default
+
\newline
\layout Description
+
+\emph on
getattr
\layout LyX-Code
+
+\size small
lctl > getattr 12
\newline
id: 12
lctl > disconnect
\newline
Finished (success)
+\newline
+
\layout Description
-setup
+
+\emph on
+setup
+\emph default
+
\layout LyX-Code
+
+\size small
lctl > setup /dev/loop0 extN
\newline
-lctl > quit
+lctl > quit
+\size default
+
+\newline
+
\layout LyX-Code
\layout Subsection
\layout Standard
None are known.
-\layout Subsection
-
-AUTHOR
-\layout Standard
-
-Cluster File Systems, Inc.
- 2002 - created
\the_end
git://git.whamcloud.com / fs / lustre-release.git / blobdiff