Remove obsolete man pages from tools no longer use in HEAD.
+++ /dev/null
-.TH lconf 1 "2004 Sep 16" Lustre "configuration utilities"
-.SH NAME
-lconf \- Lustre filesystem configuration utility
-.SH SYNOPSIS
-.br
-.B lconf
-[OPTIONS] <XML-config file>
-.br
-.SH DESCRIPTION
-.B lconf
-, when invoked configures a node following directives in the
-<XML-config-file>.Can be used to control recovery and startup/shutdown
-. There will be single configuration file for all the nodes in a
-single cluster. This file should be distributed to all the nodes in
-the cluster or kept in a location accessible to all the nodes. The XML file must be specified. When invoked with no options, lconf will attempt to configure the resources owned by the node it is invoked on
-.PP
-The arguments that can be used for lconf are:
-.PP
-.TP
---abort_recovery - Used to start Lustre when you are certian that
-recovery will not succeed, as when an OST or MDS is disabled.
-.TP
---acl Enable Access Control List support on the MDS
-.TP
---allow_unprivileged_port Allows connections from unprivileged ports
-.TP
---clientoptions <options>
-Additional options for mounting Lustre clients. Obsolete with
-zeroconfig mounting..
-.TP
---client_uuid <uuid>
-The failed client (required for recovery).
-.TP
---clumanager Generate a Red Hat Clumanager configuration file for this
-node.
-.TP
---config <arg>
-Cluster configuration name used for LDAP query (depreciated)
-.TP
---conn_uuid <uuid>
-The failed connection (required for recovery).
-.TP
--d|--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, including unloading the kernel modules.
-.TP
---debug_path <path>
-Path to save debug dumps.(default is /tmp/lustre-log)
-.TP
---dump <file>
-Dump the kernel debug log to the specified file before portals is unloaded during cleanup.
-.TP
---failover
-Used to shutdown without saving state. This will allow the node to give up service to another node for failover purposes. This will not be a clean shutdown.
-.TP
--f|--force
-Forced unmounting and/or obd detach during cleanup.
-.TP
---gdb
-Causes lconf to create a gdb module script and pause 5 seconds before doing any Lustre configuration (the gdb module script is always created, however).
-.TP
---gdb_script <arg>
-Full name of gdb debug script. Default is /tmp/ogdb.
-.TP
---group <arg>
-The group of devices to cleanup/configure.
-.TP
---group_upcall <arg>
-Pathname to the MDS upcall to resolve secondary group membership. Defaults to NONE, meaning that the MDS will use whatever group the client supplies, but this is limited to a single supplementary group.
-.TP
--h,--help
-Print help.
-.TP
---inactive <UUID>
-The UUID of the service to be ignored by a client mounting Lustre. Allows the client to mount in the presence of some inactive services. (currently OST only). Multiple UUIDs can be specified by repeating the option.
-.TP
---lctl-dump <arg>
-Dump all ioctls to the specified file
-.TP
---ldapurl <arg>
-LDAP server URL. Depreciated
-.TP
---lustre=src_dir
-Specify the base directory for Lustre sources, this parameter will cause lconf to load the lustre modules from this source tree.
-.TP
---lustre_upcall <path>
-Set the location of the Lustre upcall scripts used by the client for recovery
-.TP
---make_service_scripts Create per-service symlinks for use with clumanager HA software
-.TP
---mds_ost_conn
-Open connections to OSTs on MDS.
-.TP
---maxlevel <level>
-Perform configuration of devices and services up to level given. When
-used in conjunction with cleanup, services are torn down up to a
-certain level.
-Levels are aproximatly like:
-10 - network
-20 - device, ldlm
-30 - osd, mdd
-40 - mds, ost
-70 - mountpoint, echo_client, osc, mdc, lov
-.TP
---minlevel <level>
-Specify the minimum level of services to configure/cleanup. Default is 0.
-.TP
---mkfsoptions <options>
-Specify additional options for the mk*fs command line.
-.TP
---mountfsoptions <options>
-Specify additional options for mount fs command line. Mount options will be passed by this argument. For example, extents are to be enabled by adding ",extents" to the --mountfsoptions option. "errors=remount-ro" and "asyncdel" can also be added to it.
-.TP
---node node_name
-Specify 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 error.
-.TP
---noexec,-n
-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.
-.TP
---nomod
-Only setup devices and services, do not load modules.
-.TP
---nosetup
-Only load modules, do not configure devices or services.
-.TP
---old_conf Start up service even though config logs appear outdated.
-.TP
---portals <path>
-Specify portals source directory. If this is a relative path, then it
-is assumed to be relative to lustre. (Depreciated)
-.TP
---portals_upcall <path>
-Specify the location of the Portals upcall scripts used by the client
-for recovery (Depreciated)
-.TP
---ptldebug debug-level
-This options can be used to set the required debug level.
-.TP
---quota
-Enable quota support for client filesystem
-.TP
---rawprimary <arg> For clumanager, device of the primary quorum
-(default=/dev/raw/raw1)
-.TP
---rawsecondary <arg> For clumanager, device of the secondary quorum (default=/dev/raw/raw2)
-.TP
---record
-Write config information on mds.
-.TP
---record_device <arg>
-Specify MDS device name that will record the config commands.
-.TP
---record_log <arg>
-Specify the name of config record log.
-.TP
---recover <arg>
-Recover a device.
-.TP
---reformat
-Reformat all the devices. This is essential on the first time the file system is brought up.
-.TP
---select <arg>
-Select a particular node for a service
-.TP
---service <arg>
-Shorthand for --group <arg> --select <arg>=<hostname>
-.TP
---service_scripts <arg> For clumanager, directory containing per-service scripts (default=/etc/lustre/services)
-.TP
---single_socket The socknal option. Uses only one socket instead of a
-bundle.
-.TP
---subsystem <arg>
-Set the portals debug subsystem.
-.TP
---tgt_uuid <uuid>
-Specify the failed target (required for recovery).
-.TP
---timeout <arg>
-Set the recovery timeout period.
-.TP
---upcall <path>
-Set the location of both Lustre and Portals upcall scripts used by the
-client for recovery
-.TP
---user_xattr Enable user_xattr support on MDS
-.TP
---verbose,-v
-Be verbose and show actions while going along.
-.TP
---write_conf
-Save all client configuration information on the MDS
-.SH EXAMPLES
-.TP
-.B lconf --node client config.xml
-This invokes lconf on the client node.
-.TP
-.B lconf --ptldebug "~(portals | malloc | trace)"
-Used to set the required debug levels (all but these).
-.TP
-.B lconf --ptldebug "ldlm|ha"
-Used to turn-on specific debug types.
-.TP
-.B lconf --inactive OST_ost1_UUID --inactive OST_ost2_UUID config.xml
-A subset of failed OSTs can be ignored during Lustre mount on the clients by using this option. Here OST1 and OST2 have failed and need to be ignored.
-.SH BUGS
-None are known.
+++ /dev/null
-#LyX 1.3 created this file. For more info see http://www.lyx.org/
-\lyxformat 221
-\textclass amsart
-\language english
-\inputencoding auto
-\fontscheme times
-\graphics default
-\paperfontsize default
-\spacing single
-\papersize letterpaper
-\paperpackage a4
-\use_geometry 0
-\use_amsmath 0
-\use_natbib 0
-\use_numerical_citations 0
-\paperorientation portrait
-\secnumdepth 3
-\tocdepth 3
-\paragraph_separation skip
-\defskip medskip
-\quotes_language english
-\quotes_times 2
-\papercolumns 1
-\papersides 1
-\paperpagestyle default
-
-\layout Section
-
-lconf
-\layout Subsection
-
-NAME
-\layout Description
-
-lconf Lustre filesystem configuration utility.
-\layout Subsection
-
-SYNOPSIS
-\layout Standard
-
-
-\series bold
-lconf\SpecialChar ~
-[--node <node_name>] [-d,--cleanup] [--noexec] [--gdb] [--nosetup]
- [--nomod] [-n,--noexec] [-v,--verbose] [-h,--help] <XML-config file>
-\layout Subsection
-
-DESCRIPTION
-\layout Standard
-
-This program configures a node following directives in the <XML-config-file>.
- There will be single configuration file for all the nodes in a single cluster.
- This file should be distributed to all the nodes in the cluster or kept
- in a location accessible to all the nodes.
- One option is to store the cluster configuration information in LDAP format
- on an LDAP server that can be reached from all the cluster nodes.
-\layout Description
-
---client_uuid\SpecialChar ~
-<uuid> The failed client (required for recovery).
-\layout Description
-
---clientoptions\SpecialChar ~
-<options> Additional options for Lustre.
-\layout Description
-
---config\SpecialChar ~
-<arg> Cluster configuration name used for LDAP query
-\layout Description
-
---conn_uuid\SpecialChar ~
-<uuid> The failed connection (required for recovery).
-\layout Description
-
---d|--cleanup 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
-
---debug_path\SpecialChar ~
-<path> Path to save debug dumps.
-\layout Description
-
---dump\SpecialChar ~
-<file> Dump the kernel debug log to the specified file before portals
- is unloaded during cleanup.
-\layout Description
-
---dump_path\SpecialChar ~
-<arg> Path to save debug dumps.
- Default is /tmp/lustre_log
-\layout Description
-
---failover Used to shutdown without saving state.
- Default is 0.
- This will allow the node to give up service to another node for failover
- purposes.
- This will not be a clean shutdown.
-\layout Description
-
---force Forced unmounting and/or obd detach during cleanup.
- Default is 0.
-
-\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
-
---gdb_script\SpecialChar ~
-<arg> Full name of gdb debug script.
- Default is /tmp/ogdb.
-\layout Description
-
---group\SpecialChar ~
-<arg> The group of devices to cleanup/configure.
-\layout Description
-
---group_upcall\SpecialChar ~
-<arg> Pathname to the MDS upcall to resolve secondary group membership.
- Defaults to NONE, meaning that the MDS will use whatever group the client
- supplies, but this is limited to a single supplementary group.
-\layout Description
-
--h,--help Print help.
-\layout Description
-
---inactive\SpecialChar ~
-<UUID> The UUID of the service to be ignored by a client mounting
- Lustre.
- Allows the client to mount in the presence of some inactive services.
- (currently OST only).
- Multiple UUIDs can be specified by repeating the option.
-
-\layout Description
-
---lctl-dump\SpecialChar ~
-<arg> Dump all ioctls to the specified file
-\layout Description
-
---ldapurl\SpecialChar ~
-<arg> LDAP server URL
-\layout Description
-
---lustre_upcall\SpecialChar ~
-<path> Set the location of the Lustre upcall scripts used
- by the client for recovery
-\layout Description
-
---lustre=src_dir Specify the base directory for Lustre sources, this parameter
- will cause lconf to load the lustre modules from this soure tree.
-\layout Description
-
---mds_ost_conn Open connections to OSTs on MDS.
-\layout Description
-
---maxlevel\SpecialChar ~
-<level> Perform configuration of devices and services up to level
- given.
-
-\emph on
-level
-\emph default
- can take the values
-\series bold
-net, dev, svc, fs.
-
-\series default
-When used in conjunction with cleanup, services are torn down up to a certain
- level.
- Default is 100.
-\layout Description
-
---minlevel\SpecialChar ~
-<level> Specify the minimum level of services to configure/cleanup.
- Default is 0.
-\layout Description
-
---mkfsoptions\SpecialChar ~
-<options> Specify additional options for the mk*fs command
- line.
-\layout Description
-
---mountfsoptions\SpecialChar ~
-<options> Specify additional options for mount fs command
- line.
- Mount options will be passed by this argument.
- For example, extents are to be enabled by adding
-\begin_inset Quotes eld
-\end_inset
-
-,extents
-\begin_inset Quotes erd
-\end_inset
-
- to the --mountfsoptions option.
-
-\begin_inset Quotes eld
-\end_inset
-
-errors=remount-ro
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-asyncdel
-\begin_inset Quotes erd
-\end_inset
-
- can also be added to it.
-\layout Description
-
---node\SpecialChar ~
-node_name 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
-
---noexec,-n 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 Description
-
---nomod Only setup devices and services, do not load modules.
-\layout Description
-
---nosetup Only load modules, do not configure devices or services.
-\layout Description
-
---portals\SpecialChar ~
-<path> Specify portals source directory.
- If this is a relative path, then it is assumed to be relative to lustre.
-\layout Description
-
---portals_upcall\SpecialChar ~
-<path> Specify the location of the Portals upcall scripts
- used by the client for recovery
-\layout Description
-
---ptldebug\SpecialChar ~
-debug\SpecialChar ~
-level This options can be used to set the required debug
- level.
-\layout Description
-
---record Write config information on mds.
-\layout Description
-
---record_log\SpecialChar ~
-<arg> Specify the name of config record log.
-\layout Description
-
---record_device\SpecialChar ~
-<arg> Specify MDS device name that will record the config
- commands.
-\layout Description
-
---recover\SpecialChar ~
-<arg> Recover a device.
-\layout Description
-
---reformat Reformat all the devices.
- This is essential on the first time the file system is brought up.
-\layout Description
-
---select\SpecialChar ~
-<arg> Select a particular node for a service
-\layout Description
-
---single_socket Specify socknal option: only use one socket instead of bundle.
-\layout Description
-
---subsystem\SpecialChar ~
-<arg> Set the portals debug subsystem.
-\layout Description
-
---tgt_uuid\SpecialChar ~
-<uuid> Specify the failed target (required for recovery).
-\layout Description
-
---timeout\SpecialChar ~
-<arg> Set the recovery timeout period.
-\layout Description
-
---upcall\SpecialChar ~
-<path> Set the location of both Lustre and Portals upcall scripts
- used by the client for recovery
-\layout Description
-
---verbose,-v Be verbose and show actions while going along.
-\layout Description
-
---write_conf Save all client configuration information on the MDS
-\layout Subsection
-
-EXAMPLES
-\layout Standard
-
-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.
-\layout Standard
-
-Required debug levels can be set like this:
-\layout LyX-Code
-
-
-\size small
- ## Everything but these
-\layout LyX-Code
-
-
-\size small
-lconf --ptldebug
-\begin_inset Quotes eld
-\end_inset
-
-~(portals | malloc | trace)
-\begin_inset Quotes erd
-\end_inset
-
-
-\layout LyX-Code
-
-\layout LyX-Code
-
-
-\size small
-## Only these debug types
-\layout LyX-Code
-
-
-\size small
-lconf --ptldebug
-\begin_inset Quotes eld
-\end_inset
-
-ldlm|ha
-\begin_inset Quotes erd
-\end_inset
-
-
-\layout Standard
-
-A subset of failed OSTs can be ignored during Lustre mount on the clients
- by using the following option:
-\layout LyX-Code
-
- lconf --inactive OST_ost1_UUID --inactive OST_ost2_UUID config.xml
-\layout Standard
-
-where OST1 and OST2 have failed and need to be ignored.
-\layout Subsection
-
-BUGS
-\layout Standard
-
-None are known.
-\the_end
+++ /dev/null
-.TH lmc 1 "2004 Sep 16" Lustre "configuration utilities"
-.SH NAME
-lmc \- Lustre configuration maker
-.SH SYNOPSIS
-.br
-.B lmc
-[options] --add <objecttype> [args]
-.br
-.SH DESCRIPTION
-.B lmc
-, when invoked, adds configuration data to a configuration file. In future,
-lmc will also be able to remove configuration data or convert its format.
-A Lustre cluster consists of several components - MDSs, client mount-points,
-OSTs, LOVs and networks. A single configuration file would be generated for the complete cluster. In the lmc command line interface, each of these components is associated with an objecttype.
-.PP
-The objecttype refers to a collection of related configuration entities and can be one of
-.B net
-,
-.B MDS
-,
-.B LOV
-,
-.B OST
-,
-.B mtpt
-,
-.B route
-or
-.B echo-client.
-.PP
-We describe the arguments required for the addition of each objecttype.
-.PP
-To generate configuration data associated with systems in a Lustre cluster:
-.PP
-.B --add node
-Adds a new node in the cluster configuration.
-The arguements required are:
-.TP
---node <node_name>
-This will create a new node with the given name if not already present.
-.TP
---timeout <num>
-Timeout before going into recovery.
-.TP
---lustre_upcall <path>
-Set the location of the Lustre upcall scripts used by the client for recovery.
-.TP
---portals_upcall <path>
-Specify the location of the Portals upcall scripts used by the client for recovery.
-.TP
---upcall <path>
-Specify the location of both (Lustre and Portals) upcall scripts used by the client for recovery.
-.TP
---group_upcall <path>
-Specify the location of the group upcall scripts used by the MDS for determiningsupplementary group membership.
-.TP
---ptldebug <debug_level>
-Set the portals debug level.
-.TP
---subsystem <subsystem_name>
-Specify which Lustre subsystems have debug output recorded in the log.
-.PP
-.B --add net
-Adds a network device descriptor for the given node, with parameters as indicated.
-The arguments required are:
-.TP 12
---node <node_name>
-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.
-.TP
---nettype <type>
-This can be tcp, elan, or gm.
-.TP
---nid nid
-The network id, e.g. ElanID or IP address as used by Portals. If nid is '*', then the local address of the interface with specified nettype is will be substituted when the node is configured with lconf. An nid of '*' should be used only for the generic client configuration.
-.TP
---cluster_id id
-Specify the cluster ID.
-.TP
---hostaddr addr
-Specify the host address, which will be transfered to the real host address by lconf.
-.TP
---router
-Optional flag to mark this node as a router.
-.TP
---port [port]
-Optional arguement to indicate the tcp port. The default is 988.
-.TP
---tcpbuf <size>
-Optional arguement. The default TCP buffer size is 1MB.
-.TP
---irq_affinity 0|1
-Optional arguement. Default is 0.
-.TP
---nid_exchange 0|1
-Optional arguement since some OSTs might not have the required support. This is turned off by default, value of 1 will turn it ON.
-.PP
-.B --add mds
-Specify the MDS configuration:
-.TP
---node <node name>
-Name of the node on which the MDS resides.
-.TP
---mds <mds_name>
-Common name of the MDS.
-.TP
---mdsuuid <uuid>
-Specify MDS uuid.
-.TP
---dev <pathname>
-Path of device on local system. If the is a file, then a loop device is created and used as the block device.
-.TP
---backdev <pathname>
-Path of the device for backing storage on local system.
-.TP
---size <size>
-Optional argument indicating the size (in KB) of the device to be created (used typically for loop devices).
-.TP
---node <nodename>
-Adds an MDS to the specified node. This requires a --node argument, and it must not be a profile node.
-.TP
---fstype ldiskfs|ext3
-Optional argument used to specify the file system type. Default is ext3.
-For 2.6 kernels the ldiskfs filesystem must be used.
-.TP
---inode_size <size>
-Specify new inode size for underlying ext3 file system. Must be a power of 2
-between 128 and 4096. The default inode size is selected based on the default
-number of stripes specified for the filesystem.
-.TP
---group_upcall <pathname>
-The group upcall program to call for resolving a user's secondary groups.
-The default value is NONE, which means that the MDS will use whatever
-supplementary group is passed from the client. The supplied upcall is
-/usr/sbin/l_getgroups, which gets groups from the MDS's /etc/group file
-based on the client-supplied UID.
-.TP
---mkfsoptions <options>
-Optional argument to mkfs.
-.TP
---mountfsoptions <options>
-Optional argument to mount fs. Mount options will be passed by this argument. For example, extents are to be enabled by adding ",extents" to the --mountfsoptions option. "errors=remount-ro" and "asyncdel" can also be added to it.
-.TP
---journal_size <size>
-Optional arguement to specify the journal size for the ext3 file system. The size should be in the units expected by mkfs, so for ext3 it should be in MB. If this is option is not used, the ext3 filesystem will be configured with the default journal size.
-.PP
-.B --add lov
-Creates an LOV with the specified parameters. The mds_name must already exist in the descriptor.
-.TP
---lov <name>
-Common name for the LOV
-.TP
---mds <name>
-Common name for the MDS
-.TP
---stripe_sz <size>
-Specify the stripe size in bytes. This much data is written to each stripe before starting to write in the next stripe. Default is 1048576.
-.TP
---stripe_cnt <count>
-A value of 0 for this means to use the currently optimal number of stripes. Default is 1 stripe per file.
-.TP
---stripe_pattern <pattern>
-Only Pattern 0 (RAID 0) is supported currently.
-.PP
-.B --add ost
-Creates an OBD, OST, and OSC. The OST and OBD are created on the specified node.
-.TP
---ost <name>
-Assign a name to the OST device.
-.TP
---node <nodename>
-Node on which the OST service is run, can not be a profile node.
-.TP
---failout
-Disable failover support on OST.
-.TP
---failover
-Enable failover support on OST.
-.TP
---dev <pathname>
-Path of device on local system. If this is a file, then a loop device is created and used as the block device.
-.TP
---size [size]
-Optional argument indicating the size (in KB) of the device to be created (used typically for loop devices).
-.TP
---obdtype
-obdfilter|obdecho
-.TP
---lov <name>
-Optional arguement. Name of LOV to which this OSC will be attached.
-.TP
---ostuuid UUID
-Specify the UUID of the OST device.
-.TP
---fstype
-ldiskfs|ext3 Optional arguement used to specify the file system type. Default is ext3.
-.TP
---inode_size <size>
-Specify new inode size for underlying ext3 file system.
-.TP
---mkfsoptions <options>
-Optional argument to mkfs.
-.TP
---mountfsoptions <options>
-Optional argument to mount fs. Mount options will be passed by this argument. For example, extents are to be enabled by adding ",extents" to the --mountfsoptions option. "errors=remount-ro" and "asyncdel" can also be added to it.
-.TP
---journal_size <size>
-Optional arguement to specify the journal size for the ext3 file system. The size should be in the units expected by mkfs, so for ext3 it should be in MB. If this is option is not used, the ext3 filesystem will be configured with a journal size dependent upon how large the filesystem is.
-.PP
-.B --add mtpt
-Creates a mount-point on the specified node for the given LOV.
-.TP
---node node
-Node that will use the mtpt.
-.TP
---path /mnt/path
-The mount-point to use to mount Lustre filesystem
-.TP
---mds mds_name
-MDS name
-.TP
---ost ost_name | --lov lov_name
-OST or LOV name as specified earlier in the configuration
-.PP
-.B --add route
-Creates a static route through a gateway to a specific nid or a range of nid's.
-.TP
---node node
-Node to add the route to.
-.TP
---router
-Optional flag to mark a node as router.
-.TP
---gw nid
-The nid of the gateway (must be a local interface or a peer).
-.TP
---gateway_cluster_id id
-Specify the id of the cluster, to which the gateway belongs.
-.TP
---target_cluster_id id
-Specify the id of the cluster, to which the target of the route belongs.
-.TP
---lo nid
-For a range route, this is the lo value nid.
-.TP
---hi nid
-For a range route, this is the hi value nid.
-.PP
-.B --add echo-client
-Used for testing purpose only.
-.TP
---node node
-Name of the node that echo client should run on,
-.TP
---obd obd_name
-.SH OPTIONS
-One of the following options should be specified.
-.TP 12
---output filename
-Send output to the file. If the file exists, it will be overwritten.
-.TP
---merge filename
-Add the new element to an existing file.
-.TP
---reference
-Print short reference for commands.
-.TP
---verbose
-Print system commands as they are run.
-.TP
---batch filename
-Used to execute lmc commands in batch mode.
-.SH EXAMPLES
-.TP
-.B lmc --node adev3 --add net --nid adev3 --cluster_id 0x1000 --nettype tcp --hostaddr adev3-eth0 --port 988
-.TP
-.B lmc --node adev3 --add net --nid adev3 --cluster_id 0x2000 --nettype tcp --hostaddr adev3-eth1 --port 989
-Used to add a Lustre node to a specified Lustre cluster through a network interface. In this example, Lustre node adev3 has been added to 2 Lustre clusters whose cluster_id are 0x1000 and 0x2000 separately through 2 network interface cards: adev3-eth0 and adev3-eth1. adev3 would listen in some specified port(s) to prepare for possible connection requests from nodes in these two clusters.
-.TP
-.B lmc --node adev3 --add route --nettype tcp --gw 5 --gateway_cluster_id 0x1000 --target_cluster_id 0x1000 --lo 4 --hi 7
-Used to add a route entry for a Lustre node. Here Lustre node adev3 is told it has a new route entry that now it could send packets to Lustre nodes whose nids is from 4 to 7 with the help of Lustre gateway node whose nid is 5. Besides, Lustre gateway node is in cluster whose id is 0x1000 and target of the route belongs to cluster whose id is also 0x1000. The network in this route path is a tcp network.
-.SH BUGS
-None are known.
+++ /dev/null
-#LyX 1.3 created this file. For more info see http://www.lyx.org/
-\lyxformat 221
-\textclass amsart
-\language english
-\inputencoding auto
-\fontscheme times
-\graphics default
-\paperfontsize default
-\spacing single
-\papersize letterpaper
-\paperpackage a4
-\use_geometry 0
-\use_amsmath 0
-\use_natbib 0
-\use_numerical_citations 0
-\paperorientation portrait
-\secnumdepth 3
-\tocdepth 3
-\paragraph_separation skip
-\defskip medskip
-\quotes_language english
-\quotes_times 2
-\papercolumns 1
-\papersides 1
-\paperpagestyle default
-
-\layout Section
-
-lmc
-\layout Subsection
-
-NAME
-\layout Description
-
-lmc Lustre configuration maker.
-\layout Subsection
-
-SYNOPSIS
-\layout Standard
-
-
-\series bold
-lmc [options] --add <objectype> [args]
-\layout Standard
-
-
-\series bold
-lmc [options] --remove <objecttype> [args] -- [NOT IMPLEMENTED]
-\layout Standard
-
-
-\series bold
-lmc [options] --convert [args] -- [NOT IMPLEMENTED]
-\layout Subsection
-
-DESCRIPTION
-\layout Standard
-
-At present
-\series bold
-\emph on
-lmc
-\series default
-\emph default
-, when invoked, adds configuration data to the config file.
- In future,
-\series bold
-\emph on
-lmc
-\series default
-\emph default
- will also be able to remove configuration data or convert its format.
- A Lustre cluster consists of several components - MDS's, mount-points,
- OSTs, LOVs and whatever those reference (e.g nets and profiles).
- A single configuration file would be generated for the complete cluster.
- In the
-\series bold
-\emph on
-lmc
-\series default
-\emph default
- command line interface, each of these components is associated with an
-
-\emph on
-objecttype
-\emph default
-.
-
-\layout Standard
-
-The
-\emph on
-objecttype
-\emph default
- refers to a collection of related configuration entities and can be one
- of
-\series bold
-net
-\series default
-,
-\series bold
- MDS
-\series default
-,
-\series bold
- LOV
-\series default
-,
-\series bold
- OST
-\series default
-,
-\series bold
- mtpt
-\series default
-,
-\series bold
- route
-\series default
-,
-\series bold
- echo_client, or cobd.
-
-\series default
-We describe the arguments required for the addition of each
-\emph on
-objecttype
-\emph default
-.
-
-\layout Standard
-
-To generate configuration data associated with systems in a Lustre cluster:
-\layout Description
-
-
-\emph on
--
-\emph default
--add\SpecialChar ~
-node Adds a new node in the cluster configuration.
-
-\begin_deeper
-\layout Standard
-
-The arguments required are:
-\layout Description
-
---node\SpecialChar ~
-''node_name'' This will create a new node with the given name if not
- already present.
-\layout Description
-
---timeout\SpecialChar ~
-<num> Timeout before going into recovery
-\layout Description
-
---lustre_upcall\SpecialChar ~
-<path> Set the location of the Lustre upcall scripts used
- by the client for recovery
-\layout Description
-
---portals_upcall\SpecialChar ~
-<path> Specify the location of the Portals upcall scripts
- used by the client for recovery
-\layout Description
-
---upcall\SpecialChar ~
-<path> Specify the location of both (Lustre and Portals) upcall
- scripts used by the client for recovery
-\layout Description
-
---group_upcall\SpecialChar ~
-<path> Specify the location of the group upcall scripts used by the MDS
- for determiningsupplementary group membership
-\layout Description
-
---ptldebug\SpecialChar ~
-<debug_level> Set the portals debug level.
-\layout Description
-
---subsytem\SpecialChar ~
-<subsystem_name> Specify which Lustre subsystems have debug output
- recorded in the log.
-\end_deeper
-\layout Description
-
-
-\emph on
--
-\emph default
--add\SpecialChar ~
-net Adds a network device descriptor for the given node, with parameters
- as indicated.
-\begin_deeper
-\layout Standard
-
-The arguments required are:
-\layout Description
-
---node\SpecialChar ~
-''node_name'' 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 Description
-
---nettype\SpecialChar ~
-<type> Specify the network type.This can be
-\series bold
-tcp, elan, gm.
-\layout Description
-
---nid\SpecialChar ~
-nid The network
-\emph on
-id
-\emph default
-, e.g.
- ElanID or IP address as used by Portals.
- If
-\emph on
-nid
-\emph default
- is '*', then the local address of the interface with specified
-\series bold
-nettype
-\series default
-is will be substituted when the node is configured with lconf.
- An
-\emph on
-nid
-\emph default
- of
-\emph on
-'*'
-\emph default
- should be used only for the generic
-\emph on
-client
-\emph default
- configuration.
-\layout Description
-
---cluster_id\SpecialChar ~
-id Specify the cluster ID.
-\layout Description
-
---hostaddr\SpecialChar ~
-addr Specify the host address.
- lconf will transfer it to the real host address.
-\layout Description
-
---router Optional flag to mark this node as a router
-\layout Description
-
---port\SpecialChar ~
-[port] Optional arguement to indicate the tcp port.
- The default is 988.
-
-\layout Description
-
---tcpbuf\SpecialChar ~
-<size> Optional arguement.
- The default TCP buffer size is 1MB.
-\layout Description
-
---irq_affinity\SpecialChar ~
-0|1 Optional arguement.
- Default is 0.
-\layout Description
-
---nid_exchange\SpecialChar ~
-0|1 Optional arguement since some OSTs might not have the
- required support.
- This is turned off by default, value of 1 will turn it ON.
-
-\end_deeper
-\layout Description
-
---add\SpecialChar ~
-mds
-\begin_deeper
-\layout Description
-
---node\SpecialChar ~
-<node\SpecialChar ~
-name> Name of the node on which the MDS resides
-\layout Description
-
---mds\SpecialChar ~
-<mds_name> Specify MDS name.
-\layout Description
-
---mdsuuid\SpecialChar ~
-<uuid> Specify MDS uuid.
-\layout Description
-
---failover Enable failover support on MDS.
-\layout Description
-
---dev\SpecialChar ~
-<pathname> 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
-
---size\SpecialChar ~
-<size> Optional argument indicating the size (in KB) of the device
- to be created (used typically for loop devices).
-\layout Description
-
---node\SpecialChar ~
-<nodename> Adds an MDS to the specified node.
- This requires a
-\emph on
---node
-\emph default
- argument, and it must not be a profile node.
-\layout Description
-
---fstype\SpecialChar ~
-ldiskfs|ext3 Optional argument used to specify the file system type.
- Default is ext3. For 2.6 kernels the ldiskfs filesystem must be used.
-\layout Description
-
---inode_size\SpecialChar ~
-<size> Specify new inode size for underlying ext3 file system. Must be a
- power of 2 between 128 and 4096. The default inode size is selected based
- on the default number of stripes specified for the filesystem.
-\layout Description
-
---group_upcall\SpecialChar ~
-<pathname> The group upcall program to call for resolving a user's secondary
- groups. The default value is NONE, which means that the MDS will use whatever
- supplementary group is passed from the client. The supplied upcall is
- /usr/sbin/l_getgroups, which gets groups from the MDS's /etc/group file
- based on the client-supplied UID.
-
---mkfsoptions\SpecialChar ~
-<options> Optional argument to mkfs.
-\layout Description
-
---mountfsoptions\SpecialChar ~
-<options> Optional argument to mount fs.
- Mount options will be passed by this argument.
- For example, extents are to be enabled by adding ",extents" to the --mountfsopt
-ions option.
-
-\begin_inset Quotes eld
-\end_inset
-
-errors=remount-ro
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-asyncdel
-\begin_inset Quotes erd
-\end_inset
-
- can also be added to it.
-\layout Description
-
---journal_size\SpecialChar ~
-<size> Optional arguement to specify the journal size for
- the ext3 file system.
- The size should be in the units expected by
-\series bold
-mkfs
-\series default
-, so for ext3 it should be in MB.
- If this is option is not used, the ext3 filesystem will be configured
- with a journal size dependent upon how large the filesystem is.
-\end_deeper
-\layout Description
-
---add\SpecialChar ~
-lov Creates an LOV with the specified parameters.
- The
-\emph on
-mds_name
-\emph default
- must already exist in the descriptor.
-\begin_deeper
-\layout Description
-
---lov\SpecialChar ~
-<name> Specify LOV name.
-\layout Description
-
---mds\SpecialChar ~
-<name> Specify the mds name.
-\layout Description
-
---stripe_sz\SpecialChar ~
-<size> Specify the stripe size in bytes. This much data is written to each
- stripe before starting to write in the next stripe. Default is 1048576.
-\layout Description
-
---stripe_cnt\SpecialChar ~
-<count> A value of 0 for this means to use the currently optimal number
- of stripes. Default is 1 stripe per file.
-\layout Description
-
---stripe_pattern\SpecialChar ~
-<pattern> Only Pattern 0 (RAID 0) is supported currently.
-\end_deeper
-\layout Description
-
---add\SpecialChar ~
-ost Creates an OBD, OST, and OSC.
- The OST and OBD are created on the specified node.
-\begin_deeper
-\layout Description
-
---ost\SpecialChar ~
-<name> Assign a name to the OST device.
-\layout Description
-
---node\SpecialChar ~
-<nodename> Node on which the OST service is run, can not be a profile
- node.
-\layout Description
-
---failover Enable failover support on OST.
-\layout Description
-
---dev\SpecialChar ~
-<pathname> Path of device on local system.
- If this is a file, then a loop device is created and used as the block
- device.
-\layout Description
-
---size\SpecialChar ~
-[size] Optional argument indicating the size (in KB) of the device
- to be created (used typically for loop devices).
-\layout Description
-
---osdtype\SpecialChar ~
-obdfilter|obdecho Specify the type of OSD.
-\layout Description
-
---lov\SpecialChar ~
-<name> Optional arguement.
- Name of LOV to which this OSC will be attached.
-
-\layout Description
-
---ostuuid\SpecialChar ~
-UUID Specify the UUID of the OST device.
-
-\layout Description
-
---fstype\SpecialChar ~
-ldiskfs|ext3 Optional arguement used to specify the file system type.
- Default is ext3.
-\layout Description
-
---inode_size\SpecialChar ~
-<size> Specify new inode size for underlying ext3 file system.
-\layout Description
-
---mkfsoptions\SpecialChar ~
-<options> Optional argument to mkfs.
-\layout Description
-
---mountfsoptions\SpecialChar ~
-<options> Optional argument to mount fs.
- Mount options will be passed by this argument.
- For example, extents are to be enabled by adding ",extents" to the --mountfsopt
-ions option.
-
-\begin_inset Quotes eld
-\end_inset
-
-errors=remount-ro
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-asyncdel
-\begin_inset Quotes erd
-\end_inset
-
- can also be added to it.
-\layout Description
-
---journal_size\SpecialChar ~
-<size> Optional arguement to specify the journal size for
- the ext3 file system.
- The size should be in the units expected by
-\series bold
-mkfs
-\series default
-, so for ext3 it should be in MB.
- If this is option is not used, the ext3 filesystem will be configured
- with a journal size dependent upon how large the filesystem is.
-\end_deeper
-\layout Description
-
---add\SpecialChar ~
-mtpt Creates a mount-point on the specified node for the given LOV.
-\begin_deeper
-\layout Description
-
---node\SpecialChar ~
-node Node or profile node that will use the
-\emph on
-mtpt
-\emph default
-.
-\layout Description
-
---path\SpecialChar ~
-/mnt/path Specify the mountpoint for Lustre.
-\layout Description
-
---mds\SpecialChar ~
-mds_name Specify the mds name, which will provide service for this
- client.
-\layout Description
-
---ost\SpecialChar ~
-ost_name\SpecialChar ~
-|\SpecialChar ~
---lov\SpecialChar ~
-lov_name Specify the ost or lov, which will provide service
- for this client.
-\layout Description
-
---clientoptions Specify the options for Lustre, such as async.
-\end_deeper
-\layout Description
-
---add\SpecialChar ~
-route 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
-
---node\SpecialChar ~
-node Node to add the route to.
-\layout Description
-
---router Optional flag to mark a node as router.
-\layout Description
-
---gw\SpecialChar ~
-nid The
-\emph on
-nid
-\emph default
- of the gateway (must be a local interface or a peer).
-\layout Description
-
---gateway_cluster_id\SpecialChar ~
-id Specify the id of the cluster, to which the gateway
- belongs.
-\layout Description
-
---target_cluster_id\SpecialChar ~
-id Specify the id of the cluster, to which the target
- of the route belongs.
-\layout Description
-
---lo\SpecialChar ~
-nid For a range route, this is the lo value
-\emph on
-nid.
-\layout Description
-
---hi\SpecialChar ~
-nid For a range route, this is the hi value
-\emph on
-nid.
-\end_deeper
-\layout Description
-
---add\SpecialChar ~
-echo-client Used for testing purpose only.
-
-\begin_deeper
-\layout Description
-
---node\SpecialChar ~
-nodename
-\emph on
-
-\emph default
-Node on which the echo-client resides.
-\end_deeper
-\layout Description
-
-\end_deeper
-\layout List
-\labelwidthstring 00.00.0000
-
-
-\series bold
-Options
-\layout Description
-
---reference Print short reference for commands.
-\layout Description
-
---verbose Print system commands as they are run.
-\layout Description
-
---batch\SpecialChar ~
-filename Used to execute lmc commands in batch mode.
-\layout Description
-
---output\SpecialChar ~
-filename Send output to the file.
- If the file exists, it will be overwritten.
-\layout Description
-
---merge\SpecialChar ~
-filename
-\emph on
-
-\emph default
-Add the new element to an existing file.
-
-\layout Subsection
-
-EXAMPLES
-\layout Subsubsection
-
---add net
-\layout Standard
-
-
-\series bold
-lmc --node adev3 --add net --nid adev3 --cluster_id 0x1000 --nettype tcp
- --hostaddr adev3-eth0 --port 988
-\layout Standard
-
-
-\series bold
-lmc --node adev3 --add net --nid adev3 --cluster_id 0x2000 --nettype tcp
- --hostaddr adev3-eth1 --port 989
-\series default
-\emph on
-
-\layout Standard
-
-Used to add a Lustre node to a specified Lustre cluster through a network
- interface.
- In this example, Lustre node adev3 has been added to 2 Lustre clusters
- whose cluster_id are 0x1000 and 0x2000 separately through 2 network interface
- cards: adev3-eth0 and adev3-eth1.
- adev3 would listen in some specified port(s) to prepare for possible connection
- requests from nodes in these two clusters.
-\layout Subsubsection
-
---add route
-\layout Standard
-
-
-\series bold
-lmc --node adev3 --add route --nettype tcp --gw 5 --gateway_cluster_id 0x1000
- --target_cluster_id 0x1000 --lo 4 --hi 7
-\layout Standard
-
-Used to add a route entry for a Lustre node.
- Here Lustre node adev3 is told it has a new route entry that now it could
- send packets to Lustre nodes whose nids is from 4 to 7 with the help of
- Lustre gateway node whose nid is 5.
- Besides, Lustre gateway node is in cluster whose id is 0x1000 and target
- of the route belongs to cluster whose id is also 0x1000.
- The network in this route path is a tcp network.
-\layout Subsection
-
-BUGS
-\layout Standard
-
-None are known.
-\the_end
git://git.whamcloud.com / fs / lustre-release.git / commitdiff