From d888b77173e6b27b5f44235cd8b7b81ecfb51dc1 Mon Sep 17 00:00:00 2001 From: radhikav Date: Fri, 20 Dec 2002 01:50:41 +0000 Subject: [PATCH] Some formatting changes were made to these files by doug. --- lustre/doc/lconf.lyx | 169 ++++++++--- lustre/doc/lctl.lyx | 782 ++++++++++++++++++++++++++++++++++++++++----------- lustre/doc/lmc.lyx | 568 +++++++++++++++++++++++++++++-------- 3 files changed, 1198 insertions(+), 321 deletions(-) diff --git a/lustre/doc/lconf.lyx b/lustre/doc/lconf.lyx index 0095c6f..60739c6 100644 --- a/lustre/doc/lconf.lyx +++ b/lustre/doc/lconf.lyx @@ -30,9 +30,9 @@ lconf \layout Subsection NAME -\layout Standard +\layout Description -lconf- Lustre file system configuration utility +lconf Lustre filesystem configuration utility. \layout Subsection SYNOPSIS @@ -40,6 +40,7 @@ SYNOPSIS \series bold +\emph on lconf\SpecialChar ~ [--node ] [-d,--cleanup] [--noexec] [--gdb] [--nosetup] [--nomod] [-n,--noexec] [-v,--verbose] [-h,--help] @@ -48,52 +49,137 @@ lconf\SpecialChar ~ DESCRIPTION \layout Standard -This program configures a node following directives in the -\layout Description +This program configures a node following directives in the . +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --node\SpecialChar ~ -node_name Specifiy a specific node to configure. - By default, LCONF will search for nodes with the local hostname and 'localhost'. - When --node is used, only node_name is searched for. - If a matching node is not found in the config, then LCONF exits with an +node_name +\series default +\emph default + Specify a specific node to configure. + By default, lconf will search for nodes with the local hostname and 'localhost'. + When +\emph on + --node +\emph default + is used, only +\emph on +node_name +\emph default + is searched for. + If a matching node is not found in the config, then lconf exits with an error. -\layout Description +\layout List +\labelwidthstring 00.00.0000 + ---cleanup Unconfigure a node. - The same config and --node argument used for configuration needs to be - used for cleanup as well. - This will attempt to undo all of the configuration steps done by LCONF, +\series bold +\emph on +--cleanup +\series default +\emph default + Unconfigure a node. + The same config and +\emph on +--node +\emph default + argument used for configuration needs to be used for cleanup as well. + This will attempt to undo all of the configuration steps done by lconf, including unloading the kernel modules. -\layout Description +\layout List +\labelwidthstring 00.00.0000 ---noexec Print, but don't execute, the steps lconf will perform. - This is useful for debugging a configuration, and when used with --node, - can be run on any host. -\layout Description ---gdb Causes LCONF to print a message and pause for 5 seconds after creating - a gdb module script and before doing any lustre configuration. - (The gdb module script is always created, however.) -\layout Description +\series bold +\emph on +--noexec +\series default +\emph default + Print, but don't execute, the steps lconf will perform. + This is useful for debugging a configuration, and when used with +\emph on +--node +\emph default +, can be run on any host. +\layout List +\labelwidthstring 00.00.0000 ---nosetup Only load modules, do not configure devices or services -\layout Description ---nomod Only setup devices and services, do not load modules -\layout Description +\series bold +\emph on +--gdb +\series default +\emph default + Causes lconf to print a message and pause for 5 seconds after creating + a gdb module script and before doing any Lustre configuration (the gdb + module script is always created, however). +\layout List +\labelwidthstring 00.00.0000 ---noexec,-n Don't do anything, but print what would happen. -\layout Description ---verbose,-v Be verbose and show actions while going along -\layout Description +\series bold +\emph on +--nosetup +\series default +\emph default + Only load modules, do not configure devices or services. +\layout List +\labelwidthstring 00.00.0000 + + +\series bold +\emph on +--nomod +\series default +\emph default + Only setup devices and services, do not load modules. +\layout List +\labelwidthstring 00.00.0000 + + +\series bold +\emph on +--noexec,-n +\emph default + +\series default +Don't do anything, but print what would happen. +\layout List +\labelwidthstring 00.00.0000 + + +\series bold +\emph on +--verbose,-v +\series default +\emph default + Be verbose and show actions while going along. +\layout List +\labelwidthstring 00.00.0000 + + +\series bold +\emph on +-h,--help +\series default +\emph default + Print help. +\layout List +\labelwidthstring 00.00.0000 --h,--help Print help. -\layout Description +\series bold +\emph on --maxlevel\SpecialChar ~ - [NOT IMPLEMENTED] Perform configuration of devices and - services up to level given. + +\series default +\emph default + [NOT IMPLEMENTED] Perform configuration of devices and services up to level + given. \emph on level @@ -103,31 +189,26 @@ level net, dev, svc, fs. \series default -When used in conjunction with cleanup services are torn down up to a certain +When used in conjunction with cleanup, services are torn down up to a certain level. \layout Subsection EXAMPLES \layout Standard -On client nodes this is typically invoked as +On client nodes this is typically invoked as: \layout LyX-Code + +\size small lconf --node client config.xml \layout Standard -in order to give clients, regardless of hostname a single configuration. +in order to give clients, regardless of hostname, a single configuration. \layout Subsection BUGS \layout Standard None are known. -\layout Subsection - -AUTHOR -\layout Standard - -Cluster File Systems, Inc. - 2002 - created \the_end diff --git a/lustre/doc/lctl.lyx b/lustre/doc/lctl.lyx index 154b646..f6b1924 100644 --- a/lustre/doc/lctl.lyx +++ b/lustre/doc/lctl.lyx @@ -26,13 +26,13 @@ \layout Section -LCTL +lctl \layout Subsection NAME -\layout Standard +\layout Description -lctl - low level Lustre file system configuration utility +lctl Low level Lustre filesystem configuration utility. \layout Subsection SYNOPSIS @@ -40,11 +40,16 @@ SYNOPSIS \series bold +\emph on +\SpecialChar ~ + +\newline lctl \layout Standard \series bold +\emph on lctl\SpecialChar ~ --device\SpecialChar ~ \SpecialChar ~ @@ -69,88 +75,126 @@ The program can be invoked in interactive mode by issuing lctl. \series default - After that commands are issued as below. + After that, commands are issued as below. The most common commands in lctl are (in matching pairs) \family typewriter +\size small device \family default -, +\size default + and \family typewriter +\size small attach \family default - and +\size default +, \family typewriter +\size small detach \family default -, +\size default + and \family typewriter +\size small setup \family default - and +\size default +, \family typewriter +\size small cleanup \family default -, +\size default + and \family typewriter +\size small connect \family default - and +\size default +, \family typewriter +\size small disconnect \family default -, +\size default + and \family typewriter +\size small help \family default +\size default , and \family typewriter +\size small quit \family default +\size default . - To get a complete listing of available commands, type + To get a complete listing of available commands, type \family typewriter +\size small help \family default +\size default at the lctl prompt. To get basic help on the meaning and syntax of a command, type \family typewriter +\size small help command \family default +\size default . Command completion is activated with the \family typewriter +\size small TAB \family default +\size default key, and command history is available via the up- and down-arrow keys. \layout Standard -For non-interactive single threaded use, one uses the second invocation +For non-interactive single threaded use, one uses the second invocation, which runs \emph on command \emph default - after connecting to the + after connecting to the device \emph on -device. +. \emph default -\layout Description +\layout List +\labelwidthstring 00.00.0000 ---device The device number to be used for the operation. + +\series bold +\emph on +--device +\series default +\emph default + The device number to be used for the operation. The value of devno is an integer, normally found by calling \emph on lctl name2dev \emph default on a device name. -\layout Description +\layout List +\labelwidthstring 00.00.0000 + ---threads How many threads should be forked doing the command specified. +\series bold +\emph on +--threads +\series default +\emph default + How many threads should be forked doing the command specified. The numthreads variable is a strictly positivie integer indicating how many threads should be started. - Verbose can take values , + Verbose can take values ; \emph on devno \emph default @@ -161,138 +205,308 @@ is used as above. \layout Description -network\SpecialChar ~ -config +Network\SpecialChar ~ +Configuration \begin_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on network\SpecialChar ~ - Indicate what kind of network applies for the - configuration commands that follow -\layout Description + +\series default +\emph default + Indicate what kind of network applies for the configuration commands that + follow. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on connect\SpecialChar ~ [[\SpecialChar ~ ]\SpecialChar ~ |\SpecialChar ~ ] This will establish a connection to - a remote network network id given by the hostname/port combination or the - elan id -\layout Description +id>] +\series default +\emph default + This will establish a connection to a remote network network +\emph on +id +\emph default + given by the hostname/port combination, or the elan +\emph on +id +\emph default +. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on disconnect\SpecialChar ~ - Disconnect from a remote nid -\layout Description + +\series default +\emph default + Disconnect from a remote +\emph on +nid +\emph default +. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on mynid\SpecialChar ~ -[nid] Informs the socknal of the local nid. +[nid] +\series default +\emph default + Informs the socknal of the local +\emph on +nid +\emph default +. It defaults to hostname for tcp networks and is automatically setup for - elan/myrinet networks -\layout Description + elan/myrinet networks. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on add_uuid\SpecialChar ~ \SpecialChar ~ - Associate a given UUID with an -\emph on -nid + +\series default \emph default - -\layout Description + Associate a given UUID with an +\emph on +nid. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on close_uuid\SpecialChar ~ - Disconnect a UUID -\layout Description + +\series default +\emph default + Disconnect a UUID. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on del_uuid\SpecialChar ~ - Delete a UUID association -\layout Description + +\series default +\emph default + Delete a UUID association. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on add_route\SpecialChar ~ \SpecialChar ~ \SpecialChar ~ -[target] Add an entry to the routing table for - the given target -\layout Description +[target] +\series default +\emph default + Add an entry to the routing table for the given target. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on del_route\SpecialChar ~ - Delete an entry for the target from the routing table -\layout Description + +\series default +\emph default + Delete an entry for the target from the routing table. +\layout List +\labelwidthstring 00.00.0000 -route_list Print the complete routing table -\layout Description +\series bold +\emph on +route_list +\series default +\emph default + Print the complete routing table. +\layout List +\labelwidthstring 00.00.0000 + + +\series bold +\emph on recv_mem\SpecialChar ~ -[size] Set the socket receive buffer size, if the size is omited - the default size for the buffer is printed -\layout Description +[size] +\series default +\emph default + Set the socket +\emph on +receive +\emph default + buffer size; if the size is omitted, the default size for the buffer is + printed. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on send_mem\SpecialChar ~ -[size] Set send buffer size for the socket, if size is omited the - default size for the buffer is printed -\layout Description +[size] +\series default +\emph default + Set send buffer size for the socket; if size is omitted, the default size + for the buffer is printed. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on nagle\SpecialChar ~ -[on/off] Enable/disable nagle, omiting the arguement will cause the - default value to be printed +[on/off] +\series default +\emph default + Enable/disable nagle; omitting the argument will cause the default value + to be printed. \end_deeper \layout Description -device\SpecialChar ~ -selection +Device\SpecialChar ~ +Selection \begin_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 -newdev Create a new device -\layout Description -name2dev This command can be used to determine a device number for the given - device name. -\layout Description +\series bold +\emph on +newdev +\series default +\emph default + Create a new device. +\layout List +\labelwidthstring 00.00.0000 -device This will select the specified OBD device. + +\series bold +\emph on +name2dev +\series default +\emph default + This command can be used to determine a device number for the given device + name. +\layout List +\labelwidthstring 00.00.0000 + + +\series bold +\emph on +device +\series default +\emph default + This will select the specified OBD device. All other commands depend on the device being set. -\layout Description +\layout List +\labelwidthstring 00.00.0000 + -device_list Show all the devices +\series bold +\emph on +device_list +\series default +\emph default + Show all the devices. \end_deeper \layout Description -device\SpecialChar ~ -config +Device\SpecialChar ~ +Configuration \begin_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on attach\SpecialChar ~ type\SpecialChar ~ [name\SpecialChar ~ -[uuid]] +[uuid]] +\series default +\emph default + \shape italic +\emph on Attach \shape default +\emph default a type to the current device (which you need to set using the \family typewriter +\size small device \family default +\size default command) and give that device a name and UUID. This allows us to identify the device for use later, and also tells us what type of device we will have. -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on setup\SpecialChar ~ - Type specific device setup commands. - For obdfilter a setup command tells the driver which block device it should + +\series default +\emph default + Type specific device setup commands. + For obdfilter, a setup command tells the driver which block device it should use for storage and what type of filesystem is on that device. -\layout Description +\layout List +\labelwidthstring 00.00.0000 -cleanup Cleanup a previously setup device -\layout Description -detach Remove driver (and name and uuid) from the current device -\layout Description +\series bold +\emph on +cleanup +\series default +\emph default + Cleanup a previously setup device. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on +detach +\series default +\emph default + Remove driver (and name and UUID) from the current device. +\layout List +\labelwidthstring 00.00.0000 + + +\series bold +\emph on lov_setconfig\SpecialChar ~ lov-uuid\SpecialChar ~ default-stripe-count\SpecialChar ~ @@ -301,166 +515,409 @@ offset\SpecialChar ~ pattern\SpecialChar ~ UUID1\SpecialChar ~ [U -UID2...] Write LOV configuration to an MDS device -\layout Description +UID2...] +\series default +\emph default + Write LOV configuration to an MDS device. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on lov_getconfig\SpecialChar ~ -lov-uuid Read LOV configuration from an MDS device. +lov-uuid +\series default +\emph default + Read LOV configuration from an MDS device. Returns default-stripe-count, default-stripe-size, offset, pattern, and - a list of OST UUIDs. + a list of OST UUID's. \end_deeper \layout Description -device\SpecialChar ~ -operations +Device\SpecialChar ~ +Operations \begin_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on probe\SpecialChar ~ -[timeout] Build a connection handle to a device. - This command is used to suspend configuration till the lctl command has - ensured that the mds and osc services are available. - This is to avoid mount failures in a reebooting cluster -\layout Description +[timeout] +\series default +\emph default + Build a connection handle to a device. + This command is used to suspend configuration until the lctl command has + ensured that the MDS and OSC services are available. + This is to avoid mount failures in a rebooting cluster. +\layout List +\labelwidthstring 00.00.0000 -close -\layout Description +\series bold +\emph on +close +\emph default + +\layout List +\labelwidthstring 00.00.0000 + + +\series bold +\emph on getattr\SpecialChar ~ - Get attributes for an OST object -\layout Description + +\series default +\emph default + Get attributes for an OST object +\emph on + +\emph default + . +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on setattr\SpecialChar ~ \SpecialChar ~ - Set mode attribute for OST object -\layout Description + +\series default +\emph default + Set mode attribute for OST object +\emph on + +\emph default +. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on create\SpecialChar ~ [num\SpecialChar ~ [mode\SpecialChar ~ -[verbose]]] Create the specified number of OST objects - with the given -\layout Description +[verbose]]] +\series default +\emph default + Create the specified number +\emph on + +\emph default + of OST objects with the given +\emph on + +\emph default +. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on destroy\SpecialChar ~ - Destroy an OST object -\layout Description + +\series default +\emph default + Destroy an OST object. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on test_getattr\SpecialChar ~ \SpecialChar ~ [verbose\SpecialChar ~ -[[t]objid]] Do getattrs on OST object - (objectid+1 on each thread) -\layout Description +[[t]objid]] +\series default +\emph default + Do +\emph on + +\emph default + +\emph on +getattrs +\emph default + on OST object +\emph on + +\emph default + ( +\emph on +objectid +\emph default ++1 on each thread). +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on test_brw\SpecialChar ~ [t]\SpecialChar ~ [write\SpecialChar ~ [verbose\SpecialChar ~ [npages\SpecialChar ~ -[[t]objid]]]] Do bulk read/writes - on OST object ( per I/O) -\layout Description +[[t]objid]]]] +\series default +\emph default + Do +\emph on + +\emph default + bulk +\emph on +read +\emph default +/ +\emph on +writes +\emph default + on OST object +\emph on + +\emph default + ( +\emph on + +\emph default + per I/O). +\layout List +\labelwidthstring 00.00.0000 -test_ldlm Perform lock manager test -\layout Description +\series bold +\emph on +test_ldlm +\series default +\emph default + Perform lock manager test. +\layout List +\labelwidthstring 00.00.0000 + + +\series bold +\emph on ldlm_regress_start\SpecialChar ~ %s\SpecialChar ~ [numthreads\SpecialChar ~ [refheld\SpecialChar ~ [numres\SpecialChar ~ -[numext]]]] Start lock manager - stress test -\layout Description +[numext]]]] +\series default +\emph default + Start lock manager stress test. +\layout List +\labelwidthstring 00.00.0000 -ldlm_regress_stop Stop lock manager stress test -\layout Description -dump_ldlm Dump all lock manager state, this is very useful for debugging -\layout Description +\series bold +\emph on +ldlm_regress_stop +\series default +\emph default + Stop lock manager stress test. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on +dump_ldlm +\series default +\emph default + Dump all lock manager state, this is very useful for debugging +\layout List +\labelwidthstring 00.00.0000 + + +\series bold +\emph on newconn\SpecialChar ~ \SpecialChar ~ [newuuid] \end_deeper \layout Description -debug +Debug \begin_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on debug_kernel\SpecialChar ~ [file]\SpecialChar ~ -[raw] Get debug buffer and dump to a fileusage -\layout Description +[raw] +\series default +\emph default + Get debug buffer and dump to a +\emph on +fileusage +\emph default +. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on debug_file\SpecialChar ~ \SpecialChar ~ [output]\SpecialChar ~ -[raw] Read debug buffer from input and dump to - outputusage -\layout Description +[raw] +\series default +\emph default + Read debug buffer from input and dump to +\emph on +outputusage +\emph default +. +\layout List +\labelwidthstring 00.00.0000 -clear Clear kernel debug buffer -\layout Description +\series bold +\emph on +clear +\series default +\emph default + Clear kernel debug buffer. +\layout List +\labelwidthstring 00.00.0000 + + +\series bold +\emph on mark\SpecialChar ~ - Insert marker text in kernel debug buffer -\layout Description + +\series default +\emph default + Insert marker text in kernel debug buffer. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on filter\SpecialChar ~ Filter message type from the kernel debug - buffer -\layout Description +mask> +\series default +\emph default + Filter message type from the kernel debug buffer. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on show\SpecialChar ~ Show specific type of messages -\layout Description +mask> +\series default +\emph default + Show specific type of messages. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on debug_list\SpecialChar ~ - List all the subsystem and debug types -\layout Description + +\series default +\emph default + List all the subsystem and debug types. +\layout List +\labelwidthstring 00.00.0000 + -panic Force the kernel to panic +\series bold +\emph on +panic +\series default +\emph default + Force the kernel to panic. \end_deeper \layout Description -control +Control \begin_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 -help Show a complete list of commands, help can be used to - get help on specific command -\layout Description -exit Close the lctl session -\layout Description +\series bold +\emph on +help +\series default +\emph default + Show a complete list of commands; +\emph on +help +\emph default + can be used to get help on specific command. +\layout List +\labelwidthstring 00.00.0000 -quit Close the lctl session + +\series bold +\emph on +exit +\series default +\emph default + Close the lctl session. +\layout List +\labelwidthstring 00.00.0000 + + +\series bold +\emph on +quit +\series default +\emph default + Close the lctl session. \end_deeper \layout Subsection EXAMPLES \layout Description + +\emph on attach \layout LyX-Code + +\size small # lctl \newline lctl > newdev \newline -lctl > attach obdfilter OBDDEV OBDUUID +lctl > attach obdfilter OBDDEV OBDUUID +\size default + +\newline + \layout Description + +\emph on connect \layout LyX-Code + +\size small lctl > name2dev OSCDEV \newline 2 @@ -468,13 +925,19 @@ lctl > name2dev OSCDEV lctl > device 2 \newline lctl > connect +\size default + \newline \layout Description + +\emph on getattr \layout LyX-Code + +\size small lctl > getattr 12 \newline id: 12 @@ -514,14 +977,26 @@ obdmd: lctl > disconnect \newline Finished (success) +\newline + \layout Description -setup + +\emph on +setup +\emph default + \layout LyX-Code + +\size small lctl > setup /dev/loop0 extN \newline -lctl > quit +lctl > quit +\size default + +\newline + \layout LyX-Code \layout Subsection @@ -530,11 +1005,4 @@ BUGS \layout Standard None are known. -\layout Subsection - -AUTHOR -\layout Standard - -Cluster File Systems, Inc. - 2002 - created \the_end diff --git a/lustre/doc/lmc.lyx b/lustre/doc/lmc.lyx index a5160b7..d8032e1 100644 --- a/lustre/doc/lmc.lyx +++ b/lustre/doc/lmc.lyx @@ -30,9 +30,9 @@ lmc \layout Subsection NAME -\layout Standard +\layout Description -lmc - lustre configuration maker. +lmc Lustre configuration maker. \layout Subsection SYNOPSIS @@ -40,254 +40,589 @@ SYNOPSIS \series bold +\emph on lmc [options] --add [args] \layout Standard \series bold -NOT IMPLEMENTED -- lmc [options] --remove [args] +NOT IMPLEMENTED +\emph on +-- lmc [options] --remove [args] \layout Standard \series bold -NOT IMPLEMENTED -- lmc [options] --convert [args] +NOT IMPLEMENTED +\emph on +-- lmc [options] --convert [args] \layout Subsection DESCRIPTION \layout Standard -At present lmc when invoked adds configuration data to the config file. - lmc will also be able to remove configuration data or convert its forma. - One generates a single config file for the cluster at present including - at the minimum mds's, mtpt's and ost's and whatever those reference (e.g. - net's and profiles) +At present lmc, when invoked, adds configuration data to the config file. + lmc will also be able to remove configuration data or convert its format. + One generates a single config file for the cluster at present including, + at the minimum, MDS's, mtpt's, and OST's and whatever those reference (e.g. + nets and profiles). \layout Standard -The objecttype refers to a collection of related configuration entities - and can be one of +The +\emph on +objecttype +\emph default + refers to a collection of related configuration entities and can be one + of \series bold -net, mds, lov, ost, mtpt, route, oscref. +net, MDS, LOV, OST, mtpt, route, or oscref. \series default -We describe the arguments required for the addition of each objecttype. - [NOT implemented] Lmc can also remove items from or convert the format +We describe the arguments required for the addition of each +\emph on +objecttype +\emph default +. + [NOT IMPLEMENTED] lmc can also remove items from or convert the format of configuration data. \layout Standard -to generate configuration data associated with systems in a Lustre cluster. - -\layout Description +To generate configuration data associated with systems in a Lustre cluster: +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --add\SpecialChar ~ -net Adds a network device descriptor for the given node, with parameters - as indicated. +net +\series default +\emph default + Adds a network device descriptor for the given node, with parameters as + indicated. \begin_deeper \layout Standard -The arguments required are -\layout Description +The arguments required are: +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --node\SpecialChar ~ -''node_name'' If not present this will create a new node with the - given name. - This is also used to specify a specific node for other elements, and the -\layout Description +''node_name'' +\series default +\emph default + This will create a new node with the given name if not already present. + This is also used to specify a specific node for other elements. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --nettype\SpecialChar ~ - this can be + +\series default +\emph default + This can be \series bold -tcp, elan, gm -\layout Description +tcp, elan, gm. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --nid\SpecialChar ~ -nid the network id, e.g. - ElanID or IP address as used by portals. - If host_name is '*', then the local address while be substituted when the - node is configured with lconf. -\layout Description +nid +\series default +\emph default + The network +\emph on +id +\emph default +, e.g. + ElanID or IP address as used by Portals. + If +\emph on +host_name +\emph default + is '*', then the local address while be substituted when the node is configured + with lconf. +\layout List +\labelwidthstring 00.00.0000 ---router optional flag to mark this node as a router -\layout Description ---profile optional flag to mark this node as a profile node. - This is automatically true if the the --nid argument contains a '*'. -\layout Description +\series bold +\emph on +--router +\series default +\emph default + Optional flag to mark this node as a router +\layout List +\labelwidthstring 00.00.0000 + + +\series bold +\emph on +--profile +\series default +\emph default + Optional flag to mark this node as a profile node. + This is automatically true if the the +\emph on +--nid +\emph default + argument contains a '*'. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --port\SpecialChar ~ -[port] optional argument to indicate the tcp port. +[port] +\series default +\emph default + Optional argument to indicate the tcp port. The default is 988. -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --tcpbuf\SpecialChar ~ - optional argument + +\series default +\emph default + Optional argument. \end_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --add\SpecialChar ~ mds \begin_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --mds\SpecialChar ~ - -\layout Description + +\series default +\emph default + +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --dev\SpecialChar ~ - Path of device on local system. + +\series default +\emph default + Path of device on local system. If the is a file, then a loop device is created and used as the block device. -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --size\SpecialChar ~ - optional argument indicating the size of the device to be created - (used typically for loop devices). -\layout Description + +\series default +\emph default + Optional argument indicating the size of the device to be created (used + typically for loop devices). +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --node\SpecialChar ~ - Adds an MDS to the specified node. - This requires a --node argument, and it must not be a profile node. + +\series default +\emph default + Adds an MDS to the specified node. + This requires a +\emph on +--node +\emph default + argument, and it must not be a profile node. \end_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --add\SpecialChar ~ -lov Creates an LOV with the specified parameters. - The mds_name must already exist in the descriptor. +lov +\series default +\emph default + Creates an LOV with the specified parameters. + The +\emph on +mds_name +\emph default + must already exist in the descriptor. \begin_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --lov_ -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --mds_ -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --stripe_sz\SpecialChar ~ -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --stripe_cnt\SpecialChar ~ -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --stripe_pattern\SpecialChar ~ - Pattern can be 0. + +\series default +\emph default + Pattern can be 0. \end_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --add\SpecialChar ~ -ost Creates an OBD, OST, and OSC. +ost +\series default +\emph default + Creates an OBD, OST, and OSC. The OST and OBD are created on the specified node. \begin_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --obd\SpecialChar ~ - Assign a name to the OBD device. -\layout Description + +\series default +\emph default + Assign a name to the OBD device. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --node\SpecialChar ~ - Node on which the OST service is run, can not be a profile - node. -\layout Description + +\series default +\emph default + Node on which the OST service is run, can not be a profile node. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --dev\SpecialChar ~ - Path of device on local system. - If the is a file, then a loop device is created and used as the block device. -\layout Description + +\series default +\emph default + Path of device on local system. + If this is a file, then a loop device is created and used as the block + device. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --size\SpecialChar ~ [size] -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --lov\SpecialChar ~ - Name of LOV to which this OSC will be attached. + +\series default +\emph default + Name of LOV to which this OSC will be attached. -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold --obduuid\SpecialChar ~ -UUID specify the UUID of the OBD device. - The default value is OBD_nodename_UUID. +UUID +\series default + Specify the UUID of the OBD device. + The default value is +\emph on +OBD_nodename_UUID +\emph default +. \end_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --add\SpecialChar ~ -mtpt Creates a mount point on the specified node. +mtpt +\series default +\emph default + Creates a mount-point on the specified node. Either an LOV or OSC name can be used. \begin_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --node\SpecialChar ~ -node node or profile node that will use the mtpt -\layout Description +node +\series default +\emph default + Node or profile node that will use the +\emph on +mtpt +\emph default +. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --path\SpecialChar ~ /mnt/path\SpecialChar ~ -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --mds\SpecialChar ~ mds_name -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --obd\SpecialChar ~ lov_name|osc_name \end_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --add\SpecialChar ~ -route Creates a static route through a gateway to a specific nid or - a range of nids. +route +\series default +\emph default + Creates a static route through a gateway to a specific +\emph on +nid +\emph default + or a range of +\emph on +nid +\emph default +'s. \begin_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --node\SpecialChar ~ -node node or profile node to add the route to -\layout Description +node +\series default +\emph default + Node or profile node to add the route to. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --gw\SpecialChar ~ -nid the nid of the gateway (must be a local interface or a peer) -\layout Description +nid +\series default +\emph default + The +\emph on +nid +\emph default + of the gateway (must be a local interface or a peer). +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --tgt\SpecialChar ~ -nid for a specific route, this is the target nid -\layout Description +nid +\series default +\emph default + For a specific route, this is the target +\emph on +nid. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --lo\SpecialChar ~ -nid for a range route, this is the lo value nid -\layout Description +nid +\series default +\emph default + For a range route, this is the lo value +\emph on +nid. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --hi\SpecialChar ~ -nid for a range route, this is the hi value nid +nid +\series default +\emph default + For a range route, this is the hi value +\emph on +nid. \end_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --add\SpecialChar ~ -oscref Adds an OSC reference to a node. - This is only necessary when the the OSC will be used without a mountpoint. +oscref +\series default +\emph default + Adds an OSC reference to a node. + This is only necessary when the the OSC will be used without a mount-point. \begin_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --node\SpecialChar ~ -node node or profile node to add the OSC ref to -\layout Description +node +\series default +\emph default +Node or profile node to add the +\emph on +oscref +\emph default + to. +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --osc\SpecialChar ~ -osc_name Name of the OSC to add a reference to. - The --add ost command automatically creates the OSC, and the name will - be OSC_, where node is the name of node the OST is on. +osc_name +\series default +\emph default + Name of the OSC to add a reference to. + The +\emph on +--add +\emph default + OST command automatically creates the OSC, and the name will be +\emph on +OSC_ +\emph default +, where node is the name of node the OST is on. \end_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + -Options: +\series bold +Options \begin_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --output\SpecialChar ~ -filename Sends output to the file. +filename +\series default +\emph default + Send output to the file. If the file exists, it will be overwritten. -\layout Description +\layout List +\labelwidthstring 00.00.0000 + +\series bold +\emph on --merge\SpecialChar ~ -filename Add the new element to an existing file. +filename +\series default +\emph default +Add the new element to an existing file. \end_deeper \layout Subsection @@ -295,18 +630,11 @@ filename Add the new element to an existing file. EXAMPLES \layout Standard -Real life examples are given in the lustre-conf man page. +Real life examples are given in the Lustre-conf manual page. \layout Subsection BUGS \layout Standard None are known. -\layout Subsection - -AUTHOR -\layout Standard - -Cluster File Systems, Inc. - 2002 - created \the_end -- 1.8.3.1