1 .TH lmc 1 "2004 Sep 16" Lustre "configuration utilities"
3 lmc \- Lustre configuration maker
7 [options] --add <objecttype> [args]
11 , when invoked, adds configuration data to a configuration file. In future,
12 lmc will also be able to remove configuration data or convert its format.
13 A Lustre cluster consists of several components - MDSs, client mount-points,
14 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.
16 The objecttype refers to a collection of related configuration entities and can be one of
31 We describe the arguments required for the addition of each objecttype.
33 To generate configuration data associated with systems in a Lustre cluster:
36 Adds a new node in the cluster configuration.
37 The arguements required are:
40 This will create a new node with the given name if not already present.
43 Timeout before going into recovery.
45 --lustre_upcall <path>
46 Set the location of the Lustre upcall scripts used by the client for recovery.
48 --portals_upcall <path>
49 Specify the location of the Portals upcall scripts used by the client for recovery.
52 Specify the location of both (Lustre and Portals) upcall scripts used by the client for recovery.
54 --ptldebug <debug_level>
55 Set the portals debug level.
57 --subsystem <subsystem_name>
58 Specify which Lustre subsystems have debug output recorded in the log.
61 Adds a network device descriptor for the given node, with parameters as indicated.
62 The arguments required are:
65 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.
68 This can be tcp, elan, or gm.
71 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.
74 Specify the cluster ID.
77 Specify the host address, which will be transfered to the real host address by lconf.
80 Optional flag to mark this node as a router.
83 Optional arguement to indicate the tcp port. The default is 988.
86 Optional arguement. The default TCP buffer size is 1MB.
89 Optional arguement. Default is 0.
92 Optional arguement since some OSTs might not have the required support. This is turned off by default, value of 1 will turn it ON.
95 Specify the MDS configuration:
98 Name of the node on which the MDS resides.
101 Common name of the MDS.
107 Enable failover support on MDS.
110 Path of device on local system. If the is a file, then a loop device is created and used as the block device.
113 Path of the device for backing storage on local system.
116 Optional argument indicating the size (in KB) of the device to be created (used typically for loop devices).
119 Adds an MDS to the specified node. This requires a --node argument, and it must not be a profile node.
122 Optional argument used to specify the file system type. Default is ext3.
124 --backfstype ext3|tmpfs
125 Specify the backing filesystem type.
128 Local mount point of server namespace.
131 Specify new inode size for underlying ext3 file system.
133 --mkfsoptions <options>
134 Optional argument to mkfs.
136 --mountfsoptions <options>
137 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.
139 --journal_size <size>
140 Optional arguement to specify the journal size for the ext2/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 ext2/ext3 filesystem will be configured with the default journal size.
143 Creates an LOV with the specified parameters. The mds_name must already exist in the descriptor.
146 Common name for the LOV
149 Common name for the MDS
155 A value of 0 for this means to stripe on all available OSTs. Default is 0.
157 --stripe_pattern <pattern>
158 Only Pattern 0 (RAID 0) is supported currently.
161 Creates an OBD, OST, and OSC. The OST and OBD are created on the specified node.
164 Assign a name to the OST device.
167 Node on which the OST service is run, can not be a profile node.
170 Enable failover support on OST.
173 Path of device on local system. If this is a file, then a loop device is created and used as the block device.
176 Path of the device for backing storage on local system.
179 Optional argument indicating the size (in KB) of the device to be created (used typically for loop devices).
185 Optional arguement. Name of LOV to which this OSC will be attached.
188 Specify the UUID of the OST device.
191 extN|ext3 Optional arguement used to specify the file system type. Default is ext3.
193 --backfstype ext3|tmpfs
194 Optional argument to specify the backing filesystem type.
197 Specify new inode size for underlying ext3 file system.
200 Local mount point of server namespace.
202 --mkfsoptions <options>
203 Optional argument to mkfs.
205 --mountfsoptions <options>
206 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.
208 --journal_size <size>
209 Optional arguement to specify the journal size for the ext2/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 ext2/ext3 filesystem will be configured with the default journal size.
212 Creates a mount-point on the specified node. Either an LOV or OSC name can be used.
215 Node that will use the mtpt.
218 The mount-point to use to mount Lustre filesystem
223 --ost ost_name | --lov lov_name
224 OST or LOV name as specified earlier in the configuration
226 --clientoptions options
227 Specify the options for Lustre, such as async.
230 Creates a static route through a gateway to a specific nid or a range of nid's.
233 Node to add the route to.
236 Optional flag to mark a node as router.
239 The nid of the gateway (must be a local interface or a peer).
241 --gateway_cluster_id id
242 Specify the id of the cluster, to which the gateway belongs.
244 --target_cluster_id id
245 Specify the id of the cluster, to which the target of the route belongs.
248 For a range route, this is the lo value nid.
251 For a range route, this is the hi value nid.
254 Used for testing purpose only.
257 Name of the node that echo client should run on,
262 Management/monitoring service.
265 Node on which the mgmt service resides.
267 --mgmt <mgmt_service_name>
268 Specify management/monitoring service name.
271 Create the cobd on the specified node.
274 Node on which the cobd resides.
277 Specify the cache device for the cache obd system.
280 Specify the real device for the cache obd system.
282 One of the following options should be specified.
285 Send output to the file. If the file exists, it will be overwritten.
288 Add the new element to an existing file.
291 Print short reference for commands.
294 Print system commands as they are run.
297 Used to execute lmc commands in batch mode.
300 .B lmc --node adev3 --add net --nid adev3 --cluster_id 0x1000 --nettype tcp --hostaddr adev3-eth0 --port 988
302 .B lmc --node adev3 --add net --nid adev3 --cluster_id 0x2000 --nettype tcp --hostaddr adev3-eth1 --port 989
303 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.
305 .B lmc --node adev3 --add route --nettype tcp --gw 5 --gateway_cluster_id 0x1000 --target_cluster_id 0x1000 --lo 4 --hi 7
306 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.