Whamcloud - gitweb
b=7272
[fs/lustre-release.git] / lustre / doc / lctl.8
index 1e112dd..55652c0 100644 (file)
@@ -35,18 +35,57 @@ To get a complete listing of available commands, type help at the lctl prompt.
 For non-interactive single-threaded use, one uses the second invocation, which runs command after connecting to the device. 
 
 .B Network Configuration
+.TP
+--net <tcp/elan/myrinet> <command> 
+Indicate the network type to be used for the operation.
 .TP 
 network <tcp/elans/myrinet> 
 Indicate what kind of network applies for the configuration commands that follow.
+.TP
+interface_list 
+Print the interface entries.
+.TP
+add_interface <ip> [netmask] 
+Add an interface entry.
+.TP
+del_interface [ip] 
+Delete an interface entry.
+.TP
+peer_list 
+Print the peer entries.
+.TP
+add_peer <nid> <host> <port> 
+Add a peer entry.
+.TP
+del_peer [<nid>] [<host>] [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 [<nid>] [<host>] [ks] 
+Remove an autoconnect entry.
+.TP
+conn_list 
+Print all the connected remote nid.
 .TP 
 connect [[<hostname> <port>] | <elan id>] 
 This will establish a connection to a remote network network id given by the hostname/port combination, or the elan id.
 .TP 
 disconnect <nid> 
 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 <uuid> <nid> 
 Associate a given UUID with an nid.
@@ -62,32 +101,26 @@ Add an entry to the routing table for the given target.
 .TP 
 del_route <target> 
 Delete an entry for the target from the routing table.
+.TP
+set_route <gateway> <up/down> [<time>] 
+Enable/disable routes via the given gateway in the protals routing table. <time> is used to tell when a gateway comes back online.
 .TP 
 route_list 
 Print the complete routing table.
-.TP 
-recv_mem [size] 
-Set the socket receive buffer size; if the size is omitted, the default size for the buffer is printed.
-.TP 
-send_mem [size] 
-Set send buffer size for the socket; if size is omitted, the default size for the buffer is printed.
-.TP 
-nagle [on/off] 
-Enable/disable nagle; omitting the argument will cause the default value to be printed.
-.TP 
-fail nid|all [count] 
-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.
+.TP
+fail nid|_all_ [count] 
+Fail/restore communications. Omitting the 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. The argument "nid" is used to specify the gateway, which is one peer of the communication.
 .PP
 .B Device Selection
 .TP 
 newdev 
 Create a new device.
 .TP 
-name2dev 
-This command can be used to determine a device number for the given device name.
-.TP 
 device 
 This will select the specified OBD device.  All other commands depend on the device being set. 
+.TP
+cfg_device <$name> 
+Set current device being configured to <$name>.
 .TP 
 device_list 
 Show all the devices.
@@ -114,6 +147,21 @@ Write LOV configuration to an MDS device.
 .TP 
 lov_getconfig 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.
+.TP
+record cfg-uuid-name 
+Record commands that follow in log.
+.TP
+endrecord 
+Stop recording.
+.TP
+parse config-uuid-name 
+Parse the log of recorded commands for this config.
+.TP
+dump_log config-uuid-name 
+Print log of recorded commands for this config to kernel debug log.
+.TP
+clear_log config-name 
+Delete current config log of recorded commands.
 .PP
 .B Device Operations
 .TP 
@@ -183,6 +231,33 @@ Set stripe info for an echo client
 .TP 
 unset_stripe <objid> 
 Unset stripe info for an echo client object.
+.TP
+del_mount_option profile 
+Delete a specified profile.
+.TP
+set_timeout <secs> 
+Set the timeout(obd_timeout) for server to wait before failing recovery.
+.TP
+set_lustre_upcall </full/path/to/upcall> 
+Set the lustre upcall(obd_lustre_upcall) via the lustre.upcall sysctl.
+.TP
+llog_catlist 
+List all catalog logs on current device.
+.TP
+llog_info <$logname|#oid#ogr#ogen> 
+Print log header information. 
+.TP
+llog_print <$logname|#oid#ogr#ogen> [from] [to] 
+Print log content information. It will print all records from index 1 by default.
+.TP
+llog_check <$logname|#oid#ogr#ogen> [from] [to] 
+Check log content information. It will check all records from index 1 by default.
+.TP
+llog_cancel <catalog id|catalog name> <log id> <index> 
+Cancel one record in log.
+.TP
+llog_remove <catalog id|catalog name> <log id> 
+Remove one log from catalog, erase it from disk.
 .PP
 .B Debug
 .TP 
@@ -209,9 +284,18 @@ Show specific type of messages.
 .TP 
 debug_list <subs/types> 
 List all the subsystem and debug types.
+.TP
+modules <path> 
+Provide gdb-friendly module information.
 .TP 
 panic 
 Force the kernel to panic.
+.TP
+lwt start/stop [file] 
+Light-weight tracing.
+.TP
+memhog <page count> [<gfp flags>] 
+Memory pressure testing.
 .PP
 .B Control
 .TP