1 .TH lctl 1 "2003 Oct 8" Lustre "configuration utilities"
3 lctl \- Low level Lustre filesystem configuration utility
8 .B lctl --device <devno> <command [args]>
10 .B lctl --threads <numthreads> <verbose> <devno> <command [args]>
14 can be invoked in interactive mode by issuing lctl command. After that, commands are issued as below. The most common commands in lctl are (in matching pairs)
33 To get a complete listing of available commands, type help at the lctl prompt. To get basic help on the meaning and syntax of a command, type help command. Command completion is activated with the TAB key, and command history is available via the up- and down-arrow keys.
35 For non-interactive single-threaded use, one uses the second invocation, which runs command after connecting to the device.
37 .B Network Configuration
39 network <tcp/elans/myrinet>
40 Indicate what kind of network applies for the configuration commands that follow.
42 connect [[<hostname> <port>] | <elan id>]
43 This will establish a connection to a remote network network id given by the hostname/port combination, or the elan id.
46 Disconnect from a remote nid.
49 Informs the socknal of the local nid. It defaults to hostname for tcp networks and is automatically setup for elan/myrinet networks.
52 Associate a given UUID with an nid.
58 Delete a UUID association.
60 add_route <gateway> <target> [target]
61 Add an entry to the routing table for the given target.
64 Delete an entry for the target from the routing table.
67 Print the complete routing table.
70 Set the socket receive buffer size; if the size is omitted, the default size for the buffer is printed.
73 Set send buffer size for the socket; if size is omitted, the default size for the buffer is printed.
76 Enable/disable nagle; omitting the argument will cause the default value to be printed.
79 Fail/restore communications. Ommiting tha count implies fail indefinitely, count of zero indicates that communication should be restored. A non-zero count indicates the number of portals messages to be dropped after which the communication is restored.
87 This command can be used to determine a device number for the given device name.
90 This will select the specified OBD device. All other commands depend on the device being set.
96 Print the Lustre build version.
98 .B Device Configuration
100 attach type [name [uuid]]
101 Attach a type to the current device (which you need to set using the device 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.
104 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.
107 Cleanup a previously setup device.
110 Remove driver (and name and UUID) from the current device.
112 lov_setconfig lov-uuid stripe-count default-stripe-size offset pattern UUID1 [UUID2...]
113 Write LOV configuration to an MDS device.
115 lov_getconfig lov-uuid
116 Read LOV configuration from an MDS device. Returns default-stripe-count, default-stripe-size, offset, pattern, and a list of OST UUID's.
121 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.
124 Close the connection handle
127 Get attributes for an OST object <objid> .
129 setattr <objid> <mode>
130 Set mode attribute for OST object <objid>.
132 create [num [mode [verbose]]]
133 Create the specified number <num> of OST objects with the given <mode>.
136 Starting at <objid>, destroy <num> number of objects starting from the object with object id <objid>.
138 test_getattr <num> [verbose [[t]objid]]
139 Do <num> getattrs on OST object <objid> (objectid+1 on each thread).
141 test_brw [t]<num> [write [verbose [npages [[t]objid]]]]
142 Do <num> bulk read/writes on OST object <objid> (<npages> per I/O).
145 Perform lock manager test.
147 ldlm_regress_start %s [numthreads [refheld [numres [numext]]]]
148 Start lock manager stress test.
151 Stop lock manager stress test.
154 Dump all lock manager state, this is very useful for debugging
160 De-activate an import
162 recover <connection UUID>
164 lookup <directory> <file>
167 Disable sending of committed transnumber updates
170 Disable writes to the underlying device
173 Abort recovery on MDS device
176 Dump mount options to a file
179 Show stripe info for an echo client object.
181 set_stripe <objid>[ width!count[@offset] [:id:id....]
182 Set stripe info for an echo client
185 Unset stripe info for an echo client object.
190 Debug daemon control and dump to a file
192 debug_kernel [file] [raw]
193 Get debug buffer and dump to a fileusage.
195 debug_file <input> [output] [raw]
196 Read debug buffer from input and dump to outputusage.
199 Clear kernel debug buffer.
202 Insert marker text in kernel debug buffer.
204 filter <subsystem id/debug mask>
205 Filter message type from the kernel debug buffer.
207 show <subsystem id/debug mask>
208 Show specific type of messages.
210 debug_list <subs/types>
211 List all the subsystem and debug types.
214 Force the kernel to panic.
219 Show a complete list of commands; help <command name> can be used to get help on specific command.
222 Close the lctl session.
225 Close the lctl session.
228 The following options can be used to invoke lctl.
231 The device number to be used for the operation. The value of devno is an integer, normally found by calling lctl name2dev on a device name.
234 How many threads should be forked doing the command specified. The numthreads variable is a strictly positive integer indicating how many threads should be started. The devno option is used as above.
236 .B --ignore_errors | ignore_errors
237 Ignore errors during script processing
240 Save ioctls to a file
248 lctl > attach obdfilter OBDDEV OBDUUID
252 lctl > name2dev OSCDEV 2
302 lctl > setup /dev/loop0 extN