lustre/doc/lconf.lyx

   1 #LyX 1.3 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 221
   3 \textclass amsart
   4 \language english
   5 \inputencoding auto
   6 \fontscheme times
   7 \graphics default
   8 \paperfontsize default
   9 \spacing single
  10 \papersize letterpaper
  11 \paperpackage a4
  12 \use_geometry 0
  13 \use_amsmath 0
  14 \use_natbib 0
  15 \use_numerical_citations 0
  16 \paperorientation portrait
  17 \secnumdepth 3
  18 \tocdepth 3
  19 \paragraph_separation skip
  20 \defskip medskip
  21 \quotes_language english
  22 \quotes_times 2
  23 \papercolumns 1
  24 \papersides 1
  25 \paperpagestyle default
  26
  27 \layout Section
  28
  29 lconf
  30 \layout Subsection
  31
  32 NAME
  33 \layout Description
  34
  35 lconf Lustre filesystem configuration utility.
  36 \layout Subsection
  37
  38 SYNOPSIS
  39 \layout Standard
  40
  41
  42 \series bold
  43 lconf\SpecialChar ~
  44 [--node <node_name>] [-d,--cleanup] [--noexec] [--gdb] [--nosetup]
  45  [--nomod] [-n,--noexec] [-v,--verbose] [-h,--help] <XML-config file>
  46 \layout Subsection
  47
  48 DESCRIPTION
  49 \layout Standard
  50
  51 This program configures a node following directives in the <XML-config-file>.
  52  There will be single configuration file for all the nodes in a single cluster.
  53  This file should be distributed to all the nodes in the cluster or kept
  54  in a location accessible to all the nodes.
  55  One option is to store the cluster configuration information in LDAP format
  56  on an LDAP server that can be reached from all the cluster nodes.
  57 \layout Description
  58
  59 --config\SpecialChar ~
  60 <arg> Cluster configuration name used for LDAP query
  61 \layout Description
  62
  63 --d|--cleanup Unconfigure a node.
  64  The same config and
  65 \emph on
  66 --node
  67 \emph default
  68  argument used for configuration needs to be used for cleanup as well.
  69  This will attempt to undo all of the configuration steps done by lconf,
  70  including unloading the kernel modules.
  71 \layout Description
  72
  73 --dump\SpecialChar ~
  74 <file> Dump the kernel debug log to the specified file before portals
  75  is unloaded during cleanup.
  76 \layout Description
  77
  78 --dump_path\SpecialChar ~
  79 <arg> Path to save debug dumps.
  80  Default is /tmp/lustre_log
  81 \layout Description
  82
  83 --failover Used to shutdown without saving state.
  84  Default is 0.
  85  This will allow the node to give up service to another node for failover
  86  purposes.
  87  This will not be a clean shutdown.
  88 \layout Description
  89
  90 --force Forced unmounting and/or obd detach during cleanup.
  91  Default is 0.
  92
  93 \layout Description
  94
  95 --gdb Causes lconf to print a message and pause for 5 seconds after creating
  96  a gdb module script and before doing any Lustre configuration (the gdb
  97  module script is always created, however).
  98 \layout Description
  99
 100 --gdb_script\SpecialChar ~
 101 <arg> Full name of gdb debug script.
 102  Default is /tmp/ogdb.
 103 \layout Description
 104
 105 --group\SpecialChar ~
 106 <arg> The group of devices to cleanup/configure.
 107 \layout Description
 108
 109 -h,--help Print help.
 110 \layout Description
 111
 112 --inactive\SpecialChar ~
 113 <UUID> The UUID of the service to be ignored by a client mounting
 114  Lustre.
 115  Allows the client to mount in the presence of some inactive services.
 116  (currently OST only).
 117  Multiple UUIDs can be specified by repeating the option.
 118
 119 \layout Description
 120
 121 --lctl-dump\SpecialChar ~
 122 <arg> Dump all ioctls to the specified file
 123 \layout Description
 124
 125 --ldapurl\SpecialChar ~
 126 <arg> LDAP server URL
 127 \layout Description
 128
 129 --lustre_upcall\SpecialChar ~
 130 <path> Set the location of the Lustre upcall scripts used
 131  by the client for recovery
 132 \layout Description
 133
 134 --lustre=src_dir Specify the base directory for Lustre sources, this parameter
 135  will cause lconf to load the lustre modules from this soure tree.
 136 \layout Description
 137
 138 --mds_ost_conn Open connections to OSTs on MDS.
 139 \layout Description
 140
 141 --maxlevel\SpecialChar ~
 142 <level> Perform configuration of devices and services up to level
 143  given.
 144
 145 \emph on
 146 level
 147 \emph default
 148  can take the values
 149 \series bold
 150 net, dev, svc, fs.
 151
 152 \series default
 153 When used in conjunction with cleanup, services are torn down up to a certain
 154  level.
 155  Default is 100.
 156 \layout Description
 157
 158 --minlevel\SpecialChar ~
 159 <level> Specify the minimum level of services to configure/cleanup.
 160  Default is 0.
 161 \layout Description
 162
 163 --node\SpecialChar ~
 164 node_name Specify a specific node to configure.
 165  By default, lconf will search for nodes with the local hostname and 'localhost'.
 166  When
 167 \emph on
 168  --node
 169 \emph default
 170  is used, only
 171 \emph on
 172 node_name
 173 \emph default
 174  is searched for.
 175  If a matching node is not found in the config, then lconf exits with an
 176  error.
 177 \layout Description
 178
 179 --noexec,-n Print, but don't execute, the steps lconf will perform.
 180  This is useful for debugging a configuration, and when used with
 181 \emph on
 182 --node
 183 \emph default
 184 , can be run on any host.
 185 \layout Description
 186
 187 --nomod Only setup devices and services, do not load modules.
 188 \layout Description
 189
 190 --nosetup Only load modules, do not configure devices or services.
 191 \layout Description
 192
 193 --portals_upcall\SpecialChar ~
 194 <path> Specify the location of the Portals upcall scripts
 195  used by the client for recovery
 196 \layout Description
 197
 198 --ptldebug\SpecialChar ~
 199 debug\SpecialChar ~
 200 level This options can be used to set the required debug
 201  level.
 202 \layout Description
 203
 204 --recover\SpecialChar ~
 205 <arg> Recover a device.
 206 \layout Description
 207
 208 --reformat Reformat all the devices.
 209  This is essential on the first time the file system is brought up.
 210 \layout Description
 211
 212 --select\SpecialChar ~
 213 <arg> Select a particular node for a service
 214 \layout Description
 215
 216 --subsystem\SpecialChar ~
 217 <arg> Set the portals debug subsystem.
 218 \layout Description
 219
 220 --timeout\SpecialChar ~
 221 <arg> Set the recovery timeout period.
 222 \layout Description
 223
 224 --upcall\SpecialChar ~
 225 <path> Set the location of both Lustre and Portals upcall scripts
 226  used by the client for recovery
 227 \layout Description
 228
 229 --verbose,-v Be verbose and show actions while going along.
 230 \layout Description
 231
 232 --write_conf Save all client configuration information on the MDS
 233 \layout Subsection
 234
 235 EXAMPLES
 236 \layout Standard
 237
 238 On client nodes this is typically invoked as:
 239 \layout LyX-Code
 240
 241
 242 \size small
 243 lconf --node client config.xml
 244 \layout Standard
 245
 246 in order to give clients, regardless of hostname, a single configuration.
 247 \layout Standard
 248
 249 Required debug levels can be set like this:
 250 \layout LyX-Code
 251
 252
 253 \size small
 254    ## Everything but these
 255 \layout LyX-Code
 256
 257
 258 \size small
 259 lconf --ptldebug
 260 \begin_inset Quotes eld
 261 \end_inset
 262
 263 ~(portals | malloc | trace)
 264 \begin_inset Quotes erd
 265 \end_inset
 266
 267
 268 \layout LyX-Code
 269
 270 \layout LyX-Code
 271
 272
 273 \size small
 274 ## Only these debug types
 275 \layout LyX-Code
 276
 277
 278 \size small
 279 lconf --ptldebug
 280 \begin_inset Quotes eld
 281 \end_inset
 282
 283 ldlm|ha
 284 \begin_inset Quotes erd
 285 \end_inset
 286
 287
 288 \layout Standard
 289
 290 A subset of failed OSTs can be ignored during Lustre mount on the clients
 291  by using the following option:
 292 \layout LyX-Code
 293
 294    lconf --inactive OST_ost1_UUID --inactive OST_ost2_UUID config.xml
 295 \layout Standard
 296
 297 where OST1 and OST2 have failed and need to be ignored.
 298 \layout Subsection
 299
 300 BUGS
 301 \layout Standard
 302
 303 None are known.
 304 \the_end