Whamcloud - gitweb
Some formatting changes were made to these files by doug.
[fs/lustre-release.git] / lustre / doc / lconf.lyx
1 #LyX 1.2 created this file. For more info see http://www.lyx.org/
2 \lyxformat 220
3 \textclass amsart
4 \language english
5 \inputencoding auto
6 \fontscheme times
7 \graphics default
8 \paperfontsize default
9 \spacing single 
10 \papersize letterpaper
11 \paperpackage a4
12 \use_geometry 0
13 \use_amsmath 0
14 \use_natbib 0
15 \use_numerical_citations 0
16 \paperorientation portrait
17 \secnumdepth 3
18 \tocdepth 3
19 \paragraph_separation skip
20 \defskip medskip
21 \quotes_language english
22 \quotes_times 2
23 \papercolumns 1
24 \papersides 1
25 \paperpagestyle default
26
27 \layout Section
28
29 lconf
30 \layout Subsection
31
32 NAME
33 \layout Description
34
35 lconf Lustre filesystem configuration utility.
36 \layout Subsection
37
38 SYNOPSIS
39 \layout Standard
40
41
42 \series bold 
43 \emph on 
44 lconf\SpecialChar ~
45 [--node <node_name>] [-d,--cleanup] [--noexec] [--gdb] [--nosetup]
46  [--nomod] [-n,--noexec] [-v,--verbose] [-h,--help] <XML-config file>
47 \layout Subsection
48
49 DESCRIPTION
50 \layout Standard
51
52 This program configures a node following directives in the <XML-config-file>.
53 \layout List
54 \labelwidthstring 00.00.0000
55
56
57 \series bold 
58 \emph on 
59 --node\SpecialChar ~
60 node_name
61 \series default 
62 \emph default 
63  Specify a specific node to configure.
64  By default, lconf will search for nodes with the local hostname and 'localhost'.
65  When
66 \emph on 
67  --node
68 \emph default 
69  is used, only 
70 \emph on 
71 node_name
72 \emph default 
73  is searched for.
74  If a matching node is not found in the config, then lconf exits with an
75  error.
76 \layout List
77 \labelwidthstring 00.00.0000
78
79
80 \series bold 
81 \emph on 
82 --cleanup
83 \series default 
84 \emph default 
85  Unconfigure a node.
86  The same config and 
87 \emph on 
88 --node
89 \emph default 
90  argument used for configuration needs to be used for cleanup as well.
91  This will attempt to undo all of the configuration steps done by lconf,
92  including unloading the kernel modules.
93 \layout List
94 \labelwidthstring 00.00.0000
95
96
97 \series bold 
98 \emph on 
99 --noexec
100 \series default 
101 \emph default 
102  Print, but don't execute, the steps lconf will perform.
103  This is useful for debugging a configuration, and when used with 
104 \emph on 
105 --node
106 \emph default 
107 , can be run on any host.
108 \layout List
109 \labelwidthstring 00.00.0000
110
111
112 \series bold 
113 \emph on 
114 --gdb
115 \series default 
116 \emph default 
117  Causes lconf to print a message and pause for 5 seconds after creating
118  a gdb module script and before doing any Lustre configuration (the gdb
119  module script is always created, however).
120 \layout List
121 \labelwidthstring 00.00.0000
122
123
124 \series bold 
125 \emph on 
126 --nosetup
127 \series default 
128 \emph default 
129  Only load modules, do not configure devices or services.
130 \layout List
131 \labelwidthstring 00.00.0000
132
133
134 \series bold 
135 \emph on 
136 --nomod
137 \series default 
138 \emph default 
139  Only setup devices and services, do not load modules.
140 \layout List
141 \labelwidthstring 00.00.0000
142
143
144 \series bold 
145 \emph on 
146 --noexec,-n
147 \emph default 
148  
149 \series default 
150 Don't do anything, but print what would happen.
151 \layout List
152 \labelwidthstring 00.00.0000
153
154
155 \series bold 
156 \emph on 
157 --verbose,-v
158 \series default 
159 \emph default 
160  Be verbose and show actions while going along.
161 \layout List
162 \labelwidthstring 00.00.0000
163
164
165 \series bold 
166 \emph on 
167 -h,--help
168 \series default 
169 \emph default 
170  Print help.
171 \layout List
172 \labelwidthstring 00.00.0000
173
174
175 \series bold 
176 \emph on 
177 --maxlevel\SpecialChar ~
178 <level>
179 \series default 
180 \emph default 
181  [NOT IMPLEMENTED] Perform configuration of devices and services up to level
182  given.
183  
184 \emph on 
185 level
186 \emph default 
187  can take the values 
188 \series bold 
189 net, dev, svc, fs.
190  
191 \series default 
192 When used in conjunction with cleanup, services are torn down up to a certain
193  level.
194 \layout Subsection
195
196 EXAMPLES
197 \layout Standard
198
199 On client nodes this is typically invoked as: 
200 \layout LyX-Code
201
202
203 \size small 
204 lconf --node client config.xml
205 \layout Standard
206
207 in order to give clients, regardless of hostname, a single configuration.
208 \layout Subsection
209
210 BUGS
211 \layout Standard
212
213 None are known.
214 \the_end