Whamcloud - gitweb
Added the remaining new lmc options and also corrected all the examples in lustre...
[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 lconf\SpecialChar ~
44 [--node <node_name>] [-d,--cleanup] [--noexec] [--gdb] [--nosetup]
45  [--nomod] [-n,--noexec] [-v,--verbose] [-h,--help] <XML-config file>
46 \layout Subsection
47
48 DESCRIPTION
49 \layout Standard
50
51 This program configures a node following directives in the <XML-config-file>.
52 \layout Description
53
54 --node\SpecialChar ~
55 node_name Specify a specific node to configure.
56  By default, lconf will search for nodes with the local hostname and 'localhost'.
57  When
58 \emph on 
59  --node
60 \emph default 
61  is used, only 
62 \emph on 
63 node_name
64 \emph default 
65  is searched for.
66  If a matching node is not found in the config, then lconf exits with an
67  error.
68 \layout Description
69
70 --cleanup Unconfigure a node.
71  The same config and 
72 \emph on 
73 --node
74 \emph default 
75  argument used for configuration needs to be used for cleanup as well.
76  This will attempt to undo all of the configuration steps done by lconf,
77  including unloading the kernel modules.
78 \layout Description
79
80 --noexec Print, but don't execute, the steps lconf will perform.
81  This is useful for debugging a configuration, and when used with 
82 \emph on 
83 --node
84 \emph default 
85 , can be run on any host.
86 \layout Description
87
88 --gdb Causes lconf to print a message and pause for 5 seconds after creating
89  a gdb module script and before doing any Lustre configuration (the gdb
90  module script is always created, however).
91 \layout Description
92
93 --nosetup Only load modules, do not configure devices or services.
94 \layout Description
95
96 --nomod Only setup devices and services, do not load modules.
97 \layout Description
98
99 --noexec,-n Don't do anything, but print what would happen.
100 \layout Description
101
102 --verbose,-v Be verbose and show actions while going along.
103 \layout Description
104
105 --reformat Reformat all the devices
106 \layout Description
107
108 -h,--help Print help.
109 \layout Description
110
111 --maxlevel\SpecialChar ~
112 <level> [NOT IMPLEMENTED] Perform configuration of devices and
113  services up to level given.
114  
115 \emph on 
116 level
117 \emph default 
118  can take the values 
119 \series bold 
120 net, dev, svc, fs.
121  
122 \series default 
123 When used in conjunction with cleanup, services are torn down up to a certain
124  level.
125 \layout Subsection
126
127 EXAMPLES
128 \layout Standard
129
130 On client nodes this is typically invoked as: 
131 \layout LyX-Code
132
133
134 \size small 
135 lconf --node client config.xml
136 \layout Standard
137
138 in order to give clients, regardless of hostname, a single configuration.
139 \layout Subsection
140
141 BUGS
142 \layout Standard
143
144 None are known.
145 \the_end