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