root / man / gnt-node.sgml @ 9b94905f
History | View | Annotate | Download (31.3 kB)
1 | a8083063 | Iustin Pop | <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ |
---|---|---|---|
2 | a8083063 | Iustin Pop | |
3 | a8083063 | Iustin Pop | <!-- Fill in your name for FIRSTNAME and SURNAME. --> |
4 | a8083063 | Iustin Pop | <!-- Please adjust the date whenever revising the manpage. --> |
5 | d3b4cf9f | Iustin Pop | <!ENTITY dhdate "<date>February 12, 2009</date>"> |
6 | a8083063 | Iustin Pop | <!-- SECTION should be 1-8, maybe w/ subsection other parameters are |
7 | a8083063 | Iustin Pop | allowed: see man(7), man(1). --> |
8 | a8083063 | Iustin Pop | <!ENTITY dhsection "<manvolnum>8</manvolnum>"> |
9 | a8083063 | Iustin Pop | <!ENTITY dhucpackage "<refentrytitle>gnt-node</refentrytitle>"> |
10 | a8083063 | Iustin Pop | <!ENTITY dhpackage "gnt-node"> |
11 | a8083063 | Iustin Pop | |
12 | a8083063 | Iustin Pop | <!ENTITY debian "<productname>Debian</productname>"> |
13 | a8083063 | Iustin Pop | <!ENTITY gnu "<acronym>GNU</acronym>"> |
14 | a8083063 | Iustin Pop | <!ENTITY gpl "&gnu; <acronym>GPL</acronym>"> |
15 | a8083063 | Iustin Pop | <!ENTITY footer SYSTEM "footer.sgml"> |
16 | a8083063 | Iustin Pop | ]> |
17 | a8083063 | Iustin Pop | |
18 | a8083063 | Iustin Pop | <refentry> |
19 | a8083063 | Iustin Pop | <refentryinfo> |
20 | a8083063 | Iustin Pop | <copyright> |
21 | a8083063 | Iustin Pop | <year>2006</year> |
22 | a8083063 | Iustin Pop | <year>2007</year> |
23 | e7c6e02b | Michael Hanselmann | <year>2008</year> |
24 | d3b4cf9f | Iustin Pop | <year>2009</year> |
25 | a8083063 | Iustin Pop | <holder>Google Inc.</holder> |
26 | a8083063 | Iustin Pop | </copyright> |
27 | a8083063 | Iustin Pop | &dhdate; |
28 | a8083063 | Iustin Pop | </refentryinfo> |
29 | a8083063 | Iustin Pop | <refmeta> |
30 | a8083063 | Iustin Pop | &dhucpackage; |
31 | a8083063 | Iustin Pop | |
32 | a8083063 | Iustin Pop | &dhsection; |
33 | d3b4cf9f | Iustin Pop | <refmiscinfo>ganeti 2.0</refmiscinfo> |
34 | a8083063 | Iustin Pop | </refmeta> |
35 | a8083063 | Iustin Pop | <refnamediv> |
36 | a8083063 | Iustin Pop | <refname>&dhpackage;</refname> |
37 | a8083063 | Iustin Pop | |
38 | a8083063 | Iustin Pop | <refpurpose>node administration</refpurpose> |
39 | a8083063 | Iustin Pop | </refnamediv> |
40 | a8083063 | Iustin Pop | <refsynopsisdiv> |
41 | a8083063 | Iustin Pop | <cmdsynopsis> |
42 | a8083063 | Iustin Pop | <command>&dhpackage; </command> |
43 | a8083063 | Iustin Pop | |
44 | a8083063 | Iustin Pop | <arg choice="req">command</arg> |
45 | a8083063 | Iustin Pop | <arg>arguments...</arg> |
46 | a8083063 | Iustin Pop | </cmdsynopsis> |
47 | a8083063 | Iustin Pop | </refsynopsisdiv> |
48 | a8083063 | Iustin Pop | <refsect1> |
49 | a8083063 | Iustin Pop | <title>DESCRIPTION</title> |
50 | a8083063 | Iustin Pop | |
51 | a8083063 | Iustin Pop | <para> |
52 | a8083063 | Iustin Pop | The <command>&dhpackage;</command> is used for managing the |
53 | a8083063 | Iustin Pop | (physical) nodes in the ganeti system. |
54 | a8083063 | Iustin Pop | </para> |
55 | a8083063 | Iustin Pop | |
56 | a8083063 | Iustin Pop | </refsect1> |
57 | a8083063 | Iustin Pop | <refsect1> |
58 | a8083063 | Iustin Pop | <title>COMMANDS</title> |
59 | a8083063 | Iustin Pop | |
60 | a8083063 | Iustin Pop | <refsect2> |
61 | a8083063 | Iustin Pop | <title>ADD</title> |
62 | a8083063 | Iustin Pop | |
63 | a8083063 | Iustin Pop | <cmdsynopsis> |
64 | a8083063 | Iustin Pop | <command>add</command> |
65 | e7c6e02b | Michael Hanselmann | <arg>--readd</arg> |
66 | a8083063 | Iustin Pop | <arg>-s <replaceable>secondary_ip</replaceable></arg> |
67 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>nodename</replaceable></arg> |
68 | a8083063 | Iustin Pop | </cmdsynopsis> |
69 | a8083063 | Iustin Pop | |
70 | a8083063 | Iustin Pop | <para> |
71 | a8083063 | Iustin Pop | Adds the given node to the cluster. |
72 | a8083063 | Iustin Pop | </para> |
73 | a8083063 | Iustin Pop | |
74 | a8083063 | Iustin Pop | <para> |
75 | a8083063 | Iustin Pop | This command is used to join a new node to the cluster. You |
76 | a8083063 | Iustin Pop | will have to provide the password for root of the node to be |
77 | a8083063 | Iustin Pop | able to add the node in the cluster. The command needs to be |
78 | a8083063 | Iustin Pop | run on the ganeti master. |
79 | a8083063 | Iustin Pop | </para> |
80 | a8083063 | Iustin Pop | |
81 | a8083063 | Iustin Pop | <para> |
82 | a8083063 | Iustin Pop | Note that the command is potentially destructive, as it will |
83 | a8083063 | Iustin Pop | forcibly join the specified host the cluster, not paying |
84 | a8083063 | Iustin Pop | attention to its current status (it could be already in a |
85 | a8083063 | Iustin Pop | cluster, etc.) |
86 | a8083063 | Iustin Pop | </para> |
87 | a8083063 | Iustin Pop | |
88 | a8083063 | Iustin Pop | <para> |
89 | a8083063 | Iustin Pop | The <option>-s</option> is used in dual-home clusters and |
90 | a8083063 | Iustin Pop | specifies the new node's IP in the secondary network. See the |
91 | a8083063 | Iustin Pop | discussion in <citerefentry> |
92 | a8083063 | Iustin Pop | <refentrytitle>gnt-cluster</refentrytitle> |
93 | a8083063 | Iustin Pop | <manvolnum>8</manvolnum> </citerefentry> for more |
94 | 5bbd3f7f | Michael Hanselmann | information. |
95 | a8083063 | Iustin Pop | </para> |
96 | a8083063 | Iustin Pop | |
97 | a8083063 | Iustin Pop | <para> |
98 | d3b4cf9f | Iustin Pop | In case you're readding a node after hardware failure, you can |
99 | d3b4cf9f | Iustin Pop | use the <option>--readd</option> parameter. In this case, you |
100 | d3b4cf9f | Iustin Pop | don't need to pass the secondary IP again, it will reused from |
101 | d3b4cf9f | Iustin Pop | the cluster. Also, the <literal>drained</literal> and |
102 | d3b4cf9f | Iustin Pop | <literal>offline</literal> flags of the node will be cleared |
103 | d3b4cf9f | Iustin Pop | before re-adding it. |
104 | e7c6e02b | Michael Hanselmann | </para> |
105 | e7c6e02b | Michael Hanselmann | |
106 | e7c6e02b | Michael Hanselmann | <para> |
107 | a8083063 | Iustin Pop | Example: |
108 | a8083063 | Iustin Pop | <screen> |
109 | a8083063 | Iustin Pop | # gnt-node add node5.example.com |
110 | a8083063 | Iustin Pop | # gnt-node add -s 192.168.44.5 node5.example.com |
111 | a8083063 | Iustin Pop | </screen> |
112 | a8083063 | Iustin Pop | </para> |
113 | a8083063 | Iustin Pop | </refsect2> |
114 | a8083063 | Iustin Pop | |
115 | a8083063 | Iustin Pop | <refsect2> |
116 | cc425644 | Iustin Pop | <title>ADD-TAGS</title> |
117 | cc425644 | Iustin Pop | |
118 | cc425644 | Iustin Pop | <cmdsynopsis> |
119 | cc425644 | Iustin Pop | <command>add-tags</command> |
120 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
121 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>nodename</replaceable></arg> |
122 | cc425644 | Iustin Pop | <arg choice="req" |
123 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
124 | cc425644 | Iustin Pop | </cmdsynopsis> |
125 | cc425644 | Iustin Pop | |
126 | cc425644 | Iustin Pop | <para> |
127 | cc425644 | Iustin Pop | Add tags to the given node. If any of the tags contains |
128 | cc425644 | Iustin Pop | invalid characters, the entire operation will abort. |
129 | cc425644 | Iustin Pop | </para> |
130 | 810c50b7 | Iustin Pop | |
131 | 810c50b7 | Iustin Pop | <para> |
132 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
133 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
134 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
135 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
136 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
137 | 810c50b7 | Iustin Pop | </para> |
138 | cc425644 | Iustin Pop | </refsect2> |
139 | cc425644 | Iustin Pop | |
140 | cc425644 | Iustin Pop | <refsect2> |
141 | a5bc662a | Iustin Pop | <title>EVACUATE</title> |
142 | a5bc662a | Iustin Pop | |
143 | a5bc662a | Iustin Pop | <cmdsynopsis> |
144 | a5bc662a | Iustin Pop | <command>evacuate</command> |
145 | a5bc662a | Iustin Pop | <arg>-f</arg> |
146 | d3b4cf9f | Iustin Pop | <group> |
147 | d3b4cf9f | Iustin Pop | <arg>--iallocator <replaceable>NAME</replaceable></arg> |
148 | d3b4cf9f | Iustin Pop | <arg>--new-secondary <replaceable>destination_node</replaceable></arg> |
149 | d3b4cf9f | Iustin Pop | </group> |
150 | d3b4cf9f | Iustin Pop | <arg choice="req"><replaceable>node</replaceable></arg> |
151 | a5bc662a | Iustin Pop | </cmdsynopsis> |
152 | a5bc662a | Iustin Pop | |
153 | a5bc662a | Iustin Pop | <para> |
154 | d3b4cf9f | Iustin Pop | This command will move all secondary instances away from the |
155 | d3b4cf9f | Iustin Pop | given node. It works only for instances having a drbd disk |
156 | d3b4cf9f | Iustin Pop | template. |
157 | d3b4cf9f | Iustin Pop | </para> |
158 | d3b4cf9f | Iustin Pop | |
159 | d3b4cf9f | Iustin Pop | <para> |
160 | d3b4cf9f | Iustin Pop | The new location for the instances can be specified in two ways: |
161 | d3b4cf9f | Iustin Pop | <itemizedlist> |
162 | d3b4cf9f | Iustin Pop | <listitem> |
163 | d3b4cf9f | Iustin Pop | <simpara>as a single node for all instances, via the |
164 | d3b4cf9f | Iustin Pop | <option>--new-secondary</option> option</simpara> |
165 | d3b4cf9f | Iustin Pop | </listitem> |
166 | d3b4cf9f | Iustin Pop | <listitem> |
167 | d3b4cf9f | Iustin Pop | <simpara>or via the <option>--iallocator</option> option, |
168 | d3b4cf9f | Iustin Pop | giving a script name as parameter, so each instance will |
169 | d3b4cf9f | Iustin Pop | be in turn placed on the (per the script) optimal |
170 | d3b4cf9f | Iustin Pop | node</simpara> |
171 | d3b4cf9f | Iustin Pop | </listitem> |
172 | d3b4cf9f | Iustin Pop | </itemizedlist> |
173 | a5bc662a | Iustin Pop | </para> |
174 | a5bc662a | Iustin Pop | |
175 | a5bc662a | Iustin Pop | <para> |
176 | a5bc662a | Iustin Pop | Example: |
177 | a5bc662a | Iustin Pop | <screen> |
178 | d3b4cf9f | Iustin Pop | # gnt-node evacuate -I dumb node3.example.com |
179 | a5bc662a | Iustin Pop | </screen> |
180 | a5bc662a | Iustin Pop | </para> |
181 | a5bc662a | Iustin Pop | </refsect2> |
182 | a5bc662a | Iustin Pop | |
183 | a5bc662a | Iustin Pop | <refsect2> |
184 | c450e9b0 | Iustin Pop | <title>FAILOVER</title> |
185 | c450e9b0 | Iustin Pop | |
186 | c450e9b0 | Iustin Pop | <cmdsynopsis> |
187 | c450e9b0 | Iustin Pop | <command>failover</command> |
188 | c450e9b0 | Iustin Pop | <arg>-f</arg> |
189 | c450e9b0 | Iustin Pop | <arg>--ignore-consistency</arg> |
190 | c450e9b0 | Iustin Pop | <arg choice="req"><replaceable>node</replaceable></arg> |
191 | c450e9b0 | Iustin Pop | </cmdsynopsis> |
192 | c450e9b0 | Iustin Pop | |
193 | c450e9b0 | Iustin Pop | <para> |
194 | c450e9b0 | Iustin Pop | This command will fail over all instances having the given |
195 | c450e9b0 | Iustin Pop | node as primary to their secondary nodes. This works only for |
196 | bd028152 | Iustin Pop | instances having a drbd disk template. |
197 | c450e9b0 | Iustin Pop | </para> |
198 | c450e9b0 | Iustin Pop | |
199 | c450e9b0 | Iustin Pop | <para> |
200 | c450e9b0 | Iustin Pop | Normally the failover will check the consistency of the disks |
201 | c450e9b0 | Iustin Pop | before failing over the instance. If you are trying to migrate |
202 | c450e9b0 | Iustin Pop | instances off a dead node, this will fail. Use the |
203 | c450e9b0 | Iustin Pop | <option>--ignore-consistency</option> option for this purpose. |
204 | c450e9b0 | Iustin Pop | </para> |
205 | c450e9b0 | Iustin Pop | |
206 | c450e9b0 | Iustin Pop | <para> |
207 | c450e9b0 | Iustin Pop | Example: |
208 | c450e9b0 | Iustin Pop | <screen> |
209 | c450e9b0 | Iustin Pop | # gnt-node failover node1.example.com |
210 | c450e9b0 | Iustin Pop | </screen> |
211 | c450e9b0 | Iustin Pop | </para> |
212 | c450e9b0 | Iustin Pop | </refsect2> |
213 | c450e9b0 | Iustin Pop | |
214 | c450e9b0 | Iustin Pop | <refsect2> |
215 | a8083063 | Iustin Pop | <title>INFO</title> |
216 | a8083063 | Iustin Pop | |
217 | a8083063 | Iustin Pop | <cmdsynopsis> |
218 | a8083063 | Iustin Pop | <command>info</command> |
219 | a8083063 | Iustin Pop | <arg rep="repeat"><replaceable>node</replaceable></arg> |
220 | a8083063 | Iustin Pop | </cmdsynopsis> |
221 | a8083063 | Iustin Pop | |
222 | a8083063 | Iustin Pop | <para> |
223 | a8083063 | Iustin Pop | Show detailed information about the nodes in the cluster. If you |
224 | a8083063 | Iustin Pop | don't give any arguments, all nodes will be shows, otherwise the |
225 | a8083063 | Iustin Pop | output will be restricted to the given names. |
226 | a8083063 | Iustin Pop | </para> |
227 | a8083063 | Iustin Pop | </refsect2> |
228 | a8083063 | Iustin Pop | |
229 | a8083063 | Iustin Pop | <refsect2> |
230 | a8083063 | Iustin Pop | <title>LIST</title> |
231 | a8083063 | Iustin Pop | |
232 | a8083063 | Iustin Pop | <cmdsynopsis> |
233 | a8083063 | Iustin Pop | <command>list</command> |
234 | d3b4cf9f | Iustin Pop | <arg>--sync</arg> |
235 | d3b4cf9f | Iustin Pop | <sbr> |
236 | a8083063 | Iustin Pop | <arg>--no-headers</arg> |
237 | a8083063 | Iustin Pop | <arg>--separator=<replaceable>SEPARATOR</replaceable></arg> |
238 | d3b4cf9f | Iustin Pop | <sbr> |
239 | d3b4cf9f | Iustin Pop | <arg>--units=<replaceable>UNITS</replaceable></arg> |
240 | 48c4dfa8 | Iustin Pop | <arg>-o <replaceable>[+]FIELD,...</replaceable></arg> |
241 | d3b4cf9f | Iustin Pop | <sbr> |
242 | d3b4cf9f | Iustin Pop | <arg rep="repeat">node</arg> |
243 | a8083063 | Iustin Pop | </cmdsynopsis> |
244 | a8083063 | Iustin Pop | |
245 | a8083063 | Iustin Pop | <para> |
246 | d3b4cf9f | Iustin Pop | Lists the nodes in the cluster. |
247 | a8083063 | Iustin Pop | </para> |
248 | a8083063 | Iustin Pop | |
249 | a8083063 | Iustin Pop | <para> |
250 | a8083063 | Iustin Pop | The <option>--no-headers</option> option will skip the initial |
251 | a8083063 | Iustin Pop | header line. The <option>--separator</option> option takes an |
252 | a8083063 | Iustin Pop | argument which denotes what will be used between the output |
253 | a8083063 | Iustin Pop | fields. Both these options are to help scripting. |
254 | a8083063 | Iustin Pop | </para> |
255 | a8083063 | Iustin Pop | |
256 | a8083063 | Iustin Pop | <para> |
257 | d3b4cf9f | Iustin Pop | The units used to display the numeric values in the output |
258 | d3b4cf9f | Iustin Pop | varies, depending on the options given. By default, the values |
259 | d3b4cf9f | Iustin Pop | will be formatted in the most appropriate unit. If the |
260 | d3b4cf9f | Iustin Pop | <option>--separator</option> option is given, then the values |
261 | d3b4cf9f | Iustin Pop | are shown in mebibytes to allow parsing by scripts. In both |
262 | d3b4cf9f | Iustin Pop | cases, the <option>--units</option> option can be used to |
263 | d3b4cf9f | Iustin Pop | enforce a given output unit. |
264 | d3b4cf9f | Iustin Pop | </para> |
265 | d3b4cf9f | Iustin Pop | |
266 | d3b4cf9f | Iustin Pop | <para> |
267 | d3b4cf9f | Iustin Pop | By default, the query of nodes will be done in parallel with |
268 | d3b4cf9f | Iustin Pop | any running jobs. This might give inconsistent results for the |
269 | d3b4cf9f | Iustin Pop | free disk/memory. The <option>--sync</option> can be used to |
270 | d3b4cf9f | Iustin Pop | grab locks for all the nodes and ensure consistent view of the |
271 | d3b4cf9f | Iustin Pop | cluster (but this might stall the query for a long time). |
272 | d3b4cf9f | Iustin Pop | </para> |
273 | d3b4cf9f | Iustin Pop | |
274 | d3b4cf9f | Iustin Pop | <para> |
275 | a8083063 | Iustin Pop | The <option>-o</option> option takes a comma-separated list of |
276 | a8083063 | Iustin Pop | output fields. The available fields and their meaning are: |
277 | a8083063 | Iustin Pop | <variablelist> |
278 | a8083063 | Iustin Pop | <varlistentry> |
279 | a8083063 | Iustin Pop | <term>name</term> |
280 | a8083063 | Iustin Pop | <listitem> |
281 | a8083063 | Iustin Pop | <simpara>the node name</simpara> |
282 | a8083063 | Iustin Pop | </listitem> |
283 | a8083063 | Iustin Pop | </varlistentry> |
284 | a8083063 | Iustin Pop | <varlistentry> |
285 | d8a4b51d | Iustin Pop | <term>pinst_cnt</term> |
286 | a8083063 | Iustin Pop | <listitem> |
287 | a8083063 | Iustin Pop | <simpara>the number of instances having this node as |
288 | a8083063 | Iustin Pop | primary</simpara> |
289 | a8083063 | Iustin Pop | </listitem> |
290 | a8083063 | Iustin Pop | </varlistentry> |
291 | a8083063 | Iustin Pop | <varlistentry> |
292 | d8a4b51d | Iustin Pop | <term>pinst_list</term> |
293 | d8a4b51d | Iustin Pop | <listitem> |
294 | d8a4b51d | Iustin Pop | <simpara>the list of instances having this node as |
295 | d8a4b51d | Iustin Pop | primary, comma separated</simpara> |
296 | d8a4b51d | Iustin Pop | </listitem> |
297 | d8a4b51d | Iustin Pop | </varlistentry> |
298 | d8a4b51d | Iustin Pop | <varlistentry> |
299 | d8a4b51d | Iustin Pop | <term>sinst_cnt</term> |
300 | a8083063 | Iustin Pop | <listitem> |
301 | a8083063 | Iustin Pop | <simpara>the number of instances having this node as a |
302 | a8083063 | Iustin Pop | secondary node</simpara> |
303 | a8083063 | Iustin Pop | </listitem> |
304 | a8083063 | Iustin Pop | </varlistentry> |
305 | a8083063 | Iustin Pop | <varlistentry> |
306 | d8a4b51d | Iustin Pop | <term>sinst_list</term> |
307 | d8a4b51d | Iustin Pop | <listitem> |
308 | d8a4b51d | Iustin Pop | <simpara>the list of instances having this node as a |
309 | d8a4b51d | Iustin Pop | secondary node, comma separated</simpara> |
310 | d8a4b51d | Iustin Pop | </listitem> |
311 | d8a4b51d | Iustin Pop | </varlistentry> |
312 | d8a4b51d | Iustin Pop | <varlistentry> |
313 | a8083063 | Iustin Pop | <term>pip</term> |
314 | a8083063 | Iustin Pop | <listitem> |
315 | a8083063 | Iustin Pop | <simpara>the primary ip of this node (used for cluster |
316 | a8083063 | Iustin Pop | communication)</simpara> |
317 | a8083063 | Iustin Pop | </listitem> |
318 | a8083063 | Iustin Pop | </varlistentry> |
319 | a8083063 | Iustin Pop | <varlistentry> |
320 | a8083063 | Iustin Pop | <term>sip</term> |
321 | a8083063 | Iustin Pop | <listitem> |
322 | a8083063 | Iustin Pop | <simpara> |
323 | a8083063 | Iustin Pop | the secondary ip of this node (used for data |
324 | a8083063 | Iustin Pop | replication in dual-ip clusters, see <citerefentry> |
325 | a8083063 | Iustin Pop | <refentrytitle>gnt-cluster</refentrytitle> |
326 | a8083063 | Iustin Pop | <manvolnum>8</manvolnum> |
327 | a8083063 | Iustin Pop | </citerefentry> |
328 | a8083063 | Iustin Pop | </simpara> |
329 | a8083063 | Iustin Pop | </listitem> |
330 | a8083063 | Iustin Pop | </varlistentry> |
331 | a8083063 | Iustin Pop | <varlistentry> |
332 | a8083063 | Iustin Pop | <term>dtotal</term> |
333 | a8083063 | Iustin Pop | <listitem> |
334 | a8083063 | Iustin Pop | <simpara>total disk space in the volume group used for |
335 | a8083063 | Iustin Pop | instance disk allocations</simpara> |
336 | a8083063 | Iustin Pop | </listitem> |
337 | a8083063 | Iustin Pop | </varlistentry> |
338 | a8083063 | Iustin Pop | <varlistentry> |
339 | a8083063 | Iustin Pop | <term>dfree</term> |
340 | a8083063 | Iustin Pop | <listitem> |
341 | a8083063 | Iustin Pop | <simpara>available disk space in the volume group</simpara> |
342 | a8083063 | Iustin Pop | </listitem> |
343 | a8083063 | Iustin Pop | </varlistentry> |
344 | a8083063 | Iustin Pop | <varlistentry> |
345 | a8083063 | Iustin Pop | <term>mtotal</term> |
346 | a8083063 | Iustin Pop | <listitem> |
347 | a8083063 | Iustin Pop | <simpara>total memory on the physical node</simpara> |
348 | a8083063 | Iustin Pop | </listitem> |
349 | a8083063 | Iustin Pop | </varlistentry> |
350 | a8083063 | Iustin Pop | <varlistentry> |
351 | a8083063 | Iustin Pop | <term>mnode</term> |
352 | a8083063 | Iustin Pop | <listitem> |
353 | a8083063 | Iustin Pop | <simpara>the memory used by the node itself</simpara> |
354 | a8083063 | Iustin Pop | </listitem> |
355 | a8083063 | Iustin Pop | </varlistentry> |
356 | a8083063 | Iustin Pop | <varlistentry> |
357 | a8083063 | Iustin Pop | <term>mfree</term> |
358 | a8083063 | Iustin Pop | <listitem> |
359 | a8083063 | Iustin Pop | <simpara>memory available for instance |
360 | a8083063 | Iustin Pop | allocations</simpara> |
361 | a8083063 | Iustin Pop | </listitem> |
362 | a8083063 | Iustin Pop | </varlistentry> |
363 | d8a4b51d | Iustin Pop | <varlistentry> |
364 | d8a4b51d | Iustin Pop | <term>bootid</term> |
365 | d8a4b51d | Iustin Pop | <listitem> |
366 | d8a4b51d | Iustin Pop | <simpara>the node bootid value; this is a linux specific |
367 | d8a4b51d | Iustin Pop | feature that assigns a new UUID to the node at each boot |
368 | d8a4b51d | Iustin Pop | and can be use to detect node reboots (by tracking |
369 | d8a4b51d | Iustin Pop | changes in this value)</simpara> |
370 | d8a4b51d | Iustin Pop | </listitem> |
371 | d8a4b51d | Iustin Pop | </varlistentry> |
372 | 130a6a6f | Iustin Pop | <varlistentry> |
373 | 130a6a6f | Iustin Pop | <term>tags</term> |
374 | 130a6a6f | Iustin Pop | <listitem> |
375 | 130a6a6f | Iustin Pop | <simpara>comma-separated list of the node's |
376 | 130a6a6f | Iustin Pop | tags</simpara> |
377 | 130a6a6f | Iustin Pop | </listitem> |
378 | 130a6a6f | Iustin Pop | </varlistentry> |
379 | 38d7239a | Iustin Pop | <varlistentry> |
380 | 38d7239a | Iustin Pop | <term>serial_no</term> |
381 | 38d7239a | Iustin Pop | <listitem> |
382 | 90f72445 | Iustin Pop | <simpara>the so called 'serial number' of the node; |
383 | 38d7239a | Iustin Pop | this is a numeric field that is incremented each time |
384 | 90f72445 | Iustin Pop | the node is modified, and it can be used to detect |
385 | 38d7239a | Iustin Pop | modifications</simpara> |
386 | 38d7239a | Iustin Pop | </listitem> |
387 | 38d7239a | Iustin Pop | </varlistentry> |
388 | d3b4cf9f | Iustin Pop | <varlistentry> |
389 | 90f72445 | Iustin Pop | <term>ctime</term> |
390 | 90f72445 | Iustin Pop | <listitem> |
391 | 90f72445 | Iustin Pop | <para> |
392 | 90f72445 | Iustin Pop | the creation time of the node; note that this field |
393 | 90f72445 | Iustin Pop | contains spaces and as such it's harder to parse |
394 | 90f72445 | Iustin Pop | </para> |
395 | 90f72445 | Iustin Pop | <para> |
396 | 90f72445 | Iustin Pop | if this attribute is not present (e.g. when upgrading |
397 | 90f72445 | Iustin Pop | from older versions), then "N/A" will be shown instead |
398 | 90f72445 | Iustin Pop | </para> |
399 | 90f72445 | Iustin Pop | </listitem> |
400 | 90f72445 | Iustin Pop | </varlistentry> |
401 | 90f72445 | Iustin Pop | <varlistentry> |
402 | 90f72445 | Iustin Pop | <term>mtime</term> |
403 | 90f72445 | Iustin Pop | <listitem> |
404 | 90f72445 | Iustin Pop | <para> |
405 | 90f72445 | Iustin Pop | the last modification time of the node; note that this |
406 | 90f72445 | Iustin Pop | field contains spaces and as such it's harder to parse |
407 | 90f72445 | Iustin Pop | </para> |
408 | 90f72445 | Iustin Pop | <para> |
409 | 90f72445 | Iustin Pop | if this attribute is not present (e.g. when upgrading |
410 | 90f72445 | Iustin Pop | from older versions), then "N/A" will be shown instead |
411 | 90f72445 | Iustin Pop | </para> |
412 | 90f72445 | Iustin Pop | </listitem> |
413 | 90f72445 | Iustin Pop | </varlistentry> |
414 | 90f72445 | Iustin Pop | <varlistentry> |
415 | edc8fc5f | Iustin Pop | <term>uuid</term> |
416 | edc8fc5f | Iustin Pop | <listitem> |
417 | edc8fc5f | Iustin Pop | <simpara>Show the UUID of the node (generated |
418 | edc8fc5f | Iustin Pop | automatically by Ganeti)</simpara> |
419 | edc8fc5f | Iustin Pop | </listitem> |
420 | edc8fc5f | Iustin Pop | </varlistentry> |
421 | edc8fc5f | Iustin Pop | |
422 | edc8fc5f | Iustin Pop | <varlistentry> |
423 | d3b4cf9f | Iustin Pop | <term>ctotal</term> |
424 | d3b4cf9f | Iustin Pop | <listitem> |
425 | d3b4cf9f | Iustin Pop | <simpara>the toal number of logical processors</simpara> |
426 | d3b4cf9f | Iustin Pop | </listitem> |
427 | d3b4cf9f | Iustin Pop | </varlistentry> |
428 | d3b4cf9f | Iustin Pop | <varlistentry> |
429 | d3b4cf9f | Iustin Pop | <term>cnodes</term> |
430 | d3b4cf9f | Iustin Pop | <listitem> |
431 | d3b4cf9f | Iustin Pop | <simpara>the number of NUMA domains on the node, if the |
432 | d3b4cf9f | Iustin Pop | hypervisor can export this information</simpara> |
433 | d3b4cf9f | Iustin Pop | </listitem> |
434 | d3b4cf9f | Iustin Pop | </varlistentry> |
435 | d3b4cf9f | Iustin Pop | <varlistentry> |
436 | d3b4cf9f | Iustin Pop | <term>csockets</term> |
437 | d3b4cf9f | Iustin Pop | <listitem> |
438 | d3b4cf9f | Iustin Pop | <simpara>the number of physical CPU sockets, if the |
439 | d3b4cf9f | Iustin Pop | hypervisor can export this information</simpara> |
440 | d3b4cf9f | Iustin Pop | </listitem> |
441 | d3b4cf9f | Iustin Pop | </varlistentry> |
442 | d3b4cf9f | Iustin Pop | <varlistentry> |
443 | d3b4cf9f | Iustin Pop | <term>master_candidate</term> |
444 | d3b4cf9f | Iustin Pop | <listitem> |
445 | d3b4cf9f | Iustin Pop | <simpara>whether the node is a master candidate or not</simpara> |
446 | d3b4cf9f | Iustin Pop | </listitem> |
447 | d3b4cf9f | Iustin Pop | </varlistentry> |
448 | d3b4cf9f | Iustin Pop | <varlistentry> |
449 | d3b4cf9f | Iustin Pop | <term>drained</term> |
450 | d3b4cf9f | Iustin Pop | <listitem> |
451 | 253ba78f | Raiford Storey | <simpara>whether the node is drained or not; the cluster |
452 | 253ba78f | Raiford Storey | still communicates with drained nodes but excludes them |
453 | 253ba78f | Raiford Storey | from allocation operations</simpara> |
454 | d3b4cf9f | Iustin Pop | </listitem> |
455 | d3b4cf9f | Iustin Pop | </varlistentry> |
456 | d3b4cf9f | Iustin Pop | <varlistentry> |
457 | d3b4cf9f | Iustin Pop | <term>offline</term> |
458 | d3b4cf9f | Iustin Pop | <listitem> |
459 | 253ba78f | Raiford Storey | <simpara>whether the node is offline or not; if offline, |
460 | 253ba78f | Raiford Storey | the cluster does not communicate with offline nodes; |
461 | 253ba78f | Raiford Storey | useful for nodes that are not reachable in order to |
462 | 253ba78f | Raiford Storey | avoid delays</simpara> |
463 | d3b4cf9f | Iustin Pop | </listitem> |
464 | d3b4cf9f | Iustin Pop | </varlistentry> |
465 | c120ff34 | Iustin Pop | <varlistentry> |
466 | c120ff34 | Iustin Pop | <term>role</term> |
467 | c120ff34 | Iustin Pop | <listitem> |
468 | c120ff34 | Iustin Pop | <para> |
469 | c120ff34 | Iustin Pop | A condensed version of the node flags; this field will |
470 | c120ff34 | Iustin Pop | output a one-character field, with the following |
471 | c120ff34 | Iustin Pop | possible values: |
472 | c120ff34 | Iustin Pop | <itemizedlist> |
473 | c120ff34 | Iustin Pop | <listitem> |
474 | c120ff34 | Iustin Pop | <simpara><emphasis>M</emphasis> for the master |
475 | c120ff34 | Iustin Pop | node</simpara> |
476 | c120ff34 | Iustin Pop | </listitem> |
477 | c120ff34 | Iustin Pop | <listitem> |
478 | c120ff34 | Iustin Pop | <simpara><emphasis>C</emphasis> for a master |
479 | c120ff34 | Iustin Pop | candidate</simpara> |
480 | c120ff34 | Iustin Pop | </listitem> |
481 | c120ff34 | Iustin Pop | <listitem> |
482 | c120ff34 | Iustin Pop | <simpara><emphasis>R</emphasis> for a regular |
483 | c120ff34 | Iustin Pop | node</simpara> |
484 | c120ff34 | Iustin Pop | </listitem> |
485 | c120ff34 | Iustin Pop | <listitem> |
486 | c120ff34 | Iustin Pop | <simpara><emphasis>D</emphasis> for a drained |
487 | c120ff34 | Iustin Pop | node</simpara> |
488 | c120ff34 | Iustin Pop | </listitem> |
489 | c120ff34 | Iustin Pop | <listitem> |
490 | c120ff34 | Iustin Pop | <simpara><emphasis>O</emphasis> for an offline |
491 | c120ff34 | Iustin Pop | node</simpara> |
492 | c120ff34 | Iustin Pop | </listitem> |
493 | c120ff34 | Iustin Pop | </itemizedlist> |
494 | c120ff34 | Iustin Pop | </para> |
495 | c120ff34 | Iustin Pop | </listitem> |
496 | c120ff34 | Iustin Pop | </varlistentry> |
497 | a8083063 | Iustin Pop | </variablelist> |
498 | a8083063 | Iustin Pop | </para> |
499 | a8083063 | Iustin Pop | |
500 | a8083063 | Iustin Pop | <para> |
501 | 48c4dfa8 | Iustin Pop | If the value of the option starts with the character |
502 | 48c4dfa8 | Iustin Pop | <constant>+</constant>, the new fields will be added to the |
503 | 48c4dfa8 | Iustin Pop | default list. This allows to quickly see the default list plus |
504 | 48c4dfa8 | Iustin Pop | a few other fields, instead of retyping the entire list of |
505 | 48c4dfa8 | Iustin Pop | fields. |
506 | 48c4dfa8 | Iustin Pop | </para> |
507 | 48c4dfa8 | Iustin Pop | |
508 | 48c4dfa8 | Iustin Pop | <para> |
509 | a8083063 | Iustin Pop | Note that some of this fields are known from the configuration |
510 | d3b4cf9f | Iustin Pop | of the cluster (e.g. <simplelist type="inline"> |
511 | a8083063 | Iustin Pop | <member>name</member> <member>pinst</member> |
512 | a8083063 | Iustin Pop | <member>sinst</member> <member>pip</member> |
513 | a8083063 | Iustin Pop | <member>sip</member> </simplelist> and thus the master does |
514 | a8083063 | Iustin Pop | not need to contact the node for this data (making the listing |
515 | a8083063 | Iustin Pop | fast if only fields from this set are selected), whereas the |
516 | a8083063 | Iustin Pop | other fields are "live" fields and we need to make a query to |
517 | a8083063 | Iustin Pop | the cluster nodes. |
518 | a8083063 | Iustin Pop | </para> |
519 | a8083063 | Iustin Pop | |
520 | a8083063 | Iustin Pop | <para> |
521 | a8083063 | Iustin Pop | Depending on the virtualization type and implementation |
522 | a8083063 | Iustin Pop | details, the mtotal, mnode and mfree may have slighly varying |
523 | a8083063 | Iustin Pop | meanings. For example, some solutions share the node memory |
524 | a8083063 | Iustin Pop | with the pool of memory used for instances |
525 | d3b4cf9f | Iustin Pop | (<acronym>KVM</acronym>), whereas others have separate memory |
526 | a8083063 | Iustin Pop | for the node and for the instances (Xen). |
527 | a8083063 | Iustin Pop | </para> |
528 | d3b4cf9f | Iustin Pop | |
529 | d3b4cf9f | Iustin Pop | <para> |
530 | d3b4cf9f | Iustin Pop | If no node names are given, then all nodes are |
531 | d3b4cf9f | Iustin Pop | queried. Otherwise, only the given nodes will be listed. |
532 | d3b4cf9f | Iustin Pop | </para> |
533 | a8083063 | Iustin Pop | </refsect2> |
534 | a8083063 | Iustin Pop | |
535 | a8083063 | Iustin Pop | <refsect2> |
536 | cc425644 | Iustin Pop | <title>LIST-TAGS</title> |
537 | cc425644 | Iustin Pop | |
538 | cc425644 | Iustin Pop | <cmdsynopsis> |
539 | cc425644 | Iustin Pop | <command>list-tags</command> |
540 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>nodename</replaceable></arg> |
541 | cc425644 | Iustin Pop | </cmdsynopsis> |
542 | cc425644 | Iustin Pop | |
543 | cc425644 | Iustin Pop | <para>List the tags of the given node.</para> |
544 | cc425644 | Iustin Pop | </refsect2> |
545 | cc425644 | Iustin Pop | |
546 | cc425644 | Iustin Pop | <refsect2> |
547 | d3b4cf9f | Iustin Pop | <title>MIGRATE</title> |
548 | d3b4cf9f | Iustin Pop | <cmdsynopsis> |
549 | d3b4cf9f | Iustin Pop | <command>migrate</command> |
550 | d3b4cf9f | Iustin Pop | <arg>-f</arg> |
551 | d3b4cf9f | Iustin Pop | <arg>--non-live</arg> |
552 | d3b4cf9f | Iustin Pop | <arg choice="req"><replaceable>node</replaceable></arg> |
553 | d3b4cf9f | Iustin Pop | </cmdsynopsis> |
554 | d3b4cf9f | Iustin Pop | |
555 | d3b4cf9f | Iustin Pop | <para> |
556 | d3b4cf9f | Iustin Pop | This command will migrate all instances having the given |
557 | d3b4cf9f | Iustin Pop | node as primary to their secondary nodes. This works only for |
558 | d3b4cf9f | Iustin Pop | instances having a drbd disk template. |
559 | d3b4cf9f | Iustin Pop | </para> |
560 | d3b4cf9f | Iustin Pop | |
561 | d3b4cf9f | Iustin Pop | <para> |
562 | d3b4cf9f | Iustin Pop | As for the <command>gnt-instance migrate</command> command, |
563 | d3b4cf9f | Iustin Pop | the <option>--no-live</option> option can be given to do a |
564 | d3b4cf9f | Iustin Pop | non-live migration. |
565 | d3b4cf9f | Iustin Pop | </para> |
566 | d3b4cf9f | Iustin Pop | |
567 | d3b4cf9f | Iustin Pop | <para> |
568 | d3b4cf9f | Iustin Pop | Example: |
569 | d3b4cf9f | Iustin Pop | <screen> |
570 | d3b4cf9f | Iustin Pop | # gnt-node migrate node1.example.com |
571 | d3b4cf9f | Iustin Pop | </screen> |
572 | d3b4cf9f | Iustin Pop | </para> |
573 | d3b4cf9f | Iustin Pop | |
574 | d3b4cf9f | Iustin Pop | </refsect2> |
575 | d3b4cf9f | Iustin Pop | |
576 | d3b4cf9f | Iustin Pop | <refsect2> |
577 | 949bdabe | Iustin Pop | <title>MODIFY</title> |
578 | 949bdabe | Iustin Pop | <cmdsynopsis> |
579 | 949bdabe | Iustin Pop | <command>modify</command> |
580 | 949bdabe | Iustin Pop | <arg>-f</arg> |
581 | 949bdabe | Iustin Pop | <arg>--submit</arg> |
582 | 949bdabe | Iustin Pop | <arg>--master-candidate=<option>yes|no</option></arg> |
583 | 949bdabe | Iustin Pop | <arg>--drained=<option>yes|no</option></arg> |
584 | 949bdabe | Iustin Pop | <arg>--offline=<option>yes|no</option></arg> |
585 | 949bdabe | Iustin Pop | <arg choice="req"><replaceable>node</replaceable></arg> |
586 | 949bdabe | Iustin Pop | </cmdsynopsis> |
587 | 949bdabe | Iustin Pop | |
588 | 949bdabe | Iustin Pop | <para> |
589 | 949bdabe | Iustin Pop | This command changes the role of the node. Each options takes |
590 | 949bdabe | Iustin Pop | either a literal <literal>yes</literal> or |
591 | 949bdabe | Iustin Pop | <literal>no</literal>, and only one option should be given as |
592 | 949bdabe | Iustin Pop | <literal>yes</literal>. The meaning of the roles are described |
593 | 949bdabe | Iustin Pop | in the manpage <citerefentry> |
594 | 949bdabe | Iustin Pop | <refentrytitle>ganeti</refentrytitle> <manvolnum>7</manvolnum> |
595 | 949bdabe | Iustin Pop | </citerefentry>. |
596 | 949bdabe | Iustin Pop | </para> |
597 | 949bdabe | Iustin Pop | |
598 | 949bdabe | Iustin Pop | <para> |
599 | 949bdabe | Iustin Pop | In case a node is demoted from the master candidate role, but |
600 | 949bdabe | Iustin Pop | there are not enough new nodes for this case, the operation |
601 | 949bdabe | Iustin Pop | will be refused. To override this check, pass the |
602 | 949bdabe | Iustin Pop | <option>--force</option> option. |
603 | 949bdabe | Iustin Pop | </para> |
604 | 949bdabe | Iustin Pop | |
605 | 949bdabe | Iustin Pop | <para> |
606 | 949bdabe | Iustin Pop | Example (setting a node offline, which will demote it from |
607 | 949bdabe | Iustin Pop | master candidate role if is in that role): |
608 | 949bdabe | Iustin Pop | <screen> |
609 | 949bdabe | Iustin Pop | # gnt-node modify --offline=yes node1.example.com |
610 | 949bdabe | Iustin Pop | </screen> |
611 | 949bdabe | Iustin Pop | </para> |
612 | 949bdabe | Iustin Pop | |
613 | 949bdabe | Iustin Pop | <para>Example (setting the node back to online and master candidate): |
614 | 949bdabe | Iustin Pop | <screen> |
615 | 949bdabe | Iustin Pop | # gnt-node modify --offline=no --master-candidate=yes node1.example.com |
616 | 949bdabe | Iustin Pop | </screen> |
617 | 949bdabe | Iustin Pop | </para> |
618 | 949bdabe | Iustin Pop | |
619 | 949bdabe | Iustin Pop | </refsect2> |
620 | 949bdabe | Iustin Pop | |
621 | 949bdabe | Iustin Pop | <refsect2> |
622 | a8083063 | Iustin Pop | <title>REMOVE</title> |
623 | a8083063 | Iustin Pop | |
624 | a8083063 | Iustin Pop | <cmdsynopsis> |
625 | a8083063 | Iustin Pop | <command>remove</command> |
626 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>nodename</replaceable></arg> |
627 | a8083063 | Iustin Pop | </cmdsynopsis> |
628 | a8083063 | Iustin Pop | |
629 | a8083063 | Iustin Pop | <para> |
630 | a8083063 | Iustin Pop | Removes a node from the cluster. Instances must be removed or |
631 | a8083063 | Iustin Pop | migrated to another cluster before. |
632 | a8083063 | Iustin Pop | </para> |
633 | a8083063 | Iustin Pop | |
634 | a8083063 | Iustin Pop | <para> |
635 | a8083063 | Iustin Pop | Example: |
636 | a8083063 | Iustin Pop | <screen> |
637 | a8083063 | Iustin Pop | # gnt-node remove node5.example.com |
638 | a8083063 | Iustin Pop | </screen> |
639 | a8083063 | Iustin Pop | </para> |
640 | a8083063 | Iustin Pop | </refsect2> |
641 | a8083063 | Iustin Pop | |
642 | dcb93971 | Michael Hanselmann | <refsect2> |
643 | cc425644 | Iustin Pop | <title>REMOVE-TAGS</title> |
644 | cc425644 | Iustin Pop | <cmdsynopsis> |
645 | cc425644 | Iustin Pop | <command>remove-tags</command> |
646 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
647 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>nodename</replaceable></arg> |
648 | cc425644 | Iustin Pop | <arg choice="req" |
649 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
650 | cc425644 | Iustin Pop | </cmdsynopsis> |
651 | cc425644 | Iustin Pop | |
652 | cc425644 | Iustin Pop | <para> |
653 | cc425644 | Iustin Pop | Remove tags from the given node. If any of the tags are not |
654 | cc425644 | Iustin Pop | existing on the node, the entire operation will abort. |
655 | cc425644 | Iustin Pop | </para> |
656 | 810c50b7 | Iustin Pop | |
657 | 810c50b7 | Iustin Pop | <para> |
658 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
659 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
660 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
661 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
662 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
663 | 810c50b7 | Iustin Pop | </para> |
664 | cc425644 | Iustin Pop | </refsect2> |
665 | cc425644 | Iustin Pop | |
666 | cc425644 | Iustin Pop | <refsect2> |
667 | dcb93971 | Michael Hanselmann | <title>VOLUMES</title> |
668 | dcb93971 | Michael Hanselmann | |
669 | dcb93971 | Michael Hanselmann | <cmdsynopsis> |
670 | dcb93971 | Michael Hanselmann | <command>volumes</command> |
671 | f69dab6d | Iustin Pop | <arg>--no-headers</arg> |
672 | f69dab6d | Iustin Pop | <arg>--human-readable</arg> |
673 | f69dab6d | Iustin Pop | <arg>--separator=<replaceable>SEPARATOR</replaceable></arg> |
674 | f69dab6d | Iustin Pop | <arg>--output=<replaceable>FIELDS</replaceable></arg> |
675 | f69dab6d | Iustin Pop | <sbr> |
676 | dcb93971 | Michael Hanselmann | <arg rep="repeat"><replaceable>node</replaceable></arg> |
677 | dcb93971 | Michael Hanselmann | </cmdsynopsis> |
678 | dcb93971 | Michael Hanselmann | |
679 | dcb93971 | Michael Hanselmann | <para> |
680 | dcb93971 | Michael Hanselmann | Lists all logical volumes and their physical disks from the node(s) |
681 | dcb93971 | Michael Hanselmann | provided. |
682 | dcb93971 | Michael Hanselmann | </para> |
683 | dcb93971 | Michael Hanselmann | |
684 | dcb93971 | Michael Hanselmann | <para> |
685 | f69dab6d | Iustin Pop | The <option>--no-headers</option> option will skip the initial |
686 | f69dab6d | Iustin Pop | header line. The <option>--separator</option> option takes an |
687 | f69dab6d | Iustin Pop | argument which denotes what will be used between the output |
688 | f69dab6d | Iustin Pop | fields. Both these options are to help scripting. |
689 | f69dab6d | Iustin Pop | </para> |
690 | f69dab6d | Iustin Pop | |
691 | f69dab6d | Iustin Pop | <para> |
692 | d3b4cf9f | Iustin Pop | The units used to display the numeric values in the output |
693 | d3b4cf9f | Iustin Pop | varies, depending on the options given. By default, the values |
694 | d3b4cf9f | Iustin Pop | will be formatted in the most appropriate unit. If the |
695 | d3b4cf9f | Iustin Pop | <option>--separator</option> option is given, then the values |
696 | d3b4cf9f | Iustin Pop | are shown in mebibytes to allow parsing by scripts. In both |
697 | d3b4cf9f | Iustin Pop | cases, the <option>--units</option> option can be used to |
698 | d3b4cf9f | Iustin Pop | enforce a given output unit. |
699 | d3b4cf9f | Iustin Pop | </para> |
700 | d3b4cf9f | Iustin Pop | |
701 | d3b4cf9f | Iustin Pop | <para> |
702 | f69dab6d | Iustin Pop | The <option>-o</option> option takes a comma-separated list of |
703 | f69dab6d | Iustin Pop | output fields. The available fields and their meaning are: |
704 | f69dab6d | Iustin Pop | <variablelist> |
705 | f69dab6d | Iustin Pop | <varlistentry> |
706 | f69dab6d | Iustin Pop | <term>node</term> |
707 | f69dab6d | Iustin Pop | <listitem> |
708 | f69dab6d | Iustin Pop | <simpara>the node name on which the volume exists</simpara> |
709 | f69dab6d | Iustin Pop | </listitem> |
710 | f69dab6d | Iustin Pop | </varlistentry> |
711 | f69dab6d | Iustin Pop | <varlistentry> |
712 | f69dab6d | Iustin Pop | <term>phys</term> |
713 | f69dab6d | Iustin Pop | <listitem> |
714 | f69dab6d | Iustin Pop | <simpara>the physical drive (on which the LVM physical |
715 | f69dab6d | Iustin Pop | volume lives)</simpara> |
716 | f69dab6d | Iustin Pop | </listitem> |
717 | f69dab6d | Iustin Pop | </varlistentry> |
718 | f69dab6d | Iustin Pop | <varlistentry> |
719 | f69dab6d | Iustin Pop | <term>vg</term> |
720 | f69dab6d | Iustin Pop | <listitem> |
721 | f69dab6d | Iustin Pop | <simpara>the volume group name</simpara> |
722 | f69dab6d | Iustin Pop | </listitem> |
723 | f69dab6d | Iustin Pop | </varlistentry> |
724 | f69dab6d | Iustin Pop | <varlistentry> |
725 | f69dab6d | Iustin Pop | <term>name</term> |
726 | f69dab6d | Iustin Pop | <listitem> |
727 | f69dab6d | Iustin Pop | <simpara>the logical volume name</simpara> |
728 | f69dab6d | Iustin Pop | </listitem> |
729 | f69dab6d | Iustin Pop | </varlistentry> |
730 | f69dab6d | Iustin Pop | <varlistentry> |
731 | f69dab6d | Iustin Pop | <term>size</term> |
732 | f69dab6d | Iustin Pop | <listitem> |
733 | f69dab6d | Iustin Pop | <simpara>the logical volume size</simpara> |
734 | f69dab6d | Iustin Pop | </listitem> |
735 | f69dab6d | Iustin Pop | </varlistentry> |
736 | f69dab6d | Iustin Pop | <varlistentry> |
737 | f69dab6d | Iustin Pop | <term>instance</term> |
738 | f69dab6d | Iustin Pop | <listitem> |
739 | f69dab6d | Iustin Pop | <simpara>The name of the instance to which this volume |
740 | f69dab6d | Iustin Pop | belongs, or (in case it's an orphan volume) the |
741 | f69dab6d | Iustin Pop | character <quote>-</quote></simpara> |
742 | f69dab6d | Iustin Pop | </listitem> |
743 | f69dab6d | Iustin Pop | </varlistentry> |
744 | f69dab6d | Iustin Pop | </variablelist> |
745 | f69dab6d | Iustin Pop | </para> |
746 | f69dab6d | Iustin Pop | |
747 | f69dab6d | Iustin Pop | <para> |
748 | dcb93971 | Michael Hanselmann | Example: |
749 | dcb93971 | Michael Hanselmann | <screen> |
750 | dcb93971 | Michael Hanselmann | # gnt-node volumes node5.example.com |
751 | dcb93971 | Michael Hanselmann | Node PhysDev VG Name Size Instance |
752 | dcb93971 | Michael Hanselmann | node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11000.meta 128 instance1.example.com |
753 | dcb93971 | Michael Hanselmann | node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11001.data 256 instance1.example.com |
754 | dcb93971 | Michael Hanselmann | </screen> |
755 | dcb93971 | Michael Hanselmann | </para> |
756 | dcb93971 | Michael Hanselmann | </refsect2> |
757 | dcb93971 | Michael Hanselmann | |
758 | f5118ade | Iustin Pop | <refsect2> |
759 | 9b94905f | Iustin Pop | <title>LIST-STORAGE</title> |
760 | 4007f57d | Michael Hanselmann | |
761 | 4007f57d | Michael Hanselmann | <cmdsynopsis> |
762 | 9b94905f | Iustin Pop | <command>list-storage</command> |
763 | 4007f57d | Michael Hanselmann | <arg>--no-headers</arg> |
764 | 4007f57d | Michael Hanselmann | <arg>--human-readable</arg> |
765 | 4007f57d | Michael Hanselmann | <arg>--separator=<replaceable>SEPARATOR</replaceable></arg> |
766 | 53548798 | Michael Hanselmann | <arg>--storage-type=<replaceable>STORAGE_TYPE</replaceable></arg> |
767 | 4007f57d | Michael Hanselmann | <arg>--output=<replaceable>FIELDS</replaceable></arg> |
768 | 4007f57d | Michael Hanselmann | <sbr> |
769 | 4007f57d | Michael Hanselmann | <arg rep="repeat"><replaceable>node</replaceable></arg> |
770 | 4007f57d | Michael Hanselmann | </cmdsynopsis> |
771 | 4007f57d | Michael Hanselmann | |
772 | 4007f57d | Michael Hanselmann | <para> |
773 | 9b94905f | Iustin Pop | Lists the available storage units and their details for the |
774 | 9b94905f | Iustin Pop | given node(s). |
775 | 4007f57d | Michael Hanselmann | </para> |
776 | 4007f57d | Michael Hanselmann | |
777 | 4007f57d | Michael Hanselmann | <para> |
778 | 4007f57d | Michael Hanselmann | The <option>--no-headers</option> option will skip the initial header |
779 | 4007f57d | Michael Hanselmann | line. The <option>--separator</option> option takes an argument which |
780 | 4007f57d | Michael Hanselmann | denotes what will be used between the output fields. Both these options |
781 | 4007f57d | Michael Hanselmann | are to help scripting. |
782 | 4007f57d | Michael Hanselmann | </para> |
783 | 4007f57d | Michael Hanselmann | |
784 | 4007f57d | Michael Hanselmann | <para> |
785 | 4007f57d | Michael Hanselmann | The units used to display the numeric values in the output varies, |
786 | 4007f57d | Michael Hanselmann | depending on the options given. By default, the values will be |
787 | 4007f57d | Michael Hanselmann | formatted in the most appropriate unit. If the |
788 | 4007f57d | Michael Hanselmann | <option>--separator</option> option is given, then the values are shown |
789 | 4007f57d | Michael Hanselmann | in mebibytes to allow parsing by scripts. In both cases, the |
790 | 4007f57d | Michael Hanselmann | <option>--units</option> option can be used to enforce a given output |
791 | 4007f57d | Michael Hanselmann | unit. |
792 | 4007f57d | Michael Hanselmann | </para> |
793 | 4007f57d | Michael Hanselmann | |
794 | 4007f57d | Michael Hanselmann | <para> |
795 | 53548798 | Michael Hanselmann | The <option>--storage-type</option> option can be used to choose a |
796 | 53548798 | Michael Hanselmann | storage unit type. Possible choices are <literal>lvm-pv</literal>, |
797 | 53548798 | Michael Hanselmann | <literal>lvm-vg</literal> or <literal>file</literal>. Depending on the |
798 | 53548798 | Michael Hanselmann | storage type, the available output fields change. |
799 | 53548798 | Michael Hanselmann | </para> |
800 | 53548798 | Michael Hanselmann | |
801 | 53548798 | Michael Hanselmann | <para> |
802 | 4007f57d | Michael Hanselmann | The <option>-o</option> option takes a comma-separated list of |
803 | 4007f57d | Michael Hanselmann | output fields. The available fields and their meaning are: |
804 | 4007f57d | Michael Hanselmann | <variablelist> |
805 | 4007f57d | Michael Hanselmann | <varlistentry> |
806 | 4007f57d | Michael Hanselmann | <term>node</term> |
807 | 4007f57d | Michael Hanselmann | <listitem> |
808 | 4007f57d | Michael Hanselmann | <simpara>the node name on which the volume exists</simpara> |
809 | 4007f57d | Michael Hanselmann | </listitem> |
810 | 4007f57d | Michael Hanselmann | </varlistentry> |
811 | 4007f57d | Michael Hanselmann | <varlistentry> |
812 | 4007f57d | Michael Hanselmann | <term>name</term> |
813 | 4007f57d | Michael Hanselmann | <listitem> |
814 | 4007f57d | Michael Hanselmann | <simpara>the physical drive name</simpara> |
815 | 4007f57d | Michael Hanselmann | </listitem> |
816 | 4007f57d | Michael Hanselmann | </varlistentry> |
817 | 4007f57d | Michael Hanselmann | <varlistentry> |
818 | 4007f57d | Michael Hanselmann | <term>size</term> |
819 | 4007f57d | Michael Hanselmann | <listitem> |
820 | 53548798 | Michael Hanselmann | <simpara> |
821 | 53548798 | Michael Hanselmann | the physical drive size |
822 | 53548798 | Michael Hanselmann | (<literal>lvm-pv</literal> and <literal>lvm-vg</literal> only) |
823 | 53548798 | Michael Hanselmann | </simpara> |
824 | 4007f57d | Michael Hanselmann | </listitem> |
825 | 4007f57d | Michael Hanselmann | </varlistentry> |
826 | 4007f57d | Michael Hanselmann | <varlistentry> |
827 | 4007f57d | Michael Hanselmann | <term>used</term> |
828 | 4007f57d | Michael Hanselmann | <listitem> |
829 | 53548798 | Michael Hanselmann | <simpara> |
830 | 53548798 | Michael Hanselmann | used disk space |
831 | 53548798 | Michael Hanselmann | (<literal>lvm-pv</literal> and <literal>file</literal> only) |
832 | 53548798 | Michael Hanselmann | </simpara> |
833 | 4007f57d | Michael Hanselmann | </listitem> |
834 | 4007f57d | Michael Hanselmann | </varlistentry> |
835 | 4007f57d | Michael Hanselmann | <varlistentry> |
836 | 4007f57d | Michael Hanselmann | <term>free</term> |
837 | 4007f57d | Michael Hanselmann | <listitem> |
838 | 53548798 | Michael Hanselmann | <simpara> |
839 | 53548798 | Michael Hanselmann | available disk space |
840 | 53548798 | Michael Hanselmann | (<literal>lvm-pv</literal> and <literal>file</literal> only) |
841 | 53548798 | Michael Hanselmann | </simpara> |
842 | 4007f57d | Michael Hanselmann | </listitem> |
843 | 4007f57d | Michael Hanselmann | </varlistentry> |
844 | 4007f57d | Michael Hanselmann | <varlistentry> |
845 | 4007f57d | Michael Hanselmann | <term>allocatable</term> |
846 | 4007f57d | Michael Hanselmann | <listitem> |
847 | 53548798 | Michael Hanselmann | <simpara> |
848 | 53548798 | Michael Hanselmann | whether physical volume is allocatable |
849 | 53548798 | Michael Hanselmann | (<literal>lvm-pv</literal> only) |
850 | 53548798 | Michael Hanselmann | </simpara> |
851 | 4007f57d | Michael Hanselmann | </listitem> |
852 | 4007f57d | Michael Hanselmann | </varlistentry> |
853 | 4007f57d | Michael Hanselmann | </variablelist> |
854 | 4007f57d | Michael Hanselmann | </para> |
855 | 4007f57d | Michael Hanselmann | |
856 | 4007f57d | Michael Hanselmann | <para> |
857 | 4007f57d | Michael Hanselmann | Example: |
858 | 4007f57d | Michael Hanselmann | <screen> |
859 | 9b94905f | Iustin Pop | # gnt-node list-storage node5.example.com |
860 | 4007f57d | Michael Hanselmann | Node Name Size Used Free |
861 | 4007f57d | Michael Hanselmann | node5.example.com /dev/sda7 673.8G 0M 673.8G |
862 | 4007f57d | Michael Hanselmann | node5.example.com /dev/sdb1 698.6G 1.3G 697.4G |
863 | 4007f57d | Michael Hanselmann | </screen> |
864 | 4007f57d | Michael Hanselmann | </para> |
865 | 4007f57d | Michael Hanselmann | </refsect2> |
866 | 4007f57d | Michael Hanselmann | |
867 | 4007f57d | Michael Hanselmann | <refsect2> |
868 | 9b94905f | Iustin Pop | <title>MODIFY-STORAGE</title> |
869 | 0e89fc2d | Michael Hanselmann | |
870 | 0e89fc2d | Michael Hanselmann | <cmdsynopsis> |
871 | 9b94905f | Iustin Pop | <command>modify-storage</command> |
872 | 0e89fc2d | Michael Hanselmann | <arg><option>--allocatable=yes|no</option></arg> |
873 | 0e89fc2d | Michael Hanselmann | <sbr> |
874 | 0e89fc2d | Michael Hanselmann | <arg><replaceable>node</replaceable></arg> |
875 | 0e89fc2d | Michael Hanselmann | <arg><replaceable>storage-type</replaceable></arg> |
876 | 0e89fc2d | Michael Hanselmann | <arg><replaceable>volume-name</replaceable></arg> |
877 | 0e89fc2d | Michael Hanselmann | </cmdsynopsis> |
878 | 0e89fc2d | Michael Hanselmann | |
879 | 0e89fc2d | Michael Hanselmann | <para> |
880 | 9b94905f | Iustin Pop | Modifies storage volumes on a node. Only LVM physical volumes |
881 | 9b94905f | Iustin Pop | can be modified at the moment. They have a storage type |
882 | 9b94905f | Iustin Pop | of <quote>lvm-pv</quote>. |
883 | 0e89fc2d | Michael Hanselmann | </para> |
884 | 0e89fc2d | Michael Hanselmann | |
885 | 0e89fc2d | Michael Hanselmann | <para> |
886 | 0e89fc2d | Michael Hanselmann | Example: |
887 | 0e89fc2d | Michael Hanselmann | <screen> |
888 | 9b94905f | Iustin Pop | # gnt-node modify-storage --allocatable no node5.example.com lvm-pv /dev/sdb1 |
889 | 0e89fc2d | Michael Hanselmann | </screen> |
890 | 0e89fc2d | Michael Hanselmann | </para> |
891 | 0e89fc2d | Michael Hanselmann | </refsect2> |
892 | 0e89fc2d | Michael Hanselmann | |
893 | 0e89fc2d | Michael Hanselmann | <refsect2> |
894 | 9b94905f | Iustin Pop | <title>REPAIR-STORAGE</title> |
895 | 1e3463f1 | Michael Hanselmann | |
896 | 1e3463f1 | Michael Hanselmann | <cmdsynopsis> |
897 | 9b94905f | Iustin Pop | <command>repair-storage</command> |
898 | 1e3463f1 | Michael Hanselmann | <arg><replaceable>node</replaceable></arg> |
899 | 1e3463f1 | Michael Hanselmann | <arg><replaceable>storage-type</replaceable></arg> |
900 | 1e3463f1 | Michael Hanselmann | <arg><replaceable>volume-name</replaceable></arg> |
901 | 1e3463f1 | Michael Hanselmann | </cmdsynopsis> |
902 | 1e3463f1 | Michael Hanselmann | |
903 | 1e3463f1 | Michael Hanselmann | <para> |
904 | 9b94905f | Iustin Pop | Repairs a storage volume on a node. Only LVM volume groups can |
905 | 9b94905f | Iustin Pop | be repaired at this time. They have the storage type |
906 | 1e3463f1 | Michael Hanselmann | <quote>lvm-vg</quote>. |
907 | 1e3463f1 | Michael Hanselmann | </para> |
908 | 1e3463f1 | Michael Hanselmann | |
909 | 1e3463f1 | Michael Hanselmann | <para> |
910 | 1e3463f1 | Michael Hanselmann | On LVM volume groups, <command>repair-volume</command> runs |
911 | 1e3463f1 | Michael Hanselmann | <quote>vgreduce --removemissing</quote>. |
912 | 1e3463f1 | Michael Hanselmann | </para> |
913 | 1e3463f1 | Michael Hanselmann | |
914 | 1e3463f1 | Michael Hanselmann | <caution> |
915 | 1e3463f1 | Michael Hanselmann | <para> |
916 | 1e3463f1 | Michael Hanselmann | Running this command can lead to data loss. Use it with care. |
917 | 1e3463f1 | Michael Hanselmann | </para> |
918 | 1e3463f1 | Michael Hanselmann | </caution> |
919 | 1e3463f1 | Michael Hanselmann | |
920 | 1e3463f1 | Michael Hanselmann | <para> |
921 | 1e3463f1 | Michael Hanselmann | Example: |
922 | 1e3463f1 | Michael Hanselmann | <screen> |
923 | 9b94905f | Iustin Pop | # gnt-node repair-storage node5.example.com lvm-vg xenvg |
924 | 1e3463f1 | Michael Hanselmann | </screen> |
925 | 1e3463f1 | Michael Hanselmann | </para> |
926 | 1e3463f1 | Michael Hanselmann | </refsect2> |
927 | 1e3463f1 | Michael Hanselmann | |
928 | 1e3463f1 | Michael Hanselmann | <refsect2> |
929 | f5118ade | Iustin Pop | <title>POWERCYCLE</title> |
930 | f5118ade | Iustin Pop | |
931 | f5118ade | Iustin Pop | <cmdsynopsis> |
932 | f5118ade | Iustin Pop | <command>powercycle</command> |
933 | f5118ade | Iustin Pop | <arg><option>--confirm</option></arg> |
934 | f5118ade | Iustin Pop | <arg><option>--force</option></arg> |
935 | f5118ade | Iustin Pop | <arg choice="req"><replaceable>node</replaceable></arg> |
936 | f5118ade | Iustin Pop | </cmdsynopsis> |
937 | f5118ade | Iustin Pop | |
938 | f5118ade | Iustin Pop | <para> |
939 | f5118ade | Iustin Pop | This commands (tries to) forcefully reboot a node. It is a |
940 | f5118ade | Iustin Pop | command that can be used if the node environemnt is broken, |
941 | f5118ade | Iustin Pop | such that the admin can no longer login over ssh, but the |
942 | f5118ade | Iustin Pop | ganeti node daemon is still working. |
943 | f5118ade | Iustin Pop | </para> |
944 | f5118ade | Iustin Pop | |
945 | f5118ade | Iustin Pop | <para> |
946 | f5118ade | Iustin Pop | Note that this command is not guaranteed to work; it depends |
947 | f5118ade | Iustin Pop | on the hypervisor how effective is the reboot attempt. For |
948 | f5118ade | Iustin Pop | Linux, this command require that the kernel option |
949 | f5118ade | Iustin Pop | <literal>CONFIG_MAGIC_SYSRQ</literal> is enabled. |
950 | f5118ade | Iustin Pop | </para> |
951 | f5118ade | Iustin Pop | |
952 | f5118ade | Iustin Pop | <para> |
953 | f5118ade | Iustin Pop | The <option>--yes</option> option can be used to skip |
954 | f5118ade | Iustin Pop | confirmation, while the <option>--force</option> option is |
955 | f5118ade | Iustin Pop | needed if the target node is the master node. |
956 | f5118ade | Iustin Pop | </para> |
957 | f5118ade | Iustin Pop | |
958 | a8083063 | Iustin Pop | </refsect1> |
959 | a8083063 | Iustin Pop | |
960 | a8083063 | Iustin Pop | &footer; |
961 | a8083063 | Iustin Pop | |
962 | a8083063 | Iustin Pop | </refentry> |
963 | a8083063 | Iustin Pop | |
964 | a8083063 | Iustin Pop | <!-- Keep this comment at the end of the file |
965 | a8083063 | Iustin Pop | Local variables: |
966 | a8083063 | Iustin Pop | mode: sgml |
967 | a8083063 | Iustin Pop | sgml-omittag:t |
968 | a8083063 | Iustin Pop | sgml-shorttag:t |
969 | a8083063 | Iustin Pop | sgml-minimize-attributes:nil |
970 | a8083063 | Iustin Pop | sgml-always-quote-attributes:t |
971 | a8083063 | Iustin Pop | sgml-indent-step:2 |
972 | a8083063 | Iustin Pop | sgml-indent-data:t |
973 | a8083063 | Iustin Pop | sgml-parent-document:nil |
974 | a8083063 | Iustin Pop | sgml-default-dtd-file:nil |
975 | a8083063 | Iustin Pop | sgml-exposed-tags:nil |
976 | a8083063 | Iustin Pop | sgml-local-catalogs:nil |
977 | a8083063 | Iustin Pop | sgml-local-ecat-files:nil |
978 | a8083063 | Iustin Pop | End: |
979 | a8083063 | Iustin Pop | --> |