lustre/doc/lconf.lyx

   1 #LyX 1.2 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 220
   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 --ldapurl\SpecialChar ~
  60 <arg> LDAP server URL
  61 \layout Description
  62
  63 --config\SpecialChar ~
  64 <arg> Cluster configuration name used for LDAP query
  65 \layout Description
  66
  67 --select\SpecialChar ~
  68 <arg> Select a particular node for a service
  69 \layout Description
  70
  71 --node\SpecialChar ~
  72 node_name Specify a specific node to configure.
  73  By default, lconf will search for nodes with the local hostname and 'localhost'.
  74  When
  75 \emph on
  76  --node
  77 \emph default
  78  is used, only
  79 \emph on
  80 node_name
  81 \emph default
  82  is searched for.
  83  If a matching node is not found in the config, then lconf exits with an
  84  error.
  85 \layout Description
  86
  87 --d|--cleanup Unconfigure a node.
  88  The same config and
  89 \emph on
  90 --node
  91 \emph default
  92  argument used for configuration needs to be used for cleanup as well.
  93  This will attempt to undo all of the configuration steps done by lconf,
  94  including unloading the kernel modules.
  95 \layout Description
  96
  97 --force Forced unmounting and/or obd detach during cleanup.
  98  Default is 0.
  99
 100 \layout Description
 101
 102 --mds_ost_conn Open connections to OSTs on MDS.
 103 \layout Description
 104
 105 --failover Used to shutdown without saving state.
 106  Default is 0.
 107  This will allow the node to give up service to another node for failover
 108  purposes.
 109  This will not be a clean shutdown.
 110 \layout Description
 111
 112 --noexec Print, but don't execute, the steps lconf will perform.
 113  This is useful for debugging a configuration, and when used with
 114 \emph on
 115 --node
 116 \emph default
 117 , can be run on any host.
 118 \layout Description
 119
 120 --gdb Causes lconf to print a message and pause for 5 seconds after creating
 121  a gdb module script and before doing any Lustre configuration (the gdb
 122  module script is always created, however).
 123 \layout Description
 124
 125 --gdb_script\SpecialChar ~
 126 <arg> Full name of gdb debug script.
 127  Default is /tmp/ogdb.
 128 \layout Description
 129
 130 --dump_path\SpecialChar ~
 131 <arg> Path to save debug dumps.
 132  Default is /tmp/lustre_log
 133 \layout Description
 134
 135 --recover\SpecialChar ~
 136 <arg> Recover a device.
 137 \layout Description
 138
 139 --nosetup Only load modules, do not configure devices or services.
 140 \layout Description
 141
 142 --group\SpecialChar ~
 143 <arg> The group of devices tol cleanup/configure.
 144 \layout Description
 145
 146 --nomod Only setup devices and services, do not load modules.
 147 \layout Description
 148
 149 --noexec,-n Don't do anything, but print what would happen.
 150 \layout Description
 151
 152 --verbose,-v Be verbose and show actions while going along.
 153 \layout Description
 154
 155 --timeout\SpecialChar ~
 156 <arg> Set the recovery timeout period.
 157 \layout Description
 158
 159 --lustre_upcall\SpecialChar ~
 160 <path> Set the location of the Lustre upcall scripts used
 161  by the client for recovery
 162 \layout Description
 163
 164 --portals_upcall\SpecialChar ~
 165 <path> Specify the location of the Portals upcall scripts
 166  used by the client for recovery
 167 \layout Description
 168
 169 --upcall\SpecialChar ~
 170 <path> Set the location of both Lustre and Portals upcall scripts
 171  used by the client for recovery
 172 \layout Description
 173
 174 --lctl-dump\SpecialChar ~
 175 <arg> Dump all ioctls to the specified file
 176 \layout Description
 177
 178 --dump\SpecialChar ~
 179 <file> Dump the kernel debug log to the specified file before portals
 180  is unloaded during cleanup.
 181 \layout Description
 182
 183 --reformat Reformat all the devices.
 184  This is essential on the first time the file system is brought up.
 185 \layout Description
 186
 187 -h,--help Print help.
 188 \layout Description
 189
 190 --maxlevel\SpecialChar ~
 191 <level> Perform configuration of devices and services up to level
 192  given.
 193
 194 \emph on
 195 level
 196 \emph default
 197  can take the values
 198 \series bold
 199 net, dev, svc, fs.
 200
 201 \series default
 202 When used in conjunction with cleanup, services are torn down up to a certain
 203  level.
 204  Default is 100.
 205 \layout Description
 206
 207 --minlevel\SpecialChar ~
 208 <level> Specify the minimum level of services to configure/cleanup.
 209  Default is 0.
 210 \layout Description
 211
 212 --lustre=src_dir Specify the base directory for Lustre sources, this parameter
 213  will cause lconf to load the lustre modules from this soure tree.
 214 \layout Description
 215
 216 --portals=src_dir Portals source directory.
 217  If this is a relative path, it is assumed to be relative to Lustre source
 218  tree location.
 219
 220 \layout Description
 221
 222 --ptldebug\SpecialChar ~
 223 debug\SpecialChar ~
 224 level This options can be used to set the required debug
 225  level
 226 \layout Description
 227
 228 --subsystem\SpecialChar ~
 229 <arg> Set the portals debug subsystem
 230 \layout Subsection
 231
 232 EXAMPLES
 233 \layout Standard
 234
 235 On client nodes this is typically invoked as:
 236 \layout LyX-Code
 237
 238
 239 \size small
 240 lconf --node client config.xml
 241 \layout Standard
 242
 243 in order to give clients, regardless of hostname, a single configuration.
 244 \layout Standard
 245
 246 Required debug levels can be set like this:
 247 \layout LyX-Code
 248
 249
 250 \size small
 251    ## Everything but these
 252 \layout LyX-Code
 253
 254
 255 \size small
 256 lconf --ptldebug
 257 \begin_inset Quotes eld
 258 \end_inset
 259
 260 ~(portals | malloc | trace)
 261 \begin_inset Quotes erd
 262 \end_inset
 263
 264
 265 \layout LyX-Code
 266
 267 \layout LyX-Code
 268
 269
 270 \size small
 271 ## Only these debug types
 272 \layout LyX-Code
 273
 274
 275 \size small
 276 lconf --ptldebug
 277 \begin_inset Quotes eld
 278 \end_inset
 279
 280 ldlm|ha
 281 \begin_inset Quotes erd
 282 \end_inset
 283
 284
 285 \layout Subsection
 286
 287 BUGS
 288 \layout Standard
 289
 290 None are known.
 291 \the_end