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