Whamcloud - gitweb
land v0.9.1 on HEAD, in preparation for a 1.0.x branch
[fs/lustre-release.git] / lustre / doc / lmc.1
1 .TH lmc 1 "2003 Oct 8" Lustre "configuration utilities"
2 .SH NAME
3 lmc \- Lustre configuration maker
4 .SH SYNOPSIS
5 .br
6 .B lmc
7 [options] --add <objecttype> [args]
8 .br
9 .SH DESCRIPTION
10 .B lmc 
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.
15 .PP
16 The objecttype refers to a collection of related configuration entities and can be one of 
17 .B net
18 ,
19 .B MDS
20 ,
21 .B LOV
22 ,
23 .B OST
24 ,
25 .B mtpt
26 ,
27 .B route
28 or
29 .B echo-client.
30 .PP
31 We describe the arguments required for the addition of each objecttype. 
32 .PP
33 To generate configuration data associated with systems in a Lustre cluster:
34 .PP
35 .B --add node 
36 Adds a new node in the cluster configuration.
37 The arguements required are:
38 .TP 
39 --node <node_name>
40 This will create a new node with the given name if not already present.
41 .TP
42 --timeout <num>
43 Timeout before going into recovery
44 .TP
45 --lustre_upcall <path> 
46 Set the location of the Lustre upcall scripts used by the client for recovery
47 .TP
48 --portals_upcall <path> 
49 Specify the location of the Portals upcall scripts used by the client for recovery
50 .TP
51 --upcall <path> 
52 Specify the location of both (Lustre and Portals) upcall scripts used by the client for recovery
53 .PP
54 .B --add net 
55 Adds a network device descriptor for the given node, with parameters as indicated.
56 The arguments required are:
57 .TP 12
58 --node <node_name>
59 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.
60 .TP
61 --nettype <type> 
62 This can be tcp, elan, gm, scimac.
63 .TP
64 --nid nid 
65 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.
66 .TP
67 --hostaddr addr
68 .TP
69 --router 
70 Optional flag to mark this node as a router
71 .TP
72 --port [port] 
73 Optional arguement to indicate the tcp port. The default is 988. 
74 .TP
75 --tcpbuf <size> 
76 Optional arguement. The default TCP buffer size is 1MB.
77 .TP
78 --irq_affinity 0|1 
79 Optional arguement. Default is 0.
80 .TP
81 --nid_exchange 0|1 
82 Optional arguement since some OSTs might not have the required support. This is turned off by default, value of 1 will turn it ON. 
83 .PP
84 .B --add mds
85 Specify the MDS configuration
86 .TP
87 --node <node name> 
88 Name of the node on which the MDS resides
89 .TP
90 --mds <mds_name> 
91 Common name of the MDS
92 .TP 
93 --dev <pathname> 
94 Path of device on local system. If the is a file, then a loop device is created and used as the block device.
95 .TP
96 --size <size> 
97 Optional argument indicating the size (in KB) of the device to be created (used typically for loop devices).
98 .TP
99 --node <nodename> 
100 Adds an MDS to the specified node. This requires a --node argument, and it must not be a profile node.
101 .TP
102 --fstype extN|ext3 
103 Optional argument used to specify the file system type. Default is ext3.
104 .TP
105 --journal_size <size> 
106 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.
107 .PP
108 .B --add lov 
109 Creates an LOV with the specified parameters. The mds_name must already exist in the descriptor.
110 .TP
111 --lov <name>
112 Common name for the LOV
113 .TP
114 --mds <name>
115 Common name for the MDS
116 .TP
117 --stripe_sz <size>
118 Stripe size
119 .TP
120 --stripe_cnt <count> 
121 A value of 0 for this means to stripe on all available OSTs. Default is 0.
122 .TP
123 --stripe_pattern <pattern> 
124 Only Pattern 0 (RAID 0) is supported currently.
125 .PP
126 .B --add ost 
127 Creates an OBD, OST, and OSC. The OST and OBD are created on the specified node.
128 .TP
129 --ost <name> 
130 Assign a name to the OST device.
131 .TP
132 --node <nodename> 
133 Node on which the OST service is run, can not be a profile node.
134 .TP
135 --dev <pathname> 
136 Path of device on local system. If this is a file, then a loop device is created and used as the block device.
137 .TP
138 --size [size] 
139 Optional argument indicating the size (in KB) of the device to be created (used typically for loop devices).
140 .TP
141 --obdtype 
142 obdfilter|obdecho 
143 .TP
144 --lov <name> 
145 Optional arguement. Name of LOV to which this OSC will be attached. 
146 .TP
147 --ostuuid UUID 
148 Specify the UUID of the OST device. 
149 .TP
150 --fstype 
151 extN|ext3 Optional arguement used to specify the file system type. Default is ext3.
152 .TP
153 --journal_size <size> 
154 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.
155 .PP
156 .B --add mtpt 
157 Creates a mount-point on the specified node. Either an LOV or OSC name can be used.
158 .TP
159 --node node 
160 Node that will use the mtpt.
161 .TP
162 --path /mnt/path 
163 The mount-point to use to mount Lustre filesystem
164 .TP
165 --mds mds_name 
166 MDS name
167 .TP
168 --ost ost_name | --lov lov_name
169 OST or LOV name as specified earlier in the configuration
170 .PP
171 .B --add route 
172 Creates a static route through a gateway to a specific nid or a range of nid's.
173 .TP
174 --node node 
175 Node to add the route to.
176 .TP
177 --gw nid 
178 The nid of the gateway (must be a local interface or a peer).
179 .TP
180 --tgt nid 
181 For a specific route, this is the target nid.
182 .TP
183 --lo nid 
184 For a range route, this is the lo value nid.
185 .TP
186 --hi nid 
187 For a range route, this is the hi value nid.
188 .PP
189 .B --add echo-client 
190 Used for testing purpose only. 
191 .TP
192 --node node 
193 Name of the node that echo client should run on,
194 .TP
195 --obd obd_name 
196 .SH OPTIONS
197 One of the following options should be specified.
198 .TP 12
199 --output filename 
200 Send output to the file. If the file exists, it will be overwritten.
201 .TP
202 --merge filename 
203 Add the new element to an existing file. 
204 .SH EXAMPLES
205 Real life examples are given in the Lustre-conf manual page.
206 .SH BUGS
207 None are known.