root / man / gnt-instance.sgml @ 1abbbbe2
History | View | Annotate | Download (37.4 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 | a8083063 | Iustin Pop | <!ENTITY dhdate "<date>May 16, 2007</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-instance</refentrytitle>"> |
10 | a8083063 | Iustin Pop | <!ENTITY dhpackage "gnt-instance"> |
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 | a8083063 | Iustin Pop | <holder>Google Inc.</holder> |
24 | a8083063 | Iustin Pop | </copyright> |
25 | a8083063 | Iustin Pop | &dhdate; |
26 | a8083063 | Iustin Pop | </refentryinfo> |
27 | a8083063 | Iustin Pop | <refmeta> |
28 | a8083063 | Iustin Pop | &dhucpackage; |
29 | a8083063 | Iustin Pop | |
30 | a8083063 | Iustin Pop | &dhsection; |
31 | a8083063 | Iustin Pop | <refmiscinfo>ganeti 1.2</refmiscinfo> |
32 | a8083063 | Iustin Pop | </refmeta> |
33 | a8083063 | Iustin Pop | <refnamediv> |
34 | a8083063 | Iustin Pop | <refname>&dhpackage;</refname> |
35 | a8083063 | Iustin Pop | |
36 | a8083063 | Iustin Pop | <refpurpose>ganeti instance administration</refpurpose> |
37 | a8083063 | Iustin Pop | </refnamediv> |
38 | a8083063 | Iustin Pop | <refsynopsisdiv> |
39 | a8083063 | Iustin Pop | <cmdsynopsis> |
40 | a8083063 | Iustin Pop | <command>&dhpackage; </command> |
41 | a8083063 | Iustin Pop | |
42 | a8083063 | Iustin Pop | <arg choice="req">command</arg> |
43 | a8083063 | Iustin Pop | <arg>arguments...</arg> |
44 | a8083063 | Iustin Pop | </cmdsynopsis> |
45 | a8083063 | Iustin Pop | </refsynopsisdiv> |
46 | a8083063 | Iustin Pop | <refsect1> |
47 | a8083063 | Iustin Pop | <title>DESCRIPTION</title> |
48 | a8083063 | Iustin Pop | |
49 | a8083063 | Iustin Pop | <para> |
50 | a8083063 | Iustin Pop | The <command>&dhpackage;</command> is used for instance |
51 | a8083063 | Iustin Pop | administration in the ganeti system. |
52 | a8083063 | Iustin Pop | </para> |
53 | a8083063 | Iustin Pop | |
54 | a8083063 | Iustin Pop | </refsect1> |
55 | a8083063 | Iustin Pop | <refsect1> |
56 | a8083063 | Iustin Pop | <title>COMMANDS</title> |
57 | a8083063 | Iustin Pop | |
58 | a8083063 | Iustin Pop | <refsect2> |
59 | a8083063 | Iustin Pop | <title>Creation/removal/querying</title> |
60 | a8083063 | Iustin Pop | |
61 | a8083063 | Iustin Pop | <refsect3> |
62 | a8083063 | Iustin Pop | <title>ADD</title> |
63 | a8083063 | Iustin Pop | <cmdsynopsis> |
64 | a8083063 | Iustin Pop | <command>add</command> |
65 | a8083063 | Iustin Pop | <arg>-s <replaceable>disksize</replaceable></arg> |
66 | b9ac33e9 | Iustin Pop | <arg>--swap-size <replaceable>disksize</replaceable></arg> |
67 | a8083063 | Iustin Pop | <arg>-m <replaceable>memsize</replaceable></arg> |
68 | b9ac33e9 | Iustin Pop | <sbr> |
69 | b9ac33e9 | Iustin Pop | <arg>-o <replaceable>os-type</replaceable></arg> |
70 | a8083063 | Iustin Pop | <arg>-b <replaceable>bridge</replaceable></arg> |
71 | f3a55c90 | Alexander Schreiber | <arg>--mac <replaceable>MAC-address</replaceable></arg> |
72 | 25c5878d | Alexander Schreiber | <arg>--hvm-boot-order <replaceable>boot-order</replaceable></arg> |
73 | a8083063 | Iustin Pop | <sbr> |
74 | 00f98619 | Iustin Pop | <arg>--kernel <group choice="req"> |
75 | 00f98619 | Iustin Pop | <arg>default</arg> |
76 | 00f98619 | Iustin Pop | <arg><replaceable>kernel_path</replaceable></arg> |
77 | 00f98619 | Iustin Pop | </group></arg> |
78 | 00f98619 | Iustin Pop | <sbr> |
79 | 00f98619 | Iustin Pop | <arg>--initrd <group choice="req"> |
80 | 00f98619 | Iustin Pop | <arg>default</arg> |
81 | 00f98619 | Iustin Pop | <arg>none</arg> |
82 | 00f98619 | Iustin Pop | <arg><replaceable>initrd_path</replaceable></arg> |
83 | 00f98619 | Iustin Pop | </group> </arg> |
84 | 00f98619 | Iustin Pop | <sbr> |
85 | a8083063 | Iustin Pop | <arg choice="req">-t<group> |
86 | a8083063 | Iustin Pop | <arg>diskless</arg> |
87 | a8083063 | Iustin Pop | <arg>plain</arg> |
88 | a8083063 | Iustin Pop | <arg>local_raid1</arg> |
89 | a8083063 | Iustin Pop | <arg>remote_raid1</arg> |
90 | f69dab6d | Iustin Pop | <arg>drbd</arg> |
91 | a8083063 | Iustin Pop | </group> |
92 | a8083063 | Iustin Pop | </arg> |
93 | b9ac33e9 | Iustin Pop | <sbr> |
94 | 4677a909 | Michael Hanselmann | <arg choice="req">-n <replaceable>node<optional>:secondary-node</optional></replaceable></arg> |
95 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
96 | a8083063 | Iustin Pop | </cmdsynopsis> |
97 | 00f98619 | Iustin Pop | |
98 | a8083063 | Iustin Pop | <para> |
99 | a8083063 | Iustin Pop | Creates a new instance on the specified |
100 | a8083063 | Iustin Pop | host. <replaceable>instance</replaceable> must be in DNS and |
101 | a8083063 | Iustin Pop | resolve to a IP in the same network as the nodes in the |
102 | a8083063 | Iustin Pop | cluster. |
103 | a8083063 | Iustin Pop | </para> |
104 | a8083063 | Iustin Pop | |
105 | a8083063 | Iustin Pop | <para> |
106 | a8083063 | Iustin Pop | The <option>-s</option> option specifies the disk size for |
107 | b9ac33e9 | Iustin Pop | the instance, in mebibytes (defaults to |
108 | b9ac33e9 | Iustin Pop | <constant>20480MiB</constant> = |
109 | b9ac33e9 | Iustin Pop | <constant>20GiB</constant>). You can also use one of the |
110 | b9ac33e9 | Iustin Pop | suffixes <literal>m</literal>, <literal>g</literal> or |
111 | b9ac33e9 | Iustin Pop | <literal>t</literal> to specificy the exact the units used; |
112 | b9ac33e9 | Iustin Pop | these suffixes map to mebibytes, gibibytes and tebibytes. |
113 | a8083063 | Iustin Pop | </para> |
114 | a8083063 | Iustin Pop | |
115 | a8083063 | Iustin Pop | <para> |
116 | b9ac33e9 | Iustin Pop | The <option>--swap-size</option> option specifies the swap |
117 | b9ac33e9 | Iustin Pop | disk size (in mebibytes) for the instance (the one presented |
118 | b9ac33e9 | Iustin Pop | as <filename class="devicefile">/dev/sdb</filename>). The |
119 | b9ac33e9 | Iustin Pop | default is <constant>4096MiB</constant>. As for the disk |
120 | b9ac33e9 | Iustin Pop | size, you can specify other suffixes. |
121 | a8083063 | Iustin Pop | </para> |
122 | a8083063 | Iustin Pop | |
123 | a8083063 | Iustin Pop | <para> |
124 | a8083063 | Iustin Pop | The <option>-m</option> option specifies the memory size for |
125 | b9ac33e9 | Iustin Pop | the instance, in mebibytes (defaults to 128 MiB). Again, you |
126 | b9ac33e9 | Iustin Pop | can use other suffixes (e.g. <userinput>2g</userinput>). |
127 | b9ac33e9 | Iustin Pop | </para> |
128 | b9ac33e9 | Iustin Pop | |
129 | b9ac33e9 | Iustin Pop | <para> |
130 | b9ac33e9 | Iustin Pop | The <option>-o</option> options specifies the operating |
131 | b9ac33e9 | Iustin Pop | system to be installed. The available operating systems can |
132 | b9ac33e9 | Iustin Pop | be listed with <command>gnt-os list</command>. |
133 | a8083063 | Iustin Pop | </para> |
134 | a8083063 | Iustin Pop | |
135 | a8083063 | Iustin Pop | <para> |
136 | a8083063 | Iustin Pop | The <option>-b</option> option specifies the bridge to which the |
137 | a8083063 | Iustin Pop | instance will be connected. (defaults to the cluster-wide default |
138 | 7e84d392 | Michael Hanselmann | bridge specified at cluster initialization time). |
139 | a8083063 | Iustin Pop | </para> |
140 | a8083063 | Iustin Pop | |
141 | a8083063 | Iustin Pop | <para> |
142 | f3a55c90 | Alexander Schreiber | The <option>--mac</option> option specifies the MAC address |
143 | f3a55c90 | Alexander Schreiber | of the ethernet interface for the instance. If this option |
144 | f3a55c90 | Alexander Schreiber | is not specified, a new MAC address is generated randomly with |
145 | f3a55c90 | Alexander Schreiber | the configured MAC prefix. The randomly generated MAC |
146 | f3a55c90 | Alexander Schreiber | address is guaranteed to be unique among the instances of |
147 | f3a55c90 | Alexander Schreiber | this cluster. |
148 | f3a55c90 | Alexander Schreiber | </para> |
149 | f3a55c90 | Alexander Schreiber | |
150 | f3a55c90 | Alexander Schreiber | <para> |
151 | 25c5878d | Alexander Schreiber | The <option>--hvm-boot-order</option> option specifies the |
152 | 25c5878d | Alexander Schreiber | boot device order for Xen HVM instances. The boot order is a |
153 | 25c5878d | Alexander Schreiber | string of letters listing the boot devices, with valid |
154 | 25c5878d | Alexander Schreiber | device letters being: |
155 | 25c5878d | Alexander Schreiber | </para> |
156 | 25c5878d | Alexander Schreiber | |
157 | 25c5878d | Alexander Schreiber | <para> |
158 | 25c5878d | Alexander Schreiber | <variablelist> |
159 | 25c5878d | Alexander Schreiber | <varlistentry> |
160 | 25c5878d | Alexander Schreiber | <term>a</term> |
161 | 25c5878d | Alexander Schreiber | <listitem> |
162 | 25c5878d | Alexander Schreiber | <para> |
163 | 25c5878d | Alexander Schreiber | floppy drive |
164 | 25c5878d | Alexander Schreiber | </para> |
165 | 25c5878d | Alexander Schreiber | </listitem> |
166 | 25c5878d | Alexander Schreiber | </varlistentry> |
167 | 25c5878d | Alexander Schreiber | <varlistentry> |
168 | 25c5878d | Alexander Schreiber | <term>c</term> |
169 | 25c5878d | Alexander Schreiber | <listitem> |
170 | 25c5878d | Alexander Schreiber | <para> |
171 | 25c5878d | Alexander Schreiber | hard disk |
172 | 25c5878d | Alexander Schreiber | </para> |
173 | 25c5878d | Alexander Schreiber | </listitem> |
174 | 25c5878d | Alexander Schreiber | </varlistentry> |
175 | 25c5878d | Alexander Schreiber | <varlistentry> |
176 | 25c5878d | Alexander Schreiber | <term>d</term> |
177 | 25c5878d | Alexander Schreiber | <listitem> |
178 | 25c5878d | Alexander Schreiber | <para> |
179 | 25c5878d | Alexander Schreiber | CDROM drive |
180 | 25c5878d | Alexander Schreiber | </para> |
181 | 25c5878d | Alexander Schreiber | </listitem> |
182 | 25c5878d | Alexander Schreiber | </varlistentry> |
183 | 25c5878d | Alexander Schreiber | <varlistentry> |
184 | 25c5878d | Alexander Schreiber | <term>n</term> |
185 | 25c5878d | Alexander Schreiber | <listitem> |
186 | 25c5878d | Alexander Schreiber | <para> |
187 | 25c5878d | Alexander Schreiber | network boot (PXE) |
188 | 25c5878d | Alexander Schreiber | </para> |
189 | 25c5878d | Alexander Schreiber | </listitem> |
190 | 25c5878d | Alexander Schreiber | </varlistentry> |
191 | 25c5878d | Alexander Schreiber | </variablelist> |
192 | 25c5878d | Alexander Schreiber | </para> |
193 | 25c5878d | Alexander Schreiber | |
194 | 25c5878d | Alexander Schreiber | <para> |
195 | 25c5878d | Alexander Schreiber | The option is only relevant for Xen HVM instances and |
196 | 25c5878d | Alexander Schreiber | ignored by all other instances types. |
197 | 25c5878d | Alexander Schreiber | </para> |
198 | 25c5878d | Alexander Schreiber | |
199 | 25c5878d | Alexander Schreiber | <para> |
200 | 00f98619 | Iustin Pop | The <option>--kernel</option> options allows the instance to |
201 | 00f98619 | Iustin Pop | use a custom kernel (if a filename is passed) or to use the |
202 | 00f98619 | Iustin Pop | default kernel (<filename>@CUSTOM_XEN_KERNEL@</filename>), if the |
203 | 00f98619 | Iustin Pop | string <constant>default</constant> is passed. |
204 | 00f98619 | Iustin Pop | </para> |
205 | 00f98619 | Iustin Pop | |
206 | 00f98619 | Iustin Pop | <para> |
207 | 00f98619 | Iustin Pop | The <option>--initrd</option> option is similar: it allows |
208 | 00f98619 | Iustin Pop | the instance to use a custom initrd (if a filename is |
209 | 00f98619 | Iustin Pop | passed) or to use the default initrd |
210 | 00f98619 | Iustin Pop | (<filename>@CUSTOM_XEN_INITRD@</filename>), if the string |
211 | 00f98619 | Iustin Pop | <constant>default</constant> is passed, or to disable the |
212 | 00f98619 | Iustin Pop | use of an initrd, if the string <constant>none</constant> is |
213 | 00f98619 | Iustin Pop | passed. Note that in the case the instance is set to use the |
214 | 00f98619 | Iustin Pop | default initrd and it doesn't exist, it will be silently |
215 | 00f98619 | Iustin Pop | ignored; if the instance is set to use a custom initrd and |
216 | 00f98619 | Iustin Pop | it doesn't exist, this will be treated as an error and will |
217 | 00f98619 | Iustin Pop | prevent the startup of the instance. |
218 | 00f98619 | Iustin Pop | </para> |
219 | 00f98619 | Iustin Pop | |
220 | 00f98619 | Iustin Pop | <para> |
221 | a8083063 | Iustin Pop | The <option>-t</option> options specifies the disk layout type for |
222 | a8083063 | Iustin Pop | the instance. The available choices are: |
223 | a8083063 | Iustin Pop | <variablelist> |
224 | a8083063 | Iustin Pop | <varlistentry> |
225 | a8083063 | Iustin Pop | <term>diskless</term> |
226 | a8083063 | Iustin Pop | <listitem> |
227 | a8083063 | Iustin Pop | <para> |
228 | a8083063 | Iustin Pop | This creates an instance with no disks. Its useful for |
229 | a8083063 | Iustin Pop | testing only (or other special cases). |
230 | a8083063 | Iustin Pop | </para> |
231 | a8083063 | Iustin Pop | </listitem> |
232 | a8083063 | Iustin Pop | </varlistentry> |
233 | a8083063 | Iustin Pop | <varlistentry> |
234 | a8083063 | Iustin Pop | <term>plain</term> |
235 | a8083063 | Iustin Pop | <listitem> |
236 | a8083063 | Iustin Pop | <para>Disk devices will be logical volumes.</para> |
237 | a8083063 | Iustin Pop | </listitem> |
238 | a8083063 | Iustin Pop | </varlistentry> |
239 | a8083063 | Iustin Pop | <varlistentry> |
240 | a8083063 | Iustin Pop | <term>local_raid1</term> |
241 | a8083063 | Iustin Pop | <listitem> |
242 | a8083063 | Iustin Pop | <para> |
243 | a8083063 | Iustin Pop | Disk devices will be md raid1 arrays over two local |
244 | a8083063 | Iustin Pop | logical volumes. |
245 | a8083063 | Iustin Pop | </para> |
246 | a8083063 | Iustin Pop | </listitem> |
247 | a8083063 | Iustin Pop | </varlistentry> |
248 | a8083063 | Iustin Pop | <varlistentry> |
249 | a8083063 | Iustin Pop | <term>remote_raid1</term> |
250 | a8083063 | Iustin Pop | <listitem> |
251 | a8083063 | Iustin Pop | <para> |
252 | f69dab6d | Iustin Pop | Disk devices will be md raid1 arrays with one |
253 | f69dab6d | Iustin Pop | component (so it's not actually raid1): a drbd |
254 | f69dab6d | Iustin Pop | (0.7.x) device between the instance's primary node |
255 | f69dab6d | Iustin Pop | and the node given by the second value of the |
256 | f69dab6d | Iustin Pop | <option>--node</option> option. |
257 | f69dab6d | Iustin Pop | </para> |
258 | f69dab6d | Iustin Pop | </listitem> |
259 | f69dab6d | Iustin Pop | </varlistentry> |
260 | f69dab6d | Iustin Pop | <varlistentry> |
261 | f69dab6d | Iustin Pop | <term>drbd</term> |
262 | f69dab6d | Iustin Pop | <listitem> |
263 | f69dab6d | Iustin Pop | <para> |
264 | f69dab6d | Iustin Pop | Disk devices will be drbd (version 8.x) on top of |
265 | f69dab6d | Iustin Pop | lvm volumes. They are equivalent in functionality to |
266 | f69dab6d | Iustin Pop | <replaceable>remote_raid1</replaceable>, but are |
267 | f69dab6d | Iustin Pop | recommended for new instances (if you have drbd 8.x |
268 | f69dab6d | Iustin Pop | installed). |
269 | a8083063 | Iustin Pop | </para> |
270 | a8083063 | Iustin Pop | </listitem> |
271 | a8083063 | Iustin Pop | </varlistentry> |
272 | a8083063 | Iustin Pop | </variablelist> |
273 | a8083063 | Iustin Pop | </para> |
274 | a8083063 | Iustin Pop | |
275 | a8083063 | Iustin Pop | <para> |
276 | 4677a909 | Michael Hanselmann | The optional second value of the <option>--node</option> is used for |
277 | 4677a909 | Michael Hanselmann | the remote raid template type and specifies the remote node. |
278 | a8083063 | Iustin Pop | </para> |
279 | a8083063 | Iustin Pop | |
280 | a8083063 | Iustin Pop | <para> |
281 | a8083063 | Iustin Pop | If you do not want gnt-instance to wait for the disk mirror |
282 | a8083063 | Iustin Pop | to be synced, use the <option>--no-wait-for-sync</option> |
283 | a8083063 | Iustin Pop | option. |
284 | a8083063 | Iustin Pop | </para> |
285 | a8083063 | Iustin Pop | |
286 | a8083063 | Iustin Pop | <para> |
287 | a8083063 | Iustin Pop | Example: |
288 | a8083063 | Iustin Pop | <screen> |
289 | b9ac33e9 | Iustin Pop | # gnt-instance add -t plain -s 30g -m 512 -o debian-etch \ |
290 | b9ac33e9 | Iustin Pop | -n node1.example.com instance1.example.com |
291 | 4677a909 | Michael Hanselmann | # gnt-instance add -t remote_raid1 -s 30g -m 512 -o debian-etch \ |
292 | 4677a909 | Michael Hanselmann | -n node1.example.com:node2.example.com instance2.example.com |
293 | a8083063 | Iustin Pop | </screen> |
294 | a8083063 | Iustin Pop | </para> |
295 | a8083063 | Iustin Pop | </refsect3> |
296 | a8083063 | Iustin Pop | |
297 | a8083063 | Iustin Pop | <refsect3> |
298 | a8083063 | Iustin Pop | <title>REMOVE</title> |
299 | a8083063 | Iustin Pop | |
300 | a8083063 | Iustin Pop | <cmdsynopsis> |
301 | a8083063 | Iustin Pop | <command>remove</command> |
302 | 1d67656e | Iustin Pop | <arg>--ignore-failures</arg> |
303 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
304 | a8083063 | Iustin Pop | </cmdsynopsis> |
305 | a8083063 | Iustin Pop | |
306 | a8083063 | Iustin Pop | <para> |
307 | a8083063 | Iustin Pop | Remove an instance. This will remove all data from the |
308 | a8083063 | Iustin Pop | instance and there is <emphasis>no way back</emphasis>. If |
309 | a8083063 | Iustin Pop | you are not sure if you use an instance again, use |
310 | a8083063 | Iustin Pop | <command>shutdown</command> first and leave it in the |
311 | a8083063 | Iustin Pop | shutdown state for a while. |
312 | 1d67656e | Iustin Pop | |
313 | 1d67656e | Iustin Pop | </para> |
314 | 1d67656e | Iustin Pop | |
315 | 1d67656e | Iustin Pop | <para> |
316 | 1d67656e | Iustin Pop | The <option>--ignore-failures</option> option will cause the |
317 | 1d67656e | Iustin Pop | removal to proceed even in the presence of errors during the |
318 | 1d67656e | Iustin Pop | removal of the instance (e.g. during the shutdown or the |
319 | 1d67656e | Iustin Pop | disk removal). If this option is not given, the command will |
320 | 1d67656e | Iustin Pop | stop at the first error. |
321 | a8083063 | Iustin Pop | </para> |
322 | a8083063 | Iustin Pop | |
323 | a8083063 | Iustin Pop | <para> |
324 | a8083063 | Iustin Pop | Example: |
325 | a8083063 | Iustin Pop | <screen> |
326 | a8083063 | Iustin Pop | # gnt-instance remove instance1.example.com |
327 | a8083063 | Iustin Pop | </screen> |
328 | a8083063 | Iustin Pop | </para> |
329 | a8083063 | Iustin Pop | </refsect3> |
330 | a8083063 | Iustin Pop | |
331 | a8083063 | Iustin Pop | <refsect3> |
332 | a8083063 | Iustin Pop | <title>LIST</title> |
333 | a8083063 | Iustin Pop | |
334 | a8083063 | Iustin Pop | <cmdsynopsis> |
335 | a8083063 | Iustin Pop | <command>list</command> |
336 | a8083063 | Iustin Pop | <arg>--no-headers</arg> |
337 | a8083063 | Iustin Pop | <arg>--separator=<replaceable>SEPARATOR</replaceable></arg> |
338 | a8083063 | Iustin Pop | <arg>-o <replaceable>FIELD,...</replaceable></arg> |
339 | a8083063 | Iustin Pop | </cmdsynopsis> |
340 | a8083063 | Iustin Pop | |
341 | a8083063 | Iustin Pop | <para> |
342 | a8083063 | Iustin Pop | Shows the currently configured instances with memory usage, |
343 | a8083063 | Iustin Pop | disk usage, the node they are running on, and the CPU time, |
344 | a8083063 | Iustin Pop | counted in seconds, used by each instance since its latest |
345 | a8083063 | Iustin Pop | restart. |
346 | a8083063 | Iustin Pop | </para> |
347 | a8083063 | Iustin Pop | |
348 | a8083063 | Iustin Pop | <para> |
349 | a8083063 | Iustin Pop | The <option>--no-headers</option> option will skip the |
350 | a8083063 | Iustin Pop | initial header line. The <option>--separator</option> option |
351 | a8083063 | Iustin Pop | takes an argument which denotes what will be used between |
352 | a8083063 | Iustin Pop | the output fields. Both these options are to help scripting. |
353 | a8083063 | Iustin Pop | </para> |
354 | a8083063 | Iustin Pop | |
355 | a8083063 | Iustin Pop | <para> |
356 | a8083063 | Iustin Pop | The <option>-o</option> option takes a comma-separated list |
357 | a8083063 | Iustin Pop | of output fields. The available fields and their meaning |
358 | a8083063 | Iustin Pop | are: |
359 | a8083063 | Iustin Pop | <variablelist> |
360 | a8083063 | Iustin Pop | <varlistentry> |
361 | a8083063 | Iustin Pop | <term>name</term> |
362 | a8083063 | Iustin Pop | <listitem> |
363 | a8083063 | Iustin Pop | <simpara>the instance name</simpara> |
364 | a8083063 | Iustin Pop | </listitem> |
365 | a8083063 | Iustin Pop | </varlistentry> |
366 | a8083063 | Iustin Pop | <varlistentry> |
367 | a8083063 | Iustin Pop | <term>os</term> |
368 | a8083063 | Iustin Pop | <listitem> |
369 | a8083063 | Iustin Pop | <simpara>the OS of the instance</simpara> |
370 | a8083063 | Iustin Pop | </listitem> |
371 | a8083063 | Iustin Pop | </varlistentry> |
372 | a8083063 | Iustin Pop | <varlistentry> |
373 | a8083063 | Iustin Pop | <term>pnode</term> |
374 | a8083063 | Iustin Pop | <listitem> |
375 | a8083063 | Iustin Pop | <simpara>the primary node of the instance</simpara> |
376 | a8083063 | Iustin Pop | </listitem> |
377 | a8083063 | Iustin Pop | </varlistentry> |
378 | a8083063 | Iustin Pop | <varlistentry> |
379 | a8083063 | Iustin Pop | <term>snodes</term> |
380 | a8083063 | Iustin Pop | <listitem> |
381 | 4677a909 | Michael Hanselmann | <simpara>comma-separated list of secondary nodes for the |
382 | a8083063 | Iustin Pop | instance; usually this will be just one node</simpara> |
383 | a8083063 | Iustin Pop | </listitem> |
384 | a8083063 | Iustin Pop | </varlistentry> |
385 | a8083063 | Iustin Pop | <varlistentry> |
386 | a8083063 | Iustin Pop | <term>admin_state</term> |
387 | a8083063 | Iustin Pop | <listitem> |
388 | a8083063 | Iustin Pop | <simpara>the desired state of the instance (either "yes" |
389 | a8083063 | Iustin Pop | or "no" denoting the instance should run or |
390 | a8083063 | Iustin Pop | not)</simpara> |
391 | a8083063 | Iustin Pop | </listitem> |
392 | a8083063 | Iustin Pop | </varlistentry> |
393 | a8083063 | Iustin Pop | <varlistentry> |
394 | a8083063 | Iustin Pop | <term>admin_ram</term> |
395 | a8083063 | Iustin Pop | <listitem> |
396 | a8083063 | Iustin Pop | <simpara>the desired memory for the instance</simpara> |
397 | a8083063 | Iustin Pop | </listitem> |
398 | a8083063 | Iustin Pop | </varlistentry> |
399 | a8083063 | Iustin Pop | <varlistentry> |
400 | a8083063 | Iustin Pop | <term>disk_template</term> |
401 | a8083063 | Iustin Pop | <listitem> |
402 | a8083063 | Iustin Pop | <simpara>the disk template of the instance</simpara> |
403 | a8083063 | Iustin Pop | </listitem> |
404 | a8083063 | Iustin Pop | </varlistentry> |
405 | a8083063 | Iustin Pop | <varlistentry> |
406 | a8083063 | Iustin Pop | <term>oper_state</term> |
407 | a8083063 | Iustin Pop | <listitem> |
408 | d8052456 | Iustin Pop | <simpara>the actual state of the instance; can be |
409 | d8052456 | Iustin Pop | one of the values "running", "stopped", "(node |
410 | d8052456 | Iustin Pop | down)"</simpara> |
411 | d8052456 | Iustin Pop | </listitem> |
412 | d8052456 | Iustin Pop | </varlistentry> |
413 | d8052456 | Iustin Pop | <varlistentry> |
414 | d8052456 | Iustin Pop | <term>status</term> |
415 | d8052456 | Iustin Pop | <listitem> |
416 | d8052456 | Iustin Pop | <simpara>combined form of admin_state and oper_stat; |
417 | d8052456 | Iustin Pop | this can be one of: |
418 | d8052456 | Iustin Pop | <computeroutput>ERROR_nodedown</computeroutput> if the |
419 | d8052456 | Iustin Pop | node of the instance is down, |
420 | d8052456 | Iustin Pop | <computeroutput>ERROR_down</computeroutput> if the |
421 | d8052456 | Iustin Pop | instance should run but is down, |
422 | d8052456 | Iustin Pop | <computeroutput>ERROR_up</computeroutput> if the |
423 | d8052456 | Iustin Pop | instance should be stopped but is actually running, |
424 | d8052456 | Iustin Pop | <computeroutput>ADMIN_down</computeroutput> if the |
425 | d8052456 | Iustin Pop | instance has been stopped (and is stopped) and |
426 | d8052456 | Iustin Pop | <computeroutput>running</computeroutput> if the |
427 | d8052456 | Iustin Pop | instance is set to be running (and is |
428 | d8052456 | Iustin Pop | running)</simpara> |
429 | a8083063 | Iustin Pop | </listitem> |
430 | a8083063 | Iustin Pop | </varlistentry> |
431 | a8083063 | Iustin Pop | <varlistentry> |
432 | a8083063 | Iustin Pop | <term>oper_ram</term> |
433 | a8083063 | Iustin Pop | <listitem> |
434 | a8083063 | Iustin Pop | <simpara>the actual memory usage of the instance as seen |
435 | a8083063 | Iustin Pop | by the hypervisor</simpara> |
436 | a8083063 | Iustin Pop | </listitem> |
437 | a8083063 | Iustin Pop | </varlistentry> |
438 | a8083063 | Iustin Pop | <varlistentry> |
439 | a8083063 | Iustin Pop | <term>ip</term> |
440 | a8083063 | Iustin Pop | <listitem> |
441 | a8083063 | Iustin Pop | <simpara>the ip address ganeti recognizes as associated with |
442 | a8083063 | Iustin Pop | the instance interface</simpara> |
443 | a8083063 | Iustin Pop | </listitem> |
444 | a8083063 | Iustin Pop | </varlistentry> |
445 | a8083063 | Iustin Pop | <varlistentry> |
446 | a8083063 | Iustin Pop | <term>mac</term> |
447 | a8083063 | Iustin Pop | <listitem> |
448 | a8083063 | Iustin Pop | <simpara>the instance interface MAC address</simpara> |
449 | a8083063 | Iustin Pop | </listitem> |
450 | a8083063 | Iustin Pop | </varlistentry> |
451 | a8083063 | Iustin Pop | <varlistentry> |
452 | a8083063 | Iustin Pop | <term>bridge</term> |
453 | a8083063 | Iustin Pop | <listitem> |
454 | a8083063 | Iustin Pop | <simpara>bridge the instance is connected to |
455 | a8083063 | Iustin Pop | </simpara> |
456 | a8083063 | Iustin Pop | </listitem> |
457 | a8083063 | Iustin Pop | </varlistentry> |
458 | d8a4b51d | Iustin Pop | <varlistentry> |
459 | d8a4b51d | Iustin Pop | <term>sda_size</term> |
460 | d8a4b51d | Iustin Pop | <listitem> |
461 | d8a4b51d | Iustin Pop | <simpara>the size of the instance's first disk</simpara> |
462 | d8a4b51d | Iustin Pop | </listitem> |
463 | d8a4b51d | Iustin Pop | </varlistentry> |
464 | d8a4b51d | Iustin Pop | <varlistentry> |
465 | d8a4b51d | Iustin Pop | <term>sdb_size</term> |
466 | d8a4b51d | Iustin Pop | <listitem> |
467 | d8a4b51d | Iustin Pop | <simpara>the size of the instance's second disk</simpara> |
468 | d8a4b51d | Iustin Pop | </listitem> |
469 | d8a4b51d | Iustin Pop | </varlistentry> |
470 | d8a4b51d | Iustin Pop | <varlistentry> |
471 | d8a4b51d | Iustin Pop | <term>vcpus</term> |
472 | d8a4b51d | Iustin Pop | <listitem> |
473 | d8a4b51d | Iustin Pop | <simpara>the number of VCPUs allocated to the |
474 | d8a4b51d | Iustin Pop | instance</simpara> |
475 | d8a4b51d | Iustin Pop | </listitem> |
476 | d8a4b51d | Iustin Pop | </varlistentry> |
477 | a8083063 | Iustin Pop | </variablelist> |
478 | a8083063 | Iustin Pop | </para> |
479 | a8083063 | Iustin Pop | |
480 | a8083063 | Iustin Pop | <para> |
481 | a8083063 | Iustin Pop | There is a subtle grouping about the available output |
482 | a8083063 | Iustin Pop | fields: all fields except for <option>oper_state</option> |
483 | a8083063 | Iustin Pop | and <option>oper_ram</option> are configuration value and |
484 | a8083063 | Iustin Pop | not run-time values. So if you don't select any of the |
485 | a8083063 | Iustin Pop | <option>oper_*</option> fields, the query will be satisfied |
486 | a8083063 | Iustin Pop | instantly from the cluster configuration, without having to |
487 | a8083063 | Iustin Pop | ask the remote nodes for the data. This can be helpful for |
488 | a8083063 | Iustin Pop | big clusters when you only want some data and it makes sense |
489 | a8083063 | Iustin Pop | to specify a reduced set of output fields. |
490 | a8083063 | Iustin Pop | </para> |
491 | a8083063 | Iustin Pop | |
492 | a8083063 | Iustin Pop | <para>The default output field list is: |
493 | a8083063 | Iustin Pop | <simplelist type="inline"> |
494 | a8083063 | Iustin Pop | <member>name</member> |
495 | a8083063 | Iustin Pop | <member>os</member> |
496 | a8083063 | Iustin Pop | <member>pnode</member> |
497 | a8083063 | Iustin Pop | <member>admin_state</member> |
498 | a8083063 | Iustin Pop | <member>oper_state</member> |
499 | a8083063 | Iustin Pop | <member>oper_ram</member> |
500 | a8083063 | Iustin Pop | </simplelist>. |
501 | a8083063 | Iustin Pop | </para> |
502 | a8083063 | Iustin Pop | </refsect3> |
503 | a8083063 | Iustin Pop | |
504 | a8083063 | Iustin Pop | <refsect3> |
505 | a8083063 | Iustin Pop | <title>INFO</title> |
506 | a8083063 | Iustin Pop | |
507 | a8083063 | Iustin Pop | <cmdsynopsis> |
508 | a8083063 | Iustin Pop | <command>info</command> |
509 | a8083063 | Iustin Pop | <arg rep="repeat"><replaceable>instance</replaceable></arg> |
510 | a8083063 | Iustin Pop | </cmdsynopsis> |
511 | a8083063 | Iustin Pop | |
512 | a8083063 | Iustin Pop | <para> |
513 | a8083063 | Iustin Pop | Show detailed information about the (given) instances. This |
514 | a8083063 | Iustin Pop | is different from <command>list</command> as it shows |
515 | a8083063 | Iustin Pop | detailed data about the instance's disks (especially useful |
516 | a8083063 | Iustin Pop | for remote raid templates). |
517 | a8083063 | Iustin Pop | </para> |
518 | a8083063 | Iustin Pop | </refsect3> |
519 | a8083063 | Iustin Pop | |
520 | a8083063 | Iustin Pop | <refsect3> |
521 | a8083063 | Iustin Pop | <title>MODIFY</title> |
522 | a8083063 | Iustin Pop | |
523 | a8083063 | Iustin Pop | <cmdsynopsis> |
524 | a8083063 | Iustin Pop | <command>modify</command> |
525 | a8083063 | Iustin Pop | <arg choice="opt">-m <replaceable>memsize</replaceable></arg> |
526 | a8083063 | Iustin Pop | <arg choice="opt">-p <replaceable>vcpus</replaceable></arg> |
527 | a8083063 | Iustin Pop | <arg choice="opt">-i <replaceable>ip</replaceable></arg> |
528 | a8083063 | Iustin Pop | <arg choice="opt">-b <replaceable>bridge</replaceable></arg> |
529 | 61854511 | Iustin Pop | <arg choice="opt">--mac <replaceable>MAC-address</replaceable></arg> |
530 | 25c5878d | Alexander Schreiber | <arg>--hvm-boot-order <replaceable>boot-order</replaceable></arg> |
531 | 00f98619 | Iustin Pop | <sbr> |
532 | 00f98619 | Iustin Pop | <arg>--kernel <group choice="req"> |
533 | 00f98619 | Iustin Pop | <arg>default</arg> |
534 | 00f98619 | Iustin Pop | <arg><replaceable>kernel_path</replaceable></arg> |
535 | 00f98619 | Iustin Pop | </group></arg> |
536 | 00f98619 | Iustin Pop | <sbr> |
537 | 00f98619 | Iustin Pop | <arg>--initrd <group choice="req"> |
538 | 00f98619 | Iustin Pop | <arg>default</arg> |
539 | 00f98619 | Iustin Pop | <arg>none</arg> |
540 | 00f98619 | Iustin Pop | <arg><replaceable>initrd_path</replaceable></arg> |
541 | 00f98619 | Iustin Pop | </group> </arg> |
542 | 00f98619 | Iustin Pop | <sbr> |
543 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
544 | a8083063 | Iustin Pop | </cmdsynopsis> |
545 | a8083063 | Iustin Pop | |
546 | a8083063 | Iustin Pop | <para> |
547 | f3a55c90 | Alexander Schreiber | Modify the memory size, number of vcpus, ip address, MAC |
548 | f3a55c90 | Alexander Schreiber | address and/or bridge for an instance. |
549 | a8083063 | Iustin Pop | </para> |
550 | a8083063 | Iustin Pop | |
551 | a8083063 | Iustin Pop | <para> |
552 | a8083063 | Iustin Pop | The memory size is given in MiB. Note that you need to give |
553 | a8083063 | Iustin Pop | at least one of the arguments, otherwise the command |
554 | a8083063 | Iustin Pop | complains. |
555 | a8083063 | Iustin Pop | </para> |
556 | a8083063 | Iustin Pop | |
557 | a8083063 | Iustin Pop | <para> |
558 | 25c5878d | Alexander Schreiber | The <option>--kernel</option>, <option>--initrd</option> |
559 | 25c5878d | Alexander Schreiber | and <option>--hvm-boot-order</option> |
560 | 00f98619 | Iustin Pop | options are described in the <command>add</command> command. |
561 | 00f98619 | Iustin Pop | </para> |
562 | 00f98619 | Iustin Pop | |
563 | 00f98619 | Iustin Pop | <para> |
564 | 25c5878d | Alexander Schreiber | Additionally, the HVM boot order can be reset to the default |
565 | 25c5878d | Alexander Schreiber | values by using <option>--hvm-boot-order=default</option>. |
566 | 25c5878d | Alexander Schreiber | </para> |
567 | 25c5878d | Alexander Schreiber | |
568 | 25c5878d | Alexander Schreiber | <para> |
569 | a8083063 | Iustin Pop | All the changes take effect at the next restart. If the |
570 | a8083063 | Iustin Pop | instance is running, there is no effect on the instance. |
571 | a8083063 | Iustin Pop | </para> |
572 | a8083063 | Iustin Pop | </refsect3> |
573 | a8083063 | Iustin Pop | |
574 | d0834de3 | Michael Hanselmann | <refsect3> |
575 | d0834de3 | Michael Hanselmann | <title>REINSTALL</title> |
576 | d0834de3 | Michael Hanselmann | |
577 | d0834de3 | Michael Hanselmann | <cmdsynopsis> |
578 | d0834de3 | Michael Hanselmann | <command>reinstall</command> |
579 | d0834de3 | Michael Hanselmann | <arg choice="opt">-o <replaceable>os-type</replaceable></arg> |
580 | d0834de3 | Michael Hanselmann | <arg choice="opt">-f <replaceable>force</replaceable></arg> |
581 | d0834de3 | Michael Hanselmann | <arg choice="req"><replaceable>instance</replaceable></arg> |
582 | d0834de3 | Michael Hanselmann | </cmdsynopsis> |
583 | d0834de3 | Michael Hanselmann | |
584 | d0834de3 | Michael Hanselmann | <para> |
585 | d0834de3 | Michael Hanselmann | Reinstalls the operating system on the given instance. The instance |
586 | d0834de3 | Michael Hanselmann | must be stopped when running this command. If the |
587 | d0834de3 | Michael Hanselmann | <option>--os-type</option> is specified, the operating system is |
588 | d0834de3 | Michael Hanselmann | changed. |
589 | d0834de3 | Michael Hanselmann | </para> |
590 | d0834de3 | Michael Hanselmann | </refsect3> |
591 | d0834de3 | Michael Hanselmann | |
592 | decd5f45 | Iustin Pop | <refsect3> |
593 | decd5f45 | Iustin Pop | <title>RENAME</title> |
594 | decd5f45 | Iustin Pop | |
595 | decd5f45 | Iustin Pop | <cmdsynopsis> |
596 | decd5f45 | Iustin Pop | <command>rename</command> |
597 | decd5f45 | Iustin Pop | <arg>--no-ip-check</arg> |
598 | decd5f45 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
599 | decd5f45 | Iustin Pop | <arg choice="req"><replaceable>new_name</replaceable></arg> |
600 | decd5f45 | Iustin Pop | </cmdsynopsis> |
601 | decd5f45 | Iustin Pop | |
602 | decd5f45 | Iustin Pop | <para> |
603 | decd5f45 | Iustin Pop | Renames the given instance. The instance must be stopped |
604 | decd5f45 | Iustin Pop | when running this command. The requirements for the new name |
605 | decd5f45 | Iustin Pop | are the same as for adding an instance: the new name must be |
606 | decd5f45 | Iustin Pop | resolvable and the IP it resolves to must not be reachable |
607 | decd5f45 | Iustin Pop | (in order to prevent duplicate IPs the next time the |
608 | decd5f45 | Iustin Pop | instance is started). The IP test can be skipped if the |
609 | decd5f45 | Iustin Pop | <option>--no-ip-check</option> option is passed. |
610 | decd5f45 | Iustin Pop | </para> |
611 | decd5f45 | Iustin Pop | </refsect3> |
612 | decd5f45 | Iustin Pop | |
613 | a8083063 | Iustin Pop | </refsect2> |
614 | a8083063 | Iustin Pop | |
615 | a8083063 | Iustin Pop | <refsect2> |
616 | a8083063 | Iustin Pop | <title>Starting/stopping/connecting to console</title> |
617 | a8083063 | Iustin Pop | |
618 | a8083063 | Iustin Pop | <refsect3> |
619 | a8083063 | Iustin Pop | <title>STARTUP</title> |
620 | a8083063 | Iustin Pop | |
621 | a8083063 | Iustin Pop | <cmdsynopsis> |
622 | a8083063 | Iustin Pop | <command>startup</command> |
623 | a8083063 | Iustin Pop | <arg>--extra=<replaceable>PARAMS</replaceable></arg> |
624 | 3bd5f059 | Michael Hanselmann | <arg>--force</arg> |
625 | 312ac745 | Iustin Pop | <sbr> |
626 | 312ac745 | Iustin Pop | <group choice="opt"> |
627 | 312ac745 | Iustin Pop | <arg>--instance</arg> |
628 | 312ac745 | Iustin Pop | <arg>--node</arg> |
629 | 312ac745 | Iustin Pop | <arg>--primary</arg> |
630 | 312ac745 | Iustin Pop | <arg>--secondary</arg> |
631 | 312ac745 | Iustin Pop | <arg>--all</arg> |
632 | 312ac745 | Iustin Pop | </group> |
633 | 312ac745 | Iustin Pop | <sbr> |
634 | 312ac745 | Iustin Pop | <arg choice="opt" |
635 | 312ac745 | Iustin Pop | rep="repeat"><replaceable>name</replaceable></arg> |
636 | a8083063 | Iustin Pop | </cmdsynopsis> |
637 | a8083063 | Iustin Pop | |
638 | a8083063 | Iustin Pop | <para> |
639 | bcee9cb4 | Iustin Pop | Starts one or more instances, depending on the following |
640 | bcee9cb4 | Iustin Pop | options. The four available modes are: |
641 | 312ac745 | Iustin Pop | <variablelist> |
642 | 312ac745 | Iustin Pop | <varlistentry> |
643 | 312ac745 | Iustin Pop | <term><option>--instance</option></term> |
644 | 312ac745 | Iustin Pop | <listitem> |
645 | 312ac745 | Iustin Pop | <simpara>will start the instances given as arguments |
646 | 312ac745 | Iustin Pop | (at least one argument required); this is the default |
647 | 312ac745 | Iustin Pop | selection</simpara> |
648 | 312ac745 | Iustin Pop | </listitem> |
649 | 312ac745 | Iustin Pop | </varlistentry> |
650 | 312ac745 | Iustin Pop | <varlistentry> |
651 | 312ac745 | Iustin Pop | <term>--node</term> |
652 | 312ac745 | Iustin Pop | <listitem> |
653 | 312ac745 | Iustin Pop | <simpara>will start the instances who have the given |
654 | 312ac745 | Iustin Pop | node as either primary or secondary</simpara> |
655 | 312ac745 | Iustin Pop | </listitem> |
656 | 312ac745 | Iustin Pop | </varlistentry> |
657 | 312ac745 | Iustin Pop | <varlistentry> |
658 | 312ac745 | Iustin Pop | <term><option>--primary</option></term> |
659 | 312ac745 | Iustin Pop | <listitem> |
660 | 312ac745 | Iustin Pop | <simpara>will start all instances whose primary node |
661 | 312ac745 | Iustin Pop | is in the list of nodes passed as arguments (at least |
662 | 312ac745 | Iustin Pop | one node required)</simpara> |
663 | 312ac745 | Iustin Pop | </listitem> |
664 | 312ac745 | Iustin Pop | </varlistentry> |
665 | 312ac745 | Iustin Pop | <varlistentry> |
666 | 312ac745 | Iustin Pop | <term><option>--secondary</option></term> |
667 | 312ac745 | Iustin Pop | <listitem> |
668 | 312ac745 | Iustin Pop | <simpara>will start all instances whose secondary node |
669 | 312ac745 | Iustin Pop | is in the list of nodes passed as arguments (at least |
670 | 312ac745 | Iustin Pop | one node required)</simpara> |
671 | 312ac745 | Iustin Pop | </listitem> |
672 | 312ac745 | Iustin Pop | </varlistentry> |
673 | 312ac745 | Iustin Pop | <varlistentry> |
674 | 312ac745 | Iustin Pop | <term>--all</term> |
675 | 312ac745 | Iustin Pop | <listitem> |
676 | 312ac745 | Iustin Pop | <simpara>will start all instances in the cluster (no |
677 | 312ac745 | Iustin Pop | arguments accepted)</simpara> |
678 | 312ac745 | Iustin Pop | </listitem> |
679 | 312ac745 | Iustin Pop | </varlistentry> |
680 | 312ac745 | Iustin Pop | </variablelist> |
681 | 312ac745 | Iustin Pop | </para> |
682 | 312ac745 | Iustin Pop | |
683 | 312ac745 | Iustin Pop | <para> |
684 | bcee9cb4 | Iustin Pop | Note that although you can pass more than one selection |
685 | bcee9cb4 | Iustin Pop | option, the last one wins, so in order to guarantee the |
686 | bcee9cb4 | Iustin Pop | desired result, don't pass more than one such option. |
687 | a8083063 | Iustin Pop | </para> |
688 | a8083063 | Iustin Pop | |
689 | a8083063 | Iustin Pop | <para> |
690 | a8083063 | Iustin Pop | The <option>--extra</option> option is used to pass |
691 | a8083063 | Iustin Pop | additional argument to the instance's kernel for this start |
692 | a8083063 | Iustin Pop | only. Currently there is no way to specify a persistent set |
693 | a8083063 | Iustin Pop | of arguments (beside the one hardcoded). Note that this may |
694 | a8083063 | Iustin Pop | not apply to all virtualization types. |
695 | a8083063 | Iustin Pop | </para> |
696 | a8083063 | Iustin Pop | |
697 | 3bd5f059 | Michael Hanselmann | <para> |
698 | 3bd5f059 | Michael Hanselmann | Use <option>--force</option> to start even if secondary disks are |
699 | 3bd5f059 | Michael Hanselmann | failing. |
700 | 3bd5f059 | Michael Hanselmann | </para> |
701 | a8083063 | Iustin Pop | |
702 | a8083063 | Iustin Pop | <para> |
703 | a8083063 | Iustin Pop | Example: |
704 | a8083063 | Iustin Pop | <screen> |
705 | a8083063 | Iustin Pop | # gnt-instance start instance1.example.com |
706 | a8083063 | Iustin Pop | # gnt-instance start --extra single test1.example.com |
707 | bcee9cb4 | Iustin Pop | # gnt-instance start --node node1.example.com node2.example.com |
708 | bcee9cb4 | Iustin Pop | # gnt-instance start --all |
709 | a8083063 | Iustin Pop | </screen> |
710 | a8083063 | Iustin Pop | </para> |
711 | a8083063 | Iustin Pop | </refsect3> |
712 | a8083063 | Iustin Pop | |
713 | a8083063 | Iustin Pop | <refsect3> |
714 | a8083063 | Iustin Pop | <title>SHUTDOWN</title> |
715 | a8083063 | Iustin Pop | |
716 | a8083063 | Iustin Pop | <cmdsynopsis> |
717 | a8083063 | Iustin Pop | <command>shutdown</command> |
718 | 312ac745 | Iustin Pop | <sbr> |
719 | 312ac745 | Iustin Pop | <group choice="opt"> |
720 | 312ac745 | Iustin Pop | <arg>--instance</arg> |
721 | 312ac745 | Iustin Pop | <arg>--node</arg> |
722 | 312ac745 | Iustin Pop | <arg>--primary</arg> |
723 | 312ac745 | Iustin Pop | <arg>--secondary</arg> |
724 | 312ac745 | Iustin Pop | <arg>--all</arg> |
725 | 312ac745 | Iustin Pop | </group> |
726 | 312ac745 | Iustin Pop | <sbr> |
727 | 312ac745 | Iustin Pop | |
728 | 312ac745 | Iustin Pop | <arg choice="opt" |
729 | 312ac745 | Iustin Pop | rep="repeat"><replaceable>name</replaceable></arg> |
730 | a8083063 | Iustin Pop | </cmdsynopsis> |
731 | a8083063 | Iustin Pop | |
732 | a8083063 | Iustin Pop | <para> |
733 | 312ac745 | Iustin Pop | Stops one or more instances. If the instance cannot be |
734 | 312ac745 | Iustin Pop | cleanly stopped during a hardcoded interval (currently 2 |
735 | 312ac745 | Iustin Pop | minutes), it will forcibly stop the instance (equivalent to |
736 | 312ac745 | Iustin Pop | switching off the power on a physical machine). |
737 | 312ac745 | Iustin Pop | </para> |
738 | 312ac745 | Iustin Pop | |
739 | 312ac745 | Iustin Pop | <para> |
740 | 312ac745 | Iustin Pop | The <option>--instance</option>, <option>--node</option>, |
741 | 312ac745 | Iustin Pop | <option>--primary</option>, <option>--secondary</option> and |
742 | 312ac745 | Iustin Pop | <option>--all</option> options are similar as for the |
743 | 312ac745 | Iustin Pop | <command>startup</command> command and they influence the |
744 | 86b8c6ae | Alexander Schreiber | actual instances being shutdown. |
745 | a8083063 | Iustin Pop | </para> |
746 | a8083063 | Iustin Pop | |
747 | a8083063 | Iustin Pop | <para> |
748 | a8083063 | Iustin Pop | Example: |
749 | a8083063 | Iustin Pop | <screen> |
750 | a8083063 | Iustin Pop | # gnt-instance shutdown instance1.example.com |
751 | bcee9cb4 | Iustin Pop | # gnt-instance shutdown --all |
752 | a8083063 | Iustin Pop | </screen> |
753 | a8083063 | Iustin Pop | </para> |
754 | a8083063 | Iustin Pop | </refsect3> |
755 | a8083063 | Iustin Pop | |
756 | a8083063 | Iustin Pop | <refsect3> |
757 | 579d4337 | Alexander Schreiber | <title>REBOOT</title> |
758 | 579d4337 | Alexander Schreiber | |
759 | 579d4337 | Alexander Schreiber | <cmdsynopsis> |
760 | 579d4337 | Alexander Schreiber | <command>reboot</command> |
761 | 579d4337 | Alexander Schreiber | <sbr> |
762 | 579d4337 | Alexander Schreiber | <arg>--extra=<replaceable>PARAMS</replaceable></arg> |
763 | 579d4337 | Alexander Schreiber | <sbr> |
764 | 579d4337 | Alexander Schreiber | <arg>--type=<replaceable>REBOOT-TYPE</replaceable></arg> |
765 | 579d4337 | Alexander Schreiber | <sbr> |
766 | 579d4337 | Alexander Schreiber | <arg>--ignore-secondaries</arg> |
767 | 579d4337 | Alexander Schreiber | <sbr> |
768 | 579d4337 | Alexander Schreiber | <arg>--force-multiple</arg> |
769 | 579d4337 | Alexander Schreiber | <sbr> |
770 | 579d4337 | Alexander Schreiber | <group choice="opt"> |
771 | 579d4337 | Alexander Schreiber | <arg>--instance</arg> |
772 | 579d4337 | Alexander Schreiber | <arg>--node</arg> |
773 | 579d4337 | Alexander Schreiber | <arg>--primary</arg> |
774 | 579d4337 | Alexander Schreiber | <arg>--secondary</arg> |
775 | 579d4337 | Alexander Schreiber | <arg>--all</arg> |
776 | 579d4337 | Alexander Schreiber | </group> |
777 | 579d4337 | Alexander Schreiber | <sbr> |
778 | 579d4337 | Alexander Schreiber | |
779 | 579d4337 | Alexander Schreiber | <arg choice="opt" |
780 | 579d4337 | Alexander Schreiber | rep="repeat"><replaceable>name</replaceable></arg> |
781 | 579d4337 | Alexander Schreiber | </cmdsynopsis> |
782 | 579d4337 | Alexander Schreiber | |
783 | 579d4337 | Alexander Schreiber | <para> |
784 | 579d4337 | Alexander Schreiber | Reboots one or more instances. The type of reboot depends on |
785 | 579d4337 | Alexander Schreiber | the value of <option>--type</option>. A soft reboot does a |
786 | 579d4337 | Alexander Schreiber | hypervisor reboot, a hard reboot does a instance stop, |
787 | 579d4337 | Alexander Schreiber | recreates the hypervisor config for the instance and |
788 | 579d4337 | Alexander Schreiber | starts the instance. A full reboot does the equivalent |
789 | 579d4337 | Alexander Schreiber | of <command>gnt-instance shutdown && gnt-instance |
790 | 579d4337 | Alexander Schreiber | startup</command>. The default is soft reboot. |
791 | 579d4337 | Alexander Schreiber | </para> |
792 | 579d4337 | Alexander Schreiber | |
793 | 579d4337 | Alexander Schreiber | <para> |
794 | 579d4337 | Alexander Schreiber | For the hard reboot the option |
795 | 579d4337 | Alexander Schreiber | <option>--ignore-secondaries</option> ignores errors for the |
796 | 579d4337 | Alexander Schreiber | secondary node while re-assembling the instance disks. |
797 | 579d4337 | Alexander Schreiber | </para> |
798 | 579d4337 | Alexander Schreiber | |
799 | 579d4337 | Alexander Schreiber | <para> |
800 | 579d4337 | Alexander Schreiber | The <option>--instance</option>, <option>--node</option>, |
801 | 579d4337 | Alexander Schreiber | <option>--primary</option>, <option>--secondary</option> and |
802 | 579d4337 | Alexander Schreiber | <option>--all</option> options are similar as for the |
803 | 579d4337 | Alexander Schreiber | <command>startup</command> command and they influence the |
804 | 579d4337 | Alexander Schreiber | actual instances being rebooted. |
805 | 579d4337 | Alexander Schreiber | </para> |
806 | 36c87212 | Iustin Pop | |
807 | 579d4337 | Alexander Schreiber | <para> |
808 | 3bd5f059 | Michael Hanselmann | Use the <option>--force-multiple</option> option to keep |
809 | 579d4337 | Alexander Schreiber | gnt-instance from asking for confirmation when more than one |
810 | 579d4337 | Alexander Schreiber | instance is affected. |
811 | 579d4337 | Alexander Schreiber | </para> |
812 | 579d4337 | Alexander Schreiber | |
813 | 579d4337 | Alexander Schreiber | <para> |
814 | 579d4337 | Alexander Schreiber | Example: |
815 | 579d4337 | Alexander Schreiber | <screen> |
816 | 579d4337 | Alexander Schreiber | # gnt-instance reboot instance1.example.com |
817 | 579d4337 | Alexander Schreiber | # gnt-instance reboot --type=full instance1.example.com |
818 | 579d4337 | Alexander Schreiber | </screen> |
819 | 579d4337 | Alexander Schreiber | </para> |
820 | 579d4337 | Alexander Schreiber | </refsect3> |
821 | 579d4337 | Alexander Schreiber | |
822 | 579d4337 | Alexander Schreiber | <refsect3> |
823 | a8083063 | Iustin Pop | <title>CONSOLE</title> |
824 | a8083063 | Iustin Pop | <cmdsynopsis> |
825 | a8083063 | Iustin Pop | <command>console</command> |
826 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
827 | a8083063 | Iustin Pop | </cmdsynopsis> |
828 | a8083063 | Iustin Pop | |
829 | a8083063 | Iustin Pop | <para> |
830 | a8083063 | Iustin Pop | Connects to the console of the given instance. If the instance |
831 | a8083063 | Iustin Pop | is not up, an error is returned. |
832 | a8083063 | Iustin Pop | </para> |
833 | a8083063 | Iustin Pop | |
834 | a8083063 | Iustin Pop | <para> |
835 | a8083063 | Iustin Pop | Example: |
836 | a8083063 | Iustin Pop | <screen> |
837 | a8083063 | Iustin Pop | # gnt-instance console instance1.example.com |
838 | a8083063 | Iustin Pop | </screen> |
839 | a8083063 | Iustin Pop | </para> |
840 | a8083063 | Iustin Pop | </refsect3> |
841 | a8083063 | Iustin Pop | |
842 | a8083063 | Iustin Pop | </refsect2> |
843 | a8083063 | Iustin Pop | |
844 | a8083063 | Iustin Pop | <refsect2> |
845 | a8083063 | Iustin Pop | <title>Disk management</title> |
846 | a8083063 | Iustin Pop | |
847 | a8083063 | Iustin Pop | <refsect3> |
848 | a8083063 | Iustin Pop | <title>REPLACE-DISKS</title> |
849 | a8083063 | Iustin Pop | |
850 | a8083063 | Iustin Pop | <cmdsynopsis> |
851 | a8083063 | Iustin Pop | <command>replace-disks</command> |
852 | 0b0dea6a | Iustin Pop | <arg choice="opt">--new-secondary <replaceable>NODE</replaceable></arg> |
853 | 0b0dea6a | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
854 | 0b0dea6a | Iustin Pop | </cmdsynopsis> |
855 | 0b0dea6a | Iustin Pop | |
856 | 0b0dea6a | Iustin Pop | <cmdsynopsis> |
857 | 0b0dea6a | Iustin Pop | <command>replace-disks</command> |
858 | 6536dfa1 | Guido Trotter | <arg choice="opt">-s</arg> |
859 | a8083063 | Iustin Pop | <arg choice="req">--new-secondary <replaceable>NODE</replaceable></arg> |
860 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
861 | a8083063 | Iustin Pop | </cmdsynopsis> |
862 | a8083063 | Iustin Pop | |
863 | 0b0dea6a | Iustin Pop | <cmdsynopsis> |
864 | 0b0dea6a | Iustin Pop | <command>replace-disks</command> |
865 | 0b0dea6a | Iustin Pop | <group> |
866 | 0b0dea6a | Iustin Pop | <arg choice="req">-s</arg> |
867 | 0b0dea6a | Iustin Pop | <arg choice="req">-p</arg> |
868 | 0b0dea6a | Iustin Pop | </group> |
869 | 0b0dea6a | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
870 | 0b0dea6a | Iustin Pop | </cmdsynopsis> |
871 | 0b0dea6a | Iustin Pop | |
872 | a8083063 | Iustin Pop | <para> |
873 | 0b0dea6a | Iustin Pop | This command is a generalized form for adding and replacing |
874 | 0b0dea6a | Iustin Pop | disks. |
875 | a8083063 | Iustin Pop | </para> |
876 | a8083063 | Iustin Pop | |
877 | a8083063 | Iustin Pop | <para> |
878 | 0b0dea6a | Iustin Pop | The first form is usable with the |
879 | 0b0dea6a | Iustin Pop | <literal>remote_raid1</literal> disk template. This will |
880 | 0b0dea6a | Iustin Pop | replace the disks on both the primary and secondary node, |
881 | 0b0dea6a | Iustin Pop | and optionally will change the secondary node to a new one |
882 | 0b0dea6a | Iustin Pop | if you pass the <option>--new-secondary</option> option. |
883 | a8083063 | Iustin Pop | </para> |
884 | 0b0dea6a | Iustin Pop | |
885 | 0b0dea6a | Iustin Pop | <para> |
886 | 0b0dea6a | Iustin Pop | The second and third forms are usable with the |
887 | 0b0dea6a | Iustin Pop | <literal>drbd</literal> disk template. The second form will |
888 | 0b0dea6a | Iustin Pop | do a secondary replacement, but as opposed to the |
889 | 0b0dea6a | Iustin Pop | <literal>remote_raid1</literal> will not replace the disks |
890 | 0b0dea6a | Iustin Pop | on the primary, therefore it will execute faster. The third |
891 | 0b0dea6a | Iustin Pop | form will replace the disks on either the primary |
892 | 0b0dea6a | Iustin Pop | (<option>-p</option>) or the secondary (<option>-s</option>) |
893 | 0b0dea6a | Iustin Pop | node of the instance only, without changing the node. |
894 | 0b0dea6a | Iustin Pop | </para> |
895 | 0b0dea6a | Iustin Pop | |
896 | a8083063 | Iustin Pop | </refsect3> |
897 | a8083063 | Iustin Pop | |
898 | a8083063 | Iustin Pop | <refsect3> |
899 | a8083063 | Iustin Pop | <title>ADD-MIRROR</title> |
900 | a8083063 | Iustin Pop | <cmdsynopsis> |
901 | a8083063 | Iustin Pop | <command>add-mirror</command> |
902 | a8083063 | Iustin Pop | <arg choice="req">-b <replaceable>sdX</replaceable></arg> |
903 | a8083063 | Iustin Pop | <arg choice="req">-n <replaceable>node</replaceable></arg> |
904 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
905 | a8083063 | Iustin Pop | </cmdsynopsis> |
906 | a8083063 | Iustin Pop | <para> |
907 | a8083063 | Iustin Pop | Adds a new mirror to the disk layout of the instance, if the |
908 | a8083063 | Iustin Pop | instance has a remote raid disk layout. |
909 | a8083063 | Iustin Pop | |
910 | a8083063 | Iustin Pop | The new mirror member will be between the instance's primary |
911 | a8083063 | Iustin Pop | node and the node given with the <option>-n</option> option. |
912 | a8083063 | Iustin Pop | </para> |
913 | a8083063 | Iustin Pop | </refsect3> |
914 | a8083063 | Iustin Pop | |
915 | a8083063 | Iustin Pop | <refsect3> |
916 | a8083063 | Iustin Pop | <title>REMOVE-MIRROR</title> |
917 | a8083063 | Iustin Pop | |
918 | a8083063 | Iustin Pop | <cmdsynopsis> |
919 | a8083063 | Iustin Pop | <command>removemirror</command> |
920 | a8083063 | Iustin Pop | <arg choice="req">-b <replaceable>sdX</replaceable></arg> |
921 | a8083063 | Iustin Pop | <arg choice="req">-p <replaceable>id</replaceable></arg> |
922 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
923 | a8083063 | Iustin Pop | </cmdsynopsis> |
924 | a8083063 | Iustin Pop | <para> |
925 | a8083063 | Iustin Pop | Removes a mirror componenent from the disk layout of the |
926 | a8083063 | Iustin Pop | instance, if the instance has a remote raid disk layout. |
927 | a8083063 | Iustin Pop | </para> |
928 | a8083063 | Iustin Pop | |
929 | a8083063 | Iustin Pop | <para> |
930 | a8083063 | Iustin Pop | You need to specifiy on which disk to act on using the |
931 | a8083063 | Iustin Pop | <option>-b</option> option (either <filename>sda</filename> |
932 | a8083063 | Iustin Pop | or <filename>sdb</filename>) and the mirror component, which |
933 | a8083063 | Iustin Pop | is identified by the <option>-p</option> option. You can |
934 | a8083063 | Iustin Pop | find the list of valid identifiers with the |
935 | a8083063 | Iustin Pop | <command>info</command> command. |
936 | a8083063 | Iustin Pop | </para> |
937 | a8083063 | Iustin Pop | |
938 | a8083063 | Iustin Pop | <refsect3> |
939 | a8083063 | Iustin Pop | <title>ACTIVATE-DISKS</title> |
940 | a8083063 | Iustin Pop | |
941 | a8083063 | Iustin Pop | <cmdsynopsis> |
942 | a8083063 | Iustin Pop | <command>activate-disks</command> |
943 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
944 | a8083063 | Iustin Pop | </cmdsynopsis> |
945 | a8083063 | Iustin Pop | <para> |
946 | a8083063 | Iustin Pop | Activates the block devices of the given instance. If |
947 | a8083063 | Iustin Pop | successful, the command will show the location and name of |
948 | a8083063 | Iustin Pop | the block devices: |
949 | a8083063 | Iustin Pop | <screen> |
950 | a8083063 | Iustin Pop | node1.example.com:sda:/dev/md0 |
951 | a8083063 | Iustin Pop | node1.example.com:sdb:/dev/md1 |
952 | a8083063 | Iustin Pop | </screen> |
953 | a8083063 | Iustin Pop | |
954 | a8083063 | Iustin Pop | In this example, <emphasis>node1.example.com</emphasis> is |
955 | a8083063 | Iustin Pop | the name of the node on which the devices have been |
956 | a8083063 | Iustin Pop | activated. The <emphasis>sda</emphasis> and |
957 | a8083063 | Iustin Pop | <emphasis>sdb</emphasis> are the names of the block devices |
958 | a8083063 | Iustin Pop | inside the instance. <emphasis>/dev/md0</emphasis> and |
959 | a8083063 | Iustin Pop | <emphasis>/dev/md1</emphasis> are the names of the block |
960 | a8083063 | Iustin Pop | devices as visible on the node. |
961 | a8083063 | Iustin Pop | </para> |
962 | a8083063 | Iustin Pop | |
963 | a8083063 | Iustin Pop | <para> |
964 | a8083063 | Iustin Pop | Note that it is safe to run this command while the instance |
965 | a8083063 | Iustin Pop | is already running. |
966 | a8083063 | Iustin Pop | </para> |
967 | a8083063 | Iustin Pop | </refsect3> |
968 | a8083063 | Iustin Pop | |
969 | a8083063 | Iustin Pop | <refsect3> |
970 | a8083063 | Iustin Pop | <title>DEACTIVATE-DISKS</title> |
971 | a8083063 | Iustin Pop | |
972 | a8083063 | Iustin Pop | <cmdsynopsis> |
973 | a8083063 | Iustin Pop | <command>deactivate-disks</command> |
974 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
975 | a8083063 | Iustin Pop | </cmdsynopsis> |
976 | a8083063 | Iustin Pop | <para> |
977 | a8083063 | Iustin Pop | De-activates the block devices of the given instance. Note |
978 | a8083063 | Iustin Pop | that if you run this command for a remote raid instance |
979 | a8083063 | Iustin Pop | type, while it is running, it will not be able to shutdown |
980 | a8083063 | Iustin Pop | the block devices on the primary node, but it will shutdown |
981 | a8083063 | Iustin Pop | the block devices on the secondary nodes, thus breaking the |
982 | a8083063 | Iustin Pop | replication. |
983 | a8083063 | Iustin Pop | </para> |
984 | a8083063 | Iustin Pop | |
985 | a8083063 | Iustin Pop | </refsect3> |
986 | a8083063 | Iustin Pop | |
987 | a8083063 | Iustin Pop | </refsect2> |
988 | a8083063 | Iustin Pop | |
989 | a8083063 | Iustin Pop | <refsect2> |
990 | a8083063 | Iustin Pop | <title>Recovery</title> |
991 | a8083063 | Iustin Pop | |
992 | a8083063 | Iustin Pop | <refsect3> |
993 | a8083063 | Iustin Pop | <title>FAILOVER</title> |
994 | a8083063 | Iustin Pop | |
995 | a8083063 | Iustin Pop | <cmdsynopsis> |
996 | a8083063 | Iustin Pop | <command>failover</command> |
997 | a8083063 | Iustin Pop | <arg>-f</arg> |
998 | a8083063 | Iustin Pop | <arg>--ignore-consistency</arg> |
999 | 80de0e3f | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
1000 | a8083063 | Iustin Pop | </cmdsynopsis> |
1001 | a8083063 | Iustin Pop | |
1002 | a8083063 | Iustin Pop | <para> |
1003 | 80de0e3f | Iustin Pop | Failover will fail the instance over its secondary |
1004 | a8083063 | Iustin Pop | node. This works only for instances having a remote raid |
1005 | a8083063 | Iustin Pop | disk layout. |
1006 | a8083063 | Iustin Pop | </para> |
1007 | a8083063 | Iustin Pop | |
1008 | a8083063 | Iustin Pop | <para> |
1009 | a8083063 | Iustin Pop | Normally the failover will check the consistency of the |
1010 | 80de0e3f | Iustin Pop | disks before failing over the instance. If you are trying to |
1011 | a8083063 | Iustin Pop | migrate instances off a dead node, this will fail. Use the |
1012 | a8083063 | Iustin Pop | <option>--ignore-consistency</option> option for this |
1013 | 24a40d57 | Iustin Pop | purpose. Note that this option can be dangerous as errors in |
1014 | 24a40d57 | Iustin Pop | shutting down the instance will be ignored, resulting in |
1015 | 24a40d57 | Iustin Pop | possibly having the instance running on two machines in |
1016 | 24a40d57 | Iustin Pop | parallel (on disconnected DRBD drives). |
1017 | a8083063 | Iustin Pop | </para> |
1018 | a8083063 | Iustin Pop | |
1019 | a8083063 | Iustin Pop | <para> |
1020 | a8083063 | Iustin Pop | Example: |
1021 | a8083063 | Iustin Pop | <screen> |
1022 | a8083063 | Iustin Pop | # gnt-instance failover instance1.example.com |
1023 | a8083063 | Iustin Pop | </screen> |
1024 | a8083063 | Iustin Pop | </para> |
1025 | a8083063 | Iustin Pop | </refsect3> |
1026 | a8083063 | Iustin Pop | |
1027 | a8083063 | Iustin Pop | </refsect2> |
1028 | a8083063 | Iustin Pop | |
1029 | cc425644 | Iustin Pop | <refsect2> |
1030 | cc425644 | Iustin Pop | <title>TAGS</title> |
1031 | cc425644 | Iustin Pop | |
1032 | cc425644 | Iustin Pop | <refsect3> |
1033 | cc425644 | Iustin Pop | <title>ADD-TAGS</title> |
1034 | cc425644 | Iustin Pop | |
1035 | cc425644 | Iustin Pop | <cmdsynopsis> |
1036 | cc425644 | Iustin Pop | <command>add-tags</command> |
1037 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
1038 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>instancename</replaceable></arg> |
1039 | cc425644 | Iustin Pop | <arg choice="req" |
1040 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
1041 | cc425644 | Iustin Pop | </cmdsynopsis> |
1042 | cc425644 | Iustin Pop | |
1043 | cc425644 | Iustin Pop | <para> |
1044 | cc425644 | Iustin Pop | Add tags to the given instance. If any of the tags contains |
1045 | cc425644 | Iustin Pop | invalid characters, the entire operation will abort. |
1046 | cc425644 | Iustin Pop | </para> |
1047 | 810c50b7 | Iustin Pop | <para> |
1048 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
1049 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
1050 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
1051 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
1052 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
1053 | 810c50b7 | Iustin Pop | </para> |
1054 | cc425644 | Iustin Pop | </refsect3> |
1055 | cc425644 | Iustin Pop | |
1056 | cc425644 | Iustin Pop | <refsect3> |
1057 | cc425644 | Iustin Pop | <title>LIST-TAGS</title> |
1058 | cc425644 | Iustin Pop | |
1059 | cc425644 | Iustin Pop | <cmdsynopsis> |
1060 | cc425644 | Iustin Pop | <command>list-tags</command> |
1061 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>instancename</replaceable></arg> |
1062 | cc425644 | Iustin Pop | </cmdsynopsis> |
1063 | cc425644 | Iustin Pop | |
1064 | cc425644 | Iustin Pop | <para>List the tags of the given instance.</para> |
1065 | cc425644 | Iustin Pop | </refsect3> |
1066 | cc425644 | Iustin Pop | |
1067 | cc425644 | Iustin Pop | <refsect3> |
1068 | cc425644 | Iustin Pop | <title>REMOVE-TAGS</title> |
1069 | cc425644 | Iustin Pop | <cmdsynopsis> |
1070 | cc425644 | Iustin Pop | <command>remove-tags</command> |
1071 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
1072 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>instancename</replaceable></arg> |
1073 | cc425644 | Iustin Pop | <arg choice="req" |
1074 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
1075 | cc425644 | Iustin Pop | </cmdsynopsis> |
1076 | cc425644 | Iustin Pop | |
1077 | cc425644 | Iustin Pop | <para> |
1078 | cc425644 | Iustin Pop | Remove tags from the given instance. If any of the tags are |
1079 | cc425644 | Iustin Pop | not existing on the node, the entire operation will abort. |
1080 | cc425644 | Iustin Pop | </para> |
1081 | 810c50b7 | Iustin Pop | |
1082 | 810c50b7 | Iustin Pop | <para> |
1083 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
1084 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
1085 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
1086 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
1087 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
1088 | 810c50b7 | Iustin Pop | </para> |
1089 | cc425644 | Iustin Pop | </refsect3> |
1090 | cc425644 | Iustin Pop | |
1091 | cc425644 | Iustin Pop | </refsect2> |
1092 | cc425644 | Iustin Pop | |
1093 | a8083063 | Iustin Pop | </refsect1> |
1094 | a8083063 | Iustin Pop | |
1095 | a8083063 | Iustin Pop | &footer; |
1096 | a8083063 | Iustin Pop | |
1097 | a8083063 | Iustin Pop | </refentry> |
1098 | a8083063 | Iustin Pop | |
1099 | a8083063 | Iustin Pop | <!-- Keep this comment at the end of the file |
1100 | a8083063 | Iustin Pop | Local variables: |
1101 | a8083063 | Iustin Pop | mode: sgml |
1102 | a8083063 | Iustin Pop | sgml-omittag:t |
1103 | a8083063 | Iustin Pop | sgml-shorttag:t |
1104 | a8083063 | Iustin Pop | sgml-minimize-attributes:nil |
1105 | a8083063 | Iustin Pop | sgml-always-quote-attributes:t |
1106 | a8083063 | Iustin Pop | sgml-indent-step:2 |
1107 | a8083063 | Iustin Pop | sgml-indent-data:t |
1108 | a8083063 | Iustin Pop | sgml-parent-document:nil |
1109 | a8083063 | Iustin Pop | sgml-default-dtd-file:nil |
1110 | a8083063 | Iustin Pop | sgml-exposed-tags:nil |
1111 | a8083063 | Iustin Pop | sgml-local-catalogs:nil |
1112 | a8083063 | Iustin Pop | sgml-local-ecat-files:nil |
1113 | a8083063 | Iustin Pop | End: |
1114 | a8083063 | Iustin Pop | --> |