1 gnt-instance(8) Ganeti | Version @GANETI_VERSION@
2 =================================================
7 gnt-instance - Ganeti instance administration
12 **gnt-instance** {command} [arguments...]
17 The **gnt-instance** command is used for instance administration in
23 Creation/removal/querying
24 ~~~~~~~~~~~~~~~~~~~~~~~~~
30 | {-t|\--disk-template {diskless | file \| plain \| drbd \| rbd}}
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*}
45 Creates a new instance on the specified host. The *instance* argument
46 must be in DNS, but depending on the bridge/routing setup, need not be
47 in the same network as the nodes in the cluster.
49 The ``disk`` option specifies the parameters for the disks of the
50 instance. The numbering of disks starts at zero, and at least one disk
51 needs to be passed. For each disk, either the size or the adoption
52 source needs to be given, and optionally the access mode (read-only or
53 the default of read-write) and the LVM volume group can also be
54 specified (via the ``vg`` key). For DRBD devices, a different VG can
55 be specified for the metadata device using the ``metavg`` key. The
56 size is interpreted (when no unit is given) in mebibytes. You can also
57 use one of the suffixes *m*, *g* or *t* to specify the exact the units
58 used; these suffixes map to mebibytes, gibibytes and tebibytes.
60 When using the ``adopt`` key in the disk definition, Ganeti will
61 reuse those volumes (instead of creating new ones) as the
62 instance's disks. Ganeti will rename these volumes to the standard
63 format, and (without installing the OS) will use them as-is for the
64 instance. This allows migrating instances from non-managed mode
65 (e.g. plain KVM with LVM) to being managed via Ganeti. Please note that
66 this works only for the \`plain' disk template (see below for
69 Alternatively, a single-disk instance can be created via the ``-s``
70 option which takes a single argument, the size of the disk. This is
71 similar to the Ganeti 1.2 version (but will only create one disk).
73 The minimum disk specification is therefore ``--disk 0:size=20G`` (or
74 ``-s 20G`` when using the ``-s`` option), and a three-disk instance
75 can be specified as ``--disk 0:size=20G --disk 1:size=4G --disk
78 The ``--no-ip-check`` skips the checks that are done to see if the
79 instance's IP is not already alive (i.e. reachable from the master
82 The ``--no-name-check`` skips the check for the instance name via
83 the resolver (e.g. in DNS or /etc/hosts, depending on your setup).
84 Since the name check is used to compute the IP address, if you pass
85 this option you must also pass the ``--no-ip-check`` option.
87 If you don't want the instance to automatically start after
88 creation, this is possible via the ``--no-start`` option. This will
89 leave the instance down until a subsequent **gnt-instance start**
92 The NICs of the instances can be specified via the ``--net``
93 option. By default, one NIC is created for the instance, with a
94 random MAC, and set up according the the cluster level nic
95 parameters. Each NIC can take these parameters (all optional):
98 either a value or 'generate' to generate a new unique MAC
101 specifies the IP address assigned to the instance from the Ganeti
102 side (this is not necessarily what the instance will use, but what
103 the node expects the instance to use)
106 specifies the connection mode for this nic: routed, bridged or
110 in bridged or openvswitch mode specifies the interface to attach
111 this NIC to, in routed mode it's intended to differentiate between
112 different routing tables/instance groups (but the meaning is
113 dependent on the network script, see **gnt-cluster**\(8) for more
114 details). Note that openvswitch support is also hypervisor
118 Of these "mode" and "link" are nic parameters, and inherit their
119 default at cluster level. Alternatively, if no network is desired for
120 the instance, you can prevent the default of one NIC with the
121 ``--no-nics`` option.
123 The ``-o (--os-type)`` option specifies the operating system to be
124 installed. The available operating systems can be listed with
125 **gnt-os list**. Passing ``--no-install`` will however skip the OS
126 installation, allowing a manual import if so desired. Note that the
127 no-installation mode will automatically disable the start-up of the
128 instance (without an OS, it most likely won't be able to start-up
131 The ``-B (--backend-parameters)`` option specifies the backend
132 parameters for the instance. If no such parameters are specified, the
133 values are inherited from the cluster. Possible parameters are:
136 the maximum memory size of the instance; as usual, suffixes can be
137 used to denote the unit, otherwise the value is taken in mebibytes
140 the minimum memory size of the instance; as usual, suffixes can be
141 used to denote the unit, otherwise the value is taken in mebibytes
144 the number of VCPUs to assign to the instance (if this value makes
145 sense for the hypervisor)
148 whether the instance is considered in the N+1 cluster checks
149 (enough redundancy in the cluster to survive a node failure)
152 ``True`` or ``False``, whether the instance must be failed over
153 (shut down and rebooted) always or it may be migrated (briefly
156 Note that before 2.6 Ganeti had a ``memory`` parameter, which was the
157 only value of memory an instance could have. With the
158 ``maxmem``/``minmem`` change Ganeti guarantees that at least the minimum
159 memory is always available for an instance, but allows more memory to be
160 used (up to the maximum memory) should it be free.
162 The ``-H (--hypervisor-parameters)`` option specified the hypervisor
163 to use for the instance (must be one of the enabled hypervisors on the
164 cluster) and optionally custom parameters for this instance. If not
165 other options are used (i.e. the invocation is just -H *NAME*) the
166 instance will inherit the cluster options. The defaults below show the
167 cluster defaults at cluster creation time.
169 The possible hypervisor options are as follows:
172 Valid for the Xen HVM and KVM hypervisors.
174 A string value denoting the boot order. This has different meaning
175 for the Xen HVM hypervisor and for the KVM one.
177 For Xen HVM, The boot order is a string of letters listing the boot
178 devices, with valid device letters being:
192 The default is not to set an HVM boot order, which is interpreted
195 For KVM the boot order is either "floppy", "cdrom", "disk" or
196 "network". Please note that older versions of KVM couldn't netboot
197 from virtio interfaces. This has been fixed in more recent versions
198 and is confirmed to work at least with qemu-kvm 0.11.1. Also note
199 that if you have set the ``kernel_path`` option, that will be used
200 for booting, and this setting will be silently ignored.
203 Valid for the Xen HVM and PVM hypervisors.
205 Relevant to non-pvops guest kernels, in which the disk device names
206 are given by the host. Allows one to specify 'xvd', which helps run
207 Red Hat based installers, driven by anaconda.
210 Valid for the KVM hypervisor.
212 The path to a floppy disk image to attach to the instance. This
213 is useful to install Windows operating systems on Virt/IO disks
214 because you can specify here the floppy for the drivers at
218 Valid for the Xen HVM and KVM hypervisors.
220 The path to a CDROM image to attach to the instance.
223 Valid for the KVM hypervisor.
225 The path to a second CDROM image to attach to the instance.
226 **NOTE**: This image can't be used to boot the system. To do that
227 you have to use the 'cdrom\_image\_path' option.
230 Valid for the Xen HVM and KVM hypervisors.
232 This parameter determines the way the network cards are presented
233 to the instance. The possible options are:
235 - rtl8139 (default for Xen HVM) (HVM & KVM)
236 - ne2k\_isa (HVM & KVM)
237 - ne2k\_pci (HVM & KVM)
243 - paravirtual (default for KVM) (HVM & KVM)
246 Valid for the Xen HVM and KVM hypervisors.
248 This parameter determines the way the disks are presented to the
249 instance. The possible options are:
251 - ioemu [default] (HVM & KVM)
260 Valid for the KVM hypervisor.
262 This parameter determines the way the cdroms disks are presented
263 to the instance. The default behavior is to get the same value of
264 the earlier parameter (disk_type). The possible options are:
275 Valid for the Xen HVM and KVM hypervisors.
277 Specifies the address that the VNC listener for this instance
278 should bind to. Valid values are IPv4 addresses. Use the address
279 0.0.0.0 to bind to all available interfaces (this is the default)
280 or specify the address of one of the interfaces on the node to
281 restrict listening to that interface.
284 Valid for the KVM hypervisor.
286 A boolean option that controls whether the VNC connection is
290 Valid for the KVM hypervisor.
292 If ``vnc_tls`` is enabled, this options specifies the path to the
293 x509 certificate to use.
296 Valid for the KVM hypervisor.
299 Valid for the KVM hypervisor.
301 Specifies the address or interface on which the SPICE server will
302 listen. Valid values are:
304 - IPv4 addresses, including 0.0.0.0 and 127.0.0.1
305 - IPv6 addresses, including :: and ::1
306 - names of network interfaces
308 If a network interface is specified, the SPICE server will be bound
309 to one of the addresses of that interface.
312 Valid for the KVM hypervisor.
314 Specifies which version of the IP protocol should be used by the
317 It is mainly intended to be used for specifying what kind of IP
318 addresses should be used if a network interface with both IPv4 and
319 IPv6 addresses is specified via the ``spice_bind`` parameter. In
320 this case, if the ``spice_ip_version`` parameter is not used, the
321 default IP version of the cluster will be used.
323 spice\_password\_file
324 Valid for the KVM hypervisor.
326 Specifies a file containing the password that must be used when
327 connecting via the SPICE protocol. If the option is not specified,
328 passwordless connections are allowed.
330 spice\_image\_compression
331 Valid for the KVM hypervisor.
333 Configures the SPICE lossless image compression. Valid values are:
342 spice\_jpeg\_wan\_compression
343 Valid for the KVM hypervisor.
345 Configures how SPICE should use the jpeg algorithm for lossy image
346 compression on slow links. Valid values are:
352 spice\_zlib\_glz\_wan\_compression
353 Valid for the KVM hypervisor.
355 Configures how SPICE should use the zlib-glz algorithm for lossy image
356 compression on slow links. Valid values are:
362 spice\_streaming\_video
363 Valid for the KVM hypervisor.
365 Configures how SPICE should detect video streams. Valid values are:
371 spice\_playback\_compression
372 Valid for the KVM hypervisor.
374 Configures whether SPICE should compress audio streams or not.
377 Valid for the KVM hypervisor.
379 Specifies that the SPICE server must use TLS to encrypt all the
380 traffic with the client.
383 Valid for the KVM hypervisor.
385 Specifies a list of comma-separated ciphers that SPICE should use
386 for TLS connections. For the format, see man **cipher**\(1).
389 Valid for the KVM hypervisor.
391 Enables or disables passing mouse events via SPICE vdagent.
394 Valid for the KVM hypervisor.
396 This parameter determines the emulated cpu for the instance. If this
397 parameter is empty (which is the default configuration), it will not
400 Be aware of setting this parameter to ``"host"`` if you have nodes
401 with different CPUs from each other. Live migration may stop working
404 For more information please refer to the KVM manual.
407 Valid for the Xen HVM and KVM hypervisors.
409 A boolean option that specifies if the hypervisor should enable
410 ACPI support for this instance. By default, ACPI is disabled.
413 Valid for the Xen HVM and KVM hypervisors.
415 A boolean option that specifies if the hypervisor should enabled
416 PAE support for this instance. The default is false, disabling PAE
420 Valid for the Xen HVM and KVM hypervisors.
422 A boolean option that specifies if the instance should be started
423 with its clock set to the localtime of the machine (when true) or
424 to the UTC (When false). The default is false, which is useful for
425 Linux/Unix machines; for Windows OSes, it is recommended to enable
429 Valid for the Xen PVM and KVM hypervisors.
431 This option specifies the path (on the node) to the kernel to boot
432 the instance with. Xen PVM instances always require this, while for
433 KVM if this option is empty, it will cause the machine to load the
434 kernel from its disks (and the boot will be done accordingly to
438 Valid for the Xen PVM and KVM hypervisors.
440 This options specifies extra arguments to the kernel that will be
441 loaded. device. This is always used for Xen PVM, while for KVM it
442 is only used if the ``kernel_path`` option is also specified.
444 The default setting for this value is simply ``"ro"``, which
445 mounts the root disk (initially) in read-only one. For example,
446 setting this to single will cause the instance to start in
450 Valid for the Xen PVM and KVM hypervisors.
452 This option specifies the path (on the node) to the initrd to boot
453 the instance with. Xen PVM instances can use this always, while
454 for KVM if this option is only used if the ``kernel_path`` option
455 is also specified. You can pass here either an absolute filename
456 (the path to the initrd) if you want to use an initrd, or use the
457 format no\_initrd\_path for no initrd.
460 Valid for the Xen PVM and KVM hypervisors.
462 This options specifies the name of the root device. This is always
463 needed for Xen PVM, while for KVM it is only used if the
464 ``kernel_path`` option is also specified.
466 Please note, that if this setting is an empty string and the
467 hypervisor is Xen it will not be written to the Xen configuration
471 Valid for the KVM hypervisor.
473 This boolean option specifies whether to emulate a serial console
477 Valid for the KVM hypervisor.
479 This integer option specifies the speed of the serial console.
480 Common values are 9600, 19200, 38400, 57600 and 115200: choose the
481 one which works on your system. (The default is 38400 for historical
482 reasons, but newer versions of kvm/qemu work with 115200)
485 Valid for the KVM hypervisor.
487 The disk cache mode. It can be either default to not pass any
488 cache option to KVM, or one of the KVM cache modes: none (for
489 direct I/O), writethrough (to use the host cache but report
490 completion to the guest only when the host has committed the
491 changes to disk) or writeback (to use the host cache and report
492 completion as soon as the data is in the host cache). Note that
493 there are special considerations for the cache mode depending on
494 version of KVM used and disk type (always raw file under Ganeti),
495 please refer to the KVM documentation for more details.
498 Valid for the KVM hypervisor.
500 The security model for kvm. Currently one of *none*, *user* or
501 *pool*. Under *none*, the default, nothing is done and instances
502 are run as the Ganeti daemon user (normally root).
504 Under *user* kvm will drop privileges and become the user
505 specified by the security\_domain parameter.
507 Under *pool* a global cluster pool of users will be used, making
508 sure no two instances share the same user on the same node. (this
509 mode is not implemented yet)
512 Valid for the KVM hypervisor.
514 Under security model *user* the username to run the instance
515 under. It must be a valid username existing on the host.
517 Cannot be set under security model *none* or *pool*.
520 Valid for the KVM hypervisor.
522 If *enabled* the -enable-kvm flag is passed to kvm. If *disabled*
523 -disable-kvm is passed. If unset no flag is passed, and the
524 default running mode for your kvm binary will be used.
527 Valid for the KVM hypervisor.
529 This option passes the -mem-path argument to kvm with the path (on
530 the node) to the mount point of the hugetlbfs file system, along
531 with the -mem-prealloc argument too.
534 Valid for the KVM hypervisor.
536 This boolean option determines whether to run the KVM instance in a
539 If it is set to ``true``, an empty directory is created before
540 starting the instance and its path is passed via the -chroot flag
541 to kvm. The directory is removed when the instance is stopped.
543 It is set to ``false`` by default.
546 Valid for the KVM hypervisor.
548 The maximum amount of time (in ms) a KVM instance is allowed to be
549 frozen during a live migration, in order to copy dirty memory
550 pages. Default value is 30ms, but you may need to increase this
551 value for busy instances.
553 This option is only effective with kvm versions >= 87 and qemu-kvm
557 Valid for the Xen, KVM and LXC hypervisors.
559 The processes belonging to the given instance are only scheduled
560 on the specified CPUs.
562 The format of the mask can be given in three forms. First, the word
563 "all", which signifies the common case where all VCPUs can live on
564 any CPU, based on the hypervisor's decisions.
566 Second, a comma-separated list of CPU IDs or CPU ID ranges. The
567 ranges are defined by a lower and higher boundary, separated by a
568 dash, and the boundaries are inclusive. In this form, all VCPUs of
569 the instance will be mapped on the selected list of CPUs. Example:
570 ``0-2,5``, mapping all VCPUs (no matter how many) onto physical CPUs
573 The last form is used for explicit control of VCPU-CPU pinnings. In
574 this form, the list of VCPU mappings is given as a colon (:)
575 separated list, whose elements are the possible values for the
576 second or first form above. In this form, the number of elements in
577 the colon-separated list _must_ equal the number of VCPUs of the
584 # Map the entire instance to CPUs 0-2
585 gnt-instance modify -H cpu_mask=0-2 my-inst
587 # Map vCPU 0 to physical CPU 1 and vCPU 1 to CPU 3 (assuming 2 vCPUs)
588 gnt-instance modify -H cpu_mask=1:3 my-inst
590 # Pin vCPU 0 to CPUs 1 or 2, and vCPU 1 to any CPU
591 gnt-instance modify -H cpu_mask=1-2:all my-inst
593 # Pin vCPU 0 to any CPU, vCPU 1 to CPUs 1, 3, 4 or 5, and CPU 2 to
594 # CPU 0 (backslashes for escaping the comma)
595 gnt-instance modify -H cpu_mask=all:1\\,3-5:0 my-inst
597 # Pin entire VM to CPU 0
598 gnt-instance modify -H cpu_mask=0 my-inst
600 # Turn off CPU pinning (default setting)
601 gnt-instance modify -H cpu_mask=all my-inst
604 Valid for the Xen hypervisor.
606 Set the maximum amount of cpu usage by the VM. The value is a percentage
607 between 0 and (100 * number of VCPUs). Default cap is 0: unlimited.
610 Valid for the Xen hypervisor.
612 Set the cpu time ratio to be allocated to the VM. Valid values are
613 between 1 and 65535. Default weight is 256.
616 Valid for the KVM hypervisor.
618 This option specifies the usb mouse type to be used. It can be
619 "mouse" or "tablet". When using VNC it's recommended to set it to
623 Valid for the KVM hypervisor.
625 This option specifies the keyboard mapping to be used. It is only
626 needed when using the VNC console. For example: "fr" or "en-gb".
629 Valid for Xen PVM, Xen HVM and KVM hypervisors.
631 Normally if an instance reboots, the hypervisor will restart it. If
632 this option is set to ``exit``, the hypervisor will treat a reboot
633 as a shutdown instead.
635 It is set to ``reboot`` by default.
638 Valid for the KVM hypervisor.
640 Number of emulated CPU cores.
643 Valid for the KVM hypervisor.
645 Number of emulated CPU threads.
648 Valid for the KVM hypervisor.
650 Number of emulated CPU sockets.
653 Valid for the KVM hypervisor.
655 Comma separated list of emulated sounds cards, or "all" to enable
656 all the available ones.
659 Valid for the KVM hypervisor.
661 Comma separated list of usb devices. These can be emulated devices
662 or passthrough ones, and each one gets passed to kvm with its own
663 ``-usbdevice`` option. See the **qemu**\(1) manpage for the syntax
664 of the possible components.
667 The ``-O (--os-parameters)`` option allows customisation of the OS
668 parameters. The actual parameter names and values depends on the OS
669 being used, but the syntax is the same key=value. For example, setting
670 a hypothetical ``dhcp`` parameter to yes can be achieved by::
672 gnt-instance add -O dhcp=yes ...
674 The ``-I (--iallocator)`` option specifies the instance allocator plugin
675 to use (``.`` means the default allocator). If you pass in this option
676 the allocator will select nodes for this instance automatically, so you
677 don't need to pass them with the ``-n`` option. For more information
678 please refer to the instance allocator documentation.
680 The ``-t (--disk-template)`` options specifies the disk layout type
681 for the instance. The available choices are:
684 This creates an instance with no disks. Its useful for testing only
685 (or other special cases).
688 Disk devices will be regular files.
691 Disk devices will be logical volumes.
694 Disk devices will be drbd (version 8.x) on top of lvm volumes.
697 Disk devices will be rbd volumes residing inside a RADOS cluster.
700 The optional second value of the ``-n (--node)`` is used for the drbd
701 template type and specifies the remote node.
703 If you do not want gnt-instance to wait for the disk mirror to be
704 synced, use the ``--no-wait-for-sync`` option.
706 The ``--file-storage-dir`` specifies the relative path under the
707 cluster-wide file storage directory to store file-based disks. It is
708 useful for having different subdirectories for different
709 instances. The full path of the directory where the disk files are
710 stored will consist of cluster-wide file storage directory + optional
711 subdirectory + instance name. Example:
712 ``@RPL_FILE_STORAGE_DIR@/mysubdir/instance1.example.com``. This
713 option is only relevant for instances using the file storage backend.
715 The ``--file-driver`` specifies the driver to use for file-based
716 disks. Note that currently these drivers work with the xen hypervisor
717 only. This option is only relevant for instances using the file
718 storage backend. The available choices are:
721 Kernel loopback driver. This driver uses loopback devices to
722 access the filesystem within the file. However, running I/O
723 intensive applications in your instance using the loop driver
724 might result in slowdowns. Furthermore, if you use the loopback
725 driver consider increasing the maximum amount of loopback devices
726 (on most systems it's 8) using the max\_loop param.
729 The blktap driver (for Xen hypervisors). In order to be able to
730 use the blktap driver you should check if the 'blktapctrl' user
731 space disk agent is running (usually automatically started via
732 xend). This user-level disk I/O interface has the advantage of
733 better performance. Especially if you use a network file system
734 (e.g. NFS) to store your instances this is the recommended choice.
736 If ``--ignore-ipolicy`` is given any instance policy violations occuring
737 during this operation are ignored.
739 See **ganeti**\(7) for a description of ``--submit`` and other common
744 # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
745 -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
746 # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
747 -o debian-etch -n node1.example.com instance1.example.com
748 # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
749 -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
750 # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
751 -n node1.example.com:node2.example.com instance2.example.com
757 **batch-create** {instances\_file.json}
759 This command (similar to the Ganeti 1.2 **batcher** tool) submits
760 multiple instance creation jobs based on a definition file. The
761 instance configurations do not encompass all the possible options for
762 the **add** command, but only a subset.
764 The instance file should be a valid-formed JSON file, containing a
765 dictionary with instance name and instance parameters. The accepted
769 The size of the disks of the instance.
772 The disk template to use for the instance, the same as in the
776 A dictionary of backend parameters.
779 A dictionary with a single key (the hypervisor name), and as value
780 the hypervisor options. If not passed, the default hypervisor and
781 hypervisor options will be inherited.
784 Specifications for the one NIC that will be created for the
785 instance. 'bridge' is also accepted as a backwards compatible
789 List of nics that will be created for the instance. Each entry
790 should be a dict, with mac, ip, mode and link as possible keys.
791 Please don't provide the "mac, ip, mode, link" parent keys if you
792 use this method for specifying nics.
794 primary\_node, secondary\_node
795 The primary and optionally the secondary node to use for the
796 instance (in case an iallocator script is not used).
799 Instead of specifying the nodes, an iallocator script can be used
800 to automatically compute them.
803 whether to start the instance
806 Skip the check for already-in-use instance; see the description in
807 the **add** command for details.
810 Skip the name check for instances; see the description in the
811 **add** command for details.
813 file\_storage\_dir, file\_driver
814 Configuration for the file disk type, see the **add** command for
818 A simple definition for one instance can be (with most of the
819 parameters taken from the cluster defaults)::
825 "disk_size": ["25G"],
831 "disk_size": ["25G"],
832 "iallocator": "dumb",
833 "hypervisor": "xen-hvm",
834 "hvparams": {"acpi": true},
835 "backend": {"maxmem": 512, "minmem": 256}
839 The command will display the job id for each submitted instance, as
842 # gnt-instance batch-create instances.json
849 **remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
850 [\--force] {*instance*}
852 Remove an instance. This will remove all data from the instance and
853 there is *no way back*. If you are not sure if you use an instance
854 again, use **shutdown** first and leave it in the shutdown state for a
857 The ``--ignore-failures`` option will cause the removal to proceed
858 even in the presence of errors during the removal of the instance
859 (e.g. during the shutdown or the disk removal). If this option is not
860 given, the command will stop at the first error.
862 The ``--shutdown-timeout`` is used to specify how much time to wait
863 before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
864 kvm process for KVM, etc.). By default two minutes are given to each
867 The ``--force`` option is used to skip the interactive confirmation.
869 See **ganeti**\(7) for a description of ``--submit`` and other common
874 # gnt-instance remove instance1.example.com
881 | [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
882 | [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
884 Shows the currently configured instances with memory usage, disk
885 usage, the node they are running on, and their run status.
887 The ``--no-headers`` option will skip the initial header line. The
888 ``--separator`` option takes an argument which denotes what will be
889 used between the output fields. Both these options are to help
892 The units used to display the numeric values in the output varies,
893 depending on the options given. By default, the values will be
894 formatted in the most appropriate unit. If the ``--separator`` option
895 is given, then the values are shown in mebibytes to allow parsing by
896 scripts. In both cases, the ``--units`` option can be used to enforce
899 The ``-v`` option activates verbose mode, which changes the display of
900 special field states (see **ganeti**\(7)).
902 The ``-o (--output)`` option takes a comma-separated list of output
903 fields. The available fields and their meaning are:
905 @QUERY_FIELDS_INSTANCE@
907 If the value of the option starts with the character ``+``, the new
908 field(s) will be added to the default list. This allows one to quickly
909 see the default list plus a few other fields, instead of retyping the
910 entire list of fields.
912 There is a subtle grouping about the available output fields: all
913 fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
914 ``status`` are configuration value and not run-time values. So if you
915 don't select any of the these fields, the query will be satisfied
916 instantly from the cluster configuration, without having to ask the
917 remote nodes for the data. This can be helpful for big clusters when
918 you only want some data and it makes sense to specify a reduced set of
921 If exactly one argument is given and it appears to be a query filter
922 (see **ganeti**\(7)), the query result is filtered accordingly. For
923 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
924 (``-F``) option forces the argument to be treated as a filter (e.g.
925 ``gnt-instance list -F admin_state``).
927 The default output field list is: ``name``, ``os``, ``pnode``,
928 ``admin_state``, ``oper_state``, ``oper_ram``.
934 **list-fields** [field...]
936 Lists available fields for instances.
942 **info** [-s \| \--static] [\--roman] {\--all \| *instance*}
944 Show detailed information about the given instance(s). This is
945 different from **list** as it shows detailed data about the instance's
946 disks (especially useful for the drbd disk template).
948 If the option ``-s`` is used, only information available in the
949 configuration file is returned, without querying nodes, making the
952 Use the ``--all`` to get info about all instances, rather than
953 explicitly passing the ones you're interested in.
955 The ``--roman`` option can be used to cause envy among people who like
956 ancient cultures, but are stuck with non-latin-friendly cluster
957 virtualization technologies.
963 | [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
964 | [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
965 | [{-m|\--runtime-memory} *SIZE*]
966 | [\--net add*[:options]* \| \--net [*N*:]remove \| \--net *N:options*]
967 | [\--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| \--disk [*N*:]remove \|
968 | \--disk *N*:mode=*MODE*]
969 | [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
970 | [\--os-type=*OS* [\--force-variant]]
971 | [{-O|\--os-parameters} *param*=*value*... ]
972 | [\--offline \| \--online]
974 | [\--ignore-ipolicy]
977 Modifies the memory size, number of vcpus, ip address, MAC address
978 and/or nic parameters for an instance. It can also add and remove
979 disks and NICs to/from the instance. Note that you need to give at
980 least one of the arguments, otherwise the command complains.
982 The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
983 and ``-O (--os-parameters)`` options specifies hypervisor, backend and
984 OS parameter options in the form of name=value[,...]. For details
985 which options can be specified, see the **add** command.
987 The ``-t (--disk-template)`` option will change the disk template of
988 the instance. Currently only conversions between the plain and drbd
989 disk templates are supported, and the instance must be stopped before
990 attempting the conversion. When changing from the plain to the drbd
991 disk template, a new secondary node must be specified via the ``-n``
992 option. The option ``--no-wait-for-sync`` can be used when converting
993 to the ``drbd`` template in order to make the instance available for
994 startup before DRBD has finished resyncing.
996 The ``-m (--runtime-memory)`` option will change an instance's runtime
997 memory to the given size (in MB if a different suffix is not specified),
998 by ballooning it up or down to the new value.
1000 The ``--disk add:size=``*SIZE* option adds a disk to the instance. The
1001 optional ``vg=``*VG* option specifies an LVM volume group other than
1002 the default volume group to create the disk on. For DRBD disks, the
1003 ``metavg=``*VG* option specifies the volume group for the metadata
1004 device. ``--disk`` *N*``:add,size=``**SIZE** can be used to add a
1005 disk at a specific index. The ``--disk remove`` option will remove the
1006 last disk of the instance. Use ``--disk `` *N*``:remove`` to remove a
1007 disk by its index. The ``--disk`` *N*``:mode=``*MODE* option will change
1008 the mode of the Nth disk of the instance between read-only (``ro``) and
1009 read-write (``rw``).
1011 The ``--net add:``*options* and ``--net`` *N*``:add,``*options* option
1012 will add a new network interface to the instance. The available options
1013 are the same as in the **add** command (``mac``, ``ip``, ``link``,
1014 ``mode``). The ``--net remove`` will remove the last network interface
1015 of the instance (``--net`` *N*``:remove`` for a specific index), while
1016 the ``--net`` *N*``:``*options* option will change the parameters of the Nth
1017 instance network interface.
1019 The option ``-o (--os-type)`` will change the OS name for the instance
1020 (without reinstallation). In case an OS variant is specified that is
1021 not found, then by default the modification is refused, unless
1022 ``--force-variant`` is passed. An invalid OS will also be refused,
1023 unless the ``--force`` option is given.
1025 The ``--online`` and ``--offline`` options are used to transition an
1026 instance into and out of the ``offline`` state. An instance can be
1027 turned offline only if it was previously down. The ``--online`` option
1028 fails if the instance was not in the ``offline`` state, otherwise it
1029 changes instance's state to ``down``. These modifications take effect
1032 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1033 during this operation are ignored.
1035 See **ganeti**\(7) for a description of ``--submit`` and other common
1038 Most of the changes take effect at the next restart. If the instance is
1039 running, there is no effect on the instance.
1044 | **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
1045 | [\--force-multiple]
1046 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
1047 | [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...}
1049 Reinstalls the operating system on the given instance(s). The
1050 instance(s) must be stopped when running this command. If the ``-o
1051 (--os-type)`` is specified, the operating system is changed.
1053 The ``--select-os`` option switches to an interactive OS reinstall.
1054 The user is prompted to select the OS template from the list of
1055 available OS templates. OS parameters can be overridden using ``-O
1056 (--os-parameters)`` (more documentation for this option under the
1059 Since this is a potentially dangerous command, the user will be
1060 required to confirm this action, unless the ``-f`` flag is passed.
1061 When multiple instances are selected (either by passing multiple
1062 arguments or by using the ``--node``, ``--primary``, ``--secondary``
1063 or ``--all`` options), the user must pass the ``--force-multiple``
1064 options to skip the interactive confirmation.
1066 See **ganeti**\(7) for a description of ``--submit`` and other common
1072 | **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
1073 | {*instance*} {*new\_name*}
1075 Renames the given instance. The instance must be stopped when running
1076 this command. The requirements for the new name are the same as for
1077 adding an instance: the new name must be resolvable and the IP it
1078 resolves to must not be reachable (in order to prevent duplicate IPs
1079 the next time the instance is started). The IP test can be skipped if
1080 the ``--no-ip-check`` option is passed.
1082 Note that you can rename an instance to its same name, to force
1083 re-executing the os-specific rename script for that instance, if
1086 The ``--no-name-check`` skips the check for the new instance name via
1087 the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
1088 that the resolved name matches the provided name. Since the name check
1089 is used to compute the IP address, if you pass this option you must also
1090 pass the ``--no-ip-check`` option.
1092 See **ganeti**\(7) for a description of ``--submit`` and other common
1095 Starting/stopping/connecting to console
1096 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1102 | [\--force] [\--ignore-offline]
1103 | [\--force-multiple] [\--no-remember]
1104 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1105 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1106 | [{-H|\--hypervisor-parameters} ``key=value...``]
1107 | [{-B|\--backend-parameters} ``key=value...``]
1108 | [\--submit] [\--paused]
1111 Starts one or more instances, depending on the following options. The
1112 four available modes are:
1115 will start the instances given as arguments (at least one argument
1116 required); this is the default selection
1119 will start the instances who have the given node as either primary
1123 will start all instances whose primary node is in the list of nodes
1124 passed as arguments (at least one node required)
1127 will start all instances whose secondary node is in the list of
1128 nodes passed as arguments (at least one node required)
1131 will start all instances in the cluster (no arguments accepted)
1134 will start all instances in the cluster with the tags given as
1138 will start all instances in the cluster on nodes with the tags
1142 will start all instances in the cluster on primary nodes with the
1143 tags given as arguments
1146 will start all instances in the cluster on secondary nodes with the
1147 tags given as arguments
1149 Note that although you can pass more than one selection option, the
1150 last one wins, so in order to guarantee the desired result, don't pass
1151 more than one such option.
1153 Use ``--force`` to start even if secondary disks are failing.
1154 ``--ignore-offline`` can be used to ignore offline primary nodes and
1155 mark the instance as started even if the primary is not available.
1157 The ``--force-multiple`` will skip the interactive confirmation in the
1158 case the more than one instance will be affected.
1160 The ``--no-remember`` option will perform the startup but not change
1161 the state of the instance in the configuration file (if it was stopped
1162 before, Ganeti will still think it needs to be stopped). This can be
1163 used for testing, or for a one shot-start where you don't want the
1164 watcher to restart the instance if it crashes.
1166 The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
1167 options specify temporary hypervisor and backend parameters that can
1168 be used to start an instance with modified parameters. They can be
1169 useful for quick testing without having to modify an instance back and
1172 # gnt-instance start -H kernel_args="single" instance1
1173 # gnt-instance start -B maxmem=2048 instance2
1176 The first form will start the instance instance1 in single-user mode,
1177 and the instance instance2 with 2GB of RAM (this time only, unless
1178 that is the actual instance memory size already). Note that the values
1179 override the instance parameters (and not extend them): an instance
1180 with "kernel\_args=ro" when started with -H kernel\_args=single will
1181 result in "single", not "ro single".
1183 The ``--paused`` option is only valid for Xen and kvm hypervisors. This
1184 pauses the instance at the start of bootup, awaiting ``gnt-instance
1185 console`` to unpause it, allowing the entire boot process to be
1186 monitored for debugging.
1188 See **ganeti**\(7) for a description of ``--submit`` and other common
1193 # gnt-instance start instance1.example.com
1194 # gnt-instance start --node node1.example.com node2.example.com
1195 # gnt-instance start --all
1203 | [\--force] [\--force-multiple] [\--ignore-offline] [\--no-remember]
1204 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1205 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1209 Stops one or more instances. If the instance cannot be cleanly stopped
1210 during a hardcoded interval (currently 2 minutes), it will forcibly
1211 stop the instance (equivalent to switching off the power on a physical
1214 The ``--timeout`` is used to specify how much time to wait before
1215 forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm
1216 process for KVM, etc.). By default two minutes are given to each
1219 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1220 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1221 ``--sec-node-tags`` options are similar as for the **startup** command
1222 and they influence the actual instances being shutdown.
1224 ``--ignore-offline`` can be used to ignore offline primary nodes and
1225 force the instance to be marked as stopped. This option should be used
1226 with care as it can lead to an inconsistent cluster state.
1228 Use ``--force`` to be able to shutdown an instance even when it's marked
1229 as offline. This is useful is an offline instance ends up in the
1230 ``ERROR_up`` state, for example.
1232 The ``--no-remember`` option will perform the shutdown but not change
1233 the state of the instance in the configuration file (if it was running
1234 before, Ganeti will still thinks it needs to be running). This can be
1235 useful for a cluster-wide shutdown, where some instances are marked as
1236 up and some as down, and you don't want to change the running state:
1237 you just need to disable the watcher, shutdown all instances with
1238 ``--no-remember``, and when the watcher is activated again it will
1239 restore the correct runtime state for all instances.
1241 See **ganeti**\(7) for a description of ``--submit`` and other common
1246 # gnt-instance shutdown instance1.example.com
1247 # gnt-instance shutdown --all
1254 | [{-t|\--type} *REBOOT-TYPE*]
1255 | [\--ignore-secondaries]
1256 | [\--shutdown-timeout=*N*]
1257 | [\--force-multiple]
1258 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1259 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1263 Reboots one or more instances. The type of reboot depends on the value
1264 of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
1265 does a instance stop, recreates the hypervisor config for the instance
1266 and starts the instance. A full reboot does the equivalent of
1267 **gnt-instance shutdown && gnt-instance startup**. The default is
1270 For the hard reboot the option ``--ignore-secondaries`` ignores errors
1271 for the secondary node while re-assembling the instance disks.
1273 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1274 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1275 ``--sec-node-tags`` options are similar as for the **startup** command
1276 and they influence the actual instances being rebooted.
1278 The ``--shutdown-timeout`` is used to specify how much time to wait
1279 before forcing the shutdown (xm destroy in xen, killing the kvm
1280 process, for kvm). By default two minutes are given to each instance
1283 The ``--force-multiple`` will skip the interactive confirmation in the
1284 case the more than one instance will be affected.
1286 See **ganeti**\(7) for a description of ``--submit`` and other common
1291 # gnt-instance reboot instance1.example.com
1292 # gnt-instance reboot --type=full instance1.example.com
1298 **console** [\--show-cmd] {*instance*}
1300 Connects to the console of the given instance. If the instance is not
1301 up, an error is returned. Use the ``--show-cmd`` option to display the
1302 command instead of executing it.
1304 For HVM instances, this will attempt to connect to the serial console
1305 of the instance. To connect to the virtualized "physical" console of a
1306 HVM instance, use a VNC client with the connection info from the
1309 For Xen/kvm instances, if the instance is paused, this attempts to
1310 unpause the instance after waiting a few seconds for the connection to
1311 the console to be made.
1315 # gnt-instance console instance1.example.com
1324 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p}
1325 [\--disks *idx*] {*instance*}
1327 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
1328 [\--disks *idx*] {*instance*}
1330 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1331 {{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
1333 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1334 {-a\|\--auto} {*instance*}
1336 This command is a generalized form for replacing disks. It is
1337 currently only valid for the mirrored (DRBD) disk template.
1339 The first form (when passing the ``-p`` option) will replace the disks
1340 on the primary, while the second form (when passing the ``-s`` option
1341 will replace the disks on the secondary node. For these two cases (as
1342 the node doesn't change), it is possible to only run the replace for a
1343 subset of the disks, using the option ``--disks`` which takes a list
1344 of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
1345 the first and third disks.
1347 The third form (when passing either the ``--iallocator`` or the
1348 ``--new-secondary`` option) is designed to change secondary node of the
1349 instance. Specifying ``--iallocator`` makes the new secondary be
1350 selected automatically by the specified allocator plugin (use ``.`` to
1351 indicate the default allocator), otherwise the new secondary node will
1352 be the one chosen manually via the ``--new-secondary`` option.
1354 Note that it is not possible to select an offline or drained node as a
1357 The fourth form (when using ``--auto``) will automatically determine
1358 which disks of an instance are faulty and replace them within the same
1359 node. The ``--auto`` option works only when an instance has only
1360 faulty disks on either the primary or secondary node; it doesn't work
1361 when both sides have faulty disks.
1363 The ``--early-release`` changes the code so that the old storage on
1364 secondary node(s) is removed early (before the resync is completed)
1365 and the internal Ganeti locks for the current (and new, if any)
1366 secondary node are also released, thus allowing more parallelism in
1367 the cluster operation. This should be used only when recovering from a
1368 disk failure on the current secondary (thus the old storage is already
1369 broken) or when the storage on the primary node is known to be fine
1370 (thus we won't need the old storage for potential recovery).
1372 The ``--ignore-ipolicy`` let the command ignore instance policy
1373 violations if replace-disks changes groups and the instance would
1374 violate the new groups instance policy.
1376 See **ganeti**\(7) for a description of ``--submit`` and other common
1382 **activate-disks** [\--submit] [\--ignore-size] [\--wait-for-sync] {*instance*}
1384 Activates the block devices of the given instance. If successful, the
1385 command will show the location and name of the block devices::
1387 node1.example.com:disk/0:/dev/drbd0
1388 node1.example.com:disk/1:/dev/drbd1
1391 In this example, *node1.example.com* is the name of the node on which
1392 the devices have been activated. The *disk/0* and *disk/1* are the
1393 Ganeti-names of the instance disks; how they are visible inside the
1394 instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
1395 actual block devices as visible on the node.
1397 The ``--ignore-size`` option can be used to activate disks ignoring
1398 the currently configured size in Ganeti. This can be used in cases
1399 where the configuration has gotten out of sync with the real-world
1400 (e.g. after a partially-failed grow-disk operation or due to rounding
1401 in LVM devices). This should not be used in normal cases, but only
1402 when activate-disks fails without it.
1404 The ``--wait-for-sync`` option will ensure that the command returns only
1405 after the instance's disks are synchronised (mostly for DRBD); this can
1406 be useful to ensure consistency, as otherwise there are no commands that
1407 can wait until synchronisation is done. However when passing this
1408 option, the command will have additional output, making it harder to
1409 parse the disk information.
1411 Note that it is safe to run this command while the instance is already
1414 See **ganeti**\(7) for a description of ``--submit`` and other common
1420 **deactivate-disks** [-f] [\--submit] {*instance*}
1422 De-activates the block devices of the given instance. Note that if you
1423 run this command for an instance with a drbd disk template, while it
1424 is running, it will not be able to shutdown the block devices on the
1425 primary node, but it will shutdown the block devices on the secondary
1426 nodes, thus breaking the replication.
1428 The ``-f``/``--force`` option will skip checks that the instance is
1429 down; in case the hypervisor is confused and we can't talk to it,
1430 normally Ganeti will refuse to deactivate the disks, but with this
1431 option passed it will skip this check and directly try to deactivate
1432 the disks. This can still fail due to the instance actually running or
1435 See **ganeti**\(7) for a description of ``--submit`` and other common
1441 | **grow-disk** [\--no-wait-for-sync] [\--submit] [\--absolute]
1442 | {*instance*} {*disk*} {*amount*}
1444 Grows an instance's disk. This is only possible for instances having a
1445 plain, drbd, file, sharedfile or rbd disk template.
1447 Note that this command only change the block device size; it will not
1448 grow the actual filesystems, partitions, etc. that live on that
1449 disk. Usually, you will need to:
1451 #. use **gnt-instance grow-disk**
1453 #. reboot the instance (later, at a convenient time)
1455 #. use a filesystem resizer, such as **ext2online**\(8) or
1456 **xfs\_growfs**\(8) to resize the filesystem, or use **fdisk**\(8) to
1457 change the partition table on the disk
1459 The *disk* argument is the index of the instance disk to grow. The
1460 *amount* argument is given as a number which can have a suffix (like the
1461 disk size in instance create); if the suffix is missing, the value will
1462 be interpreted as mebibytes.
1464 By default, the *amount* value represents the desired increase in the
1465 disk size (e.g. an amount of 1G will take a disk of size 3G to 4G). If
1466 the optional ``--absolute`` parameter is passed, then the *amount*
1467 argument doesn't represent the delta, but instead the desired final disk
1468 size (e.g. an amount of 8G will take a disk of size 4G to 8G).
1470 For instances with a drbd template, note that the disk grow operation
1471 might complete on one node but fail on the other; this will leave the
1472 instance with different-sized LVs on the two nodes, but this will not
1473 create problems (except for unused space).
1475 If you do not want gnt-instance to wait for the new disk region to be
1476 synced, use the ``--no-wait-for-sync`` option.
1478 See **ganeti**\(7) for a description of ``--submit`` and other common
1481 Example (increase the first disk for instance1 by 16GiB)::
1483 # gnt-instance grow-disk instance1.example.com 0 16g
1485 Example for increasing the disk size to a certain size::
1487 # gnt-instance grow-disk --absolute instance1.example.com 0 32g
1489 Also note that disk shrinking is not supported; use **gnt-backup
1490 export** and then **gnt-backup import** to reduce the disk size of an
1496 | **recreate-disks** [\--submit]
1497 | [{-n node1:[node2] \| {-I\|\--iallocator *name*}}]
1498 | [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
1500 Recreates all or a subset of disks of the given instance.
1502 Note that this functionality should only be used for missing disks; if
1503 any of the given disks already exists, the operation will fail. While
1504 this is suboptimal, recreate-disks should hopefully not be needed in
1505 normal operation and as such the impact of this is low.
1507 If only a subset should be recreated, any number of ``disk`` options can
1508 be specified. It expects a disk index and an optional list of disk
1509 parameters to change. Only ``size`` and ``mode`` can be changed while
1510 recreating disks. To recreate all disks while changing parameters on
1511 a subset only, a ``--disk`` option must be given for every disk of the
1514 Optionally the instance's disks can be recreated on different
1515 nodes. This can be useful if, for example, the original nodes of the
1516 instance have gone down (and are marked offline), so we can't recreate
1517 on the same nodes. To do this, pass the new node(s) via ``-n`` option,
1518 with a syntax similar to the **add** command. The number of nodes
1519 passed must equal the number of nodes that the instance currently
1520 has. Note that changing nodes is only allowed when all disks are
1521 replaced, e.g. when no ``--disk`` option is passed.
1523 Another method of choosing which nodes to place the instance on is by
1524 using the specified iallocator, passing the ``--iallocator`` option.
1525 The primary and secondary nodes will be chosen by the specified
1526 iallocator plugin, or by the default allocator if ``.`` is specified.
1528 See **ganeti**\(7) for a description of ``--submit`` and other common
1537 | **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
1538 | [\--shutdown-timeout=*N*]
1539 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
1543 Failover will stop the instance (if running), change its primary node,
1544 and if it was originally running it will start it again (on the new
1545 primary). This only works for instances with drbd template (in which
1546 case you can only fail to the secondary node) and for externally
1547 mirrored templates (blockdev and rbd) (which can change to any other
1550 If the instance's disk template is of type blockdev or rbd, then you
1551 can explicitly specify the target node (which can be any node) using
1552 the ``-n`` or ``--target-node`` option, or specify an iallocator plugin
1553 using the ``-I`` or ``--iallocator`` option. If you omit both, the default
1554 iallocator will be used to specify the target node.
1556 Normally the failover will check the consistency of the disks before
1557 failing over the instance. If you are trying to migrate instances off
1558 a dead node, this will fail. Use the ``--ignore-consistency`` option
1559 for this purpose. Note that this option can be dangerous as errors in
1560 shutting down the instance will be ignored, resulting in possibly
1561 having the instance running on two machines in parallel (on
1562 disconnected DRBD drives).
1564 The ``--shutdown-timeout`` is used to specify how much time to wait
1565 before forcing the shutdown (xm destroy in xen, killing the kvm
1566 process, for kvm). By default two minutes are given to each instance
1569 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1570 during this operation are ignored.
1572 See **ganeti**\(7) for a description of ``--submit`` and other common
1577 # gnt-instance failover instance1.example.com
1583 | **migrate** [-f] [\--allow-failover] [\--non-live]
1584 | [\--migration-mode=live\|non-live] [\--ignore-ipolicy]
1585 | [\--no-runtime-changes] [\--submit]
1586 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
1588 | **migrate** [-f] \--cleanup [\--submit] {*instance*}
1590 Migrate will move the instance to its secondary node without shutdown.
1591 As with failover, it only works for instances having the drbd disk
1592 template or an externally mirrored disk template type such as blockdev
1595 If the instance's disk template is of type blockdev or rbd, then you can
1596 explicitly specify the target node (which can be any node) using the
1597 ``-n`` or ``--target-node`` option, or specify an iallocator plugin
1598 using the ``-I`` or ``--iallocator`` option. If you omit both, the
1599 default iallocator will be used to specify the target node.
1600 Alternatively, the default iallocator can be requested by specifying
1601 ``.`` as the name of the plugin.
1603 The migration command needs a perfectly healthy instance, as we rely
1604 on the dual-master capability of drbd8 and the disks of the instance
1605 are not allowed to be degraded.
1607 The ``--non-live`` and ``--migration-mode=non-live`` options will
1608 switch (for the hypervisors that support it) between a "fully live"
1609 (i.e. the interruption is as minimal as possible) migration and one in
1610 which the instance is frozen, its state saved and transported to the
1611 remote node, and then resumed there. This all depends on the
1612 hypervisor support for two different methods. In any case, it is not
1613 an error to pass this parameter (it will just be ignored if the
1614 hypervisor doesn't support it). The option ``--migration-mode=live``
1615 option will request a fully-live migration. The default, when neither
1616 option is passed, depends on the hypervisor parameters (and can be
1617 viewed with the **gnt-cluster info** command).
1619 If the ``--cleanup`` option is passed, the operation changes from
1620 migration to attempting recovery from a failed previous migration. In
1621 this mode, Ganeti checks if the instance runs on the correct node (and
1622 updates its configuration if not) and ensures the instances' disks
1623 are configured correctly. In this mode, the ``--non-live`` option is
1626 The option ``-f`` will skip the prompting for confirmation.
1628 If ``--allow-failover`` is specified it tries to fallback to failover if
1629 it already can determine that a migration won't work (e.g. if the
1630 instance is shut down). Please note that the fallback will not happen
1631 during execution. If a migration fails during execution it still fails.
1633 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1634 during this operation are ignored.
1636 The ``--no-runtime-changes`` option forbids migrate to alter an
1637 instance's runtime before migrating it (eg. ballooning an instance
1638 down because the target node doesn't have enough available memory).
1640 If an instance has the backend parameter ``always_failover`` set to
1641 true, then the migration is automatically converted into a failover.
1643 See **ganeti**\(7) for a description of ``--submit`` and other common
1646 Example (and expected output)::
1648 # gnt-instance migrate instance1
1649 Instance instance1 will be migrated. Note that migration
1650 might impact the instance if anything goes wrong (e.g. due to bugs in
1651 the hypervisor). Continue?
1653 Migrating instance instance1.example.com
1654 * checking disk consistency between source and target
1655 * switching node node2.example.com to secondary mode
1656 * changing into standalone mode
1657 * changing disks into dual-master mode
1658 * wait until resync is done
1659 * preparing node2.example.com to accept the instance
1660 * migrating instance to node2.example.com
1661 * switching node node1.example.com to secondary mode
1662 * wait until resync is done
1663 * changing into standalone mode
1664 * changing disks into single-master mode
1665 * wait until resync is done
1673 | **move** [-f] [\--ignore-consistency]
1674 | [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
1677 Move will move the instance to an arbitrary node in the cluster. This
1678 works only for instances having a plain or file disk template.
1680 Note that since this operation is done via data copy, it will take a
1681 long time for big disks (similar to replace-disks for a drbd
1684 The ``--shutdown-timeout`` is used to specify how much time to wait
1685 before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the
1686 kvm process for KVM, etc.). By default two minutes are given to each
1689 The ``--ignore-consistency`` option will make Ganeti ignore any errors
1690 in trying to shutdown the instance on its node; useful if the
1691 hypervisor is broken and you want to recover the data.
1693 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1694 during this operation are ignored.
1696 See **ganeti**\(7) for a description of ``--submit`` and other common
1701 # gnt-instance move -n node3.example.com instance1.example.com
1707 | **change-group** [\--submit]
1708 | [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
1710 This command moves an instance to another node group. The move is
1711 calculated by an iallocator, either given on the command line or as a
1714 If no specific destination groups are specified using ``--to``, all
1715 groups except the one containing the instance are considered.
1717 See **ganeti**\(7) for a description of ``--submit`` and other common
1722 # gnt-instance change-group -I hail --to rack2 inst1.example.com
1731 **add-tags** [\--from *file*] {*instancename*} {*tag*...}
1733 Add tags to the given instance. If any of the tags contains invalid
1734 characters, the entire operation will abort.
1736 If the ``--from`` option is given, the list of tags will be extended
1737 with the contents of that file (each line becomes a tag). In this
1738 case, there is not need to pass tags on the command line (if you do,
1739 both sources will be used). A file name of ``-`` will be interpreted
1745 **list-tags** {*instancename*}
1747 List the tags of the given instance.
1752 **remove-tags** [\--from *file*] {*instancename*} {*tag*...}
1754 Remove tags from the given instance. If any of the tags are not
1755 existing on the node, the entire operation will abort.
1757 If the ``--from`` option is given, the list of tags to be removed will
1758 be extended with the contents of that file (each line becomes a tag).
1759 In this case, there is not need to pass tags on the command line (if
1760 you do, tags from both sources will be removed). A file name of ``-``
1761 will be interpreted as stdin.
1763 .. vim: set textwidth=72 :