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 derives the mode and the link from the settings of the network
119 which is identified by its name. If the network option is chosen,
120 link and mode must not be specified. Note that the mode and link
121 depend on the network-to-nodegroup connection, thus allowing
122 different nodegroups to be connected to the same network in
126 Of these "mode" and "link" are nic parameters, and inherit their
127 default at cluster level. Alternatively, if no network is desired for
128 the instance, you can prevent the default of one NIC with the
129 ``--no-nics`` option.
131 The ``-o (--os-type)`` option specifies the operating system to be
132 installed. The available operating systems can be listed with
133 **gnt-os list**. Passing ``--no-install`` will however skip the OS
134 installation, allowing a manual import if so desired. Note that the
135 no-installation mode will automatically disable the start-up of the
136 instance (without an OS, it most likely won't be able to start-up
139 The ``-B (--backend-parameters)`` option specifies the backend
140 parameters for the instance. If no such parameters are specified, the
141 values are inherited from the cluster. Possible parameters are:
144 the maximum memory size of the instance; as usual, suffixes can be
145 used to denote the unit, otherwise the value is taken in mebibytes
148 the minimum memory size of the instance; as usual, suffixes can be
149 used to denote the unit, otherwise the value is taken in mebibytes
152 the number of VCPUs to assign to the instance (if this value makes
153 sense for the hypervisor)
156 whether the instance is considered in the N+1 cluster checks
157 (enough redundancy in the cluster to survive a node failure)
160 ``True`` or ``False``, whether the instance must be failed over
161 (shut down and rebooted) always or it may be migrated (briefly
164 Note that before 2.6 Ganeti had a ``memory`` parameter, which was the
165 only value of memory an instance could have. With the
166 ``maxmem``/``minmem`` change Ganeti guarantees that at least the minimum
167 memory is always available for an instance, but allows more memory to be
168 used (up to the maximum memory) should it be free.
170 The ``-H (--hypervisor-parameters)`` option specified the hypervisor
171 to use for the instance (must be one of the enabled hypervisors on the
172 cluster) and optionally custom parameters for this instance. If not
173 other options are used (i.e. the invocation is just -H *NAME*) the
174 instance will inherit the cluster options. The defaults below show the
175 cluster defaults at cluster creation time.
177 The possible hypervisor options are as follows:
180 Valid for the Xen HVM and KVM hypervisors.
182 A string value denoting the boot order. This has different meaning
183 for the Xen HVM hypervisor and for the KVM one.
185 For Xen HVM, The boot order is a string of letters listing the boot
186 devices, with valid device letters being:
200 The default is not to set an HVM boot order, which is interpreted
203 For KVM the boot order is either "floppy", "cdrom", "disk" or
204 "network". Please note that older versions of KVM couldn't netboot
205 from virtio interfaces. This has been fixed in more recent versions
206 and is confirmed to work at least with qemu-kvm 0.11.1. Also note
207 that if you have set the ``kernel_path`` option, that will be used
208 for booting, and this setting will be silently ignored.
211 Valid for the Xen HVM and PVM hypervisors.
213 Relevant to non-pvops guest kernels, in which the disk device names
214 are given by the host. Allows one to specify 'xvd', which helps run
215 Red Hat based installers, driven by anaconda.
218 Valid for the KVM hypervisor.
220 The path to a floppy disk image to attach to the instance. This
221 is useful to install Windows operating systems on Virt/IO disks
222 because you can specify here the floppy for the drivers at
226 Valid for the Xen HVM and KVM hypervisors.
228 The path to a CDROM image to attach to the instance.
231 Valid for the KVM hypervisor.
233 The path to a second CDROM image to attach to the instance.
234 **NOTE**: This image can't be used to boot the system. To do that
235 you have to use the 'cdrom\_image\_path' option.
238 Valid for the Xen HVM and KVM hypervisors.
240 This parameter determines the way the network cards are presented
241 to the instance. The possible options are:
243 - rtl8139 (default for Xen HVM) (HVM & KVM)
244 - ne2k\_isa (HVM & KVM)
245 - ne2k\_pci (HVM & KVM)
251 - paravirtual (default for KVM) (HVM & KVM)
254 Valid for the Xen HVM and KVM hypervisors.
256 This parameter determines the way the disks are presented to the
257 instance. The possible options are:
259 - ioemu [default] (HVM & KVM)
268 Valid for the KVM hypervisor.
270 This parameter determines the way the cdroms disks are presented
271 to the instance. The default behavior is to get the same value of
272 the earlier parameter (disk_type). The possible options are:
283 Valid for the Xen HVM and KVM hypervisors.
285 Specifies the address that the VNC listener for this instance
286 should bind to. Valid values are IPv4 addresses. Use the address
287 0.0.0.0 to bind to all available interfaces (this is the default)
288 or specify the address of one of the interfaces on the node to
289 restrict listening to that interface.
292 Valid for the KVM hypervisor.
294 A boolean option that controls whether the VNC connection is
298 Valid for the KVM hypervisor.
300 If ``vnc_tls`` is enabled, this options specifies the path to the
301 x509 certificate to use.
304 Valid for the KVM hypervisor.
307 Valid for the KVM hypervisor.
309 Specifies the address or interface on which the SPICE server will
310 listen. Valid values are:
312 - IPv4 addresses, including 0.0.0.0 and 127.0.0.1
313 - IPv6 addresses, including :: and ::1
314 - names of network interfaces
316 If a network interface is specified, the SPICE server will be bound
317 to one of the addresses of that interface.
320 Valid for the KVM hypervisor.
322 Specifies which version of the IP protocol should be used by the
325 It is mainly intended to be used for specifying what kind of IP
326 addresses should be used if a network interface with both IPv4 and
327 IPv6 addresses is specified via the ``spice_bind`` parameter. In
328 this case, if the ``spice_ip_version`` parameter is not used, the
329 default IP version of the cluster will be used.
331 spice\_password\_file
332 Valid for the KVM hypervisor.
334 Specifies a file containing the password that must be used when
335 connecting via the SPICE protocol. If the option is not specified,
336 passwordless connections are allowed.
338 spice\_image\_compression
339 Valid for the KVM hypervisor.
341 Configures the SPICE lossless image compression. Valid values are:
350 spice\_jpeg\_wan\_compression
351 Valid for the KVM hypervisor.
353 Configures how SPICE should use the jpeg algorithm for lossy image
354 compression on slow links. Valid values are:
360 spice\_zlib\_glz\_wan\_compression
361 Valid for the KVM hypervisor.
363 Configures how SPICE should use the zlib-glz algorithm for lossy image
364 compression on slow links. Valid values are:
370 spice\_streaming\_video
371 Valid for the KVM hypervisor.
373 Configures how SPICE should detect video streams. Valid values are:
379 spice\_playback\_compression
380 Valid for the KVM hypervisor.
382 Configures whether SPICE should compress audio streams or not.
385 Valid for the KVM hypervisor.
387 Specifies that the SPICE server must use TLS to encrypt all the
388 traffic with the client.
391 Valid for the KVM hypervisor.
393 Specifies a list of comma-separated ciphers that SPICE should use
394 for TLS connections. For the format, see man **cipher**\(1).
397 Valid for the KVM hypervisor.
399 Enables or disables passing mouse events via SPICE vdagent.
402 Valid for the KVM hypervisor.
404 This parameter determines the emulated cpu for the instance. If this
405 parameter is empty (which is the default configuration), it will not
408 Be aware of setting this parameter to ``"host"`` if you have nodes
409 with different CPUs from each other. Live migration may stop working
412 For more information please refer to the KVM manual.
415 Valid for the Xen HVM and KVM hypervisors.
417 A boolean option that specifies if the hypervisor should enable
418 ACPI support for this instance. By default, ACPI is disabled.
421 Valid for the Xen HVM and KVM hypervisors.
423 A boolean option that specifies if the hypervisor should enabled
424 PAE support for this instance. The default is false, disabling PAE
428 Valid for the Xen HVM and KVM hypervisors.
430 A boolean option that specifies if the instance should be started
431 with its clock set to the localtime of the machine (when true) or
432 to the UTC (When false). The default is false, which is useful for
433 Linux/Unix machines; for Windows OSes, it is recommended to enable
437 Valid for the Xen PVM and KVM hypervisors.
439 This option specifies the path (on the node) to the kernel to boot
440 the instance with. Xen PVM instances always require this, while for
441 KVM if this option is empty, it will cause the machine to load the
442 kernel from its disks (and the boot will be done accordingly to
446 Valid for the Xen PVM and KVM hypervisors.
448 This options specifies extra arguments to the kernel that will be
449 loaded. device. This is always used for Xen PVM, while for KVM it
450 is only used if the ``kernel_path`` option is also specified.
452 The default setting for this value is simply ``"ro"``, which
453 mounts the root disk (initially) in read-only one. For example,
454 setting this to single will cause the instance to start in
458 Valid for the Xen PVM and KVM hypervisors.
460 This option specifies the path (on the node) to the initrd to boot
461 the instance with. Xen PVM instances can use this always, while
462 for KVM if this option is only used if the ``kernel_path`` option
463 is also specified. You can pass here either an absolute filename
464 (the path to the initrd) if you want to use an initrd, or use the
465 format no\_initrd\_path for no initrd.
468 Valid for the Xen PVM and KVM hypervisors.
470 This options specifies the name of the root device. This is always
471 needed for Xen PVM, while for KVM it is only used if the
472 ``kernel_path`` option is also specified.
474 Please note, that if this setting is an empty string and the
475 hypervisor is Xen it will not be written to the Xen configuration
479 Valid for the KVM hypervisor.
481 This boolean option specifies whether to emulate a serial console
485 Valid for the KVM hypervisor.
487 This integer option specifies the speed of the serial console.
488 Common values are 9600, 19200, 38400, 57600 and 115200: choose the
489 one which works on your system. (The default is 38400 for historical
490 reasons, but newer versions of kvm/qemu work with 115200)
493 Valid for the KVM hypervisor.
495 The disk cache mode. It can be either default to not pass any
496 cache option to KVM, or one of the KVM cache modes: none (for
497 direct I/O), writethrough (to use the host cache but report
498 completion to the guest only when the host has committed the
499 changes to disk) or writeback (to use the host cache and report
500 completion as soon as the data is in the host cache). Note that
501 there are special considerations for the cache mode depending on
502 version of KVM used and disk type (always raw file under Ganeti),
503 please refer to the KVM documentation for more details.
506 Valid for the KVM hypervisor.
508 The security model for kvm. Currently one of *none*, *user* or
509 *pool*. Under *none*, the default, nothing is done and instances
510 are run as the Ganeti daemon user (normally root).
512 Under *user* kvm will drop privileges and become the user
513 specified by the security\_domain parameter.
515 Under *pool* a global cluster pool of users will be used, making
516 sure no two instances share the same user on the same node. (this
517 mode is not implemented yet)
520 Valid for the KVM hypervisor.
522 Under security model *user* the username to run the instance
523 under. It must be a valid username existing on the host.
525 Cannot be set under security model *none* or *pool*.
528 Valid for the KVM hypervisor.
530 If *enabled* the -enable-kvm flag is passed to kvm. If *disabled*
531 -disable-kvm is passed. If unset no flag is passed, and the
532 default running mode for your kvm binary will be used.
535 Valid for the KVM hypervisor.
537 This option passes the -mem-path argument to kvm with the path (on
538 the node) to the mount point of the hugetlbfs file system, along
539 with the -mem-prealloc argument too.
542 Valid for the KVM hypervisor.
544 This boolean option determines whether to run the KVM instance in a
547 If it is set to ``true``, an empty directory is created before
548 starting the instance and its path is passed via the -chroot flag
549 to kvm. The directory is removed when the instance is stopped.
551 It is set to ``false`` by default.
554 Valid for the KVM hypervisor.
556 The maximum amount of time (in ms) a KVM instance is allowed to be
557 frozen during a live migration, in order to copy dirty memory
558 pages. Default value is 30ms, but you may need to increase this
559 value for busy instances.
561 This option is only effective with kvm versions >= 87 and qemu-kvm
565 Valid for the Xen, KVM and LXC hypervisors.
567 The processes belonging to the given instance are only scheduled
568 on the specified CPUs.
570 The format of the mask can be given in three forms. First, the word
571 "all", which signifies the common case where all VCPUs can live on
572 any CPU, based on the hypervisor's decisions.
574 Second, a comma-separated list of CPU IDs or CPU ID ranges. The
575 ranges are defined by a lower and higher boundary, separated by a
576 dash, and the boundaries are inclusive. In this form, all VCPUs of
577 the instance will be mapped on the selected list of CPUs. Example:
578 ``0-2,5``, mapping all VCPUs (no matter how many) onto physical CPUs
581 The last form is used for explicit control of VCPU-CPU pinnings. In
582 this form, the list of VCPU mappings is given as a colon (:)
583 separated list, whose elements are the possible values for the
584 second or first form above. In this form, the number of elements in
585 the colon-separated list _must_ equal the number of VCPUs of the
592 # Map the entire instance to CPUs 0-2
593 gnt-instance modify -H cpu_mask=0-2 my-inst
595 # Map vCPU 0 to physical CPU 1 and vCPU 1 to CPU 3 (assuming 2 vCPUs)
596 gnt-instance modify -H cpu_mask=1:3 my-inst
598 # Pin vCPU 0 to CPUs 1 or 2, and vCPU 1 to any CPU
599 gnt-instance modify -H cpu_mask=1-2:all my-inst
601 # Pin vCPU 0 to any CPU, vCPU 1 to CPUs 1, 3, 4 or 5, and CPU 2 to
602 # CPU 0 (backslashes for escaping the comma)
603 gnt-instance modify -H cpu_mask=all:1\\,3-5:0 my-inst
605 # Pin entire VM to CPU 0
606 gnt-instance modify -H cpu_mask=0 my-inst
608 # Turn off CPU pinning (default setting)
609 gnt-instance modify -H cpu_mask=all my-inst
612 Valid for the Xen hypervisor.
614 Set the maximum amount of cpu usage by the VM. The value is a percentage
615 between 0 and (100 * number of VCPUs). Default cap is 0: unlimited.
618 Valid for the Xen hypervisor.
620 Set the cpu time ratio to be allocated to the VM. Valid values are
621 between 1 and 65535. Default weight is 256.
624 Valid for the KVM hypervisor.
626 This option specifies the usb mouse type to be used. It can be
627 "mouse" or "tablet". When using VNC it's recommended to set it to
631 Valid for the KVM hypervisor.
633 This option specifies the keyboard mapping to be used. It is only
634 needed when using the VNC console. For example: "fr" or "en-gb".
637 Valid for Xen PVM, Xen HVM and KVM hypervisors.
639 Normally if an instance reboots, the hypervisor will restart it. If
640 this option is set to ``exit``, the hypervisor will treat a reboot
641 as a shutdown instead.
643 It is set to ``reboot`` by default.
646 Valid for the KVM hypervisor.
648 Number of emulated CPU cores.
651 Valid for the KVM hypervisor.
653 Number of emulated CPU threads.
656 Valid for the KVM hypervisor.
658 Number of emulated CPU sockets.
661 Valid for the KVM hypervisor.
663 Comma separated list of emulated sounds cards, or "all" to enable
664 all the available ones.
667 Valid for the KVM hypervisor.
669 Comma separated list of usb devices. These can be emulated devices
670 or passthrough ones, and each one gets passed to kvm with its own
671 ``-usbdevice`` option. See the **qemu**\(1) manpage for the syntax
672 of the possible components.
675 Valid for the KVM hypervisor.
677 Emulated vga mode, passed the the kvm -vga option.
680 Valid for the KVM hypervisor.
682 Any other option to the KVM hypervisor, useful tweaking anything
683 that Ganeti doesn't support.
686 Valid for the KVM hypervisor.
688 Use in case an instance must be booted with an exact type of
689 machine version (due to e.g. outdated drivers). In case it's not set
690 the default version supported by your version of kvm is used.
693 Valid for the KVM hypervisor.
695 Path to the userspace KVM (or qemu) program.
697 The ``-O (--os-parameters)`` option allows customisation of the OS
698 parameters. The actual parameter names and values depends on the OS
699 being used, but the syntax is the same key=value. For example, setting
700 a hypothetical ``dhcp`` parameter to yes can be achieved by::
702 gnt-instance add -O dhcp=yes ...
704 The ``-I (--iallocator)`` option specifies the instance allocator plugin
705 to use (``.`` means the default allocator). If you pass in this option
706 the allocator will select nodes for this instance automatically, so you
707 don't need to pass them with the ``-n`` option. For more information
708 please refer to the instance allocator documentation.
710 The ``-t (--disk-template)`` options specifies the disk layout type
711 for the instance. The available choices are:
714 This creates an instance with no disks. Its useful for testing only
715 (or other special cases).
718 Disk devices will be regular files.
721 Disk devices will be logical volumes.
724 Disk devices will be drbd (version 8.x) on top of lvm volumes.
727 Disk devices will be rbd volumes residing inside a RADOS cluster.
730 The optional second value of the ``-n (--node)`` is used for the drbd
731 template type and specifies the remote node.
733 If you do not want gnt-instance to wait for the disk mirror to be
734 synced, use the ``--no-wait-for-sync`` option.
736 The ``--file-storage-dir`` specifies the relative path under the
737 cluster-wide file storage directory to store file-based disks. It is
738 useful for having different subdirectories for different
739 instances. The full path of the directory where the disk files are
740 stored will consist of cluster-wide file storage directory + optional
741 subdirectory + instance name. Example:
742 ``@RPL_FILE_STORAGE_DIR@/mysubdir/instance1.example.com``. This
743 option is only relevant for instances using the file storage backend.
745 The ``--file-driver`` specifies the driver to use for file-based
746 disks. Note that currently these drivers work with the xen hypervisor
747 only. This option is only relevant for instances using the file
748 storage backend. The available choices are:
751 Kernel loopback driver. This driver uses loopback devices to
752 access the filesystem within the file. However, running I/O
753 intensive applications in your instance using the loop driver
754 might result in slowdowns. Furthermore, if you use the loopback
755 driver consider increasing the maximum amount of loopback devices
756 (on most systems it's 8) using the max\_loop param.
759 The blktap driver (for Xen hypervisors). In order to be able to
760 use the blktap driver you should check if the 'blktapctrl' user
761 space disk agent is running (usually automatically started via
762 xend). This user-level disk I/O interface has the advantage of
763 better performance. Especially if you use a network file system
764 (e.g. NFS) to store your instances this is the recommended choice.
766 If ``--ignore-ipolicy`` is given any instance policy violations occuring
767 during this operation are ignored.
769 See **ganeti**\(7) for a description of ``--submit`` and other common
774 # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
775 -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
776 # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
777 -o debian-etch -n node1.example.com instance1.example.com
778 # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
779 -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
780 # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
781 -n node1.example.com:node2.example.com instance2.example.com
787 **batch-create** {instances\_file.json}
789 This command (similar to the Ganeti 1.2 **batcher** tool) submits
790 multiple instance creation jobs based on a definition file. The
791 instance configurations do not encompass all the possible options for
792 the **add** command, but only a subset.
794 The instance file should be a valid-formed JSON file, containing a
795 dictionary with instance name and instance parameters. The accepted
799 The size of the disks of the instance.
802 The disk template to use for the instance, the same as in the
806 A dictionary of backend parameters.
809 A dictionary with a single key (the hypervisor name), and as value
810 the hypervisor options. If not passed, the default hypervisor and
811 hypervisor options will be inherited.
814 Specifications for the one NIC that will be created for the
815 instance. 'bridge' is also accepted as a backwards compatible
819 List of nics that will be created for the instance. Each entry
820 should be a dict, with mac, ip, mode and link as possible keys.
821 Please don't provide the "mac, ip, mode, link" parent keys if you
822 use this method for specifying nics.
824 primary\_node, secondary\_node
825 The primary and optionally the secondary node to use for the
826 instance (in case an iallocator script is not used).
829 Instead of specifying the nodes, an iallocator script can be used
830 to automatically compute them.
833 whether to start the instance
836 Skip the check for already-in-use instance; see the description in
837 the **add** command for details.
840 Skip the name check for instances; see the description in the
841 **add** command for details.
843 file\_storage\_dir, file\_driver
844 Configuration for the file disk type, see the **add** command for
848 A simple definition for one instance can be (with most of the
849 parameters taken from the cluster defaults)::
855 "disk_size": ["25G"],
861 "disk_size": ["25G"],
862 "iallocator": "dumb",
863 "hypervisor": "xen-hvm",
864 "hvparams": {"acpi": true},
865 "backend": {"maxmem": 512, "minmem": 256}
869 The command will display the job id for each submitted instance, as
872 # gnt-instance batch-create instances.json
879 **remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
880 [\--force] {*instance*}
882 Remove an instance. This will remove all data from the instance and
883 there is *no way back*. If you are not sure if you use an instance
884 again, use **shutdown** first and leave it in the shutdown state for a
887 The ``--ignore-failures`` option will cause the removal to proceed
888 even in the presence of errors during the removal of the instance
889 (e.g. during the shutdown or the disk removal). If this option is not
890 given, the command will stop at the first error.
892 The ``--shutdown-timeout`` is used to specify how much time to wait
893 before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the
894 kvm process for KVM, etc.). By default two minutes are given to each
897 The ``--force`` option is used to skip the interactive confirmation.
899 See **ganeti**\(7) for a description of ``--submit`` and other common
904 # gnt-instance remove instance1.example.com
911 | [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
912 | [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
914 Shows the currently configured instances with memory usage, disk
915 usage, the node they are running on, and their run status.
917 The ``--no-headers`` option will skip the initial header line. The
918 ``--separator`` option takes an argument which denotes what will be
919 used between the output fields. Both these options are to help
922 The units used to display the numeric values in the output varies,
923 depending on the options given. By default, the values will be
924 formatted in the most appropriate unit. If the ``--separator`` option
925 is given, then the values are shown in mebibytes to allow parsing by
926 scripts. In both cases, the ``--units`` option can be used to enforce
929 The ``-v`` option activates verbose mode, which changes the display of
930 special field states (see **ganeti**\(7)).
932 The ``-o (--output)`` option takes a comma-separated list of output
933 fields. The available fields and their meaning are:
935 @QUERY_FIELDS_INSTANCE@
937 If the value of the option starts with the character ``+``, the new
938 field(s) will be added to the default list. This allows one to quickly
939 see the default list plus a few other fields, instead of retyping the
940 entire list of fields.
942 There is a subtle grouping about the available output fields: all
943 fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and
944 ``status`` are configuration value and not run-time values. So if you
945 don't select any of the these fields, the query will be satisfied
946 instantly from the cluster configuration, without having to ask the
947 remote nodes for the data. This can be helpful for big clusters when
948 you only want some data and it makes sense to specify a reduced set of
951 If exactly one argument is given and it appears to be a query filter
952 (see **ganeti**\(7)), the query result is filtered accordingly. For
953 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
954 (``-F``) option forces the argument to be treated as a filter (e.g.
955 ``gnt-instance list -F admin_state``).
957 The default output field list is: ``name``, ``os``, ``pnode``,
958 ``admin_state``, ``oper_state``, ``oper_ram``.
964 **list-fields** [field...]
966 Lists available fields for instances.
972 **info** [-s \| \--static] [\--roman] {\--all \| *instance*}
974 Show detailed information about the given instance(s). This is
975 different from **list** as it shows detailed data about the instance's
976 disks (especially useful for the drbd disk template).
978 If the option ``-s`` is used, only information available in the
979 configuration file is returned, without querying nodes, making the
982 Use the ``--all`` to get info about all instances, rather than
983 explicitly passing the ones you're interested in.
985 The ``--roman`` option can be used to cause envy among people who like
986 ancient cultures, but are stuck with non-latin-friendly cluster
987 virtualization technologies.
993 | [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
994 | [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
995 | [{-m|\--runtime-memory} *SIZE*]
996 | [\--net add*[:options]* \| \--net [*N*:]remove \| \--net *N:options*]
997 | [\--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| \--disk [*N*:]remove \|
998 | \--disk *N*:mode=*MODE*]
999 | [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
1000 | [\--os-type=*OS* [\--force-variant]]
1001 | [{-O|\--os-parameters} *param*=*value*... ]
1002 | [\--offline \| \--online]
1004 | [\--ignore-ipolicy]
1007 Modifies the memory size, number of vcpus, ip address, MAC address
1008 and/or nic parameters for an instance. It can also add and remove
1009 disks and NICs to/from the instance. Note that you need to give at
1010 least one of the arguments, otherwise the command complains.
1012 The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``
1013 and ``-O (--os-parameters)`` options specifies hypervisor, backend and
1014 OS parameter options in the form of name=value[,...]. For details
1015 which options can be specified, see the **add** command.
1017 The ``-t (--disk-template)`` option will change the disk template of
1018 the instance. Currently only conversions between the plain and drbd
1019 disk templates are supported, and the instance must be stopped before
1020 attempting the conversion. When changing from the plain to the drbd
1021 disk template, a new secondary node must be specified via the ``-n``
1022 option. The option ``--no-wait-for-sync`` can be used when converting
1023 to the ``drbd`` template in order to make the instance available for
1024 startup before DRBD has finished resyncing.
1026 The ``-m (--runtime-memory)`` option will change an instance's runtime
1027 memory to the given size (in MB if a different suffix is not specified),
1028 by ballooning it up or down to the new value.
1030 The ``--disk add:size=``*SIZE* option adds a disk to the instance. The
1031 optional ``vg=``*VG* option specifies an LVM volume group other than
1032 the default volume group to create the disk on. For DRBD disks, the
1033 ``metavg=``*VG* option specifies the volume group for the metadata
1034 device. ``--disk`` *N*``:add,size=``**SIZE** can be used to add a
1035 disk at a specific index. The ``--disk remove`` option will remove the
1036 last disk of the instance. Use ``--disk `` *N*``:remove`` to remove a
1037 disk by its index. The ``--disk`` *N*``:mode=``*MODE* option will change
1038 the mode of the Nth disk of the instance between read-only (``ro``) and
1039 read-write (``rw``).
1041 The ``--net add:``*options* and ``--net`` *N*``:add,``*options* option
1042 will add a new network interface to the instance. The available options
1043 are the same as in the **add** command (``mac``, ``ip``, ``link``,
1044 ``mode``, ``network``). The ``--net remove`` will remove the last network
1045 interface of the instance (``--net`` *N*``:remove`` for a specific index),
1046 while the ``--net`` *N*``:``*options* option will change the parameters of
1047 the Nth instance network interface.
1049 The option ``-o (--os-type)`` will change the OS name for the instance
1050 (without reinstallation). In case an OS variant is specified that is
1051 not found, then by default the modification is refused, unless
1052 ``--force-variant`` is passed. An invalid OS will also be refused,
1053 unless the ``--force`` option is given.
1055 The ``--online`` and ``--offline`` options are used to transition an
1056 instance into and out of the ``offline`` state. An instance can be
1057 turned offline only if it was previously down. The ``--online`` option
1058 fails if the instance was not in the ``offline`` state, otherwise it
1059 changes instance's state to ``down``. These modifications take effect
1062 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1063 during this operation are ignored.
1065 See **ganeti**\(7) for a description of ``--submit`` and other common
1068 Most of the changes take effect at the next restart. If the instance is
1069 running, there is no effect on the instance.
1074 | **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
1075 | [\--force-multiple]
1076 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
1077 | [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...}
1079 Reinstalls the operating system on the given instance(s). The
1080 instance(s) must be stopped when running this command. If the ``-o
1081 (--os-type)`` is specified, the operating system is changed.
1083 The ``--select-os`` option switches to an interactive OS reinstall.
1084 The user is prompted to select the OS template from the list of
1085 available OS templates. OS parameters can be overridden using ``-O
1086 (--os-parameters)`` (more documentation for this option under the
1089 Since this is a potentially dangerous command, the user will be
1090 required to confirm this action, unless the ``-f`` flag is passed.
1091 When multiple instances are selected (either by passing multiple
1092 arguments or by using the ``--node``, ``--primary``, ``--secondary``
1093 or ``--all`` options), the user must pass the ``--force-multiple``
1094 options to skip the interactive confirmation.
1096 See **ganeti**\(7) for a description of ``--submit`` and other common
1102 | **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
1103 | {*instance*} {*new\_name*}
1105 Renames the given instance. The instance must be stopped when running
1106 this command. The requirements for the new name are the same as for
1107 adding an instance: the new name must be resolvable and the IP it
1108 resolves to must not be reachable (in order to prevent duplicate IPs
1109 the next time the instance is started). The IP test can be skipped if
1110 the ``--no-ip-check`` option is passed.
1112 Note that you can rename an instance to its same name, to force
1113 re-executing the os-specific rename script for that instance, if
1116 The ``--no-name-check`` skips the check for the new instance name via
1117 the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
1118 that the resolved name matches the provided name. Since the name check
1119 is used to compute the IP address, if you pass this option you must also
1120 pass the ``--no-ip-check`` option.
1122 See **ganeti**\(7) for a description of ``--submit`` and other common
1125 Starting/stopping/connecting to console
1126 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1132 | [\--force] [\--ignore-offline]
1133 | [\--force-multiple] [\--no-remember]
1134 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1135 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1136 | [{-H|\--hypervisor-parameters} ``key=value...``]
1137 | [{-B|\--backend-parameters} ``key=value...``]
1138 | [\--submit] [\--paused]
1141 Starts one or more instances, depending on the following options. The
1142 four available modes are:
1145 will start the instances given as arguments (at least one argument
1146 required); this is the default selection
1149 will start the instances who have the given node as either primary
1153 will start all instances whose primary node is in the list of nodes
1154 passed as arguments (at least one node required)
1157 will start all instances whose secondary node is in the list of
1158 nodes passed as arguments (at least one node required)
1161 will start all instances in the cluster (no arguments accepted)
1164 will start all instances in the cluster with the tags given as
1168 will start all instances in the cluster on nodes with the tags
1172 will start all instances in the cluster on primary nodes with the
1173 tags given as arguments
1176 will start all instances in the cluster on secondary nodes with the
1177 tags given as arguments
1179 Note that although you can pass more than one selection option, the
1180 last one wins, so in order to guarantee the desired result, don't pass
1181 more than one such option.
1183 Use ``--force`` to start even if secondary disks are failing.
1184 ``--ignore-offline`` can be used to ignore offline primary nodes and
1185 mark the instance as started even if the primary is not available.
1187 The ``--force-multiple`` will skip the interactive confirmation in the
1188 case the more than one instance will be affected.
1190 The ``--no-remember`` option will perform the startup but not change
1191 the state of the instance in the configuration file (if it was stopped
1192 before, Ganeti will still think it needs to be stopped). This can be
1193 used for testing, or for a one shot-start where you don't want the
1194 watcher to restart the instance if it crashes.
1196 The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)``
1197 options specify temporary hypervisor and backend parameters that can
1198 be used to start an instance with modified parameters. They can be
1199 useful for quick testing without having to modify an instance back and
1202 # gnt-instance start -H kernel_args="single" instance1
1203 # gnt-instance start -B maxmem=2048 instance2
1206 The first form will start the instance instance1 in single-user mode,
1207 and the instance instance2 with 2GB of RAM (this time only, unless
1208 that is the actual instance memory size already). Note that the values
1209 override the instance parameters (and not extend them): an instance
1210 with "kernel\_args=ro" when started with -H kernel\_args=single will
1211 result in "single", not "ro single".
1213 The ``--paused`` option is only valid for Xen and kvm hypervisors. This
1214 pauses the instance at the start of bootup, awaiting ``gnt-instance
1215 console`` to unpause it, allowing the entire boot process to be
1216 monitored for debugging.
1218 See **ganeti**\(7) for a description of ``--submit`` and other common
1223 # gnt-instance start instance1.example.com
1224 # gnt-instance start --node node1.example.com node2.example.com
1225 # gnt-instance start --all
1233 | [\--force] [\--force-multiple] [\--ignore-offline] [\--no-remember]
1234 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1235 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1239 Stops one or more instances. If the instance cannot be cleanly stopped
1240 during a hardcoded interval (currently 2 minutes), it will forcibly
1241 stop the instance (equivalent to switching off the power on a physical
1244 The ``--timeout`` is used to specify how much time to wait before
1245 forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm
1246 process for KVM, etc.). By default two minutes are given to each
1249 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1250 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1251 ``--sec-node-tags`` options are similar as for the **startup** command
1252 and they influence the actual instances being shutdown.
1254 ``--ignore-offline`` can be used to ignore offline primary nodes and
1255 force the instance to be marked as stopped. This option should be used
1256 with care as it can lead to an inconsistent cluster state.
1258 Use ``--force`` to be able to shutdown an instance even when it's marked
1259 as offline. This is useful is an offline instance ends up in the
1260 ``ERROR_up`` state, for example.
1262 The ``--no-remember`` option will perform the shutdown but not change
1263 the state of the instance in the configuration file (if it was running
1264 before, Ganeti will still thinks it needs to be running). This can be
1265 useful for a cluster-wide shutdown, where some instances are marked as
1266 up and some as down, and you don't want to change the running state:
1267 you just need to disable the watcher, shutdown all instances with
1268 ``--no-remember``, and when the watcher is activated again it will
1269 restore the correct runtime state for all instances.
1271 See **ganeti**\(7) for a description of ``--submit`` and other common
1276 # gnt-instance shutdown instance1.example.com
1277 # gnt-instance shutdown --all
1284 | [{-t|\--type} *REBOOT-TYPE*]
1285 | [\--ignore-secondaries]
1286 | [\--shutdown-timeout=*N*]
1287 | [\--force-multiple]
1288 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
1289 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
1293 Reboots one or more instances. The type of reboot depends on the value
1294 of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
1295 does a instance stop, recreates the hypervisor config for the instance
1296 and starts the instance. A full reboot does the equivalent of
1297 **gnt-instance shutdown && gnt-instance startup**. The default is
1300 For the hard reboot the option ``--ignore-secondaries`` ignores errors
1301 for the secondary node while re-assembling the instance disks.
1303 The ``--instance``, ``--node``, ``--primary``, ``--secondary``,
1304 ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and
1305 ``--sec-node-tags`` options are similar as for the **startup** command
1306 and they influence the actual instances being rebooted.
1308 The ``--shutdown-timeout`` is used to specify how much time to wait
1309 before forcing the shutdown (xm destroy in xen, killing the kvm
1310 process, for kvm). By default two minutes are given to each instance
1313 The ``--force-multiple`` will skip the interactive confirmation in the
1314 case the more than one instance will be affected.
1316 See **ganeti**\(7) for a description of ``--submit`` and other common
1321 # gnt-instance reboot instance1.example.com
1322 # gnt-instance reboot --type=full instance1.example.com
1328 **console** [\--show-cmd] {*instance*}
1330 Connects to the console of the given instance. If the instance is not
1331 up, an error is returned. Use the ``--show-cmd`` option to display the
1332 command instead of executing it.
1334 For HVM instances, this will attempt to connect to the serial console
1335 of the instance. To connect to the virtualized "physical" console of a
1336 HVM instance, use a VNC client with the connection info from the
1339 For Xen/kvm instances, if the instance is paused, this attempts to
1340 unpause the instance after waiting a few seconds for the connection to
1341 the console to be made.
1345 # gnt-instance console instance1.example.com
1354 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p}
1355 [\--disks *idx*] {*instance*}
1357 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
1358 [\--disks *idx*] {*instance*}
1360 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1361 {{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
1363 **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
1364 {-a\|\--auto} {*instance*}
1366 This command is a generalized form for replacing disks. It is
1367 currently only valid for the mirrored (DRBD) disk template.
1369 The first form (when passing the ``-p`` option) will replace the disks
1370 on the primary, while the second form (when passing the ``-s`` option
1371 will replace the disks on the secondary node. For these two cases (as
1372 the node doesn't change), it is possible to only run the replace for a
1373 subset of the disks, using the option ``--disks`` which takes a list
1374 of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only
1375 the first and third disks.
1377 The third form (when passing either the ``--iallocator`` or the
1378 ``--new-secondary`` option) is designed to change secondary node of the
1379 instance. Specifying ``--iallocator`` makes the new secondary be
1380 selected automatically by the specified allocator plugin (use ``.`` to
1381 indicate the default allocator), otherwise the new secondary node will
1382 be the one chosen manually via the ``--new-secondary`` option.
1384 Note that it is not possible to select an offline or drained node as a
1387 The fourth form (when using ``--auto``) will automatically determine
1388 which disks of an instance are faulty and replace them within the same
1389 node. The ``--auto`` option works only when an instance has only
1390 faulty disks on either the primary or secondary node; it doesn't work
1391 when both sides have faulty disks.
1393 The ``--early-release`` changes the code so that the old storage on
1394 secondary node(s) is removed early (before the resync is completed)
1395 and the internal Ganeti locks for the current (and new, if any)
1396 secondary node are also released, thus allowing more parallelism in
1397 the cluster operation. This should be used only when recovering from a
1398 disk failure on the current secondary (thus the old storage is already
1399 broken) or when the storage on the primary node is known to be fine
1400 (thus we won't need the old storage for potential recovery).
1402 The ``--ignore-ipolicy`` let the command ignore instance policy
1403 violations if replace-disks changes groups and the instance would
1404 violate the new groups instance policy.
1406 See **ganeti**\(7) for a description of ``--submit`` and other common
1412 **activate-disks** [\--submit] [\--ignore-size] [\--wait-for-sync] {*instance*}
1414 Activates the block devices of the given instance. If successful, the
1415 command will show the location and name of the block devices::
1417 node1.example.com:disk/0:/dev/drbd0
1418 node1.example.com:disk/1:/dev/drbd1
1421 In this example, *node1.example.com* is the name of the node on which
1422 the devices have been activated. The *disk/0* and *disk/1* are the
1423 Ganeti-names of the instance disks; how they are visible inside the
1424 instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the
1425 actual block devices as visible on the node.
1427 The ``--ignore-size`` option can be used to activate disks ignoring
1428 the currently configured size in Ganeti. This can be used in cases
1429 where the configuration has gotten out of sync with the real-world
1430 (e.g. after a partially-failed grow-disk operation or due to rounding
1431 in LVM devices). This should not be used in normal cases, but only
1432 when activate-disks fails without it.
1434 The ``--wait-for-sync`` option will ensure that the command returns only
1435 after the instance's disks are synchronised (mostly for DRBD); this can
1436 be useful to ensure consistency, as otherwise there are no commands that
1437 can wait until synchronisation is done. However when passing this
1438 option, the command will have additional output, making it harder to
1439 parse the disk information.
1441 Note that it is safe to run this command while the instance is already
1444 See **ganeti**\(7) for a description of ``--submit`` and other common
1450 **deactivate-disks** [-f] [\--submit] {*instance*}
1452 De-activates the block devices of the given instance. Note that if you
1453 run this command for an instance with a drbd disk template, while it
1454 is running, it will not be able to shutdown the block devices on the
1455 primary node, but it will shutdown the block devices on the secondary
1456 nodes, thus breaking the replication.
1458 The ``-f``/``--force`` option will skip checks that the instance is
1459 down; in case the hypervisor is confused and we can't talk to it,
1460 normally Ganeti will refuse to deactivate the disks, but with this
1461 option passed it will skip this check and directly try to deactivate
1462 the disks. This can still fail due to the instance actually running or
1465 See **ganeti**\(7) for a description of ``--submit`` and other common
1471 | **grow-disk** [\--no-wait-for-sync] [\--submit] [\--absolute]
1472 | {*instance*} {*disk*} {*amount*}
1474 Grows an instance's disk. This is only possible for instances having a
1475 plain, drbd, file, sharedfile or rbd disk template.
1477 Note that this command only change the block device size; it will not
1478 grow the actual filesystems, partitions, etc. that live on that
1479 disk. Usually, you will need to:
1481 #. use **gnt-instance grow-disk**
1483 #. reboot the instance (later, at a convenient time)
1485 #. use a filesystem resizer, such as **ext2online**\(8) or
1486 **xfs\_growfs**\(8) to resize the filesystem, or use **fdisk**\(8) to
1487 change the partition table on the disk
1489 The *disk* argument is the index of the instance disk to grow. The
1490 *amount* argument is given as a number which can have a suffix (like the
1491 disk size in instance create); if the suffix is missing, the value will
1492 be interpreted as mebibytes.
1494 By default, the *amount* value represents the desired increase in the
1495 disk size (e.g. an amount of 1G will take a disk of size 3G to 4G). If
1496 the optional ``--absolute`` parameter is passed, then the *amount*
1497 argument doesn't represent the delta, but instead the desired final disk
1498 size (e.g. an amount of 8G will take a disk of size 4G to 8G).
1500 For instances with a drbd template, note that the disk grow operation
1501 might complete on one node but fail on the other; this will leave the
1502 instance with different-sized LVs on the two nodes, but this will not
1503 create problems (except for unused space).
1505 If you do not want gnt-instance to wait for the new disk region to be
1506 synced, use the ``--no-wait-for-sync`` option.
1508 See **ganeti**\(7) for a description of ``--submit`` and other common
1511 Example (increase the first disk for instance1 by 16GiB)::
1513 # gnt-instance grow-disk instance1.example.com 0 16g
1515 Example for increasing the disk size to a certain size::
1517 # gnt-instance grow-disk --absolute instance1.example.com 0 32g
1519 Also note that disk shrinking is not supported; use **gnt-backup
1520 export** and then **gnt-backup import** to reduce the disk size of an
1526 | **recreate-disks** [\--submit]
1527 | [{-n node1:[node2] \| {-I\|\--iallocator *name*}}]
1528 | [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
1530 Recreates all or a subset of disks of the given instance.
1532 Note that this functionality should only be used for missing disks; if
1533 any of the given disks already exists, the operation will fail. While
1534 this is suboptimal, recreate-disks should hopefully not be needed in
1535 normal operation and as such the impact of this is low.
1537 If only a subset should be recreated, any number of ``disk`` options can
1538 be specified. It expects a disk index and an optional list of disk
1539 parameters to change. Only ``size`` and ``mode`` can be changed while
1540 recreating disks. To recreate all disks while changing parameters on
1541 a subset only, a ``--disk`` option must be given for every disk of the
1544 Optionally the instance's disks can be recreated on different
1545 nodes. This can be useful if, for example, the original nodes of the
1546 instance have gone down (and are marked offline), so we can't recreate
1547 on the same nodes. To do this, pass the new node(s) via ``-n`` option,
1548 with a syntax similar to the **add** command. The number of nodes
1549 passed must equal the number of nodes that the instance currently
1550 has. Note that changing nodes is only allowed when all disks are
1551 replaced, e.g. when no ``--disk`` option is passed.
1553 Another method of choosing which nodes to place the instance on is by
1554 using the specified iallocator, passing the ``--iallocator`` option.
1555 The primary and secondary nodes will be chosen by the specified
1556 iallocator plugin, or by the default allocator if ``.`` is specified.
1558 See **ganeti**\(7) for a description of ``--submit`` and other common
1567 | **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
1568 | [\--shutdown-timeout=*N*]
1569 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
1573 Failover will stop the instance (if running), change its primary node,
1574 and if it was originally running it will start it again (on the new
1575 primary). This only works for instances with drbd template (in which
1576 case you can only fail to the secondary node) and for externally
1577 mirrored templates (blockdev and rbd) (which can change to any other
1580 If the instance's disk template is of type blockdev or rbd, then you
1581 can explicitly specify the target node (which can be any node) using
1582 the ``-n`` or ``--target-node`` option, or specify an iallocator plugin
1583 using the ``-I`` or ``--iallocator`` option. If you omit both, the default
1584 iallocator will be used to specify the target node.
1586 Normally the failover will check the consistency of the disks before
1587 failing over the instance. If you are trying to migrate instances off
1588 a dead node, this will fail. Use the ``--ignore-consistency`` option
1589 for this purpose. Note that this option can be dangerous as errors in
1590 shutting down the instance will be ignored, resulting in possibly
1591 having the instance running on two machines in parallel (on
1592 disconnected DRBD drives).
1594 The ``--shutdown-timeout`` is used to specify how much time to wait
1595 before forcing the shutdown (xm destroy in xen, killing the kvm
1596 process, for kvm). By default two minutes are given to each instance
1599 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1600 during this operation are ignored.
1602 See **ganeti**\(7) for a description of ``--submit`` and other common
1607 # gnt-instance failover instance1.example.com
1613 | **migrate** [-f] [\--allow-failover] [\--non-live]
1614 | [\--migration-mode=live\|non-live] [\--ignore-ipolicy]
1615 | [\--no-runtime-changes] [\--submit]
1616 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
1618 | **migrate** [-f] \--cleanup [\--submit] {*instance*}
1620 Migrate will move the instance to its secondary node without shutdown.
1621 As with failover, it only works for instances having the drbd disk
1622 template or an externally mirrored disk template type such as blockdev
1625 If the instance's disk template is of type blockdev or rbd, then you can
1626 explicitly specify the target node (which can be any node) using the
1627 ``-n`` or ``--target-node`` option, or specify an iallocator plugin
1628 using the ``-I`` or ``--iallocator`` option. If you omit both, the
1629 default iallocator will be used to specify the target node.
1630 Alternatively, the default iallocator can be requested by specifying
1631 ``.`` as the name of the plugin.
1633 The migration command needs a perfectly healthy instance, as we rely
1634 on the dual-master capability of drbd8 and the disks of the instance
1635 are not allowed to be degraded.
1637 The ``--non-live`` and ``--migration-mode=non-live`` options will
1638 switch (for the hypervisors that support it) between a "fully live"
1639 (i.e. the interruption is as minimal as possible) migration and one in
1640 which the instance is frozen, its state saved and transported to the
1641 remote node, and then resumed there. This all depends on the
1642 hypervisor support for two different methods. In any case, it is not
1643 an error to pass this parameter (it will just be ignored if the
1644 hypervisor doesn't support it). The option ``--migration-mode=live``
1645 option will request a fully-live migration. The default, when neither
1646 option is passed, depends on the hypervisor parameters (and can be
1647 viewed with the **gnt-cluster info** command).
1649 If the ``--cleanup`` option is passed, the operation changes from
1650 migration to attempting recovery from a failed previous migration. In
1651 this mode, Ganeti checks if the instance runs on the correct node (and
1652 updates its configuration if not) and ensures the instances' disks
1653 are configured correctly. In this mode, the ``--non-live`` option is
1656 The option ``-f`` will skip the prompting for confirmation.
1658 If ``--allow-failover`` is specified it tries to fallback to failover if
1659 it already can determine that a migration won't work (e.g. if the
1660 instance is shut down). Please note that the fallback will not happen
1661 during execution. If a migration fails during execution it still fails.
1663 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1664 during this operation are ignored.
1666 The ``--no-runtime-changes`` option forbids migrate to alter an
1667 instance's runtime before migrating it (eg. ballooning an instance
1668 down because the target node doesn't have enough available memory).
1670 If an instance has the backend parameter ``always_failover`` set to
1671 true, then the migration is automatically converted into a failover.
1673 See **ganeti**\(7) for a description of ``--submit`` and other common
1676 Example (and expected output)::
1678 # gnt-instance migrate instance1
1679 Instance instance1 will be migrated. Note that migration
1680 might impact the instance if anything goes wrong (e.g. due to bugs in
1681 the hypervisor). Continue?
1683 Migrating instance instance1.example.com
1684 * checking disk consistency between source and target
1685 * switching node node2.example.com to secondary mode
1686 * changing into standalone mode
1687 * changing disks into dual-master mode
1688 * wait until resync is done
1689 * preparing node2.example.com to accept the instance
1690 * migrating instance to node2.example.com
1691 * switching node node1.example.com to secondary mode
1692 * wait until resync is done
1693 * changing into standalone mode
1694 * changing disks into single-master mode
1695 * wait until resync is done
1703 | **move** [-f] [\--ignore-consistency]
1704 | [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
1707 Move will move the instance to an arbitrary node in the cluster. This
1708 works only for instances having a plain or file disk template.
1710 Note that since this operation is done via data copy, it will take a
1711 long time for big disks (similar to replace-disks for a drbd
1714 The ``--shutdown-timeout`` is used to specify how much time to wait
1715 before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the
1716 kvm process for KVM, etc.). By default two minutes are given to each
1719 The ``--ignore-consistency`` option will make Ganeti ignore any errors
1720 in trying to shutdown the instance on its node; useful if the
1721 hypervisor is broken and you want to recover the data.
1723 If ``--ignore-ipolicy`` is given any instance policy violations occuring
1724 during this operation are ignored.
1726 See **ganeti**\(7) for a description of ``--submit`` and other common
1731 # gnt-instance move -n node3.example.com instance1.example.com
1737 | **change-group** [\--submit]
1738 | [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
1740 This command moves an instance to another node group. The move is
1741 calculated by an iallocator, either given on the command line or as a
1744 If no specific destination groups are specified using ``--to``, all
1745 groups except the one containing the instance are considered.
1747 See **ganeti**\(7) for a description of ``--submit`` and other common
1752 # gnt-instance change-group -I hail --to rack2 inst1.example.com
1761 **add-tags** [\--from *file*] {*instancename*} {*tag*...}
1763 Add tags to the given instance. If any of the tags contains invalid
1764 characters, the entire operation will abort.
1766 If the ``--from`` option is given, the list of tags will be extended
1767 with the contents of that file (each line becomes a tag). In this
1768 case, there is not need to pass tags on the command line (if you do,
1769 both sources will be used). A file name of ``-`` will be interpreted
1775 **list-tags** {*instancename*}
1777 List the tags of the given instance.
1782 **remove-tags** [\--from *file*] {*instancename*} {*tag*...}
1784 Remove tags from the given instance. If any of the tags are not
1785 existing on the node, the entire operation will abort.
1787 If the ``--from`` option is given, the list of tags to be removed will
1788 be extended with the contents of that file (each line becomes a tag).
1789 In this case, there is not need to pass tags on the command line (if
1790 you do, tags from both sources will be removed). A file name of ``-``
1791 will be interpreted as stdin.
1793 .. vim: set textwidth=72 :