Improve gnt-instance documentation
[ganeti-local] / man / gnt-instance.rst
1 gnt-instance(8) Ganeti | Version @GANETI_VERSION@
2 =================================================
3
4 Name
5 ----
6
7 gnt-instance - Ganeti instance administration
8
9 Synopsis
10 --------
11
12 **gnt-instance** {command} [arguments...]
13
14 DESCRIPTION
15 -----------
16
17 The **gnt-instance** command is used for instance administration in
18 the Ganeti system.
19
20 COMMANDS
21 --------
22
23 Creation/removal/querying
24 ~~~~~~~~~~~~~~~~~~~~~~~~~
25
26 ADD
27 ^^^
28
29 | **add**
30 | {-t|\--disk-template {diskless | file \| plain \| drbd \| rbd}}
31 | {\--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*]
32 |  \| {size=*VAL*,provider=*PROVIDER*}[,param=*value*... ][,mode=*ro\|rw*]
33 |  \| {-s|\--os-size} *SIZE*}
34 | [\--no-ip-check] [\--no-name-check] [\--no-conflicts-check]
35 | [\--no-start] [\--no-install]
36 | [\--net=*N* [:options...] \| \--no-nics]
37 | [{-B|\--backend-parameters} *BEPARAMS*]
38 | [{-H|\--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]]
39 | [{-O|\--os-parameters} *param*=*value*... ]
40 | [\--file-storage-dir *dir\_path*] [\--file-driver {loop \| blktap}]
41 | {{-n|\--node} *node[:secondary-node]* \| {-I|\--iallocator} *name*}
42 | {{-o|\--os-type} *os-type*}
43 | [\--submit]
44 | [\--ignore-ipolicy]
45 | {*instance*}
46
47 Creates a new instance on the specified host. The *instance* argument
48 must be in DNS, but depending on the bridge/routing setup, need not be
49 in the same network as the nodes in the cluster.
50
51 The ``disk`` option specifies the parameters for the disks of the
52 instance. The numbering of disks starts at zero, and at least one disk
53 needs to be passed. For each disk, either the size or the adoption
54 source needs to be given, and optionally the access mode (read-only or
55 the default of read-write). The size is interpreted (when no unit is
56 given) in mebibytes. You can also use one of the suffixes *m*, *g* or
57 *t* to specify the exact the units used; these suffixes map to
58 mebibytes, gibibytes and tebibytes. For LVM and DRBD devices, the LVM
59 volume group can also be specified (via the ``vg`` key). For DRBD
60 devices, a different VG can be specified for the metadata device using
61 the ``metavg`` key. For ExtStorage devices, also the ``provider``
62 option is mandatory, to specify which ExtStorage provider to use.
63
64 When creating ExtStorage disks, also arbitrary parameters can be passed,
65 to the ExtStorage provider. Those parameters are passed as additional
66 comma separated options. Therefore, an ExtStorage disk provided by
67 provider ``pvdr1`` with parameters ``param1``, ``param2`` would be
68 passed as ``--disk 0:size=10G,provider=pvdr1,param1=val1,param2=val2``.
69
70 When using the ``adopt`` key in the disk definition, Ganeti will
71 reuse those volumes (instead of creating new ones) as the
72 instance's disks. Ganeti will rename these volumes to the standard
73 format, and (without installing the OS) will use them as-is for the
74 instance. This allows migrating instances from non-managed mode
75 (e.g. plain KVM with LVM) to being managed via Ganeti. Please note that
76 this works only for the \`plain' disk template (see below for
77 template details).
78
79 Alternatively, a single-disk instance can be created via the ``-s``
80 option which takes a single argument, the size of the disk. This is
81 similar to the Ganeti 1.2 version (but will only create one disk).
82
83 The minimum disk specification is therefore ``--disk 0:size=20G`` (or
84 ``-s 20G`` when using the ``-s`` option), and a three-disk instance
85 can be specified as ``--disk 0:size=20G --disk 1:size=4G --disk
86 2:size=100G``.
87
88 The minimum information needed to specify an ExtStorage disk are the
89 ``size`` and the ``provider``. For example:
90 ``--disk 0:size=20G,provider=pvdr1``.
91
92 The ``--no-ip-check`` skips the checks that are done to see if the
93 instance's IP is not already alive (i.e. reachable from the master
94 node).
95
96 The ``--no-name-check`` skips the check for the instance name via
97 the resolver (e.g. in DNS or /etc/hosts, depending on your setup).
98 Since the name check is used to compute the IP address, if you pass
99 this option you must also pass the ``--no-ip-check`` option.
100
101 If you don't want the instance to automatically start after
102 creation, this is possible via the ``--no-start`` option. This will
103 leave the instance down until a subsequent **gnt-instance start**
104 command.
105
106 The NICs of the instances can be specified via the ``--net``
107 option. By default, one NIC is created for the instance, with a
108 random MAC, and set up according the the cluster level NIC
109 parameters. Each NIC can take these parameters (all optional):
110
111 mac
112     either a value or 'generate' to generate a new unique MAC
113
114 ip
115     specifies the IP address assigned to the instance from the Ganeti
116     side (this is not necessarily what the instance will use, but what
117     the node expects the instance to use). Note that if an IP in the
118     range of a network configured with **gnt-network**\(8) is used,
119     and the NIC is not already connected to it, this network has to be
120     passed in the **network** parameter if this NIC is meant to be
121     connected to the said network. ``--no-conflicts-check`` can be used
122     to override this check. The special value **pool** causes Ganeti to
123     select an IP from the the network the NIC is or will be connected to.
124
125 mode
126     specifies the connection mode for this NIC: routed, bridged or
127     openvswitch.
128
129 link
130     in bridged or openvswitch mode specifies the interface to attach
131     this NIC to, in routed mode it's intended to differentiate between
132     different routing tables/instance groups (but the meaning is
133     dependent on the network script, see **gnt-cluster**\(8) for more
134     details). Note that openvswitch support is also hypervisor
135     dependent.
136
137 network
138     derives the mode and the link from the settings of the network
139     which is identified by its name. If the network option is chosen,
140     link and mode must not be specified. Note that the mode and link
141     depend on the network-to-nodegroup connection, thus allowing
142     different nodegroups to be connected to the same network in
143     different ways.
144
145
146 Of these "mode" and "link" are NIC parameters, and inherit their
147 default at cluster level.  Alternatively, if no network is desired for
148 the instance, you can prevent the default of one NIC with the
149 ``--no-nics`` option.
150
151 The ``-o (--os-type)`` option specifies the operating system to be
152 installed.  The available operating systems can be listed with
153 **gnt-os list**.  Passing ``--no-install`` will however skip the OS
154 installation, allowing a manual import if so desired. Note that the
155 no-installation mode will automatically disable the start-up of the
156 instance (without an OS, it most likely won't be able to start-up
157 successfully).
158
159 The ``-B (--backend-parameters)`` option specifies the backend
160 parameters for the instance. If no such parameters are specified, the
161 values are inherited from the cluster. Possible parameters are:
162
163 maxmem
164     the maximum memory size of the instance; as usual, suffixes can be
165     used to denote the unit, otherwise the value is taken in mebibytes
166
167 minmem
168     the minimum memory size of the instance; as usual, suffixes can be
169     used to denote the unit, otherwise the value is taken in mebibytes
170
171 vcpus
172     the number of VCPUs to assign to the instance (if this value makes
173     sense for the hypervisor)
174
175 auto\_balance
176     whether the instance is considered in the N+1 cluster checks
177     (enough redundancy in the cluster to survive a node failure)
178
179 always\_failover
180     ``True`` or ``False``, whether the instance must be failed over
181     (shut down and rebooted) always or it may be migrated (briefly
182     suspended)
183
184 Note that before 2.6 Ganeti had a ``memory`` parameter, which was the
185 only value of memory an instance could have. With the
186 ``maxmem``/``minmem`` change Ganeti guarantees that at least the minimum
187 memory is always available for an instance, but allows more memory to be
188 used (up to the maximum memory) should it be free.
189
190 The ``-H (--hypervisor-parameters)`` option specified the hypervisor
191 to use for the instance (must be one of the enabled hypervisors on the
192 cluster) and optionally custom parameters for this instance. If not
193 other options are used (i.e. the invocation is just -H *NAME*) the
194 instance will inherit the cluster options. The defaults below show the
195 cluster defaults at cluster creation time.
196
197 The possible hypervisor options are as follows:
198
199 boot\_order
200     Valid for the Xen HVM and KVM hypervisors.
201
202     A string value denoting the boot order. This has different meaning
203     for the Xen HVM hypervisor and for the KVM one.
204
205     For Xen HVM, The boot order is a string of letters listing the boot
206     devices, with valid device letters being:
207
208     a
209         floppy drive
210
211     c
212         hard disk
213
214     d
215         CDROM drive
216
217     n
218         network boot (PXE)
219
220     The default is not to set an HVM boot order, which is interpreted
221     as 'dc'.
222
223     For KVM the boot order is either "floppy", "cdrom", "disk" or
224     "network".  Please note that older versions of KVM couldn't netboot
225     from virtio interfaces. This has been fixed in more recent versions
226     and is confirmed to work at least with qemu-kvm 0.11.1. Also note
227     that if you have set the ``kernel_path`` option, that will be used
228     for booting, and this setting will be silently ignored.
229
230 blockdev\_prefix
231     Valid for the Xen HVM and PVM hypervisors.
232
233     Relevant to non-pvops guest kernels, in which the disk device names
234     are given by the host.  Allows one to specify 'xvd', which helps run
235     Red Hat based installers, driven by anaconda.
236
237 floppy\_image\_path
238     Valid for the KVM hypervisor.
239
240     The path to a floppy disk image to attach to the instance.  This
241     is useful to install Windows operating systems on Virt/IO disks
242     because you can specify here the floppy for the drivers at
243     installation time.
244
245 cdrom\_image\_path
246     Valid for the Xen HVM and KVM hypervisors.
247
248     The path to a CDROM image to attach to the instance.
249
250 cdrom2\_image\_path
251     Valid for the KVM hypervisor.
252
253     The path to a second CDROM image to attach to the instance.
254     **NOTE**: This image can't be used to boot the system. To do that
255     you have to use the 'cdrom\_image\_path' option.
256
257 nic\_type
258     Valid for the Xen HVM and KVM hypervisors.
259
260     This parameter determines the way the network cards are presented
261     to the instance. The possible options are:
262
263     - rtl8139 (default for Xen HVM) (HVM & KVM)
264     - ne2k\_isa (HVM & KVM)
265     - ne2k\_pci (HVM & KVM)
266     - i82551 (KVM)
267     - i82557b (KVM)
268     - i82559er (KVM)
269     - pcnet (KVM)
270     - e1000 (KVM)
271     - paravirtual (default for KVM) (HVM & KVM)
272
273 disk\_type
274     Valid for the Xen HVM and KVM hypervisors.
275
276     This parameter determines the way the disks are presented to the
277     instance. The possible options are:
278
279     - ioemu [default] (HVM & KVM)
280     - ide (HVM & KVM)
281     - scsi (KVM)
282     - sd (KVM)
283     - mtd (KVM)
284     - pflash (KVM)
285
286
287 cdrom\_disk\_type
288     Valid for the KVM hypervisor.
289
290     This parameter determines the way the cdroms disks are presented
291     to the instance. The default behavior is to get the same value of
292     the earlier parameter (disk_type). The possible options are:
293
294     - paravirtual
295     - ide
296     - scsi
297     - sd
298     - mtd
299     - pflash
300
301
302 vnc\_bind\_address
303     Valid for the Xen HVM and KVM hypervisors.
304
305     Specifies the address that the VNC listener for this instance
306     should bind to. Valid values are IPv4 addresses. Use the address
307     0.0.0.0 to bind to all available interfaces (this is the default)
308     or specify the address of one of the interfaces on the node to
309     restrict listening to that interface.
310
311 vnc\_tls
312     Valid for the KVM hypervisor.
313
314     A boolean option that controls whether the VNC connection is
315     secured with TLS.
316
317 vnc\_x509\_path
318     Valid for the KVM hypervisor.
319
320     If ``vnc_tls`` is enabled, this options specifies the path to the
321     x509 certificate to use.
322
323 vnc\_x509\_verify
324     Valid for the KVM hypervisor.
325
326 spice\_bind
327     Valid for the KVM hypervisor.
328
329     Specifies the address or interface on which the SPICE server will
330     listen. Valid values are:
331
332     - IPv4 addresses, including 0.0.0.0 and 127.0.0.1
333     - IPv6 addresses, including :: and ::1
334     - names of network interfaces
335
336     If a network interface is specified, the SPICE server will be bound
337     to one of the addresses of that interface.
338
339 spice\_ip\_version
340     Valid for the KVM hypervisor.
341
342     Specifies which version of the IP protocol should be used by the
343     SPICE server.
344
345     It is mainly intended to be used for specifying what kind of IP
346     addresses should be used if a network interface with both IPv4 and
347     IPv6 addresses is specified via the ``spice_bind`` parameter. In
348     this case, if the ``spice_ip_version`` parameter is not used, the
349     default IP version of the cluster will be used.
350
351 spice\_password\_file
352     Valid for the KVM hypervisor.
353
354     Specifies a file containing the password that must be used when
355     connecting via the SPICE protocol. If the option is not specified,
356     passwordless connections are allowed.
357
358 spice\_image\_compression
359     Valid for the KVM hypervisor.
360
361     Configures the SPICE lossless image compression. Valid values are:
362
363     - auto_glz
364     - auto_lz
365     - quic
366     - glz
367     - lz
368     - off
369
370 spice\_jpeg\_wan\_compression
371     Valid for the KVM hypervisor.
372
373     Configures how SPICE should use the jpeg algorithm for lossy image
374     compression on slow links. Valid values are:
375
376     - auto
377     - never
378     - always
379
380 spice\_zlib\_glz\_wan\_compression
381     Valid for the KVM hypervisor.
382
383     Configures how SPICE should use the zlib-glz algorithm for lossy image
384     compression on slow links. Valid values are:
385
386     - auto
387     - never
388     - always
389
390 spice\_streaming\_video
391     Valid for the KVM hypervisor.
392
393     Configures how SPICE should detect video streams. Valid values are:
394
395     - off
396     - all
397     - filter
398
399 spice\_playback\_compression
400     Valid for the KVM hypervisor.
401
402     Configures whether SPICE should compress audio streams or not.
403
404 spice\_use\_tls
405     Valid for the KVM hypervisor.
406
407     Specifies that the SPICE server must use TLS to encrypt all the
408     traffic with the client.
409
410 spice\_tls\_ciphers
411     Valid for the KVM hypervisor.
412
413     Specifies a list of comma-separated ciphers that SPICE should use
414     for TLS connections. For the format, see man **cipher**\(1).
415
416 spice\_use\_vdagent
417     Valid for the KVM hypervisor.
418
419     Enables or disables passing mouse events via SPICE vdagent.
420
421 cpu\_type
422     Valid for the KVM hypervisor.
423
424     This parameter determines the emulated cpu for the instance. If this
425     parameter is empty (which is the default configuration), it will not
426     be passed to KVM.
427
428     Be aware of setting this parameter to ``"host"`` if you have nodes
429     with different CPUs from each other. Live migration may stop working
430     in this situation.
431
432     For more information please refer to the KVM manual.
433
434 acpi
435     Valid for the Xen HVM and KVM hypervisors.
436
437     A boolean option that specifies if the hypervisor should enable
438     ACPI support for this instance. By default, ACPI is disabled.
439
440 pae
441     Valid for the Xen HVM and KVM hypervisors.
442
443     A boolean option that specifies if the hypervisor should enabled
444     PAE support for this instance. The default is false, disabling PAE
445     support.
446
447 use\_localtime
448     Valid for the Xen HVM and KVM hypervisors.
449
450     A boolean option that specifies if the instance should be started
451     with its clock set to the localtime of the machine (when true) or
452     to the UTC (When false). The default is false, which is useful for
453     Linux/Unix machines; for Windows OSes, it is recommended to enable
454     this parameter.
455
456 kernel\_path
457     Valid for the Xen PVM and KVM hypervisors.
458
459     This option specifies the path (on the node) to the kernel to boot
460     the instance with. Xen PVM instances always require this, while for
461     KVM if this option is empty, it will cause the machine to load the
462     kernel from its disks (and the boot will be done accordingly to
463     ``boot_order``).
464
465 kernel\_args
466     Valid for the Xen PVM and KVM hypervisors.
467
468     This options specifies extra arguments to the kernel that will be
469     loaded. device. This is always used for Xen PVM, while for KVM it
470     is only used if the ``kernel_path`` option is also specified.
471
472     The default setting for this value is simply ``"ro"``, which
473     mounts the root disk (initially) in read-only one. For example,
474     setting this to single will cause the instance to start in
475     single-user mode.
476
477 initrd\_path
478     Valid for the Xen PVM and KVM hypervisors.
479
480     This option specifies the path (on the node) to the initrd to boot
481     the instance with. Xen PVM instances can use this always, while
482     for KVM if this option is only used if the ``kernel_path`` option
483     is also specified. You can pass here either an absolute filename
484     (the path to the initrd) if you want to use an initrd, or use the
485     format no\_initrd\_path for no initrd.
486
487 root\_path
488     Valid for the Xen PVM and KVM hypervisors.
489
490     This options specifies the name of the root device. This is always
491     needed for Xen PVM, while for KVM it is only used if the
492     ``kernel_path`` option is also specified.
493
494     Please note, that if this setting is an empty string and the
495     hypervisor is Xen it will not be written to the Xen configuration
496     file
497
498 serial\_console
499     Valid for the KVM hypervisor.
500
501     This boolean option specifies whether to emulate a serial console
502     for the instance. Note that some versions of KVM have a bug that
503     will make an instance hang when configured to use the serial console
504     unless a connection is made to it within about 2 seconds of the
505     instance's startup. For such case it's recommended to disable this
506     option, which is enabled by default.
507
508 serial\_speed
509     Valid for the KVM hypervisor.
510
511     This integer option specifies the speed of the serial console.
512     Common values are 9600, 19200, 38400, 57600 and 115200: choose the
513     one which works on your system. (The default is 38400 for historical
514     reasons, but newer versions of kvm/qemu work with 115200)
515
516 disk\_cache
517     Valid for the KVM hypervisor.
518
519     The disk cache mode. It can be either default to not pass any
520     cache option to KVM, or one of the KVM cache modes: none (for
521     direct I/O), writethrough (to use the host cache but report
522     completion to the guest only when the host has committed the
523     changes to disk) or writeback (to use the host cache and report
524     completion as soon as the data is in the host cache). Note that
525     there are special considerations for the cache mode depending on
526     version of KVM used and disk type (always raw file under Ganeti),
527     please refer to the KVM documentation for more details.
528
529 security\_model
530     Valid for the KVM hypervisor.
531
532     The security model for kvm. Currently one of *none*, *user* or
533     *pool*. Under *none*, the default, nothing is done and instances
534     are run as the Ganeti daemon user (normally root).
535
536     Under *user* kvm will drop privileges and become the user
537     specified by the security\_domain parameter.
538
539     Under *pool* a global cluster pool of users will be used, making
540     sure no two instances share the same user on the same node. (this
541     mode is not implemented yet)
542
543 security\_domain
544     Valid for the KVM hypervisor.
545
546     Under security model *user* the username to run the instance
547     under.  It must be a valid username existing on the host.
548
549     Cannot be set under security model *none* or *pool*.
550
551 kvm\_flag
552     Valid for the KVM hypervisor.
553
554     If *enabled* the -enable-kvm flag is passed to kvm. If *disabled*
555     -disable-kvm is passed. If unset no flag is passed, and the
556     default running mode for your kvm binary will be used.
557
558 mem\_path
559     Valid for the KVM hypervisor.
560
561     This option passes the -mem-path argument to kvm with the path (on
562     the node) to the mount point of the hugetlbfs file system, along
563     with the -mem-prealloc argument too.
564
565 use\_chroot
566     Valid for the KVM hypervisor.
567
568     This boolean option determines whether to run the KVM instance in a
569     chroot directory.
570
571     If it is set to ``true``, an empty directory is created before
572     starting the instance and its path is passed via the -chroot flag
573     to kvm. The directory is removed when the instance is stopped.
574
575     It is set to ``false`` by default.
576
577 migration\_downtime
578     Valid for the KVM hypervisor.
579
580     The maximum amount of time (in ms) a KVM instance is allowed to be
581     frozen during a live migration, in order to copy dirty memory
582     pages. Default value is 30ms, but you may need to increase this
583     value for busy instances.
584
585     This option is only effective with kvm versions >= 87 and qemu-kvm
586     versions >= 0.11.0.
587
588 cpu\_mask
589     Valid for the Xen, KVM and LXC hypervisors.
590
591     The processes belonging to the given instance are only scheduled
592     on the specified CPUs.
593
594     The format of the mask can be given in three forms. First, the word
595     "all", which signifies the common case where all VCPUs can live on
596     any CPU, based on the hypervisor's decisions.
597
598     Second, a comma-separated list of CPU IDs or CPU ID ranges. The
599     ranges are defined by a lower and higher boundary, separated by a
600     dash, and the boundaries are inclusive. In this form, all VCPUs of
601     the instance will be mapped on the selected list of CPUs. Example:
602     ``0-2,5``, mapping all VCPUs (no matter how many) onto physical CPUs
603     0, 1, 2 and 5.
604
605     The last form is used for explicit control of VCPU-CPU pinnings. In
606     this form, the list of VCPU mappings is given as a colon (:)
607     separated list, whose elements are the possible values for the
608     second or first form above. In this form, the number of elements in
609     the colon-separated list _must_ equal the number of VCPUs of the
610     instance.
611
612     Example:
613
614     .. code-block:: bash
615
616       # Map the entire instance to CPUs 0-2
617       gnt-instance modify -H cpu_mask=0-2 my-inst
618
619       # Map vCPU 0 to physical CPU 1 and vCPU 1 to CPU 3 (assuming 2 vCPUs)
620       gnt-instance modify -H cpu_mask=1:3 my-inst
621
622       # Pin vCPU 0 to CPUs 1 or 2, and vCPU 1 to any CPU
623       gnt-instance modify -H cpu_mask=1-2:all my-inst
624
625       # Pin vCPU 0 to any CPU, vCPU 1 to CPUs 1, 3, 4 or 5, and CPU 2 to
626       # CPU 0 (backslashes for escaping the comma)
627       gnt-instance modify -H cpu_mask=all:1\\,3-5:0 my-inst
628
629       # Pin entire VM to CPU 0
630       gnt-instance modify -H cpu_mask=0 my-inst
631
632       # Turn off CPU pinning (default setting)
633       gnt-instance modify -H cpu_mask=all my-inst
634
635 cpu\_cap
636     Valid for the Xen hypervisor.
637
638     Set the maximum amount of cpu usage by the VM. The value is a percentage
639     between 0 and (100 * number of VCPUs). Default cap is 0: unlimited.
640
641 cpu\_weight
642     Valid for the Xen hypervisor.
643
644     Set the cpu time ratio to be allocated to the VM. Valid values are
645     between 1 and 65535. Default weight is 256.
646
647 usb\_mouse
648     Valid for the KVM hypervisor.
649
650     This option specifies the usb mouse type to be used. It can be
651     "mouse" or "tablet". When using VNC it's recommended to set it to
652     "tablet".
653
654 keymap
655     Valid for the KVM hypervisor.
656
657     This option specifies the keyboard mapping to be used. It is only
658     needed when using the VNC console. For example: "fr" or "en-gb".
659
660 reboot\_behavior
661     Valid for Xen PVM, Xen HVM and KVM hypervisors.
662
663     Normally if an instance reboots, the hypervisor will restart it. If
664     this option is set to ``exit``, the hypervisor will treat a reboot
665     as a shutdown instead.
666
667     It is set to ``reboot`` by default.
668
669 cpu\_cores
670     Valid for the KVM hypervisor.
671
672     Number of emulated CPU cores.
673
674 cpu\_threads
675     Valid for the KVM hypervisor.
676
677     Number of emulated CPU threads.
678
679 cpu\_sockets
680     Valid for the KVM hypervisor.
681
682     Number of emulated CPU sockets.
683
684 soundhw
685     Valid for the KVM hypervisor.
686
687     Comma separated list of emulated sounds cards, or "all" to enable
688     all the available ones.
689
690 usb\_devices
691     Valid for the KVM hypervisor.
692
693     Comma separated list of usb devices. These can be emulated devices
694     or passthrough ones, and each one gets passed to kvm with its own
695     ``-usbdevice`` option. See the **qemu**\(1) manpage for the syntax
696     of the possible components.
697
698 vga
699     Valid for the KVM hypervisor.
700
701     Emulated vga mode, passed the the kvm -vga option.
702
703 kvm\_extra
704     Valid for the KVM hypervisor.
705
706     Any other option to the KVM hypervisor, useful tweaking anything
707     that Ganeti doesn't support.
708
709 machine\_version
710     Valid for the KVM hypervisor.
711
712     Use in case an instance must be booted with an exact type of
713     machine version (due to e.g. outdated drivers). In case it's not set
714     the default version supported by your version of kvm is used.
715
716 kvm\_path
717     Valid for the KVM hypervisor.
718
719     Path to the userspace KVM (or qemu) program.
720
721 The ``-O (--os-parameters)`` option allows customisation of the OS
722 parameters. The actual parameter names and values depends on the OS
723 being used, but the syntax is the same key=value. For example, setting
724 a hypothetical ``dhcp`` parameter to yes can be achieved by::
725
726     gnt-instance add -O dhcp=yes ...
727
728 The ``-I (--iallocator)`` option specifies the instance allocator plugin
729 to use (``.`` means the default allocator). If you pass in this option
730 the allocator will select nodes for this instance automatically, so you
731 don't need to pass them with the ``-n`` option. For more information
732 please refer to the instance allocator documentation.
733
734 The ``-t (--disk-template)`` options specifies the disk layout type
735 for the instance.  The available choices are:
736
737 diskless
738     This creates an instance with no disks. Its useful for testing only
739     (or other special cases).
740
741 file
742     Disk devices will be regular files.
743
744 sharedfile
745     Disk devices will be regulare files on a shared directory.
746
747 plain
748     Disk devices will be logical volumes.
749
750 drbd
751     Disk devices will be drbd (version 8.x) on top of lvm volumes.
752
753 rbd
754     Disk devices will be rbd volumes residing inside a RADOS cluster.
755
756 blockdev
757     Disk devices will be adopted pre-existent block devices.
758
759 ext
760     Disk devices will be provided by external shared storage,
761     through the ExtStorage Interface using ExtStorage providers.
762
763 The optional second value of the ``-n (--node)`` is used for the drbd
764 template type and specifies the remote node.
765
766 If you do not want gnt-instance to wait for the disk mirror to be
767 synced, use the ``--no-wait-for-sync`` option.
768
769 The ``--file-storage-dir`` specifies the relative path under the
770 cluster-wide file storage directory to store file-based disks. It is
771 useful for having different subdirectories for different
772 instances. The full path of the directory where the disk files are
773 stored will consist of cluster-wide file storage directory + optional
774 subdirectory + instance name. Example:
775 ``@RPL_FILE_STORAGE_DIR@/mysubdir/instance1.example.com``. This
776 option is only relevant for instances using the file storage backend.
777
778 The ``--file-driver`` specifies the driver to use for file-based
779 disks. Note that currently these drivers work with the xen hypervisor
780 only. This option is only relevant for instances using the file
781 storage backend. The available choices are:
782
783 loop
784     Kernel loopback driver. This driver uses loopback devices to
785     access the filesystem within the file. However, running I/O
786     intensive applications in your instance using the loop driver
787     might result in slowdowns. Furthermore, if you use the loopback
788     driver consider increasing the maximum amount of loopback devices
789     (on most systems it's 8) using the max\_loop param.
790
791 blktap
792     The blktap driver (for Xen hypervisors). In order to be able to
793     use the blktap driver you should check if the 'blktapctrl' user
794     space disk agent is running (usually automatically started via
795     xend).  This user-level disk I/O interface has the advantage of
796     better performance. Especially if you use a network file system
797     (e.g. NFS) to store your instances this is the recommended choice.
798
799 If ``--ignore-ipolicy`` is given any instance policy violations occuring
800 during this operation are ignored.
801
802 See **ganeti**\(7) for a description of ``--submit`` and other common
803 options.
804
805 Example::
806
807     # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
808       -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
809     # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
810       -o debian-etch -n node1.example.com instance1.example.com
811     # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
812       -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
813     # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
814       -n node1.example.com:node2.example.com instance2.example.com
815     # gnt-instance add -t rbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
816       -n node1.example.com instance1.example.com
817     # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1 -B maxmem=512 \
818       -o debian-etch -n node1.example.com instance1.example.com
819     # gnt-instance add -t ext --disk 0:size=30g,provider=pvdr1,param1=val1 \
820       --disk 1:size=40g,provider=pvdr2,param2=val2,param3=val3 -B maxmem=512 \
821       -o debian-etch -n node1.example.com instance1.example.com
822
823
824 BATCH-CREATE
825 ^^^^^^^^^^^^
826
827 **batch-create** {instances\_file.json}
828
829 This command (similar to the Ganeti 1.2 **batcher** tool) submits
830 multiple instance creation jobs based on a definition file. The
831 instance configurations do not encompass all the possible options for
832 the **add** command, but only a subset.
833
834 The instance file should be a valid-formed JSON file, containing a
835 dictionary with instance name and instance parameters. The accepted
836 parameters are:
837
838 disk\_size
839     The size of the disks of the instance.
840
841 disk\_template
842     The disk template to use for the instance, the same as in the
843     **add** command.
844
845 backend
846     A dictionary of backend parameters.
847
848 hypervisor
849     A dictionary with a single key (the hypervisor name), and as value
850     the hypervisor options. If not passed, the default hypervisor and
851     hypervisor options will be inherited.
852
853 mac, ip, mode, link
854     Specifications for the one NIC that will be created for the
855     instance. 'bridge' is also accepted as a backwards compatible
856     key.
857
858 nics
859     List of NICs that will be created for the instance. Each entry
860     should be a dict, with mac, ip, mode and link as possible keys.
861     Please don't provide the "mac, ip, mode, link" parent keys if you
862     use this method for specifying NICs.
863
864 primary\_node, secondary\_node
865     The primary and optionally the secondary node to use for the
866     instance (in case an iallocator script is not used).
867
868 iallocator
869     Instead of specifying the nodes, an iallocator script can be used
870     to automatically compute them.
871
872 start
873     whether to start the instance
874
875 ip\_check
876     Skip the check for already-in-use instance; see the description in
877     the **add** command for details.
878
879 name\_check
880     Skip the name check for instances; see the description in the
881     **add** command for details.
882
883 file\_storage\_dir, file\_driver
884     Configuration for the file disk type, see the **add** command for
885     details.
886
887
888 A simple definition for one instance can be (with most of the
889 parameters taken from the cluster defaults)::
890
891     {
892       "instance3": {
893         "template": "drbd",
894         "os": "debootstrap",
895         "disk_size": ["25G"],
896         "iallocator": "dumb"
897       },
898       "instance5": {
899         "template": "drbd",
900         "os": "debootstrap",
901         "disk_size": ["25G"],
902         "iallocator": "dumb",
903         "hypervisor": "xen-hvm",
904         "hvparams": {"acpi": true},
905         "backend": {"maxmem": 512, "minmem": 256}
906       }
907     }
908
909 The command will display the job id for each submitted instance, as
910 follows::
911
912     # gnt-instance batch-create instances.json
913     instance3: 11224
914     instance5: 11225
915
916 REMOVE
917 ^^^^^^
918
919 **remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
920 [\--force] {*instance*}
921
922 Remove an instance. This will remove all data from the instance and
923 there is *no way back*. If you are not sure if you use an instance
924 again, use **shutdown** first and leave it in the shutdown state for a
925 while.
926
927 The ``--ignore-failures`` option will cause the removal to proceed
928 even in the presence of errors during the removal of the instance
929 (e.g. during the shutdown or the disk removal). If this option is not
930 given, the command will stop at the first error.
931
932 The ``--shutdown-timeout`` is used to specify how much time to wait
933 before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
934 kvm process for KVM, etc.). By default two minutes are given to each
935 instance to stop.
936
937 The ``--force`` option is used to skip the interactive confirmation.
938
939 See **ganeti**\(7) for a description of ``--submit`` and other common
940 options.
941
942 Example::
943
944     # gnt-instance remove instance1.example.com
945
946
947 LIST
948 ^^^^
949
950 | **list**
951 | [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
952 | [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
953
954 Shows the currently configured instances with memory usage, disk
955 usage, the node they are running on, and their run status.
956
957 The ``--no-headers`` option will skip the initial header line. The
958 ``--separator`` option takes an argument which denotes what will be
959 used between the output fields. Both these options are to help
960 scripting.
961
962 The units used to display the numeric values in the output varies,
963 depending on the options given. By default, the values will be
964 formatted in the most appropriate unit. If the ``--separator`` option
965 is given, then the values are shown in mebibytes to allow parsing by
966 scripts. In both cases, the ``--units`` option can be used to enforce
967 a given output unit.
968
969 The ``-v`` option activates verbose mode, which changes the display of
970 special field states (see **ganeti**\(7)).
971
972 The ``-o (--output)`` option takes a comma-separated list of output
973 fields. The available fields and their meaning are:
974
975 @QUERY_FIELDS_INSTANCE@
976
977 If the value of the option starts with the character ``+``, the new
978 field(s) will be added to the default list. This allows one to quickly
979 see the default list plus a few other fields, instead of retyping the
980 entire list of fields.
981
982 There is a subtle grouping about the available output fields: all
983 fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
984 ``status`` are configuration value and not run-time values. So if you
985 don't select any of the these fields, the query will be satisfied
986 instantly from the cluster configuration, without having to ask the
987 remote nodes for the data. This can be helpful for big clusters when
988 you only want some data and it makes sense to specify a reduced set of
989 output fields.
990
991 If exactly one argument is given and it appears to be a query filter
992 (see **ganeti**\(7)), the query result is filtered accordingly. For
993 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
994 (``-F``) option forces the argument to be treated as a filter (e.g.
995 ``gnt-instance list -F admin_state``).
996
997 The default output field list is: ``name``, ``os``, ``pnode``,
998 ``admin_state``, ``oper_state``, ``oper_ram``.
999
1000
1001 LIST-FIELDS
1002 ^^^^^^^^^^^
1003
1004 **list-fields** [field...]
1005
1006 Lists available fields for instances.
1007
1008
1009 INFO
1010 ^^^^
1011
1012 **info** [-s \| \--static] [\--roman] {\--all \| *instance*}
1013
1014 Show detailed information about the given instance(s). This is
1015 different from **list** as it shows detailed data about the instance's
1016 disks (especially useful for the drbd disk template).
1017
1018 If the option ``-s`` is used, only information available in the
1019 configuration file is returned, without querying nodes, making the
1020 operation faster.
1021
1022 Use the ``--all`` to get info about all instances, rather than
1023 explicitly passing the ones you're interested in.
1024
1025 The ``--roman`` option can be used to cause envy among people who like
1026 ancient cultures, but are stuck with non-latin-friendly cluster
1027 virtualization technologies.
1028
1029 MODIFY
1030 ^^^^^^
1031
1032 | **modify**
1033 | [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
1034 | [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
1035 | [{-m|\--runtime-memory} *SIZE*]
1036 | [\--net add*[:options]* \| \--net [*N*:]remove \| \--net *N:options*]
1037 | [\--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \|
1038 |  \--disk add:size=*SIZE*,provider=*PROVIDER*[,param=*value*... ] \|
1039 |  \--disk [*N*:]remove \|
1040 |  \--disk *N*:mode=*MODE*]
1041 | [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
1042 | [\--os-type=*OS* [\--force-variant]]
1043 | [{-O|\--os-parameters} *param*=*value*... ]
1044 | [\--offline \| \--online]
1045 | [\--submit]
1046 | [\--ignore-ipolicy]
1047 | {*instance*}
1048
1049 Modifies the memory size, number of vcpus, ip address, MAC address
1050 and/or NIC parameters for an instance. It can also add and remove
1051 disks and NICs to/from the instance. Note that you need to give at
1052 least one of the arguments, otherwise the command complains.
1053
1054 The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
1055 and ``-O (--os-parameters)`` options specifies hypervisor, backend and
1056 OS parameter options in the form of name=value[,...]. For details
1057 which options can be specified, see the **add** command.
1058
1059 The ``-t (--disk-template)`` option will change the disk template of
1060 the instance.  Currently only conversions between the plain and drbd
1061 disk templates are supported, and the instance must be stopped before
1062 attempting the conversion. When changing from the plain to the drbd
1063 disk template, a new secondary node must be specified via the ``-n``
1064 option. The option ``--no-wait-for-sync`` can be used when converting
1065 to the ``drbd`` template in order to make the instance available for
1066 startup before DRBD has finished resyncing.
1067
1068 The ``-m (--runtime-memory)`` option will change an instance's runtime
1069 memory to the given size (in MB if a different suffix is not specified),
1070 by ballooning it up or down to the new value.
1071
1072 The ``--disk add:size=``*SIZE* option adds a disk to the instance. The
1073 optional ``vg=``*VG* option specifies an LVM volume group other than the
1074 default volume group to create the disk on. For DRBD disks, the
1075 ``metavg=``*VG* option specifies the volume group for the metadata
1076 device. When adding an ExtStorage disk the ``provider=``*PROVIDER*
1077 option is also mandatory and specifies the ExtStorage provider. Also,
1078 for ExtStorage disks arbitrary parameters can be passed as additional
1079 comma separated options, same as in the **add** command. ``--disk``
1080 *N*``:add,size=``**SIZE** can be used to add a disk at a specific index.
1081 The ``--disk remove`` option will remove the last disk of the instance.
1082 Use ``--disk `` *N*``:remove`` to remove a disk by its index. The
1083 ``--disk`` *N*``:mode=``*MODE* option will change the mode of the Nth
1084 disk of the instance between read-only (``ro``) and read-write (``rw``).
1085
1086 The ``--net add:``*options* and ``--net`` *N*``:add,``*options* option
1087 will add a new network interface to the instance. The available options
1088 are the same as in the **add** command (``mac``, ``ip``, ``link``,
1089 ``mode``, ``network``). The ``--net remove`` will remove the last network
1090 interface of the instance (``--net`` *N*``:remove`` for a specific index),
1091 while the ``--net`` *N*``:``*options* option will change the parameters of
1092 the Nth instance network interface.
1093
1094 The option ``-o (--os-type)`` will change the OS name for the instance
1095 (without reinstallation). In case an OS variant is specified that is
1096 not found, then by default the modification is refused, unless
1097 ``--force-variant`` is passed. An invalid OS will also be refused,
1098 unless the ``--force`` option is given.
1099
1100 The ``--online`` and ``--offline`` options are used to transition an
1101 instance into and out of the ``offline`` state. An instance can be
1102 turned offline only if it was previously down. The ``--online`` option
1103 fails if the instance was not in the ``offline`` state, otherwise it
1104 changes instance's state to ``down``. These modifications take effect
1105 immediately.
1106
1107 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1108 during this operation are ignored.
1109
1110 See **ganeti**\(7) for a description of ``--submit`` and other common
1111 options.
1112
1113 Most of the changes take effect at the next restart. If the instance is
1114 running, there is no effect on the instance.
1115
1116 REINSTALL
1117 ^^^^^^^^^
1118
1119 | **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
1120 | [\--force-multiple]
1121 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
1122 | [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...}
1123
1124 Reinstalls the operating system on the given instance(s). The
1125 instance(s) must be stopped when running this command. If the ``-o
1126 (--os-type)`` is specified, the operating system is changed.
1127
1128 The ``--select-os`` option switches to an interactive OS reinstall.
1129 The user is prompted to select the OS template from the list of
1130 available OS templates. OS parameters can be overridden using ``-O
1131 (--os-parameters)`` (more documentation for this option under the
1132 **add** command).
1133
1134 Since this is a potentially dangerous command, the user will be
1135 required to confirm this action, unless the ``-f`` flag is passed.
1136 When multiple instances are selected (either by passing multiple
1137 arguments or by using the ``--node``, ``--primary``, ``--secondary``
1138 or ``--all`` options), the user must pass the ``--force-multiple``
1139 options to skip the interactive confirmation.
1140
1141 See **ganeti**\(7) for a description of ``--submit`` and other common
1142 options.
1143
1144 RENAME
1145 ^^^^^^
1146
1147 | **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
1148 | {*instance*} {*new\_name*}
1149
1150 Renames the given instance. The instance must be stopped when running
1151 this command. The requirements for the new name are the same as for
1152 adding an instance: the new name must be resolvable and the IP it
1153 resolves to must not be reachable (in order to prevent duplicate IPs
1154 the next time the instance is started). The IP test can be skipped if
1155 the ``--no-ip-check`` option is passed.
1156
1157 Note that you can rename an instance to its same name, to force
1158 re-executing the os-specific rename script for that instance, if
1159 needed.
1160
1161 The ``--no-name-check`` skips the check for the new instance name via
1162 the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
1163 that the resolved name matches the provided name. Since the name check
1164 is used to compute the IP address, if you pass this option you must also
1165 pass the ``--no-ip-check`` option.
1166
1167 See **ganeti**\(7) for a description of ``--submit`` and other common
1168 options.
1169
1170 Starting/stopping/connecting to console
1171 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1172
1173 STARTUP
1174 ^^^^^^^
1175
1176 | **startup**
1177 | [\--force] [\--ignore-offline]
1178 | [\--force-multiple] [\--no-remember]
1179 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1180 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1181 | [{-H|\--hypervisor-parameters} ``key=value...``]
1182 | [{-B|\--backend-parameters} ``key=value...``]
1183 | [\--submit] [\--paused]
1184 | {*name*...}
1185
1186 Starts one or more instances, depending on the following options.  The
1187 four available modes are:
1188
1189 \--instance
1190     will start the instances given as arguments (at least one argument
1191     required); this is the default selection
1192
1193 \--node
1194     will start the instances who have the given node as either primary
1195     or secondary
1196
1197 \--primary
1198     will start all instances whose primary node is in the list of nodes
1199     passed as arguments (at least one node required)
1200
1201 \--secondary
1202     will start all instances whose secondary node is in the list of
1203     nodes passed as arguments (at least one node required)
1204
1205 \--all
1206     will start all instances in the cluster (no arguments accepted)
1207
1208 \--tags
1209     will start all instances in the cluster with the tags given as
1210     arguments
1211
1212 \--node-tags
1213     will start all instances in the cluster on nodes with the tags
1214     given as arguments
1215
1216 \--pri-node-tags
1217     will start all instances in the cluster on primary nodes with the
1218     tags given as arguments
1219
1220 \--sec-node-tags
1221     will start all instances in the cluster on secondary nodes with the
1222     tags given as arguments
1223
1224 Note that although you can pass more than one selection option, the
1225 last one wins, so in order to guarantee the desired result, don't pass
1226 more than one such option.
1227
1228 Use ``--force`` to start even if secondary disks are failing.
1229 ``--ignore-offline`` can be used to ignore offline primary nodes and
1230 mark the instance as started even if the primary is not available.
1231
1232 The ``--force-multiple`` will skip the interactive confirmation in the
1233 case the more than one instance will be affected.
1234
1235 The ``--no-remember`` option will perform the startup but not change
1236 the state of the instance in the configuration file (if it was stopped
1237 before, Ganeti will still think it needs to be stopped). This can be
1238 used for testing, or for a one shot-start where you don't want the
1239 watcher to restart the instance if it crashes.
1240
1241 The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
1242 options specify temporary hypervisor and backend parameters that can
1243 be used to start an instance with modified parameters. They can be
1244 useful for quick testing without having to modify an instance back and
1245 forth, e.g.::
1246
1247     # gnt-instance start -H kernel_args="single" instance1
1248     # gnt-instance start -B maxmem=2048 instance2
1249
1250
1251 The first form will start the instance instance1 in single-user mode,
1252 and the instance instance2 with 2GB of RAM (this time only, unless
1253 that is the actual instance memory size already). Note that the values
1254 override the instance parameters (and not extend them): an instance
1255 with "kernel\_args=ro" when started with -H kernel\_args=single will
1256 result in "single", not "ro single".
1257
1258 The ``--paused`` option is only valid for Xen and kvm hypervisors.  This
1259 pauses the instance at the start of bootup, awaiting ``gnt-instance
1260 console`` to unpause it, allowing the entire boot process to be
1261 monitored for debugging.
1262
1263 See **ganeti**\(7) for a description of ``--submit`` and other common
1264 options.
1265
1266 Example::
1267
1268     # gnt-instance start instance1.example.com
1269     # gnt-instance start --node node1.example.com node2.example.com
1270     # gnt-instance start --all
1271
1272
1273 SHUTDOWN
1274 ^^^^^^^^
1275
1276 | **shutdown**
1277 | [\--timeout=*N*]
1278 | [\--force] [\--force-multiple] [\--ignore-offline] [\--no-remember]
1279 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1280 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1281 | [\--submit]
1282 | {*name*...}
1283
1284 Stops one or more instances. If the instance cannot be cleanly stopped
1285 during a hardcoded interval (currently 2 minutes), it will forcibly
1286 stop the instance (equivalent to switching off the power on a physical
1287 machine).
1288
1289 The ``--timeout`` is used to specify how much time to wait before
1290 forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm
1291 process for KVM, etc.). By default two minutes are given to each
1292 instance to stop.
1293
1294 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1295 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1296 ``--sec-node-tags`` options are similar as for the **startup** command
1297 and they influence the actual instances being shutdown.
1298
1299 ``--ignore-offline`` can be used to ignore offline primary nodes and
1300 force the instance to be marked as stopped. This option should be used
1301 with care as it can lead to an inconsistent cluster state.
1302
1303 Use ``--force`` to be able to shutdown an instance even when it's marked
1304 as offline. This is useful is an offline instance ends up in the
1305 ``ERROR_up`` state, for example.
1306
1307 The ``--no-remember`` option will perform the shutdown but not change
1308 the state of the instance in the configuration file (if it was running
1309 before, Ganeti will still thinks it needs to be running). This can be
1310 useful for a cluster-wide shutdown, where some instances are marked as
1311 up and some as down, and you don't want to change the running state:
1312 you just need to disable the watcher, shutdown all instances with
1313 ``--no-remember``, and when the watcher is activated again it will
1314 restore the correct runtime state for all instances.
1315
1316 See **ganeti**\(7) for a description of ``--submit`` and other common
1317 options.
1318
1319 Example::
1320
1321     # gnt-instance shutdown instance1.example.com
1322     # gnt-instance shutdown --all
1323
1324
1325 REBOOT
1326 ^^^^^^
1327
1328 | **reboot**
1329 | [{-t|\--type} *REBOOT-TYPE*]
1330 | [\--ignore-secondaries]
1331 | [\--shutdown-timeout=*N*]
1332 | [\--force-multiple]
1333 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1334 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1335 | [\--submit]
1336 | [*name*...]
1337
1338 Reboots one or more instances. The type of reboot depends on the value
1339 of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
1340 does a instance stop, recreates the hypervisor config for the instance
1341 and starts the instance. A full reboot does the equivalent of
1342 **gnt-instance shutdown && gnt-instance startup**.  The default is
1343 hard reboot.
1344
1345 For the hard reboot the option ``--ignore-secondaries`` ignores errors
1346 for the secondary node while re-assembling the instance disks.
1347
1348 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1349 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1350 ``--sec-node-tags`` options are similar as for the **startup** command
1351 and they influence the actual instances being rebooted.
1352
1353 The ``--shutdown-timeout`` is used to specify how much time to wait
1354 before forcing the shutdown (xm destroy in xen, killing the kvm
1355 process, for kvm). By default two minutes are given to each instance
1356 to stop.
1357
1358 The ``--force-multiple`` will skip the interactive confirmation in the
1359 case the more than one instance will be affected.
1360
1361 See **ganeti**\(7) for a description of ``--submit`` and other common
1362 options.
1363
1364 Example::
1365
1366     # gnt-instance reboot instance1.example.com
1367     # gnt-instance reboot --type=full instance1.example.com
1368
1369
1370 CONSOLE
1371 ^^^^^^^
1372
1373 **console** [\--show-cmd] {*instance*}
1374
1375 Connects to the console of the given instance. If the instance is not
1376 up, an error is returned. Use the ``--show-cmd`` option to display the
1377 command instead of executing it.
1378
1379 For HVM instances, this will attempt to connect to the serial console
1380 of the instance. To connect to the virtualized "physical" console of a
1381 HVM instance, use a VNC client with the connection info from the
1382 **info** command.
1383
1384 For Xen/kvm instances, if the instance is paused, this attempts to
1385 unpause the instance after waiting a few seconds for the connection to
1386 the console to be made.
1387
1388 Example::
1389
1390     # gnt-instance console instance1.example.com
1391
1392
1393 Disk management
1394 ~~~~~~~~~~~~~~~
1395
1396 REPLACE-DISKS
1397 ^^^^^^^^^^^^^
1398
1399 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p}
1400 [\--disks *idx*] {*instance*}
1401
1402 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
1403 [\--disks *idx*] {*instance*}
1404
1405 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1406 {{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
1407
1408 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1409 {-a\|\--auto} {*instance*}
1410
1411 This command is a generalized form for replacing disks. It is
1412 currently only valid for the mirrored (DRBD) disk template.
1413
1414 The first form (when passing the ``-p`` option) will replace the disks
1415 on the primary, while the second form (when passing the ``-s`` option
1416 will replace the disks on the secondary node. For these two cases (as
1417 the node doesn't change), it is possible to only run the replace for a
1418 subset of the disks, using the option ``--disks`` which takes a list
1419 of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
1420 the first and third disks.
1421
1422 The third form (when passing either the ``--iallocator`` or the
1423 ``--new-secondary`` option) is designed to change secondary node of the
1424 instance. Specifying ``--iallocator`` makes the new secondary be
1425 selected automatically by the specified allocator plugin (use ``.`` to
1426 indicate the default allocator), otherwise the new secondary node will
1427 be the one chosen manually via the ``--new-secondary`` option.
1428
1429 Note that it is not possible to select an offline or drained node as a
1430 new secondary.
1431
1432 The fourth form (when using ``--auto``) will automatically determine
1433 which disks of an instance are faulty and replace them within the same
1434 node. The ``--auto`` option works only when an instance has only
1435 faulty disks on either the primary or secondary node; it doesn't work
1436 when both sides have faulty disks.
1437
1438 The ``--early-release`` changes the code so that the old storage on
1439 secondary node(s) is removed early (before the resync is completed)
1440 and the internal Ganeti locks for the current (and new, if any)
1441 secondary node are also released, thus allowing more parallelism in
1442 the cluster operation. This should be used only when recovering from a
1443 disk failure on the current secondary (thus the old storage is already
1444 broken) or when the storage on the primary node is known to be fine
1445 (thus we won't need the old storage for potential recovery).
1446
1447 The ``--ignore-ipolicy`` let the command ignore instance policy
1448 violations if replace-disks changes groups and the instance would
1449 violate the new groups instance policy.
1450
1451 See **ganeti**\(7) for a description of ``--submit`` and other common
1452 options.
1453
1454 ACTIVATE-DISKS
1455 ^^^^^^^^^^^^^^
1456
1457 **activate-disks** [\--submit] [\--ignore-size] [\--wait-for-sync] {*instance*}
1458
1459 Activates the block devices of the given instance. If successful, the
1460 command will show the location and name of the block devices::
1461
1462     node1.example.com:disk/0:/dev/drbd0
1463     node1.example.com:disk/1:/dev/drbd1
1464
1465
1466 In this example, *node1.example.com* is the name of the node on which
1467 the devices have been activated. The *disk/0* and *disk/1* are the
1468 Ganeti-names of the instance disks; how they are visible inside the
1469 instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
1470 actual block devices as visible on the node.
1471
1472 The ``--ignore-size`` option can be used to activate disks ignoring
1473 the currently configured size in Ganeti. This can be used in cases
1474 where the configuration has gotten out of sync with the real-world
1475 (e.g. after a partially-failed grow-disk operation or due to rounding
1476 in LVM devices). This should not be used in normal cases, but only
1477 when activate-disks fails without it.
1478
1479 The ``--wait-for-sync`` option will ensure that the command returns only
1480 after the instance's disks are synchronised (mostly for DRBD); this can
1481 be useful to ensure consistency, as otherwise there are no commands that
1482 can wait until synchronisation is done. However when passing this
1483 option, the command will have additional output, making it harder to
1484 parse the disk information.
1485
1486 Note that it is safe to run this command while the instance is already
1487 running.
1488
1489 See **ganeti**\(7) for a description of ``--submit`` and other common
1490 options.
1491
1492 DEACTIVATE-DISKS
1493 ^^^^^^^^^^^^^^^^
1494
1495 **deactivate-disks** [-f] [\--submit] {*instance*}
1496
1497 De-activates the block devices of the given instance. Note that if you
1498 run this command for an instance with a drbd disk template, while it
1499 is running, it will not be able to shutdown the block devices on the
1500 primary node, but it will shutdown the block devices on the secondary
1501 nodes, thus breaking the replication.
1502
1503 The ``-f``/``--force`` option will skip checks that the instance is
1504 down; in case the hypervisor is confused and we can't talk to it,
1505 normally Ganeti will refuse to deactivate the disks, but with this
1506 option passed it will skip this check and directly try to deactivate
1507 the disks. This can still fail due to the instance actually running or
1508 other issues.
1509
1510 See **ganeti**\(7) for a description of ``--submit`` and other common
1511 options.
1512
1513 GROW-DISK
1514 ^^^^^^^^^
1515
1516 | **grow-disk** [\--no-wait-for-sync] [\--submit] [\--absolute]
1517 | {*instance*} {*disk*} {*amount*}
1518
1519 Grows an instance's disk. This is only possible for instances having a
1520 plain, drbd, file, sharedfile, rbd or ext disk template. For the ext
1521 template to work, the ExtStorage provider should also support growing.
1522 This means having a ``grow`` script that actually grows the volume of
1523 the external shared storage.
1524
1525 Note that this command only change the block device size; it will not
1526 grow the actual filesystems, partitions, etc. that live on that
1527 disk. Usually, you will need to:
1528
1529 #. use **gnt-instance grow-disk**
1530
1531 #. reboot the instance (later, at a convenient time)
1532
1533 #. use a filesystem resizer, such as **ext2online**\(8) or
1534    **xfs\_growfs**\(8) to resize the filesystem, or use **fdisk**\(8) to
1535    change the partition table on the disk
1536
1537 The *disk* argument is the index of the instance disk to grow. The
1538 *amount* argument is given as a number which can have a suffix (like the
1539 disk size in instance create); if the suffix is missing, the value will
1540 be interpreted as mebibytes.
1541
1542 By default, the *amount* value represents the desired increase in the
1543 disk size (e.g. an amount of 1G will take a disk of size 3G to 4G). If
1544 the optional ``--absolute`` parameter is passed, then the *amount*
1545 argument doesn't represent the delta, but instead the desired final disk
1546 size (e.g. an amount of 8G will take a disk of size 4G to 8G).
1547
1548 For instances with a drbd template, note that the disk grow operation
1549 might complete on one node but fail on the other; this will leave the
1550 instance with different-sized LVs on the two nodes, but this will not
1551 create problems (except for unused space).
1552
1553 If you do not want gnt-instance to wait for the new disk region to be
1554 synced, use the ``--no-wait-for-sync`` option.
1555
1556 See **ganeti**\(7) for a description of ``--submit`` and other common
1557 options.
1558
1559 Example (increase the first disk for instance1 by 16GiB)::
1560
1561     # gnt-instance grow-disk instance1.example.com 0 16g
1562
1563 Example for increasing the disk size to a certain size::
1564
1565    # gnt-instance grow-disk --absolute instance1.example.com 0 32g
1566
1567 Also note that disk shrinking is not supported; use **gnt-backup
1568 export** and then **gnt-backup import** to reduce the disk size of an
1569 instance.
1570
1571 RECREATE-DISKS
1572 ^^^^^^^^^^^^^^
1573
1574 | **recreate-disks** [\--submit]
1575 | [{-n node1:[node2] \| {-I\|\--iallocator *name*}}]
1576 | [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
1577
1578 Recreates all or a subset of disks of the given instance.
1579
1580 Note that this functionality should only be used for missing disks; if
1581 any of the given disks already exists, the operation will fail.  While
1582 this is suboptimal, recreate-disks should hopefully not be needed in
1583 normal operation and as such the impact of this is low.
1584
1585 If only a subset should be recreated, any number of ``disk`` options can
1586 be specified. It expects a disk index and an optional list of disk
1587 parameters to change. Only ``size`` and ``mode`` can be changed while
1588 recreating disks. To recreate all disks while changing parameters on
1589 a subset only, a ``--disk`` option must be given for every disk of the
1590 instance.
1591
1592 Optionally the instance's disks can be recreated on different
1593 nodes. This can be useful if, for example, the original nodes of the
1594 instance have gone down (and are marked offline), so we can't recreate
1595 on the same nodes. To do this, pass the new node(s) via ``-n`` option,
1596 with a syntax similar to the **add** command. The number of nodes
1597 passed must equal the number of nodes that the instance currently
1598 has. Note that changing nodes is only allowed when all disks are
1599 replaced, e.g. when no ``--disk`` option is passed.
1600
1601 Another method of choosing which nodes to place the instance on is by
1602 using the specified iallocator, passing the ``--iallocator`` option.
1603 The primary and secondary nodes will be chosen by the specified
1604 iallocator plugin, or by the default allocator if ``.`` is specified.
1605
1606 See **ganeti**\(7) for a description of ``--submit`` and other common
1607 options.
1608
1609 Recovery/moving
1610 ~~~~~~~~~~~~~~~
1611
1612 FAILOVER
1613 ^^^^^^^^
1614
1615 | **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
1616 | [\--shutdown-timeout=*N*]
1617 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
1618 | [\--submit]
1619 | {*instance*}
1620
1621 Failover will stop the instance (if running), change its primary node,
1622 and if it was originally running it will start it again (on the new
1623 primary). This works for instances with drbd template (in which case you
1624 can only fail to the secondary node) and for externally mirrored
1625 templates (sharedfile, blockdev, rbd and ext) (in which case you can
1626 fail to any other node).
1627
1628 If the instance's disk template is of type sharedfile, blockdev, rbd or
1629 ext, then you can explicitly specify the target node (which can be any
1630 node) using the ``-n`` or ``--target-node`` option, or specify an
1631 iallocator plugin using the ``-I`` or ``--iallocator`` option. If you
1632 omit both, the default iallocator will be used to specify the target
1633 node.
1634
1635 If the instance's disk template is of type drbd, the target node is
1636 automatically selected as the drbd's secondary node. Changing the
1637 secondary node is possible with a replace-disks operation.
1638
1639 Normally the failover will check the consistency of the disks before
1640 failing over the instance. If you are trying to migrate instances off
1641 a dead node, this will fail. Use the ``--ignore-consistency`` option
1642 for this purpose. Note that this option can be dangerous as errors in
1643 shutting down the instance will be ignored, resulting in possibly
1644 having the instance running on two machines in parallel (on
1645 disconnected DRBD drives).
1646
1647 The ``--shutdown-timeout`` is used to specify how much time to wait
1648 before forcing the shutdown (xm destroy in xen, killing the kvm
1649 process, for kvm). By default two minutes are given to each instance
1650 to stop.
1651
1652 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1653 during this operation are ignored.
1654
1655 See **ganeti**\(7) for a description of ``--submit`` and other common
1656 options.
1657
1658 Example::
1659
1660     # gnt-instance failover instance1.example.com
1661
1662 For externally mirrored templates also ``-n`` is available::
1663
1664     # gnt-instance failover -n node3.example.com instance1.example.com
1665
1666
1667 MIGRATE
1668 ^^^^^^^
1669
1670 | **migrate** [-f] [\--allow-failover] [\--non-live]
1671 | [\--migration-mode=live\|non-live] [\--ignore-ipolicy]
1672 | [\--no-runtime-changes] [\--submit]
1673 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
1674
1675 | **migrate** [-f] \--cleanup [\--submit] {*instance*}
1676
1677 Migrate will move the instance to its secondary node without shutdown.
1678 As with failover, it works for instances having the drbd disk template
1679 or an externally mirrored disk template type such as sharedfile,
1680 blockdev, rbd or ext.
1681
1682 If the instance's disk template is of type sharedfile, blockdev, rbd or
1683 ext, then you can explicitly specify the target node (which can be any
1684 node) using the ``-n`` or ``--target-node`` option, or specify an
1685 iallocator plugin using the ``-I`` or ``--iallocator`` option. If you
1686 omit both, the default iallocator will be used to specify the target
1687 node.  Alternatively, the default iallocator can be requested by
1688 specifying ``.`` as the name of the plugin.
1689
1690 If the instance's disk template is of type drbd, the target node is
1691 automatically selected as the drbd's secondary node. Changing the
1692 secondary node is possible with a replace-disks operation.
1693
1694 The migration command needs a perfectly healthy instance for drbd
1695 instances, as we rely on the dual-master capability of drbd8 and the
1696 disks of the instance are not allowed to be degraded.
1697
1698 The ``--non-live`` and ``--migration-mode=non-live`` options will
1699 switch (for the hypervisors that support it) between a "fully live"
1700 (i.e. the interruption is as minimal as possible) migration and one in
1701 which the instance is frozen, its state saved and transported to the
1702 remote node, and then resumed there. This all depends on the
1703 hypervisor support for two different methods. In any case, it is not
1704 an error to pass this parameter (it will just be ignored if the
1705 hypervisor doesn't support it). The option ``--migration-mode=live``
1706 option will request a fully-live migration. The default, when neither
1707 option is passed, depends on the hypervisor parameters (and can be
1708 viewed with the **gnt-cluster info** command).
1709
1710 If the ``--cleanup`` option is passed, the operation changes from
1711 migration to attempting recovery from a failed previous migration. In
1712 this mode, Ganeti checks if the instance runs on the correct node (and
1713 updates its configuration if not) and ensures the instances' disks
1714 are configured correctly. In this mode, the ``--non-live`` option is
1715 ignored.
1716
1717 The option ``-f`` will skip the prompting for confirmation.
1718
1719 If ``--allow-failover`` is specified it tries to fallback to failover if
1720 it already can determine that a migration won't work (e.g. if the
1721 instance is shut down). Please note that the fallback will not happen
1722 during execution. If a migration fails during execution it still fails.
1723
1724 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1725 during this operation are ignored.
1726
1727 The ``--no-runtime-changes`` option forbids migrate to alter an
1728 instance's runtime before migrating it (eg. ballooning an instance
1729 down because the target node doesn't have enough available memory).
1730
1731 If an instance has the backend parameter ``always_failover`` set to
1732 true, then the migration is automatically converted into a failover.
1733
1734 See **ganeti**\(7) for a description of ``--submit`` and other common
1735 options.
1736
1737 Example (and expected output)::
1738
1739     # gnt-instance migrate instance1
1740     Instance instance1 will be migrated. Note that migration
1741     might impact the instance if anything goes wrong (e.g. due to bugs in
1742     the hypervisor). Continue?
1743     y/[n]/?: y
1744     Migrating instance instance1.example.com
1745     * checking disk consistency between source and target
1746     * switching node node2.example.com to secondary mode
1747     * changing into standalone mode
1748     * changing disks into dual-master mode
1749     * wait until resync is done
1750     * preparing node2.example.com to accept the instance
1751     * migrating instance to node2.example.com
1752     * switching node node1.example.com to secondary mode
1753     * wait until resync is done
1754     * changing into standalone mode
1755     * changing disks into single-master mode
1756     * wait until resync is done
1757     * done
1758     #
1759
1760
1761 MOVE
1762 ^^^^
1763
1764 | **move** [-f] [\--ignore-consistency]
1765 | [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
1766 | {*instance*}
1767
1768 Move will move the instance to an arbitrary node in the cluster. This
1769 works only for instances having a plain or file disk template.
1770
1771 Note that since this operation is done via data copy, it will take a
1772 long time for big disks (similar to replace-disks for a drbd
1773 instance).
1774
1775 The ``--shutdown-timeout`` is used to specify how much time to wait
1776 before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the
1777 kvm process for KVM, etc.). By default two minutes are given to each
1778 instance to stop.
1779
1780 The ``--ignore-consistency`` option will make Ganeti ignore any errors
1781 in trying to shutdown the instance on its node; useful if the
1782 hypervisor is broken and you want to recover the data.
1783
1784 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1785 during this operation are ignored.
1786
1787 See **ganeti**\(7) for a description of ``--submit`` and other common
1788 options.
1789
1790 Example::
1791
1792     # gnt-instance move -n node3.example.com instance1.example.com
1793
1794
1795 CHANGE-GROUP
1796 ^^^^^^^^^^^^
1797
1798 | **change-group** [\--submit]
1799 | [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
1800
1801 This command moves an instance to another node group. The move is
1802 calculated by an iallocator, either given on the command line or as a
1803 cluster default.
1804
1805 If no specific destination groups are specified using ``--to``, all
1806 groups except the one containing the instance are considered.
1807
1808 See **ganeti**\(7) for a description of ``--submit`` and other common
1809 options.
1810
1811 Example::
1812
1813     # gnt-instance change-group -I hail --to rack2 inst1.example.com
1814
1815
1816 Tags
1817 ~~~~
1818
1819 ADD-TAGS
1820 ^^^^^^^^
1821
1822 **add-tags** [\--from *file*] {*instancename*} {*tag*...}
1823
1824 Add tags to the given instance. If any of the tags contains invalid
1825 characters, the entire operation will abort.
1826
1827 If the ``--from`` option is given, the list of tags will be extended
1828 with the contents of that file (each line becomes a tag).  In this
1829 case, there is not need to pass tags on the command line (if you do,
1830 both sources will be used). A file name of ``-`` will be interpreted
1831 as stdin.
1832
1833 LIST-TAGS
1834 ^^^^^^^^^
1835
1836 **list-tags** {*instancename*}
1837
1838 List the tags of the given instance.
1839
1840 REMOVE-TAGS
1841 ^^^^^^^^^^^
1842
1843 **remove-tags** [\--from *file*] {*instancename*} {*tag*...}
1844
1845 Remove tags from the given instance. If any of the tags are not
1846 existing on the node, the entire operation will abort.
1847
1848 If the ``--from`` option is given, the list of tags to be removed will
1849 be extended with the contents of that file (each line becomes a tag).
1850 In this case, there is not need to pass tags on the command line (if
1851 you do, tags from both sources will be removed). A file name of ``-``
1852 will be interpreted as stdin.
1853
1854 .. vim: set textwidth=72 :
1855 .. Local Variables:
1856 .. mode: rst
1857 .. fill-column: 72
1858 .. End: