X-Git-Url: https://git.whamcloud.com/?p=fs%2Flustre-release.git;a=blobdiff_plain;f=lustre%2Fdoc%2Flctl.8;h=92f67ea73d4b6af3d036ca17d4ed2391750bc5e2;hp=55652c01b72e75d903faeec78b3ea90de5ec5c2a;hb=6871453b053d5756aba2321122db4564df5c1c57;hpb=d3f14b341f24e28a453c02a99c7072d2bd39b86a diff --git a/lustre/doc/lctl.8 b/lustre/doc/lctl.8 index 55652c0..92f67ea 100644 --- a/lustre/doc/lctl.8 +++ b/lustre/doc/lctl.8 @@ -7,385 +7,541 @@ lctl \- Low level Lustre filesystem configuration utility .br .B lctl --device .br -.B lctl --threads -.br .SH DESCRIPTION .B lctl -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) +is used to directly control Lustre via an ioctl interface, allowing +various configuration, maintenance, and debugging features to be accessed. + +.B lctl +can be invoked in interactive mode by issuing lctl command. After that, commands are issued as below. The most common commands in lctl are +.B dl +, +.B dk +, .B device -and -.B attach -, -.B detach -and -.B setup , -.B cleanup -and -.B connect +.B network +.I +, +.B list_nids +, +.B ping +.I nid , -.B disconnect -and .B help -, and +, .B quit. -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. +To get a complete listing of available commands, type +.B help +at the lctl prompt. To get basic help on the meaning and syntax of a +command, type +.B help +.I command +. Command completion is activated with the TAB key, and command history is available via the up- and down-arrow keys. -For non-interactive single-threaded use, one uses the second invocation, which runs command after connecting to the device. +For non-interactive use, one uses the second invocation, which runs command after connecting to the device. -.B Network Configuration -.TP ---net -Indicate the network type to be used for the operation. -.TP -network -Indicate what kind of network applies for the configuration commands that follow. -.TP -interface_list -Print the interface entries. -.TP -add_interface [netmask] -Add an interface entry. -.TP -del_interface [ip] -Delete an interface entry. -.TP -peer_list -Print the peer entries. -.TP -add_peer -Add a peer entry. -.TP -del_peer [] [] [ks] -Remove a peer entry. -.TP -autoconn_list -Print autoconnect entries. -.TP -add_autoconn nid ipaddr port [ise] -Add an autoconnect entry. -.TP -del_autoconn [] [] [ks] -Remove an autoconnect entry. -.TP -conn_list -Print all the connected remote nid. -.TP -connect [[ ] | ] -This will establish a connection to a remote network network id given by the hostname/port combination, or the elan id. -.TP -disconnect -Disconnect from a remote nid. -.TP -active_tx -This command should print active transmits, and it is only used for elan network type. -.TP -mynid [nid] -Informs the socknal of the local nid. It defaults to hostname for tcp networks and is automatically setup for elan/myrinet networks. -.TP -shownid -Print the local NID. -.TP -add_uuid -Associate a given UUID with an nid. -.TP -close_uuid -Disconnect a UUID. -.TP -del_uuid -Delete a UUID association. -.TP -add_route [target] -Add an entry to the routing table for the given target. -.TP -del_route -Delete an entry for the target from the routing table. -.TP -set_route [