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 to 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  Useful for debugging purposes.
 151 \layout Description
 152
 153 --verbose,-v Be verbose and show actions while going along.
 154 \layout Description
 155
 156 --timeout\SpecialChar ~
 157 <arg> Set the recovery timeout period.
 158 \layout Description
 159
 160 --lustre_upcall\SpecialChar ~
 161 <path> Set the location of the Lustre upcall scripts used
 162  by the client for recovery
 163 \layout Description
 164
 165 --portals_upcall\SpecialChar ~
 166 <path> Specify the location of the Portals upcall scripts
 167  used by the client for recovery
 168 \layout Description
 169
 170 --upcall\SpecialChar ~
 171 <path> Set the location of both Lustre and Portals upcall scripts
 172  used by the client for recovery
 173 \layout Description
 174
 175 --lctl-dump\SpecialChar ~
 176 <arg> Dump all ioctls to the specified file
 177 \layout Description
 178
 179 --dump\SpecialChar ~
 180 <file> Dump the kernel debug log to the specified file before portals
 181  is unloaded during cleanup.
 182 \layout Description
 183
 184 --reformat Reformat all the devices.
 185  This is essential on the first time the file system is brought up.
 186 \layout Description
 187
 188 -h,--help Print help.
 189 \layout Description
 190
 191 --maxlevel\SpecialChar ~
 192 <level> Perform configuration of devices and services up to level
 193  given.
 194
 195 \emph on
 196 level
 197 \emph default
 198  can take the values
 199 \series bold
 200 net, dev, svc, fs.
 201
 202 \series default
 203 When used in conjunction with cleanup, services are torn down up to a certain
 204  level.
 205  Default is 100.
 206 \layout Description
 207
 208 --minlevel\SpecialChar ~
 209 <level> Specify the minimum level of services to configure/cleanup.
 210  Default is 0.
 211 \layout Description
 212
 213 --lustre=src_dir Specify the base directory for Lustre sources, this parameter
 214  will cause lconf to load the lustre modules from this soure tree.
 215 \layout Description
 216
 217 --ptldebug\SpecialChar ~
 218 debug\SpecialChar ~
 219 level This options can be used to set the required debug
 220  level.
 221 \layout Description
 222
 223 --subsystem\SpecialChar ~
 224 <arg> Set the portals debug subsystem.
 225 \layout Subsection
 226
 227 EXAMPLES
 228 \layout Standard
 229
 230 On client nodes this is typically invoked as:
 231 \layout LyX-Code
 232
 233
 234 \size small
 235 lconf --node client config.xml
 236 \layout Standard
 237
 238 in order to give clients, regardless of hostname, a single configuration.
 239 \layout Standard
 240
 241 Required debug levels can be set like this:
 242 \layout LyX-Code
 243
 244
 245 \size small
 246    ## Everything but these
 247 \layout LyX-Code
 248
 249
 250 \size small
 251 lconf --ptldebug
 252 \begin_inset Quotes eld
 253 \end_inset
 254
 255 ~(portals | malloc | trace)
 256 \begin_inset Quotes erd
 257 \end_inset
 258
 259
 260 \layout LyX-Code
 261
 262 \layout LyX-Code
 263
 264
 265 \size small
 266 ## Only these debug types
 267 \layout LyX-Code
 268
 269
 270 \size small
 271 lconf --ptldebug
 272 \begin_inset Quotes eld
 273 \end_inset
 274
 275 ldlm|ha
 276 \begin_inset Quotes erd
 277 \end_inset
 278
 279
 280 \layout Subsection
 281
 282 BUGS
 283 \layout Standard
 284
 285 None are known.
 286 \the_end