lustre/doc/lmc.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 lmc
  30 \layout Subsection
  31
  32 NAME
  33 \layout Standard
  34
  35 lmc - lustre configuration maker.
  36 \layout Subsection
  37
  38 SYNOPSIS
  39 \layout Standard
  40
  41
  42 \series bold
  43 lmc [options] --add <objectype> [args]
  44 \layout Standard
  45
  46
  47 \series bold
  48 NOT IMPLEMENTED -- lmc [options] --remove <objecttype> [args]
  49 \layout Standard
  50
  51
  52 \series bold
  53 NOT IMPLEMENTED -- lmc [options] --convert [args]
  54 \layout Subsection
  55
  56 DESCRIPTION
  57 \layout Standard
  58
  59 At present lmc when invoked adds configuration data to the config file.
  60  lmc will also be able to remove configuration data or convert its forma.
  61  One generates a single config file for the cluster at present including
  62  at the minimum mds's, mtpt's and ost's and whatever those reference (e.g.
  63  net's and profiles)
  64 \layout Standard
  65
  66 The objecttype refers to a collection of related configuration entities
  67  and can be one of
  68 \series bold
  69 net, mds, lov, ost, mtpt, route, oscref.
  70
  71 \series default
  72 We describe the arguments required for the addition of each objecttype.
  73  [NOT implemented] Lmc can also remove items from or convert the format
  74  of configuration data.
  75 \layout Standard
  76
  77 to generate configuration data associated with systems in a Lustre cluster.
  78
  79 \layout Description
  80
  81 --add\SpecialChar ~
  82 net Adds a network device descriptor for the given node, with parameters
  83  as indicated.
  84 \begin_deeper
  85 \layout Standard
  86
  87 The arguments required are
  88 \layout Description
  89
  90 --node\SpecialChar ~
  91 ''node_name'' If not present this will create a new node with the
  92  given name.
  93  This is also used to specify a specific node for other elements, and the
  94 \layout Description
  95
  96 --nettype\SpecialChar ~
  97 <type> this can be
  98 \series bold
  99 tcp, elan, gm
 100 \layout Description
 101
 102 --nid\SpecialChar ~
 103 nid the network id, e.g.
 104  ElanID or IP address as used by portals.
 105  If host_name is '*', then the local address while be substituted when the
 106  node is configured with lconf.
 107 \layout Description
 108
 109 --router optional flag to mark this node as a router
 110 \layout Description
 111
 112 --profile optional flag to mark this node as a profile node.
 113  This is automatically true if the the --nid argument contains a '*'.
 114 \layout Description
 115
 116 --port\SpecialChar ~
 117 [port] optional argument to indicate the tcp port.
 118  The default is 988.
 119
 120 \layout Description
 121
 122 --tcpbuf\SpecialChar ~
 123 <size> optional argument
 124 \end_deeper
 125 \layout Description
 126
 127 --add\SpecialChar ~
 128 mds
 129 \begin_deeper
 130 \layout Description
 131
 132 --mds\SpecialChar ~
 133 <mds_name>
 134 \layout Description
 135
 136 --device\SpecialChar ~
 137 <pathname>
 138 \layout Description
 139
 140 --size\SpecialChar ~
 141 <size> optional argument indicating the size of the device to be created
 142  (used typically for loop devices).
 143 \layout Description
 144
 145 --node\SpecialChar ~
 146 <nodename> Adds an MDS to the specified node.
 147  This requires a --node argument, and it must not be a profile node.
 148 \end_deeper
 149 \layout Description
 150
 151 --add\SpecialChar ~
 152 lov Creates an LOV with the specified parameters.
 153  The mds_name must already exist in the descriptor.
 154 \begin_deeper
 155 \layout Description
 156
 157 --lov_<name>
 158 \layout Description
 159
 160 --mds_<name>
 161 \layout Description
 162
 163 --stripesize\SpecialChar ~
 164 <size>
 165 \layout Description
 166
 167 --stripecount\SpecialChar ~
 168 <count>
 169 \layout Description
 170
 171 --pattern\SpecialChar ~
 172 <pattern> Pattern can be 0.
 173 \end_deeper
 174 \layout Description
 175
 176 --add\SpecialChar ~
 177 ost Creates an OBD, OST, and OSC.
 178  The OST and OBD are created on the specified node.
 179 \begin_deeper
 180 \layout Description
 181
 182 --ost\SpecialChar ~
 183 <name> [NOT IMPLEMENTED] Name to give to this OST target.
 184 \layout Description
 185
 186 --node\SpecialChar ~
 187 <nodename> Node on which the OST service is run, can not be a profile
 188  node.
 189 \layout Description
 190
 191 --device\SpecialChar ~
 192
 193 \layout Description
 194
 195 --size\SpecialChar ~
 196 [size]
 197 \layout Description
 198
 199 --lov\SpecialChar ~
 200 <name> Name of LOV to which this OSC will be attached.
 201
 202 \layout Description
 203
 204 --obduuid\SpecialChar ~
 205 UUID specify the UUID of the OBD device.
 206  The default value is OBD_nodename_UUID.
 207 \end_deeper
 208 \layout Description
 209
 210 --add\SpecialChar ~
 211 mtpt Creates a mount point on the specified node.
 212  Either an LOV or OSC name can be used.
 213 \begin_deeper
 214 \layout Description
 215
 216 --node\SpecialChar ~
 217 node node or profile node that will use the mtpt
 218 \layout Description
 219
 220 --path\SpecialChar ~
 221 /mnt/path\SpecialChar ~
 222
 223 \layout Description
 224
 225 --mds\SpecialChar ~
 226 mds_name
 227 \layout Description
 228
 229 --mdc\SpecialChar ~
 230 lov_name|osc_name
 231 \end_deeper
 232 \layout Description
 233
 234 --add\SpecialChar ~
 235 route Creates a static route through a gateway to a specific nid or
 236  a range of nids.
 237 \begin_deeper
 238 \layout Description
 239
 240 --node\SpecialChar ~
 241 node node or profile node to add the route to
 242 \layout Description
 243
 244 --gw\SpecialChar ~
 245 nid the nid of the gateway (must be a local interface or a peer)
 246 \layout Description
 247
 248 --tgt\SpecialChar ~
 249 nid for a specific route, this is the target nid
 250 \layout Description
 251
 252 --lo\SpecialChar ~
 253 nid for a range route, this is the lo value nid
 254 \layout Description
 255
 256 --hi\SpecialChar ~
 257 nid for a range route, this is the hi value nid
 258 \end_deeper
 259 \layout Description
 260
 261 --add\SpecialChar ~
 262 oscref Adds an OSC reference to a node.
 263  This is only necessary when the the OSC will be used without a mountpoint.
 264 \begin_deeper
 265 \layout Description
 266
 267 --node\SpecialChar ~
 268 node node or profile node to add the OSC ref to
 269 \layout Description
 270
 271 --osc\SpecialChar ~
 272 osc_name Name of the OSC to add a reference to.
 273  The --add ost command automatically creates the OSC, and the name will
 274  be OSC_<node>, where node is the name of node the OST is on.
 275 \end_deeper
 276 \layout Description
 277
 278 Options:
 279 \begin_deeper
 280 \layout Description
 281
 282 --output\SpecialChar ~
 283 filename Sends output to the file.
 284  If the file exists, it will be overwritten.
 285 \layout Description
 286
 287 --merge\SpecialChar ~
 288 filename Add the new element to an existing file.
 289
 290 \end_deeper
 291 \layout Subsection
 292
 293 EXAMPLES
 294 \layout Standard
 295
 296 Real life examples are given in the lustre-conf man page.
 297 \layout Subsection
 298
 299 BUGS
 300 \layout Standard
 301
 302 None are known.
 303 \layout Subsection
 304
 305 AUTHOR
 306 \layout Standard
 307
 308 Cluster File Systems, Inc.
 309  2002 - created
 310 \the_end