lustre/doc/lctl.8

   1 .TH lctl 1 "2003 Oct 8" Lustre "configuration utilities"
   2 .SH NAME
   3 lctl \- Low level Lustre filesystem configuration utility
   4 .SH SYNOPSIS
   5 .br
   6 .B lctl
   7 .br
   8 .B lctl --device <devno> <command [args]>
   9 .br
  10 .SH DESCRIPTION
  11 .B lctl
  12 is used to directly control Lustre via an ioctl interface, allowing
  13 various configuration, maintenance, and debugging features to be accessed.
  14
  15 .B lctl
  16 can be invoked in interactive mode by issuing lctl command. After that, commands are issued as below. The most common commands in lctl are
  17 .B dl
  18 ,
  19 .B dk
  20 ,
  21 .B device
  22 ,
  23 .B network
  24 .I <up/down>
  25 ,
  26 .B list_nids
  27 ,
  28 .B ping
  29 .I nid
  30 ,
  31 .B help
  32 ,
  33 .B quit.
  34
  35 To get a complete listing of available commands, type
  36 .B help
  37 at the lctl prompt.  To get basic help on the meaning and syntax of a
  38 command, type
  39 .B help
  40 .I command
  41 .  Command completion is activated with the TAB key, and command history is available via the up- and down-arrow keys.
  42
  43 For non-interactive use, one uses the second invocation, which runs command after connecting to the device.
  44
  45 .SS Network Configuration
  46 .TP
  47 .BI network " <up/down>|<tcp/elan/myrinet>"
  48 Start or stop LNET, or select a network type for other
  49 .I lctl
  50 LNET commands
  51 .TP
  52 .BI list_nids
  53 Print all Network Identifiers on the local node. LNET must be running.
  54 .TP
  55 .BI which_nid " <nidlist>"
  56 From a list of nids for a remote node, show which interface communication
  57 will take place on.
  58 .TP
  59 .BI ping " <nid> "
  60 Check LNET connectivity via an LNET ping. This will use the fabric
  61 appropriate to the specified NID.
  62 .TP
  63 .BI interface_list
  64 Print the network interface information for a given
  65 .B network
  66 type.
  67 .TP
  68 .BI peer_list
  69 Print the known peers for a given
  70 .B network
  71 type.
  72 .TP
  73 .BI conn_list
  74 Print all the connected remote NIDs for a given
  75 .B network
  76 type.
  77 .TP
  78 .BI active_tx
  79 This command should print active transmits, and it is only used for elan network type.
  80 .TP
  81 .BI route_list
  82 Print the complete routing table.
  83 .PP
  84 .SS Device Selection
  85 .TP
  86 .BI device " <devname> "
  87 This will select the specified OBD device.  All other commands depend on the device being set.
  88 .TP
  89 .BI device_list
  90 Show all the local Lustre OBDs. AKA
  91 .B dl
  92 .PP
  93 .SS Device Operations
  94 .TP
  95 .BI conf_param " <device> <parameter>"
  96 Set a permanent configuration parameter for any device via the MGS.  This
  97 command must be run on the MGS node.
  98 .TP
  99 .BI activate
 100 Reactivate an import after deactivating, below.
 101 .TP
 102 .BI deactivate
 103 Deactivate an import, in particular meaning do not assign new file stripes
 104 to an OSC.  This command should be used on the OSC in the MDT LOV
 105 corresponding to a failed OST device, to prevent further attempts at
 106 communication with the failed OST.
 107 .TP
 108 .BI abort_recovery
 109 Abort the recovery process on a restarting MDT or OST device
 110 .PP
 111 .SS Virtual Block Device Operation
 112 Lustre is able to emulate a virtual block device upon regular file. It is necessary to be used when you are trying to setup a swap space via file.
 113 .TP
 114 .BI blockdev_attach " <file name> <device node>"
 115 Attach the lustre regular file to a block device. If the device node is not existent, lctl will create it \- it is recommended to create it by lctl since the emulator uses a dynamical major number.
 116 .TP
 117 .BI blockdev_detach " <device node>"
 118 Detach the virtual block device.
 119 .TP
 120 .BI blockdev_info " <device node>"
 121 Acquire which lustre file was attached to the device node.
 122 .PP
 123 .SS Changelogs
 124 .TP
 125 .BI changelog_register
 126 Register a new changelog user for a particular device.  Changelog entries
 127 will not be purged beyond any registered users' set point. (See lfs changelog_clear.)
 128 .TP
 129 .BI changelog_deregister " <id>"
 130 Unregister an existing changelog user.  If the user's "clear" record number
 131 is the minimum for the device, changelog records will be purged until the
 132 next minimum.
 133 .PP
 134 .SS Debug
 135 .TP
 136 .BI debug_daemon
 137 Start and stop the debug daemon, and control the output filename and size.
 138 .TP
 139 .BI debug_kernel " [file] [raw]"
 140 Dump the kernel debug buffer to stdout or file.
 141 .TP
 142 .BI debug_file " <input> [output]"
 143 Convert kernel-dumped debug log from binary to plain text format.
 144 .TP
 145 .BI clear
 146 Clear the kernel debug buffer.
 147 .TP
 148 .BI mark " <text>"
 149 Insert marker text in the kernel debug buffer.
 150 .TP
 151 .BI filter " <subsystem id/debug mask>"
 152 Filter kernel debug messages by subsystem or mask.
 153 .TP
 154 .BI show " <subsystem id/debug mask>"
 155 Show specific type of messages.
 156 .TP
 157 .BI debug_list " <subs/types>"
 158 List all the subsystem and debug types.
 159 .TP
 160 .BI modules " <path>"
 161 Provide gdb-friendly module information.
 162
 163 .SH OPTIONS
 164 The following options can be used to invoke lctl.
 165 .TP
 166 .B --device
 167 The device to be used for the operation. This can be specified by name or
 168 number. See
 169 .B device_list
 170 .TP
 171 .B --ignore_errors | ignore_errors
 172 Ignore errors during script processing
 173 .TP
 174 .SH EXAMPLES
 175 # lctl
 176 .br
 177 lctl > dl
 178   0 UP mgc MGC192.168.0.20@tcp bfbb24e3-7deb-2ffa-eab0-44dffe00f692 5
 179   1 UP ost OSS OSS_uuid 3
 180   2 UP obdfilter testfs-OST0000 testfs-OST0000_UUID 3
 181 .br
 182 lctl > dk /tmp/log
 183 Debug log: 87 lines, 87 kept, 0 dropped.
 184 .br
 185 lctl > quit
 186 .PP
 187 # lctl conf_param testfs-MDT0000 sys.timeout=40
 188
 189 .SH BUGS
 190 Please report all bugs to Sun Microsystems, Inc. http://bugzilla.lustre.org/
 191 .SH AVAILABILITY
 192 .B lctl
 193 is part of the
 194 .BR Lustre (7)
 195 filesystem package and is available from Sun Microsystems, Inc.
 196 .br
 197 http://www.sun.com/software/products/lustre/index.xml
 198 .SH SEE ALSO
 199 .BR Lustre (7),
 200 .BR mkfs.lustre (8),
 201 .BR mount.lustre (8),
 202 .BR lctl (8),
 203 .BR lfs (1)