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 replace_nids " <devicename> <nid1>[,nid2,nid3 ...]"
  60 Replace the LNET Network Identifiers for a given device,
  61 as when the server's IP address has changed.
  62 This command must be run on the MGS node.
  63 Only MGS server should be started (command execution returns error
  64 in another cases). To start the MGS service only:
  65 mount -t lustre <MDT partition> -o nosvc <mount point>
  66 Note the replace_nids command skips any invalidated records in the configuration log.
  67 The previous log is backed up with the suffix '.bak'.
  68 .TP
  69 .BI ping " <nid> "
  70 Check LNET connectivity via an LNET ping. This will use the fabric
  71 appropriate to the specified NID.
  72 .TP
  73 .BI interface_list
  74 Print the network interface information for a given
  75 .B network
  76 type.
  77 .TP
  78 .BI peer_list
  79 Print the known peers for a given
  80 .B network
  81 type.
  82 .TP
  83 .BI conn_list
  84 Print all the connected remote NIDs for a given
  85 .B network
  86 type.
  87 .TP
  88 .BI active_tx
  89 This command should print active transmits, and it is only used for elan network type.
  90 .TP
  91 .BI route_list
  92 Print the complete routing table.
  93 .PP
  94 .SS Device Selection
  95 .TP
  96 .BI device " <devname> "
  97 This will select the specified OBD device.  All other commands depend on the device being set.
  98 .TP
  99 .BI device_list
 100 Show all the local Lustre OBDs. AKA
 101 .B dl
 102 .PP
 103 .SS Device Operations
 104 .TP
 105 .BI list_param " [-F|-R] <param_search ...>"
 106 List the Lustre or LNet parameter name
 107 .B -F
 108 Add '/', '@' or '=' for dirs, symlinks and writeable files, respectively.
 109 .br
 110 .B -R
 111 Recursively list all parameters under the specified parameter search string. If
 112 .I param_search
 113 is unspecified, all the parameters will be shown.
 114 .br
 115 .B Examples:
 116 .br
 117 .B
 118 # lctl list_param ost.*
 119 .br
 120   ost.OSS
 121 .br
 122   ost.num_refs
 123 .br
 124 .B
 125 # lctl list_param -F ost.* debug
 126 .br
 127   ost.OSS/
 128 .br
 129   ost.num_refs
 130 .br
 131   debug=
 132 .br
 133 .B
 134 # lctl list_param -R mdt
 135 .br
 136   mdt
 137 .br
 138   mdt.lustre-MDT0000
 139 .br
 140   mdt.lustre-MDT0000.capa
 141 .br
 142   mdt.lustre-MDT0000.capa_count
 143 .br
 144   mdt.lustre-MDT0000.capa_key_timeout
 145 .br
 146   mdt.lustre-MDT0000.capa_timeout
 147 .br
 148   mdt.lustre-MDT0000.commit_on_sharing
 149 .br
 150   mdt.lustre-MDT0000.evict_client
 151 .br
 152   ...
 153 .TP
 154 .BI get_param " [-n|-N|-F] <parameter ...>"
 155 Get the value of Lustre or LNET parameter.
 156 .br
 157 .B -n
 158 Print only the value and not parameter name.
 159 .br
 160 .B -N
 161 Print only matched parameter names and not the values. (Especially useful when using patterns.)
 162 .br
 163 .B -F
 164 When -N specified, add '/', '@' or '=' for directories, symlinks and writeable files, respectively.
 165 .br
 166 .B Examples:
 167 .br
 168 .B
 169 # lctl get_param ost.*
 170 .br
 171   ost.OSS
 172 .br
 173   ost.num_refs
 174 .br
 175 .B
 176 # lctl get_param -n debug timeout
 177 .br
 178   super warning dlmtrace error emerg ha rpctrace vfstrace config console
 179 .br
 180   20
 181 .br
 182 .B
 183 # lctl get_param -N ost.* debug
 184 .br
 185   ost.OSS
 186 .br
 187   ost.num_refs
 188 .br
 189   debug
 190 .br
 191 lctl "get_param -NF" is equivalent to "list_param -F".
 192 .TP
 193 .BI set_param " [-n] <parameter=value ...>"
 194 Set the value of Lustre or LNET parameter.
 195 .br
 196 .B -n
 197 Disable printing of the key name when printing values.
 198 .br
 199 .B Examples:
 200 .br
 201 .B
 202 # lctl set_param fail_loc=0 timeout=20
 203 .br
 204   fail_loc=0
 205 .br
 206   timeout=20
 207 .br
 208 .B
 209 # lctl set_param -n fail_loc=0 timeout=20
 210 .br
 211   0
 212 .br
 213   20
 214 .TP
 215 .BI conf_param " [-d] <device|fsname>.<parameter>=<value>"
 216 Set a permanent configuration parameter for any device via the MGS.  This
 217 command must be run on the MGS node.
 218 .br
 219 .B -d <device|fsname>.<parameter>
 220 Delete a parameter setting (use the default value at the next restart).  A null value for <value> also deletes the parameter setting.
 221 .br
 222 .B Parameters:
 223 .br
 224 All of the writable parameters under
 225 .B lctl list_param
 226 (e.g.
 227 .I lctl list_param -F osc.*.* | grep =
 228 ) can be permanently set using
 229 .B lctl conf_param
 230 , but the format is slightly different.  For conf_param, the device is specified first, then the obdtype. (See examples below.)  Wildcards are not supported.
 231 .br
 232 Additionally, failover nodes may be added (or removed), and some system-wide parameters may be set as well (sys.at_max, sys.at_min, sys.at_extra, sys.at_early_margin, sys.at_history, sys.timeout, sys.ldlm_timeout.)  <device> is ignored for system wide parameters.
 233 .br
 234 .B Examples:
 235 .br
 236 # lctl conf_param testfs.sys.at_max=1200
 237 .br
 238 # lctl conf_param testfs.llite.max_read_ahead_mb=16
 239 .br
 240 # lctl conf_param testfs-MDT0000.lov.stripesize=2M
 241 .br
 242 # lctl conf_param lustre-OST0001.osc.active=0
 243 .br
 244 # lctl conf_param testfs-OST0000.osc.max_dirty_mb=29.15
 245 .br
 246 # lctl conf_param testfs-OST0000.ost.client_cache_seconds=15
 247 .br
 248 # lctl conf_param testfs-OST0000.failover.node=1.2.3.4@tcp1
 249 .TP
 250 .BI activate
 251 Reactivate an import after deactivating, below.  This setting is only effective until the next restart (see
 252 .B conf_param
 253 ).
 254 .TP
 255 .BI deactivate
 256 Deactivate an import, in particular meaning do not assign new file stripes
 257 to an OSC.  This command should be used on the OSC in the MDT LOV
 258 corresponding to a failed OST device, to prevent further attempts at
 259 communication with the failed OST.
 260 .TP
 261 .BI abort_recovery
 262 Abort the recovery process on a restarting MDT or OST device
 263 .PP
 264 .SS Virtual Block Device Operation
 265 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.
 266 .TP
 267 .BI blockdev_attach " <file name> <device node>"
 268 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.
 269 .TP
 270 .BI blockdev_detach " <device node>"
 271 Detach the virtual block device.
 272 .TP
 273 .BI blockdev_info " <device node>"
 274 Acquire which lustre file was attached to the device node.
 275 .PP
 276 .SS Changelogs
 277 .TP
 278 .BI changelog_register
 279 Register a new changelog user for a particular device.  Changelog entries
 280 will not be purged beyond any registered users' set point. (See lfs changelog_clear.)
 281 .TP
 282 .BI changelog_deregister " <id>"
 283 Unregister an existing changelog user.  If the user's "clear" record number
 284 is the minimum for the device, changelog records will be purged until the
 285 next minimum.
 286 .PP
 287 .SS Debug
 288 .TP
 289 .BI debug_daemon
 290 Start and stop the debug daemon, and control the output filename and size.
 291 .TP
 292 .BI debug_kernel " [file] [raw]"
 293 Dump the kernel debug buffer to stdout or file.
 294 .TP
 295 .BI debug_file " <input> [output]"
 296 Convert kernel-dumped debug log from binary to plain text format.
 297 .TP
 298 .BI clear
 299 Clear the kernel debug buffer.
 300 .TP
 301 .BI mark " <text>"
 302 Insert marker text in the kernel debug buffer.
 303 .TP
 304 .BI filter " <subsystem id/debug mask>"
 305 Filter kernel debug messages by subsystem or mask.
 306 .TP
 307 .BI show " <subsystem id/debug mask>"
 308 Show specific type of messages.
 309 .TP
 310 .BI debug_list " <subs/types>"
 311 List all the subsystem and debug types.
 312 .TP
 313 .BI modules " <path>"
 314 Provide gdb-friendly module information.
 315
 316 .SH OPTIONS
 317 The following options can be used to invoke lctl.
 318 .TP
 319 .B --device
 320 The device to be used for the operation. This can be specified by name or
 321 number. See
 322 .B device_list
 323 .TP
 324 .B --ignore_errors | ignore_errors
 325 Ignore errors during script processing
 326
 327 .SH EXAMPLES
 328 # lctl
 329 .br
 330 lctl > dl
 331   0 UP mgc MGC192.168.0.20@tcp bfbb24e3-7deb-2ffa-eab0-44dffe00f692 5
 332   1 UP ost OSS OSS_uuid 3
 333   2 UP obdfilter testfs-OST0000 testfs-OST0000_UUID 3
 334 .br
 335 lctl > dk /tmp/log
 336 Debug log: 87 lines, 87 kept, 0 dropped.
 337 .br
 338 lctl > quit
 339
 340 .SH AVAILABILITY
 341 .B lctl
 342 is part of the
 343 .BR Lustre (7)
 344 filesystem package.
 345 .SH SEE ALSO
 346 .BR Lustre (7),
 347 .BR mkfs.lustre (8),
 348 .BR mount.lustre (8),
 349 .BR lctl (8),
 350 .BR lfs (1)